1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
18 module abstract_compiler
22 import auto_super_init
26 # Add compiling options
27 redef class ToolContext
29 var opt_output
: OptionString = new OptionString("Output file", "-o", "--output")
31 var opt_no_cc
: OptionBool = new OptionBool("Do not invoke C compiler", "--no-cc")
33 var opt_no_main
: OptionBool = new OptionBool("Do not generate main entry point", "--no-main")
35 var opt_cc_path
: OptionArray = new OptionArray("Set include path for C header files (may be used more than once)", "--cc-path")
37 var opt_make_flags
: OptionString = new OptionString("Additional options to make", "--make-flags")
39 var opt_compile_dir
: OptionString = new OptionString("Directory used to generate temporary files", "--compile-dir")
41 var opt_hardening
: OptionBool = new OptionBool("Generate contracts in the C code against bugs in the compiler", "--hardening")
43 var opt_no_shortcut_range
: OptionBool = new OptionBool("Always insantiate a range and its iterator on 'for' loops", "--no-shortcut-range")
44 # --no-check-covariance
45 var opt_no_check_covariance
: OptionBool = new OptionBool("Disable type tests of covariant parameters (dangerous)", "--no-check-covariance")
46 # --no-check-attr-isset
47 var opt_no_check_attr_isset
: OptionBool = new OptionBool("Disable isset tests before each attribute access (dangerous)", "--no-check-attr-isset")
49 var opt_no_check_assert
: OptionBool = new OptionBool("Disable the evaluation of explicit 'assert' and 'as' (dangerous)", "--no-check-assert")
51 var opt_no_check_autocast
: OptionBool = new OptionBool("Disable implicit casts on unsafe expression usage (dangerous)", "--no-check-autocast")
53 var opt_no_check_other
: OptionBool = new OptionBool("Disable implicit tests: unset attribute, null receiver (dangerous)", "--no-check-other")
54 # --typing-test-metrics
55 var opt_typing_test_metrics
: OptionBool = new OptionBool("Enable static and dynamic count of all type tests", "--typing-test-metrics")
56 # --invocation-metrics
57 var opt_invocation_metrics
: OptionBool = new OptionBool("Enable static and dynamic count of all method invocations", "--invocation-metrics")
58 # --isset-checks-metrics
59 var opt_isset_checks_metrics
: OptionBool = new OptionBool("Enable static and dynamic count of isset checks before attributes access", "--isset-checks-metrics")
61 var opt_stacktrace
: OptionString = new OptionString("Control the generation of stack traces", "--stacktrace")
63 var opt_no_gcc_directive
= new OptionArray("Disable a advanced gcc directives for optimization", "--no-gcc-directive")
65 var opt_release
= new OptionBool("Compile in release mode and finalize application", "--release")
70 self.option_context
.add_option
(self.opt_output
, self.opt_no_cc
, self.opt_no_main
, self.opt_make_flags
, self.opt_compile_dir
, self.opt_hardening
, self.opt_no_shortcut_range
)
71 self.option_context
.add_option
(self.opt_no_check_covariance
, self.opt_no_check_attr_isset
, self.opt_no_check_assert
, self.opt_no_check_autocast
, self.opt_no_check_other
)
72 self.option_context
.add_option
(self.opt_typing_test_metrics
, self.opt_invocation_metrics
, self.opt_isset_checks_metrics
)
73 self.option_context
.add_option
(self.opt_stacktrace
)
74 self.option_context
.add_option
(self.opt_no_gcc_directive
)
75 self.option_context
.add_option
(self.opt_release
)
78 redef fun process_options
(args
)
82 var st
= opt_stacktrace
.value
83 if st
== null or st
== "none" or st
== "libunwind" or st
== "nitstack" then
85 else if st
== "auto" then
87 opt_stacktrace
.value
= null
89 print
"Error: unknown value `{st}` for --stacktrace. Use `none`, `libunwind`, `nitstack` or `auto`."
95 redef class ModelBuilder
96 # The compilation directory
97 var compile_dir
: String
99 # Simple indirection to `Toolchain::write_and_make`
100 protected fun write_and_make
(compiler
: AbstractCompiler)
102 var platform
= compiler
.mainmodule
.target_platform
104 if platform
== null then
105 toolchain
= new MakefileToolchain(toolcontext
)
107 toolchain
= platform
.toolchain
(toolcontext
)
109 compile_dir
= toolchain
.compile_dir
110 toolchain
.write_and_make compiler
115 fun toolchain
(toolcontext
: ToolContext): Toolchain is abstract
119 var toolcontext
: ToolContext
121 fun compile_dir
: String
123 var compile_dir
= toolcontext
.opt_compile_dir
.value
124 if compile_dir
== null then compile_dir
= ".nit_compile"
128 fun write_and_make
(compiler
: AbstractCompiler) is abstract
131 class MakefileToolchain
133 # The list of directories to search for included C headers (-I for C compilers)
134 # The list is initially set with :
135 # * the toolcontext --cc-path option
136 # * the NIT_CC_PATH environment variable
137 # * `toolcontext.nit_dir`
138 # Path can be added (or removed) by the client
139 var cc_paths
= new Array[String]
141 protected fun gather_cc_paths
143 # Look for the the Nit clib path
144 var path_env
= toolcontext
.nit_dir
145 if path_env
!= null then
146 var libname
= "{path_env}/clib"
147 if libname
.file_exists
then cc_paths
.add
(libname
)
150 if cc_paths
.is_empty
then
151 toolcontext
.error
(null, "Cannot determine the nit clib path. define envvar NIT_DIR.")
154 # Add user defined cc_paths
155 cc_paths
.append
(toolcontext
.opt_cc_path
.value
)
157 path_env
= "NIT_CC_PATH".environ
158 if not path_env
.is_empty
then
159 cc_paths
.append
(path_env
.split_with
(':'))
163 redef fun write_and_make
(compiler
)
167 var mainmodule
= compiler
.mainmodule
168 var compile_dir
= compile_dir
170 # Generate the .h and .c files
171 # A single C file regroups many compiled rumtime functions
172 # 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
174 self.toolcontext
.info
("*** WRITING C ***", 1)
178 var cfiles
= new Array[String]
179 write_files
(compiler
, compile_dir
, cfiles
)
181 # Generate the Makefile
183 write_makefile
(compiler
, compile_dir
, cfiles
)
186 self.toolcontext
.info
("*** END WRITING C: {time1-time0} ***", 2)
188 # Execute the Makefile
190 if self.toolcontext
.opt_no_cc
.value
then return
193 self.toolcontext
.info
("*** COMPILING C ***", 1)
195 compile_c_code
(compiler
, compile_dir
)
198 self.toolcontext
.info
("*** END COMPILING C: {time1-time0} ***", 2)
201 fun write_files
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
203 if self.toolcontext
.opt_stacktrace
.value
== "nitstack" then compiler
.build_c_to_nit_bindings
205 var platform
= compiler
.mainmodule
.target_platform
206 var cc_opt_with_libgc
= "-DWITH_LIBGC"
207 if platform
!= null and not platform
.supports_libgc
then cc_opt_with_libgc
= ""
209 # Add gc_choser.h to aditionnal bodies
210 var gc_chooser
= new ExternCFile("gc_chooser.c", cc_opt_with_libgc
)
211 compiler
.extern_bodies
.add
(gc_chooser
)
212 compiler
.files_to_copy
.add
"{cc_paths.first}/gc_chooser.c"
213 compiler
.files_to_copy
.add
"{cc_paths.first}/gc_chooser.h"
216 var m2m
= toolcontext
.modelbuilder
.mmodule2nmodule
217 for m
in compiler
.mainmodule
.in_importation
.greaters
do
218 compiler
.finalize_ffi_for_module
(m
)
221 # Copy original .[ch] files to compile_dir
222 for src
in compiler
.files_to_copy
do
223 var basename
= src
.basename
("")
224 var dst
= "{compile_dir}/{basename}"
228 var hfilename
= compiler
.header
.file
.name
+ ".h"
229 var hfilepath
= "{compile_dir}/{hfilename}"
230 var h
= new OFStream.open
(hfilepath
)
231 for l
in compiler
.header
.decl_lines
do
235 for l
in compiler
.header
.lines
do
241 for f
in compiler
.files
do
243 var hfile
: nullable OFStream = null
245 var cfilename
= "{f.name}.0.h"
246 var cfilepath
= "{compile_dir}/{cfilename}"
247 hfile
= new OFStream.open
(cfilepath
)
248 hfile
.write
"#include \"{hfilename}\
"\n"
249 for key
in f
.required_declarations
do
250 if not compiler
.provided_declarations
.has_key
(key
) then
251 var node
= compiler
.requirers_of_declarations
.get_or_null
(key
)
253 node
.debug
"No provided declaration for {key}"
255 print
"No provided declaration for {key}"
259 hfile
.write compiler
.provided_declarations
[key
]
263 var file
: nullable OFStream = null
264 for vis
in f
.writers
do
265 if vis
== compiler
.header
then continue
266 var total_lines
= vis
.lines
.length
+ vis
.decl_lines
.length
267 if total_lines
== 0 then continue
269 if file
== null or count
> 10000 then
271 if file
!= null then file
.close
272 cfilename
= "{f.name}.{i}.c"
273 cfilepath
= "{compile_dir}/{cfilename}"
274 self.toolcontext
.info
("new C source files to compile: {cfilepath}", 3)
275 cfiles
.add
(cfilename
)
276 file
= new OFStream.open
(cfilepath
)
277 file
.write
"#include \"{f.name}.0.h\
"\n"
280 for l
in vis
.decl_lines
do
284 for l
in vis
.lines
do
289 if file
!= null then file
.close
292 self.toolcontext
.info
("Total C source files to compile: {cfiles.length}", 2)
295 fun makefile_name
(mainmodule
: MModule): String do return "{mainmodule.name}.mk"
297 fun default_outname
(mainmodule
: MModule): String do return mainmodule
.name
299 fun write_makefile
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
301 var mainmodule
= compiler
.mainmodule
303 var outname
= self.toolcontext
.opt_output
.value
or else default_outname
(mainmodule
)
305 var orig_dir
=".." # FIXME only works if `compile_dir` is a subdirectory of cwd
306 var outpath
= orig_dir
.join_path
(outname
).simplify_path
307 var makename
= makefile_name
(mainmodule
)
308 var makepath
= "{compile_dir}/{makename}"
309 var makefile
= new OFStream.open
(makepath
)
313 cc_includes
+= " -I \"" + p + "\
""
316 var linker_options
= new HashSet[String]
317 var m2m
= toolcontext
.modelbuilder
.mmodule2nmodule
318 for m
in mainmodule
.in_importation
.greaters
do
319 var libs
= m
.collect_linker_libs
320 if libs
!= null then linker_options
.add_all
(libs
)
323 makefile
.write
("CC = ccache cc\nCFLAGS = -g -O2 -Wno-unused-value -Wno-switch\nCINCL = {cc_includes}\nLDFLAGS ?= \nLDLIBS ?= -lm -lgc {linker_options.join(" ")}\n\n")
325 var ost
= toolcontext
.opt_stacktrace
.value
326 if ost
== "libunwind" or ost
== "nitstack" then makefile
.write
("NEED_LIBUNWIND := YesPlease\n")
328 # Dynamic adaptations
329 # While `platform` enable complex toolchains, they are statically applied
330 # For a dynamic adaptsation of the compilation, the generated Makefile should check and adapt things itself
332 # Check and adapt the targeted system
333 makefile
.write
("uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')\n")
334 makefile
.write
("ifeq ($(uname_S),Darwin)\n")
335 # remove -lunwind since it is already included on macosx
336 makefile
.write
("\tNEED_LIBUNWIND :=\n")
337 makefile
.write
("endif\n\n")
339 # Check and adapt for the compiler used
340 # clang need an additionnal `-Qunused-arguments`
341 makefile
.write
("clang_check := $(shell sh -c '$(CC) -v 2>&1 | grep -q clang; echo $$?')\nifeq ($(clang_check), 0)\n\tCFLAGS += -Qunused-arguments\nendif\n")
343 makefile
.write
("ifdef NEED_LIBUNWIND\n\tLDLIBS += -lunwind\nendif\n")
345 makefile
.write
("all: {outpath}\n\n")
347 var ofiles
= new Array[String]
348 var dep_rules
= new Array[String]
349 # Compile each generated file
351 var o
= f
.strip_extension
(".c") + ".o"
352 makefile
.write
("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -c -o {o} {f}\n\n")
357 var java_files
= new Array[ExternFile]
359 # Compile each required extern body into a specific .o
360 for f
in compiler
.extern_bodies
do
361 var o
= f
.makefile_rule_name
362 var ff
= f
.filename
.basename
("")
363 makefile
.write
("{o}: {ff}\n")
364 makefile
.write
("\t{f.makefile_rule_content}\n\n")
365 dep_rules
.add
(f
.makefile_rule_name
)
367 if f
.compiles_to_o_file
then ofiles
.add
(o
)
368 if f
.add_to_jar
then java_files
.add
(f
)
371 if not java_files
.is_empty
then
372 var jar_file
= "{outpath}.jar"
374 var class_files_array
= new Array[String]
375 for f
in java_files
do class_files_array
.add
(f
.makefile_rule_name
)
376 var class_files
= class_files_array
.join
(" ")
378 makefile
.write
("{jar_file}: {class_files}\n")
379 makefile
.write
("\tjar cf {jar_file} {class_files}\n\n")
380 dep_rules
.add jar_file
384 makefile
.write
("{outpath}: {dep_rules.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outpath} {ofiles.join(" ")} $(LDLIBS)\n\n")
386 makefile
.write
("clean:\n\trm {ofiles.join(" ")} 2>/dev/null\n\n")
388 self.toolcontext
.info
("Generated makefile: {makepath}", 2)
391 fun compile_c_code
(compiler
: AbstractCompiler, compile_dir
: String)
393 var makename
= makefile_name
(compiler
.mainmodule
)
395 var makeflags
= self.toolcontext
.opt_make_flags
.value
396 if makeflags
== null then makeflags
= ""
397 self.toolcontext
.info
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags}", 2)
400 if self.toolcontext
.verbose_level
>= 3 then
401 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1")
403 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1 >/dev/null")
406 toolcontext
.error
(null, "make failed! Error code: {res}.")
411 # Singleton that store the knowledge about the compilation process
412 abstract class AbstractCompiler
413 type VISITOR: AbstractCompilerVisitor
415 # Table corresponding c_names to nit names (methods)
416 var names
= new HashMap[String, String]
418 # The main module of the program currently compiled
419 # Is assigned during the separate compilation
420 var mainmodule
: MModule writable
422 # The real main module of the program
423 var realmainmodule
: MModule
425 # The modeulbuilder used to know the model and the AST
426 var modelbuilder
: ModelBuilder protected writable
428 # Is hardening asked? (see --hardening)
429 fun hardening
: Bool do return self.modelbuilder
.toolcontext
.opt_hardening
.value
431 init(mainmodule
: MModule, modelbuilder
: ModelBuilder)
433 self.mainmodule
= mainmodule
434 self.realmainmodule
= mainmodule
435 self.modelbuilder
= modelbuilder
438 # Force the creation of a new file
439 # The point is to avoid contamination between must-be-compiled-separately files
440 fun new_file
(name
: String): CodeFile
442 var f
= new CodeFile(name
)
447 # The list of all associated files
448 # Used to generate .c files
449 var files
: List[CodeFile] = new List[CodeFile]
451 # Initialize a visitor specific for a compiler engine
452 fun new_visitor
: VISITOR is abstract
454 # Where global declaration are stored (the main .h)
455 var header
: CodeWriter writable
457 # Provide a declaration that can be requested (before or latter) by a visitor
458 fun provide_declaration
(key
: String, s
: String)
460 if self.provided_declarations
.has_key
(key
) then
461 assert self.provided_declarations
[key
] == s
463 self.provided_declarations
[key
] = s
466 private var provided_declarations
= new HashMap[String, String]
468 private var requirers_of_declarations
= new HashMap[String, ANode]
470 # Builds the .c and .h files to be used when generating a Stack Trace
471 # Binds the generated C function names to Nit function names
472 fun build_c_to_nit_bindings
474 var compile_dir
= modelbuilder
.compile_dir
476 var stream
= new OFStream.open
("{compile_dir}/c_functions_hash.c")
477 stream
.write
("#include <string.h>\n")
478 stream
.write
("#include <stdlib.h>\n")
479 stream
.write
("#include \"c_functions_hash
.h\
"\n")
480 stream
.write
("typedef struct C_Nit_Names\{char* name; char* nit_name;\}C_Nit_Names;\n")
481 stream
.write
("const char* get_nit_name(register const char* procproc, register unsigned int len)\{\n")
482 stream
.write
("char* procname = malloc(len+1);")
483 stream
.write
("memcpy(procname, procproc, len);")
484 stream
.write
("procname[len] = '\\0';")
485 stream
.write
("static const C_Nit_Names map[{names.length}] = \{\n")
486 for i
in names
.keys
do
489 stream.write("\
",\"")
490 stream.write(names[i])
491 stream.write("\
"\},\n")
493 stream
.write
("\};\n")
494 stream
.write
("int i;")
495 stream
.write
("for(i = 0; i < {names.length}; i++)\{")
496 stream
.write
("if(strcmp(procname,map[i].name) == 0)\{")
497 stream
.write
("free(procname);")
498 stream
.write
("return map[i].nit_name;")
501 stream
.write
("free(procname);")
502 stream
.write
("return NULL;")
506 stream
= new OFStream.open
("{compile_dir}/c_functions_hash.h")
507 stream
.write
("const char* get_nit_name(register const char* procname, register unsigned int len);\n")
510 extern_bodies
.add
(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
514 # This method call compile_header_strucs method that has to be refined
515 fun compile_header
do
517 var toolctx
= modelbuilder
.toolcontext
518 self.header
.add_decl
("#include <stdlib.h>")
519 self.header
.add_decl
("#include <stdio.h>")
520 self.header
.add_decl
("#include <string.h>")
521 self.header
.add_decl
("#include \"gc_chooser
.h\
"")
522 self.header
.add_decl
("#ifdef ANDROID")
523 self.header
.add_decl
(" #include <android/log.h>")
524 self.header
.add_decl
(" #define PRINT_ERROR(...) (void)__android_log_print(ANDROID_LOG_WARN, \"Nit\
", __VA_ARGS__)")
525 self.header
.add_decl
("#else")
526 self.header
.add_decl
(" #define PRINT_ERROR(...) fprintf(stderr, __VA_ARGS__)")
527 self.header
.add_decl
("#endif")
529 compile_header_structs
530 compile_nitni_structs
532 var gccd_disable
= modelbuilder
.toolcontext
.opt_no_gcc_directive
.value
533 if gccd_disable
.has
("noreturn") or gccd_disable
.has
("all") then
534 # Signal handler function prototype
535 self.header
.add_decl
("void show_backtrace(int);")
537 self.header
.add_decl
("void show_backtrace(int) __attribute__ ((noreturn));")
540 if gccd_disable
.has
("likely") or gccd_disable
.has
("all") then
541 self.header
.add_decl
("#define likely(x) (x)")
542 self.header
.add_decl
("#define unlikely(x) (x)")
543 else if gccd_disable
.has
("correct-likely") then
544 # invert the `likely` definition
545 # Used by masochists to bench the worst case
546 self.header
.add_decl
("#define likely(x) __builtin_expect((x),0)")
547 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),1)")
549 self.header
.add_decl
("#define likely(x) __builtin_expect((x),1)")
550 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),0)")
553 # Global variable used by intern methods
554 self.header
.add_decl
("extern int glob_argc;")
555 self.header
.add_decl
("extern char **glob_argv;")
556 self.header
.add_decl
("extern val *glob_sys;")
559 # Declaration of structures for live Nit types
560 protected fun compile_header_structs
is abstract
562 # Declaration of structures for nitni undelying the FFI
563 protected fun compile_nitni_structs
is abstract
565 # Generate the main C function.
567 # * allocate the Sys object if it exists
568 # * call init if is exists
569 # * call main if it exists
570 fun compile_main_function
572 var v
= self.new_visitor
573 v
.add_decl
("#include <signal.h>")
574 var ost
= modelbuilder
.toolcontext
.opt_stacktrace
.value
575 var platform
= mainmodule
.target_platform
578 if platform
!= null and not platform
.supports_libunwind
then
583 modelbuilder
.toolcontext
.opt_stacktrace
.value
= ost
586 if platform
!= null and platform
.no_main
then modelbuilder
.toolcontext
.opt_no_main
.value
= true
588 if ost
== "nitstack" or ost
== "libunwind" then
589 v
.add_decl
("#define UNW_LOCAL_ONLY")
590 v
.add_decl
("#include <libunwind.h>")
591 if ost
== "nitstack" then
592 v
.add_decl
("#include \"c_functions_hash
.h\
"")
595 v
.add_decl
("int glob_argc;")
596 v
.add_decl
("char **glob_argv;")
597 v
.add_decl
("val *glob_sys;")
599 if self.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
600 for tag
in count_type_test_tags
do
601 v
.add_decl
("long count_type_test_resolved_{tag};")
602 v
.add_decl
("long count_type_test_unresolved_{tag};")
603 v
.add_decl
("long count_type_test_skipped_{tag};")
604 v
.compiler
.header
.add_decl
("extern long count_type_test_resolved_{tag};")
605 v
.compiler
.header
.add_decl
("extern long count_type_test_unresolved_{tag};")
606 v
.compiler
.header
.add_decl
("extern long count_type_test_skipped_{tag};")
610 if self.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then
611 v
.add_decl
("long count_invoke_by_tables;")
612 v
.add_decl
("long count_invoke_by_direct;")
613 v
.add_decl
("long count_invoke_by_inline;")
614 v
.compiler
.header
.add_decl
("extern long count_invoke_by_tables;")
615 v
.compiler
.header
.add_decl
("extern long count_invoke_by_direct;")
616 v
.compiler
.header
.add_decl
("extern long count_invoke_by_inline;")
619 if self.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
620 v
.add_decl
("long count_attr_reads = 0;")
621 v
.add_decl
("long count_isset_checks = 0;")
622 v
.compiler
.header
.add_decl
("extern long count_attr_reads;")
623 v
.compiler
.header
.add_decl
("extern long count_isset_checks;")
626 v
.add_decl
("void sig_handler(int signo)\{")
627 v
.add_decl
("PRINT_ERROR(\"Caught signal
: %s\\n\
", strsignal(signo));")
628 v
.add_decl
("show_backtrace(signo);")
631 v
.add_decl
("void show_backtrace (int signo) \{")
632 if ost
== "nitstack" or ost
== "libunwind" then
633 v
.add_decl
("char* opt = getenv(\"NIT_NO_STACK\
");")
634 v
.add_decl
("unw_cursor_t cursor;")
635 v
.add_decl
("if(opt==NULL)\{")
636 v
.add_decl
("unw_context_t uc;")
637 v
.add_decl
("unw_word_t ip;")
638 v
.add_decl
("char* procname = malloc(sizeof(char) * 100);")
639 v
.add_decl
("unw_getcontext(&uc);")
640 v
.add_decl
("unw_init_local(&cursor, &uc);")
641 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
642 v
.add_decl
("PRINT_ERROR(\"-- Stack Trace ------------------------------\\n\
");")
643 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
644 v
.add_decl
("while (unw_step(&cursor) > 0) \{")
645 v
.add_decl
(" unw_get_proc_name(&cursor, procname, 100, &ip);")
646 if ost
== "nitstack" then
647 v
.add_decl
(" const char* recv = get_nit_name(procname, strlen(procname));")
648 v
.add_decl
(" if (recv != NULL)\{")
649 v
.add_decl
(" PRINT_ERROR(\"` %s\\n\", recv);")
650 v.add_decl(" \}else\{")
651 v.add_decl(" PRINT_ERROR(\"` %s\\n\
", procname);")
654 v
.add_decl
(" PRINT_ERROR(\"` %s \\n\",procname);")
657 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
658 v.add_decl("free(procname);")
661 v.add_decl("exit(signo);")
664 if modelbuilder.toolcontext.opt_no_main.value then
665 v.add_decl("int nit_main(int argc, char** argv) \{")
667 v.add_decl("int main(int argc, char** argv) \{")
670 v.add("signal(SIGABRT, sig_handler);")
671 v.add("signal(SIGFPE, sig_handler);")
672 v.add("signal(SIGILL, sig_handler);")
673 v.add("signal(SIGINT, sig_handler);")
674 v.add("signal(SIGTERM, sig_handler);")
675 v.add("signal(SIGSEGV, sig_handler);")
676 v.add("signal(SIGPIPE, sig_handler);")
678 v.add("glob_argc = argc; glob_argv = argv;")
679 v.add("initialize_gc_option();")
680 var main_type = mainmodule.sys_type
681 if main_type != null then
682 var mainmodule = v.compiler.mainmodule
683 var glob_sys = v.init_instance(main_type)
684 v.add("glob_sys = {glob_sys};")
685 var main_init = mainmodule.try_get_primitive_method("init", main_type.mclass)
686 if main_init != null then
687 v.send(main_init, [glob_sys])
689 var main_method = mainmodule.try_get_primitive_method("main", main_type.mclass)
690 if main_method != null then
691 v.send(main_method, [glob_sys])
695 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
696 v.add_decl("long count_type_test_resolved_total = 0;")
697 v.add_decl("long count_type_test_unresolved_total = 0;")
698 v.add_decl("long count_type_test_skipped_total = 0;")
699 v.add_decl("long count_type_test_total_total = 0;")
700 for tag in count_type_test_tags do
701 v.add_decl("long count_type_test_total_{tag};")
702 v.add("count_type_test_total_{tag} = count_type_test_resolved_{tag} + count_type_test_unresolved_{tag} + count_type_test_skipped_{tag};")
703 v.add("count_type_test_resolved_total += count_type_test_resolved_{tag};")
704 v.add("count_type_test_unresolved_total += count_type_test_unresolved_{tag};")
705 v.add("count_type_test_skipped_total += count_type_test_skipped_{tag};")
706 v.add("count_type_test_total_total += count_type_test_total_{tag};")
708 v.add("printf(\"# dynamic count_type_test: total %l\\n\");")
709 v.add("printf(\"\\tresolved\\tunresolved\\tskipped\\ttotal\\n\");")
710 var tags = count_type_test_tags.to_a
713 v.add("printf(\"{tag}\");")
714 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_resolved_{tag}, 100.0*count_type_test_resolved_{tag}/count_type_test_total_total);")
715 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_unresolved_{tag}, 100.0*count_type_test_unresolved_{tag}/count_type_test_total_total);")
716 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_skipped_{tag}, 100.0*count_type_test_skipped_{tag}/count_type_test_total_total);")
717 v.add("printf(\"\\t%ld (%.2f%%)\\n\", count_type_test_total_{tag}, 100.0*count_type_test_total_{tag}/count_type_test_total_total);")
721 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
722 v.add_decl("long count_invoke_total;")
723 v.add("count_invoke_total = count_invoke_by_tables + count_invoke_by_direct + count_invoke_by_inline;")
724 v.add("printf(\"# dynamic count_invocation: total %ld\\n\", count_invoke_total);")
725 v.add("printf(\"by table: %ld (%.2f%%)\\n\", count_invoke_by_tables, 100.0*count_invoke_by_tables/count_invoke_total);")
726 v.add("printf(\"direct: %ld (%.2f%%)\\n\", count_invoke_by_direct, 100.0*count_invoke_by_direct/count_invoke_total);")
727 v.add("printf(\"inlined: %ld (%.2f%%)\\n\", count_invoke_by_inline, 100.0*count_invoke_by_inline/count_invoke_total);")
730 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
731 v.add("printf(\"# dynamic attribute reads: %ld\\n\", count_attr_reads);")
732 v.add("printf(\"# dynamic isset checks: %ld\\n\", count_isset_checks);")
739 # List of additional files required to compile (FFI)
740 var extern_bodies = new Array[ExternFile]
742 # List of source files to copy over to the compile dir
743 var files_to_copy = new Array[String]
745 # This is used to avoid adding an extern file more than once
746 private var seen_extern = new ArraySet[String]
748 # Generate code that initialize the attributes on a new instance
749 fun generate_init_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
751 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
752 self.mainmodule.linearize_mclassdefs(cds)
754 var n = self.modelbuilder.mclassdef2nclassdef[cd]
755 for npropdef in n.n_propdefs do
756 if npropdef isa AAttrPropdef then
757 npropdef.init_expr(v, recv)
763 # Generate code that check if an attribute is correctly initialized
764 fun generate_check_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
766 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
767 self.mainmodule.linearize_mclassdefs(cds)
769 var n = self.modelbuilder.mclassdef2nclassdef[cd]
770 for npropdef in n.n_propdefs do
771 if npropdef isa AAttrPropdef then
772 npropdef.check_expr(v, recv)
780 var count_type_test_tags: Array[String] = ["isa", "as", "auto", "covariance", "erasure"]
781 var count_type_test_resolved: HashMap[String, Int] = init_count_type_test_tags
782 var count_type_test_unresolved: HashMap[String, Int] = init_count_type_test_tags
783 var count_type_test_skipped: HashMap[String, Int] = init_count_type_test_tags
785 protected fun init_count_type_test_tags: HashMap[String, Int]
787 var res = new HashMap[String, Int]
788 for tag in count_type_test_tags do
794 # Display stats about compilation process
796 # * type tests against resolved types (`x
isa Collection[Animal]`)
797 # * type tests against unresolved types (`x
isa Collection[E
]`)
798 # * type tests skipped
803 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
804 print "# static count_type_test"
805 print "\tresolved:\tunresolved\tskipped\ttotal"
806 var count_type_test_total = init_count_type_test_tags
807 count_type_test_resolved["total"] = 0
808 count_type_test_unresolved["total"] = 0
809 count_type_test_skipped["total"] = 0
810 count_type_test_total["total"] = 0
811 for tag in count_type_test_tags do
812 count_type_test_total[tag] = count_type_test_resolved[tag] + count_type_test_unresolved[tag] + count_type_test_skipped[tag]
813 count_type_test_resolved["total"] += count_type_test_resolved[tag]
814 count_type_test_unresolved["total"] += count_type_test_unresolved[tag]
815 count_type_test_skipped["total"] += count_type_test_skipped[tag]
816 count_type_test_total["total"] += count_type_test_total[tag]
818 var count_type_test = count_type_test_total["total"]
819 var tags = count_type_test_tags.to_a
823 printn "\t{count_type_test_resolved[tag]} ({div(count_type_test_resolved[tag],count_type_test)}%)"
824 printn "\t{count_type_test_unresolved[tag]} ({div(count_type_test_unresolved[tag],count_type_test)}%)"
825 printn "\t{count_type_test_skipped[tag]} ({div(count_type_test_skipped[tag],count_type_test)}%)"
826 printn "\t{count_type_test_total[tag]} ({div(count_type_test_total[tag],count_type_test)}%)"
832 fun finalize_ffi_for_module(mmodule: MModule) do mmodule.finalize_ffi(self)
835 # Avoid division by zero by returning the string "n/a"
836 fun div(a,b:Int):String
838 if b == 0 then return "n/a"
839 return ((a*10000/b).to_f / 100.0).to_precision(2)
843 # A file unit (may be more than one file if
844 # A file unit aim to be autonomous and is made or one or more `CodeWriter`s
847 var writers = new Array[CodeWriter]
848 var required_declarations = new HashSet[String]
851 # Where to store generated lines
854 var lines: List[String] = new List[String]
855 var decl_lines: List[String] = new List[String]
857 # Add a line in the main part of the generated C
858 fun add(s: String) do self.lines.add(s)
861 # (used for local or global declaration)
862 fun add_decl(s: String) do self.decl_lines.add(s)
867 file.writers.add(self)
871 # A visitor on the AST of property definition that generate the C code.
872 abstract class AbstractCompilerVisitor
874 type COMPILER: AbstractCompiler
876 # The associated compiler
877 var compiler: COMPILER
879 # The current visited AST node
880 var current_node: nullable ANode writable = null
882 # The current `Frame`
883 var frame: nullable Frame writable
885 # Alias for self.compiler.mainmodule.object_type
886 fun object_type: MClassType do return self.compiler.mainmodule.object_type
888 # Alias for self.compiler.mainmodule.bool_type
889 fun bool_type: MClassType do return self.compiler.mainmodule.bool_type
891 var writer: CodeWriter
893 init(compiler: COMPILER)
895 self.compiler = compiler
896 self.writer = new CodeWriter(compiler.files.last)
899 # Force to get the primitive class named `name
` or abort
900 fun get_class(name: String): MClass do return self.compiler.mainmodule.get_primitive_class(name)
902 # Force to get the primitive property named `name
` in the instance `recv
` or abort
903 fun get_property(name: String, recv: MType): MMethod
905 assert recv isa MClassType
906 return self.compiler.modelbuilder.force_get_primitive_method(self.current_node.as(not null), name, recv.mclass, self.compiler.mainmodule)
909 fun compile_callsite(callsite: CallSite, args: Array[RuntimeVariable]): nullable RuntimeVariable
911 return self.send(callsite.mproperty, args)
914 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable is abstract
916 fun calloc_array(ret_type: MType, arguments: Array[RuntimeVariable]) is abstract
918 fun native_array_def(pname: String, ret_type: nullable MType, arguments: Array[RuntimeVariable]) is abstract
920 # Transform varargs, in raw arguments, into a single argument of type `Array`
921 # Note: this method modify the given `args
`
922 # If there is no vararg, then `args
` is not modified.
923 fun varargize(mpropdef: MPropDef, msignature: MSignature, args: Array[RuntimeVariable])
925 var recv = args.first
926 var vararg_rank = msignature.vararg_rank
927 if vararg_rank >= 0 then
928 assert args.length >= msignature.arity + 1 # because of self
930 args = new Array[RuntimeVariable]
932 args.add(rawargs.first) # recv
934 for i in [0..vararg_rank[ do
935 args.add(rawargs[i+1])
938 var vararg_lastrank = vararg_rank + rawargs.length-1-msignature.arity
939 var vararg = new Array[RuntimeVariable]
940 for i in [vararg_rank..vararg_lastrank] do
941 vararg.add(rawargs[i+1])
944 var elttype = msignature.mparameters[vararg_rank].mtype
945 args.add(self.vararg_instance(mpropdef, recv, vararg, elttype))
947 for i in [vararg_lastrank+1..rawargs.length-1[ do
948 args.add(rawargs[i+1])
951 rawargs.add_all(args)
957 # Anchor a type to the main module and the current receiver
958 fun anchor(mtype: MType): MType
960 if not mtype.need_anchor then return mtype
961 return mtype.anchor_to(self.compiler.mainmodule, self.frame.receiver)
964 fun resolve_for(mtype: MType, recv: RuntimeVariable): MType
966 if not mtype.need_anchor then return mtype
967 return mtype.resolve_for(recv.mcasttype, self.frame.receiver, self.compiler.mainmodule, true)
970 # Unsafely cast a value to a new type
971 # ie the result share the same C variable but my have a different mcasttype
972 # NOTE: if the adaptation is useless then `value
` is returned as it.
973 # ENSURE: `result
.name
== value
.name
`
974 fun autoadapt(value: RuntimeVariable, mtype: MType): RuntimeVariable
976 mtype = self.anchor(mtype)
977 var valmtype = value.mcasttype
978 if valmtype.is_subtype(self.compiler.mainmodule, null, mtype) then
982 if valmtype isa MNullableType and valmtype.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
983 var res = new RuntimeVariable(value.name, valmtype, valmtype.mtype)
986 var res = new RuntimeVariable(value.name, valmtype, mtype)
991 # Generate a super call from a method definition
992 fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
994 fun adapt_signature(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
996 # Box or unbox a value to another type iff a C type conversion is needed
997 # ENSURE: `result
.mtype
.ctype
== mtype
.ctype
`
998 fun autobox(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1000 # Generate a polymorphic subtype test
1001 fun type_test(value: RuntimeVariable, mtype: MType, tag: String): RuntimeVariable is abstract
1003 # Generate the code required to dynamically check if 2 objects share the same runtime type
1004 fun is_same_type_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1006 # Generate a Nit "is" for two runtime_variables
1007 fun equal_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1011 # Generate a static call on a method definition
1012 fun call(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1014 # Generate a polymorphic send for the method `m
` and the arguments `args
`
1015 fun send(m: MMethod, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1017 # Generate a monomorphic send for the method `m
`, the type `t
` and the arguments `args
`
1018 fun monomorphic_send(m: MMethod, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1020 assert t isa MClassType
1021 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
1022 return self.call(propdef, t, args)
1025 # Generate a monomorphic super send from the method `m
`, the type `t
` and the arguments `args
`
1026 fun monomorphic_super_send(m: MMethodDef, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1028 assert t isa MClassType
1029 m = m.lookup_next_definition(self.compiler.mainmodule, t)
1030 return self.call(m, t, args)
1033 # Attributes handling
1035 # Generate a polymorphic attribute is_set test
1036 fun isset_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1038 # Generate a polymorphic attribute read
1039 fun read_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1041 # Generate a polymorphic attribute write
1042 fun write_attribute(a: MAttribute, recv: RuntimeVariable, value: RuntimeVariable) is abstract
1046 # Add a check and an abort for a null reciever if needed
1047 fun check_recv_notnull(recv: RuntimeVariable)
1049 if self.compiler.modelbuilder.toolcontext.opt_no_check_other.value then return
1051 var maybenull = recv.mcasttype isa MNullableType or recv.mcasttype isa MNullType
1053 self.add("if (unlikely({recv} == NULL)) \{")
1054 self.add_abort("Receiver is null")
1061 private var names: HashSet[String] = new HashSet[String]
1062 private var last: Int = 0
1064 # Return a new name based on `s
` and unique in the visitor
1065 fun get_name(s: String): String
1067 if not self.names.has(s) then
1071 var i = self.last + 1
1074 if not self.names.has(s2) then
1083 # Return an unique and stable identifier associated with an escapemark
1084 fun escapemark_name(e: nullable EscapeMark): String
1087 if escapemark_names.has_key(e) then return escapemark_names[e]
1089 if name == null then name = "label"
1090 name = get_name(name)
1091 escapemark_names[e] = name
1095 private var escapemark_names = new HashMap[EscapeMark, String]
1097 # Return a "const char*" variable associated to the classname of the dynamic type of an object
1098 # NOTE: we do not return a `RuntimeVariable` "NativeString" as the class may not exist in the module/program
1099 fun class_name_string(value: RuntimeVariable): String is abstract
1101 # Variables handling
1103 protected var variables: HashMap[Variable, RuntimeVariable] = new HashMap[Variable, RuntimeVariable]
1105 # Return the local runtime_variable associated to a Nit local variable
1106 fun variable(variable: Variable): RuntimeVariable
1108 if self.variables.has_key(variable) then
1109 return self.variables[variable]
1111 var name = self.get_name("var_{variable.name}")
1112 var mtype = variable.declared_type.as(not null)
1113 mtype = self.anchor(mtype)
1114 var res = new RuntimeVariable(name, mtype, mtype)
1115 self.add_decl("{mtype.ctype} {name} /* var {variable}: {mtype} */;")
1116 self.variables[variable] = res
1121 # Return a new uninitialized local runtime_variable
1122 fun new_var(mtype: MType): RuntimeVariable
1124 mtype = self.anchor(mtype)
1125 var name = self.get_name("var")
1126 var res = new RuntimeVariable(name, mtype, mtype)
1127 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1131 # Return a new uninitialized named runtime_variable
1132 fun new_named_var(mtype: MType, name: String): RuntimeVariable
1134 mtype = self.anchor(mtype)
1135 var res = new RuntimeVariable(name, mtype, mtype)
1136 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1140 # Correctly assign a left and a right value
1141 # Boxing and unboxing is performed if required
1142 fun assign(left, right: RuntimeVariable)
1144 right = self.autobox(right, left.mtype)
1145 self.add("{left} = {right};")
1148 # Generate instances
1150 # Generate a alloc-instance + init-attributes
1151 fun init_instance(mtype: MClassType): RuntimeVariable is abstract
1153 # Generate an integer value
1154 fun int_instance(value: Int): RuntimeVariable
1156 var res = self.new_var(self.get_class("Int").mclass_type)
1157 self.add("{res} = {value};")
1161 # Generate a string value
1162 fun string_instance(string: String): RuntimeVariable
1164 var mtype = self.get_class("String").mclass_type
1165 var name = self.get_name("varonce")
1166 self.add_decl("static {mtype.ctype} {name};")
1167 var res = self.new_var(mtype)
1168 self.add("if ({name}) \{")
1169 self.add("{res} = {name};")
1170 self.add("\} else \{")
1171 var native_mtype = self.get_class("NativeString").mclass_type
1172 var nat = self.new_var(native_mtype)
1173 self.add("{nat} = \"{string.escape_to_c}\";")
1174 var length = self.int_instance(string.length)
1175 self.add("{res} = {self.send(self.get_property("to_s_with_length", native_mtype), [nat, length]).as(not null)};")
1176 self.add("{name} = {res};")
1181 # Generate an array value
1182 fun array_instance(array: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1184 # Get an instance of a array for a vararg
1185 fun vararg_instance(mpropdef: MPropDef, recv: RuntimeVariable, varargs: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1189 # Add a line in the main part of the generated C
1190 fun add(s: String) do self.writer.lines.add(s)
1193 # (used for local or global declaration)
1194 fun add_decl(s: String) do self.writer.decl_lines.add(s)
1196 # Request the presence of a global declaration
1197 fun require_declaration(key: String)
1199 var reqs = self.writer.file.required_declarations
1200 if reqs.has(key) then return
1202 var node = current_node
1203 if node != null then compiler.requirers_of_declarations[key] = node
1206 # Add a declaration in the local-header
1207 # The declaration is ensured to be present once
1208 fun declare_once(s: String)
1210 self.compiler.provide_declaration(s, s)
1211 self.require_declaration(s)
1214 # look for a needed .h and .c file for a given .nit source-file
1215 # FIXME: bad API, parameter should be a `MModule`, not its source-file
1216 fun add_extern(file: String)
1218 file = file.strip_extension(".nit")
1219 var tryfile = file + ".nit.h"
1220 if tryfile.file_exists then
1221 self.declare_once("#include \"{tryfile.basename("")}\"")
1222 self.compiler.files_to_copy.add(tryfile)
1224 tryfile = file + "_nit.h"
1225 if tryfile.file_exists then
1226 self.declare_once("#include \"{tryfile.basename("")}\"")
1227 self.compiler.files_to_copy.add(tryfile)
1230 if self.compiler.seen_extern.has(file) then return
1231 self.compiler.seen_extern.add(file)
1232 tryfile = file + ".nit.c"
1233 if not tryfile.file_exists then
1234 tryfile = file + "_nit.c"
1235 if not tryfile.file_exists then return
1237 var f = new ExternCFile(tryfile.basename(""), "")
1238 self.compiler.extern_bodies.add(f)
1239 self.compiler.files_to_copy.add(tryfile)
1242 # Return a new local runtime_variable initialized with the C expression `cexpr
`.
1243 fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
1245 var res = new_var(mtype)
1246 self.add("{res} = {cexpr};")
1250 # Generate generic abort
1251 # used by aborts, asserts, casts, etc.
1252 fun add_abort(message: String)
1254 self.add("PRINT_ERROR(\"Runtime error: %s\", \"{message.escape_to_c}\");")
1260 if self.current_node != null and self.current_node.location.file != null then
1261 self.add("PRINT_ERROR(\" (%s:%d)\\n\", \"{self.current_node.location.file.filename.escape_to_c}\", {current_node.location.line_start});")
1263 self.add("PRINT_ERROR(\"\\n\");")
1265 self.add("show_backtrace(1);")
1268 # Add a dynamic cast
1269 fun add_cast(value: RuntimeVariable, mtype: MType, tag: String)
1271 var res = self.type_test(value, mtype, tag)
1272 self.add("if (unlikely(!{res})) \{")
1273 var cn = self.class_name_string(value)
1274 self.add("PRINT_ERROR(\"Runtime error: Cast failed. Expected `%s
`, got `%s
`\", \"{mtype.to_s.escape_to_c}\", {cn});")
1279 # Generate a return with the value `s
`
1280 fun ret(s: RuntimeVariable)
1282 self.assign(self.frame.returnvar.as(not null), s)
1283 self.add("goto {self.frame.returnlabel.as(not null)};")
1286 # Compile a statement (if any)
1287 fun stmt(nexpr: nullable AExpr)
1289 if nexpr == null then return
1290 var old = self.current_node
1291 self.current_node = nexpr
1293 self.current_node = old
1296 # Compile an expression an return its result
1297 # `mtype
` is the expected return type, pass null if no specific type is expected.
1298 fun expr(nexpr: AExpr, mtype: nullable MType): RuntimeVariable
1300 var old = self.current_node
1301 self.current_node = nexpr
1302 var res = nexpr.expr(self).as(not null)
1303 if mtype != null then
1304 mtype = self.anchor(mtype)
1305 res = self.autobox(res, mtype)
1307 res = autoadapt(res, nexpr.mtype.as(not null))
1308 var implicit_cast_to = nexpr.implicit_cast_to
1309 if implicit_cast_to != null and not self.compiler.modelbuilder.toolcontext.opt_no_check_autocast.value then
1310 add_cast(res, implicit_cast_to, "auto")
1311 res = autoadapt(res, implicit_cast_to)
1313 self.current_node = old
1317 # Alias for `self.expr
(nexpr
, self.bool_type
)`
1318 fun expr_bool(nexpr: AExpr): RuntimeVariable do return expr(nexpr, bool_type)
1320 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1321 fun debug(message: String)
1323 var node = self.current_node
1324 if node == null then
1325 print "?: {message}"
1329 self.add("/* DEBUG: {message} */")
1333 # A C function associated to a Nit method
1334 # Because of customization, a given Nit method can be compiler more that once
1335 abstract class AbstractRuntimeFunction
1337 type COMPILER: AbstractCompiler
1338 type VISITOR: AbstractCompilerVisitor
1340 # The associated Nit method
1341 var mmethoddef: MMethodDef
1343 # The mangled c name of the runtime_function
1344 # Subclasses should redefine `build_c_name
` instead
1347 var res = self.c_name_cache
1348 if res != null then return res
1349 res = self.build_c_name
1350 self.c_name_cache = res
1354 # Non cached version of `c_name
`
1355 protected fun build_c_name: String is abstract
1357 protected var c_name_cache: nullable String writable = null
1359 # Implements a call of the runtime_function
1360 # May inline the body or generate a C function call
1361 fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1363 # Generate the code for the `AbstractRuntimeFunction`
1364 # Warning: compile more than once compilation makes CC unhappy
1365 fun compile_to_c(compiler: COMPILER) is abstract
1368 # A runtime variable hold a runtime value in C.
1369 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1371 # The tricky point is that a single C variable can be associated to more than one `RuntimeVariable` because the static knowledge of the type of an expression can vary in the C code.
1372 class RuntimeVariable
1373 # The name of the variable in the C code
1376 # The static type of the variable (as declard in C)
1379 # The current casted type of the variable (as known in Nit)
1380 var mcasttype: MType writable
1382 # If the variable exaclty a mcasttype?
1383 # false (usual value) means that the variable is a mcasttype or a subtype.
1384 var is_exact: Bool writable = false
1386 init(name: String, mtype: MType, mcasttype: MType)
1390 self.mcasttype = mcasttype
1391 assert not mtype.need_anchor
1392 assert not mcasttype.need_anchor
1395 redef fun to_s do return name
1400 if self.is_exact then
1401 exact_str = " exact"
1406 if self.mtype == self.mcasttype then
1407 type_str = "{mtype}{exact_str}"
1409 type_str = "{mtype}({mcasttype}{exact_str})"
1411 return "<{name}:{type_str}>"
1415 # A frame correspond to a visited property in a `GlobalCompilerVisitor`
1418 type VISITOR: AbstractCompilerVisitor
1420 # The associated visitor
1421 var visitor: VISITOR
1423 # The executed property.
1424 # A Method in case of a call, an attribute in case of a default initialization.
1425 var mpropdef: MPropDef
1427 # The static type of the receiver
1428 var receiver: MClassType
1430 # Arguments of the method (the first is the receiver)
1431 var arguments: Array[RuntimeVariable]
1433 # The runtime_variable associated to the return (in a function)
1434 var returnvar: nullable RuntimeVariable writable = null
1436 # The label at the end of the property
1437 var returnlabel: nullable String writable = null
1441 # Return the C type associated to a given Nit static type
1442 fun ctype: String do return "val*"
1444 fun ctypename: String do return "val"
1446 # Return the name of the C structure associated to a Nit live type
1447 fun c_name: String is abstract
1448 protected var c_name_cache: nullable String protected writable
1451 redef class MClassType
1454 var res = self.c_name_cache
1455 if res != null then return res
1456 res = "{mclass.intro_mmodule.name.to_cmangle}__{mclass.name.to_cmangle}"
1457 self.c_name_cache = res
1461 redef fun ctype: String
1463 if mclass.name == "Int" then
1465 else if mclass.name == "Bool" then
1467 else if mclass.name == "Char" then
1469 else if mclass.name == "Float" then
1471 else if mclass.name == "NativeString" then
1473 else if mclass.name == "NativeArray" then
1475 else if mclass.kind == extern_kind then
1482 redef fun ctypename: String
1484 if mclass.name == "Int" then
1486 else if mclass.name == "Bool" then
1488 else if mclass.name == "Char" then
1490 else if mclass.name == "Float" then
1492 else if mclass.name == "NativeString" then
1494 else if mclass.name == "NativeArray" then
1495 #return "{self.arguments.first.ctype}*"
1497 else if mclass.kind == extern_kind then
1505 redef class MGenericType
1508 var res = self.c_name_cache
1509 if res != null then return res
1511 for t in self.arguments do
1512 res = res + t.c_name
1514 self.c_name_cache = res
1519 redef class MParameterType
1522 var res = self.c_name_cache
1523 if res != null then return res
1524 res = "{self.mclass.c_name}_FT{self.rank}"
1525 self.c_name_cache = res
1530 redef class MVirtualType
1533 var res = self.c_name_cache
1534 if res != null then return res
1535 res = "{self.mproperty.intro.mclassdef.mclass.c_name}_VT{self.mproperty.name}"
1536 self.c_name_cache = res
1541 redef class MNullableType
1544 var res = self.c_name_cache
1545 if res != null then return res
1546 res = "nullable_{self.mtype.c_name}"
1547 self.c_name_cache = res
1553 # Return the name of the C structure associated to a Nit class
1554 fun c_name: String do
1555 var res = self.c_name_cache
1556 if res != null then return res
1557 res = "{intro_mmodule.name.to_cmangle}__{name.to_cmangle}"
1558 self.c_name_cache = res
1561 private var c_name_cache: nullable String
1564 redef class MProperty
1565 fun c_name: String do
1566 var res = self.c_name_cache
1567 if res != null then return res
1568 res = "{self.intro.c_name}"
1569 self.c_name_cache = res
1572 private var c_name_cache: nullable String
1575 redef class MPropDef
1576 type VISITOR: AbstractCompilerVisitor
1578 private var c_name_cache: nullable String
1580 # The mangled name associated to the property
1583 var res = self.c_name_cache
1584 if res != null then return res
1585 res = "{self.mclassdef.mmodule.name.to_cmangle}__{self.mclassdef.mclass.name.to_cmangle}__{self.mproperty.name.to_cmangle}"
1586 self.c_name_cache = res
1591 redef class MMethodDef
1592 # Can the body be inlined?
1593 fun can_inline(v: VISITOR): Bool
1595 if is_abstract then return true
1596 var modelbuilder = v.compiler.modelbuilder
1597 if modelbuilder.mpropdef2npropdef.has_key(self) then
1598 var npropdef = modelbuilder.mpropdef2npropdef[self]
1599 return npropdef.can_inline
1600 else if self.mproperty.name == "init" then
1601 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1608 # Inline the body in another visitor
1609 fun compile_inside_to_c(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1611 var modelbuilder = v.compiler.modelbuilder
1612 if modelbuilder.mpropdef2npropdef.has_key(self) then
1613 var npropdef = modelbuilder.mpropdef2npropdef[self]
1614 var oldnode = v.current_node
1615 v.current_node = npropdef
1616 self.compile_parameter_check(v, arguments)
1617 npropdef.compile_to_c(v, self, arguments)
1618 v.current_node = oldnode
1619 else if self.mproperty.name == "init" then
1620 var nclassdef = modelbuilder.mclassdef2nclassdef[self.mclassdef]
1621 var oldnode = v.current_node
1622 v.current_node = nclassdef
1623 self.compile_parameter_check(v, arguments)
1624 nclassdef.compile_to_c(v, self, arguments)
1625 v.current_node = oldnode
1632 # Generate type checks in the C code to check covariant parameters
1633 fun compile_parameter_check(v: VISITOR, arguments: Array[RuntimeVariable])
1635 if v.compiler.modelbuilder.toolcontext.opt_no_check_covariance.value then return
1637 for i in [0..msignature.arity[ do
1638 # skip test for vararg since the array is instantiated with the correct polymorphic type
1639 if msignature.vararg_rank == i then continue
1641 # skip if the cast is not required
1642 var origmtype = self.mproperty.intro.msignature.mparameters[i].mtype
1643 if not origmtype.need_anchor then continue
1645 # get the parameter type
1646 var mtype = self.msignature.mparameters[i].mtype
1649 # note that v decides if and how to implements the cast
1650 v.add("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1651 v.add_cast(arguments[i+1], mtype, "covariance")
1658 redef class APropdef
1659 fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1661 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at {location.to_s}\\n\");")
1662 debug("Not yet implemented")
1665 fun can_inline: Bool do return true
1668 redef class AMethPropdef
1669 redef fun compile_to_c(v, mpropdef, arguments)
1671 if mpropdef.is_abstract then
1672 var cn = v.class_name_string(arguments.first)
1673 v.add("PRINT_ERROR(\"Runtime error: Abstract method `%s
` called on `%s
`\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1678 # Call the implicit super-init
1679 var auto_super_inits = self.auto_super_inits
1680 if auto_super_inits != null then
1681 var args = [arguments.first]
1682 for auto_super_init in auto_super_inits do
1684 for i in [0..auto_super_init.msignature.arity+1[ do
1685 args.add(arguments[i])
1687 v.compile_callsite(auto_super_init, args)
1691 var n_block = n_block
1692 if n_block != null then
1693 for i in [0..mpropdef.msignature.arity[ do
1694 var variable = self.n_signature.n_params[i].variable.as(not null)
1695 v.assign(v.variable(variable), arguments[i+1])
1698 else if mpropdef.is_intern then
1699 compile_intern_to_c(v, mpropdef, arguments)
1700 else if mpropdef.is_extern then
1701 if mpropdef.mproperty.is_init then
1702 compile_externinit_to_c(v, mpropdef, arguments)
1704 compile_externmeth_to_c(v, mpropdef, arguments)
1709 redef fun can_inline
1711 if self.auto_super_inits != null then return false
1712 var nblock = self.n_block
1713 if nblock == null then return true
1714 if (mpropdef.mproperty.name == "==" or mpropdef.mproperty.name == "!=") and mpropdef.mclassdef.mclass.name == "Object" then return true
1715 if nblock isa ABlockExpr and nblock.n_expr.length == 0 then return true
1719 fun compile_intern_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1721 var pname = mpropdef.mproperty.name
1722 var cname = mpropdef.mclassdef.mclass.name
1723 var ret = mpropdef.msignature.return_mtype
1725 ret = v.resolve_for(ret, arguments.first)
1726 else if mpropdef.mproperty.is_new then
1727 ret = arguments.first.mcasttype
1729 if pname != "==" and pname != "!=" then
1730 v.adapt_signature(mpropdef, arguments)
1732 if cname == "Int" then
1733 if pname == "output" then
1734 v.add("printf(\"%ld\\n\", {arguments.first});")
1736 else if pname == "object_id" then
1737 v.ret(arguments.first)
1739 else if pname == "+" then
1740 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1742 else if pname == "-" then
1743 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1745 else if pname == "unary -" then
1746 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1748 else if pname == "*" then
1749 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1751 else if pname == "/" then
1752 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1754 else if pname == "%" then
1755 v.ret(v.new_expr("{arguments[0]} % {arguments[1]}", ret.as(not null)))
1757 else if pname == "lshift" then
1758 v.ret(v.new_expr("{arguments[0]} << {arguments[1]}", ret.as(not null)))
1760 else if pname == "rshift" then
1761 v.ret(v.new_expr("{arguments[0]} >> {arguments[1]}", ret.as(not null)))
1763 else if pname == "==" then
1764 v.ret(v.equal_test(arguments[0], arguments[1]))
1766 else if pname == "!=" then
1767 var res = v.equal_test(arguments[0], arguments[1])
1768 v.ret(v.new_expr("!{res}", ret.as(not null)))
1770 else if pname == "<" then
1771 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1773 else if pname == ">" then
1774 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1776 else if pname == "<=" then
1777 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1779 else if pname == ">=" then
1780 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1782 else if pname == "to_f" then
1783 v.ret(v.new_expr("(double){arguments[0]}", ret.as(not null)))
1785 else if pname == "ascii" then
1786 v.ret(v.new_expr("{arguments[0]}", ret.as(not null)))
1789 else if cname == "Char" then
1790 if pname == "output" then
1791 v.add("printf(\"%c\", {arguments.first});")
1793 else if pname == "object_id" then
1794 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1796 else if pname == "successor" then
1797 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1799 else if pname == "predecessor" then
1800 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1802 else if pname == "==" then
1803 v.ret(v.equal_test(arguments[0], arguments[1]))
1805 else if pname == "!=" then
1806 var res = v.equal_test(arguments[0], arguments[1])
1807 v.ret(v.new_expr("!{res}", ret.as(not null)))
1809 else if pname == "<" then
1810 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1812 else if pname == ">" then
1813 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1815 else if pname == "<=" then
1816 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1818 else if pname == ">=" then
1819 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1821 else if pname == "to_i" then
1822 v.ret(v.new_expr("{arguments[0]}-'0'", ret.as(not null)))
1824 else if pname == "ascii" then
1825 v.ret(v.new_expr("(unsigned char){arguments[0]}", ret.as(not null)))
1828 else if cname == "Bool" then
1829 if pname == "output" then
1830 v.add("printf({arguments.first}?\"true\\n\":\"false\\n\");")
1832 else if pname == "object_id" then
1833 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1835 else if pname == "==" then
1836 v.ret(v.equal_test(arguments[0], arguments[1]))
1838 else if pname == "!=" then
1839 var res = v.equal_test(arguments[0], arguments[1])
1840 v.ret(v.new_expr("!{res}", ret.as(not null)))
1843 else if cname == "Float" then
1844 if pname == "output" then
1845 v.add("printf(\"%f\\n\", {arguments.first});")
1847 else if pname == "object_id" then
1848 v.ret(v.new_expr("(double){arguments.first}", ret.as(not null)))
1850 else if pname == "+" then
1851 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1853 else if pname == "-" then
1854 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1856 else if pname == "unary -" then
1857 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1859 else if pname == "succ" then
1860 v.ret(v.new_expr("{arguments[0]}+1", ret.as(not null)))
1862 else if pname == "prec" then
1863 v.ret(v.new_expr("{arguments[0]}-1", ret.as(not null)))
1865 else if pname == "*" then
1866 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1868 else if pname == "/" then
1869 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1871 else if pname == "==" then
1872 v.ret(v.equal_test(arguments[0], arguments[1]))
1874 else if pname == "!=" then
1875 var res = v.equal_test(arguments[0], arguments[1])
1876 v.ret(v.new_expr("!{res}", ret.as(not null)))
1878 else if pname == "<" then
1879 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1881 else if pname == ">" then
1882 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1884 else if pname == "<=" then
1885 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1887 else if pname == ">=" then
1888 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1890 else if pname == "to_i" then
1891 v.ret(v.new_expr("(long){arguments[0]}", ret.as(not null)))
1894 else if cname == "NativeString" then
1895 if pname == "[]" then
1896 v.ret(v.new_expr("{arguments[0]}[{arguments[1]}]", ret.as(not null)))
1898 else if pname == "[]=" then
1899 v.add("{arguments[0]}[{arguments[1]}]={arguments[2]};")
1901 else if pname == "copy_to" then
1902 v.add("memcpy({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
1904 else if pname == "atoi" then
1905 v.ret(v.new_expr("atoi({arguments[0]});", ret.as(not null)))
1907 else if pname == "init" then
1908 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
1911 else if cname == "NativeArray" then
1912 v.native_array_def(pname, ret, arguments)
1915 if pname == "exit" then
1916 v.add("exit({arguments[1]});")
1918 else if pname == "sys" then
1919 v.ret(v.new_expr("glob_sys", ret.as(not null)))
1921 else if pname == "calloc_string" then
1922 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
1924 else if pname == "calloc_array" then
1925 v.calloc_array(ret.as(not null), arguments)
1927 else if pname == "object_id" then
1928 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1930 else if pname == "is_same_type" then
1931 v.ret(v.is_same_type_test(arguments[0], arguments[1]))
1933 else if pname == "is_same_instance" then
1934 v.ret(v.equal_test(arguments[0], arguments[1]))
1936 else if pname == "output_class_name" then
1937 var nat = v.class_name_string(arguments.first)
1938 v.add("printf(\"%s\\n\", {nat});")
1940 else if pname == "native_class_name" then
1941 var nat = v.class_name_string(arguments.first)
1942 v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
1944 else if pname == "force_garbage_collection" then
1945 v.add("nit_gcollect();")
1947 else if pname == "native_argc" then
1948 v.ret(v.new_expr("glob_argc", ret.as(not null)))
1950 else if pname == "native_argv" then
1951 v.ret(v.new_expr("glob_argv[{arguments[1]}]", ret.as(not null)))
1954 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{mpropdef} at {location.to_s}\\n\");")
1955 debug("Not implemented {mpropdef}")
1958 fun compile_externmeth_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1961 var nextern = self.n_extern
1962 if nextern == null then
1963 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED nitni for {mpropdef} at {location.to_s}\\n\");")
1964 v.add("show_backtrace(1);")
1967 externname = nextern.text.substring(1, nextern.text.length-2)
1968 if location.file != null then
1969 var file = location.file.filename
1972 var res: nullable RuntimeVariable = null
1973 var ret = mpropdef.msignature.return_mtype
1975 ret = v.resolve_for(ret, arguments.first)
1976 res = v.new_var(ret)
1978 v.adapt_signature(mpropdef, arguments)
1981 v.add("{externname}({arguments.join(", ")});")
1983 v.add("{res} = {externname}({arguments.join(", ")});")
1988 fun compile_externinit_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1991 var nextern = self.n_extern
1992 if nextern == null then
1993 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED nitni for {mpropdef} at {location.to_s}\\n\");")
1994 v.add("show_backtrace(1);")
1997 externname = nextern.text.substring(1, nextern.text.length-2)
1998 if location.file != null then
1999 var file = location.file.filename
2002 v.adapt_signature(mpropdef, arguments)
2003 var ret = arguments.first.mtype
2004 var res = v.new_var(ret)
2008 v.add("{res} = {externname}({arguments.join(", ")});")
2013 redef class AAttrPropdef
2014 redef fun compile_to_c(v, mpropdef, arguments)
2016 if arguments.length == 1 then
2017 var res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2018 v.assign(v.frame.returnvar.as(not null), res)
2020 v.write_attribute(self.mpropdef.mproperty, arguments.first, arguments[1])
2024 fun init_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2026 var nexpr = self.n_expr
2027 if nexpr != null then
2028 var oldnode = v.current_node
2029 v.current_node = self
2030 var old_frame = v.frame
2031 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2033 var value = v.expr(nexpr, self.mpropdef.static_mtype)
2034 v.write_attribute(self.mpropdef.mproperty, recv, value)
2036 v.current_node = oldnode
2040 fun check_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2042 var nexpr = self.n_expr
2043 if nexpr != null then return
2045 var oldnode = v.current_node
2046 v.current_node = self
2047 var old_frame = v.frame
2048 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2050 # Force read to check the initialization
2051 v.read_attribute(self.mpropdef.mproperty, recv)
2053 v.current_node = oldnode
2057 redef class AClassdef
2058 private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2060 if mpropdef == self.mfree_init then
2061 var super_inits = self.super_inits
2062 if super_inits != null then
2063 var args_of_super = arguments
2064 if arguments.length > 1 then args_of_super = [arguments.first]
2065 for su in super_inits do
2066 v.send(su, args_of_super)
2069 var recv = arguments.first
2071 # Collect undefined attributes
2072 for npropdef in self.n_propdefs do
2073 if npropdef isa AAttrPropdef and npropdef.n_expr == null then
2074 v.write_attribute(npropdef.mpropdef.mproperty, recv, arguments[i])
2085 # Try to compile self as an expression
2086 # Do not call this method directly, use `v
.expr
` instead
2087 private fun expr(v: AbstractCompilerVisitor): nullable RuntimeVariable
2089 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\");")
2090 var mtype = self.mtype
2091 if mtype == null then
2094 var res = v.new_var(mtype)
2095 v.add("/* {res} = NOT YET {class_name} */")
2100 # Try to compile self as a statement
2101 # Do not call this method directly, use `v
.stmt
` instead
2102 private fun stmt(v: AbstractCompilerVisitor)
2105 if res != null then v.add("{res};")
2109 redef class ABlockExpr
2112 for e in self.n_expr do v.stmt(e)
2116 var last = self.n_expr.last
2117 for e in self.n_expr do
2118 if e == last then break
2121 return v.expr(last, null)
2125 redef class AVardeclExpr
2128 var variable = self.variable.as(not null)
2129 var ne = self.n_expr
2131 var i = v.expr(ne, variable.declared_type)
2132 v.assign(v.variable(variable), i)
2137 redef class AVarExpr
2140 var res = v.variable(self.variable.as(not null))
2141 var mtype = self.mtype.as(not null)
2142 return v.autoadapt(res, mtype)
2146 redef class AVarAssignExpr
2149 var variable = self.variable.as(not null)
2150 var i = v.expr(self.n_value, variable.declared_type)
2151 v.assign(v.variable(variable), i)
2155 var variable = self.variable.as(not null)
2156 var i = v.expr(self.n_value, variable.declared_type)
2157 v.assign(v.variable(variable), i)
2162 redef class AVarReassignExpr
2165 var variable = self.variable.as(not null)
2166 var vari = v.variable(variable)
2167 var value = v.expr(self.n_value, variable.declared_type)
2168 var res = v.compile_callsite(self.reassign_callsite.as(not null), [vari, value])
2170 v.assign(v.variable(variable), res)
2174 redef class ASelfExpr
2175 redef fun expr(v) do return v.frame.arguments.first
2178 redef class AContinueExpr
2179 redef fun stmt(v) do v.add("goto CONTINUE_{v.escapemark_name(self.escapemark)};")
2182 redef class ABreakExpr
2183 redef fun stmt(v) do v.add("goto BREAK_{v.escapemark_name(self.escapemark)};")
2186 redef class AReturnExpr
2189 var nexpr = self.n_expr
2190 if nexpr != null then
2191 var returnvar = v.frame.returnvar.as(not null)
2192 var i = v.expr(nexpr, returnvar.mtype)
2193 v.assign(returnvar, i)
2195 v.add("goto {v.frame.returnlabel.as(not null)};")
2199 redef class AAbortExpr
2200 redef fun stmt(v) do v.add_abort("Aborted")
2206 var cond = v.expr_bool(self.n_expr)
2207 v.add("if ({cond})\{")
2216 var res = v.new_var(self.mtype.as(not null))
2217 var cond = v.expr_bool(self.n_expr)
2218 v.add("if ({cond})\{")
2219 v.assign(res, v.expr(self.n_then.as(not null), null))
2221 v.assign(res, v.expr(self.n_else.as(not null), null))
2227 redef class AIfexprExpr
2230 var res = v.new_var(self.mtype.as(not null))
2231 var cond = v.expr_bool(self.n_expr)
2232 v.add("if ({cond})\{")
2233 v.assign(res, v.expr(self.n_then, null))
2235 v.assign(res, v.expr(self.n_else, null))
2244 v.stmt(self.n_block)
2245 var escapemark = self.escapemark
2246 if escapemark != null then
2247 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2252 redef class AWhileExpr
2256 var cond = v.expr_bool(self.n_expr)
2257 v.add("if (!{cond}) break;")
2258 v.stmt(self.n_block)
2259 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2261 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2265 redef class ALoopExpr
2269 v.stmt(self.n_block)
2270 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2272 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2276 redef class AForExpr
2279 # Shortcut on explicit range
2280 # Avoid the instantiation of the range and the iterator
2281 var nexpr = self.n_expr
2282 if self.variables.length == 1 and nexpr isa AOrangeExpr and not v.compiler.modelbuilder.toolcontext.opt_no_shortcut_range.value then
2283 var from = v.expr(nexpr.n_expr, null)
2284 var to = v.expr(nexpr.n_expr2, null)
2285 var variable = v.variable(variables.first)
2287 v.assign(variable, from)
2288 v.add("for(;;) \{ /* shortcut range */")
2290 var ok = v.send(v.get_property("<", variable.mtype), [variable, to])
2292 v.add("if(!{ok}) break;")
2294 v.stmt(self.n_block)
2296 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2297 var succ = v.send(v.get_property("succ", variable.mtype), [variable])
2299 v.assign(variable, succ)
2301 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2305 var cl = v.expr(self.n_expr, null)
2306 var it_meth = self.method_iterator
2307 assert it_meth != null
2308 var it = v.compile_callsite(it_meth, [cl])
2311 var isok_meth = self.method_is_ok
2312 assert isok_meth != null
2313 var ok = v.compile_callsite(isok_meth, [it])
2315 v.add("if(!{ok}) break;")
2316 if self.variables.length == 1 then
2317 var item_meth = self.method_item
2318 assert item_meth != null
2319 var i = v.compile_callsite(item_meth, [it])
2321 v.assign(v.variable(variables.first), i)
2322 else if self.variables.length == 2 then
2323 var key_meth = self.method_key
2324 assert key_meth != null
2325 var i = v.compile_callsite(key_meth, [it])
2327 v.assign(v.variable(variables[0]), i)
2328 var item_meth = self.method_item
2329 assert item_meth != null
2330 i = v.compile_callsite(item_meth, [it])
2332 v.assign(v.variable(variables[1]), i)
2336 v.stmt(self.n_block)
2337 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2338 var next_meth = self.method_next
2339 assert next_meth != null
2340 v.compile_callsite(next_meth, [it])
2342 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2346 redef class AAssertExpr
2349 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return
2351 var cond = v.expr_bool(self.n_expr)
2352 v.add("if (unlikely(!{cond})) \{")
2356 v.add_abort("Assert '{nid.text}' failed")
2358 v.add_abort("Assert failed")
2367 var res = v.new_var(self.mtype.as(not null))
2368 var i1 = v.expr_bool(self.n_expr)
2369 v.add("if ({i1}) \{")
2372 var i2 = v.expr_bool(self.n_expr2)
2373 v.add("{res} = {i2};")
2379 redef class AImpliesExpr
2382 var res = v.new_var(self.mtype.as(not null))
2383 var i1 = v.expr_bool(self.n_expr)
2384 v.add("if (!{i1}) \{")
2387 var i2 = v.expr_bool(self.n_expr2)
2388 v.add("{res} = {i2};")
2394 redef class AAndExpr
2397 var res = v.new_var(self.mtype.as(not null))
2398 var i1 = v.expr_bool(self.n_expr)
2399 v.add("if (!{i1}) \{")
2402 var i2 = v.expr_bool(self.n_expr2)
2403 v.add("{res} = {i2};")
2409 redef class ANotExpr
2412 var cond = v.expr_bool(self.n_expr)
2413 return v.new_expr("!{cond}", self.mtype.as(not null))
2417 redef class AOrElseExpr
2420 var res = v.new_var(self.mtype.as(not null))
2421 var i1 = v.expr(self.n_expr, null)
2422 v.add("if ({i1}!=NULL) \{")
2425 var i2 = v.expr(self.n_expr2, null)
2432 redef class AIntExpr
2433 redef fun expr(v) do return v.new_expr("{self.value.to_s}", self.mtype.as(not null))
2436 redef class AFloatExpr
2437 redef fun expr(v) do return v.new_expr("{self.n_float.text}", self.mtype.as(not null)) # FIXME use value, not n_float
2440 redef class ACharExpr
2441 redef fun expr(v) do return v.new_expr("'{self.value.to_s.escape_to_c}'", self.mtype.as(not null))
2444 redef class AArrayExpr
2447 var mtype = self.mtype.as(MClassType).arguments.first
2448 var array = new Array[RuntimeVariable]
2449 for nexpr in self.n_exprs.n_exprs do
2450 var i = v.expr(nexpr, mtype)
2453 return v.array_instance(array, mtype)
2457 redef class AStringFormExpr
2458 redef fun expr(v) do return v.string_instance(self.value.as(not null))
2461 redef class ASuperstringExpr
2464 var array = new Array[RuntimeVariable]
2465 for ne in self.n_exprs do
2466 if ne isa AStringFormExpr and ne.value == "" then continue # skip empty sub-strings
2467 var i = v.expr(ne, null)
2470 var a = v.array_instance(array, v.object_type)
2471 var res = v.send(v.get_property("to_s", a.mtype), [a])
2476 redef class ACrangeExpr
2479 var i1 = v.expr(self.n_expr, null)
2480 var i2 = v.expr(self.n_expr2, null)
2481 var mtype = self.mtype.as(MClassType)
2482 var res = v.init_instance(mtype)
2483 var it = v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2488 redef class AOrangeExpr
2491 var i1 = v.expr(self.n_expr, null)
2492 var i2 = v.expr(self.n_expr2, null)
2493 var mtype = self.mtype.as(MClassType)
2494 var res = v.init_instance(mtype)
2495 var it = v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2500 redef class ATrueExpr
2501 redef fun expr(v) do return v.new_expr("1", self.mtype.as(not null))
2504 redef class AFalseExpr
2505 redef fun expr(v) do return v.new_expr("0", self.mtype.as(not null))
2508 redef class ANullExpr
2509 redef fun expr(v) do return v.new_expr("NULL", self.mtype.as(not null))
2512 redef class AIsaExpr
2515 var i = v.expr(self.n_expr, null)
2516 return v.type_test(i, self.cast_type.as(not null), "isa")
2520 redef class AAsCastExpr
2523 var i = v.expr(self.n_expr, null)
2524 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2526 v.add_cast(i, self.mtype.as(not null), "as")
2531 redef class AAsNotnullExpr
2534 var i = v.expr(self.n_expr, null)
2535 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2537 v.add("if (unlikely({i} == NULL)) \{")
2538 v.add_abort("Cast failed")
2544 redef class AParExpr
2545 redef fun expr(v) do return v.expr(self.n_expr, null)
2548 redef class AOnceExpr
2551 var mtype = self.mtype.as(not null)
2552 var name = v.get_name("varonce")
2553 var guard = v.get_name(name + "_guard")
2554 v.add_decl("static {mtype.ctype} {name};")
2555 v.add_decl("static int {guard};")
2556 var res = v.new_var(mtype)
2557 v.add("if ({guard}) \{")
2558 v.add("{res} = {name};")
2560 var i = v.expr(self.n_expr, mtype)
2561 v.add("{res} = {i};")
2562 v.add("{name} = {res};")
2563 v.add("{guard} = 1;")
2569 redef class ASendExpr
2572 var recv = v.expr(self.n_expr, null)
2574 for a in self.raw_arguments.as(not null) do
2575 args.add(v.expr(a, null))
2577 return v.compile_callsite(self.callsite.as(not null), args)
2581 redef class ASendReassignFormExpr
2584 var recv = v.expr(self.n_expr, null)
2586 for a in self.raw_arguments.as(not null) do
2587 args.add(v.expr(a, null))
2589 var value = v.expr(self.n_value, null)
2591 var left = v.compile_callsite(self.callsite.as(not null), args)
2594 var res = v.compile_callsite(self.reassign_callsite.as(not null), [left, value])
2598 v.compile_callsite(self.write_callsite.as(not null), args)
2602 redef class ASuperExpr
2605 var recv = v.frame.arguments.first
2607 for a in self.n_args.n_exprs do
2608 args.add(v.expr(a, null))
2611 var callsite = self.callsite
2612 if callsite != null then
2613 # Add additionnals arguments for the super init call
2614 if args.length == 1 then
2615 for i in [0..callsite.msignature.arity[ do
2616 args.add(v.frame.arguments[i+1])
2620 var res = v.compile_callsite(callsite, args)
2624 if args.length == 1 then
2625 args = v.frame.arguments
2628 # stantard call-next-method
2629 return v.supercall(mpropdef.as(not null), recv.mtype.as(MClassType), args)
2633 redef class ANewExpr
2636 var mtype = self.mtype.as(MClassType)
2638 var ctype = mtype.ctype
2639 if mtype.mclass.name == "NativeArray" then
2640 assert self.n_args.n_exprs.length == 1
2641 var l = v.expr(self.n_args.n_exprs.first, null)
2642 assert mtype isa MGenericType
2643 var elttype = mtype.arguments.first
2644 return v.native_array_instance(elttype, l)
2645 else if ctype == "val*" then
2646 recv = v.init_instance(mtype)
2647 else if ctype == "void*" then
2648 recv = v.new_expr("NULL/*special!*/", mtype)
2650 recv = v.new_expr("({ctype})0/*special!*/", mtype)
2653 for a in self.n_args.n_exprs do
2654 args.add(v.expr(a, null))
2656 var res2 = v.compile_callsite(self.callsite.as(not null), args)
2657 if res2 != null then
2658 #self.debug("got {res2} from {mproperty}. drop {recv}")
2665 redef class AAttrExpr
2668 var recv = v.expr(self.n_expr, null)
2669 var mproperty = self.mproperty.as(not null)
2670 return v.read_attribute(mproperty, recv)
2674 redef class AAttrAssignExpr
2677 var recv = v.expr(self.n_expr, null)
2678 var i = v.expr(self.n_value, null)
2679 var mproperty = self.mproperty.as(not null)
2680 v.write_attribute(mproperty, recv, i)
2684 redef class AAttrReassignExpr
2687 var recv = v.expr(self.n_expr, null)
2688 var value = v.expr(self.n_value, null)
2689 var mproperty = self.mproperty.as(not null)
2690 var attr = v.read_attribute(mproperty, recv)
2691 var res = v.compile_callsite(self.reassign_callsite.as(not null), [attr, value])
2693 v.write_attribute(mproperty, recv, res)
2697 redef class AIssetAttrExpr
2700 var recv = v.expr(self.n_expr, null)
2701 var mproperty = self.mproperty.as(not null)
2702 return v.isset_attribute(mproperty, recv)
2706 redef class ADebugTypeExpr
2715 redef class Array[E]
2716 # Return a new `Array` with the elements only contened in self and not in `o
`
2717 fun -(o: Array[E]): Array[E] do
2718 var res = new Array[E]
2719 for e in self do if not o.has(e) then res.add(e)
2725 # All `MProperty` associated to all `MClassDef` of `mclass
`
2726 fun properties(mclass: MClass): Set[MProperty] do
2727 if not self.properties_cache.has_key(mclass) then
2728 var properties = new HashSet[MProperty]
2729 var parents = new Array[MClass]
2730 if self.flatten_mclass_hierarchy.has(mclass) then
2731 parents.add_all(mclass.in_hierarchy(self).direct_greaters)
2733 for parent in parents do
2734 properties.add_all(self.properties(parent))
2736 for mclassdef in mclass.mclassdefs do
2737 for mprop in mclassdef.intro_mproperties do
2738 properties.add(mprop)
2741 self.properties_cache[mclass] = properties
2743 return properties_cache[mclass]
2745 private var properties_cache: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
2747 # Write FFI and nitni results to file
2748 fun finalize_ffi(c: AbstractCompiler) do end
2750 # Give requided addinional system libraries (as given to LD_LIBS)
2751 # Note: can return null instead of an empty set
2752 fun collect_linker_libs: nullable Set[String] do return null
2755 # Create a tool context to handle options and paths
2756 var toolcontext = new ToolContext
2758 var opt_mixins = new OptionArray("Additionals module to min-in", "-m")
2759 toolcontext.option_context.add_option(opt_mixins)
2761 toolcontext.tooldescription = "Usage: nitg [OPTION]... file.nit\nCompiles Nit programs."
2763 # We do not add other options, so process them now!
2764 toolcontext.process_options(args)
2766 # We need a model to collect stufs
2767 var model = new Model
2768 # An a model builder to parse files
2769 var modelbuilder = new ModelBuilder(model, toolcontext)
2771 var arguments = toolcontext.option_context.rest
2772 if arguments.length > 1 then
2773 print "Too much arguments: {arguments.join(" ")}"
2774 print toolcontext.tooldescription
2777 var progname = arguments.first
2779 # Here we load an process all modules passed on the command line
2780 var mmodules = modelbuilder.parse([progname])
2781 mmodules.add_all modelbuilder.parse(opt_mixins.value)
2783 if mmodules.is_empty then return
2784 modelbuilder.run_phases
2787 if mmodules.length == 1 then
2788 mainmodule = mmodules.first
2790 mainmodule = new MModule(model, null, mmodules.first.name, mmodules.first.location)
2791 mainmodule.set_imported_mmodules(mmodules)
2794 toolcontext.run_global_phases(mmodules)