blob: b9624343999183790651fb283703ce0d6a6fc5f1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
// Copyright 2011 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.buildjar.javac.plugins;
import com.google.devtools.build.buildjar.InvalidCommandLineException;
import com.sun.tools.javac.comp.AttrContext;
import com.sun.tools.javac.comp.Env;
import com.sun.tools.javac.main.JavaCompiler;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.Log;
import java.util.List;
/**
* An interface for additional static analyses that need access to the javac compiler's AST at
* specific points in the compilation process. This class provides callbacks after the attribute and
* flow phases of the javac compilation process. A static analysis may be implemented by subclassing
* this abstract class and performing the analysis in the callback methods. The analysis may then be
* registered with the BlazeJavaCompiler to be run during the compilation process. See {@link
* com.google.devtools.build.buildjar.javac.plugins.dependency.StrictJavaDepsPlugin} for an example.
*/
public abstract class BlazeJavaCompilerPlugin {
protected Context context;
protected Log log;
protected JavaCompiler compiler;
/**
* Preprocess the command-line flags that were passed to javac. This is called before {@link
* #init(Context, Log, JavaCompiler)} and {@link #initializeContext(Context)}.
*
* @param args The command-line flags that javac was invoked with.
* @throws InvalidCommandLineException if the arguments are invalid
* @returns The flags that do not belong to this plugin.
*/
public List<String> processArgs(List<String> args) throws InvalidCommandLineException {
return args;
}
/**
* Called after all plugins have processed arguments and can be used to customize the Java
* compiler context.
*/
public void initializeContext(Context context) {
this.context = context;
}
/**
* Performs analysis actions after the attribute phase of the javac compiler. The attribute phase
* performs symbol resolution on the parse tree.
*
* @param env The attributed parse tree (after symbol resolution)
*/
public void postAttribute(Env<AttrContext> env) {}
/**
* Performs analysis actions after the flow phase of the javac compiler. The flow phase performs
* dataflow checks, such as finding unreachable statements.
*
* @param env The attributed parse tree (after symbol resolution)
*/
public void postFlow(Env<AttrContext> env) {}
/**
* Performs analysis actions when the compiler is done and is about to wipe clean its internal
* data structures (such as the symbol table).
*/
public void finish() {}
/**
* Initializes the plugin. Called by {@link
* com.google.devtools.build.buildjar.javac.BlazeJavaCompiler}'s constructor.
*
* @param context The Context object from the enclosing BlazeJavaCompiler instance
* @param log The Log object from the enclosing BlazeJavaCompiler instance
* @param compiler The enclosing BlazeJavaCompiler instance
*/
public void init(Context context, Log log, JavaCompiler compiler) {
this.context = context;
this.log = log;
this.compiler = compiler;
}
}
|
