1 /* 2 * Copyright (c) 2005, 2015, 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 */ 25 26 package com.sun.tools.javac.api; 27 28 import java.util.Collection; 29 import java.util.LinkedHashSet; 30 import java.util.Locale; 31 import java.util.ServiceLoader; 32 import java.util.Set; 33 import java.util.stream.Collectors; 34 35 import javax.annotation.processing.Processor; 36 import javax.lang.model.element.Element; 37 import javax.lang.model.type.TypeMirror; 38 import javax.lang.model.util.Elements; 39 import javax.lang.model.util.Types; 40 import javax.tools.JavaFileObject; 41 42 import com.sun.source.tree.CompilationUnitTree; 43 import com.sun.source.tree.Tree; 44 import com.sun.source.util.JavacTask; 45 import com.sun.source.util.Plugin; 46 import com.sun.source.util.TaskListener; 47 import com.sun.tools.doclint.DocLint; 48 import com.sun.tools.javac.main.JavaCompiler; 49 import com.sun.tools.javac.model.JavacElements; 50 import com.sun.tools.javac.model.JavacTypes; 51 import com.sun.tools.javac.platform.PlatformDescription; 52 import com.sun.tools.javac.platform.PlatformDescription.PluginInfo; 53 import com.sun.tools.javac.processing.JavacProcessingEnvironment; 54 import com.sun.tools.javac.tree.JCTree; 55 import com.sun.tools.javac.util.Context; 56 import com.sun.tools.javac.util.DefinedBy; 57 import com.sun.tools.javac.util.DefinedBy.Api; 58 import com.sun.tools.javac.util.List; 59 import com.sun.tools.javac.util.Log; 60 import com.sun.tools.javac.util.PropagatedException; 61 62 /** 63 * Provides basic functionality for implementations of JavacTask. 64 * 65 * <p><b>This is NOT part of any supported API. 66 * If you write code that depends on this, you do so at your own 67 * risk. This code and its internal interfaces are subject to change 68 * or deletion without notice.</b></p> 69 */ 70 public class BasicJavacTask extends JavacTask { 71 protected Context context; 72 private TaskListener taskListener; 73 74 public static JavacTask instance(Context context) { 75 JavacTask instance = context.get(JavacTask.class); 76 if (instance == null) 77 instance = new BasicJavacTask(context, true); 78 return instance; 79 } 80 81 public BasicJavacTask(Context c, boolean register) { 82 context = c; 83 if (register) 84 context.put(JavacTask.class, this); 85 } 86 87 @Override @DefinedBy(Api.COMPILER_TREE) 88 public Iterable<? extends CompilationUnitTree> parse() { 89 throw new IllegalStateException(); 90 } 91 92 @Override @DefinedBy(Api.COMPILER_TREE) 93 public Iterable<? extends Element> analyze() { 94 throw new IllegalStateException(); 95 } 96 97 @Override @DefinedBy(Api.COMPILER_TREE) 98 public Iterable<? extends JavaFileObject> generate() { 99 throw new IllegalStateException(); 100 } 101 102 @Override @DefinedBy(Api.COMPILER_TREE) 103 public void setTaskListener(TaskListener tl) { 104 MultiTaskListener mtl = MultiTaskListener.instance(context); 105 if (taskListener != null) 106 mtl.remove(taskListener); 107 if (tl != null) 108 mtl.add(tl); 109 taskListener = tl; 110 } 111 112 @Override @DefinedBy(Api.COMPILER_TREE) 113 public void addTaskListener(TaskListener taskListener) { 114 MultiTaskListener mtl = MultiTaskListener.instance(context); 115 mtl.add(taskListener); 116 } 117 118 @Override @DefinedBy(Api.COMPILER_TREE) 119 public void removeTaskListener(TaskListener taskListener) { 120 MultiTaskListener mtl = MultiTaskListener.instance(context); 121 mtl.remove(taskListener); 122 } 123 124 public Collection<TaskListener> getTaskListeners() { 125 MultiTaskListener mtl = MultiTaskListener.instance(context); 126 return mtl.getTaskListeners(); 127 } 128 129 @Override @DefinedBy(Api.COMPILER_TREE) 130 public TypeMirror getTypeMirror(Iterable<? extends Tree> path) { 131 // TODO: Should complete attribution if necessary 132 Tree last = null; 133 for (Tree node : path) 134 last = node; 135 return ((JCTree)last).type; 136 } 137 138 @Override @DefinedBy(Api.COMPILER_TREE) 139 public Elements getElements() { 140 if (context == null) 141 throw new IllegalStateException(); 142 return JavacElements.instance(context); 143 } 144 145 @Override @DefinedBy(Api.COMPILER_TREE) 146 public Types getTypes() { 147 if (context == null) 148 throw new IllegalStateException(); 149 return JavacTypes.instance(context); 150 } 151 152 @Override @DefinedBy(Api.COMPILER) 153 public void setProcessors(Iterable<? extends Processor> processors) { 154 throw new IllegalStateException(); 155 } 156 157 @Override @DefinedBy(Api.COMPILER) 158 public void setLocale(Locale locale) { 159 throw new IllegalStateException(); 160 } 161 162 @Override @DefinedBy(Api.COMPILER) 163 public Boolean call() { 164 throw new IllegalStateException(); 165 } 166 167 /** 168 * For internal use only. 169 * This method will be removed without warning. 170 * @return the context 171 */ 172 public Context getContext() { 173 return context; 174 } 175 176 public void initPlugins(Set<List<String>> pluginOpts) { 177 PlatformDescription platformProvider = context.get(PlatformDescription.class); 178 179 if (platformProvider != null) { 180 for (PluginInfo<Plugin> pluginDesc : platformProvider.getPlugins()) { 181 java.util.List<String> options = 182 pluginDesc.getOptions().entrySet().stream() 183 .map(e -> e.getKey() + "=" + e.getValue()) 184 .collect(Collectors.toList()); 185 try { 186 pluginDesc.getPlugin().init(this, options.toArray(new String[options.size()])); 187 } catch (RuntimeException ex) { 188 throw new PropagatedException(ex); 189 } 190 } 191 } 192 193 if (pluginOpts.isEmpty()) 194 return; 195 196 Set<List<String>> pluginsToCall = new LinkedHashSet<>(pluginOpts); 197 JavacProcessingEnvironment pEnv = JavacProcessingEnvironment.instance(context); 198 ServiceLoader<Plugin> sl = pEnv.getServiceLoader(Plugin.class); 199 for (Plugin plugin : sl) { 200 for (List<String> p : pluginsToCall) { 201 if (plugin.getName().equals(p.head)) { 202 pluginsToCall.remove(p); 203 try { 204 plugin.init(this, p.tail.toArray(new String[p.tail.size()])); 205 } catch (RuntimeException ex) { 206 throw new PropagatedException(ex); 207 } 208 } 209 } 210 } 211 for (List<String> p: pluginsToCall) { 212 Log.instance(context).error("plugin.not.found", p.head); 213 } 214 } 215 216 public void initDocLint(List<String> docLintOpts) { 217 if (docLintOpts.isEmpty()) 218 return; 219 220 new DocLint().init(this, docLintOpts.toArray(new String[docLintOpts.size()])); 221 JavaCompiler.instance(context).keepComments = true; 222 } 223 }