Tue, 08 Nov 2011 17:06:58 -0800
7108669: cleanup Log methods for direct printing to streams
Reviewed-by: mcimadamore
1 /*
2 * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.tools.javac.api;
28 import java.io.File;
29 import java.io.InputStream;
30 import java.io.OutputStream;
31 import java.io.OutputStreamWriter;
32 import java.io.PrintWriter;
33 import java.io.Writer;
34 import java.nio.charset.Charset;
35 import java.util.ArrayList;
36 import java.util.Collections;
37 import java.util.EnumSet;
38 import java.util.Iterator;
39 import java.util.List;
40 import java.util.Locale;
41 import java.util.Set;
42 import javax.lang.model.SourceVersion;
43 import javax.tools.*;
45 import com.sun.source.util.JavacTask;
46 import com.sun.tools.javac.file.JavacFileManager;
47 import com.sun.tools.javac.main.JavacOption.OptionKind;
48 import com.sun.tools.javac.main.JavacOption;
49 import com.sun.tools.javac.main.Main;
50 import com.sun.tools.javac.main.RecognizedOptions.GrumpyHelper;
51 import com.sun.tools.javac.main.RecognizedOptions;
52 import com.sun.tools.javac.util.ClientCodeException;
53 import com.sun.tools.javac.util.Context;
54 import com.sun.tools.javac.util.Log;
55 import com.sun.tools.javac.util.Log.PrefixKind;
56 import com.sun.tools.javac.util.Options;
57 import com.sun.tools.javac.util.Pair;
59 /**
60 * TODO: describe com.sun.tools.javac.api.Tool
61 *
62 * <p><b>This is NOT part of any supported API.
63 * If you write code that depends on this, you do so at your own
64 * risk. This code and its internal interfaces are subject to change
65 * or deletion without notice.</b></p>
66 *
67 * @author Peter von der Ah\u00e9
68 */
69 public final class JavacTool implements JavaCompiler {
70 private final List<Pair<String,String>> options
71 = new ArrayList<Pair<String,String>>();
72 private final Context dummyContext = new Context();
74 private final PrintWriter silent = new PrintWriter(new OutputStream(){
75 public void write(int b) {}
76 });
78 private final Main sharedCompiler = new Main("javac", silent);
79 {
80 sharedCompiler.setOptions(Options.instance(dummyContext));
81 }
83 /**
84 * Constructor used by service provider mechanism. The correct way to
85 * obtain an instance of this class is using create or the service provider
86 * mechanism.
87 * @see javax.tools.JavaCompilerTool
88 * @see javax.tools.ToolProvider
89 * @see #create
90 */
91 @Deprecated
92 public JavacTool() {}
94 /**
95 * Static factory method for creating new instances of this tool.
96 * @return new instance of this tool
97 */
98 public static JavacTool create() {
99 return new JavacTool();
100 }
102 private String argsToString(Object... args) {
103 String newArgs = null;
104 if (args.length > 0) {
105 StringBuilder sb = new StringBuilder();
106 String separator = "";
107 for (Object arg : args) {
108 sb.append(separator).append(arg.toString());
109 separator = File.pathSeparator;
110 }
111 newArgs = sb.toString();
112 }
113 return newArgs;
114 }
116 private void setOption1(String name, OptionKind kind, Object... args) {
117 String arg = argsToString(args);
118 JavacOption option = sharedCompiler.getOption(name);
119 if (option == null || !match(kind, option.getKind()))
120 throw new IllegalArgumentException(name);
121 if ((args.length != 0) != option.hasArg())
122 throw new IllegalArgumentException(name);
123 if (option.hasArg()) {
124 if (option.process(null, name, arg)) // FIXME
125 throw new IllegalArgumentException(name);
126 } else {
127 if (option.process(null, name)) // FIXME
128 throw new IllegalArgumentException(name);
129 }
130 options.add(new Pair<String,String>(name,arg));
131 }
133 public void setOption(String name, Object... args) {
134 setOption1(name, OptionKind.NORMAL, args);
135 }
137 public void setExtendedOption(String name, Object... args) {
138 setOption1(name, OptionKind.EXTENDED, args);
139 }
141 private static boolean match(OptionKind clientKind, OptionKind optionKind) {
142 return (clientKind == (optionKind == OptionKind.HIDDEN ? OptionKind.EXTENDED : optionKind));
143 }
145 public JavacFileManager getStandardFileManager(
146 DiagnosticListener<? super JavaFileObject> diagnosticListener,
147 Locale locale,
148 Charset charset) {
149 Context context = new Context();
150 context.put(Locale.class, locale);
151 if (diagnosticListener != null)
152 context.put(DiagnosticListener.class, diagnosticListener);
153 PrintWriter pw = (charset == null)
154 ? new PrintWriter(System.err, true)
155 : new PrintWriter(new OutputStreamWriter(System.err, charset), true);
156 context.put(Log.outKey, pw);
157 return new JavacFileManager(context, true, charset);
158 }
160 @Override
161 public JavacTask getTask(Writer out,
162 JavaFileManager fileManager,
163 DiagnosticListener<? super JavaFileObject> diagnosticListener,
164 Iterable<String> options,
165 Iterable<String> classes,
166 Iterable<? extends JavaFileObject> compilationUnits) {
167 Context context = new Context();
168 return getTask(out, fileManager, diagnosticListener,
169 options, classes, compilationUnits,
170 context);
171 }
173 public JavacTask getTask(Writer out,
174 JavaFileManager fileManager,
175 DiagnosticListener<? super JavaFileObject> diagnosticListener,
176 Iterable<String> options,
177 Iterable<String> classes,
178 Iterable<? extends JavaFileObject> compilationUnits,
179 Context context)
180 {
181 try {
182 ClientCodeWrapper ccw = ClientCodeWrapper.instance(context);
184 final String kindMsg = "All compilation units must be of SOURCE kind";
185 if (options != null)
186 for (String option : options)
187 option.getClass(); // null check
188 if (classes != null) {
189 for (String cls : classes)
190 if (!SourceVersion.isName(cls)) // implicit null check
191 throw new IllegalArgumentException("Not a valid class name: " + cls);
192 }
193 if (compilationUnits != null) {
194 compilationUnits = ccw.wrapJavaFileObjects(compilationUnits); // implicit null check
195 for (JavaFileObject cu : compilationUnits) {
196 if (cu.getKind() != JavaFileObject.Kind.SOURCE)
197 throw new IllegalArgumentException(kindMsg);
198 }
199 }
201 if (diagnosticListener != null)
202 context.put(DiagnosticListener.class, ccw.wrap(diagnosticListener));
204 if (out == null)
205 context.put(Log.outKey, new PrintWriter(System.err, true));
206 else
207 context.put(Log.outKey, new PrintWriter(out, true));
209 if (fileManager == null)
210 fileManager = getStandardFileManager(diagnosticListener, null, null);
211 fileManager = ccw.wrap(fileManager);
212 context.put(JavaFileManager.class, fileManager);
213 processOptions(context, fileManager, options);
214 Main compiler = new Main("javacTask", context.get(Log.outKey));
215 return new JavacTaskImpl(compiler, options, context, classes, compilationUnits);
216 } catch (ClientCodeException ex) {
217 throw new RuntimeException(ex.getCause());
218 }
219 }
221 private static void processOptions(Context context,
222 JavaFileManager fileManager,
223 Iterable<String> options)
224 {
225 if (options == null)
226 return;
228 Options optionTable = Options.instance(context);
229 Log log = Log.instance(context);
231 JavacOption[] recognizedOptions =
232 RecognizedOptions.getJavacToolOptions(new GrumpyHelper(log));
233 Iterator<String> flags = options.iterator();
234 while (flags.hasNext()) {
235 String flag = flags.next();
236 int j;
237 for (j=0; j<recognizedOptions.length; j++)
238 if (recognizedOptions[j].matches(flag))
239 break;
241 if (j == recognizedOptions.length) {
242 if (fileManager.handleOption(flag, flags)) {
243 continue;
244 } else {
245 String msg = log.localize(PrefixKind.JAVAC, "err.invalid.flag", flag);
246 throw new IllegalArgumentException(msg);
247 }
248 }
250 JavacOption option = recognizedOptions[j];
251 if (option.hasArg()) {
252 if (!flags.hasNext()) {
253 String msg = log.localize(PrefixKind.JAVAC, "err.req.arg", flag);
254 throw new IllegalArgumentException(msg);
255 }
256 String operand = flags.next();
257 if (option.process(optionTable, flag, operand))
258 // should not happen as the GrumpyHelper will throw exceptions
259 // in case of errors
260 throw new IllegalArgumentException(flag + " " + operand);
261 } else {
262 if (option.process(optionTable, flag))
263 // should not happen as the GrumpyHelper will throw exceptions
264 // in case of errors
265 throw new IllegalArgumentException(flag);
266 }
267 }
269 optionTable.notifyListeners();
270 }
272 public int run(InputStream in, OutputStream out, OutputStream err, String... arguments) {
273 if (err == null)
274 err = System.err;
275 for (String argument : arguments)
276 argument.getClass(); // null check
277 return com.sun.tools.javac.Main.compile(arguments, new PrintWriter(err, true));
278 }
280 public Set<SourceVersion> getSourceVersions() {
281 return Collections.unmodifiableSet(EnumSet.range(SourceVersion.RELEASE_3,
282 SourceVersion.latest()));
283 }
285 public int isSupportedOption(String option) {
286 JavacOption[] recognizedOptions =
287 RecognizedOptions.getJavacToolOptions(new GrumpyHelper(null));
288 for (JavacOption o : recognizedOptions) {
289 if (o.matches(option))
290 return o.hasArg() ? 1 : 0;
291 }
292 return -1;
293 }
295 }