bundles/org.simantics.scl.compiler/src/org/simantics/scl/compiler/compilation/SCLCompiler.java

   1 package org.simantics.scl.compiler.compilation;
   2
   3 import java.io.IOException;
   4 import java.io.Reader;
   5 import java.util.ArrayList;
   6 import java.util.Map;
   7
   8 import org.simantics.scl.compiler.environment.EnvironmentFactory;
   9 import org.simantics.scl.compiler.errors.ErrorLog;
  10 import org.simantics.scl.compiler.internal.codegen.types.JavaReferenceValidatorFactory;
  11 import org.simantics.scl.compiler.internal.header.ModuleHeader;
  12 import org.simantics.scl.compiler.internal.parsing.declarations.DeclarationAst;
  13 import org.simantics.scl.compiler.internal.parsing.exceptions.SCLSyntaxErrorException;
  14 import org.simantics.scl.compiler.internal.parsing.parser.SCLParserImpl;
  15 import org.simantics.scl.compiler.internal.parsing.parser.SCLParserOptions;
  16 import org.simantics.scl.compiler.module.ConcreteModule;
  17 import org.simantics.scl.compiler.module.options.ModuleCompilationOptions;
  18 import org.simantics.scl.compiler.top.ModuleInitializer;
  19 import org.simantics.scl.compiler.top.SCLCompilerConfiguration;
  20 import org.simantics.scl.compiler.top.StandardModuleInitializer;
  21
  22 public class SCLCompiler {
  23     CompilationContext compilationContext = new CompilationContext();
  24     DeclarationClassification declarations = new DeclarationClassification(compilationContext);
  25
  26     // publishable results
  27     Map<String, byte[]> classes;
  28     ConcreteModule module;
  29     ModuleInitializer moduleInitializer;
  30
  31     private CompilationTimer timer;
  32     private ModuleCompilationOptions options;
  33
  34     JavaReferenceValidatorFactory jrvFactory;
  35
  36     public SCLCompiler(ModuleCompilationOptions options, JavaReferenceValidatorFactory jrvFactory) {
  37         this.options = options == null ? ModuleCompilationOptions.STANDARD_OPTIONS : options;
  38         this.jrvFactory = jrvFactory;
  39     }
  40
  41     @SuppressWarnings("unchecked")
  42     public void addSource(Reader sourceReader) {
  43         if(SCLCompilerConfiguration.ENABLE_TIMING) initializeTiming();
  44         try {
  45             SCLParserImpl parser = new SCLParserImpl(sourceReader);
  46             parser.setParserOptions(SCLParserOptions.MODULE_DEFAULT);
  47             parser.setCompilationContext(compilationContext);
  48             if(!parser.isEmpty())
  49             for(DeclarationAst declaration : (ArrayList<DeclarationAst>)parser.parseModule())
  50                 declarations.handle(declaration);
  51         } catch(SCLSyntaxErrorException e) {
  52             compilationContext.errorLog.log(e.location, e.getMessage());
  53         } catch(Exception e) {
  54             compilationContext.errorLog.log(e);
  55         } finally {
  56             try {
  57                 sourceReader.close();
  58             } catch (IOException e) {
  59                 e.printStackTrace();
  60             }
  61         }
  62         if(SCLCompilerConfiguration.ENABLE_TIMING) phaseFinished("Parsing");
  63     }
  64
  65     private boolean hasErrors() {
  66         return !compilationContext.errorLog.hasNoErrors();
  67     }
  68
  69     public void compile(
  70             EnvironmentFactory localEnvironmentFactory,
  71             String moduleName) {
  72         try {
  73             if(hasErrors()) return;
  74             Elaboration elaboration = new Elaboration(compilationContext,
  75                     timer,
  76                     localEnvironmentFactory,
  77                     moduleName,
  78                     compilationContext.header,
  79                     declarations.importsAst,
  80                     jrvFactory,
  81                     declarations.valueDefinitionsAst,
  82                     declarations.relationDefinitionsAst);
  83             if(options.computeCoverage)
  84                 elaboration.addCoverageBranchPoints();
  85             if(options.collectDebugInfo)
  86                 elaboration.collectDebugInfo();
  87             // Elaboration
  88             if(hasErrors()) return;
  89             elaboration.addTypesToEnvironment(
  90                     declarations.dataTypesAst,
  91                     declarations.typeAliasesAst,
  92                     declarations.effectsAst,
  93                     declarations.rulesetsAst);
  94             if(hasErrors()) return;
  95             elaboration.processTypeAliases(declarations.typeAliasesAst);
  96             if(hasErrors()) return;
  97             elaboration.processDataTypes(declarations.dataTypesAst);
  98             if(hasErrors()) return;
  99             elaboration.processTypeClasses(declarations.typeClassesAst);
 100             if(hasErrors()) return;
 101             elaboration.processDerivingInstances(declarations.derivingInstancesAst, declarations.instancesAst);
 102             if(hasErrors()) return;
 103             elaboration.processInstances(declarations.instancesAst);
 104             if(hasErrors()) return;
 105             elaboration.processJavaMethods(declarations.javaMethodDeclarations);
 106             if(hasErrors()) return;
 107             elaboration.processRulesets(declarations.rulesetsAst);
 108             if(hasErrors()) return;
 109             elaboration.addDataTypesToEnvironment();
 110             elaboration.addTypeClassesToEnvironment();
 111             elaboration.preprocessValueDefinitions(declarations.typeAnnotationsAst);
 112             elaboration.processMappingRelations(declarations.mappingRelationsAst);
 113             elaboration.addFixityToEnvironment(declarations.fixityAst);
 114             elaboration.addValueDefinitionsToEnvironment(declarations.typeAnnotationsAst);
 115             elaboration.processRules(declarations.rulesAst);
 116             elaboration.addSupplementedTypeAnnotationsToEnvironment();
 117             if(SCLCompilerConfiguration.ENABLE_TIMING) phaseFinished("Elaboration");
 118
 119             // Type checking
 120             if(hasErrors()) return;
 121             //new TypeChecking(errorLog, elaboration.environment, elaboration.module).typeCheck();
 122             new TypeChecking(compilationContext, elaboration.module).typeCheck();
 123
 124             if(SCLCompilerConfiguration.ENABLE_TIMING) phaseFinished("Type checking");
 125
 126             // FIXME HACK for testing
 127             /*if(!elaboration.module.getRules().isEmpty()) {
 128                 TransformationBuilder tb = new TransformationBuilder(elaboration.module.getRules());
 129                 tb.compileRules(elaboration.environment);
 130                 System.out.println(tb.getCompiledExpression(elaboration.environment));
 131             }*/
 132
 133             // Documentation generation
 134             new DocumentationGeneration(
 135                     declarations.valueDocumentation,
 136                     declarations.typeDocumentation,
 137                     declarations.classDocumentation,
 138                     elaboration.module
 139                     )
 140                 .generateDocumentation();
 141             this.declarations = null;
 142
 143             // Code generation
 144             if(hasErrors()) return;
 145             CodeGeneration codeGeneration = new CodeGeneration(
 146                     compilationContext,
 147                     elaboration.javaReferenceValidator,
 148                     elaboration.module);
 149             codeGeneration.simplifyValues();
 150             if(hasErrors()) return;
 151             codeGeneration.convertToSSA();
 152             if(hasErrors()) return;
 153             codeGeneration.optimizeSSA();
 154
 155             if(SCLCompilerConfiguration.ENABLE_TIMING) phaseFinished("SSA conversion and optimization");
 156
 157             if(hasErrors()) return;
 158             codeGeneration.generateCode();
 159             if(hasErrors()) return;
 160             codeGeneration.generateDataTypes(elaboration.dataTypes);
 161             if(hasErrors()) return;
 162             codeGeneration.generateTypeClasses();
 163             if(hasErrors()) return;
 164             codeGeneration.generateTypeClassInstances();
 165             if(hasErrors()) return;
 166
 167             classes = codeGeneration.classes;
 168             module =  codeGeneration.module;
 169             moduleInitializer = StandardModuleInitializer.create(
 170                     compilationContext.namingPolicy.getModuleClassName(),
 171                     codeGeneration.externalConstants);
 172
 173             module.setClasses(classes);
 174             module.setParentClassLoader(elaboration.javaReferenceValidator.getClassLoader());
 175             module.setModuleInitializer(moduleInitializer);
 176             module.setBranchPoints(elaboration.branchPoints);
 177             if(compilationContext.errorLog.hasErrorsOrWarnings())
 178                 module.setWarnings(compilationContext.errorLog.getErrors());
 179
 180             if(SCLCompilerConfiguration.ENABLE_TIMING) {
 181                 phaseFinished("Code generation");
 182                 reportTiming(moduleName);
 183             }
 184         } catch(Exception e) {
 185             compilationContext.errorLog.log(e);
 186         }
 187     }
 188
 189     public ErrorLog getErrorLog() {
 190         return compilationContext.errorLog;
 191     }
 192
 193     public Map<String, byte[]> getClasses() {
 194         return classes;
 195     }
 196
 197     public ConcreteModule getModule() {
 198         return module;
 199     }
 200
 201     public ModuleInitializer getModuleInitializer() {
 202         return moduleInitializer;
 203     }
 204
 205     private void initializeTiming() {
 206         timer = new CompilationTimer();
 207     }
 208
 209     private void phaseFinished(String phaseName) {
 210         timer.phaseFinished(phaseName);
 211     }
 212
 213     private void reportTiming(String moduleName) {
 214         timer.report(moduleName);
 215     }
 216 }