1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2008 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Common things for NIT compilation and C generation
18 package compiling_base
24 import compiling_writer
26 redef class ToolContext
27 readable writable var _compdir
: nullable String = null
28 readable writable var _clibdir
: nullable String = null
29 readable writable var _bindir
: nullable String = null
30 readable writable var _output_file
: nullable String = null
31 readable writable var _boost
: Bool = false
32 readable writable var _no_cc
: Bool = false
33 readable writable var _cc_link
: Bool = false
34 readable writable var _cc_libs
: Array[String] = new Array[String]
35 readable writable var _cc_lib_paths
: Array[String] = new Array[String]
36 readable writable var _cc_include_paths
: Array[String] = new Array[String]
37 readable writable var _ext_prefix
: String = ""
40 # A program that is compiled to C
45 _compdir
= p
.tc
.compdir
.as(not null)
46 _build_file
= "{compdir}/{program.main_module.name}._build.sh"
49 # The Nit program compiled to C
50 readable var _program
: Program
52 # C files (full path) required to compile
53 readable var _files
: Array[String] = new Array[String]
55 # Includes paths (gcc -I) required to find the headers (.h) of native modules
56 readable var _include_dirs
: ArraySet[String] = new ArraySet[String]
58 # The path of the building script
59 readable var _build_file
: String
61 # The directory where all files are generated
62 readable var _compdir
: String
64 # Return the basename of the public header file (.h) of a module
65 fun module_header_name
(m
: MMModule): String
67 if _module_include
.has_key
(m
) then
68 return _module_include
[m
]
70 var filename
= "{m.name}.{get_file_ending}.h"
71 _module_include
[m
] = filename
75 # Cache for module_header_name
76 var _module_include
: Map[MMModule, String] = new HashMap[MMModule, String]
78 # When we are using global compilation, we generate _glob files instead
79 # of _sep files so that we do not corrupt separate compilation
80 fun get_file_ending
: String do return if program
.tc
.global
then "_glob" else "_sep"
82 # Generate the shell script that build the program by calling gccx
83 fun generate_build_file
85 var f
= new OFStream.open
(_build_file
)
89 if tc
.verbose_level
== 1 then
91 else if tc
.verbose_level
>= 2 then
92 # We catch tc.verbose_level >= 2, since 3+ is not valid with gccx
96 f
.write
("#!/bin/sh\n")
97 f
.write
("# This shell script is generated by NIT to compile the program {program.main_module.name}.\n")
98 f
.write
("CLIBDIR=\"{tc.clibdir.as(not null)}\
"\n")
99 f
.write
("{tc.bindir.as(not null)}/gccx {verbose} -d {compdir} -I $CLIBDIR {include_dirs.join(" ")}")
100 if tc
.output_file
!= null then
101 f
.write
(" -o {tc.output_file.as(not null)}")
102 else if tc
.ext_prefix
.is_empty
then
103 f
.write
(" -o {program.main_module.name}")
105 f
.write
(" -o {program.main_module.name}_{tc.ext_prefix}")
107 if tc
.boost
then f
.write
(" -O")
108 if not tc
.cc_link
then f
.write
(" -x \"-c\
"")
109 for l
in tc
.cc_libs
do f
.write
(" -x \"-l
{l}\
"")
110 for lp
in tc
.cc_lib_paths
do f
.write
(" -x \"-L
{lp}\
"")
111 for ip
in tc
.cc_include_paths
do f
.write
(" -x \"-I
{ip}\
"")
112 f
.write
(" \"$@\
" \\\n {files.join("\\\n ")}\n")
116 # Invoke the build_file
119 program
.tc
.info
("Building",1)
120 sys
.system
("sh {_build_file}")
124 # Class used to generate files.
125 # Note that in fact it is not a visitor.
126 # Note also that this class is unefficient and poorly designed thus requires love.
127 class CompilerVisitor
128 # Add a line in the current declaration block
129 fun add_decl
(s
: String)
131 add_line_to
(_decl_writer
, s
)
134 # Add a line in the current instr block
135 fun add_instr
(s
: String)
137 add_line_to
(_writer
, s
)
141 fun add_indent
(w
: Writer)
143 if _indent_level
>= 8 then
146 for i
in [0.._indent_level
[ do
152 fun add_line_to
(w
: Writer, s
: String)
159 # Add a assignment between a variable and an expression
160 fun add_assignment
(v
: String, s
: String)
172 # Return a unique new number for the instance
175 var res
= _number_cpt
176 _number_cpt
= res
+ 1
179 # next number for new_number
180 var _number_cpt
: Int = 0
182 # Add an indent level.
183 # New decl and instr will be indented.
184 fun indent
do _indent_level
+= 1
186 # Remove an indent level.
190 if _indent_level
< 0 then _indent_level
= 0
193 # The processed mmmodule
194 readable var _mmmodule
: MMModule
196 # Where header decl are stored (public stuff)
197 readable writable var _header_writer
: Writer
199 # Where current instr are stored (current function declaration)
200 readable writable var _writer
: Writer
202 # Where current decl are stored (current function instructions)
203 readable writable var _decl_writer
: Writer
205 # Where body instr are stored (C functions body)
206 readable writable var _top_writer
: Writer
208 # Where body decl are stored (private C function proptypes and typedefs)
209 readable writable var _top_decl_writer
: Writer
211 # The current indent lever
212 readable writable var _indent_level
: Int = 0
214 # The program we are compiling
215 readable var _program
: Program
217 # The cprogram associed with program
218 readable var _cprogram
: CProgram
220 # Create a new CompilerVisitor based on a module
221 init(mod
: MMModule, cp
: CProgram)
225 _program
= cp
.program
233 _top_decl_writer
= w
.sub
237 redef class MMGlobalProperty
238 # C symbol refering a method inocation
239 fun meth_call
: String
241 return "CALL_{intro.cname}"
244 # C symbol refering an attribure access
245 fun attr_access
: String
247 return "ATTR_{intro.cname}"
251 redef class MMGlobalClass
252 # C symbol refering the identifier of the class
255 return "ID_{intro.name}"
258 # C symbol refering the color of the class (for subtype tests)
261 return "COLOR_{intro.name}"
264 # C symbol refering the init table position of the class (for constructor linearization)
265 fun init_table_pos_id
: String
267 return "INIT_TABLE_POS_{intro.name}"
271 redef class MMLocalProperty
272 # Cacher result of cname
273 var _cname_cache
: nullable String
275 # The mangled name of the method
278 var cname
= _cname_cache
279 if cname
== null then
280 cname
= cmangle
(mmmodule
.name
, local_class
.name
, name
)
286 # C macro used to get the function for the call of a super property
287 fun super_meth_call
: String
289 return "CALL_SUPER_{cname}"