001    /*
002     * Copyright 2010-2014 JetBrains s.r.o.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.jetbrains.jet.cli.jvm.compiler;
018    
019    import com.google.common.base.Predicates;
020    import com.google.common.collect.Lists;
021    import com.google.common.collect.Maps;
022    import com.intellij.openapi.Disposable;
023    import com.intellij.openapi.util.Disposer;
024    import com.intellij.psi.PsiFile;
025    import com.intellij.util.ArrayUtil;
026    import kotlin.Function0;
027    import kotlin.Function1;
028    import kotlin.Unit;
029    import kotlin.modules.AllModules;
030    import kotlin.modules.Module;
031    import org.jetbrains.annotations.NotNull;
032    import org.jetbrains.annotations.Nullable;
033    import org.jetbrains.jet.analyzer.AnalysisResult;
034    import org.jetbrains.jet.asJava.FilteredJvmDiagnostics;
035    import org.jetbrains.jet.cli.common.CLIConfigurationKeys;
036    import org.jetbrains.jet.cli.common.CompilerPlugin;
037    import org.jetbrains.jet.cli.common.CompilerPluginContext;
038    import org.jetbrains.jet.cli.common.messages.AnalyzerWithCompilerReport;
039    import org.jetbrains.jet.cli.common.messages.MessageCollector;
040    import org.jetbrains.jet.cli.jvm.JVMConfigurationKeys;
041    import org.jetbrains.jet.codegen.*;
042    import org.jetbrains.jet.codegen.state.GenerationState;
043    import org.jetbrains.jet.codegen.state.Progress;
044    import org.jetbrains.jet.config.CompilerConfiguration;
045    import org.jetbrains.jet.lang.descriptors.impl.ModuleDescriptorImpl;
046    import org.jetbrains.jet.lang.parsing.JetScriptDefinition;
047    import org.jetbrains.jet.lang.parsing.JetScriptDefinitionProvider;
048    import org.jetbrains.jet.lang.psi.JetFile;
049    import org.jetbrains.jet.lang.resolve.AnalyzerScriptParameter;
050    import org.jetbrains.jet.lang.resolve.BindingTrace;
051    import org.jetbrains.jet.lang.resolve.BindingTraceContext;
052    import org.jetbrains.jet.lang.resolve.ScriptNameUtil;
053    import org.jetbrains.jet.lang.resolve.java.PackageClassUtils;
054    import org.jetbrains.jet.lang.resolve.java.TopDownAnalyzerFacadeForJVM;
055    import org.jetbrains.jet.lang.resolve.kotlin.incremental.IncrementalPackage;
056    import org.jetbrains.jet.lang.resolve.kotlin.incremental.cache.IncrementalCache;
057    import org.jetbrains.jet.lang.resolve.kotlin.incremental.cache.IncrementalCacheProvider;
058    import org.jetbrains.jet.lang.resolve.name.FqName;
059    import org.jetbrains.jet.plugin.MainFunctionDetector;
060    import org.jetbrains.jet.utils.KotlinPaths;
061    
062    import java.io.File;
063    import java.net.URL;
064    import java.net.URLClassLoader;
065    import java.util.*;
066    
067    public class KotlinToJVMBytecodeCompiler {
068    
069        private KotlinToJVMBytecodeCompiler() {
070        }
071    
072        @NotNull
073        private static List<String> getAbsolutePaths(@NotNull File directory, @NotNull Module module) {
074            List<String> result = Lists.newArrayList();
075    
076            for (String sourceFile : module.getSourceFiles()) {
077                File source = new File(sourceFile);
078                if (!source.isAbsolute()) {
079                    source = new File(directory, sourceFile);
080                }
081    
082                if (!source.exists()) {
083                    throw new CompileEnvironmentException("'" + source + "' does not exist in module " + module.getModuleName());
084                }
085    
086                result.add(source.getAbsolutePath());
087            }
088            return result;
089        }
090    
091        private static void writeOutput(
092                @NotNull CompilerConfiguration configuration,
093                @NotNull ClassFileFactory outputFiles,
094                @Nullable File outputDir,
095                @Nullable File jarPath,
096                boolean jarRuntime,
097                @Nullable FqName mainClass
098        ) {
099            MessageCollector messageCollector = configuration.get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, MessageCollector.NONE);
100            CompileEnvironmentUtil.writeOutputToDirOrJar(jarPath, outputDir, jarRuntime, mainClass, outputFiles, messageCollector);
101        }
102    
103        public static boolean compileModules(
104                @NotNull CompilerConfiguration configuration,
105                @NotNull List<Module> chunk,
106                @NotNull File directory,
107                @Nullable File jarPath,
108                boolean jarRuntime
109        ) {
110            Map<Module, ClassFileFactory> outputFiles = Maps.newHashMap();
111    
112            CompilerConfiguration compilerConfiguration = createCompilerConfiguration(configuration, chunk, directory);
113    
114            Disposable parentDisposable = Disposer.newDisposable();
115            JetCoreEnvironment environment = null;
116            try {
117                environment = JetCoreEnvironment.createForProduction(parentDisposable, compilerConfiguration);
118    
119                AnalysisResult result = analyze(environment);
120                if (result == null) {
121                    return false;
122                }
123    
124                result.throwIfError();
125    
126                for (Module module : chunk) {
127                    List<JetFile> jetFiles = CompileEnvironmentUtil.getJetFiles(
128                            environment.getProject(), getAbsolutePaths(directory, module), new Function1<String, Unit>() {
129                                @Override
130                                public Unit invoke(String s) {
131                                    throw new IllegalStateException("Should have been checked before: " + s);
132                                }
133                            }
134                    );
135                    GenerationState generationState =
136                            generate(environment, result, jetFiles, module.getModuleName(), new File(module.getOutputDirectory()));
137                    outputFiles.put(module, generationState.getFactory());
138                }
139            }
140            finally {
141                if (environment != null) {
142                    Disposer.dispose(parentDisposable);
143                }
144            }
145    
146            for (Module module : chunk) {
147                writeOutput(configuration, outputFiles.get(module), new File(module.getOutputDirectory()), jarPath, jarRuntime, null);
148            }
149            return true;
150        }
151    
152        @NotNull
153        private static CompilerConfiguration createCompilerConfiguration(
154                @NotNull CompilerConfiguration base,
155                @NotNull List<Module> chunk,
156                @NotNull File directory
157        ) {
158            CompilerConfiguration configuration = base.copy();
159    
160            List<String> sourceRoots = Lists.newArrayList();
161    
162            for (Module module : chunk) {
163                sourceRoots.addAll(getAbsolutePaths(directory, module));
164    
165                for (String classpathRoot : module.getClasspathRoots()) {
166                    configuration.add(JVMConfigurationKeys.CLASSPATH_KEY, new File(classpathRoot));
167                }
168    
169                for (String annotationsRoot : module.getAnnotationsRoots()) {
170                    configuration.add(JVMConfigurationKeys.ANNOTATIONS_PATH_KEY, new File(annotationsRoot));
171                }
172    
173                configuration.add(JVMConfigurationKeys.MODULE_IDS, module.getModuleName());
174            }
175    
176            CompileEnvironmentUtil.addSourceFilesCheckingForDuplicates(configuration, sourceRoots);
177    
178            return configuration;
179        }
180    
181        @Nullable
182        private static FqName findMainClass(@NotNull GenerationState generationState, @NotNull List<JetFile> files) {
183            MainFunctionDetector mainFunctionDetector = new MainFunctionDetector(generationState.getBindingContext());
184            FqName mainClass = null;
185            for (JetFile file : files) {
186                if (mainFunctionDetector.hasMain(file.getDeclarations())) {
187                    if (mainClass != null) {
188                        // more than one main
189                        return null;
190                    }
191                    FqName fqName = file.getPackageFqName();
192                    mainClass = PackageClassUtils.getPackageClassFqName(fqName);
193                }
194            }
195            return mainClass;
196        }
197    
198        public static boolean compileBunchOfSources(
199                @NotNull JetCoreEnvironment environment,
200                @Nullable File jar,
201                @Nullable File outputDir,
202                boolean includeRuntime
203        ) {
204    
205            GenerationState generationState = analyzeAndGenerate(environment);
206            if (generationState == null) {
207                return false;
208            }
209    
210            FqName mainClass = findMainClass(generationState, environment.getSourceFiles());
211    
212            try {
213                writeOutput(environment.getConfiguration(), generationState.getFactory(), outputDir, jar, includeRuntime, mainClass);
214                return true;
215            }
216            finally {
217                generationState.destroy();
218            }
219        }
220    
221        public static void compileAndExecuteScript(
222                @NotNull KotlinPaths paths,
223                @NotNull JetCoreEnvironment environment,
224                @NotNull List<String> scriptArgs
225        ) {
226            Class<?> scriptClass = compileScript(paths, environment);
227            if (scriptClass == null) return;
228    
229            try {
230                scriptClass.getConstructor(String[].class).newInstance(new Object[] {ArrayUtil.toStringArray(scriptArgs)});
231            }
232            catch (RuntimeException e) {
233                throw e;
234            }
235            catch (Exception e) {
236                throw new RuntimeException("Failed to evaluate script: " + e, e);
237            }
238        }
239    
240        @Nullable
241        public static Class<?> compileScript(@NotNull KotlinPaths paths, @NotNull JetCoreEnvironment environment) {
242            List<AnalyzerScriptParameter> scriptParameters = environment.getConfiguration().getList(JVMConfigurationKeys.SCRIPT_PARAMETERS);
243            if (!scriptParameters.isEmpty()) {
244                JetScriptDefinitionProvider.getInstance(environment.getProject()).addScriptDefinition(
245                        new JetScriptDefinition(".kts", scriptParameters)
246                );
247            }
248            GenerationState state = analyzeAndGenerate(environment);
249            if (state == null) {
250                return null;
251            }
252    
253            GeneratedClassLoader classLoader;
254            try {
255                classLoader = new GeneratedClassLoader(state.getFactory(),
256                                                       new URLClassLoader(new URL[] {
257                                                               // TODO: add all classpath
258                                                               paths.getRuntimePath().toURI().toURL()
259                                                       }, AllModules.class.getClassLoader())
260                );
261    
262                FqName nameForScript = ScriptNameUtil.classNameForScript(environment.getSourceFiles().get(0).getScript());
263                return classLoader.loadClass(nameForScript.asString());
264            }
265            catch (Exception e) {
266                throw new RuntimeException("Failed to evaluate script: " + e, e);
267            }
268        }
269    
270        @Nullable
271        public static GenerationState analyzeAndGenerate(@NotNull JetCoreEnvironment environment) {
272            AnalysisResult result = analyze(environment);
273    
274            if (result == null) {
275                return null;
276            }
277    
278            result.throwIfError();
279    
280            return generate(environment, result, environment.getSourceFiles(), null, null);
281        }
282    
283        @Nullable
284        private static AnalysisResult analyze(@NotNull final JetCoreEnvironment environment) {
285            AnalyzerWithCompilerReport analyzerWithCompilerReport = new AnalyzerWithCompilerReport(
286                    environment.getConfiguration().get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY));
287            analyzerWithCompilerReport.analyzeAndReport(
288                    environment.getSourceFiles(), new Function0<AnalysisResult>() {
289                        @NotNull
290                        @Override
291                        public AnalysisResult invoke() {
292                            CliLightClassGenerationSupport support = CliLightClassGenerationSupport.getInstanceForCli(environment.getProject());
293                            BindingTrace sharedTrace = support.getTrace();
294                            ModuleDescriptorImpl sharedModule = support.newModule();
295    
296                            return TopDownAnalyzerFacadeForJVM.analyzeFilesWithJavaIntegration(
297                                    environment.getProject(),
298                                    environment.getSourceFiles(),
299                                    sharedTrace,
300                                    Predicates.<PsiFile>alwaysTrue(),
301                                    sharedModule,
302                                    environment.getConfiguration().get(JVMConfigurationKeys.MODULE_IDS),
303                                    environment.getConfiguration().get(JVMConfigurationKeys.INCREMENTAL_CACHE_PROVIDER)
304                            );
305                        }
306                    }
307            );
308    
309            AnalysisResult result = analyzerWithCompilerReport.getAnalysisResult();
310            assert result != null : "AnalysisResult should be non-null, compiling: " + environment.getSourceFiles();
311    
312            CompilerPluginContext context = new CompilerPluginContext(environment.getProject(), result.getBindingContext(),
313                                                                      environment.getSourceFiles());
314            for (CompilerPlugin plugin : environment.getConfiguration().getList(CLIConfigurationKeys.COMPILER_PLUGINS)) {
315                plugin.processFiles(context);
316            }
317    
318            return analyzerWithCompilerReport.hasErrors() ? null : result;
319        }
320    
321        @NotNull
322        private static GenerationState generate(
323                @NotNull JetCoreEnvironment environment,
324                @NotNull AnalysisResult result,
325                @NotNull List<JetFile> sourceFiles,
326                @Nullable String moduleId,
327                File outputDirectory
328        ) {
329            CompilerConfiguration configuration = environment.getConfiguration();
330            IncrementalCacheProvider incrementalCacheProvider = configuration.get(JVMConfigurationKeys.INCREMENTAL_CACHE_PROVIDER);
331    
332            Collection<FqName> packagesWithRemovedFiles;
333            if (moduleId == null || incrementalCacheProvider == null) {
334                packagesWithRemovedFiles = null;
335            }
336            else {
337                IncrementalCache incrementalCache = incrementalCacheProvider.getIncrementalCache(moduleId);
338                packagesWithRemovedFiles = IncrementalPackage.getPackagesWithRemovedFiles(incrementalCache, environment.getSourceFiles());
339            }
340            BindingTraceContext diagnosticHolder = new BindingTraceContext();
341            GenerationState generationState = new GenerationState(
342                    environment.getProject(),
343                    ClassBuilderFactories.BINARIES,
344                    Progress.DEAF,
345                    result.getModuleDescriptor(),
346                    result.getBindingContext(),
347                    sourceFiles,
348                    configuration.get(JVMConfigurationKeys.DISABLE_CALL_ASSERTIONS, false),
349                    configuration.get(JVMConfigurationKeys.DISABLE_PARAM_ASSERTIONS, false),
350                    GenerationState.GenerateClassFilter.GENERATE_ALL,
351                    configuration.get(JVMConfigurationKeys.DISABLE_INLINE, false),
352                    configuration.get(JVMConfigurationKeys.DISABLE_OPTIMIZATION, false),
353                    packagesWithRemovedFiles,
354                    moduleId,
355                    diagnosticHolder,
356                    outputDirectory
357            );
358            KotlinCodegenFacade.compileCorrectFiles(generationState, CompilationErrorHandler.THROW_EXCEPTION);
359            AnalyzerWithCompilerReport.reportDiagnostics(
360                    new FilteredJvmDiagnostics(
361                            diagnosticHolder.getBindingContext().getDiagnostics(),
362                            result.getBindingContext().getDiagnostics()
363                    ),
364                    environment.getConfiguration().get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY)
365            );
366            return generationState;
367        }
368    }