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
24 private import annotation
28 # Add compiling options
29 redef class ToolContext
31 var opt_output
= new OptionString("Output file", "-o", "--output")
33 var opt_dir
= new OptionString("Output directory", "--dir")
35 var opt_no_cc
= new OptionBool("Do not invoke C compiler", "--no-cc")
37 var opt_no_main
= new OptionBool("Do not generate main entry point", "--no-main")
39 var opt_make_flags
= new OptionString("Additional options to make", "--make-flags")
41 var opt_max_c_lines
= new OptionInt("Maximum number of lines in generated C files. Use 0 for unlimited", 10000, "--max-c-lines")
43 var opt_group_c_files
= new OptionBool("Group all generated code in the same series of files", "--group-c-files")
45 var opt_compile_dir
= new OptionString("Directory used to generate temporary files", "--compile-dir")
47 var opt_hardening
= new OptionBool("Generate contracts in the C code against bugs in the compiler", "--hardening")
48 # --no-check-covariance
49 var opt_no_check_covariance
= new OptionBool("Disable type tests of covariant parameters (dangerous)", "--no-check-covariance")
50 # --no-check-attr-isset
51 var opt_no_check_attr_isset
= new OptionBool("Disable isset tests before each attribute access (dangerous)", "--no-check-attr-isset")
53 var opt_no_check_assert
= new OptionBool("Disable the evaluation of explicit 'assert' and 'as' (dangerous)", "--no-check-assert")
55 var opt_no_check_autocast
= new OptionBool("Disable implicit casts on unsafe expression usage (dangerous)", "--no-check-autocast")
57 var opt_no_check_null
= new OptionBool("Disable tests of null receiver (dangerous)", "--no-check-null")
59 var opt_no_check_all
= new OptionBool("Disable all tests (dangerous)", "--no-check-all")
60 # --typing-test-metrics
61 var opt_typing_test_metrics
= new OptionBool("Enable static and dynamic count of all type tests", "--typing-test-metrics")
62 # --invocation-metrics
63 var opt_invocation_metrics
= new OptionBool("Enable static and dynamic count of all method invocations", "--invocation-metrics")
64 # --isset-checks-metrics
65 var opt_isset_checks_metrics
= new OptionBool("Enable static and dynamic count of isset checks before attributes access", "--isset-checks-metrics")
67 var opt_no_stacktrace
= new OptionBool("Disable the generation of stack traces", "--no-stacktrace")
69 var opt_no_gcc_directive
= new OptionArray("Disable a advanced gcc directives for optimization", "--no-gcc-directive")
71 var opt_release
= new OptionBool("Compile in release mode and finalize application", "--release")
76 self.option_context
.add_option
(self.opt_output
, self.opt_dir
, self.opt_no_cc
, self.opt_no_main
, self.opt_make_flags
, self.opt_compile_dir
, self.opt_hardening
)
77 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_null
, self.opt_no_check_all
)
78 self.option_context
.add_option
(self.opt_typing_test_metrics
, self.opt_invocation_metrics
, self.opt_isset_checks_metrics
)
79 self.option_context
.add_option
(self.opt_no_stacktrace
)
80 self.option_context
.add_option
(self.opt_no_gcc_directive
)
81 self.option_context
.add_option
(self.opt_release
)
82 self.option_context
.add_option
(self.opt_max_c_lines
, self.opt_group_c_files
)
84 opt_no_main
.hidden
= true
87 redef fun process_options
(args
)
91 if opt_output
.value
!= null and opt_dir
.value
!= null then
92 print
"Option Error: cannot use both --dir and --output"
96 if opt_no_check_all
.value
then
97 opt_no_check_covariance
.value
= true
98 opt_no_check_attr_isset
.value
= true
99 opt_no_check_assert
.value
= true
100 opt_no_check_autocast
.value
= true
101 opt_no_check_null
.value
= true
106 redef class ModelBuilder
107 # Simple indirection to `Toolchain::write_and_make`
108 protected fun write_and_make
(compiler
: AbstractCompiler)
110 var platform
= compiler
.target_platform
111 var toolchain
= platform
.toolchain
(toolcontext
, compiler
)
112 compiler
.toolchain
= toolchain
113 toolchain
.write_and_make
118 # The specific tool-chain associated to the platform
119 fun toolchain
(toolcontext
: ToolContext, compiler
: AbstractCompiler): Toolchain
121 return new MakefileToolchain(toolcontext
, compiler
)
125 # Build toolchain for a specific target program, varies per `Platform`
129 var toolcontext
: ToolContext
131 # Compiler of the target program
132 var compiler
: AbstractCompiler
134 # Directory where to generate all files
136 # The option `--compile_dir` change this directory.
137 fun root_compile_dir
: String
139 var compile_dir
= toolcontext
.opt_compile_dir
.value
140 if compile_dir
== null then compile_dir
= "nit_compile"
144 # Directory where to generate all C files
146 # By default it is `root_compile_dir` but some platform may require that it is a subdirectory.
147 fun compile_dir
: String do return root_compile_dir
149 # Write all C files and compile them
150 fun write_and_make
is abstract
153 # Default toolchain using a Makefile
154 class MakefileToolchain
157 redef fun write_and_make
159 var compile_dir
= compile_dir
161 # Remove the compilation directory unless explicitly set
162 var auto_remove
= toolcontext
.opt_compile_dir
.value
== null
164 # Generate the .h and .c files
165 # A single C file regroups many compiled rumtime functions
166 # 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
168 self.toolcontext
.info
("*** WRITING C ***", 1)
170 root_compile_dir
.mkdir
173 var cfiles
= new Array[String]
174 write_files
(compile_dir
, cfiles
)
176 # Generate the Makefile
178 write_makefile
(compile_dir
, cfiles
)
181 self.toolcontext
.info
("*** END WRITING C: {time1-time0} ***", 2)
183 # Execute the Makefile
185 if self.toolcontext
.opt_no_cc
.value
then return
188 self.toolcontext
.info
("*** COMPILING C ***", 1)
190 compile_c_code
(compile_dir
)
193 sys
.system
("rm -r -- '{root_compile_dir.escape_to_sh}/'")
197 self.toolcontext
.info
("*** END COMPILING C: {time1-time0} ***", 2)
200 # Write all source files to the `compile_dir`
201 fun write_files
(compile_dir
: String, cfiles
: Array[String])
203 var platform
= compiler
.target_platform
204 if platform
.supports_libunwind
then compiler
.build_c_to_nit_bindings
205 var cc_opt_with_libgc
= "-DWITH_LIBGC"
206 if not platform
.supports_libgc
then cc_opt_with_libgc
= ""
208 # Add gc_choser.h to aditionnal bodies
209 var gc_chooser
= new ExternCFile("gc_chooser.c", cc_opt_with_libgc
)
210 if cc_opt_with_libgc
!= "" then gc_chooser
.pkgconfigs
.add
"bdw-gc"
211 compiler
.extern_bodies
.add
(gc_chooser
)
212 var clib
= toolcontext
.nit_dir
/ "clib"
213 compiler
.files_to_copy
.add
"{clib}/gc_chooser.c"
214 compiler
.files_to_copy
.add
"{clib}/gc_chooser.h"
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 FileWriter.open
(hfilepath
)
231 for l
in compiler
.header
.decl_lines
do
235 for l
in compiler
.header
.lines
do
241 var max_c_lines
= toolcontext
.opt_max_c_lines
.value
242 for f
in compiler
.files
do
245 var file
: nullable FileWriter = null
246 for vis
in f
.writers
do
247 if vis
== compiler
.header
then continue
248 var total_lines
= vis
.lines
.length
+ vis
.decl_lines
.length
249 if total_lines
== 0 then continue
251 if file
== null or (count
> max_c_lines
and max_c_lines
> 0) then
253 if file
!= null then file
.close
254 var cfilename
= "{f.name}.{i}.c"
255 var cfilepath
= "{compile_dir}/{cfilename}"
256 self.toolcontext
.info
("new C source files to compile: {cfilepath}", 3)
257 cfiles
.add
(cfilename
)
258 file
= new FileWriter.open
(cfilepath
)
259 file
.write
"#include \"{f.name}.0.h\
"\n"
262 for l
in vis
.decl_lines
do
266 for l
in vis
.lines
do
271 if file
== null then continue
274 var cfilename
= "{f.name}.0.h"
275 var cfilepath
= "{compile_dir}/{cfilename}"
276 var hfile
: nullable FileWriter = null
277 hfile
= new FileWriter.open
(cfilepath
)
278 hfile
.write
"#include \"{hfilename}\
"\n"
279 for key
in f
.required_declarations
do
280 if not compiler
.provided_declarations
.has_key
(key
) then
281 var node
= compiler
.requirers_of_declarations
.get_or_null
(key
)
283 node
.debug
"No provided declaration for {key}"
285 print
"No provided declaration for {key}"
289 hfile
.write compiler
.provided_declarations
[key
]
295 self.toolcontext
.info
("Total C source files to compile: {cfiles.length}", 2)
298 # Get the name of the Makefile to use
299 fun makefile_name
: String do return "{compiler.mainmodule.c_name}.mk"
301 # Get the default name of the executable to produce
302 fun default_outname
: String
304 var mainmodule
= compiler
.mainmodule
.first_real_mmodule
305 return mainmodule
.name
308 # Combine options and platform informations to get the final path of the outfile
309 fun outfile
(mainmodule
: MModule): String
311 var res
= self.toolcontext
.opt_output
.value
312 if res
!= null then return res
313 res
= default_outname
314 var dir
= self.toolcontext
.opt_dir
.value
315 if dir
!= null then return dir
.join_path
(res
)
320 fun write_makefile
(compile_dir
: String, cfiles
: Array[String])
322 var mainmodule
= compiler
.mainmodule
323 var platform
= compiler
.target_platform
325 var outname
= outfile
(mainmodule
)
327 var real_outpath
= compile_dir
.relpath
(outname
)
328 var outpath
= real_outpath
.escape_to_mk
329 if outpath
!= real_outpath
then
330 # If the name is crazy and need escaping, we will do an indirection
331 # 1. generate the binary in the nit_compile dir under an escaped name
332 # 2. copy the binary at the right place in the `all` goal.
333 outpath
= mainmodule
.c_name
335 var makename
= makefile_name
336 var makepath
= "{compile_dir}/{makename}"
337 var makefile
= new FileWriter.open
(makepath
)
339 var linker_options
= new HashSet[String]
340 for m
in mainmodule
.in_importation
.greaters
do
341 var libs
= m
.collect_linker_libs
342 if libs
!= null then linker_options
.add_all
(libs
)
345 makefile
.write
("CC = ccache cc\nCXX = ccache c++\nCFLAGS = -g -O2 -Wno-unused-value -Wno-switch -Wno-attributes\nCINCL =\nLDFLAGS ?= \nLDLIBS ?= -lm {linker_options.join(" ")}\n\n")
347 makefile
.write
"\n# SPECIAL CONFIGURATION FLAGS\n"
348 if platform
.supports_libunwind
then
349 if toolcontext
.opt_no_stacktrace
.value
then
350 makefile
.write
"NO_STACKTRACE=True"
352 makefile
.write
"NO_STACKTRACE= # Set to `True` to enable"
356 # Dynamic adaptations
357 # While `platform` enable complex toolchains, they are statically applied
358 # For a dynamic adaptsation of the compilation, the generated Makefile should check and adapt things itself
359 makefile
.write
"\n\n"
361 # Check and adapt the targeted system
362 makefile
.write
("uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')\n")
364 # Check and adapt for the compiler used
365 # clang need an additionnal `-Qunused-arguments`
366 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")
368 if platform
.supports_libunwind
then
370 ifneq ($(NO_STACKTRACE), True)
371 # Check and include lib-unwind in a portable way
372 ifneq ($(uname_S),Darwin)
373 # already included on macosx, but need to get the correct flags in other supported platforms.
374 ifeq ($(shell pkg-config --exists 'libunwind'; echo $$?), 0)
375 LDLIBS += `pkg-config --libs libunwind`
376 CFLAGS += `pkg-config --cflags libunwind`
378 $(warning "[_] stack-traces disabled. Please install libunwind-dev.")
379 CFLAGS += -D NO_STACKTRACE
383 # Stacktraces disabled
384 CFLAGS += -D NO_STACKTRACE
389 makefile
.write
("CFLAGS += -D NO_STACKTRACE\n\n")
392 makefile
.write
("all: {outpath}\n")
393 if outpath
!= real_outpath
then
394 makefile
.write
("\tcp -- {outpath.escape_to_sh} {real_outpath.escape_to_sh.replace("$","$$")}")
398 var ofiles
= new Array[String]
399 var dep_rules
= new Array[String]
400 # Compile each generated file
402 var o
= f
.strip_extension
(".c") + ".o"
403 makefile
.write
("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -c -o {o} {f}\n\n")
408 # Generate linker script, if any
409 if not compiler
.linker_script
.is_empty
then
410 var linker_script_path
= "{compile_dir}/linker_script"
411 ofiles
.add
"linker_script"
412 var f
= new FileWriter.open
(linker_script_path
)
413 for l
in compiler
.linker_script
do
420 var java_files
= new Array[ExternFile]
422 var pkgconfigs
= new Array[String]
423 for f
in compiler
.extern_bodies
do
424 pkgconfigs
.add_all f
.pkgconfigs
427 if not pkgconfigs
.is_empty
then
429 # does pkg-config exists?
430 ifneq ($(shell which pkg-config >/dev/null; echo $$?), 0)
431 $(error "Command `pkg-config` not found. Please install it")
434 for p
in pkgconfigs
do
436 # Check for library {{{p}}}
437 ifneq ($(shell pkg-config --exists '{{{p}}}'; echo $$?), 0)
438 $(error "pkg-config: package {{{p}}} is not found.")
444 # Compile each required extern body into a specific .o
445 for f
in compiler
.extern_bodies
do
446 var o
= f
.makefile_rule_name
447 var ff
= f
.filename
.basename
("")
448 makefile
.write
("{o}: {ff}\n")
449 makefile
.write
("\t{f.makefile_rule_content}\n\n")
450 dep_rules
.add
(f
.makefile_rule_name
)
452 if f
.compiles_to_o_file
then ofiles
.add
(o
)
453 if f
.add_to_jar
then java_files
.add
(f
)
456 if not java_files
.is_empty
then
457 var jar_file
= "{outpath}.jar"
459 var class_files_array
= new Array[String]
460 for f
in java_files
do class_files_array
.add
(f
.makefile_rule_name
)
461 var class_files
= class_files_array
.join
(" ")
463 makefile
.write
("{jar_file}: {class_files}\n")
464 makefile
.write
("\tjar cf {jar_file} {class_files}\n\n")
465 dep_rules
.add jar_file
470 if not pkgconfigs
.is_empty
then
471 pkg
= "`pkg-config --libs {pkgconfigs.join(" ")}`"
473 makefile
.write
("{outpath}: {dep_rules.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outpath.escape_to_sh} {ofiles.join(" ")} $(LDLIBS) {pkg}\n\n")
475 makefile
.write
("clean:\n\trm {ofiles.join(" ")} 2>/dev/null\n")
476 if outpath
!= real_outpath
then
477 makefile
.write
("\trm -- {outpath.escape_to_sh} 2>/dev/null\n")
480 self.toolcontext
.info
("Generated makefile: {makepath}", 2)
482 makepath
.file_copy_to
"{compile_dir}/Makefile"
485 # The C code is generated, compile it to an executable
486 fun compile_c_code
(compile_dir
: String)
488 var makename
= makefile_name
490 var makeflags
= self.toolcontext
.opt_make_flags
.value
491 if makeflags
== null then makeflags
= ""
493 var command
= "make -B -C {compile_dir} -f {makename} -j 4 {makeflags}"
494 self.toolcontext
.info
(command
, 2)
497 if self.toolcontext
.verbose_level
>= 3 then
498 res
= sys
.system
("{command} 2>&1")
500 res
= sys
.system
("{command} 2>&1 >/dev/null")
503 toolcontext
.error
(null, "Compilation Error: `make` failed with error code: {res}. The command was `{command}`.")
508 # Singleton that store the knowledge about the compilation process
509 abstract class AbstractCompiler
510 type VISITOR: AbstractCompilerVisitor
512 # Table corresponding c_names to nit names (methods)
513 var names
= new HashMap[String, String]
515 # The main module of the program currently compiled
516 # Is assigned during the separate compilation
517 var mainmodule
: MModule is writable
519 # The real main module of the program
520 var realmainmodule
: MModule is noinit
522 # The modelbuilder used to know the model and the AST
523 var modelbuilder
: ModelBuilder is protected writable
525 # The associated toolchain
527 # Set by `modelbuilder.write_and_make` and permit sub-routines to access the current toolchain if required.
528 var toolchain
: Toolchain is noinit
530 # Is hardening asked? (see --hardening)
531 fun hardening
: Bool do return self.modelbuilder
.toolcontext
.opt_hardening
.value
533 # The targeted specific platform
534 var target_platform
: Platform is noinit
538 self.realmainmodule
= mainmodule
539 target_platform
= mainmodule
.target_platform
or else new Platform
542 # Do the full code generation of the program `mainmodule`
543 # It is the main method usually called after the instantiation
544 fun do_compilation
is abstract
546 # Force the creation of a new file
547 # The point is to avoid contamination between must-be-compiled-separately files
548 fun new_file
(name
: String): CodeFile
550 if modelbuilder
.toolcontext
.opt_group_c_files
.value
then
551 if self.files
.is_empty
then
552 var f
= new CodeFile(mainmodule
.c_name
)
555 return self.files
.first
557 var f
= new CodeFile(name
)
562 # The list of all associated files
563 # Used to generate .c files
564 var files
= new List[CodeFile]
566 # Initialize a visitor specific for a compiler engine
567 fun new_visitor
: VISITOR is abstract
569 # Where global declaration are stored (the main .h)
570 var header
: CodeWriter is writable, noinit
572 # Additionnal linker script for `ld`.
573 # Mainly used to do specific link-time symbol resolution
574 var linker_script
= new Array[String]
576 # Provide a declaration that can be requested (before or latter) by a visitor
577 fun provide_declaration
(key
: String, s
: String)
579 if self.provided_declarations
.has_key
(key
) then
580 assert self.provided_declarations
[key
] == s
582 self.provided_declarations
[key
] = s
585 private var provided_declarations
= new HashMap[String, String]
587 private var requirers_of_declarations
= new HashMap[String, ANode]
589 # Builds the .c and .h files to be used when generating a Stack Trace
590 # Binds the generated C function names to Nit function names
591 fun build_c_to_nit_bindings
593 var compile_dir
= toolchain
.compile_dir
595 var stream
= new FileWriter.open
("{compile_dir}/c_functions_hash.c")
596 stream
.write
("#include <string.h>\n")
597 stream
.write
("#include <stdlib.h>\n")
598 stream
.write
("#include \"c_functions_hash
.h\
"\n")
599 stream
.write
("typedef struct C_Nit_Names\{char* name; char* nit_name;\}C_Nit_Names;\n")
600 stream
.write
("const char* get_nit_name(register const char* procproc, register unsigned int len)\{\n")
601 stream
.write
("char* procname = malloc(len+1);")
602 stream
.write
("memcpy(procname, procproc, len);")
603 stream
.write
("procname[len] = '\\0';")
604 stream
.write
("static const C_Nit_Names map[{names.length}] = \{\n")
605 for i
in names
.keys
do
607 stream.write(i.escape_to_c)
608 stream.write("\
",\"")
609 stream.write(names[i].escape_to_c)
610 stream.write("\
"\},\n")
612 stream
.write
("\};\n")
613 stream
.write
("int i;")
614 stream
.write
("for(i = 0; i < {names.length}; i++)\{")
615 stream
.write
("if(strcmp(procname,map[i].name) == 0)\{")
616 stream
.write
("free(procname);")
617 stream
.write
("return map[i].nit_name;")
620 stream
.write
("free(procname);")
621 stream
.write
("return NULL;")
625 stream
= new FileWriter.open
("{compile_dir}/c_functions_hash.h")
626 stream
.write
("const char* get_nit_name(register const char* procname, register unsigned int len);\n")
629 extern_bodies
.add
(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
633 # This method call compile_header_strucs method that has to be refined
634 fun compile_header
do
635 self.header
.add_decl
("#include <stdlib.h>")
636 self.header
.add_decl
("#include <stdio.h>")
637 self.header
.add_decl
("#include <string.h>")
638 self.header
.add_decl
("#include <sys/types.h>\n")
639 self.header
.add_decl
("#include <unistd.h>\n")
640 self.header
.add_decl
("#include <stdint.h>\n")
641 self.header
.add_decl
("#include \"gc_chooser
.h\
"")
642 self.header
.add_decl
("#ifdef ANDROID")
643 self.header
.add_decl
(" #include <android/log.h>")
644 self.header
.add_decl
(" #define PRINT_ERROR(...) (void)__android_log_print(ANDROID_LOG_WARN, \"Nit\
", __VA_ARGS__)")
645 self.header
.add_decl
("#else")
646 self.header
.add_decl
(" #define PRINT_ERROR(...) fprintf(stderr, __VA_ARGS__)")
647 self.header
.add_decl
("#endif")
649 compile_header_structs
650 compile_nitni_structs
652 var gccd_disable
= modelbuilder
.toolcontext
.opt_no_gcc_directive
.value
653 if gccd_disable
.has
("noreturn") or gccd_disable
.has
("all") then
654 # Signal handler function prototype
655 self.header
.add_decl
("void fatal_exit(int);")
657 self.header
.add_decl
("void fatal_exit(int) __attribute__ ((noreturn));")
660 if gccd_disable
.has
("likely") or gccd_disable
.has
("all") then
661 self.header
.add_decl
("#define likely(x) (x)")
662 self.header
.add_decl
("#define unlikely(x) (x)")
663 else if gccd_disable
.has
("correct-likely") then
664 # invert the `likely` definition
665 # Used by masochists to bench the worst case
666 self.header
.add_decl
("#define likely(x) __builtin_expect((x),0)")
667 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),1)")
669 self.header
.add_decl
("#define likely(x) __builtin_expect((x),1)")
670 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),0)")
673 # Global variable used by intern methods
674 self.header
.add_decl
("extern int glob_argc;")
675 self.header
.add_decl
("extern char **glob_argv;")
676 self.header
.add_decl
("extern val *glob_sys;")
679 # Declaration of structures for live Nit types
680 protected fun compile_header_structs
is abstract
682 # Declaration of structures for nitni undelying the FFI
683 protected fun compile_nitni_structs
685 self.header
.add_decl
"""
686 /* Native reference to Nit objects */
687 /* This structure is used to represent every Nit type in extern methods and custom C code. */
689 struct nitni_ref *next,
690 *prev; /* adjacent global references in global list */
691 int count; /* number of time this global reference has been marked */
694 /* List of global references from C code to Nit objects */
695 /* Instanciated empty at init of Nit system and filled explicitly by user in C code */
696 struct nitni_global_ref_list_t {
697 struct nitni_ref *head, *tail;
699 extern struct nitni_global_ref_list_t *nitni_global_ref_list;
701 /* Initializer of global reference list */
702 extern void nitni_global_ref_list_init();
704 /* Intern function to add a global reference to the list */
705 extern void nitni_global_ref_add( struct nitni_ref *ref );
707 /* Intern function to remove a global reference from the list */
708 extern void nitni_global_ref_remove( struct nitni_ref *ref );
710 /* Increase count on an existing global reference */
711 extern void nitni_global_ref_incr( struct nitni_ref *ref );
713 /* Decrease count on an existing global reference */
714 extern void nitni_global_ref_decr( struct nitni_ref *ref );
718 fun compile_finalizer_function
720 var finalizable_type
= mainmodule
.finalizable_type
721 if finalizable_type
== null then return
723 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
725 if finalize_meth
== null then
726 modelbuilder
.toolcontext
.error
(null, "Error: the `Finalizable` class does not declare the `finalize` method.")
730 var v
= self.new_visitor
731 v
.add_decl
"void gc_finalize (void *obj, void *client_data) \{"
732 var recv
= v
.new_expr
("obj", finalizable_type
)
733 v
.send
(finalize_meth
, [recv
])
737 # Generate the main C function.
741 # * allocate the Sys object if it exists
742 # * call init if is exists
743 # * call main if it exists
744 fun compile_main_function
746 var v
= self.new_visitor
747 v
.add_decl
("#include <signal.h>")
748 var platform
= target_platform
750 var no_main
= platform
.no_main
or modelbuilder
.toolcontext
.opt_no_main
.value
752 if platform
.supports_libunwind
then
753 v
.add_decl
("#ifndef NO_STACKTRACE")
754 v
.add_decl
("#define UNW_LOCAL_ONLY")
755 v
.add_decl
("#include <libunwind.h>")
756 v
.add_decl
("#include \"c_functions_hash
.h\
"")
759 v
.add_decl
("int glob_argc;")
760 v
.add_decl
("char **glob_argv;")
761 v
.add_decl
("val *glob_sys;")
763 if self.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
764 for tag
in count_type_test_tags
do
765 v
.add_decl
("long count_type_test_resolved_{tag};")
766 v
.add_decl
("long count_type_test_unresolved_{tag};")
767 v
.add_decl
("long count_type_test_skipped_{tag};")
768 v
.compiler
.header
.add_decl
("extern long count_type_test_resolved_{tag};")
769 v
.compiler
.header
.add_decl
("extern long count_type_test_unresolved_{tag};")
770 v
.compiler
.header
.add_decl
("extern long count_type_test_skipped_{tag};")
774 if self.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then
775 v
.add_decl
("long count_invoke_by_tables;")
776 v
.add_decl
("long count_invoke_by_direct;")
777 v
.add_decl
("long count_invoke_by_inline;")
778 v
.compiler
.header
.add_decl
("extern long count_invoke_by_tables;")
779 v
.compiler
.header
.add_decl
("extern long count_invoke_by_direct;")
780 v
.compiler
.header
.add_decl
("extern long count_invoke_by_inline;")
783 if self.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
784 v
.add_decl
("long count_attr_reads = 0;")
785 v
.add_decl
("long count_isset_checks = 0;")
786 v
.compiler
.header
.add_decl
("extern long count_attr_reads;")
787 v
.compiler
.header
.add_decl
("extern long count_isset_checks;")
790 v
.add_decl
("static void show_backtrace(void) \{")
791 if platform
.supports_libunwind
then
792 v
.add_decl
("#ifndef NO_STACKTRACE")
793 v
.add_decl
("char* opt = getenv(\"NIT_NO_STACK\
");")
794 v
.add_decl
("unw_cursor_t cursor;")
795 v
.add_decl
("if(opt==NULL)\{")
796 v
.add_decl
("unw_context_t uc;")
797 v
.add_decl
("unw_word_t ip;")
798 v
.add_decl
("char* procname = malloc(sizeof(char) * 100);")
799 v
.add_decl
("unw_getcontext(&uc);")
800 v
.add_decl
("unw_init_local(&cursor, &uc);")
801 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
802 v
.add_decl
("PRINT_ERROR(\"-- Stack Trace ------------------------------\\n\
");")
803 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
804 v
.add_decl
("while (unw_step(&cursor) > 0) \{")
805 v
.add_decl
(" unw_get_proc_name(&cursor, procname, 100, &ip);")
806 v
.add_decl
(" const char* recv = get_nit_name(procname, strlen(procname));")
807 v
.add_decl
(" if (recv != NULL)\{")
808 v
.add_decl
(" PRINT_ERROR(\"` %s\\n\", recv);")
809 v.add_decl(" \}else\{")
810 v.add_decl(" PRINT_ERROR(\"` %s\\n\
", procname);")
813 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
814 v
.add_decl
("free(procname);")
816 v
.add_decl
("#endif /* NO_STACKTRACE */")
820 v
.add_decl
("void sig_handler(int signo)\{")
821 v
.add_decl
("PRINT_ERROR(\"Caught signal
: %s\\n\
", strsignal(signo));")
822 v
.add_decl
("show_backtrace();")
824 v
.add_decl
("signal(signo, SIG_DFL);")
825 v
.add_decl
("kill(getpid(), signo);")
828 v
.add_decl
("void fatal_exit(int status) \{")
829 v
.add_decl
("show_backtrace();")
830 v
.add_decl
("exit(status);")
834 v
.add_decl
("int nit_main(int argc, char** argv) \{")
836 v
.add_decl
("int main(int argc, char** argv) \{")
839 v
.add
("signal(SIGABRT, sig_handler);")
840 v
.add
("signal(SIGFPE, sig_handler);")
841 v
.add
("signal(SIGILL, sig_handler);")
842 v
.add
("signal(SIGINT, sig_handler);")
843 v
.add
("signal(SIGTERM, sig_handler);")
844 v
.add
("signal(SIGSEGV, sig_handler);")
845 v
.add
("signal(SIGPIPE, sig_handler);")
847 v
.add
("glob_argc = argc; glob_argv = argv;")
848 v
.add
("initialize_gc_option();")
850 v
.add
"initialize_nitni_global_refs();"
852 var main_type
= mainmodule
.sys_type
853 if main_type
!= null then
854 var mainmodule
= v
.compiler
.mainmodule
855 var glob_sys
= v
.init_instance
(main_type
)
856 v
.add
("glob_sys = {glob_sys};")
857 var main_init
= mainmodule
.try_get_primitive_method
("init", main_type
.mclass
)
858 if main_init
!= null then
859 v
.send
(main_init
, [glob_sys
])
861 var main_method
= mainmodule
.try_get_primitive_method
("run", main_type
.mclass
) or else
862 mainmodule
.try_get_primitive_method
("main", main_type
.mclass
)
863 if main_method
!= null then
864 v
.send
(main_method
, [glob_sys
])
868 if self.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
869 v
.add_decl
("long count_type_test_resolved_total = 0;")
870 v
.add_decl
("long count_type_test_unresolved_total = 0;")
871 v
.add_decl
("long count_type_test_skipped_total = 0;")
872 v
.add_decl
("long count_type_test_total_total = 0;")
873 for tag
in count_type_test_tags
do
874 v
.add_decl
("long count_type_test_total_{tag};")
875 v
.add
("count_type_test_total_{tag} = count_type_test_resolved_{tag} + count_type_test_unresolved_{tag} + count_type_test_skipped_{tag};")
876 v
.add
("count_type_test_resolved_total += count_type_test_resolved_{tag};")
877 v
.add
("count_type_test_unresolved_total += count_type_test_unresolved_{tag};")
878 v
.add
("count_type_test_skipped_total += count_type_test_skipped_{tag};")
879 v
.add
("count_type_test_total_total += count_type_test_total_{tag};")
881 v
.add
("printf(\"# dynamic count_type_test: total %l\\n\");")
882 v
.add
("printf(\"\\tresolved\\tunresolved\\tskipped\\ttotal\\n\
");")
883 var tags
= count_type_test_tags
.to_a
886 v
.add
("printf(\"{tag}\
");")
887 v
.add
("printf(\"\\t
%ld
(%.2f
%%)\
", count_type_test_resolved_{tag}, 100.0*count_type_test_resolved_{tag}/count_type_test_total_total);")
888 v
.add
("printf(\"\\t
%ld
(%.2f
%%)\
", count_type_test_unresolved_{tag}, 100.0*count_type_test_unresolved_{tag}/count_type_test_total_total);")
889 v
.add
("printf(\"\\t
%ld
(%.2f
%%)\
", count_type_test_skipped_{tag}, 100.0*count_type_test_skipped_{tag}/count_type_test_total_total);")
890 v
.add
("printf(\"\\t
%ld
(%.2f
%%)\\n\
", count_type_test_total_{tag}, 100.0*count_type_test_total_{tag}/count_type_test_total_total);")
894 if self.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then
895 v
.add_decl
("long count_invoke_total;")
896 v
.add
("count_invoke_total = count_invoke_by_tables + count_invoke_by_direct + count_invoke_by_inline;")
897 v
.add
("printf(\"# dynamic count_invocation: total %ld\\n\", count_invoke_total);")
898 v
.add
("printf(\"by table
: %ld
(%.2f
%%)\\n\
", count_invoke_by_tables, 100.0*count_invoke_by_tables/count_invoke_total);")
899 v
.add
("printf(\"direct
: %ld
(%.2f
%%)\\n\
", count_invoke_by_direct, 100.0*count_invoke_by_direct/count_invoke_total);")
900 v
.add
("printf(\"inlined
: %ld
(%.2f
%%)\\n\
", count_invoke_by_inline, 100.0*count_invoke_by_inline/count_invoke_total);")
903 if self.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
904 v
.add
("printf(\"# dynamic attribute reads: %ld\\n\", count_attr_reads);")
905 v
.add
("printf(\"# dynamic isset checks: %ld\\n\", count_isset_checks);")
911 for m
in mainmodule
.in_importation
.greaters
do
912 var f
= "FILE_"+m
.c_name
913 v
.add
"const char {f}[] = \"{m.location.file.filename.escape_to_c}\
";"
914 provide_declaration
(f
, "extern const char {f}[];")
918 # Copile all C functions related to the [incr|decr]_ref features of the FFI
919 fun compile_nitni_global_ref_functions
921 var v
= self.new_visitor
923 struct nitni_global_ref_list_t *nitni_global_ref_list;
924 void initialize_nitni_global_refs() {
925 nitni_global_ref_list = (struct nitni_global_ref_list_t*)nit_alloc(sizeof(struct nitni_global_ref_list_t));
926 nitni_global_ref_list->head = NULL;
927 nitni_global_ref_list->tail = NULL;
930 void nitni_global_ref_add( struct nitni_ref *ref ) {
931 if ( nitni_global_ref_list->head == NULL ) {
932 nitni_global_ref_list->head = ref;
935 nitni_global_ref_list->tail->next = ref;
936 ref->prev = nitni_global_ref_list->tail;
938 nitni_global_ref_list->tail = ref;
943 void nitni_global_ref_remove( struct nitni_ref *ref ) {
944 if ( ref->prev == NULL ) {
945 nitni_global_ref_list->head = ref->next;
947 ref->prev->next = ref->next;
950 if ( ref->next == NULL ) {
951 nitni_global_ref_list->tail = ref->prev;
953 ref->next->prev = ref->prev;
957 extern void nitni_global_ref_incr( struct nitni_ref *ref ) {
958 if ( ref->count == 0 ) /* not registered */
961 nitni_global_ref_add( ref );
967 extern void nitni_global_ref_decr( struct nitni_ref *ref ) {
968 if ( ref->count == 1 ) /* was last reference */
970 /* remove from list */
971 nitni_global_ref_remove( ref );
979 # List of additional files required to compile (FFI)
980 var extern_bodies
= new Array[ExternFile]
982 # List of source files to copy over to the compile dir
983 var files_to_copy
= new Array[String]
985 # This is used to avoid adding an extern file more than once
986 private var seen_extern
= new ArraySet[String]
988 # Generate code that initialize the attributes on a new instance
989 fun generate_init_attr
(v
: VISITOR, recv
: RuntimeVariable, mtype
: MClassType)
991 var cds
= mtype
.collect_mclassdefs
(self.mainmodule
).to_a
992 self.mainmodule
.linearize_mclassdefs
(cds
)
994 for npropdef
in modelbuilder
.collect_attr_propdef
(cd
) do
995 npropdef
.init_expr
(v
, recv
)
1000 # Generate code that check if an attribute is correctly initialized
1001 fun generate_check_attr
(v
: VISITOR, recv
: RuntimeVariable, mtype
: MClassType)
1003 var cds
= mtype
.collect_mclassdefs
(self.mainmodule
).to_a
1004 self.mainmodule
.linearize_mclassdefs
(cds
)
1006 for npropdef
in modelbuilder
.collect_attr_propdef
(cd
) do
1007 npropdef
.check_expr
(v
, recv
)
1014 var count_type_test_tags
: Array[String] = ["isa", "as", "auto", "covariance", "erasure"]
1015 var count_type_test_resolved
: HashMap[String, Int] = init_count_type_test_tags
1016 var count_type_test_unresolved
: HashMap[String, Int] = init_count_type_test_tags
1017 var count_type_test_skipped
: HashMap[String, Int] = init_count_type_test_tags
1019 protected fun init_count_type_test_tags
: HashMap[String, Int]
1021 var res
= new HashMap[String, Int]
1022 for tag
in count_type_test_tags
do
1028 # Display stats about compilation process
1032 # * type tests against resolved types (`x isa Collection[Animal]`)
1033 # * type tests against unresolved types (`x isa Collection[E]`)
1034 # * type tests skipped
1035 # * type tests total
1038 if self.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
1039 print
"# static count_type_test"
1040 print
"\tresolved:\tunresolved\tskipped\ttotal"
1041 var count_type_test_total
= init_count_type_test_tags
1042 count_type_test_resolved
["total"] = 0
1043 count_type_test_unresolved
["total"] = 0
1044 count_type_test_skipped
["total"] = 0
1045 count_type_test_total
["total"] = 0
1046 for tag
in count_type_test_tags
do
1047 count_type_test_total
[tag
] = count_type_test_resolved
[tag
] + count_type_test_unresolved
[tag
] + count_type_test_skipped
[tag
]
1048 count_type_test_resolved
["total"] += count_type_test_resolved
[tag
]
1049 count_type_test_unresolved
["total"] += count_type_test_unresolved
[tag
]
1050 count_type_test_skipped
["total"] += count_type_test_skipped
[tag
]
1051 count_type_test_total
["total"] += count_type_test_total
[tag
]
1053 var count_type_test
= count_type_test_total
["total"]
1054 var tags
= count_type_test_tags
.to_a
1058 printn
"\t{count_type_test_resolved[tag]} ({div(count_type_test_resolved[tag],count_type_test)}%)"
1059 printn
"\t{count_type_test_unresolved[tag]} ({div(count_type_test_unresolved[tag],count_type_test)}%)"
1060 printn
"\t{count_type_test_skipped[tag]} ({div(count_type_test_skipped[tag],count_type_test)}%)"
1061 printn
"\t{count_type_test_total[tag]} ({div(count_type_test_total[tag],count_type_test)}%)"
1067 fun finalize_ffi_for_module
(mmodule
: MModule) do mmodule
.finalize_ffi
(self)
1070 # A file unit (may be more than one file if
1071 # A file unit aim to be autonomous and is made or one or more `CodeWriter`s
1074 var writers
= new Array[CodeWriter]
1075 var required_declarations
= new HashSet[String]
1078 # Where to store generated lines
1081 var lines
: List[String] = new List[String]
1082 var decl_lines
: List[String] = new List[String]
1084 # Add a line in the main part of the generated C
1085 fun add
(s
: String) do self.lines
.add
(s
)
1088 # (used for local or global declaration)
1089 fun add_decl
(s
: String) do self.decl_lines
.add
(s
)
1093 file
.writers
.add
(self)
1097 # A visitor on the AST of property definition that generate the C code.
1098 abstract class AbstractCompilerVisitor
1100 type COMPILER: AbstractCompiler
1102 # The associated compiler
1103 var compiler
: COMPILER
1105 # The current visited AST node
1106 var current_node
: nullable ANode = null is writable
1108 # The current `StaticFrame`
1109 var frame
: nullable StaticFrame = null is writable
1111 # Alias for self.compiler.mainmodule.object_type
1112 fun object_type
: MClassType do return self.compiler
.mainmodule
.object_type
1114 # Alias for self.compiler.mainmodule.bool_type
1115 fun bool_type
: MClassType do return self.compiler
.mainmodule
.bool_type
1117 var writer
: CodeWriter is noinit
1121 self.writer
= new CodeWriter(compiler
.files
.last
)
1124 # Force to get the primitive property named `name` in the instance `recv` or abort
1125 fun get_property
(name
: String, recv
: MType): MMethod
1127 assert recv
isa MClassType
1128 return self.compiler
.modelbuilder
.force_get_primitive_method
(self.current_node
, name
, recv
.mclass
, self.compiler
.mainmodule
)
1131 fun compile_callsite
(callsite
: CallSite, arguments
: Array[RuntimeVariable]): nullable RuntimeVariable
1133 var initializers
= callsite
.mpropdef
.initializers
1134 if not initializers
.is_empty
then
1135 var recv
= arguments
.first
1138 for p
in initializers
do
1139 if p
isa MMethod then
1141 for x
in p
.intro
.msignature
.mparameters
do
1142 args
.add arguments
[i
]
1146 else if p
isa MAttribute then
1147 self.write_attribute
(p
, recv
, arguments
[i
])
1151 assert i
== arguments
.length
1153 return self.send
(callsite
.mproperty
, [recv
])
1156 return self.send
(callsite
.mproperty
, arguments
)
1159 fun native_array_instance
(elttype
: MType, length
: RuntimeVariable): RuntimeVariable is abstract
1161 fun calloc_array
(ret_type
: MType, arguments
: Array[RuntimeVariable]) is abstract
1163 fun native_array_def
(pname
: String, ret_type
: nullable MType, arguments
: Array[RuntimeVariable]) is abstract
1165 # Return an element of a native array.
1166 # The method is unsafe and is just a direct wrapper for the specific implementation of native arrays
1167 fun native_array_get
(native_array
: RuntimeVariable, index
: Int): RuntimeVariable is abstract
1169 # Store an element in a native array.
1170 # The method is unsafe and is just a direct wrapper for the specific implementation of native arrays
1171 fun native_array_set
(native_array
: RuntimeVariable, index
: Int, value
: RuntimeVariable) is abstract
1173 # Evaluate `args` as expressions in the call of `mpropdef` on `recv`.
1174 # This method is used to manage varargs in signatures and returns the real array
1175 # of runtime variables to use in the call.
1176 fun varargize
(mpropdef
: MMethodDef, map
: nullable SignatureMap, recv
: RuntimeVariable, args
: SequenceRead[AExpr]): Array[RuntimeVariable]
1178 var msignature
= mpropdef
.new_msignature
or else mpropdef
.msignature
.as(not null)
1179 var res
= new Array[RuntimeVariable]
1182 if msignature
.arity
== 0 then return res
1185 assert args
.length
== msignature
.arity
1187 res
.add
self.expr
(ne
, null)
1192 # Eval in order of arguments, not parameters
1193 var exprs
= new Array[RuntimeVariable].with_capacity
(args
.length
)
1195 exprs
.add
self.expr
(ne
, null)
1198 # Fill `res` with the result of the evaluation according to the mapping
1199 for i
in [0..msignature
.arity
[ do
1200 var param
= msignature
.mparameters
[i
]
1201 var j
= map
.map
.get_or_null
(i
)
1204 res
.add
(null_instance
)
1207 if param
.is_vararg
and map
.vararg_decl
> 0 then
1208 var vararg
= exprs
.sub
(j
, map
.vararg_decl
)
1209 var elttype
= param
.mtype
1210 var arg
= self.vararg_instance
(mpropdef
, recv
, vararg
, elttype
)
1221 # Anchor a type to the main module and the current receiver
1222 fun anchor
(mtype
: MType): MType
1224 if not mtype
.need_anchor
then return mtype
1225 return mtype
.anchor_to
(self.compiler
.mainmodule
, self.frame
.receiver
)
1228 fun resolve_for
(mtype
: MType, recv
: RuntimeVariable): MType
1230 if not mtype
.need_anchor
then return mtype
1231 return mtype
.resolve_for
(recv
.mcasttype
, self.frame
.receiver
, self.compiler
.mainmodule
, true)
1234 # Unsafely cast a value to a new type
1235 # ie the result share the same C variable but my have a different mcasttype
1236 # NOTE: if the adaptation is useless then `value` is returned as it.
1237 # ENSURE: `result.name == value.name`
1238 fun autoadapt
(value
: RuntimeVariable, mtype
: MType): RuntimeVariable
1240 mtype
= self.anchor
(mtype
)
1241 var valmtype
= value
.mcasttype
1242 if valmtype
.is_subtype
(self.compiler
.mainmodule
, null, mtype
) then
1246 if valmtype
isa MNullableType and valmtype
.mtype
.is_subtype
(self.compiler
.mainmodule
, null, mtype
) then
1247 var res
= new RuntimeVariable(value
.name
, valmtype
, valmtype
.mtype
)
1250 var res
= new RuntimeVariable(value
.name
, valmtype
, mtype
)
1255 # Generate a super call from a method definition
1256 fun supercall
(m
: MMethodDef, recvtype
: MClassType, args
: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1258 # Adapt the arguments of a method according to targetted `MMethodDef`
1259 fun adapt_signature
(m
: MMethodDef, args
: Array[RuntimeVariable]) is abstract
1261 # Unbox all the arguments of a method when implemented `extern` or `intern`
1262 fun unbox_signature_extern
(m
: MMethodDef, args
: Array[RuntimeVariable]) is abstract
1264 # Box or unbox a value to another type iff a C type conversion is needed
1265 # ENSURE: `result.mtype.ctype == mtype.ctype`
1266 fun autobox
(value
: RuntimeVariable, mtype
: MType): RuntimeVariable is abstract
1268 # Box extern classes to be used in the generated code
1269 fun box_extern
(value
: RuntimeVariable, mtype
: MType): RuntimeVariable is abstract
1271 # Unbox extern classes to be used in extern code (legacy NI and FFI)
1272 fun unbox_extern
(value
: RuntimeVariable, mtype
: MType): RuntimeVariable is abstract
1274 # Generate a polymorphic subtype test
1275 fun type_test
(value
: RuntimeVariable, mtype
: MType, tag
: String): RuntimeVariable is abstract
1277 # Generate the code required to dynamically check if 2 objects share the same runtime type
1278 fun is_same_type_test
(value1
, value2
: RuntimeVariable): RuntimeVariable is abstract
1280 # Generate a Nit "is" for two runtime_variables
1281 fun equal_test
(value1
, value2
: RuntimeVariable): RuntimeVariable is abstract
1285 # Generate a static call on a method definition
1286 fun call
(m
: MMethodDef, recvtype
: MClassType, args
: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1288 # Generate a polymorphic send for the method `m` and the arguments `args`
1289 fun send
(m
: MMethod, args
: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1291 # Generate a monomorphic send for the method `m`, the type `t` and the arguments `args`
1292 fun monomorphic_send
(m
: MMethod, t
: MType, args
: Array[RuntimeVariable]): nullable RuntimeVariable
1294 assert t
isa MClassType
1295 var propdef
= m
.lookup_first_definition
(self.compiler
.mainmodule
, t
)
1296 return self.call
(propdef
, t
, args
)
1299 # Generate a monomorphic super send from the method `m`, the type `t` and the arguments `args`
1300 fun monomorphic_super_send
(m
: MMethodDef, t
: MType, args
: Array[RuntimeVariable]): nullable RuntimeVariable
1302 assert t
isa MClassType
1303 m
= m
.lookup_next_definition
(self.compiler
.mainmodule
, t
)
1304 return self.call
(m
, t
, args
)
1307 # Attributes handling
1309 # Generate a polymorphic attribute is_set test
1310 fun isset_attribute
(a
: MAttribute, recv
: RuntimeVariable): RuntimeVariable is abstract
1312 # Generate a polymorphic attribute read
1313 fun read_attribute
(a
: MAttribute, recv
: RuntimeVariable): RuntimeVariable is abstract
1315 # Generate a polymorphic attribute write
1316 fun write_attribute
(a
: MAttribute, recv
: RuntimeVariable, value
: RuntimeVariable) is abstract
1320 # Add a check and an abort for a null receiver if needed
1321 fun check_recv_notnull
(recv
: RuntimeVariable)
1323 if self.compiler
.modelbuilder
.toolcontext
.opt_no_check_null
.value
then return
1325 var maybenull
= recv
.mcasttype
isa MNullableType or recv
.mcasttype
isa MNullType
1327 self.add
("if (unlikely({recv} == NULL)) \{")
1328 self.add_abort
("Receiver is null")
1335 private var names
= new HashSet[String]
1336 private var last
: Int = 0
1338 # Return a new name based on `s` and unique in the visitor
1339 fun get_name
(s
: String): String
1341 if not self.names
.has
(s
) then
1345 var i
= self.last
+ 1
1348 if not self.names
.has
(s2
) then
1357 # Return an unique and stable identifier associated with an escapemark
1358 fun escapemark_name
(e
: nullable EscapeMark): String
1361 if frame
.escapemark_names
.has_key
(e
) then return frame
.escapemark_names
[e
]
1363 if name
== null then name
= "label"
1364 name
= get_name
(name
)
1365 frame
.escapemark_names
[e
] = name
1369 # Insert a C label for associated with an escapemark
1370 fun add_escape_label
(e
: nullable EscapeMark)
1372 if e
== null then return
1373 if e
.escapes
.is_empty
then return
1374 add
("BREAK_{escapemark_name(e)}: (void)0;")
1377 # Return a "const char*" variable associated to the classname of the dynamic type of an object
1378 # NOTE: we do not return a `RuntimeVariable` "NativeString" as the class may not exist in the module/program
1379 fun class_name_string
(value
: RuntimeVariable): String is abstract
1381 # Variables handling
1383 protected var variables
= new HashMap[Variable, RuntimeVariable]
1385 # Return the local runtime_variable associated to a Nit local variable
1386 fun variable
(variable
: Variable): RuntimeVariable
1388 if self.variables
.has_key
(variable
) then
1389 return self.variables
[variable
]
1391 var name
= self.get_name
("var_{variable.name}")
1392 var mtype
= variable
.declared_type
.as(not null)
1393 mtype
= self.anchor
(mtype
)
1394 var res
= new RuntimeVariable(name
, mtype
, mtype
)
1395 self.add_decl
("{mtype.ctype} {name} /* var {variable}: {mtype} */;")
1396 self.variables
[variable
] = res
1401 # Return a new uninitialized local runtime_variable
1402 fun new_var
(mtype
: MType): RuntimeVariable
1404 mtype
= self.anchor
(mtype
)
1405 var name
= self.get_name
("var")
1406 var res
= new RuntimeVariable(name
, mtype
, mtype
)
1407 self.add_decl
("{mtype.ctype} {name} /* : {mtype} */;")
1411 # The difference with `new_var` is the C static type of the local variable
1412 fun new_var_extern
(mtype
: MType): RuntimeVariable
1414 mtype
= self.anchor
(mtype
)
1415 var name
= self.get_name
("var")
1416 var res
= new RuntimeVariable(name
, mtype
, mtype
)
1417 self.add_decl
("{mtype.ctype_extern} {name} /* : {mtype} for extern */;")
1421 # Return a new uninitialized named runtime_variable
1422 fun new_named_var
(mtype
: MType, name
: String): RuntimeVariable
1424 mtype
= self.anchor
(mtype
)
1425 var res
= new RuntimeVariable(name
, mtype
, mtype
)
1426 self.add_decl
("{mtype.ctype} {name} /* : {mtype} */;")
1430 # Correctly assign a left and a right value
1431 # Boxing and unboxing is performed if required
1432 fun assign
(left
, right
: RuntimeVariable)
1434 right
= self.autobox
(right
, left
.mtype
)
1435 self.add
("{left} = {right};")
1438 # Generate instances
1440 # Generate a alloc-instance + init-attributes
1441 fun init_instance
(mtype
: MClassType): RuntimeVariable is abstract
1443 # Allocate and init attributes of an instance of a standard or extern class
1445 # Does not support universals and the pseudo-internal `NativeArray` class.
1446 fun init_instance_or_extern
(mtype
: MClassType): RuntimeVariable
1449 var ctype
= mtype
.ctype
1450 assert mtype
.mclass
.name
!= "NativeArray"
1451 if not mtype
.is_c_primitive
then
1452 recv
= init_instance
(mtype
)
1453 else if ctype
== "char*" then
1454 recv
= new_expr
("NULL/*special!*/", mtype
)
1456 recv
= new_expr
("({ctype})0/*special!*/", mtype
)
1461 # Set a GC finalizer on `recv`, only if `recv` isa Finalizable
1462 fun set_finalizer
(recv
: RuntimeVariable)
1464 var mtype
= recv
.mtype
1465 var finalizable_type
= compiler
.mainmodule
.finalizable_type
1466 if finalizable_type
!= null and not mtype
.need_anchor
and
1467 mtype
.is_subtype
(compiler
.mainmodule
, null, finalizable_type
) then
1468 add
"gc_register_finalizer({recv});"
1472 # The currently processed module
1474 # alias for `compiler.mainmodule`
1475 fun mmodule
: MModule do return compiler
.mainmodule
1477 # Generate an integer value
1478 fun int_instance
(value
: Int): RuntimeVariable
1480 var t
= mmodule
.int_type
1481 var res
= new RuntimeVariable("{value.to_s}l", t
, t
)
1485 # Generate a byte value
1486 fun byte_instance
(value
: Byte): RuntimeVariable
1488 var t
= mmodule
.byte_type
1489 var res
= new RuntimeVariable("((unsigned char){value.to_s})", t
, t
)
1493 # Generate a char value
1494 fun char_instance
(value
: Char): RuntimeVariable
1496 var t
= mmodule
.char_type
1497 var res
= new RuntimeVariable("'{value.to_s.escape_to_c}'", t
, t
)
1501 # Generate a float value
1503 # FIXME pass a Float, not a string
1504 fun float_instance
(value
: String): RuntimeVariable
1506 var t
= mmodule
.float_type
1507 var res
= new RuntimeVariable("{value}", t
, t
)
1511 # Generate an integer value
1512 fun bool_instance
(value
: Bool): RuntimeVariable
1514 var s
= if value
then "1" else "0"
1515 var res
= new RuntimeVariable(s
, bool_type
, bool_type
)
1519 # Generate the `null` value
1520 fun null_instance
: RuntimeVariable
1522 var t
= compiler
.mainmodule
.model
.null_type
1523 var res
= new RuntimeVariable("((val*)NULL)", t
, t
)
1527 # Generate a string value
1528 fun string_instance
(string
: String): RuntimeVariable
1530 var mtype
= mmodule
.string_type
1531 var name
= self.get_name
("varonce")
1532 self.add_decl
("static {mtype.ctype} {name};")
1533 var res
= self.new_var
(mtype
)
1534 self.add
("if (likely({name}!=NULL)) \{")
1535 self.add
("{res} = {name};")
1536 self.add
("\} else \{")
1537 var native_mtype
= mmodule
.native_string_type
1538 var nat
= self.new_var
(native_mtype
)
1539 self.add
("{nat} = \"{string.escape_to_c}\
";")
1540 var length
= self.int_instance
(string
.length
)
1541 self.add
("{res} = {self.send(self.get_property("to_s_with_length", native_mtype), [nat, length]).as(not null)};")
1542 self.add
("{name} = {res};")
1547 fun value_instance
(object
: Object): RuntimeVariable
1549 if object
isa Int then
1550 return int_instance
(object
)
1551 else if object
isa Bool then
1552 return bool_instance
(object
)
1553 else if object
isa String then
1554 return string_instance
(object
)
1560 # Generate an array value
1561 fun array_instance
(array
: Array[RuntimeVariable], elttype
: MType): RuntimeVariable is abstract
1563 # Get an instance of a array for a vararg
1564 fun vararg_instance
(mpropdef
: MPropDef, recv
: RuntimeVariable, varargs
: Array[RuntimeVariable], elttype
: MType): RuntimeVariable is abstract
1568 # Add a line in the main part of the generated C
1569 fun add
(s
: String) do self.writer
.lines
.add
(s
)
1572 # (used for local or global declaration)
1573 fun add_decl
(s
: String) do self.writer
.decl_lines
.add
(s
)
1575 # Request the presence of a global declaration
1576 fun require_declaration
(key
: String)
1578 var reqs
= self.writer
.file
.required_declarations
1579 if reqs
.has
(key
) then return
1581 var node
= current_node
1582 if node
!= null then compiler
.requirers_of_declarations
[key
] = node
1585 # Add a declaration in the local-header
1586 # The declaration is ensured to be present once
1587 fun declare_once
(s
: String)
1589 self.compiler
.provide_declaration
(s
, s
)
1590 self.require_declaration
(s
)
1593 # Look for a needed .h and .c file for a given module
1594 # This is used for the legacy FFI
1595 fun add_extern
(mmodule
: MModule)
1597 var file
= mmodule
.location
.file
.filename
1598 file
= file
.strip_extension
(".nit")
1599 var tryfile
= file
+ ".nit.h"
1600 if tryfile
.file_exists
then
1601 self.declare_once
("#include \"{tryfile.basename("")}\
"")
1602 self.compiler
.files_to_copy
.add
(tryfile
)
1604 tryfile
= file
+ "_nit.h"
1605 if tryfile
.file_exists
then
1606 self.declare_once
("#include \"{tryfile.basename("")}\
"")
1607 self.compiler
.files_to_copy
.add
(tryfile
)
1610 if self.compiler
.seen_extern
.has
(file
) then return
1611 self.compiler
.seen_extern
.add
(file
)
1612 tryfile
= file
+ ".nit.c"
1613 if not tryfile
.file_exists
then
1614 tryfile
= file
+ "_nit.c"
1615 if not tryfile
.file_exists
then return
1617 var f
= new ExternCFile(tryfile
.basename
(""), "")
1618 self.compiler
.extern_bodies
.add
(f
)
1619 self.compiler
.files_to_copy
.add
(tryfile
)
1622 # Return a new local runtime_variable initialized with the C expression `cexpr`.
1623 fun new_expr
(cexpr
: String, mtype
: MType): RuntimeVariable
1625 var res
= new_var
(mtype
)
1626 self.add
("{res} = {cexpr};")
1630 # Generate generic abort
1631 # used by aborts, asserts, casts, etc.
1632 fun add_abort
(message
: String)
1634 self.add
("PRINT_ERROR(\"Runtime error
: %s\
", \"{message.escape_to_c}\
");")
1640 if self.current_node
!= null and self.current_node
.location
.file
!= null and
1641 self.current_node
.location
.file
.mmodule
!= null then
1642 var f
= "FILE_{self.current_node.location.file.mmodule.c_name}"
1643 self.require_declaration
(f
)
1644 self.add
("PRINT_ERROR(\" (%s
:%d
)\\n\
", {f}, {current_node.location.line_start});")
1646 self.add
("PRINT_ERROR(\"\\n\
");")
1648 self.add
("fatal_exit(1);")
1651 # Add a dynamic cast
1652 fun add_cast
(value
: RuntimeVariable, mtype
: MType, tag
: String)
1654 var res
= self.type_test
(value
, mtype
, tag
)
1655 self.add
("if (unlikely(!{res})) \{")
1656 var cn
= self.class_name_string
(value
)
1657 self.add
("PRINT_ERROR(\"Runtime error
: Cast failed
. Expected `%s`, got
`%s`\
", \"{mtype.to_s.escape_to_c}\
", {cn});")
1662 # Generate a return with the value `s`
1663 fun ret
(s
: RuntimeVariable)
1665 self.assign
(self.frame
.returnvar
.as(not null), s
)
1666 self.add
("goto {self.frame.returnlabel.as(not null)};")
1669 # Compile a statement (if any)
1670 fun stmt
(nexpr
: nullable AExpr)
1672 if nexpr
== null then return
1673 if nexpr
.mtype
== null and not nexpr
.is_typed
then
1674 # Untyped expression.
1675 # Might mean dead code or invalid code
1677 add_abort
("FATAL: bad statement executed.")
1681 var narray
= nexpr
.comprehension
1682 if narray
!= null then
1683 var recv
= frame
.comprehension
.as(not null)
1684 var val
= expr
(nexpr
, narray
.element_mtype
)
1685 compile_callsite
(narray
.push_callsite
.as(not null), [recv
, val
])
1689 var old
= self.current_node
1690 self.current_node
= nexpr
1692 self.current_node
= old
1695 # Compile an expression an return its result
1696 # `mtype` is the expected return type, pass null if no specific type is expected.
1697 fun expr
(nexpr
: AExpr, mtype
: nullable MType): RuntimeVariable
1699 if nexpr
.mtype
== null then
1700 # Untyped expression.
1701 # Might mean dead code or invalid code.
1703 add_abort
("FATAL: bad expression executed.")
1704 # and return a placebo result to please the C compiler
1705 if mtype
== null then mtype
= compiler
.mainmodule
.object_type
1706 return new_var
(mtype
)
1708 var old
= self.current_node
1709 self.current_node
= nexpr
1710 var res
= nexpr
.expr
(self).as(not null)
1711 if mtype
!= null then
1712 mtype
= self.anchor
(mtype
)
1713 res
= self.autobox
(res
, mtype
)
1715 res
= autoadapt
(res
, nexpr
.mtype
.as(not null))
1716 var implicit_cast_to
= nexpr
.implicit_cast_to
1717 if implicit_cast_to
!= null and not self.compiler
.modelbuilder
.toolcontext
.opt_no_check_autocast
.value
then
1718 add_cast
(res
, implicit_cast_to
, "auto")
1719 res
= autoadapt
(res
, implicit_cast_to
)
1721 self.current_node
= old
1725 # Alias for `self.expr(nexpr, self.bool_type)`
1726 fun expr_bool
(nexpr
: AExpr): RuntimeVariable do return expr
(nexpr
, bool_type
)
1728 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1729 fun debug
(message
: String)
1731 var node
= self.current_node
1732 if node
== null then
1733 print
"?: {message}"
1737 self.add
("/* DEBUG: {message} */")
1741 # A C function associated to a Nit method
1742 # Because of customization, a given Nit method can be compiler more that once
1743 abstract class AbstractRuntimeFunction
1745 type COMPILER: AbstractCompiler
1746 type VISITOR: AbstractCompilerVisitor
1748 # The associated Nit method
1749 var mmethoddef
: MMethodDef
1751 # The mangled c name of the runtime_function
1752 # Subclasses should redefine `build_c_name` instead
1755 var res
= self.c_name_cache
1756 if res
!= null then return res
1757 res
= self.build_c_name
1758 self.c_name_cache
= res
1762 # Non cached version of `c_name`
1763 protected fun build_c_name
: String is abstract
1765 protected var c_name_cache
: nullable String = null is writable
1767 # Implements a call of the runtime_function
1768 # May inline the body or generate a C function call
1769 fun call
(v
: VISITOR, arguments
: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1771 # Generate the code for the `AbstractRuntimeFunction`
1772 # Warning: compile more than once compilation makes CC unhappy
1773 fun compile_to_c
(compiler
: COMPILER) is abstract
1776 # A runtime variable hold a runtime value in C.
1777 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1779 # 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.
1780 class RuntimeVariable
1781 # The name of the variable in the C code
1784 # The static type of the variable (as declard in C)
1787 # The current casted type of the variable (as known in Nit)
1788 var mcasttype
: MType is writable
1790 # If the variable exaclty a mcasttype?
1791 # false (usual value) means that the variable is a mcasttype or a subtype.
1792 var is_exact
: Bool = false is writable
1796 assert not mtype
.need_anchor
1797 assert not mcasttype
.need_anchor
1800 redef fun to_s
do return name
1805 if self.is_exact
then
1806 exact_str
= " exact"
1811 if self.mtype
== self.mcasttype
then
1812 type_str
= "{mtype}{exact_str}"
1814 type_str
= "{mtype}({mcasttype}{exact_str})"
1816 return "<{name}:{type_str}>"
1820 # The static context of a visited property in a `AbstractCompilerVisitor`
1823 type VISITOR: AbstractCompilerVisitor
1825 # The associated visitor
1826 var visitor
: VISITOR
1828 # The executed property.
1829 # A Method in case of a call, an attribute in case of a default initialization.
1830 var mpropdef
: MPropDef
1832 # The static type of the receiver
1833 var receiver
: MClassType
1835 # Arguments of the method (the first is the receiver)
1836 var arguments
: Array[RuntimeVariable]
1838 # The runtime_variable associated to the return (in a function)
1839 var returnvar
: nullable RuntimeVariable = null is writable
1841 # The label at the end of the property
1842 var returnlabel
: nullable String = null is writable
1844 # Labels associated to a each escapemarks.
1845 # Because of inlinings, escape-marks must be associated to their context (the frame)
1846 private var escapemark_names
= new HashMap[EscapeMark, String]
1848 # The array comprehension currently filled, if any
1849 private var comprehension
: nullable RuntimeVariable = null
1853 # Return the C type associated to a given Nit static type
1854 fun ctype
: String do return "val*"
1856 # C type outside of the compiler code and in boxes
1857 fun ctype_extern
: String do return "val*"
1859 # Short name of the `ctype` to use in unions
1860 fun ctypename
: String do return "val"
1862 # Is the associated C type a primitive one?
1864 # ENSURE `result == (ctype != "val*")`
1865 fun is_c_primitive
: Bool do return false
1868 redef class MClassType
1870 redef var ctype
is lazy
do
1871 if mclass
.name
== "Int" then
1873 else if mclass
.name
== "Bool" then
1875 else if mclass
.name
== "Char" then
1877 else if mclass
.name
== "Float" then
1879 else if mclass
.name
== "Byte" then
1880 return "unsigned char"
1881 else if mclass
.name
== "NativeString" then
1883 else if mclass
.name
== "NativeArray" then
1890 redef var is_c_primitive
is lazy
do return ctype
!= "val*"
1892 redef fun ctype_extern
: String
1894 if mclass
.kind
== extern_kind
then
1901 redef fun ctypename
: String
1903 if mclass
.name
== "Int" then
1905 else if mclass
.name
== "Bool" then
1907 else if mclass
.name
== "Char" then
1909 else if mclass
.name
== "Float" then
1911 else if mclass
.name
== "Byte" then
1913 else if mclass
.name
== "NativeString" then
1915 else if mclass
.name
== "NativeArray" then
1916 #return "{self.arguments.first.ctype}*"
1924 redef class MPropDef
1925 type VISITOR: AbstractCompilerVisitor
1928 redef class MMethodDef
1929 # Can the body be inlined?
1930 fun can_inline
(v
: VISITOR): Bool
1932 if is_abstract
then return true
1933 var modelbuilder
= v
.compiler
.modelbuilder
1934 var node
= modelbuilder
.mpropdef2node
(self)
1935 if node
isa APropdef then
1936 return node
.can_inline
1937 else if node
isa AClassdef then
1938 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1945 # Inline the body in another visitor
1946 fun compile_inside_to_c
(v
: VISITOR, arguments
: Array[RuntimeVariable]): nullable RuntimeVariable
1948 var modelbuilder
= v
.compiler
.modelbuilder
1949 var val
= constant_value
1950 var node
= modelbuilder
.mpropdef2node
(self)
1953 var cn
= v
.class_name_string
(arguments
.first
)
1954 v
.current_node
= node
1955 v
.add
("PRINT_ERROR(\"Runtime error
: Abstract method
`%s` called on
`%s`\
", \"{mproperty.name.escape_to_c}\
", {cn});")
1960 if node
isa APropdef then
1961 var oldnode
= v
.current_node
1962 v
.current_node
= node
1963 self.compile_parameter_check
(v
, arguments
)
1964 node
.compile_to_c
(v
, self, arguments
)
1965 v
.current_node
= oldnode
1966 else if node
isa AClassdef then
1967 var oldnode
= v
.current_node
1968 v
.current_node
= node
1969 self.compile_parameter_check
(v
, arguments
)
1970 node
.compile_to_c
(v
, self, arguments
)
1971 v
.current_node
= oldnode
1972 else if val
!= null then
1973 v
.ret
(v
.value_instance
(val
))
1980 # Generate type checks in the C code to check covariant parameters
1981 fun compile_parameter_check
(v
: VISITOR, arguments
: Array[RuntimeVariable])
1983 if v
.compiler
.modelbuilder
.toolcontext
.opt_no_check_covariance
.value
then return
1985 for i
in [0..msignature
.arity
[ do
1986 # skip test for vararg since the array is instantiated with the correct polymorphic type
1987 if msignature
.vararg_rank
== i
then continue
1989 # skip if the cast is not required
1990 var origmtype
= self.mproperty
.intro
.msignature
.mparameters
[i
].mtype
1991 if not origmtype
.need_anchor
then continue
1993 # get the parameter type
1994 var mtype
= self.msignature
.mparameters
[i
].mtype
1997 # note that v decides if and how to implements the cast
1998 v
.add
("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1999 v
.add_cast
(arguments
[i
+1], mtype
, "covariance")
2006 redef class APropdef
2007 fun compile_to_c
(v
: AbstractCompilerVisitor, mpropdef
: MMethodDef, arguments
: Array[RuntimeVariable])
2009 v
.add
("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at
{location.to_s}\\n\
");")
2010 debug
("Not yet implemented")
2013 fun can_inline
: Bool do return true
2016 redef class AMethPropdef
2017 redef fun compile_to_c
(v
, mpropdef
, arguments
)
2019 # Call the implicit super-init
2020 var auto_super_inits
= self.auto_super_inits
2021 if auto_super_inits
!= null then
2022 var args
= [arguments
.first
]
2023 for auto_super_init
in auto_super_inits
do
2024 assert auto_super_init
.mproperty
!= mpropdef
.mproperty
2026 for i
in [0..auto_super_init
.msignature
.arity
+1[ do
2027 args
.add
(arguments
[i
])
2029 assert auto_super_init
.mproperty
!= mpropdef
.mproperty
2030 v
.compile_callsite
(auto_super_init
, args
)
2033 if auto_super_call
then
2034 v
.supercall
(mpropdef
, arguments
.first
.mtype
.as(MClassType), arguments
)
2037 # Try special compilation
2038 if mpropdef
.is_intern
then
2039 if compile_intern_to_c
(v
, mpropdef
, arguments
) then return
2040 else if mpropdef
.is_extern
then
2041 if mpropdef
.mproperty
.is_init
then
2042 if compile_externinit_to_c
(v
, mpropdef
, arguments
) then return
2044 if compile_externmeth_to_c
(v
, mpropdef
, arguments
) then return
2048 # Compile block if any
2049 var n_block
= n_block
2050 if n_block
!= null then
2051 for i
in [0..mpropdef
.msignature
.arity
[ do
2052 var variable
= self.n_signature
.n_params
[i
].variable
.as(not null)
2053 v
.assign
(v
.variable
(variable
), arguments
[i
+1])
2060 var cn
= v
.class_name_string
(arguments
.first
)
2061 v
.add
("PRINT_ERROR(\"Runtime error
: uncompiled method
`%s` called on
`%s`. NOT YET IMPLEMENTED\
", \"{mpropdef.mproperty.name.escape_to_c}\
", {cn});")
2065 redef fun can_inline
2067 if self.auto_super_inits
!= null then return false
2068 var nblock
= self.n_block
2069 if nblock
== null then return true
2070 if (mpropdef
.mproperty
.name
== "==" or mpropdef
.mproperty
.name
== "!=") and mpropdef
.mclassdef
.mclass
.name
== "Object" then return true
2071 if nblock
isa ABlockExpr and nblock
.n_expr
.length
== 0 then return true
2075 fun compile_intern_to_c
(v
: AbstractCompilerVisitor, mpropdef
: MMethodDef, arguments
: Array[RuntimeVariable]): Bool
2077 var pname
= mpropdef
.mproperty
.name
2078 var cname
= mpropdef
.mclassdef
.mclass
.name
2079 var ret
= mpropdef
.msignature
.return_mtype
2081 ret
= v
.resolve_for
(ret
, arguments
.first
)
2083 if pname
!= "==" and pname
!= "!=" then
2084 v
.adapt_signature
(mpropdef
, arguments
)
2085 v
.unbox_signature_extern
(mpropdef
, arguments
)
2087 if cname
== "Int" then
2088 if pname
== "output" then
2089 v
.add
("printf(\"%ld\\n\
", {arguments.first});")
2091 else if pname
== "object_id" then
2092 v
.ret
(arguments
.first
)
2094 else if pname
== "+" then
2095 v
.ret
(v
.new_expr
("{arguments[0]} + {arguments[1]}", ret
.as(not null)))
2097 else if pname
== "-" then
2098 v
.ret
(v
.new_expr
("{arguments[0]} - {arguments[1]}", ret
.as(not null)))
2100 else if pname
== "unary -" then
2101 v
.ret
(v
.new_expr
("-{arguments[0]}", ret
.as(not null)))
2103 else if pname
== "unary +" then
2106 else if pname
== "*" then
2107 v
.ret
(v
.new_expr
("{arguments[0]} * {arguments[1]}", ret
.as(not null)))
2109 else if pname
== "/" then
2110 v
.ret
(v
.new_expr
("{arguments[0]} / {arguments[1]}", ret
.as(not null)))
2112 else if pname
== "%" then
2113 v
.ret
(v
.new_expr
("{arguments[0]} % {arguments[1]}", ret
.as(not null)))
2115 else if pname
== "lshift" then
2116 v
.ret
(v
.new_expr
("{arguments[0]} << {arguments[1]}", ret
.as(not null)))
2118 else if pname
== "rshift" then
2119 v
.ret
(v
.new_expr
("{arguments[0]} >> {arguments[1]}", ret
.as(not null)))
2121 else if pname
== "==" then
2122 v
.ret
(v
.equal_test
(arguments
[0], arguments
[1]))
2124 else if pname
== "!=" then
2125 var res
= v
.equal_test
(arguments
[0], arguments
[1])
2126 v
.ret
(v
.new_expr
("!{res}", ret
.as(not null)))
2128 else if pname
== "<" then
2129 v
.ret
(v
.new_expr
("{arguments[0]} < {arguments[1]}", ret
.as(not null)))
2131 else if pname
== ">" then
2132 v
.ret
(v
.new_expr
("{arguments[0]} > {arguments[1]}", ret
.as(not null)))
2134 else if pname
== "<=" then
2135 v
.ret
(v
.new_expr
("{arguments[0]} <= {arguments[1]}", ret
.as(not null)))
2137 else if pname
== ">=" then
2138 v
.ret
(v
.new_expr
("{arguments[0]} >= {arguments[1]}", ret
.as(not null)))
2140 else if pname
== "to_f" then
2141 v
.ret
(v
.new_expr
("(double){arguments[0]}", ret
.as(not null)))
2143 else if pname
== "to_b" then
2144 v
.ret
(v
.new_expr
("(unsigned char){arguments[0]}", ret
.as(not null)))
2146 else if pname
== "ascii" then
2147 v
.ret
(v
.new_expr
("(uint32_t){arguments[0]}", ret
.as(not null)))
2150 else if cname
== "Char" then
2151 if pname
== "output" then
2152 v
.add
("printf(\"%c\
", ((unsigned char){arguments.first}));")
2154 else if pname
== "object_id" then
2155 v
.ret
(v
.new_expr
("(long){arguments.first}", ret
.as(not null)))
2157 else if pname
== "successor" then
2158 v
.ret
(v
.new_expr
("{arguments[0]} + {arguments[1]}", ret
.as(not null)))
2160 else if pname
== "predecessor" then
2161 v
.ret
(v
.new_expr
("{arguments[0]} - {arguments[1]}", ret
.as(not null)))
2163 else if pname
== "==" then
2164 v
.ret
(v
.equal_test
(arguments
[0], arguments
[1]))
2166 else if pname
== "!=" then
2167 var res
= v
.equal_test
(arguments
[0], arguments
[1])
2168 v
.ret
(v
.new_expr
("!{res}", ret
.as(not null)))
2170 else if pname
== "<" then
2171 v
.ret
(v
.new_expr
("{arguments[0]} < {arguments[1]}", ret
.as(not null)))
2173 else if pname
== ">" then
2174 v
.ret
(v
.new_expr
("{arguments[0]} > {arguments[1]}", ret
.as(not null)))
2176 else if pname
== "<=" then
2177 v
.ret
(v
.new_expr
("{arguments[0]} <= {arguments[1]}", ret
.as(not null)))
2179 else if pname
== ">=" then
2180 v
.ret
(v
.new_expr
("{arguments[0]} >= {arguments[1]}", ret
.as(not null)))
2182 else if pname
== "to_i" then
2183 v
.ret
(v
.new_expr
("{arguments[0]}-'0'", ret
.as(not null)))
2185 else if pname
== "ascii" then
2186 v
.ret
(v
.new_expr
("(long){arguments[0]}", ret
.as(not null)))
2189 else if cname
== "Byte" then
2190 if pname
== "output" then
2191 v
.add
("printf(\"%x\\n\
", {arguments.first});")
2193 else if pname
== "object_id" then
2194 v
.ret
(v
.new_expr
("(long){arguments.first}", ret
.as(not null)))
2196 else if pname
== "+" then
2197 v
.ret
(v
.new_expr
("{arguments[0]} + {arguments[1]}", ret
.as(not null)))
2199 else if pname
== "-" then
2200 v
.ret
(v
.new_expr
("{arguments[0]} - {arguments[1]}", ret
.as(not null)))
2202 else if pname
== "unary -" then
2203 v
.ret
(v
.new_expr
("-{arguments[0]}", ret
.as(not null)))
2205 else if pname
== "unary +" then
2208 else if pname
== "*" then
2209 v
.ret
(v
.new_expr
("{arguments[0]} * {arguments[1]}", ret
.as(not null)))
2211 else if pname
== "/" then
2212 v
.ret
(v
.new_expr
("{arguments[0]} / {arguments[1]}", ret
.as(not null)))
2214 else if pname
== "%" then
2215 v
.ret
(v
.new_expr
("{arguments[0]} % {arguments[1]}", ret
.as(not null)))
2217 else if pname
== "lshift" then
2218 v
.ret
(v
.new_expr
("{arguments[0]} << {arguments[1]}", ret
.as(not null)))
2220 else if pname
== "rshift" then
2221 v
.ret
(v
.new_expr
("{arguments[0]} >> {arguments[1]}", ret
.as(not null)))
2223 else if pname
== "==" then
2224 v
.ret
(v
.equal_test
(arguments
[0], arguments
[1]))
2226 else if pname
== "!=" then
2227 var res
= v
.equal_test
(arguments
[0], arguments
[1])
2228 v
.ret
(v
.new_expr
("!{res}", ret
.as(not null)))
2230 else if pname
== "<" then
2231 v
.ret
(v
.new_expr
("{arguments[0]} < {arguments[1]}", ret
.as(not null)))
2233 else if pname
== ">" then
2234 v
.ret
(v
.new_expr
("{arguments[0]} > {arguments[1]}", ret
.as(not null)))
2236 else if pname
== "<=" then
2237 v
.ret
(v
.new_expr
("{arguments[0]} <= {arguments[1]}", ret
.as(not null)))
2239 else if pname
== ">=" then
2240 v
.ret
(v
.new_expr
("{arguments[0]} >= {arguments[1]}", ret
.as(not null)))
2242 else if pname
== "to_i" then
2243 v
.ret
(v
.new_expr
("(long){arguments[0]}", ret
.as(not null)))
2245 else if pname
== "to_f" then
2246 v
.ret
(v
.new_expr
("(double){arguments[0]}", ret
.as(not null)))
2248 else if pname
== "ascii" then
2249 v
.ret
(v
.new_expr
("{arguments[0]}", ret
.as(not null)))
2252 else if cname
== "Bool" then
2253 if pname
== "output" then
2254 v
.add
("printf({arguments.first}?\"true\\n\
":\"false\\n\
");")
2256 else if pname
== "object_id" then
2257 v
.ret
(v
.new_expr
("(long){arguments.first}", ret
.as(not null)))
2259 else if pname
== "==" then
2260 v
.ret
(v
.equal_test
(arguments
[0], arguments
[1]))
2262 else if pname
== "!=" then
2263 var res
= v
.equal_test
(arguments
[0], arguments
[1])
2264 v
.ret
(v
.new_expr
("!{res}", ret
.as(not null)))
2267 else if cname
== "Float" then
2268 if pname
== "output" then
2269 v
.add
("printf(\"%f\\n\
", {arguments.first});")
2271 else if pname
== "object_id" then
2272 v
.ret
(v
.new_expr
("(double){arguments.first}", ret
.as(not null)))
2274 else if pname
== "+" then
2275 v
.ret
(v
.new_expr
("{arguments[0]} + {arguments[1]}", ret
.as(not null)))
2277 else if pname
== "-" then
2278 v
.ret
(v
.new_expr
("{arguments[0]} - {arguments[1]}", ret
.as(not null)))
2280 else if pname
== "unary -" then
2281 v
.ret
(v
.new_expr
("-{arguments[0]}", ret
.as(not null)))
2283 else if pname
== "unary +" then
2286 else if pname
== "succ" then
2287 v
.ret
(v
.new_expr
("{arguments[0]}+1", ret
.as(not null)))
2289 else if pname
== "prec" then
2290 v
.ret
(v
.new_expr
("{arguments[0]}-1", ret
.as(not null)))
2292 else if pname
== "*" then
2293 v
.ret
(v
.new_expr
("{arguments[0]} * {arguments[1]}", ret
.as(not null)))
2295 else if pname
== "/" then
2296 v
.ret
(v
.new_expr
("{arguments[0]} / {arguments[1]}", ret
.as(not null)))
2298 else if pname
== "==" then
2299 v
.ret
(v
.equal_test
(arguments
[0], arguments
[1]))
2301 else if pname
== "!=" then
2302 var res
= v
.equal_test
(arguments
[0], arguments
[1])
2303 v
.ret
(v
.new_expr
("!{res}", ret
.as(not null)))
2305 else if pname
== "<" then
2306 v
.ret
(v
.new_expr
("{arguments[0]} < {arguments[1]}", ret
.as(not null)))
2308 else if pname
== ">" then
2309 v
.ret
(v
.new_expr
("{arguments[0]} > {arguments[1]}", ret
.as(not null)))
2311 else if pname
== "<=" then
2312 v
.ret
(v
.new_expr
("{arguments[0]} <= {arguments[1]}", ret
.as(not null)))
2314 else if pname
== ">=" then
2315 v
.ret
(v
.new_expr
("{arguments[0]} >= {arguments[1]}", ret
.as(not null)))
2317 else if pname
== "to_i" then
2318 v
.ret
(v
.new_expr
("(long){arguments[0]}", ret
.as(not null)))
2320 else if pname
== "to_b" then
2321 v
.ret
(v
.new_expr
("(unsigned char){arguments[0]}", ret
.as(not null)))
2324 else if cname
== "NativeString" then
2325 if pname
== "[]" then
2326 v
.ret
(v
.new_expr
("(uint32_t)(unsigned char){arguments[0]}[{arguments[1]}]", ret
.as(not null)))
2328 else if pname
== "[]=" then
2329 v
.add
("{arguments[0]}[{arguments[1]}]=(unsigned char){arguments[2]};")
2331 else if pname
== "copy_to" then
2332 v
.add
("memmove({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
2334 else if pname
== "atoi" then
2335 v
.ret
(v
.new_expr
("atoi({arguments[0]});", ret
.as(not null)))
2337 else if pname
== "fast_cstring" then
2338 v
.ret
(v
.new_expr
("{arguments[0]} + {arguments[1]}", ret
.as(not null)))
2340 else if pname
== "new" then
2341 v
.ret
(v
.new_expr
("(char*)nit_alloc({arguments[1]})", ret
.as(not null)))
2344 else if cname
== "NativeArray" then
2345 v
.native_array_def
(pname
, ret
, arguments
)
2348 if pname
== "exit" then
2349 v
.add
("exit({arguments[1]});")
2351 else if pname
== "sys" then
2352 v
.ret
(v
.new_expr
("glob_sys", ret
.as(not null)))
2354 else if pname
== "calloc_string" then
2355 v
.ret
(v
.new_expr
("(char*)nit_alloc({arguments[1]})", ret
.as(not null)))
2357 else if pname
== "calloc_array" then
2358 v
.calloc_array
(ret
.as(not null), arguments
)
2360 else if pname
== "object_id" then
2361 v
.ret
(v
.new_expr
("(long){arguments.first}", ret
.as(not null)))
2363 else if pname
== "is_same_type" then
2364 v
.ret
(v
.is_same_type_test
(arguments
[0], arguments
[1]))
2366 else if pname
== "is_same_instance" then
2367 v
.ret
(v
.equal_test
(arguments
[0], arguments
[1]))
2369 else if pname
== "output_class_name" then
2370 var nat
= v
.class_name_string
(arguments
.first
)
2371 v
.add
("printf(\"%s\\n\
", {nat});")
2373 else if pname
== "native_class_name" then
2374 var nat
= v
.class_name_string
(arguments
.first
)
2375 v
.ret
(v
.new_expr
("(char*){nat}", ret
.as(not null)))
2377 else if pname
== "force_garbage_collection" then
2378 v
.add
("nit_gcollect();")
2380 else if pname
== "native_argc" then
2381 v
.ret
(v
.new_expr
("glob_argc", ret
.as(not null)))
2383 else if pname
== "native_argv" then
2384 v
.ret
(v
.new_expr
("glob_argv[{arguments[1]}]", ret
.as(not null)))
2390 # Compile an extern method
2391 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2392 fun compile_externmeth_to_c
(v
: AbstractCompilerVisitor, mpropdef
: MMethodDef, arguments
: Array[RuntimeVariable]): Bool
2395 var at
= self.get_single_annotation
("extern", v
.compiler
.modelbuilder
)
2396 if at
!= null and at
.n_args
.length
== 1 then
2397 externname
= at
.arg_as_string
(v
.compiler
.modelbuilder
)
2398 if externname
== null then return false
2402 v
.add_extern
(mpropdef
.mclassdef
.mmodule
)
2403 var res
: nullable RuntimeVariable = null
2404 var ret
= mpropdef
.msignature
.return_mtype
2406 ret
= v
.resolve_for
(ret
, arguments
.first
)
2407 res
= v
.new_var_extern
(ret
)
2409 v
.adapt_signature
(mpropdef
, arguments
)
2410 v
.unbox_signature_extern
(mpropdef
, arguments
)
2413 v
.add
("{externname}({arguments.join(", ")});")
2415 v
.add
("{res} = {externname}({arguments.join(", ")});")
2416 res
= v
.box_extern
(res
, ret
.as(not null))
2422 # Compile an extern factory
2423 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2424 fun compile_externinit_to_c
(v
: AbstractCompilerVisitor, mpropdef
: MMethodDef, arguments
: Array[RuntimeVariable]): Bool
2427 var at
= self.get_single_annotation
("extern", v
.compiler
.modelbuilder
)
2429 externname
= at
.arg_as_string
(v
.compiler
.modelbuilder
)
2430 if externname
== null then return false
2434 v
.add_extern
(mpropdef
.mclassdef
.mmodule
)
2435 v
.adapt_signature
(mpropdef
, arguments
)
2436 v
.unbox_signature_extern
(mpropdef
, arguments
)
2437 var ret
= arguments
.first
.mtype
2438 var res
= v
.new_var_extern
(ret
)
2442 v
.add
("{res} = {externname}({arguments.join(", ")});")
2443 res
= v
.box_extern
(res
, ret
)
2449 redef class AAttrPropdef
2450 redef fun can_inline
: Bool do return not is_lazy
2452 redef fun compile_to_c
(v
, mpropdef
, arguments
)
2454 if mpropdef
== mreadpropdef
then
2455 assert arguments
.length
== 1
2456 var recv
= arguments
.first
2460 var ret
= self.mtype
2461 var useiset
= not ret
.is_c_primitive
and not ret
isa MNullableType
2462 var guard
= self.mlazypropdef
.mproperty
2464 set
= v
.isset_attribute
(self.mpropdef
.mproperty
, recv
)
2466 set
= v
.read_attribute
(guard
, recv
)
2468 v
.add
("if(likely({set})) \{")
2469 res
= v
.read_attribute
(self.mpropdef
.mproperty
, recv
)
2472 var value
= evaluate_expr
(v
, recv
)
2474 v
.assign
(res
, value
)
2476 var true_v
= v
.bool_instance
(true)
2477 v
.write_attribute
(guard
, arguments
.first
, true_v
)
2481 res
= v
.read_attribute
(self.mpropdef
.mproperty
, arguments
.first
)
2483 v
.assign
(v
.frame
.returnvar
.as(not null), res
)
2484 else if mpropdef
== mwritepropdef
then
2485 assert arguments
.length
== 2
2486 v
.write_attribute
(self.mpropdef
.mproperty
, arguments
.first
, arguments
[1])
2488 var ret
= self.mtype
2489 var useiset
= not ret
.is_c_primitive
and not ret
isa MNullableType
2491 v
.write_attribute
(self.mlazypropdef
.mproperty
, arguments
.first
, v
.bool_instance
(true))
2499 fun init_expr
(v
: AbstractCompilerVisitor, recv
: RuntimeVariable)
2501 if has_value
and not is_lazy
and not n_expr
isa ANullExpr then evaluate_expr
(v
, recv
)
2504 # Evaluate, store and return the default value of the attribute
2505 private fun evaluate_expr
(v
: AbstractCompilerVisitor, recv
: RuntimeVariable): RuntimeVariable
2507 var oldnode
= v
.current_node
2508 v
.current_node
= self
2509 var old_frame
= v
.frame
2510 var frame
= new StaticFrame(v
, self.mreadpropdef
.as(not null), recv
.mcasttype
.undecorate
.as(MClassType), [recv
])
2514 var mtype
= self.mtype
2515 assert mtype
!= null
2517 var nexpr
= self.n_expr
2518 var nblock
= self.n_block
2519 if nexpr
!= null then
2520 value
= v
.expr
(nexpr
, mtype
)
2521 else if nblock
!= null then
2522 value
= v
.new_var
(mtype
)
2523 frame
.returnvar
= value
2524 frame
.returnlabel
= v
.get_name
("RET_LABEL")
2527 v
.add
("{frame.returnlabel.as(not null)}:(void)0;")
2533 v
.write_attribute
(self.mpropdef
.mproperty
, recv
, value
)
2536 v
.current_node
= oldnode
2541 fun check_expr
(v
: AbstractCompilerVisitor, recv
: RuntimeVariable)
2543 var nexpr
= self.n_expr
2544 if nexpr
!= null then return
2546 var oldnode
= v
.current_node
2547 v
.current_node
= self
2548 var old_frame
= v
.frame
2549 var frame
= new StaticFrame(v
, self.mpropdef
.as(not null), recv
.mtype
.as(MClassType), [recv
])
2551 # Force read to check the initialization
2552 v
.read_attribute
(self.mpropdef
.mproperty
, recv
)
2554 v
.current_node
= oldnode
2558 redef class AClassdef
2559 private fun compile_to_c
(v
: AbstractCompilerVisitor, mpropdef
: MMethodDef, arguments
: Array[RuntimeVariable])
2561 if mpropdef
== self.mfree_init
then
2562 assert mpropdef
.mproperty
.is_root_init
2563 assert arguments
.length
== 1
2564 if not mpropdef
.is_intro
then
2565 v
.supercall
(mpropdef
, arguments
.first
.mtype
.as(MClassType), arguments
)
2575 # Try to compile self as an expression
2576 # Do not call this method directly, use `v.expr` instead
2577 private fun expr
(v
: AbstractCompilerVisitor): nullable RuntimeVariable
2579 v
.add
("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\
");")
2580 var mtype
= self.mtype
2581 if mtype
== null then
2584 var res
= v
.new_var
(mtype
)
2585 v
.add
("/* {res} = NOT YET {class_name} */")
2590 # Try to compile self as a statement
2591 # Do not call this method directly, use `v.stmt` instead
2592 private fun stmt
(v
: AbstractCompilerVisitor)
2598 redef class ABlockExpr
2601 for e
in self.n_expr
do v
.stmt
(e
)
2605 var last
= self.n_expr
.last
2606 for e
in self.n_expr
do
2607 if e
== last
then break
2610 return v
.expr
(last
, null)
2614 redef class AVardeclExpr
2617 var variable
= self.variable
.as(not null)
2618 var ne
= self.n_expr
2620 var i
= v
.expr
(ne
, variable
.declared_type
)
2621 v
.assign
(v
.variable
(variable
), i
)
2626 redef class AVarExpr
2629 var res
= v
.variable
(self.variable
.as(not null))
2630 var mtype
= self.mtype
.as(not null)
2631 return v
.autoadapt
(res
, mtype
)
2635 redef class AVarAssignExpr
2638 var variable
= self.variable
.as(not null)
2639 var i
= v
.expr
(self.n_value
, variable
.declared_type
)
2640 v
.assign
(v
.variable
(variable
), i
)
2645 redef class AVarReassignExpr
2648 var variable
= self.variable
.as(not null)
2649 var vari
= v
.variable
(variable
)
2650 var value
= v
.expr
(self.n_value
, variable
.declared_type
)
2651 var res
= v
.compile_callsite
(self.reassign_callsite
.as(not null), [vari
, value
])
2653 v
.assign
(v
.variable
(variable
), res
)
2657 redef class ASelfExpr
2658 redef fun expr
(v
) do return v
.frame
.arguments
.first
2661 redef class AImplicitSelfExpr
2662 redef fun expr
(v
) do
2663 if not is_sys
then return super
2664 return v
.new_expr
("glob_sys", mtype
.as(not null))
2668 redef class AEscapeExpr
2669 redef fun stmt
(v
) do v
.add
("goto BREAK_{v.escapemark_name(self.escapemark)};")
2672 redef class AReturnExpr
2675 var nexpr
= self.n_expr
2676 if nexpr
!= null then
2677 var returnvar
= v
.frame
.returnvar
.as(not null)
2678 var i
= v
.expr
(nexpr
, returnvar
.mtype
)
2679 v
.assign
(returnvar
, i
)
2681 v
.add
("goto {v.frame.returnlabel.as(not null)};")
2685 redef class AAbortExpr
2686 redef fun stmt
(v
) do v
.add_abort
("Aborted")
2692 var cond
= v
.expr_bool
(self.n_expr
)
2693 v
.add
("if ({cond})\{")
2702 var res
= v
.new_var
(self.mtype
.as(not null))
2703 var cond
= v
.expr_bool
(self.n_expr
)
2704 v
.add
("if ({cond})\{")
2705 v
.assign
(res
, v
.expr
(self.n_then
.as(not null), null))
2707 v
.assign
(res
, v
.expr
(self.n_else
.as(not null), null))
2713 redef class AIfexprExpr
2716 var res
= v
.new_var
(self.mtype
.as(not null))
2717 var cond
= v
.expr_bool
(self.n_expr
)
2718 v
.add
("if ({cond})\{")
2719 v
.assign
(res
, v
.expr
(self.n_then
, null))
2721 v
.assign
(res
, v
.expr
(self.n_else
, null))
2730 v
.stmt
(self.n_block
)
2731 v
.add_escape_label
(break_mark
)
2735 redef class AWhileExpr
2739 var cond
= v
.expr_bool
(self.n_expr
)
2740 v
.add
("if (!{cond}) break;")
2741 v
.stmt
(self.n_block
)
2742 v
.add_escape_label
(continue_mark
)
2744 v
.add_escape_label
(break_mark
)
2748 redef class ALoopExpr
2752 v
.stmt
(self.n_block
)
2753 v
.add_escape_label
(continue_mark
)
2755 v
.add_escape_label
(break_mark
)
2759 redef class AForExpr
2762 var cl
= v
.expr
(self.n_expr
, null)
2763 var it_meth
= self.method_iterator
2764 assert it_meth
!= null
2765 var it
= v
.compile_callsite
(it_meth
, [cl
])
2768 var isok_meth
= self.method_is_ok
2769 assert isok_meth
!= null
2770 var ok
= v
.compile_callsite
(isok_meth
, [it
])
2772 v
.add
("if(!{ok}) break;")
2773 if self.variables
.length
== 1 then
2774 var item_meth
= self.method_item
2775 assert item_meth
!= null
2776 var i
= v
.compile_callsite
(item_meth
, [it
])
2778 v
.assign
(v
.variable
(variables
.first
), i
)
2779 else if self.variables
.length
== 2 then
2780 var key_meth
= self.method_key
2781 assert key_meth
!= null
2782 var i
= v
.compile_callsite
(key_meth
, [it
])
2784 v
.assign
(v
.variable
(variables
[0]), i
)
2785 var item_meth
= self.method_item
2786 assert item_meth
!= null
2787 i
= v
.compile_callsite
(item_meth
, [it
])
2789 v
.assign
(v
.variable
(variables
[1]), i
)
2793 v
.stmt
(self.n_block
)
2794 v
.add_escape_label
(continue_mark
)
2795 var next_meth
= self.method_next
2796 assert next_meth
!= null
2797 v
.compile_callsite
(next_meth
, [it
])
2799 v
.add_escape_label
(break_mark
)
2801 var method_finish
= self.method_finish
2802 if method_finish
!= null then
2803 # TODO: Find a way to call this also in long escape (e.g. return)
2804 v
.compile_callsite
(method_finish
, [it
])
2809 redef class AAssertExpr
2812 if v
.compiler
.modelbuilder
.toolcontext
.opt_no_check_assert
.value
then return
2814 var cond
= v
.expr_bool
(self.n_expr
)
2815 v
.add
("if (unlikely(!{cond})) \{")
2819 v
.add_abort
("Assert '{nid.text}' failed")
2821 v
.add_abort
("Assert failed")
2830 var res
= v
.new_var
(self.mtype
.as(not null))
2831 var i1
= v
.expr_bool
(self.n_expr
)
2832 v
.add
("if ({i1}) \{")
2835 var i2
= v
.expr_bool
(self.n_expr2
)
2836 v
.add
("{res} = {i2};")
2842 redef class AImpliesExpr
2845 var res
= v
.new_var
(self.mtype
.as(not null))
2846 var i1
= v
.expr_bool
(self.n_expr
)
2847 v
.add
("if (!{i1}) \{")
2850 var i2
= v
.expr_bool
(self.n_expr2
)
2851 v
.add
("{res} = {i2};")
2857 redef class AAndExpr
2860 var res
= v
.new_var
(self.mtype
.as(not null))
2861 var i1
= v
.expr_bool
(self.n_expr
)
2862 v
.add
("if (!{i1}) \{")
2865 var i2
= v
.expr_bool
(self.n_expr2
)
2866 v
.add
("{res} = {i2};")
2872 redef class ANotExpr
2875 var cond
= v
.expr_bool
(self.n_expr
)
2876 return v
.new_expr
("!{cond}", self.mtype
.as(not null))
2880 redef class AOrElseExpr
2883 var res
= v
.new_var
(self.mtype
.as(not null))
2884 var i1
= v
.expr
(self.n_expr
, null)
2885 v
.add
("if ({i1}!=NULL) \{")
2888 var i2
= v
.expr
(self.n_expr2
, null)
2895 redef class AIntExpr
2896 redef fun expr
(v
) do return v
.int_instance
(self.value
.as(not null))
2899 redef class AByteExpr
2900 redef fun expr
(v
) do return v
.byte_instance
(self.value
.as(not null))
2903 redef class AFloatExpr
2904 redef fun expr
(v
) do return v
.float_instance
("{self.n_float.text}") # FIXME use value, not n_float
2907 redef class ACharExpr
2908 redef fun expr
(v
) do return v
.char_instance
(self.value
.as(not null))
2911 redef class AArrayExpr
2914 var mtype
= self.element_mtype
.as(not null)
2915 var array
= new Array[RuntimeVariable]
2916 var res
= v
.array_instance
(array
, mtype
)
2918 var old_comprehension
= v
.frame
.comprehension
2919 v
.frame
.comprehension
= res
2920 for nexpr
in self.n_exprs
do
2923 v
.frame
.comprehension
= old_comprehension
2929 redef class AStringFormExpr
2930 redef fun expr
(v
) do return v
.string_instance
(self.value
.as(not null))
2933 redef class ASuperstringExpr
2936 var type_string
= mtype
.as(not null)
2938 # Collect elements of the superstring
2939 var array
= new Array[AExpr]
2940 for ne
in self.n_exprs
do
2941 # Drop literal empty string.
2942 # They appears in things like "{a}" that is ["", a, ""]
2943 if ne
isa AStringFormExpr and ne
.value
== "" then continue # skip empty sub-strings
2947 # Store the allocated native array in a static variable
2949 var varonce
= v
.get_name
("varonce")
2950 v
.add
("if (unlikely({varonce}==NULL)) \{")
2952 # The native array that will contains the elements to_s-ized.
2953 # For fast concatenation.
2954 var a
= v
.native_array_instance
(type_string
, v
.int_instance
(array
.length
))
2956 v
.add_decl
("static {a.mtype.ctype} {varonce};")
2958 # Pre-fill the array with the literal string parts.
2959 # So they do not need to be filled again when reused
2960 for i
in [0..array
.length
[ do
2962 if not ne
isa AStringFormExpr then continue
2963 var e
= v
.expr
(ne
, null)
2964 v
.native_array_set
(a
, i
, e
)
2968 # Take the native-array from the store.
2969 # The point is to prevent that some recursive execution use (and corrupt) the same native array
2970 # WARNING: not thread safe! (FIXME?)
2971 v
.add
("{a} = {varonce};")
2972 v
.add
("{varonce} = NULL;")
2975 # Stringify the elements and put them in the native array
2976 var to_s_method
= v
.get_property
("to_s", v
.object_type
)
2977 for i
in [0..array
.length
[ do
2979 if ne
isa AStringFormExpr then continue
2980 var e
= v
.expr
(ne
, null)
2981 # Skip the `to_s` if the element is already a String
2982 if not e
.mcasttype
.is_subtype
(v
.compiler
.mainmodule
, null, type_string
) then
2983 e
= v
.send
(to_s_method
, [e
]).as(not null)
2985 v
.native_array_set
(a
, i
, e
)
2988 # Fast join the native string to get the result
2989 var res
= v
.send
(v
.get_property
("native_to_s", a
.mtype
), [a
])
2991 # We finish to work with the native array,
2992 # so store it so that it can be reused
2993 v
.add
("{varonce} = {a};")
2998 redef class ACrangeExpr
3001 var i1
= v
.expr
(self.n_expr
, null)
3002 var i2
= v
.expr
(self.n_expr2
, null)
3003 var mtype
= self.mtype
.as(MClassType)
3004 var res
= v
.init_instance
(mtype
)
3005 v
.compile_callsite
(init_callsite
.as(not null), [res
, i1
, i2
])
3010 redef class AOrangeExpr
3013 var i1
= v
.expr
(self.n_expr
, null)
3014 var i2
= v
.expr
(self.n_expr2
, null)
3015 var mtype
= self.mtype
.as(MClassType)
3016 var res
= v
.init_instance
(mtype
)
3017 v
.compile_callsite
(init_callsite
.as(not null), [res
, i1
, i2
])
3022 redef class ATrueExpr
3023 redef fun expr
(v
) do return v
.bool_instance
(true)
3026 redef class AFalseExpr
3027 redef fun expr
(v
) do return v
.bool_instance
(false)
3030 redef class ANullExpr
3031 redef fun expr
(v
) do return v
.null_instance
3034 redef class AIsaExpr
3037 var i
= v
.expr
(self.n_expr
, null)
3038 return v
.type_test
(i
, self.cast_type
.as(not null), "isa")
3042 redef class AAsCastExpr
3045 var i
= v
.expr
(self.n_expr
, null)
3046 if v
.compiler
.modelbuilder
.toolcontext
.opt_no_check_assert
.value
then return i
3048 v
.add_cast
(i
, self.mtype
.as(not null), "as")
3053 redef class AAsNotnullExpr
3056 var i
= v
.expr
(self.n_expr
, null)
3057 if v
.compiler
.modelbuilder
.toolcontext
.opt_no_check_assert
.value
then return i
3059 if i
.mtype
.is_c_primitive
then return i
3061 v
.add
("if (unlikely({i} == NULL)) \{")
3062 v
.add_abort
("Cast failed")
3068 redef class AParExpr
3069 redef fun expr
(v
) do return v
.expr
(self.n_expr
, null)
3072 redef class AOnceExpr
3075 var mtype
= self.mtype
.as(not null)
3076 var name
= v
.get_name
("varonce")
3077 var guard
= v
.get_name
(name
+ "_guard")
3078 v
.add_decl
("static {mtype.ctype} {name};")
3079 v
.add_decl
("static int {guard};")
3080 var res
= v
.new_var
(mtype
)
3081 v
.add
("if (likely({guard})) \{")
3082 v
.add
("{res} = {name};")
3084 var i
= v
.expr
(self.n_expr
, mtype
)
3085 v
.add
("{res} = {i};")
3086 v
.add
("{name} = {res};")
3087 v
.add
("{guard} = 1;")
3093 redef class ASendExpr
3096 var recv
= v
.expr
(self.n_expr
, null)
3097 var callsite
= self.callsite
.as(not null)
3098 var args
= v
.varargize
(callsite
.mpropdef
, callsite
.signaturemap
, recv
, self.raw_arguments
)
3099 return v
.compile_callsite
(callsite
, args
)
3103 redef class ASendReassignFormExpr
3106 var recv
= v
.expr
(self.n_expr
, null)
3107 var callsite
= self.callsite
.as(not null)
3108 var args
= v
.varargize
(callsite
.mpropdef
, callsite
.signaturemap
, recv
, self.raw_arguments
)
3110 var value
= v
.expr
(self.n_value
, null)
3112 var left
= v
.compile_callsite
(callsite
, args
)
3115 var res
= v
.compile_callsite
(self.reassign_callsite
.as(not null), [left
, value
])
3119 v
.compile_callsite
(self.write_callsite
.as(not null), args
)
3123 redef class ASuperExpr
3126 var recv
= v
.frame
.arguments
.first
3128 var callsite
= self.callsite
3129 if callsite
!= null then
3132 if self.n_args
.n_exprs
.is_empty
then
3133 # Add automatic arguments for the super init call
3135 for i
in [0..callsite
.msignature
.arity
[ do
3136 args
.add
(v
.frame
.arguments
[i
+1])
3139 args
= v
.varargize
(callsite
.mpropdef
, callsite
.signaturemap
, recv
, self.n_args
.n_exprs
)
3143 var res
= v
.compile_callsite
(callsite
, args
)
3147 var mpropdef
= self.mpropdef
.as(not null)
3150 if self.n_args
.n_exprs
.is_empty
then
3151 args
= v
.frame
.arguments
3153 args
= v
.varargize
(mpropdef
, signaturemap
, recv
, self.n_args
.n_exprs
)
3156 # Standard call-next-method
3157 return v
.supercall
(mpropdef
, recv
.mtype
.as(MClassType), args
)
3161 redef class ANewExpr
3164 var mtype
= self.recvtype
3165 assert mtype
!= null
3167 if mtype
.mclass
.name
== "NativeArray" then
3168 assert self.n_args
.n_exprs
.length
== 1
3169 var l
= v
.expr
(self.n_args
.n_exprs
.first
, null)
3170 assert mtype
isa MGenericType
3171 var elttype
= mtype
.arguments
.first
3172 return v
.native_array_instance
(elttype
, l
)
3175 var recv
= v
.init_instance_or_extern
(mtype
)
3177 var callsite
= self.callsite
3178 if callsite
== null then return recv
3180 var args
= v
.varargize
(callsite
.mpropdef
, callsite
.signaturemap
, recv
, self.n_args
.n_exprs
)
3181 var res2
= v
.compile_callsite
(callsite
, args
)
3182 if res2
!= null then
3183 #self.debug("got {res2} from {mproperty}. drop {recv}")
3190 redef class AAttrExpr
3193 var recv
= v
.expr
(self.n_expr
, null)
3194 var mproperty
= self.mproperty
.as(not null)
3195 return v
.read_attribute
(mproperty
, recv
)
3199 redef class AAttrAssignExpr
3202 var recv
= v
.expr
(self.n_expr
, null)
3203 var i
= v
.expr
(self.n_value
, null)
3204 var mproperty
= self.mproperty
.as(not null)
3205 v
.write_attribute
(mproperty
, recv
, i
)
3210 redef class AAttrReassignExpr
3213 var recv
= v
.expr
(self.n_expr
, null)
3214 var value
= v
.expr
(self.n_value
, null)
3215 var mproperty
= self.mproperty
.as(not null)
3216 var attr
= v
.read_attribute
(mproperty
, recv
)
3217 var res
= v
.compile_callsite
(self.reassign_callsite
.as(not null), [attr
, value
])
3219 v
.write_attribute
(mproperty
, recv
, res
)
3223 redef class AIssetAttrExpr
3226 var recv
= v
.expr
(self.n_expr
, null)
3227 var mproperty
= self.mproperty
.as(not null)
3228 return v
.isset_attribute
(mproperty
, recv
)
3232 redef class AVarargExpr
3235 return v
.expr
(self.n_expr
, null)
3239 redef class ANamedargExpr
3242 return v
.expr
(self.n_expr
, null)
3246 redef class ADebugTypeExpr
3255 redef class Array[E
]
3256 # Return a new `Array` with the elements only contened in self and not in `o`
3257 fun -(o
: Array[E
]): Array[E
] do
3258 var res
= new Array[E
]
3259 for e
in self do if not o
.has
(e
) then res
.add
(e
)
3265 # All `MProperty` associated to all `MClassDef` of `mclass`
3266 fun properties
(mclass
: MClass): Set[MProperty] do
3267 if not self.properties_cache
.has_key
(mclass
) then
3268 var properties
= new HashSet[MProperty]
3269 var parents
= new Array[MClass]
3270 if self.flatten_mclass_hierarchy
.has
(mclass
) then
3271 parents
.add_all
(mclass
.in_hierarchy
(self).direct_greaters
)
3273 for parent
in parents
do
3274 properties
.add_all
(self.properties
(parent
))
3276 for mclassdef
in mclass
.mclassdefs
do
3277 if not self.in_importation
<= mclassdef
.mmodule
then continue
3278 for mprop
in mclassdef
.intro_mproperties
do
3279 properties
.add
(mprop
)
3282 self.properties_cache
[mclass
] = properties
3284 return properties_cache
[mclass
]
3286 private var properties_cache
: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
3288 # Write FFI and nitni results to file
3289 fun finalize_ffi
(c
: AbstractCompiler) do end
3291 # Give requided addinional system libraries (as given to LD_LIBS)
3292 # Note: can return null instead of an empty set
3293 fun collect_linker_libs
: nullable Array[String] do return null
3296 # Create a tool context to handle options and paths
3297 var toolcontext
= new ToolContext
3299 toolcontext
.tooldescription
= "Usage: nitc [OPTION]... file.nit...\nCompiles Nit programs."
3301 # We do not add other options, so process them now!
3302 toolcontext
.process_options
(args
)
3304 # We need a model to collect stufs
3305 var model
= new Model
3306 # An a model builder to parse files
3307 var modelbuilder
= new ModelBuilder(model
, toolcontext
)
3309 var arguments
= toolcontext
.option_context
.rest
3310 if arguments
.length
> 1 and toolcontext
.opt_output
.value
!= null then
3311 print
"Option Error: --output needs a single source file. Do you prefer --dir?"
3315 # Here we load an process all modules passed on the command line
3316 var mmodules
= modelbuilder
.parse
(arguments
)
3318 if mmodules
.is_empty
then return
3319 modelbuilder
.run_phases
3321 for mmodule
in mmodules
do
3322 toolcontext
.info
("*** PROCESS {mmodule} ***", 1)
3324 toolcontext
.run_global_phases
(ms
)