1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2011 Alexis Laferrière <alexis.laf@xymus.net>
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 # Information and tools relevant to the frontier files
25 import syntax
# FIXME: to remove since it breaks modularity
27 redef class MMSrcModule
28 fun compile_frontier
( v
: FrontierVisitor )
30 # assumes is extern hybrid (verified by caller)
32 v
.body
.add
( "#include \"{name}._nitni
.h\
"\n" )
35 v
.header_top
.add
( "#include <nit_common.h>\n" )
36 v
.header_top
.add
( "#include \"{v.cprogram.module_header_name(self)}\
"\n" )
38 var guard_name
= "{name.to_s.to_upper}_NITNI_H"
39 v
.header_top
.add
( "#ifndef {guard_name}\n" )
40 v
.header_top
.add
( "#define {guard_name}\n\n" )
42 # import custom _nit.h file from frontier
43 var native_header
= "{directory.path}/{name}.nit.h"
44 if not native_header
.file_exists
then # try old style
45 native_header
= "{directory.path}/{name}_nit.h"
47 if native_header
.file_exists
then
48 var path
= "..".join_path
(native_header
).simplify_path
49 v
.body
.add
( "#include \"{path}\
"\n" )
50 v
.header
.add
( "#include \"{path}\
"\n" )
53 for local_class
in local_classes
do
55 for prop
in local_class
.local_local_properties
do
56 # if defined of redefined in this module
58 if prop
.mmmodule
== self and
59 prop
isa MMSrcMethod and prop
.is_extern
then
60 prop
.compile_extern_to_frontier
( v
)
65 # if class is extern and defined here first
66 if local_class
.global
.intro
== local_class
and
67 local_class
.global
.is_extern
then
68 local_class
.compile_defaut_extern_type
( v
)
72 v
.header
.add
( "#endif\n" )
76 redef class MMSrcMethod
77 fun compile_extern_to_frontier
( v
: FrontierVisitor )
79 # defines types used in signature
80 if signature
!= null then
81 signature
.compile_frontier
( v
)
84 for imported
in explicit_imports
do
85 # adds friendly access to property
86 v
.friendlys
.add
( imported
)
88 # defines relevant types
89 imported
.signature
.compile_frontier
( v
)
92 # adds casts and as verifications
93 for cast
in explicit_casts
do
96 v
.types
.add
( cast
.from
)
97 v
.types
.add
( cast
.to
)
102 compile_super_to_frontier
( v
)
105 # adds function in frontier to be called by pure nit
106 compile_out_to_frontier
( v
)
109 # Compiles body and header for the friendly super method.
110 # The friendly super method is called by custom native code and
111 # calls the generated C code to execute the real implementation.
112 # It handles types conversion and verifications.
113 fun compile_super_to_frontier
( v
: FrontierVisitor )
116 v
.header
.add
( "\n/* friendly for super of {full_name} */\n" )
117 v
.header
.add
( "{frontier_super_csignature_from( mmmodule )};\n" )
119 # Defines a local name for simplier use, as with friendlys.
120 v
.header
.add
( "#ifndef {friendly_super_cname}\n" )
121 v
.header
.add
( "#define {friendly_super_cname} {local_friendly_super_name_from( mmmodule )}\n" )
122 v
.header
.add
( "#endif\n" )
125 v
.body
.add
( "\n/* friendly for super of {full_name} */\n" )
126 var fc
= new FunctionCompiler( friendly_super_csignature
)
129 var params
= new Array[String]
132 var name_for_sub
= "recv___nit"
133 fc
.decls
.add
( "val_t {name_for_sub};\n" )
134 fc
.exprs
.add
( "{signature.recv.assign_from_friendly( name_for_sub, "recv" )};\n" )
135 params
.add
( name_for_sub
)
138 for p
in signature
.params
do
139 name_for_sub
= "{p.name}___nit"
140 fc
.decls
.add
( "val_t {name_for_sub};\n" )
141 fc
.exprs
.add
( "{p.mmtype.assign_from_friendly( name_for_sub, p.name.to_s )};\n" )
142 params
.add
( name_for_sub
)
145 # hook to generated C
146 var return_type
: nullable MMType = null
148 if signature
.return_type
!= null then
149 return_type
= signature
.return_type
153 if return_type
!= null then
154 fc
.decls
.add
( "{return_type.friendly_extern_name} return___nitni;\n" )
155 fc
.decls
.add
( "val_t return___nit;\n" )
156 s
.append
( "return___nit = " )
159 s
.append
( "{super_meth_call}( recv___nit )" )
161 s
.append
( "( {params.join( ", " )} );\n" )
163 fc
.exprs
.add
( s
.to_s
)
166 if return_type
!= null
168 fc
.exprs
.add
( "{return_type.assign_to_friendly( "return___nitni", "return___nit" )};\n" )
169 fc
.exprs
.add
( "return return___nitni;\n" )
172 v
.body
.append
( fc
.to_writer
)
175 # Compiles body and header for the out method.
176 # The out method is called by generated C code
177 # It handles variables conversions and verification
178 fun compile_out_to_frontier
( v
: FrontierVisitor )
181 v
.header
.add
( "\n/* out/indirect function for {full_name} */\n" )
182 v
.header
.add
( "{out_csignature};\n" ) # incoming types boxed
185 v
.body
.add
( "/* out/indirect function for {full_name} */\n" )
186 var fc
= new FunctionCompiler( out_csignature
)
189 var params
= new List[String]
192 var name_for_impl
= "recv___nitni"
193 fc
.decls
.add
( "{signature.recv.friendly_extern_name} {name_for_impl};\n" )
194 fc
.exprs
.add
( "{signature.recv.assign_to_friendly( name_for_impl, "recv" )};\n" )
195 params
.add
( name_for_impl
)
198 for p
in signature
.params
do
199 var name_for_impl
= "{p.name}___nitni"
200 fc
.decls
.add
( "{p.mmtype.friendly_extern_name} {name_for_impl};\n" )
201 fc
.exprs
.add
( "{p.mmtype.assign_to_friendly( name_for_impl, p.name.to_s )};\n" )
202 params
.add
( name_for_impl
)
206 var return_type
: nullable MMType = null
208 if signature
.return_type
!= null then
209 return_type
= signature
.return_type
211 return_type
= local_class
.get_type
215 if return_type
!= null then
216 fc
.decls
.add
( "{return_type.friendly_extern_name} return___nitni;\n" )
217 fc
.decls
.add
( "val_t return___nit;\n" )
218 s
.append
( "return___nitni = " )
221 s
.append
( "{extern_name.as(not null)}( {params.join( ", " )} );\n" )
223 fc
.exprs
.add
( s
.to_s
)
226 if return_type
!= null then
227 fc
.exprs
.add
( "{return_type.assign_from_friendly( "return___nit", "return___nitni" )};\n" )
228 fc
.exprs
.add
( "return return___nit;\n" )
231 v
.body
.append
( fc
.to_writer
)
236 redef class MMLocalClass
237 # Defines a defaut type for special of pointers in frontier.
238 # Can be overriden in the custime .nit.h file, as seen with nits.
239 fun compile_defaut_extern_type
( v
: FrontierVisitor )
241 v
.header
.add
( "#ifndef {get_type.friendly_extern_name}\n" )
242 v
.header
.add
( "\ttypedef void* {get_type.friendly_extern_name};\n" )
243 v
.header
.add
( "#endif\n\n" )
247 redef class MMSignature
248 fun compile_frontier
( v
: FrontierVisitor )
254 for p
in params
do v
.types
.add
( p
.mmtype
)
264 class FrontierVisitor
265 # frontier file header
267 # header comments, imports, guard and types
268 var header_top
: Writer = new Writer
271 var header
: Writer = new Writer
274 var body
: Writer = new Writer
276 # set of imported functions, cached to avoid repetitions
277 var friendlys
: Set[ MMExplicitImport ] = new HashSet[ MMExplicitImport ]
279 # set of relevant types, cached to avoid repetitions
280 var types
: Set[ MMType ] = new HashSet[ MMType ]
282 # set of imported casts and as, cached to avoid repetitions
283 var casts
: Set[ MMImportedCast ] = new HashSet[ MMImportedCast ]
285 var mmmodule
: MMModule
287 var cprogram
: CProgram
292 for t
in types
do t
.compile_to_frontier
( self )
295 for friendly
in friendlys
do friendly
.compile_friendly_to_frontier
( self )
298 for cast
in casts
do cast
.compile_to_frontier
( self )
301 fun write_to_files
( base_path
: String )
303 var path
= "{base_path}._nitni.h"
304 var stream
= new OFStream.open
( path
)
305 header_top
.write_to_stream
( stream
)
306 header
.write_to_stream
( stream
)
309 path
= "{base_path}._nitni.c"
310 stream
= new OFStream.open
( path
)
311 body
.write_to_stream
( stream
)
316 redef class MMImportedCast
317 # Defines functions to cast types and verify the type of an object.
318 fun compile_to_frontier
( v
: FrontierVisitor )
321 if not ( is_about_nullable_only
and is_not_null_to_nullable
) then
322 v
.header
.add
( "\n/* Type check for {from} with {to} */\n" )
323 v
.header
.add
( "{is_a_local_csignature( v.mmmodule )};\n" )
325 v
.header
.add
( "#ifndef {is_a_friendly_extern_name}\n" )
326 v
.header
.add
( "#define {is_a_friendly_extern_name} {is_a_local_cname( v.mmmodule )}\n" )
327 v
.header
.add
( "#endif\n" )
329 var fc
= compile_is
( v
.mmmodule
)
330 v
.body
.append
( fc
.to_writer
)
333 # compile cast itself
334 v
.header
.add
( "\n/* Cast for {from} to {to} */\n" )
335 v
.header
.add
( "{as_local_csignature( v.mmmodule )};\n" )
337 v
.header
.add
( "#ifndef {as_friendly_extern_name}\n" )
338 v
.header
.add
( "#define {as_friendly_extern_name} {as_local_cname( v.mmmodule )}\n" )
339 v
.header
.add
( "#endif\n" )
341 var fc
= compile_as
( v
.mmmodule
)
342 v
.body
.append
( fc
.to_writer
)
345 # Compiles a function to cast an object to a different type.
346 # Verify type and if it is null.
347 fun compile_as
( m
: MMModule ) : FunctionCompiler
349 var fc
= new FunctionCompiler( as_local_csignature
( m
) )
352 var temp_name
= "temp"
354 fc
.decls
.add
( "val_t {temp_name};\n" )
355 fc
.decls
.add
( "{to.friendly_extern_name} {out_name};\n" )
357 fc
.exprs
.add
( "{from.assign_from_friendly(temp_name, in_name)};\n" )
359 # makes sur it is not null if it cannot be
360 if not to
.is_nullable
then
361 compile_check_is_not_null
( fc
, temp_name
)
364 # makes sure it's the right type, unless it's only a cast about null
365 if not is_about_nullable_only
then # inter types
366 to
.compile_check_isa
( fc
, temp_name
)
369 fc
.exprs
.add
( "{to.assign_to_friendly(out_name, temp_name)};\n" )
371 fc
.exprs
.add
( "return {out_name};\n" )
376 # Compiles a function to verify if an object is of the given type.
377 # Verify type and if it is null.
378 fun compile_is
( m
: MMModule ) : FunctionCompiler
380 var fc
= new FunctionCompiler( is_a_local_csignature
( m
) )
382 var temp_name
= "temp"
383 fc
.decls
.add
( "val_t {temp_name};\n" )
385 fc
.exprs
.add
( "{from.assign_from_friendly(temp_name, in_name)};\n" )
387 if is_nullable_to_not_null
then # from null
388 if is_about_nullable_only
then # opposite, we want to know if null
389 fc
.exprs
.add
( "if ( ! ISNULL({temp_name}) ) return 0;\n" )
391 fc
.exprs
.add
( "if ( ISNULL({temp_name}) ) return 0;\n" )
395 if not is_about_nullable_only
then # inter types
396 fc
.exprs
.add
( "if ( ! {to.compile_condition_isa( temp_name )} ) return 0;\n" )
399 fc
.exprs
.add
( "return 1;\n" )
404 # Compiles lines of code to check if an object is not null.
405 # Is to be nested within another function.
406 fun compile_check_is_not_null
( fc
: FunctionCompiler, name
: String )
408 fc
.exprs
.add
( "if ( ISNULL({name}) )\{" )
409 fc
.exprs
.add
( "\tfprintf( stderr, \"Casting from
{from} to
{to} failed because value
is null.\
" );\n" )
410 fc
.exprs
.add
( "\tabort();\n" )
414 redef fun ==( other
)
416 return other
isa MMImportedCast and
417 other
.from
== from
and other
.to
== to
421 return from
.hash
+ to
.hash
426 # Compiles a lines of code to ensure that an object is of the given type.
427 # Aborts when it is of the wrong type
428 # Does not check if it is null.
429 # Is to be nested within another function.
430 fun compile_check_isa
( fc
: FunctionCompiler, name
: String )
432 fc
.exprs
.add
( "if ( ! {compile_condition_isa( name )} )\{" )
433 fc
.exprs
.add
( "\tfprintf( stderr, \"Casting to
{self} failed because value
is not a
{self}.\
" );\n" )
434 fc
.exprs
.add
( "\tabort();\n" )
438 # Compiles an expression to verify if an object is of the given type.
439 # To be nested within a condition.
440 fun compile_condition_isa
( var_name
: String ) : String
442 return "( ISOBJ( {var_name} ) ? OBJISA( {var_name}, {local_class.cname} ): VALISA( {var_name}, {local_class.cname} ) )"
445 # Defines a friendly type in C for a given Nit type.
446 # Standard Nit classes are kept within a struct.
447 fun compile_to_frontier
( v
: FrontierVisitor )
449 var pi
= local_class
.primitive_info
450 if pi
== null or is_nullable
then
451 var name
= friendly_extern_name
452 var guard
= "{name.to_s.to_upper}_TYPE"
455 v
.header_top
.add
( "#ifndef {guard}\n" )
456 v
.header_top
.add
( "#define {guard}\n" )
457 v
.header_top
.add
( "typedef struct s_{name}\{\n" )
458 v
.header_top
.add
( "\tval_t v;\n" )
459 v
.header_top
.add
( "\} {name};\n" )
460 v
.header_top
.add
( "#endif\n\n" )
462 # add null version, as a struct
464 var null_getter
= "null_{as_notnull.friendly_extern_name}"
465 var null_getter_local
= "{mmmodule.to_s}_{null_getter}"
467 v
.header
.add
( "{name} {null_getter_local}();\n" )
469 v
.header
.add
( "#ifndef {null_getter}\n" )
470 v
.header
.add
( "#define {null_getter} {null_getter_local}\n" )
471 v
.header
.add
( "#endif\n\n" )
473 v
.body
.add
( "{name} {null_getter_local}()\n" )
475 v
.body
.add
( "\t{name} n;\n" )
476 v
.body
.add
( "\tn.v = NIT_NULL;\n" )
477 v
.body
.add
( "\treturn n;\n" )
478 v
.body
.add
( "\}\n\n" )
484 redef class MMExplicitImport
485 fun compile_friendly_to_frontier
( v
: FrontierVisitor )
487 # prototype in header
488 v
.header
.add
( "/* friendly for {method.full_name} */\n" )
489 v
.header
.add
( "{method.frontier_csignature_from( v.mmmodule, local_class )};\n" )
491 # Defines a simplier name to be used within this module and to prevent
492 # conflict with other modules importing the same friendly.
493 v
.header
.add
( "#ifndef {method.friendly_extern_name( local_class )}\n" )
494 v
.header
.add
( "#define {method.friendly_extern_name( local_class )} {method.local_friendly_name_from( v.mmmodule, local_class )}\n" )
495 v
.header
.add
( "#endif\n" )
497 # implementation in body
498 v
.body
.add
( "/* friendly for {method.full_name} */\n" )
500 var fc
= new FunctionCompiler( method
.frontier_csignature_from
( v
.mmmodule
, local_class
) )
503 var params
= new Array[String]
505 # if not init, add receiver
506 if not method
.is_init
then
507 var name_for_sub
= "recv___nit"
508 fc
.decls
.add
( "val_t {name_for_sub};\n" )
509 fc
.exprs
.add
( "{signature.recv.assign_from_friendly( name_for_sub, "recv" )};\n" )
510 params
.add
( name_for_sub
)
513 for p
in signature
.params
do
514 var name_for_sub
= "{p.name}___nit"
515 fc
.decls
.add
( "val_t {name_for_sub};\n" )
516 fc
.exprs
.add
( "{p.mmtype.assign_from_friendly( name_for_sub, p.name.to_s )};\n" )
517 params
.add
( name_for_sub
)
521 var return_type
: nullable MMType = null
523 # handles return of method or constructor
524 if method
.signature
.return_type
!= null then
525 return_type
= method
.signature
.return_type
526 else if method
.is_init
then
527 return_type
= method
.local_class
.get_type
531 if return_type
!= null then
532 fc
.decls
.add
( "{return_type.friendly_extern_name} result___nitni;\n" )
533 fc
.decls
.add
( "val_t result___nit;\n" )
534 s
.append
( "result___nit = " )
537 # hook to generated C code
538 if method
.is_init
then
539 s
.append
( "NEW_{local_class}_{method.global.intro.cname}" )
541 s
.append
( "{method.global.meth_call}( recv___nit )" )
544 s
.append
( "( {params.join( ", " )} );\n" )
546 fc
.exprs
.add
( s
.to_s
)
549 if return_type
!= null then
550 var result_name_nitni
= "result___nitni"
551 var result_name_nit
= "result___nit"
553 fc
.exprs
.add
( "{return_type.assign_to_friendly( result_name_nitni, result_name_nit )};\n" )
554 fc
.exprs
.add
( "return {result_name_nitni};\n" )
557 v
.body
.append
( fc
.to_writer
)
562 return method
.global
.to_s
.hash
+ local_class
.to_s
.hash
564 redef fun == ( other
)
566 return other
isa MMExplicitImport and
567 method
== other
.method
and local_class
== other
.local_class