compiler: fix the signature of `add_extern`
[nit.git] / src / compiler / abstract_compiler.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2012 Jean Privat <jean@pryen.org>
4 #
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
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
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.
16
17 # Abstract compiler
18 module abstract_compiler
19
20 import literal
21 import semantize
22 import platform
23 import c_tools
24 private import annotation
25 import mixin
26
27 # Add compiling options
28 redef class ToolContext
29 # --output
30 var opt_output = new OptionString("Output file", "-o", "--output")
31 # --dir
32 var opt_dir = new OptionString("Output directory", "--dir")
33 # --no-cc
34 var opt_no_cc = new OptionBool("Do not invoke C compiler", "--no-cc")
35 # --no-main
36 var opt_no_main = new OptionBool("Do not generate main entry point", "--no-main")
37 # --make-flags
38 var opt_make_flags = new OptionString("Additional options to make", "--make-flags")
39 # --max-c-lines
40 var opt_max_c_lines = new OptionInt("Maximum number of lines in generated C files. Use 0 for unlimited", 10000, "--max-c-lines")
41 # --group-c-files
42 var opt_group_c_files = new OptionBool("Group all generated code in the same series of files", "--group-c-files")
43 # --compile-dir
44 var opt_compile_dir = new OptionString("Directory used to generate temporary files", "--compile-dir")
45 # --hardening
46 var opt_hardening = new OptionBool("Generate contracts in the C code against bugs in the compiler", "--hardening")
47 # --no-check-covariance
48 var opt_no_check_covariance = new OptionBool("Disable type tests of covariant parameters (dangerous)", "--no-check-covariance")
49 # --no-check-attr-isset
50 var opt_no_check_attr_isset = new OptionBool("Disable isset tests before each attribute access (dangerous)", "--no-check-attr-isset")
51 # --no-check-assert
52 var opt_no_check_assert = new OptionBool("Disable the evaluation of explicit 'assert' and 'as' (dangerous)", "--no-check-assert")
53 # --no-check-autocast
54 var opt_no_check_autocast = new OptionBool("Disable implicit casts on unsafe expression usage (dangerous)", "--no-check-autocast")
55 # --no-check-null
56 var opt_no_check_null = new OptionBool("Disable tests of null receiver (dangerous)", "--no-check-null")
57 # --no-check-all
58 var opt_no_check_all = new OptionBool("Disable all tests (dangerous)", "--no-check-all")
59 # --typing-test-metrics
60 var opt_typing_test_metrics = new OptionBool("Enable static and dynamic count of all type tests", "--typing-test-metrics")
61 # --invocation-metrics
62 var opt_invocation_metrics = new OptionBool("Enable static and dynamic count of all method invocations", "--invocation-metrics")
63 # --isset-checks-metrics
64 var opt_isset_checks_metrics = new OptionBool("Enable static and dynamic count of isset checks before attributes access", "--isset-checks-metrics")
65 # --stacktrace
66 var opt_stacktrace = new OptionString("Control the generation of stack traces", "--stacktrace")
67 # --no-gcc-directives
68 var opt_no_gcc_directive = new OptionArray("Disable a advanced gcc directives for optimization", "--no-gcc-directive")
69 # --release
70 var opt_release = new OptionBool("Compile in release mode and finalize application", "--release")
71
72 redef init
73 do
74 super
75 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)
76 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)
77 self.option_context.add_option(self.opt_typing_test_metrics, self.opt_invocation_metrics, self.opt_isset_checks_metrics)
78 self.option_context.add_option(self.opt_stacktrace)
79 self.option_context.add_option(self.opt_no_gcc_directive)
80 self.option_context.add_option(self.opt_release)
81 self.option_context.add_option(self.opt_max_c_lines, self.opt_group_c_files)
82
83 opt_no_main.hidden = true
84 end
85
86 redef fun process_options(args)
87 do
88 super
89
90 var st = opt_stacktrace.value
91 if st == "none" or st == "libunwind" or st == "nitstack" then
92 # Fine, do nothing
93 else if st == "auto" or st == null then
94 # Default is nitstack
95 opt_stacktrace.value = "nitstack"
96 else
97 print "Error: unknown value `{st}` for --stacktrace. Use `none`, `libunwind`, `nitstack` or `auto`."
98 exit(1)
99 end
100
101 if opt_output.value != null and opt_dir.value != null then
102 print "Error: cannot use both --dir and --output"
103 exit(1)
104 end
105
106 if opt_no_check_all.value then
107 opt_no_check_covariance.value = true
108 opt_no_check_attr_isset.value = true
109 opt_no_check_assert.value = true
110 opt_no_check_autocast.value = true
111 opt_no_check_null.value = true
112 end
113 end
114 end
115
116 redef class ModelBuilder
117 # The compilation directory
118 var compile_dir: String
119
120 # Simple indirection to `Toolchain::write_and_make`
121 protected fun write_and_make(compiler: AbstractCompiler)
122 do
123 var platform = compiler.mainmodule.target_platform
124 var toolchain
125 if platform == null then
126 toolchain = new MakefileToolchain(toolcontext)
127 else
128 toolchain = platform.toolchain(toolcontext)
129 end
130 compile_dir = toolchain.compile_dir
131 toolchain.write_and_make compiler
132 end
133 end
134
135 redef class Platform
136 fun toolchain(toolcontext: ToolContext): Toolchain is abstract
137 end
138
139 class Toolchain
140 var toolcontext: ToolContext
141
142 fun compile_dir: String
143 do
144 var compile_dir = toolcontext.opt_compile_dir.value
145 if compile_dir == null then compile_dir = ".nit_compile"
146 return compile_dir
147 end
148
149 fun write_and_make(compiler: AbstractCompiler) is abstract
150 end
151
152 class MakefileToolchain
153 super Toolchain
154
155 redef fun write_and_make(compiler)
156 do
157 var compile_dir = compile_dir
158
159 # Generate the .h and .c files
160 # A single C file regroups many compiled rumtime functions
161 # 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
162 var time0 = get_time
163 self.toolcontext.info("*** WRITING C ***", 1)
164
165 compile_dir.mkdir
166
167 var cfiles = new Array[String]
168 write_files(compiler, compile_dir, cfiles)
169
170 # Generate the Makefile
171
172 write_makefile(compiler, compile_dir, cfiles)
173
174 var time1 = get_time
175 self.toolcontext.info("*** END WRITING C: {time1-time0} ***", 2)
176
177 # Execute the Makefile
178
179 if self.toolcontext.opt_no_cc.value then return
180
181 time0 = time1
182 self.toolcontext.info("*** COMPILING C ***", 1)
183
184 compile_c_code(compiler, compile_dir)
185
186 time1 = get_time
187 self.toolcontext.info("*** END COMPILING C: {time1-time0} ***", 2)
188 end
189
190 fun write_files(compiler: AbstractCompiler, compile_dir: String, cfiles: Array[String])
191 do
192 var platform = compiler.mainmodule.target_platform
193 if self.toolcontext.opt_stacktrace.value == "nitstack" and (platform == null or platform.supports_libunwind) then compiler.build_c_to_nit_bindings
194 var cc_opt_with_libgc = "-DWITH_LIBGC"
195 if platform != null and not platform.supports_libgc then cc_opt_with_libgc = ""
196
197 # Add gc_choser.h to aditionnal bodies
198 var gc_chooser = new ExternCFile("gc_chooser.c", cc_opt_with_libgc)
199 if cc_opt_with_libgc != "" then gc_chooser.pkgconfigs.add "bdw-gc"
200 compiler.extern_bodies.add(gc_chooser)
201 var clib = toolcontext.nit_dir / "clib"
202 compiler.files_to_copy.add "{clib}/gc_chooser.c"
203 compiler.files_to_copy.add "{clib}/gc_chooser.h"
204
205 # FFI
206 for m in compiler.mainmodule.in_importation.greaters do
207 compiler.finalize_ffi_for_module(m)
208 end
209
210 # Copy original .[ch] files to compile_dir
211 for src in compiler.files_to_copy do
212 var basename = src.basename("")
213 var dst = "{compile_dir}/{basename}"
214 src.file_copy_to dst
215 end
216
217 var hfilename = compiler.header.file.name + ".h"
218 var hfilepath = "{compile_dir}/{hfilename}"
219 var h = new OFStream.open(hfilepath)
220 for l in compiler.header.decl_lines do
221 h.write l
222 h.write "\n"
223 end
224 for l in compiler.header.lines do
225 h.write l
226 h.write "\n"
227 end
228 h.close
229
230 var max_c_lines = toolcontext.opt_max_c_lines.value
231 for f in compiler.files do
232 var i = 0
233 var count = 0
234 var file: nullable OFStream = null
235 for vis in f.writers do
236 if vis == compiler.header then continue
237 var total_lines = vis.lines.length + vis.decl_lines.length
238 if total_lines == 0 then continue
239 count += total_lines
240 if file == null or (count > max_c_lines and max_c_lines > 0) then
241 i += 1
242 if file != null then file.close
243 var cfilename = "{f.name}.{i}.c"
244 var cfilepath = "{compile_dir}/{cfilename}"
245 self.toolcontext.info("new C source files to compile: {cfilepath}", 3)
246 cfiles.add(cfilename)
247 file = new OFStream.open(cfilepath)
248 file.write "#include \"{f.name}.0.h\"\n"
249 count = total_lines
250 end
251 for l in vis.decl_lines do
252 file.write l
253 file.write "\n"
254 end
255 for l in vis.lines do
256 file.write l
257 file.write "\n"
258 end
259 end
260 if file == null then continue
261 file.close
262
263 var cfilename = "{f.name}.0.h"
264 var cfilepath = "{compile_dir}/{cfilename}"
265 var hfile: nullable OFStream = null
266 hfile = new OFStream.open(cfilepath)
267 hfile.write "#include \"{hfilename}\"\n"
268 for key in f.required_declarations do
269 if not compiler.provided_declarations.has_key(key) then
270 var node = compiler.requirers_of_declarations.get_or_null(key)
271 if node != null then
272 node.debug "No provided declaration for {key}"
273 else
274 print "No provided declaration for {key}"
275 end
276 abort
277 end
278 hfile.write compiler.provided_declarations[key]
279 hfile.write "\n"
280 end
281 hfile.close
282 end
283
284 self.toolcontext.info("Total C source files to compile: {cfiles.length}", 2)
285 end
286
287 fun makefile_name(mainmodule: MModule): String do return "{mainmodule.c_name}.mk"
288
289 fun default_outname(mainmodule: MModule): String
290 do
291 # Search a non fictive module
292 var res = mainmodule.name
293 while mainmodule.is_fictive do
294 mainmodule = mainmodule.in_importation.direct_greaters.first
295 res = mainmodule.name
296 end
297 return res
298 end
299
300 # Combine options and platform informations to get the final path of the outfile
301 fun outfile(mainmodule: MModule): String
302 do
303 var res = self.toolcontext.opt_output.value
304 if res != null then return res
305 res = default_outname(mainmodule)
306 var dir = self.toolcontext.opt_dir.value
307 if dir != null then return dir.join_path(res)
308 return res
309 end
310
311 fun write_makefile(compiler: AbstractCompiler, compile_dir: String, cfiles: Array[String])
312 do
313 var mainmodule = compiler.mainmodule
314 var platform = compiler.mainmodule.target_platform
315
316 var outname = outfile(mainmodule)
317
318 var real_outpath = compile_dir.relpath(outname)
319 var outpath = real_outpath.escape_to_mk
320 if outpath != real_outpath then
321 # If the name is crazy and need escaping, we will do an indirection
322 # 1. generate the binary in the .nit_compile dir under an escaped name
323 # 2. copy the binary at the right place in the `all` goal.
324 outpath = mainmodule.c_name
325 end
326 var makename = makefile_name(mainmodule)
327 var makepath = "{compile_dir}/{makename}"
328 var makefile = new OFStream.open(makepath)
329
330 var linker_options = new HashSet[String]
331 for m in mainmodule.in_importation.greaters do
332 var libs = m.collect_linker_libs
333 if libs != null then linker_options.add_all(libs)
334 end
335
336 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")
337
338 var ost = toolcontext.opt_stacktrace.value
339 if (ost == "libunwind" or ost == "nitstack") and (platform == null or platform.supports_libunwind) then makefile.write("NEED_LIBUNWIND := YesPlease\n")
340
341 # Dynamic adaptations
342 # While `platform` enable complex toolchains, they are statically applied
343 # For a dynamic adaptsation of the compilation, the generated Makefile should check and adapt things itself
344
345 # Check and adapt the targeted system
346 makefile.write("uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')\n")
347 makefile.write("ifeq ($(uname_S),Darwin)\n")
348 # remove -lunwind since it is already included on macosx
349 makefile.write("\tNEED_LIBUNWIND :=\n")
350 makefile.write("endif\n\n")
351
352 # Check and adapt for the compiler used
353 # clang need an additionnal `-Qunused-arguments`
354 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")
355
356 makefile.write("ifdef NEED_LIBUNWIND\n\tLDLIBS += -lunwind\nendif\n")
357
358 makefile.write("all: {outpath}\n")
359 if outpath != real_outpath then
360 makefile.write("\tcp -- {outpath.escape_to_sh} {real_outpath.escape_to_sh.replace("$","$$")}")
361 end
362 makefile.write("\n")
363
364 var ofiles = new Array[String]
365 var dep_rules = new Array[String]
366 # Compile each generated file
367 for f in cfiles do
368 var o = f.strip_extension(".c") + ".o"
369 makefile.write("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -c -o {o} {f}\n\n")
370 ofiles.add(o)
371 dep_rules.add(o)
372 end
373
374 var java_files = new Array[ExternFile]
375
376 var pkgconfigs = new Array[String]
377 for f in compiler.extern_bodies do
378 pkgconfigs.add_all f.pkgconfigs
379 end
380 # Protect pkg-config
381 if not pkgconfigs.is_empty then
382 makefile.write """
383 # does pkg-config exists?
384 ifneq ($(shell which pkg-config >/dev/null; echo $$?), 0)
385 $(error "Command `pkg-config` not found. Please install it")
386 endif
387 """
388 for p in pkgconfigs do
389 makefile.write """
390 # Check for library {{{p}}}
391 ifneq ($(shell pkg-config --exists '{{{p}}}'; echo $$?), 0)
392 $(error "pkg-config: package {{{p}}} is not found.")
393 endif
394 """
395 end
396 end
397
398 # Compile each required extern body into a specific .o
399 for f in compiler.extern_bodies do
400 var o = f.makefile_rule_name
401 var ff = f.filename.basename("")
402 makefile.write("{o}: {ff}\n")
403 makefile.write("\t{f.makefile_rule_content}\n\n")
404 dep_rules.add(f.makefile_rule_name)
405
406 if f.compiles_to_o_file then ofiles.add(o)
407 if f.add_to_jar then java_files.add(f)
408 end
409
410 if not java_files.is_empty then
411 var jar_file = "{outpath}.jar"
412
413 var class_files_array = new Array[String]
414 for f in java_files do class_files_array.add(f.makefile_rule_name)
415 var class_files = class_files_array.join(" ")
416
417 makefile.write("{jar_file}: {class_files}\n")
418 makefile.write("\tjar cf {jar_file} {class_files}\n\n")
419 dep_rules.add jar_file
420 end
421
422 # Link edition
423 var pkg = ""
424 if not pkgconfigs.is_empty then
425 pkg = "`pkg-config --libs {pkgconfigs.join(" ")}`"
426 end
427 makefile.write("{outpath}: {dep_rules.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outpath.escape_to_sh} {ofiles.join(" ")} $(LDLIBS) {pkg}\n\n")
428 # Clean
429 makefile.write("clean:\n\trm {ofiles.join(" ")} 2>/dev/null\n")
430 if outpath != real_outpath then
431 makefile.write("\trm -- {outpath.escape_to_sh} 2>/dev/null\n")
432 end
433 makefile.close
434 self.toolcontext.info("Generated makefile: {makepath}", 2)
435
436 makepath.file_copy_to "{compile_dir}/Makefile"
437 end
438
439 fun compile_c_code(compiler: AbstractCompiler, compile_dir: String)
440 do
441 var makename = makefile_name(compiler.mainmodule)
442
443 var makeflags = self.toolcontext.opt_make_flags.value
444 if makeflags == null then makeflags = ""
445 self.toolcontext.info("make -B -C {compile_dir} -f {makename} -j 4 {makeflags}", 2)
446
447 var res
448 if self.toolcontext.verbose_level >= 3 then
449 res = sys.system("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1")
450 else
451 res = sys.system("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1 >/dev/null")
452 end
453 if res != 0 then
454 toolcontext.error(null, "make failed! Error code: {res}.")
455 end
456 end
457 end
458
459 # Singleton that store the knowledge about the compilation process
460 abstract class AbstractCompiler
461 type VISITOR: AbstractCompilerVisitor
462
463 # Table corresponding c_names to nit names (methods)
464 var names = new HashMap[String, String]
465
466 # The main module of the program currently compiled
467 # Is assigned during the separate compilation
468 var mainmodule: MModule is writable
469
470 # The real main module of the program
471 var realmainmodule: MModule is noinit
472
473 # The modelbuilder used to know the model and the AST
474 var modelbuilder: ModelBuilder is protected writable
475
476 # Is hardening asked? (see --hardening)
477 fun hardening: Bool do return self.modelbuilder.toolcontext.opt_hardening.value
478
479 init
480 do
481 self.realmainmodule = mainmodule
482 end
483
484 # Force the creation of a new file
485 # The point is to avoid contamination between must-be-compiled-separately files
486 fun new_file(name: String): CodeFile
487 do
488 if modelbuilder.toolcontext.opt_group_c_files.value then
489 if self.files.is_empty then
490 var f = new CodeFile(mainmodule.c_name)
491 self.files.add(f)
492 end
493 return self.files.first
494 end
495 var f = new CodeFile(name)
496 self.files.add(f)
497 return f
498 end
499
500 # The list of all associated files
501 # Used to generate .c files
502 var files = new List[CodeFile]
503
504 # Initialize a visitor specific for a compiler engine
505 fun new_visitor: VISITOR is abstract
506
507 # Where global declaration are stored (the main .h)
508 var header: CodeWriter is writable, noinit
509
510 # Provide a declaration that can be requested (before or latter) by a visitor
511 fun provide_declaration(key: String, s: String)
512 do
513 if self.provided_declarations.has_key(key) then
514 assert self.provided_declarations[key] == s
515 end
516 self.provided_declarations[key] = s
517 end
518
519 private var provided_declarations = new HashMap[String, String]
520
521 private var requirers_of_declarations = new HashMap[String, ANode]
522
523 # Builds the .c and .h files to be used when generating a Stack Trace
524 # Binds the generated C function names to Nit function names
525 fun build_c_to_nit_bindings
526 do
527 var compile_dir = modelbuilder.compile_dir
528
529 var stream = new OFStream.open("{compile_dir}/c_functions_hash.c")
530 stream.write("#include <string.h>\n")
531 stream.write("#include <stdlib.h>\n")
532 stream.write("#include \"c_functions_hash.h\"\n")
533 stream.write("typedef struct C_Nit_Names\{char* name; char* nit_name;\}C_Nit_Names;\n")
534 stream.write("const char* get_nit_name(register const char* procproc, register unsigned int len)\{\n")
535 stream.write("char* procname = malloc(len+1);")
536 stream.write("memcpy(procname, procproc, len);")
537 stream.write("procname[len] = '\\0';")
538 stream.write("static const C_Nit_Names map[{names.length}] = \{\n")
539 for i in names.keys do
540 stream.write("\{\"")
541 stream.write(i.escape_to_c)
542 stream.write("\",\"")
543 stream.write(names[i].escape_to_c)
544 stream.write("\"\},\n")
545 end
546 stream.write("\};\n")
547 stream.write("int i;")
548 stream.write("for(i = 0; i < {names.length}; i++)\{")
549 stream.write("if(strcmp(procname,map[i].name) == 0)\{")
550 stream.write("free(procname);")
551 stream.write("return map[i].nit_name;")
552 stream.write("\}")
553 stream.write("\}")
554 stream.write("free(procname);")
555 stream.write("return NULL;")
556 stream.write("\}\n")
557 stream.close
558
559 stream = new OFStream.open("{compile_dir}/c_functions_hash.h")
560 stream.write("const char* get_nit_name(register const char* procname, register unsigned int len);\n")
561 stream.close
562
563 extern_bodies.add(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
564 end
565
566 # Compile C headers
567 # This method call compile_header_strucs method that has to be refined
568 fun compile_header do
569 self.header.add_decl("#include <stdlib.h>")
570 self.header.add_decl("#include <stdio.h>")
571 self.header.add_decl("#include <string.h>")
572 self.header.add_decl("#include \"gc_chooser.h\"")
573 self.header.add_decl("#ifdef ANDROID")
574 self.header.add_decl(" #include <android/log.h>")
575 self.header.add_decl(" #define PRINT_ERROR(...) (void)__android_log_print(ANDROID_LOG_WARN, \"Nit\", __VA_ARGS__)")
576 self.header.add_decl("#else")
577 self.header.add_decl(" #define PRINT_ERROR(...) fprintf(stderr, __VA_ARGS__)")
578 self.header.add_decl("#endif")
579
580 compile_header_structs
581 compile_nitni_structs
582
583 var gccd_disable = modelbuilder.toolcontext.opt_no_gcc_directive.value
584 if gccd_disable.has("noreturn") or gccd_disable.has("all") then
585 # Signal handler function prototype
586 self.header.add_decl("void show_backtrace(int);")
587 else
588 self.header.add_decl("void show_backtrace(int) __attribute__ ((noreturn));")
589 end
590
591 if gccd_disable.has("likely") or gccd_disable.has("all") then
592 self.header.add_decl("#define likely(x) (x)")
593 self.header.add_decl("#define unlikely(x) (x)")
594 else if gccd_disable.has("correct-likely") then
595 # invert the `likely` definition
596 # Used by masochists to bench the worst case
597 self.header.add_decl("#define likely(x) __builtin_expect((x),0)")
598 self.header.add_decl("#define unlikely(x) __builtin_expect((x),1)")
599 else
600 self.header.add_decl("#define likely(x) __builtin_expect((x),1)")
601 self.header.add_decl("#define unlikely(x) __builtin_expect((x),0)")
602 end
603
604 # Global variable used by intern methods
605 self.header.add_decl("extern int glob_argc;")
606 self.header.add_decl("extern char **glob_argv;")
607 self.header.add_decl("extern val *glob_sys;")
608 end
609
610 # Declaration of structures for live Nit types
611 protected fun compile_header_structs is abstract
612
613 # Declaration of structures for nitni undelying the FFI
614 protected fun compile_nitni_structs
615 do
616 self.header.add_decl """
617 /* Native reference to Nit objects */
618 /* This structure is used to represent every Nit type in extern methods and custom C code. */
619 struct nitni_ref {
620 struct nitni_ref *next,
621 *prev; /* adjacent global references in global list */
622 int count; /* number of time this global reference has been marked */
623 };
624
625 /* List of global references from C code to Nit objects */
626 /* Instanciated empty at init of Nit system and filled explicitly by user in C code */
627 struct nitni_global_ref_list_t {
628 struct nitni_ref *head, *tail;
629 };
630 extern struct nitni_global_ref_list_t *nitni_global_ref_list;
631
632 /* Initializer of global reference list */
633 extern void nitni_global_ref_list_init();
634
635 /* Intern function to add a global reference to the list */
636 extern void nitni_global_ref_add( struct nitni_ref *ref );
637
638 /* Intern function to remove a global reference from the list */
639 extern void nitni_global_ref_remove( struct nitni_ref *ref );
640
641 /* Increase count on an existing global reference */
642 extern void nitni_global_ref_incr( struct nitni_ref *ref );
643
644 /* Decrease count on an existing global reference */
645 extern void nitni_global_ref_decr( struct nitni_ref *ref );
646 """
647 end
648
649 fun compile_finalizer_function
650 do
651 var finalizable_type = mainmodule.finalizable_type
652 if finalizable_type == null then return
653
654 var finalize_meth = mainmodule.try_get_primitive_method("finalize", finalizable_type.mclass)
655
656 if finalize_meth == null then
657 modelbuilder.toolcontext.error(null, "The `Finalizable` class doesn't declare the `finalize` method.")
658 return
659 end
660
661 var v = self.new_visitor
662 v.add_decl "void gc_finalize (void *obj, void *client_data) \{"
663 var recv = v.new_expr("obj", finalizable_type)
664 v.send(finalize_meth, [recv])
665 v.add "\}"
666 end
667
668 # Generate the main C function.
669 #
670 # This function:
671 #
672 # * allocate the Sys object if it exists
673 # * call init if is exists
674 # * call main if it exists
675 fun compile_main_function
676 do
677 var v = self.new_visitor
678 v.add_decl("#include <signal.h>")
679 var ost = modelbuilder.toolcontext.opt_stacktrace.value
680 var platform = mainmodule.target_platform
681
682 if platform != null and not platform.supports_libunwind then ost = "none"
683
684 var no_main = (platform != null and platform.no_main) or modelbuilder.toolcontext.opt_no_main.value
685
686 if ost == "nitstack" or ost == "libunwind" then
687 v.add_decl("#define UNW_LOCAL_ONLY")
688 v.add_decl("#include <libunwind.h>")
689 if ost == "nitstack" then
690 v.add_decl("#include \"c_functions_hash.h\"")
691 end
692 end
693 v.add_decl("int glob_argc;")
694 v.add_decl("char **glob_argv;")
695 v.add_decl("val *glob_sys;")
696
697 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
698 for tag in count_type_test_tags do
699 v.add_decl("long count_type_test_resolved_{tag};")
700 v.add_decl("long count_type_test_unresolved_{tag};")
701 v.add_decl("long count_type_test_skipped_{tag};")
702 v.compiler.header.add_decl("extern long count_type_test_resolved_{tag};")
703 v.compiler.header.add_decl("extern long count_type_test_unresolved_{tag};")
704 v.compiler.header.add_decl("extern long count_type_test_skipped_{tag};")
705 end
706 end
707
708 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
709 v.add_decl("long count_invoke_by_tables;")
710 v.add_decl("long count_invoke_by_direct;")
711 v.add_decl("long count_invoke_by_inline;")
712 v.compiler.header.add_decl("extern long count_invoke_by_tables;")
713 v.compiler.header.add_decl("extern long count_invoke_by_direct;")
714 v.compiler.header.add_decl("extern long count_invoke_by_inline;")
715 end
716
717 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
718 v.add_decl("long count_attr_reads = 0;")
719 v.add_decl("long count_isset_checks = 0;")
720 v.compiler.header.add_decl("extern long count_attr_reads;")
721 v.compiler.header.add_decl("extern long count_isset_checks;")
722 end
723
724 v.add_decl("void sig_handler(int signo)\{")
725 v.add_decl("PRINT_ERROR(\"Caught signal : %s\\n\", strsignal(signo));")
726 v.add_decl("show_backtrace(signo);")
727 v.add_decl("\}")
728
729 v.add_decl("void show_backtrace (int signo) \{")
730 if ost == "nitstack" or ost == "libunwind" then
731 v.add_decl("char* opt = getenv(\"NIT_NO_STACK\");")
732 v.add_decl("unw_cursor_t cursor;")
733 v.add_decl("if(opt==NULL)\{")
734 v.add_decl("unw_context_t uc;")
735 v.add_decl("unw_word_t ip;")
736 v.add_decl("char* procname = malloc(sizeof(char) * 100);")
737 v.add_decl("unw_getcontext(&uc);")
738 v.add_decl("unw_init_local(&cursor, &uc);")
739 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
740 v.add_decl("PRINT_ERROR(\"-- Stack Trace ------------------------------\\n\");")
741 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
742 v.add_decl("while (unw_step(&cursor) > 0) \{")
743 v.add_decl(" unw_get_proc_name(&cursor, procname, 100, &ip);")
744 if ost == "nitstack" then
745 v.add_decl(" const char* recv = get_nit_name(procname, strlen(procname));")
746 v.add_decl(" if (recv != NULL)\{")
747 v.add_decl(" PRINT_ERROR(\"` %s\\n\", recv);")
748 v.add_decl(" \}else\{")
749 v.add_decl(" PRINT_ERROR(\"` %s\\n\", procname);")
750 v.add_decl(" \}")
751 else
752 v.add_decl(" PRINT_ERROR(\"` %s \\n\",procname);")
753 end
754 v.add_decl("\}")
755 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
756 v.add_decl("free(procname);")
757 v.add_decl("\}")
758 end
759 v.add_decl("exit(signo);")
760 v.add_decl("\}")
761
762 if no_main then
763 v.add_decl("int nit_main(int argc, char** argv) \{")
764 else
765 v.add_decl("int main(int argc, char** argv) \{")
766 end
767
768 v.add("signal(SIGABRT, sig_handler);")
769 v.add("signal(SIGFPE, sig_handler);")
770 v.add("signal(SIGILL, sig_handler);")
771 v.add("signal(SIGINT, sig_handler);")
772 v.add("signal(SIGTERM, sig_handler);")
773 v.add("signal(SIGSEGV, sig_handler);")
774 v.add("signal(SIGPIPE, sig_handler);")
775
776 v.add("glob_argc = argc; glob_argv = argv;")
777 v.add("initialize_gc_option();")
778
779 v.add "initialize_nitni_global_refs();"
780
781 var main_type = mainmodule.sys_type
782 if main_type != null then
783 var mainmodule = v.compiler.mainmodule
784 var glob_sys = v.init_instance(main_type)
785 v.add("glob_sys = {glob_sys};")
786 var main_init = mainmodule.try_get_primitive_method("init", main_type.mclass)
787 if main_init != null then
788 v.send(main_init, [glob_sys])
789 end
790 var main_method = mainmodule.try_get_primitive_method("run", main_type.mclass) or else
791 mainmodule.try_get_primitive_method("main", main_type.mclass)
792 if main_method != null then
793 v.send(main_method, [glob_sys])
794 end
795 end
796
797 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
798 v.add_decl("long count_type_test_resolved_total = 0;")
799 v.add_decl("long count_type_test_unresolved_total = 0;")
800 v.add_decl("long count_type_test_skipped_total = 0;")
801 v.add_decl("long count_type_test_total_total = 0;")
802 for tag in count_type_test_tags do
803 v.add_decl("long count_type_test_total_{tag};")
804 v.add("count_type_test_total_{tag} = count_type_test_resolved_{tag} + count_type_test_unresolved_{tag} + count_type_test_skipped_{tag};")
805 v.add("count_type_test_resolved_total += count_type_test_resolved_{tag};")
806 v.add("count_type_test_unresolved_total += count_type_test_unresolved_{tag};")
807 v.add("count_type_test_skipped_total += count_type_test_skipped_{tag};")
808 v.add("count_type_test_total_total += count_type_test_total_{tag};")
809 end
810 v.add("printf(\"# dynamic count_type_test: total %l\\n\");")
811 v.add("printf(\"\\tresolved\\tunresolved\\tskipped\\ttotal\\n\");")
812 var tags = count_type_test_tags.to_a
813 tags.add("total")
814 for tag in tags do
815 v.add("printf(\"{tag}\");")
816 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_resolved_{tag}, 100.0*count_type_test_resolved_{tag}/count_type_test_total_total);")
817 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_unresolved_{tag}, 100.0*count_type_test_unresolved_{tag}/count_type_test_total_total);")
818 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_skipped_{tag}, 100.0*count_type_test_skipped_{tag}/count_type_test_total_total);")
819 v.add("printf(\"\\t%ld (%.2f%%)\\n\", count_type_test_total_{tag}, 100.0*count_type_test_total_{tag}/count_type_test_total_total);")
820 end
821 end
822
823 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
824 v.add_decl("long count_invoke_total;")
825 v.add("count_invoke_total = count_invoke_by_tables + count_invoke_by_direct + count_invoke_by_inline;")
826 v.add("printf(\"# dynamic count_invocation: total %ld\\n\", count_invoke_total);")
827 v.add("printf(\"by table: %ld (%.2f%%)\\n\", count_invoke_by_tables, 100.0*count_invoke_by_tables/count_invoke_total);")
828 v.add("printf(\"direct: %ld (%.2f%%)\\n\", count_invoke_by_direct, 100.0*count_invoke_by_direct/count_invoke_total);")
829 v.add("printf(\"inlined: %ld (%.2f%%)\\n\", count_invoke_by_inline, 100.0*count_invoke_by_inline/count_invoke_total);")
830 end
831
832 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
833 v.add("printf(\"# dynamic attribute reads: %ld\\n\", count_attr_reads);")
834 v.add("printf(\"# dynamic isset checks: %ld\\n\", count_isset_checks);")
835 end
836
837 v.add("return 0;")
838 v.add("\}")
839 end
840
841 # Copile all C functions related to the [incr|decr]_ref features of the FFI
842 fun compile_nitni_global_ref_functions
843 do
844 var v = self.new_visitor
845 v.add """
846 struct nitni_global_ref_list_t *nitni_global_ref_list;
847 void initialize_nitni_global_refs() {
848 nitni_global_ref_list = (struct nitni_global_ref_list_t*)nit_alloc(sizeof(struct nitni_global_ref_list_t));
849 nitni_global_ref_list->head = NULL;
850 nitni_global_ref_list->tail = NULL;
851 }
852
853 void nitni_global_ref_add( struct nitni_ref *ref ) {
854 if ( nitni_global_ref_list->head == NULL ) {
855 nitni_global_ref_list->head = ref;
856 ref->prev = NULL;
857 } else {
858 nitni_global_ref_list->tail->next = ref;
859 ref->prev = nitni_global_ref_list->tail;
860 }
861 nitni_global_ref_list->tail = ref;
862
863 ref->next = NULL;
864 }
865
866 void nitni_global_ref_remove( struct nitni_ref *ref ) {
867 if ( ref->prev == NULL ) {
868 nitni_global_ref_list->head = ref->next;
869 } else {
870 ref->prev->next = ref->next;
871 }
872
873 if ( ref->next == NULL ) {
874 nitni_global_ref_list->tail = ref->prev;
875 } else {
876 ref->next->prev = ref->prev;
877 }
878 }
879
880 extern void nitni_global_ref_incr( struct nitni_ref *ref ) {
881 if ( ref->count == 0 ) /* not registered */
882 {
883 /* add to list */
884 nitni_global_ref_add( ref );
885 }
886
887 ref->count ++;
888 }
889
890 extern void nitni_global_ref_decr( struct nitni_ref *ref ) {
891 if ( ref->count == 1 ) /* was last reference */
892 {
893 /* remove from list */
894 nitni_global_ref_remove( ref );
895 }
896
897 ref->count --;
898 }
899 """
900 end
901
902 # List of additional files required to compile (FFI)
903 var extern_bodies = new Array[ExternFile]
904
905 # List of source files to copy over to the compile dir
906 var files_to_copy = new Array[String]
907
908 # This is used to avoid adding an extern file more than once
909 private var seen_extern = new ArraySet[String]
910
911 # Generate code that initialize the attributes on a new instance
912 fun generate_init_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
913 do
914 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
915 self.mainmodule.linearize_mclassdefs(cds)
916 for cd in cds do
917 for npropdef in modelbuilder.collect_attr_propdef(cd) do
918 npropdef.init_expr(v, recv)
919 end
920 end
921 end
922
923 # Generate code that check if an attribute is correctly initialized
924 fun generate_check_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
925 do
926 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
927 self.mainmodule.linearize_mclassdefs(cds)
928 for cd in cds do
929 for npropdef in modelbuilder.collect_attr_propdef(cd) do
930 npropdef.check_expr(v, recv)
931 end
932 end
933 end
934
935 # stats
936
937 var count_type_test_tags: Array[String] = ["isa", "as", "auto", "covariance", "erasure"]
938 var count_type_test_resolved: HashMap[String, Int] = init_count_type_test_tags
939 var count_type_test_unresolved: HashMap[String, Int] = init_count_type_test_tags
940 var count_type_test_skipped: HashMap[String, Int] = init_count_type_test_tags
941
942 protected fun init_count_type_test_tags: HashMap[String, Int]
943 do
944 var res = new HashMap[String, Int]
945 for tag in count_type_test_tags do
946 res[tag] = 0
947 end
948 return res
949 end
950
951 # Display stats about compilation process
952 #
953 # Metrics used:
954 #
955 # * type tests against resolved types (`x isa Collection[Animal]`)
956 # * type tests against unresolved types (`x isa Collection[E]`)
957 # * type tests skipped
958 # * type tests total
959 fun display_stats
960 do
961 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
962 print "# static count_type_test"
963 print "\tresolved:\tunresolved\tskipped\ttotal"
964 var count_type_test_total = init_count_type_test_tags
965 count_type_test_resolved["total"] = 0
966 count_type_test_unresolved["total"] = 0
967 count_type_test_skipped["total"] = 0
968 count_type_test_total["total"] = 0
969 for tag in count_type_test_tags do
970 count_type_test_total[tag] = count_type_test_resolved[tag] + count_type_test_unresolved[tag] + count_type_test_skipped[tag]
971 count_type_test_resolved["total"] += count_type_test_resolved[tag]
972 count_type_test_unresolved["total"] += count_type_test_unresolved[tag]
973 count_type_test_skipped["total"] += count_type_test_skipped[tag]
974 count_type_test_total["total"] += count_type_test_total[tag]
975 end
976 var count_type_test = count_type_test_total["total"]
977 var tags = count_type_test_tags.to_a
978 tags.add("total")
979 for tag in tags do
980 printn tag
981 printn "\t{count_type_test_resolved[tag]} ({div(count_type_test_resolved[tag],count_type_test)}%)"
982 printn "\t{count_type_test_unresolved[tag]} ({div(count_type_test_unresolved[tag],count_type_test)}%)"
983 printn "\t{count_type_test_skipped[tag]} ({div(count_type_test_skipped[tag],count_type_test)}%)"
984 printn "\t{count_type_test_total[tag]} ({div(count_type_test_total[tag],count_type_test)}%)"
985 print ""
986 end
987 end
988 end
989
990 fun finalize_ffi_for_module(mmodule: MModule) do mmodule.finalize_ffi(self)
991
992 # Division facility
993 # Avoid division by zero by returning the string "n/a"
994 fun div(a,b:Int):String
995 do
996 if b == 0 then return "n/a"
997 return ((a*10000/b).to_f / 100.0).to_precision(2)
998 end
999 end
1000
1001 # A file unit (may be more than one file if
1002 # A file unit aim to be autonomous and is made or one or more `CodeWriter`s
1003 class CodeFile
1004 var name: String
1005 var writers = new Array[CodeWriter]
1006 var required_declarations = new HashSet[String]
1007 end
1008
1009 # Where to store generated lines
1010 class CodeWriter
1011 var file: CodeFile
1012 var lines: List[String] = new List[String]
1013 var decl_lines: List[String] = new List[String]
1014
1015 # Add a line in the main part of the generated C
1016 fun add(s: String) do self.lines.add(s)
1017
1018 # Add a line in the
1019 # (used for local or global declaration)
1020 fun add_decl(s: String) do self.decl_lines.add(s)
1021
1022 init
1023 do
1024 file.writers.add(self)
1025 end
1026 end
1027
1028 # A visitor on the AST of property definition that generate the C code.
1029 abstract class AbstractCompilerVisitor
1030
1031 type COMPILER: AbstractCompiler
1032
1033 # The associated compiler
1034 var compiler: COMPILER
1035
1036 # The current visited AST node
1037 var current_node: nullable ANode = null is writable
1038
1039 # The current `Frame`
1040 var frame: nullable Frame = null is writable
1041
1042 # Alias for self.compiler.mainmodule.object_type
1043 fun object_type: MClassType do return self.compiler.mainmodule.object_type
1044
1045 # Alias for self.compiler.mainmodule.bool_type
1046 fun bool_type: MClassType do return self.compiler.mainmodule.bool_type
1047
1048 var writer: CodeWriter is noinit
1049
1050 init
1051 do
1052 self.writer = new CodeWriter(compiler.files.last)
1053 end
1054
1055 # Force to get the primitive class named `name` or abort
1056 fun get_class(name: String): MClass do return self.compiler.mainmodule.get_primitive_class(name)
1057
1058 # Force to get the primitive property named `name` in the instance `recv` or abort
1059 fun get_property(name: String, recv: MType): MMethod
1060 do
1061 assert recv isa MClassType
1062 return self.compiler.modelbuilder.force_get_primitive_method(self.current_node, name, recv.mclass, self.compiler.mainmodule)
1063 end
1064
1065 fun compile_callsite(callsite: CallSite, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1066 do
1067 var initializers = callsite.mpropdef.initializers
1068 if not initializers.is_empty then
1069 var recv = arguments.first
1070
1071 var i = 1
1072 for p in initializers do
1073 if p isa MMethod then
1074 var args = [recv]
1075 for x in p.intro.msignature.mparameters do
1076 args.add arguments[i]
1077 i += 1
1078 end
1079 self.send(p, args)
1080 else if p isa MAttribute then
1081 self.write_attribute(p, recv, arguments[i])
1082 i += 1
1083 else abort
1084 end
1085 assert i == arguments.length
1086
1087 return self.send(callsite.mproperty, [recv])
1088 end
1089
1090 return self.send(callsite.mproperty, arguments)
1091 end
1092
1093 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable is abstract
1094
1095 fun calloc_array(ret_type: MType, arguments: Array[RuntimeVariable]) is abstract
1096
1097 fun native_array_def(pname: String, ret_type: nullable MType, arguments: Array[RuntimeVariable]) is abstract
1098
1099 # Evaluate `args` as expressions in the call of `mpropdef` on `recv`.
1100 # This method is used to manage varargs in signatures and returns the real array
1101 # of runtime variables to use in the call.
1102 fun varargize(mpropdef: MMethodDef, recv: RuntimeVariable, args: SequenceRead[AExpr]): Array[RuntimeVariable]
1103 do
1104 var msignature = mpropdef.new_msignature or else mpropdef.msignature.as(not null)
1105 var res = new Array[RuntimeVariable]
1106 res.add(recv)
1107
1108 if args.is_empty then return res
1109
1110 var vararg_rank = msignature.vararg_rank
1111 var vararg_len = args.length - msignature.arity
1112 if vararg_len < 0 then vararg_len = 0
1113
1114 for i in [0..msignature.arity[ do
1115 if i == vararg_rank then
1116 var ne = args[i]
1117 if ne isa AVarargExpr then
1118 var e = self.expr(ne.n_expr, null)
1119 res.add(e)
1120 continue
1121 end
1122 var vararg = new Array[RuntimeVariable]
1123 for j in [vararg_rank..vararg_rank+vararg_len] do
1124 var e = self.expr(args[j], null)
1125 vararg.add(e)
1126 end
1127 var elttype = msignature.mparameters[vararg_rank].mtype
1128 var arg = self.vararg_instance(mpropdef, recv, vararg, elttype)
1129 res.add(arg)
1130 else
1131 var j = i
1132 if i > vararg_rank then j += vararg_len
1133 var e = self.expr(args[j], null)
1134 res.add(e)
1135 end
1136 end
1137 return res
1138 end
1139
1140 # Type handling
1141
1142 # Anchor a type to the main module and the current receiver
1143 fun anchor(mtype: MType): MType
1144 do
1145 if not mtype.need_anchor then return mtype
1146 return mtype.anchor_to(self.compiler.mainmodule, self.frame.receiver)
1147 end
1148
1149 fun resolve_for(mtype: MType, recv: RuntimeVariable): MType
1150 do
1151 if not mtype.need_anchor then return mtype
1152 return mtype.resolve_for(recv.mcasttype, self.frame.receiver, self.compiler.mainmodule, true)
1153 end
1154
1155 # Unsafely cast a value to a new type
1156 # ie the result share the same C variable but my have a different mcasttype
1157 # NOTE: if the adaptation is useless then `value` is returned as it.
1158 # ENSURE: `result.name == value.name`
1159 fun autoadapt(value: RuntimeVariable, mtype: MType): RuntimeVariable
1160 do
1161 mtype = self.anchor(mtype)
1162 var valmtype = value.mcasttype
1163 if valmtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1164 return value
1165 end
1166
1167 if valmtype isa MNullableType and valmtype.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1168 var res = new RuntimeVariable(value.name, valmtype, valmtype.mtype)
1169 return res
1170 else
1171 var res = new RuntimeVariable(value.name, valmtype, mtype)
1172 return res
1173 end
1174 end
1175
1176 # Generate a super call from a method definition
1177 fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1178
1179 # Adapt the arguments of a method according to targetted `MMethodDef`
1180 fun adapt_signature(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1181
1182 # Unbox all the arguments of a method when implemented `extern` or `intern`
1183 fun unbox_signature_extern(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1184
1185 # Box or unbox a value to another type iff a C type conversion is needed
1186 # ENSURE: `result.mtype.ctype == mtype.ctype`
1187 fun autobox(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1188
1189 # Box extern classes to be used in the generated code
1190 fun box_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1191
1192 # Unbox extern classes to be used in extern code (legacy NI and FFI)
1193 fun unbox_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1194
1195 # Generate a polymorphic subtype test
1196 fun type_test(value: RuntimeVariable, mtype: MType, tag: String): RuntimeVariable is abstract
1197
1198 # Generate the code required to dynamically check if 2 objects share the same runtime type
1199 fun is_same_type_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1200
1201 # Generate a Nit "is" for two runtime_variables
1202 fun equal_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1203
1204 # Sends
1205
1206 # Generate a static call on a method definition
1207 fun call(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1208
1209 # Generate a polymorphic send for the method `m` and the arguments `args`
1210 fun send(m: MMethod, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1211
1212 # Generate a monomorphic send for the method `m`, the type `t` and the arguments `args`
1213 fun monomorphic_send(m: MMethod, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1214 do
1215 assert t isa MClassType
1216 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
1217 return self.call(propdef, t, args)
1218 end
1219
1220 # Generate a monomorphic super send from the method `m`, the type `t` and the arguments `args`
1221 fun monomorphic_super_send(m: MMethodDef, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1222 do
1223 assert t isa MClassType
1224 m = m.lookup_next_definition(self.compiler.mainmodule, t)
1225 return self.call(m, t, args)
1226 end
1227
1228 # Attributes handling
1229
1230 # Generate a polymorphic attribute is_set test
1231 fun isset_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1232
1233 # Generate a polymorphic attribute read
1234 fun read_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1235
1236 # Generate a polymorphic attribute write
1237 fun write_attribute(a: MAttribute, recv: RuntimeVariable, value: RuntimeVariable) is abstract
1238
1239 # Checks
1240
1241 # Add a check and an abort for a null receiver if needed
1242 fun check_recv_notnull(recv: RuntimeVariable)
1243 do
1244 if self.compiler.modelbuilder.toolcontext.opt_no_check_null.value then return
1245
1246 var maybenull = recv.mcasttype isa MNullableType or recv.mcasttype isa MNullType
1247 if maybenull then
1248 self.add("if (unlikely({recv} == NULL)) \{")
1249 self.add_abort("Receiver is null")
1250 self.add("\}")
1251 end
1252 end
1253
1254 # Names handling
1255
1256 private var names = new HashSet[String]
1257 private var last: Int = 0
1258
1259 # Return a new name based on `s` and unique in the visitor
1260 fun get_name(s: String): String
1261 do
1262 if not self.names.has(s) then
1263 self.names.add(s)
1264 return s
1265 end
1266 var i = self.last + 1
1267 loop
1268 var s2 = s + i.to_s
1269 if not self.names.has(s2) then
1270 self.last = i
1271 self.names.add(s2)
1272 return s2
1273 end
1274 i = i + 1
1275 end
1276 end
1277
1278 # Return an unique and stable identifier associated with an escapemark
1279 fun escapemark_name(e: nullable EscapeMark): String
1280 do
1281 assert e != null
1282 if frame.escapemark_names.has_key(e) then return frame.escapemark_names[e]
1283 var name = e.name
1284 if name == null then name = "label"
1285 name = get_name(name)
1286 frame.escapemark_names[e] = name
1287 return name
1288 end
1289
1290 # Insert a C label for associated with an escapemark
1291 fun add_escape_label(e: nullable EscapeMark)
1292 do
1293 if e == null then return
1294 if e.escapes.is_empty then return
1295 add("BREAK_{escapemark_name(e)}: (void)0;")
1296 end
1297
1298 # Return a "const char*" variable associated to the classname of the dynamic type of an object
1299 # NOTE: we do not return a `RuntimeVariable` "NativeString" as the class may not exist in the module/program
1300 fun class_name_string(value: RuntimeVariable): String is abstract
1301
1302 # Variables handling
1303
1304 protected var variables = new HashMap[Variable, RuntimeVariable]
1305
1306 # Return the local runtime_variable associated to a Nit local variable
1307 fun variable(variable: Variable): RuntimeVariable
1308 do
1309 if self.variables.has_key(variable) then
1310 return self.variables[variable]
1311 else
1312 var name = self.get_name("var_{variable.name}")
1313 var mtype = variable.declared_type.as(not null)
1314 mtype = self.anchor(mtype)
1315 var res = new RuntimeVariable(name, mtype, mtype)
1316 self.add_decl("{mtype.ctype} {name} /* var {variable}: {mtype} */;")
1317 self.variables[variable] = res
1318 return res
1319 end
1320 end
1321
1322 # Return a new uninitialized local runtime_variable
1323 fun new_var(mtype: MType): RuntimeVariable
1324 do
1325 mtype = self.anchor(mtype)
1326 var name = self.get_name("var")
1327 var res = new RuntimeVariable(name, mtype, mtype)
1328 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1329 return res
1330 end
1331
1332 # The difference with `new_var` is the C static type of the local variable
1333 fun new_var_extern(mtype: MType): RuntimeVariable
1334 do
1335 mtype = self.anchor(mtype)
1336 var name = self.get_name("var")
1337 var res = new RuntimeVariable(name, mtype, mtype)
1338 self.add_decl("{mtype.ctype_extern} {name} /* : {mtype} for extern */;")
1339 return res
1340 end
1341
1342 # Return a new uninitialized named runtime_variable
1343 fun new_named_var(mtype: MType, name: String): RuntimeVariable
1344 do
1345 mtype = self.anchor(mtype)
1346 var res = new RuntimeVariable(name, mtype, mtype)
1347 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1348 return res
1349 end
1350
1351 # Correctly assign a left and a right value
1352 # Boxing and unboxing is performed if required
1353 fun assign(left, right: RuntimeVariable)
1354 do
1355 right = self.autobox(right, left.mtype)
1356 self.add("{left} = {right};")
1357 end
1358
1359 # Generate instances
1360
1361 # Generate a alloc-instance + init-attributes
1362 fun init_instance(mtype: MClassType): RuntimeVariable is abstract
1363
1364 # Set a GC finalizer on `recv`, only if `recv` isa Finalizable
1365 fun set_finalizer(recv: RuntimeVariable)
1366 do
1367 var mtype = recv.mtype
1368 var finalizable_type = compiler.mainmodule.finalizable_type
1369 if finalizable_type != null and not mtype.need_anchor and
1370 mtype.is_subtype(compiler.mainmodule, null, finalizable_type) then
1371 add "gc_register_finalizer({recv});"
1372 end
1373 end
1374
1375 # Generate an integer value
1376 fun int_instance(value: Int): RuntimeVariable
1377 do
1378 var res = self.new_var(self.get_class("Int").mclass_type)
1379 self.add("{res} = {value};")
1380 return res
1381 end
1382
1383 # Generate an integer value
1384 fun bool_instance(value: Bool): RuntimeVariable
1385 do
1386 var res = self.new_var(self.get_class("Bool").mclass_type)
1387 if value then
1388 self.add("{res} = 1;")
1389 else
1390 self.add("{res} = 0;")
1391 end
1392 return res
1393 end
1394
1395 # Generate a string value
1396 fun string_instance(string: String): RuntimeVariable
1397 do
1398 var mtype = self.get_class("String").mclass_type
1399 var name = self.get_name("varonce")
1400 self.add_decl("static {mtype.ctype} {name};")
1401 var res = self.new_var(mtype)
1402 self.add("if ({name}) \{")
1403 self.add("{res} = {name};")
1404 self.add("\} else \{")
1405 var native_mtype = self.get_class("NativeString").mclass_type
1406 var nat = self.new_var(native_mtype)
1407 self.add("{nat} = \"{string.escape_to_c}\";")
1408 var length = self.int_instance(string.length)
1409 self.add("{res} = {self.send(self.get_property("to_s_with_length", native_mtype), [nat, length]).as(not null)};")
1410 self.add("{name} = {res};")
1411 self.add("\}")
1412 return res
1413 end
1414
1415 fun value_instance(object: Object): RuntimeVariable
1416 do
1417 if object isa Int then
1418 return int_instance(object)
1419 else if object isa Bool then
1420 return bool_instance(object)
1421 else if object isa String then
1422 return string_instance(object)
1423 else
1424 abort
1425 end
1426 end
1427
1428 # Generate an array value
1429 fun array_instance(array: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1430
1431 # Get an instance of a array for a vararg
1432 fun vararg_instance(mpropdef: MPropDef, recv: RuntimeVariable, varargs: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1433
1434 # Code generation
1435
1436 # Add a line in the main part of the generated C
1437 fun add(s: String) do self.writer.lines.add(s)
1438
1439 # Add a line in the
1440 # (used for local or global declaration)
1441 fun add_decl(s: String) do self.writer.decl_lines.add(s)
1442
1443 # Request the presence of a global declaration
1444 fun require_declaration(key: String)
1445 do
1446 var reqs = self.writer.file.required_declarations
1447 if reqs.has(key) then return
1448 reqs.add(key)
1449 var node = current_node
1450 if node != null then compiler.requirers_of_declarations[key] = node
1451 end
1452
1453 # Add a declaration in the local-header
1454 # The declaration is ensured to be present once
1455 fun declare_once(s: String)
1456 do
1457 self.compiler.provide_declaration(s, s)
1458 self.require_declaration(s)
1459 end
1460
1461 # Look for a needed .h and .c file for a given module
1462 # This is used for the legacy FFI
1463 fun add_extern(mmodule: MModule)
1464 do
1465 var file = mmodule.location.file.filename
1466 file = file.strip_extension(".nit")
1467 var tryfile = file + ".nit.h"
1468 if tryfile.file_exists then
1469 self.declare_once("#include \"{tryfile.basename("")}\"")
1470 self.compiler.files_to_copy.add(tryfile)
1471 end
1472 tryfile = file + "_nit.h"
1473 if tryfile.file_exists then
1474 self.declare_once("#include \"{tryfile.basename("")}\"")
1475 self.compiler.files_to_copy.add(tryfile)
1476 end
1477
1478 if self.compiler.seen_extern.has(file) then return
1479 self.compiler.seen_extern.add(file)
1480 tryfile = file + ".nit.c"
1481 if not tryfile.file_exists then
1482 tryfile = file + "_nit.c"
1483 if not tryfile.file_exists then return
1484 end
1485 var f = new ExternCFile(tryfile.basename(""), "")
1486 self.compiler.extern_bodies.add(f)
1487 self.compiler.files_to_copy.add(tryfile)
1488 end
1489
1490 # Return a new local runtime_variable initialized with the C expression `cexpr`.
1491 fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
1492 do
1493 var res = new_var(mtype)
1494 self.add("{res} = {cexpr};")
1495 return res
1496 end
1497
1498 # Generate generic abort
1499 # used by aborts, asserts, casts, etc.
1500 fun add_abort(message: String)
1501 do
1502 self.add("PRINT_ERROR(\"Runtime error: %s\", \"{message.escape_to_c}\");")
1503 add_raw_abort
1504 end
1505
1506 fun add_raw_abort
1507 do
1508 if self.current_node != null and self.current_node.location.file != null then
1509 self.add("PRINT_ERROR(\" (%s:%d)\\n\", \"{self.current_node.location.file.filename.escape_to_c}\", {current_node.location.line_start});")
1510 else
1511 self.add("PRINT_ERROR(\"\\n\");")
1512 end
1513 self.add("show_backtrace(1);")
1514 end
1515
1516 # Add a dynamic cast
1517 fun add_cast(value: RuntimeVariable, mtype: MType, tag: String)
1518 do
1519 var res = self.type_test(value, mtype, tag)
1520 self.add("if (unlikely(!{res})) \{")
1521 var cn = self.class_name_string(value)
1522 self.add("PRINT_ERROR(\"Runtime error: Cast failed. Expected `%s`, got `%s`\", \"{mtype.to_s.escape_to_c}\", {cn});")
1523 self.add_raw_abort
1524 self.add("\}")
1525 end
1526
1527 # Generate a return with the value `s`
1528 fun ret(s: RuntimeVariable)
1529 do
1530 self.assign(self.frame.returnvar.as(not null), s)
1531 self.add("goto {self.frame.returnlabel.as(not null)};")
1532 end
1533
1534 # Compile a statement (if any)
1535 fun stmt(nexpr: nullable AExpr)
1536 do
1537 if nexpr == null then return
1538
1539 var narray = nexpr.comprehension
1540 if narray != null then
1541 var recv = frame.comprehension.as(not null)
1542 var val = expr(nexpr, narray.element_mtype)
1543 compile_callsite(narray.push_callsite.as(not null), [recv, val])
1544 return
1545 end
1546
1547 var old = self.current_node
1548 self.current_node = nexpr
1549 nexpr.stmt(self)
1550 self.current_node = old
1551 end
1552
1553 # Compile an expression an return its result
1554 # `mtype` is the expected return type, pass null if no specific type is expected.
1555 fun expr(nexpr: AExpr, mtype: nullable MType): RuntimeVariable
1556 do
1557 var old = self.current_node
1558 self.current_node = nexpr
1559 var res = nexpr.expr(self).as(not null)
1560 if mtype != null then
1561 mtype = self.anchor(mtype)
1562 res = self.autobox(res, mtype)
1563 end
1564 res = autoadapt(res, nexpr.mtype.as(not null))
1565 var implicit_cast_to = nexpr.implicit_cast_to
1566 if implicit_cast_to != null and not self.compiler.modelbuilder.toolcontext.opt_no_check_autocast.value then
1567 add_cast(res, implicit_cast_to, "auto")
1568 res = autoadapt(res, implicit_cast_to)
1569 end
1570 self.current_node = old
1571 return res
1572 end
1573
1574 # Alias for `self.expr(nexpr, self.bool_type)`
1575 fun expr_bool(nexpr: AExpr): RuntimeVariable do return expr(nexpr, bool_type)
1576
1577 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1578 fun debug(message: String)
1579 do
1580 var node = self.current_node
1581 if node == null then
1582 print "?: {message}"
1583 else
1584 node.debug(message)
1585 end
1586 self.add("/* DEBUG: {message} */")
1587 end
1588 end
1589
1590 # A C function associated to a Nit method
1591 # Because of customization, a given Nit method can be compiler more that once
1592 abstract class AbstractRuntimeFunction
1593
1594 type COMPILER: AbstractCompiler
1595 type VISITOR: AbstractCompilerVisitor
1596
1597 # The associated Nit method
1598 var mmethoddef: MMethodDef
1599
1600 # The mangled c name of the runtime_function
1601 # Subclasses should redefine `build_c_name` instead
1602 fun c_name: String
1603 do
1604 var res = self.c_name_cache
1605 if res != null then return res
1606 res = self.build_c_name
1607 self.c_name_cache = res
1608 return res
1609 end
1610
1611 # Non cached version of `c_name`
1612 protected fun build_c_name: String is abstract
1613
1614 protected var c_name_cache: nullable String = null is writable
1615
1616 # Implements a call of the runtime_function
1617 # May inline the body or generate a C function call
1618 fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1619
1620 # Generate the code for the `AbstractRuntimeFunction`
1621 # Warning: compile more than once compilation makes CC unhappy
1622 fun compile_to_c(compiler: COMPILER) is abstract
1623 end
1624
1625 # A runtime variable hold a runtime value in C.
1626 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1627 #
1628 # 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.
1629 class RuntimeVariable
1630 # The name of the variable in the C code
1631 var name: String
1632
1633 # The static type of the variable (as declard in C)
1634 var mtype: MType
1635
1636 # The current casted type of the variable (as known in Nit)
1637 var mcasttype: MType is writable
1638
1639 # If the variable exaclty a mcasttype?
1640 # false (usual value) means that the variable is a mcasttype or a subtype.
1641 var is_exact: Bool = false is writable
1642
1643 init
1644 do
1645 assert not mtype.need_anchor
1646 assert not mcasttype.need_anchor
1647 end
1648
1649 redef fun to_s do return name
1650
1651 redef fun inspect
1652 do
1653 var exact_str
1654 if self.is_exact then
1655 exact_str = " exact"
1656 else
1657 exact_str = ""
1658 end
1659 var type_str
1660 if self.mtype == self.mcasttype then
1661 type_str = "{mtype}{exact_str}"
1662 else
1663 type_str = "{mtype}({mcasttype}{exact_str})"
1664 end
1665 return "<{name}:{type_str}>"
1666 end
1667 end
1668
1669 # A frame correspond to a visited property in a `GlobalCompilerVisitor`
1670 class Frame
1671
1672 type VISITOR: AbstractCompilerVisitor
1673
1674 # The associated visitor
1675 var visitor: VISITOR
1676
1677 # The executed property.
1678 # A Method in case of a call, an attribute in case of a default initialization.
1679 var mpropdef: MPropDef
1680
1681 # The static type of the receiver
1682 var receiver: MClassType
1683
1684 # Arguments of the method (the first is the receiver)
1685 var arguments: Array[RuntimeVariable]
1686
1687 # The runtime_variable associated to the return (in a function)
1688 var returnvar: nullable RuntimeVariable = null is writable
1689
1690 # The label at the end of the property
1691 var returnlabel: nullable String = null is writable
1692
1693 # Labels associated to a each escapemarks.
1694 # Because of inlinings, escape-marks must be associated to their context (the frame)
1695 private var escapemark_names = new HashMap[EscapeMark, String]
1696
1697 # The array comprehension currently filled, if any
1698 private var comprehension: nullable RuntimeVariable = null
1699 end
1700
1701 redef class MType
1702 # Return the C type associated to a given Nit static type
1703 fun ctype: String do return "val*"
1704
1705 # C type outside of the compiler code and in boxes
1706 fun ctype_extern: String do return "val*"
1707
1708 # Short name of the `ctype` to use in unions
1709 fun ctypename: String do return "val"
1710 end
1711
1712 redef class MClassType
1713
1714 redef fun ctype: String
1715 do
1716 if mclass.name == "Int" then
1717 return "long"
1718 else if mclass.name == "Bool" then
1719 return "short int"
1720 else if mclass.name == "Char" then
1721 return "char"
1722 else if mclass.name == "Float" then
1723 return "double"
1724 else if mclass.name == "NativeString" then
1725 return "char*"
1726 else if mclass.name == "NativeArray" then
1727 return "val*"
1728 else
1729 return "val*"
1730 end
1731 end
1732
1733 redef fun ctype_extern: String
1734 do
1735 if mclass.kind == extern_kind then
1736 return "void*"
1737 else
1738 return ctype
1739 end
1740 end
1741
1742 redef fun ctypename: String
1743 do
1744 if mclass.name == "Int" then
1745 return "l"
1746 else if mclass.name == "Bool" then
1747 return "s"
1748 else if mclass.name == "Char" then
1749 return "c"
1750 else if mclass.name == "Float" then
1751 return "d"
1752 else if mclass.name == "NativeString" then
1753 return "str"
1754 else if mclass.name == "NativeArray" then
1755 #return "{self.arguments.first.ctype}*"
1756 return "val"
1757 else
1758 return "val"
1759 end
1760 end
1761 end
1762
1763 redef class MPropDef
1764 type VISITOR: AbstractCompilerVisitor
1765 end
1766
1767 redef class MMethodDef
1768 # Can the body be inlined?
1769 fun can_inline(v: VISITOR): Bool
1770 do
1771 if is_abstract then return true
1772 var modelbuilder = v.compiler.modelbuilder
1773 var node = modelbuilder.mpropdef2node(self)
1774 if node isa APropdef then
1775 return node.can_inline
1776 else if node isa AClassdef then
1777 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1778 return true
1779 else
1780 abort
1781 end
1782 end
1783
1784 # Inline the body in another visitor
1785 fun compile_inside_to_c(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1786 do
1787 var modelbuilder = v.compiler.modelbuilder
1788 var val = constant_value
1789 var node = modelbuilder.mpropdef2node(self)
1790 if node isa APropdef then
1791 var oldnode = v.current_node
1792 v.current_node = node
1793 self.compile_parameter_check(v, arguments)
1794 node.compile_to_c(v, self, arguments)
1795 v.current_node = oldnode
1796 else if node isa AClassdef then
1797 var oldnode = v.current_node
1798 v.current_node = node
1799 self.compile_parameter_check(v, arguments)
1800 node.compile_to_c(v, self, arguments)
1801 v.current_node = oldnode
1802 else if val != null then
1803 v.ret(v.value_instance(val))
1804 else
1805 abort
1806 end
1807 return null
1808 end
1809
1810 # Generate type checks in the C code to check covariant parameters
1811 fun compile_parameter_check(v: VISITOR, arguments: Array[RuntimeVariable])
1812 do
1813 if v.compiler.modelbuilder.toolcontext.opt_no_check_covariance.value then return
1814
1815 for i in [0..msignature.arity[ do
1816 # skip test for vararg since the array is instantiated with the correct polymorphic type
1817 if msignature.vararg_rank == i then continue
1818
1819 # skip if the cast is not required
1820 var origmtype = self.mproperty.intro.msignature.mparameters[i].mtype
1821 if not origmtype.need_anchor then continue
1822
1823 # get the parameter type
1824 var mtype = self.msignature.mparameters[i].mtype
1825
1826 # generate the cast
1827 # note that v decides if and how to implements the cast
1828 v.add("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1829 v.add_cast(arguments[i+1], mtype, "covariance")
1830 end
1831 end
1832 end
1833
1834 # Node visit
1835
1836 redef class APropdef
1837 fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1838 do
1839 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at {location.to_s}\\n\");")
1840 debug("Not yet implemented")
1841 end
1842
1843 fun can_inline: Bool do return true
1844 end
1845
1846 redef class AMethPropdef
1847 redef fun compile_to_c(v, mpropdef, arguments)
1848 do
1849 if mpropdef.is_abstract then
1850 var cn = v.class_name_string(arguments.first)
1851 v.add("PRINT_ERROR(\"Runtime error: Abstract method `%s` called on `%s`\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1852 v.add_raw_abort
1853 return
1854 end
1855
1856 # Call the implicit super-init
1857 var auto_super_inits = self.auto_super_inits
1858 if auto_super_inits != null then
1859 var args = [arguments.first]
1860 for auto_super_init in auto_super_inits do
1861 assert auto_super_init.mproperty != mpropdef.mproperty
1862 args.clear
1863 for i in [0..auto_super_init.msignature.arity+1[ do
1864 args.add(arguments[i])
1865 end
1866 assert auto_super_init.mproperty != mpropdef.mproperty
1867 v.compile_callsite(auto_super_init, args)
1868 end
1869 end
1870 if auto_super_call then
1871 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
1872 end
1873
1874 # Try special compilation
1875 if mpropdef.is_intern then
1876 if compile_intern_to_c(v, mpropdef, arguments) then return
1877 else if mpropdef.is_extern then
1878 if mpropdef.mproperty.is_init then
1879 if compile_externinit_to_c(v, mpropdef, arguments) then return
1880 else
1881 if compile_externmeth_to_c(v, mpropdef, arguments) then return
1882 end
1883 end
1884
1885 # Compile block if any
1886 var n_block = n_block
1887 if n_block != null then
1888 for i in [0..mpropdef.msignature.arity[ do
1889 var variable = self.n_signature.n_params[i].variable.as(not null)
1890 v.assign(v.variable(variable), arguments[i+1])
1891 end
1892 v.stmt(n_block)
1893 return
1894 end
1895
1896 # We have a problem
1897 var cn = v.class_name_string(arguments.first)
1898 v.add("PRINT_ERROR(\"Runtime error: uncompiled method `%s` called on `%s`. NOT YET IMPLEMENTED\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1899 v.add_raw_abort
1900 end
1901
1902 redef fun can_inline
1903 do
1904 if self.auto_super_inits != null then return false
1905 var nblock = self.n_block
1906 if nblock == null then return true
1907 if (mpropdef.mproperty.name == "==" or mpropdef.mproperty.name == "!=") and mpropdef.mclassdef.mclass.name == "Object" then return true
1908 if nblock isa ABlockExpr and nblock.n_expr.length == 0 then return true
1909 return false
1910 end
1911
1912 fun compile_intern_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
1913 do
1914 var pname = mpropdef.mproperty.name
1915 var cname = mpropdef.mclassdef.mclass.name
1916 var ret = mpropdef.msignature.return_mtype
1917 if ret != null then
1918 ret = v.resolve_for(ret, arguments.first)
1919 end
1920 if pname != "==" and pname != "!=" then
1921 v.adapt_signature(mpropdef, arguments)
1922 v.unbox_signature_extern(mpropdef, arguments)
1923 end
1924 if cname == "Int" then
1925 if pname == "output" then
1926 v.add("printf(\"%ld\\n\", {arguments.first});")
1927 return true
1928 else if pname == "object_id" then
1929 v.ret(arguments.first)
1930 return true
1931 else if pname == "+" then
1932 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1933 return true
1934 else if pname == "-" then
1935 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1936 return true
1937 else if pname == "unary -" then
1938 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1939 return true
1940 else if pname == "*" then
1941 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1942 return true
1943 else if pname == "/" then
1944 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1945 return true
1946 else if pname == "%" then
1947 v.ret(v.new_expr("{arguments[0]} % {arguments[1]}", ret.as(not null)))
1948 return true
1949 else if pname == "lshift" then
1950 v.ret(v.new_expr("{arguments[0]} << {arguments[1]}", ret.as(not null)))
1951 return true
1952 else if pname == "rshift" then
1953 v.ret(v.new_expr("{arguments[0]} >> {arguments[1]}", ret.as(not null)))
1954 return true
1955 else if pname == "==" then
1956 v.ret(v.equal_test(arguments[0], arguments[1]))
1957 return true
1958 else if pname == "!=" then
1959 var res = v.equal_test(arguments[0], arguments[1])
1960 v.ret(v.new_expr("!{res}", ret.as(not null)))
1961 return true
1962 else if pname == "<" then
1963 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1964 return true
1965 else if pname == ">" then
1966 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1967 return true
1968 else if pname == "<=" then
1969 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1970 return true
1971 else if pname == ">=" then
1972 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1973 return true
1974 else if pname == "to_f" then
1975 v.ret(v.new_expr("(double){arguments[0]}", ret.as(not null)))
1976 return true
1977 else if pname == "ascii" then
1978 v.ret(v.new_expr("{arguments[0]}", ret.as(not null)))
1979 return true
1980 end
1981 else if cname == "Char" then
1982 if pname == "output" then
1983 v.add("printf(\"%c\", {arguments.first});")
1984 return true
1985 else if pname == "object_id" then
1986 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1987 return true
1988 else if pname == "successor" then
1989 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1990 return true
1991 else if pname == "predecessor" then
1992 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1993 return true
1994 else if pname == "==" then
1995 v.ret(v.equal_test(arguments[0], arguments[1]))
1996 return true
1997 else if pname == "!=" then
1998 var res = v.equal_test(arguments[0], arguments[1])
1999 v.ret(v.new_expr("!{res}", ret.as(not null)))
2000 return true
2001 else if pname == "<" then
2002 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2003 return true
2004 else if pname == ">" then
2005 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2006 return true
2007 else if pname == "<=" then
2008 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2009 return true
2010 else if pname == ">=" then
2011 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2012 return true
2013 else if pname == "to_i" then
2014 v.ret(v.new_expr("{arguments[0]}-'0'", ret.as(not null)))
2015 return true
2016 else if pname == "ascii" then
2017 v.ret(v.new_expr("(unsigned char){arguments[0]}", ret.as(not null)))
2018 return true
2019 end
2020 else if cname == "Bool" then
2021 if pname == "output" then
2022 v.add("printf({arguments.first}?\"true\\n\":\"false\\n\");")
2023 return true
2024 else if pname == "object_id" then
2025 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2026 return true
2027 else if pname == "==" then
2028 v.ret(v.equal_test(arguments[0], arguments[1]))
2029 return true
2030 else if pname == "!=" then
2031 var res = v.equal_test(arguments[0], arguments[1])
2032 v.ret(v.new_expr("!{res}", ret.as(not null)))
2033 return true
2034 end
2035 else if cname == "Float" then
2036 if pname == "output" then
2037 v.add("printf(\"%f\\n\", {arguments.first});")
2038 return true
2039 else if pname == "object_id" then
2040 v.ret(v.new_expr("(double){arguments.first}", ret.as(not null)))
2041 return true
2042 else if pname == "+" then
2043 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
2044 return true
2045 else if pname == "-" then
2046 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
2047 return true
2048 else if pname == "unary -" then
2049 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
2050 return true
2051 else if pname == "succ" then
2052 v.ret(v.new_expr("{arguments[0]}+1", ret.as(not null)))
2053 return true
2054 else if pname == "prec" then
2055 v.ret(v.new_expr("{arguments[0]}-1", ret.as(not null)))
2056 return true
2057 else if pname == "*" then
2058 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
2059 return true
2060 else if pname == "/" then
2061 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
2062 return true
2063 else if pname == "==" then
2064 v.ret(v.equal_test(arguments[0], arguments[1]))
2065 return true
2066 else if pname == "!=" then
2067 var res = v.equal_test(arguments[0], arguments[1])
2068 v.ret(v.new_expr("!{res}", ret.as(not null)))
2069 return true
2070 else if pname == "<" then
2071 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2072 return true
2073 else if pname == ">" then
2074 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2075 return true
2076 else if pname == "<=" then
2077 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2078 return true
2079 else if pname == ">=" then
2080 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2081 return true
2082 else if pname == "to_i" then
2083 v.ret(v.new_expr("(long){arguments[0]}", ret.as(not null)))
2084 return true
2085 end
2086 else if cname == "NativeString" then
2087 if pname == "[]" then
2088 v.ret(v.new_expr("{arguments[0]}[{arguments[1]}]", ret.as(not null)))
2089 return true
2090 else if pname == "[]=" then
2091 v.add("{arguments[0]}[{arguments[1]}]={arguments[2]};")
2092 return true
2093 else if pname == "copy_to" then
2094 v.add("memmove({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
2095 return true
2096 else if pname == "atoi" then
2097 v.ret(v.new_expr("atoi({arguments[0]});", ret.as(not null)))
2098 return true
2099 else if pname == "new" then
2100 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2101 return true
2102 end
2103 else if cname == "NativeArray" then
2104 v.native_array_def(pname, ret, arguments)
2105 return true
2106 end
2107 if pname == "exit" then
2108 v.add("exit({arguments[1]});")
2109 return true
2110 else if pname == "sys" then
2111 v.ret(v.new_expr("glob_sys", ret.as(not null)))
2112 return true
2113 else if pname == "calloc_string" then
2114 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2115 return true
2116 else if pname == "calloc_array" then
2117 v.calloc_array(ret.as(not null), arguments)
2118 return true
2119 else if pname == "object_id" then
2120 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2121 return true
2122 else if pname == "is_same_type" then
2123 v.ret(v.is_same_type_test(arguments[0], arguments[1]))
2124 return true
2125 else if pname == "is_same_instance" then
2126 v.ret(v.equal_test(arguments[0], arguments[1]))
2127 return true
2128 else if pname == "output_class_name" then
2129 var nat = v.class_name_string(arguments.first)
2130 v.add("printf(\"%s\\n\", {nat});")
2131 return true
2132 else if pname == "native_class_name" then
2133 var nat = v.class_name_string(arguments.first)
2134 v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
2135 return true
2136 else if pname == "force_garbage_collection" then
2137 v.add("nit_gcollect();")
2138 return true
2139 else if pname == "native_argc" then
2140 v.ret(v.new_expr("glob_argc", ret.as(not null)))
2141 return true
2142 else if pname == "native_argv" then
2143 v.ret(v.new_expr("glob_argv[{arguments[1]}]", ret.as(not null)))
2144 return true
2145 end
2146 return false
2147 end
2148
2149 # Compile an extern method
2150 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2151 fun compile_externmeth_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2152 do
2153 var externname
2154 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2155 if at != null then
2156 externname = at.arg_as_string(v.compiler.modelbuilder)
2157 if externname == null then return false
2158 else
2159 return false
2160 end
2161 v.add_extern(mpropdef.mclassdef.mmodule)
2162 var res: nullable RuntimeVariable = null
2163 var ret = mpropdef.msignature.return_mtype
2164 if ret != null then
2165 ret = v.resolve_for(ret, arguments.first)
2166 res = v.new_var_extern(ret)
2167 end
2168 v.adapt_signature(mpropdef, arguments)
2169 v.unbox_signature_extern(mpropdef, arguments)
2170
2171 if res == null then
2172 v.add("{externname}({arguments.join(", ")});")
2173 else
2174 v.add("{res} = {externname}({arguments.join(", ")});")
2175 res = v.box_extern(res, ret.as(not null))
2176 v.ret(res)
2177 end
2178 return true
2179 end
2180
2181 # Compile an extern factory
2182 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2183 fun compile_externinit_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2184 do
2185 var externname
2186 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2187 if at != null then
2188 externname = at.arg_as_string(v.compiler.modelbuilder)
2189 if externname == null then return false
2190 else
2191 return false
2192 end
2193 v.add_extern(mpropdef.mclassdef.mmodule)
2194 v.adapt_signature(mpropdef, arguments)
2195 v.unbox_signature_extern(mpropdef, arguments)
2196 var ret = arguments.first.mtype
2197 var res = v.new_var_extern(ret)
2198
2199 arguments.shift
2200
2201 v.add("{res} = {externname}({arguments.join(", ")});")
2202 res = v.box_extern(res, ret)
2203 v.ret(res)
2204 return true
2205 end
2206 end
2207
2208 redef class AAttrPropdef
2209 redef fun can_inline: Bool do return not is_lazy
2210
2211 redef fun compile_to_c(v, mpropdef, arguments)
2212 do
2213 if mpropdef == mreadpropdef then
2214 assert arguments.length == 1
2215 var recv = arguments.first
2216 var res
2217 if is_lazy then
2218 var set
2219 var ret = self.mpropdef.static_mtype
2220 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2221 var guard = self.mlazypropdef.mproperty
2222 if useiset then
2223 set = v.isset_attribute(self.mpropdef.mproperty, recv)
2224 else
2225 set = v.read_attribute(guard, recv)
2226 end
2227 v.add("if(likely({set})) \{")
2228 res = v.read_attribute(self.mpropdef.mproperty, recv)
2229 v.add("\} else \{")
2230
2231 var value = evaluate_expr(v, recv)
2232
2233 v.assign(res, value)
2234 if not useiset then
2235 var true_v = v.new_expr("1", v.bool_type)
2236 v.write_attribute(guard, arguments.first, true_v)
2237 end
2238 v.add("\}")
2239 else
2240 res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2241 end
2242 v.assign(v.frame.returnvar.as(not null), res)
2243 else if mpropdef == mwritepropdef then
2244 assert arguments.length == 2
2245 v.write_attribute(self.mpropdef.mproperty, arguments.first, arguments[1])
2246 if is_lazy then
2247 var ret = self.mpropdef.static_mtype
2248 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2249 if not useiset then
2250 v.write_attribute(self.mlazypropdef.mproperty, arguments.first, v.new_expr("1", v.bool_type))
2251 end
2252 end
2253 else
2254 abort
2255 end
2256 end
2257
2258 fun init_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2259 do
2260 if has_value and not is_lazy then evaluate_expr(v, recv)
2261 end
2262
2263 # Evaluate, store and return the default value of the attribute
2264 private fun evaluate_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable): RuntimeVariable
2265 do
2266 var oldnode = v.current_node
2267 v.current_node = self
2268 var old_frame = v.frame
2269 var frame = new Frame(v, self.mpropdef.as(not null), recv.mcasttype.as_notnullable.as(MClassType), [recv])
2270 v.frame = frame
2271
2272 var value
2273 var mtype = self.mpropdef.static_mtype
2274 assert mtype != null
2275
2276 var nexpr = self.n_expr
2277 var nblock = self.n_block
2278 if nexpr != null then
2279 value = v.expr(nexpr, mtype)
2280 else if nblock != null then
2281 value = v.new_var(mtype)
2282 frame.returnvar = value
2283 frame.returnlabel = v.get_name("RET_LABEL")
2284 v.add("\{")
2285 v.stmt(nblock)
2286 v.add("{frame.returnlabel.as(not null)}:(void)0;")
2287 v.add("\}")
2288 else
2289 abort
2290 end
2291
2292 v.write_attribute(self.mpropdef.mproperty, recv, value)
2293
2294 v.frame = old_frame
2295 v.current_node = oldnode
2296
2297 return value
2298 end
2299
2300 fun check_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2301 do
2302 var nexpr = self.n_expr
2303 if nexpr != null then return
2304
2305 var oldnode = v.current_node
2306 v.current_node = self
2307 var old_frame = v.frame
2308 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2309 v.frame = frame
2310 # Force read to check the initialization
2311 v.read_attribute(self.mpropdef.mproperty, recv)
2312 v.frame = old_frame
2313 v.current_node = oldnode
2314 end
2315 end
2316
2317 redef class AClassdef
2318 private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2319 do
2320 if mpropdef == self.mfree_init then
2321 assert mpropdef.mproperty.is_root_init
2322 assert arguments.length == 1
2323 if not mpropdef.is_intro then
2324 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
2325 end
2326 return
2327 else
2328 abort
2329 end
2330 end
2331 end
2332
2333 redef class AExpr
2334 # Try to compile self as an expression
2335 # Do not call this method directly, use `v.expr` instead
2336 private fun expr(v: AbstractCompilerVisitor): nullable RuntimeVariable
2337 do
2338 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\");")
2339 var mtype = self.mtype
2340 if mtype == null then
2341 return null
2342 else
2343 var res = v.new_var(mtype)
2344 v.add("/* {res} = NOT YET {class_name} */")
2345 return res
2346 end
2347 end
2348
2349 # Try to compile self as a statement
2350 # Do not call this method directly, use `v.stmt` instead
2351 private fun stmt(v: AbstractCompilerVisitor)
2352 do
2353 expr(v)
2354 end
2355 end
2356
2357 redef class ABlockExpr
2358 redef fun stmt(v)
2359 do
2360 for e in self.n_expr do v.stmt(e)
2361 end
2362 redef fun expr(v)
2363 do
2364 var last = self.n_expr.last
2365 for e in self.n_expr do
2366 if e == last then break
2367 v.stmt(e)
2368 end
2369 return v.expr(last, null)
2370 end
2371 end
2372
2373 redef class AVardeclExpr
2374 redef fun stmt(v)
2375 do
2376 var variable = self.variable.as(not null)
2377 var ne = self.n_expr
2378 if ne != null then
2379 var i = v.expr(ne, variable.declared_type)
2380 v.assign(v.variable(variable), i)
2381 end
2382 end
2383 end
2384
2385 redef class AVarExpr
2386 redef fun expr(v)
2387 do
2388 var res = v.variable(self.variable.as(not null))
2389 var mtype = self.mtype.as(not null)
2390 return v.autoadapt(res, mtype)
2391 end
2392 end
2393
2394 redef class AVarAssignExpr
2395 redef fun expr(v)
2396 do
2397 var variable = self.variable.as(not null)
2398 var i = v.expr(self.n_value, variable.declared_type)
2399 v.assign(v.variable(variable), i)
2400 return i
2401 end
2402 end
2403
2404 redef class AVarReassignExpr
2405 redef fun stmt(v)
2406 do
2407 var variable = self.variable.as(not null)
2408 var vari = v.variable(variable)
2409 var value = v.expr(self.n_value, variable.declared_type)
2410 var res = v.compile_callsite(self.reassign_callsite.as(not null), [vari, value])
2411 assert res != null
2412 v.assign(v.variable(variable), res)
2413 end
2414 end
2415
2416 redef class ASelfExpr
2417 redef fun expr(v) do return v.frame.arguments.first
2418 end
2419
2420 redef class AEscapeExpr
2421 redef fun stmt(v) do v.add("goto BREAK_{v.escapemark_name(self.escapemark)};")
2422 end
2423
2424 redef class AReturnExpr
2425 redef fun stmt(v)
2426 do
2427 var nexpr = self.n_expr
2428 if nexpr != null then
2429 var returnvar = v.frame.returnvar.as(not null)
2430 var i = v.expr(nexpr, returnvar.mtype)
2431 v.assign(returnvar, i)
2432 end
2433 v.add("goto {v.frame.returnlabel.as(not null)};")
2434 end
2435 end
2436
2437 redef class AAbortExpr
2438 redef fun stmt(v) do v.add_abort("Aborted")
2439 end
2440
2441 redef class AIfExpr
2442 redef fun stmt(v)
2443 do
2444 var cond = v.expr_bool(self.n_expr)
2445 v.add("if ({cond})\{")
2446 v.stmt(self.n_then)
2447 v.add("\} else \{")
2448 v.stmt(self.n_else)
2449 v.add("\}")
2450 end
2451
2452 redef fun expr(v)
2453 do
2454 var res = v.new_var(self.mtype.as(not null))
2455 var cond = v.expr_bool(self.n_expr)
2456 v.add("if ({cond})\{")
2457 v.assign(res, v.expr(self.n_then.as(not null), null))
2458 v.add("\} else \{")
2459 v.assign(res, v.expr(self.n_else.as(not null), null))
2460 v.add("\}")
2461 return res
2462 end
2463 end
2464
2465 redef class AIfexprExpr
2466 redef fun expr(v)
2467 do
2468 var res = v.new_var(self.mtype.as(not null))
2469 var cond = v.expr_bool(self.n_expr)
2470 v.add("if ({cond})\{")
2471 v.assign(res, v.expr(self.n_then, null))
2472 v.add("\} else \{")
2473 v.assign(res, v.expr(self.n_else, null))
2474 v.add("\}")
2475 return res
2476 end
2477 end
2478
2479 redef class ADoExpr
2480 redef fun stmt(v)
2481 do
2482 v.stmt(self.n_block)
2483 v.add_escape_label(break_mark)
2484 end
2485 end
2486
2487 redef class AWhileExpr
2488 redef fun stmt(v)
2489 do
2490 v.add("for(;;) \{")
2491 var cond = v.expr_bool(self.n_expr)
2492 v.add("if (!{cond}) break;")
2493 v.stmt(self.n_block)
2494 v.add_escape_label(continue_mark)
2495 v.add("\}")
2496 v.add_escape_label(break_mark)
2497 end
2498 end
2499
2500 redef class ALoopExpr
2501 redef fun stmt(v)
2502 do
2503 v.add("for(;;) \{")
2504 v.stmt(self.n_block)
2505 v.add_escape_label(continue_mark)
2506 v.add("\}")
2507 v.add_escape_label(break_mark)
2508 end
2509 end
2510
2511 redef class AForExpr
2512 redef fun stmt(v)
2513 do
2514 var cl = v.expr(self.n_expr, null)
2515 var it_meth = self.method_iterator
2516 assert it_meth != null
2517 var it = v.compile_callsite(it_meth, [cl])
2518 assert it != null
2519 v.add("for(;;) \{")
2520 var isok_meth = self.method_is_ok
2521 assert isok_meth != null
2522 var ok = v.compile_callsite(isok_meth, [it])
2523 assert ok != null
2524 v.add("if(!{ok}) break;")
2525 if self.variables.length == 1 then
2526 var item_meth = self.method_item
2527 assert item_meth != null
2528 var i = v.compile_callsite(item_meth, [it])
2529 assert i != null
2530 v.assign(v.variable(variables.first), i)
2531 else if self.variables.length == 2 then
2532 var key_meth = self.method_key
2533 assert key_meth != null
2534 var i = v.compile_callsite(key_meth, [it])
2535 assert i != null
2536 v.assign(v.variable(variables[0]), i)
2537 var item_meth = self.method_item
2538 assert item_meth != null
2539 i = v.compile_callsite(item_meth, [it])
2540 assert i != null
2541 v.assign(v.variable(variables[1]), i)
2542 else
2543 abort
2544 end
2545 v.stmt(self.n_block)
2546 v.add_escape_label(continue_mark)
2547 var next_meth = self.method_next
2548 assert next_meth != null
2549 v.compile_callsite(next_meth, [it])
2550 v.add("\}")
2551 v.add_escape_label(break_mark)
2552
2553 var method_finish = self.method_finish
2554 if method_finish != null then
2555 # TODO: Find a way to call this also in long escape (e.g. return)
2556 v.compile_callsite(method_finish, [it])
2557 end
2558 end
2559 end
2560
2561 redef class AAssertExpr
2562 redef fun stmt(v)
2563 do
2564 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return
2565
2566 var cond = v.expr_bool(self.n_expr)
2567 v.add("if (unlikely(!{cond})) \{")
2568 v.stmt(self.n_else)
2569 var nid = self.n_id
2570 if nid != null then
2571 v.add_abort("Assert '{nid.text}' failed")
2572 else
2573 v.add_abort("Assert failed")
2574 end
2575 v.add("\}")
2576 end
2577 end
2578
2579 redef class AOrExpr
2580 redef fun expr(v)
2581 do
2582 var res = v.new_var(self.mtype.as(not null))
2583 var i1 = v.expr_bool(self.n_expr)
2584 v.add("if ({i1}) \{")
2585 v.add("{res} = 1;")
2586 v.add("\} else \{")
2587 var i2 = v.expr_bool(self.n_expr2)
2588 v.add("{res} = {i2};")
2589 v.add("\}")
2590 return res
2591 end
2592 end
2593
2594 redef class AImpliesExpr
2595 redef fun expr(v)
2596 do
2597 var res = v.new_var(self.mtype.as(not null))
2598 var i1 = v.expr_bool(self.n_expr)
2599 v.add("if (!{i1}) \{")
2600 v.add("{res} = 1;")
2601 v.add("\} else \{")
2602 var i2 = v.expr_bool(self.n_expr2)
2603 v.add("{res} = {i2};")
2604 v.add("\}")
2605 return res
2606 end
2607 end
2608
2609 redef class AAndExpr
2610 redef fun expr(v)
2611 do
2612 var res = v.new_var(self.mtype.as(not null))
2613 var i1 = v.expr_bool(self.n_expr)
2614 v.add("if (!{i1}) \{")
2615 v.add("{res} = 0;")
2616 v.add("\} else \{")
2617 var i2 = v.expr_bool(self.n_expr2)
2618 v.add("{res} = {i2};")
2619 v.add("\}")
2620 return res
2621 end
2622 end
2623
2624 redef class ANotExpr
2625 redef fun expr(v)
2626 do
2627 var cond = v.expr_bool(self.n_expr)
2628 return v.new_expr("!{cond}", self.mtype.as(not null))
2629 end
2630 end
2631
2632 redef class AOrElseExpr
2633 redef fun expr(v)
2634 do
2635 var res = v.new_var(self.mtype.as(not null))
2636 var i1 = v.expr(self.n_expr, null)
2637 v.add("if ({i1}!=NULL) \{")
2638 v.assign(res, i1)
2639 v.add("\} else \{")
2640 var i2 = v.expr(self.n_expr2, null)
2641 v.assign(res, i2)
2642 v.add("\}")
2643 return res
2644 end
2645 end
2646
2647 redef class AIntExpr
2648 redef fun expr(v) do return v.new_expr("{self.value.to_s}", self.mtype.as(not null))
2649 end
2650
2651 redef class AFloatExpr
2652 redef fun expr(v) do return v.new_expr("{self.n_float.text}", self.mtype.as(not null)) # FIXME use value, not n_float
2653 end
2654
2655 redef class ACharExpr
2656 redef fun expr(v) do return v.new_expr("'{self.value.to_s.escape_to_c}'", self.mtype.as(not null))
2657 end
2658
2659 redef class AArrayExpr
2660 redef fun expr(v)
2661 do
2662 var mtype = self.element_mtype.as(not null)
2663 var array = new Array[RuntimeVariable]
2664 var res = v.array_instance(array, mtype)
2665
2666 var old_comprehension = v.frame.comprehension
2667 v.frame.comprehension = res
2668 for nexpr in self.n_exprs do
2669 v.stmt(nexpr)
2670 end
2671 v.frame.comprehension = old_comprehension
2672
2673 return res
2674 end
2675 end
2676
2677 redef class AStringFormExpr
2678 redef fun expr(v) do return v.string_instance(self.value.as(not null))
2679 end
2680
2681 redef class ASuperstringExpr
2682 redef fun expr(v)
2683 do
2684 var array = new Array[RuntimeVariable]
2685 for ne in self.n_exprs do
2686 if ne isa AStringFormExpr and ne.value == "" then continue # skip empty sub-strings
2687 var i = v.expr(ne, null)
2688 array.add(i)
2689 end
2690 var a = v.array_instance(array, v.object_type)
2691 var res = v.send(v.get_property("to_s", a.mtype), [a])
2692 return res
2693 end
2694 end
2695
2696 redef class ACrangeExpr
2697 redef fun expr(v)
2698 do
2699 var i1 = v.expr(self.n_expr, null)
2700 var i2 = v.expr(self.n_expr2, null)
2701 var mtype = self.mtype.as(MClassType)
2702 var res = v.init_instance(mtype)
2703 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2704 return res
2705 end
2706 end
2707
2708 redef class AOrangeExpr
2709 redef fun expr(v)
2710 do
2711 var i1 = v.expr(self.n_expr, null)
2712 var i2 = v.expr(self.n_expr2, null)
2713 var mtype = self.mtype.as(MClassType)
2714 var res = v.init_instance(mtype)
2715 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2716 return res
2717 end
2718 end
2719
2720 redef class ATrueExpr
2721 redef fun expr(v) do return v.new_expr("1", self.mtype.as(not null))
2722 end
2723
2724 redef class AFalseExpr
2725 redef fun expr(v) do return v.new_expr("0", self.mtype.as(not null))
2726 end
2727
2728 redef class ANullExpr
2729 redef fun expr(v) do return v.new_expr("NULL", self.mtype.as(not null))
2730 end
2731
2732 redef class AIsaExpr
2733 redef fun expr(v)
2734 do
2735 var i = v.expr(self.n_expr, null)
2736 return v.type_test(i, self.cast_type.as(not null), "isa")
2737 end
2738 end
2739
2740 redef class AAsCastExpr
2741 redef fun expr(v)
2742 do
2743 var i = v.expr(self.n_expr, null)
2744 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2745
2746 v.add_cast(i, self.mtype.as(not null), "as")
2747 return i
2748 end
2749 end
2750
2751 redef class AAsNotnullExpr
2752 redef fun expr(v)
2753 do
2754 var i = v.expr(self.n_expr, null)
2755 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2756
2757 if i.mtype.ctype != "val*" then return i
2758
2759 v.add("if (unlikely({i} == NULL)) \{")
2760 v.add_abort("Cast failed")
2761 v.add("\}")
2762 return i
2763 end
2764 end
2765
2766 redef class AParExpr
2767 redef fun expr(v) do return v.expr(self.n_expr, null)
2768 end
2769
2770 redef class AOnceExpr
2771 redef fun expr(v)
2772 do
2773 var mtype = self.mtype.as(not null)
2774 var name = v.get_name("varonce")
2775 var guard = v.get_name(name + "_guard")
2776 v.add_decl("static {mtype.ctype} {name};")
2777 v.add_decl("static int {guard};")
2778 var res = v.new_var(mtype)
2779 v.add("if ({guard}) \{")
2780 v.add("{res} = {name};")
2781 v.add("\} else \{")
2782 var i = v.expr(self.n_expr, mtype)
2783 v.add("{res} = {i};")
2784 v.add("{name} = {res};")
2785 v.add("{guard} = 1;")
2786 v.add("\}")
2787 return res
2788 end
2789 end
2790
2791 redef class ASendExpr
2792 redef fun expr(v)
2793 do
2794 var recv = v.expr(self.n_expr, null)
2795 var callsite = self.callsite.as(not null)
2796 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2797 return v.compile_callsite(callsite, args)
2798 end
2799 end
2800
2801 redef class ASendReassignFormExpr
2802 redef fun stmt(v)
2803 do
2804 var recv = v.expr(self.n_expr, null)
2805 var callsite = self.callsite.as(not null)
2806 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2807
2808 var value = v.expr(self.n_value, null)
2809
2810 var left = v.compile_callsite(callsite, args)
2811 assert left != null
2812
2813 var res = v.compile_callsite(self.reassign_callsite.as(not null), [left, value])
2814 assert res != null
2815
2816 args.add(res)
2817 v.compile_callsite(self.write_callsite.as(not null), args)
2818 end
2819 end
2820
2821 redef class ASuperExpr
2822 redef fun expr(v)
2823 do
2824 var recv = v.frame.arguments.first
2825
2826 var callsite = self.callsite
2827 if callsite != null then
2828 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2829
2830 # Add additional arguments for the super init call
2831 if args.length == 1 then
2832 for i in [0..callsite.msignature.arity[ do
2833 args.add(v.frame.arguments[i+1])
2834 end
2835 end
2836 # Super init call
2837 var res = v.compile_callsite(callsite, args)
2838 return res
2839 end
2840
2841 var mpropdef = self.mpropdef.as(not null)
2842 var args = v.varargize(mpropdef, recv, self.n_args.n_exprs)
2843 if args.length == 1 then
2844 args = v.frame.arguments
2845 end
2846
2847 # stantard call-next-method
2848 return v.supercall(mpropdef, recv.mtype.as(MClassType), args)
2849 end
2850 end
2851
2852 redef class ANewExpr
2853 redef fun expr(v)
2854 do
2855 var mtype = self.recvtype
2856 assert mtype != null
2857 var recv
2858 var ctype = mtype.ctype
2859 if mtype.mclass.name == "NativeArray" then
2860 assert self.n_args.n_exprs.length == 1
2861 var l = v.expr(self.n_args.n_exprs.first, null)
2862 assert mtype isa MGenericType
2863 var elttype = mtype.arguments.first
2864 return v.native_array_instance(elttype, l)
2865 else if ctype == "val*" then
2866 recv = v.init_instance(mtype)
2867 else if ctype == "char*" then
2868 recv = v.new_expr("NULL/*special!*/", mtype)
2869 else
2870 recv = v.new_expr("({ctype})0/*special!*/", mtype)
2871 end
2872
2873 var callsite = self.callsite.as(not null)
2874 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2875 var res2 = v.compile_callsite(callsite, args)
2876 if res2 != null then
2877 #self.debug("got {res2} from {mproperty}. drop {recv}")
2878 return res2
2879 end
2880 return recv
2881 end
2882 end
2883
2884 redef class AAttrExpr
2885 redef fun expr(v)
2886 do
2887 var recv = v.expr(self.n_expr, null)
2888 var mproperty = self.mproperty.as(not null)
2889 return v.read_attribute(mproperty, recv)
2890 end
2891 end
2892
2893 redef class AAttrAssignExpr
2894 redef fun expr(v)
2895 do
2896 var recv = v.expr(self.n_expr, null)
2897 var i = v.expr(self.n_value, null)
2898 var mproperty = self.mproperty.as(not null)
2899 v.write_attribute(mproperty, recv, i)
2900 return i
2901 end
2902 end
2903
2904 redef class AAttrReassignExpr
2905 redef fun stmt(v)
2906 do
2907 var recv = v.expr(self.n_expr, null)
2908 var value = v.expr(self.n_value, null)
2909 var mproperty = self.mproperty.as(not null)
2910 var attr = v.read_attribute(mproperty, recv)
2911 var res = v.compile_callsite(self.reassign_callsite.as(not null), [attr, value])
2912 assert res != null
2913 v.write_attribute(mproperty, recv, res)
2914 end
2915 end
2916
2917 redef class AIssetAttrExpr
2918 redef fun expr(v)
2919 do
2920 var recv = v.expr(self.n_expr, null)
2921 var mproperty = self.mproperty.as(not null)
2922 return v.isset_attribute(mproperty, recv)
2923 end
2924 end
2925
2926 redef class ADebugTypeExpr
2927 redef fun stmt(v)
2928 do
2929 # do nothing
2930 end
2931 end
2932
2933 # Utils
2934
2935 redef class Array[E]
2936 # Return a new `Array` with the elements only contened in self and not in `o`
2937 fun -(o: Array[E]): Array[E] do
2938 var res = new Array[E]
2939 for e in self do if not o.has(e) then res.add(e)
2940 return res
2941 end
2942 end
2943
2944 redef class MModule
2945 # All `MProperty` associated to all `MClassDef` of `mclass`
2946 fun properties(mclass: MClass): Set[MProperty] do
2947 if not self.properties_cache.has_key(mclass) then
2948 var properties = new HashSet[MProperty]
2949 var parents = new Array[MClass]
2950 if self.flatten_mclass_hierarchy.has(mclass) then
2951 parents.add_all(mclass.in_hierarchy(self).direct_greaters)
2952 end
2953 for parent in parents do
2954 properties.add_all(self.properties(parent))
2955 end
2956 for mclassdef in mclass.mclassdefs do
2957 if not self.in_importation <= mclassdef.mmodule then continue
2958 for mprop in mclassdef.intro_mproperties do
2959 properties.add(mprop)
2960 end
2961 end
2962 self.properties_cache[mclass] = properties
2963 end
2964 return properties_cache[mclass]
2965 end
2966 private var properties_cache: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
2967
2968 # Write FFI and nitni results to file
2969 fun finalize_ffi(c: AbstractCompiler) do end
2970
2971 # Give requided addinional system libraries (as given to LD_LIBS)
2972 # Note: can return null instead of an empty set
2973 fun collect_linker_libs: nullable Set[String] do return null
2974 end
2975
2976 # Create a tool context to handle options and paths
2977 var toolcontext = new ToolContext
2978
2979 toolcontext.tooldescription = "Usage: nitc [OPTION]... file.nit...\nCompiles Nit programs."
2980
2981 # We do not add other options, so process them now!
2982 toolcontext.process_options(args)
2983
2984 # We need a model to collect stufs
2985 var model = new Model
2986 # An a model builder to parse files
2987 var modelbuilder = new ModelBuilder(model, toolcontext)
2988
2989 var arguments = toolcontext.option_context.rest
2990 if arguments.length > 1 and toolcontext.opt_output.value != null then
2991 print "Error: --output needs a single source file. Do you prefer --dir?"
2992 exit 1
2993 end
2994
2995 # Here we load an process all modules passed on the command line
2996 var mmodules = modelbuilder.parse(arguments)
2997
2998 if mmodules.is_empty then return
2999 modelbuilder.run_phases
3000
3001 for mmodule in mmodules do
3002 toolcontext.info("*** PROCESS {mmodule} ***", 1)
3003 var ms = [mmodule]
3004 toolcontext.run_global_phases(ms)
3005 end