src/common_ffi/common_ffi.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Copyright 2013 Alexis Laferrière <alexis.laf@xymus.net>
   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 # FFI concers common between the compilers and the interpreter.
  18 # Offers services to compile modules using foreign code. Mainly allows
  19 # to wrap foreign code in Nit methods.
  20 module common_ffi
  21
  22 import parser
  23 import modelbuilder
  24
  25 import nitni
  26
  27 import ffi_base
  28 import extern_classes
  29 import header_dependency
  30 import pkgconfig
  31 import c_compiler_options
  32 import c
  33 import cpp
  34
  35 redef class MModule
  36         # Does this module uses the FFI?
  37         var uses_ffi: Bool = false
  38 end
  39
  40 redef class AModule
  41         # C compilation unit for the FFI files
  42         private var ffi_ccu: nullable CCompilationUnit = null
  43
  44         # Foreign language used in this AModule
  45         private var present_languages = new HashSet[FFILanguage]
  46
  47         # Callbacks used locally
  48         var ffi_callbacks = new HashMap[FFILanguage, Set[NitniCallback]]
  49
  50         # Ensures all of the general foreign code of the module has been analyzed.
  51         # Manages header blocks, extern class types and foreign dependancies between modules
  52         fun ensure_compile_ffi_wrapper
  53         do
  54                 if ffi_ccu != null then return
  55
  56                 # ready extern code compiler
  57                 var ffi_ccu = new CCompilationUnit
  58                 self.ffi_ccu = ffi_ccu
  59
  60                 # generate code
  61                 for block in n_extern_code_blocks do
  62                         var language = block.language
  63                         assert language != null
  64                         present_languages.add(language)
  65                         language.compile_module_block(block, ffi_ccu, self)
  66                 end
  67
  68                 ffi_ccu.header_c_base.add( "#include \"{mmodule.name}._nitni.h\"\n" )
  69
  70                 # include dependancies FFI
  71                 for mod in mmodule.header_dependencies do
  72                         if mod.uses_ffi then ffi_ccu.header_custom.add("#include \"{mod.name}._ffi.h\"\n")
  73                 end
  74
  75                 for nclassdef in n_classdefs do
  76                         # Does it declares an extern type?
  77                         if nclassdef isa AStdClassdef and nclassdef.n_extern_code_block != null then
  78                                 mmodule.uses_ffi = true
  79                                 var language = nclassdef.n_extern_code_block.language
  80                                 assert language != null
  81                                 present_languages.add(language)
  82                                 nclassdef.n_extern_code_block.language.compile_extern_class(
  83                                         nclassdef.n_extern_code_block.as(not null), nclassdef, ffi_ccu, self)
  84                         end
  85                 end
  86         end
  87
  88         # Complete the compilation of the FFI code
  89         fun finalize_ffi_wrapper(compdir: String, mainmodule: MModule)
  90         do
  91                 ensure_compile_ffi_wrapper
  92
  93                 for language in present_languages do if ffi_callbacks.keys.has(language) then
  94                         for callback in ffi_callbacks[language] do
  95                                 language.compile_callback(callback, self, mainmodule, ffi_ccu.as(not null))
  96                         end
  97
  98                         language.compile_to_files(self, compdir)
  99                 end
 100
 101                 ffi_ccu.write_as_impl(self, compdir)
 102                 for filename in ffi_ccu.files do ffi_files.add(new ExternCFile(filename, self.c_compiler_options))
 103         end
 104 end
 105
 106 redef class AExternPropdef
 107         private var ffi_has_been_compiled = false
 108
 109         # Compile the necessary wrapper around this extern method or constructor
 110         fun compile_ffi_method(amodule: AModule)
 111         do
 112                 assert n_extern_code_block != null
 113
 114                 if ffi_has_been_compiled then return
 115                 ffi_has_been_compiled = true
 116
 117                 amodule.ensure_compile_ffi_wrapper
 118
 119                 var language = n_extern_code_block.language
 120                 assert language != null
 121                 amodule.present_languages.add(language)
 122                 n_extern_code_block.language.compile_extern_method(
 123                         n_extern_code_block.as(not null), self, amodule.ffi_ccu.as(not null), amodule)
 124         end
 125 end
 126
 127 redef class VerifyNitniCallbacksPhase
 128         redef fun process_npropdef(npropdef)
 129         do
 130                 super
 131
 132                 if not npropdef isa AExternPropdef then return
 133
 134                 var code_block = npropdef.n_extern_code_block
 135                 if code_block == null then return
 136
 137                 var lang = code_block.language
 138                 assert lang != null
 139
 140                 # Associate callbacks used by an extern method to its foreign language
 141                 for callback in npropdef.foreign_callbacks.all do
 142                         var map = npropdef.parent.parent.as(AModule).ffi_callbacks
 143                         if not map.keys.has(lang) then map[lang] = new HashSet[NitniCallback]
 144                         map[lang].add(callback)
 145                 end
 146         end
 147 end