• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/javac/code/DeferredLintHandler.java@ca5783d9a597 (annotated)

src/share/classes/com/sun/tools/javac/code/DeferredLintHandler.java

Mon, 16 Oct 2017 16:07:48 +0800

author

aoqi

date

Mon, 16 Oct 2017 16:07:48 +0800

changeset 2893

ca5783d9a597

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.javac.code;
aoqi@0	27
aoqi@0	28	import java.util.HashMap;
aoqi@0	29	import java.util.Map;
aoqi@0	30
aoqi@0	31	import com.sun.tools.javac.tree.EndPosTable;
aoqi@0	32	import com.sun.tools.javac.tree.JCTree;
aoqi@0	33	import com.sun.tools.javac.util.Assert;
aoqi@0	34	import com.sun.tools.javac.util.Context;
aoqi@0	35	import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
aoqi@0	36	import com.sun.tools.javac.util.ListBuffer;
aoqi@0	37
aoqi@0	38	/**
aoqi@0	39	*
aoqi@0	40	* <p><b>This is NOT part of any supported API.
aoqi@0	41	* If you write code that depends on this, you do so at your own risk.
aoqi@0	42	* This code and its internal interfaces are subject to change or
aoqi@0	43	* deletion without notice.</b>
aoqi@0	44	*/
aoqi@0	45	public class DeferredLintHandler {
aoqi@0	46	protected static final Context.Key<DeferredLintHandler> deferredLintHandlerKey =
aoqi@0	47	new Context.Key<DeferredLintHandler>();
aoqi@0	48
aoqi@0	49	public static DeferredLintHandler instance(Context context) {
aoqi@0	50	DeferredLintHandler instance = context.get(deferredLintHandlerKey);
aoqi@0	51	if (instance == null)
aoqi@0	52	instance = new DeferredLintHandler(context);
aoqi@0	53	return instance;
aoqi@0	54	}
aoqi@0	55
aoqi@0	56	protected DeferredLintHandler(Context context) {
aoqi@0	57	context.put(deferredLintHandlerKey, this);
aoqi@0	58	this.currentPos = IMMEDIATE_POSITION;
aoqi@0	59	}
aoqi@0	60
aoqi@0	61	/**An interface for deferred lint reporting - loggers passed to
aoqi@0	62	* {@link #report(LintLogger) } will be called when
aoqi@0	63	* {@link #flush(DiagnosticPosition) } is invoked.
aoqi@0	64	*/
aoqi@0	65	public interface LintLogger {
aoqi@0	66	void report();
aoqi@0	67	}
aoqi@0	68
aoqi@0	69	private DiagnosticPosition currentPos;
aoqi@0	70	private Map<DiagnosticPosition, ListBuffer<LintLogger>> loggersQueue = new HashMap<DiagnosticPosition, ListBuffer<LintLogger>>();
aoqi@0	71
aoqi@0	72	/**Associate the given logger with the current position as set by {@link #setPos(DiagnosticPosition) }.
aoqi@0	73	* Will be invoked when {@link #flush(DiagnosticPosition) } will be invoked with the same position.
aoqi@0	74	* <br>
aoqi@0	75	* Will invoke the logger synchronously if {@link #immediate() } was called
aoqi@0	76	* instead of {@link #setPos(DiagnosticPosition) }.
aoqi@0	77	*/
aoqi@0	78	public void report(LintLogger logger) {
aoqi@0	79	if (currentPos == IMMEDIATE_POSITION) {
aoqi@0	80	logger.report();
aoqi@0	81	} else {
aoqi@0	82	ListBuffer<LintLogger> loggers = loggersQueue.get(currentPos);
aoqi@0	83	if (loggers == null) {
aoqi@0	84	loggersQueue.put(currentPos, loggers = new ListBuffer<>());
aoqi@0	85	}
aoqi@0	86	loggers.append(logger);
aoqi@0	87	}
aoqi@0	88	}
aoqi@0	89
aoqi@0	90	/**Invoke all {@link LintLogger}s that were associated with the provided {@code pos}.
aoqi@0	91	*/
aoqi@0	92	public void flush(DiagnosticPosition pos) {
aoqi@0	93	ListBuffer<LintLogger> loggers = loggersQueue.get(pos);
aoqi@0	94	if (loggers != null) {
aoqi@0	95	for (LintLogger lintLogger : loggers) {
aoqi@0	96	lintLogger.report();
aoqi@0	97	}
aoqi@0	98	loggersQueue.remove(pos);
aoqi@0	99	}
aoqi@0	100	}
aoqi@0	101
aoqi@0	102	/**Sets the current position to the provided {@code currentPos}. {@link LintLogger}s
aoqi@0	103	* passed to subsequent invocations of {@link #report(LintLogger) } will be associated
aoqi@0	104	* with the given position.
aoqi@0	105	*/
aoqi@0	106	public DiagnosticPosition setPos(DiagnosticPosition currentPos) {
aoqi@0	107	DiagnosticPosition prevPosition = this.currentPos;
aoqi@0	108	this.currentPos = currentPos;
aoqi@0	109	return prevPosition;
aoqi@0	110	}
aoqi@0	111
aoqi@0	112	/**{@link LintLogger}s passed to subsequent invocations of
aoqi@0	113	* {@link #report(LintLogger) } will be invoked immediately.
aoqi@0	114	*/
aoqi@0	115	public DiagnosticPosition immediate() {
aoqi@0	116	return setPos(IMMEDIATE_POSITION);
aoqi@0	117	}
aoqi@0	118
aoqi@0	119	private static final DiagnosticPosition IMMEDIATE_POSITION = new DiagnosticPosition() {
aoqi@0	120	@Override
aoqi@0	121	public JCTree getTree() {
aoqi@0	122	Assert.error();
aoqi@0	123	return null;
aoqi@0	124	}
aoqi@0	125
aoqi@0	126	@Override
aoqi@0	127	public int getStartPosition() {
aoqi@0	128	Assert.error();
aoqi@0	129	return -1;
aoqi@0	130	}
aoqi@0	131
aoqi@0	132	@Override
aoqi@0	133	public int getPreferredPosition() {
aoqi@0	134	Assert.error();
aoqi@0	135	return -1;
aoqi@0	136	}
aoqi@0	137
aoqi@0	138	@Override
aoqi@0	139	public int getEndPosition(EndPosTable endPosTable) {
aoqi@0	140	Assert.error();
aoqi@0	141	return -1;
aoqi@0	142	}
aoqi@0	143	};
aoqi@0	144	}