src/compiler/java_compiler.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 # Compile Nit code to Java code
  16 #
  17 # 3 runtime structures are used to represent Nit instance in Java generated code:
  18 # * `RTClass` to represent a class, it's super-type table and its VFT
  19 # * `RTMethod` to reprensent a compiled method definition
  20 # * `RTVal` to reprensent a Nit instance, the null value or a native value
  21 #
  22 # More details are given in the documentation of these 3 classes.
  23 #
  24 # TODO Factorize with `abstract_compiler`
  25 module java_compiler
  26
  27 import rapid_type_analysis
  28 import frontend
  29
  30 redef class ToolContext
  31
  32         # Where to output the generated binary
  33         var opt_output = new OptionString("Output file", "-o", "--output")
  34
  35         # Where to output tmp files
  36         var opt_compile_dir = new OptionString("Directory used to generate temporary files", "--compile-dir")
  37
  38         redef init do
  39                 super
  40                 option_context.add_option(opt_output, opt_compile_dir)
  41         end
  42 end
  43
  44 redef class ModelBuilder
  45
  46         # Start the Java compiler
  47         fun run_java_compiler(mainmodule: MModule, runtime_type_analysis: RapidTypeAnalysis) do
  48                 var time0 = get_time
  49                 toolcontext.info("*** GENERATING JAVA ***", 1)
  50
  51                 var compiler = new JavaCompiler(mainmodule, self, runtime_type_analysis)
  52                 compiler.do_compilation
  53
  54                 var time1 = get_time
  55                 toolcontext.info("*** END GENERATING JAVA: {time1-time0} ***", 2)
  56                 write_and_make(compiler)
  57         end
  58
  59         # Write Java code and compile it into an executable jar
  60         fun write_and_make(compiler: JavaCompiler) do
  61                 var time0 = get_time
  62                 toolcontext.info("*** WRITING JAVA ***", 1)
  63
  64                 compiler.compile_dir.mkdir
  65
  66                 var jfiles = write_java_files(compiler)
  67
  68                 var time1 = get_time
  69                 toolcontext.info("*** END WRITING JAVA: {time1-time0} ***", 2)
  70
  71                 time0 = time1
  72                 toolcontext.info("*** COMPILING JAVA ***", 1)
  73
  74                 build_with_make(compiler, jfiles)
  75                 write_shell_script(compiler)
  76
  77                 time1 = get_time
  78                 toolcontext.info("*** END COMPILING JAVA: {time1-time0} ***", 2)
  79         end
  80
  81         # Write files managed by `compiler` into concrete files
  82         fun write_java_files(compiler: JavaCompiler): Array[String] do
  83                 var jfiles = new Array[String]
  84                 for f in compiler.files do
  85                         var file = new FileWriter.open("{compiler.compile_dir}/{f.filename}")
  86                         for line in f.lines do file.write(line)
  87                         file.close
  88                         jfiles.add(f.filename)
  89                 end
  90                 return jfiles
  91         end
  92
  93         # Compile Java generated files using `make`
  94         fun build_with_make(compiler: JavaCompiler, jfiles: Array[String]) do
  95                 write_manifest(compiler)
  96                 write_makefile(compiler, jfiles)
  97                 var compile_dir = compiler.compile_dir
  98                 var outname = compiler.outname.to_path.filename
  99                 toolcontext.info("make -N -C {compile_dir} -f {outname}.mk", 2)
 100                 var res
 101                 if toolcontext.verbose_level >= 3 then
 102                         res = sys.system("make -B -C {compile_dir} -f {outname}.mk 2>&1")
 103                 else
 104                         res = sys.system("make -B -C {compile_dir} -f {outname}.mk 2>&1 > /dev/null")
 105                 end
 106                 if res != 0 then toolcontext.error(null, "make failed! Error code: {res}.")
 107         end
 108
 109         # Write the Makefile used to compile Java generated files into an executable jar
 110         fun write_makefile(compiler: JavaCompiler, jfiles: Array[String]) do
 111                 # list class files from jfiles
 112                 var ofiles = new List[String]
 113                 for f in jfiles do ofiles.add(f.strip_extension(".java") + ".class")
 114
 115                 var compile_dir = compiler.compile_dir
 116                 var outname = compiler.outname.to_path.filename
 117                 var outpath = (sys.getcwd / compiler.outname).simplify_path
 118                 var makename = "{compile_dir}/{outname}.mk"
 119                 var makefile = new FileWriter.open(makename)
 120
 121                 makefile.write("JC = javac\n")
 122                 makefile.write("JAR = jar\n\n")
 123
 124                 makefile.write("all: {outpath}.jar\n\n")
 125
 126                 makefile.write("{outpath}.jar: {compiler.mainmodule.jname}_Main.class\n")
 127                 makefile.write("\t$(JAR) cfm {outpath}.jar {outname}.mf {ofiles.join(" ")}\n\n")
 128
 129                 makefile.write("{compiler.mainmodule.jname}_Main.class:\n")
 130                 makefile.write("\t$(JC) {jfiles.join(" ")}\n\n")
 131
 132                 makefile.write("clean:\n")
 133                 makefile.write("\trm {ofiles.join(" ")} 2>/dev/null\n\n")
 134
 135                 makefile.close
 136                 toolcontext.info("Generated makefile: {makename}", 2)
 137         end
 138
 139         # Write the Java manifest file
 140         private fun write_manifest(compiler: JavaCompiler) do
 141                 var compile_dir = compiler.compile_dir
 142                 var outname = compiler.outname.to_path.filename
 143                 var maniffile = new FileWriter.open("{compile_dir}/{outname}.mf")
 144                 maniffile.write("Manifest-Version: 1.0\n")
 145                 maniffile.write("Main-Class: {compiler.mainmodule.jname}_Main\n")
 146                 maniffile.close
 147         end
 148
 149         # Write a simple bash script that runs the jar like it was a binary generated by nitc
 150         private fun write_shell_script(compiler: JavaCompiler) do
 151                 var outname = compiler.outname
 152                 var shfile = new FileWriter.open(outname)
 153                 shfile.write("#!/bin/bash\n")
 154                 shfile.write("java -jar {outname}.jar \"$@\"\n")
 155                 shfile.close
 156                 sys.system("chmod +x {outname}")
 157         end
 158 end
 159
 160 # Compiler that translates Nit code to Java code
 161 class JavaCompiler
 162         # The main module of the program currently compiled
 163         var mainmodule: MModule
 164
 165         # Modelbuilder used to know the model and the AST
 166         var modelbuilder: ModelBuilder
 167
 168         # The result of the RTA (used to know live types and methods)
 169         var runtime_type_analysis: RapidTypeAnalysis
 170
 171         # Where to generate tmp files
 172         var compile_dir: String is lazy do
 173                 var dir = modelbuilder.toolcontext.opt_compile_dir.value
 174                 if dir == null then dir = "nitj_compile"
 175                 return dir
 176         end
 177
 178         # Name of the generated executable
 179         var outname: String is lazy do
 180                 var name = modelbuilder.toolcontext.opt_output.value
 181                 if name == null then name = mainmodule.jname
 182                 return name
 183         end
 184
 185         # The list of all associated files
 186         # Used to generate .java files
 187         var files: Array[JavaCodeFile] = new Array[JavaCodeFile]
 188
 189         # Force the creation of a new file
 190         # The point is to avoid contamination between must-be-compiled-separately files
 191         fun new_file(name: String): JavaCodeFile do
 192                 var file = new JavaCodeFile(name)
 193                 files.add(file)
 194                 return file
 195         end
 196
 197         # Kind of visitor to use
 198         type VISITOR: JavaCompilerVisitor
 199
 200         # Initialize a visitor specific for the compiler engine
 201         fun new_visitor(filename: String): VISITOR do
 202                 return new JavaCompilerVisitor(self, new_file(filename))
 203         end
 204
 205         # Compile Nit code to Java
 206         fun do_compilation do
 207                 modelbuilder.toolcontext.info("NOT YET IMPLEMENTED", 0)
 208         end
 209 end
 210
 211 # The class visiting the AST
 212 #
 213 # A visitor is attached to one JavaCodeFile it writes into.
 214 class JavaCompilerVisitor
 215         super Visitor
 216
 217         # JavaCompiler used with this visitor
 218         type COMPILER: JavaCompiler
 219
 220         # The associated compiler
 221         var compiler: JavaCompiler
 222
 223         # The file to write generated code into
 224         var file: JavaCodeFile
 225
 226         # Code generation
 227
 228         # Add a line (will be suffixed by `\n`)
 229         fun add(line: String) do file.lines.add("{line}\n")
 230
 231         # Add a new partial line (no `\n` suffix)
 232         fun addn(line: String) do file.lines.add(line)
 233 end
 234
 235 # A file containing Java code.
 236 class JavaCodeFile
 237
 238         # File name
 239         var filename: String
 240
 241         # Lines to write
 242         var lines: List[String] = new List[String]
 243 end
 244
 245 redef class MEntity
 246         # A Java compatible name for `self`
 247         private fun jname: String do return name.to_cmangle
 248 end