nitg: makefile do not set -I in CFLAGS
[nit.git] / src / abstract_compiler.nit
index 2487069..9b4be94 100644 (file)
@@ -27,6 +27,8 @@ redef class ToolContext
        var opt_output: OptionString = new OptionString("Output file", "-o", "--output")
        # --no-cc
        var opt_no_cc: OptionBool = new OptionBool("Do not invoke C compiler", "--no-cc")
+       # --cc-paths
+       var opt_cc_path: OptionArray = new OptionArray("Set include path for C header files (may be used more than once)", "--cc-path")
        # --make-flags
        var opt_make_flags: OptionString = new OptionString("Additional options to make", "--make-flags")
        # --hardening
@@ -56,6 +58,42 @@ redef class ToolContext
 end
 
 redef class ModelBuilder
+       # The list of directories to search for included C headers (-I for C compilers)
+       # The list is initially set with :
+       #   * the toolcontext --cc-path option
+       #   * the NIT_CC_PATH environment variable
+       #   * some heuristics including the NIT_DIR environment variable and the progname of the process
+       # Path can be added (or removed) by the client
+       var cc_paths = new Array[String]
+
+       redef init(model, toolcontext)
+       do
+               super
+
+               # Look for the the Nit clib path
+               var path_env = "NIT_DIR".environ
+               if not path_env.is_empty then
+                       var libname = "{path_env}/clib"
+                       if libname.file_exists then cc_paths.add(libname)
+               end
+
+               var libname = "{sys.program_name.dirname}/../clib"
+               if libname.file_exists then cc_paths.add(libname.simplify_path)
+
+               if cc_paths.is_empty then
+                       toolcontext.error(null, "Cannot determine the nit clib path. define envvar NIT_DIR.")
+               end
+
+               # Add user defined cc_paths
+               cc_paths.append(toolcontext.opt_cc_path.value)
+
+               path_env = "NIT_CC_PATH".environ
+               if not path_env.is_empty then
+                       cc_paths.append(path_env.split_with(':'))
+               end
+
+       end
+
        protected fun write_and_make(compiler: AbstractCompiler)
        do
                var mainmodule = compiler.mainmodule
@@ -64,45 +102,65 @@ redef class ModelBuilder
                # A single C file regroups many compiled rumtime functions
                # Note that we do not try to be clever an a small change in a Nit source file may change the content of all the generated .c files
                var time0 = get_time
+               self.toolcontext.info("*** WRITING C ***", 1)
 
                ".nit_compile".mkdir
 
                var outname = self.toolcontext.opt_output.value
                if outname == null then
-                       outname = "{mainmodule.name}.bin"
+                       outname = "{mainmodule.name}"
                end
 
-               var hfilename = ".nit_compile/{mainmodule.name}.1.h"
-               var h = new OFStream.open(hfilename)
+               var hfilename = compiler.header.file.name + ".h"
+               var hfilepath = ".nit_compile/{hfilename}"
+               var h = new OFStream.open(hfilepath)
                for l in compiler.header.decl_lines do
                        h.write l
                        h.write "\n"
                end
+               for l in compiler.header.lines do
+                       h.write l
+                       h.write "\n"
+               end
                h.close
 
                var cfiles = new Array[String]
 
                for f in compiler.files do
                        var i = 0
-                       var file: nullable OFStream = null
+                       var hfile: nullable OFStream = null
                        var count = 0
+                       var cfilename = ".nit_compile/{f.name}.0.h"
+                       hfile = new OFStream.open(cfilename)
+                       hfile.write "#include \"{hfilename}\"\n"
+                       for key in f.required_declarations do
+                               if not compiler.provided_declarations.has_key(key) then
+                                       print "No provided declaration for {key}"
+                                       abort
+                               end
+                               hfile.write compiler.provided_declarations[key]
+                               hfile.write "\n"
+                       end
+                       hfile.close
+                       var file: nullable OFStream = null
                        for vis in f.writers do
-                               count += vis.lines.length
+                               if vis == compiler.header then continue
+                               var total_lines = vis.lines.length + vis.decl_lines.length
+                               if total_lines == 0 then continue
+                               count += total_lines
                                if file == null or count > 10000  then
                                        i += 1
                                        if file != null then file.close
-                                       var cfilename = ".nit_compile/{f.name}.{i}.c"
+                                       cfilename = ".nit_compile/{f.name}.{i}.c"
                                        self.toolcontext.info("new C source files to compile: {cfilename}", 3)
                                        cfiles.add(cfilename)
                                        file = new OFStream.open(cfilename)
-                                       file.write "#include \"{mainmodule.name}.1.h\"\n"
-                                       count = vis.lines.length
+                                       file.write "#include \"{f.name}.0.h\"\n"
+                                       count = total_lines
                                end
-                               if vis != compiler.header then
-                                       for l in vis.decl_lines do
-                                               file.write l
-                                               file.write "\n"
-                                       end
+                               for l in vis.decl_lines do
+                                       file.write l
+                                       file.write "\n"
                                end
                                for l in vis.lines do
                                        file.write l
@@ -119,23 +177,34 @@ redef class ModelBuilder
                var makename = ".nit_compile/{mainmodule.name}.mk"
                var makefile = new OFStream.open(makename)
 
-               makefile.write("CC = ccache cc\nCFLAGS = -g -O2\nLDFLAGS ?= \nLDLIBS  ?= -lm -lgc\n\n")
+               var cc_includes = ""
+               for p in cc_paths do
+                       #p = "..".join_path(p)
+                       cc_includes += " -I \"" + p + "\""
+               end
+               makefile.write("CC = ccache cc\nCFLAGS = -g -O2\nCINCL = {cc_includes}\nLDFLAGS ?= \nLDLIBS  ?= -lm -lgc\n\n")
                makefile.write("all: {outname}\n\n")
 
                var ofiles = new Array[String]
                # Compile each generated file
                for f in cfiles do
                        var o = f.strip_extension(".c") + ".o"
-                       makefile.write("{o}: {f}\n\t$(CC) $(CFLAGS) -D NONITCNI -c -o {o} {f}\n\n")
+                       makefile.write("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -D NONITCNI -c -o {o} {f}\n\n")
                        ofiles.add(o)
                end
+
+               # Add gc_choser.h to aditionnal bodies
+               var gc_chooser = new ExternCFile("{cc_paths.first}/gc_chooser.c", "-DWITH_LIBGC")
+               compiler.extern_bodies.add(gc_chooser)
+
                # Compile each required extern body into a specific .o
                for f in compiler.extern_bodies do
-                       var basename = f.basename(".c")
+                       var basename = f.filename.basename(".c")
                        var o = ".nit_compile/{basename}.extern.o"
-                       makefile.write("{o}: {f}\n\t$(CC) $(CFLAGS) -D NONITCNI -c -o {o} {f}\n\n")
+                       makefile.write("{o}: {f.filename}\n\t$(CC) $(CFLAGS) -D NONITCNI {f.cflags} -c -o {o} {f.filename}\n\n")
                        ofiles.add(o)
                end
+
                # Link edition
                makefile.write("{outname}: {ofiles.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outname} {ofiles.join(" ")} $(LDLIBS)\n\n")
                # Clean
@@ -144,7 +213,7 @@ redef class ModelBuilder
                self.toolcontext.info("Generated makefile: {makename}", 2)
 
                var time1 = get_time
-               self.toolcontext.info("*** END COMPILING TO C: {time1-time0} ***", 2)
+               self.toolcontext.info("*** END WRITING C: {time1-time0} ***", 2)
 
                # Execute the Makefile
 
@@ -175,8 +244,12 @@ end
 abstract class AbstractCompiler
        type VISITOR: AbstractCompilerVisitor
 
-       # The main module of the program
-       var mainmodule: MModule protected writable
+       # The main module of the program currently compiled
+       # Is assigned during the separate compilation
+       var mainmodule: MModule writable
+
+       # The real main module of the program
+       var realmainmodule: MModule
 
        # The modeulbuilder used to know the model and the AST
        var modelbuilder: ModelBuilder protected writable
@@ -187,9 +260,8 @@ abstract class AbstractCompiler
        init(mainmodule: MModule, modelbuilder: ModelBuilder)
        do
                self.mainmodule = mainmodule
+               self.realmainmodule = mainmodule
                self.modelbuilder = modelbuilder
-               var file = new_file(mainmodule.name)
-               self.header = new CodeWriter(file)
        end
 
        # Force the creation of a new file
@@ -209,10 +281,19 @@ abstract class AbstractCompiler
        fun new_visitor: VISITOR is abstract
 
        # Where global declaration are stored (the main .h)
-       #
-       # FIXME: should not have a global .h since it does not help recompilations
        var header: CodeWriter writable
 
+       # Provide a declaration that can be requested (before or latter) by a visitor
+       fun provide_declaration(key: String, s: String)
+       do
+               if self.provided_declarations.has_key(key) then
+                       assert self.provided_declarations[key] == s
+               end
+               self.provided_declarations[key] = s
+       end
+
+       private var provided_declarations = new HashMap[String, String]
+
        # Compile C headers
        # This method call compile_header_strucs method that has to be refined
        fun compile_header do
@@ -220,16 +301,7 @@ abstract class AbstractCompiler
                self.header.add_decl("#include <stdlib.h>")
                self.header.add_decl("#include <stdio.h>")
                self.header.add_decl("#include <string.h>")
-               self.header.add_decl("#ifndef NOBOEHM")
-               self.header.add_decl("#include <gc/gc.h>")
-               self.header.add_decl("#ifdef NOBOEHM_ATOMIC")
-               self.header.add_decl("#undef GC_MALLOC_ATOMIC")
-               self.header.add_decl("#define GC_MALLOC_ATOMIC(x) GC_MALLOC(x)")
-               self.header.add_decl("#endif /*NOBOEHM_ATOMIC*/")
-               self.header.add_decl("#else /*NOBOEHM*/")
-               self.header.add_decl("#define GC_MALLOC(x) calloc(1, (x))")
-               self.header.add_decl("#define GC_MALLOC_ATOMIC(x) calloc(1, (x))")
-               self.header.add_decl("#endif /*NOBOEHM*/")
+               self.header.add_decl("#include <gc_chooser.h>")
 
                compile_header_structs
 
@@ -266,6 +338,7 @@ abstract class AbstractCompiler
                end
                v.add_decl("int main(int argc, char** argv) \{")
                v.add("glob_argc = argc; glob_argv = argv;")
+               v.add("initialize_gc_option();")
                var main_type = mainmodule.sys_type
                if main_type != null then
                        var mainmodule = v.compiler.mainmodule
@@ -310,31 +383,11 @@ abstract class AbstractCompiler
                v.add("\}")
        end
 
-       # look for a needed .h and .c file for a given .nit source-file
-       # FIXME: bad API, parameter should be a MModule, not its source-file
-       fun add_extern(file: String)
-       do
-               file = file.strip_extension(".nit")
-               var tryfile = file + ".nit.h"
-               if tryfile.file_exists then
-                       self.header.add_decl("#include \"{"..".join_path(tryfile)}\"")
-               end
-               tryfile = file + "_nit.h"
-               if tryfile.file_exists then
-                       self.header.add_decl("#include \"{"..".join_path(tryfile)}\"")
-               end
-               tryfile = file + ".nit.c"
-               if tryfile.file_exists then
-                       self.extern_bodies.add(tryfile)
-               end
-               tryfile = file + "_nit.c"
-               if tryfile.file_exists then
-                       self.extern_bodies.add(tryfile)
-               end
-       end
-
        # List of additional .c files required to compile (native interface)
-       var extern_bodies = new ArraySet[String]
+       var extern_bodies = new Array[ExternCFile]
+
+       # This is used to avoid adding an extern file more than once
+       private var seen_extern = new ArraySet[String]
 
        # Generate code that check if an instance is correctly initialized
        fun generate_check_init_instance(mtype: MClassType) is abstract
@@ -437,6 +490,7 @@ end
 class CodeFile
        var name: String
        var writers = new Array[CodeWriter]
+       var required_declarations = new HashSet[String]
 end
 
 # Where to store generated lines
@@ -778,6 +832,45 @@ abstract class AbstractCompilerVisitor
        # (used for local or global declaration)
        fun add_decl(s: String) do self.writer.decl_lines.add(s)
 
+       # Request the presence of a global declaration
+       fun require_declaration(key: String)
+       do
+               self.writer.file.required_declarations.add(key)
+       end
+
+       # Add a declaration in the local-header
+       # The declaration is ensured to be present once
+       fun declare_once(s: String)
+       do
+               self.compiler.provide_declaration(s, s)
+               self.require_declaration(s)
+       end
+
+       # look for a needed .h and .c file for a given .nit source-file
+       # FIXME: bad API, parameter should be a MModule, not its source-file
+       fun add_extern(file: String)
+       do
+               file = file.strip_extension(".nit")
+               var tryfile = file + ".nit.h"
+               if tryfile.file_exists then
+                       self.declare_once("#include \"{"..".join_path(tryfile)}\"")
+               end
+               tryfile = file + "_nit.h"
+               if tryfile.file_exists then
+                       self.declare_once("#include \"{"..".join_path(tryfile)}\"")
+               end
+
+               if self.compiler.seen_extern.has(file) then return
+               self.compiler.seen_extern.add(file)
+               tryfile = file + ".nit.c"
+               if not tryfile.file_exists then
+                       tryfile = file + "_nit.c"
+                       if not tryfile.file_exists then return
+               end
+               var f = new ExternCFile(tryfile, "")
+               self.compiler.extern_bodies.add(f)
+       end
+
        # Return a new local runtime_variable initialized with the C expression `cexpr'.
        fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
        do
@@ -962,6 +1055,14 @@ class Frame
        var returnlabel: nullable String writable = null
 end
 
+# An extern C file to compile
+class ExternCFile
+       # The filename of the file
+       var filename: String
+       # Additionnal specific CC compiler -c flags
+       var cflags: String
+end
+
 redef class String
        # Mangle a string to be a unique valid C identifier
        fun to_cmangle: String
@@ -1511,7 +1612,7 @@ redef class AInternMethPropdef
                        v.ret(v.new_expr("glob_sys", ret.as(not null)))
                        return
                else if pname == "calloc_string" then
-                       v.ret(v.new_expr("(char*)GC_MALLOC_ATOMIC({arguments[1]})", ret.as(not null)))
+                       v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
                        return
                else if pname == "calloc_array" then
                        v.calloc_array(ret.as(not null), arguments)
@@ -1531,7 +1632,7 @@ redef class AInternMethPropdef
                        v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
                        return
                else if pname == "force_garbage_collection" then
-                       v.add("GC_gcollect();")
+                       v.add("nit_gcollect();")
                        return
                end
                v.add("printf(\"NOT YET IMPLEMENTED {class_name}:{mpropdef} at {location.to_s}\\n\");")
@@ -1552,7 +1653,7 @@ redef class AExternMethPropdef
                externname = nextern.text.substring(1, nextern.text.length-2)
                if location.file != null then
                        var file = location.file.filename
-                       v.compiler.add_extern(file)
+                       v.add_extern(file)
                end
                var res: nullable RuntimeVariable = null
                var ret = mpropdef.msignature.return_mtype
@@ -1584,7 +1685,7 @@ redef class AExternInitPropdef
                externname = nextern.text.substring(1, nextern.text.length-2)
                if location.file != null then
                        var file = location.file.filename
-                       v.compiler.add_extern(file)
+                       v.add_extern(file)
                end
                v.adapt_signature(mpropdef, arguments)
                var ret = arguments.first.mtype
@@ -2267,19 +2368,7 @@ end
 
 # Utils
 
-redef class HashSet[E]
-       init from(elements: Collection[E]) do
-               init
-               self.add_all(elements)
-       end
-end
-
 redef class Array[E]
-       init from(elements: Collection[E]) do
-               init
-               self.add_all(elements)
-       end
-
        # Return a new Array with the elements only contened in 'self' and not in 'o'
        fun -(o: Array[E]): Array[E] do
                var res = new Array[E]