Support for nesting C code within a Nit program using its FFI

Introduced classes

class FromCCallContext

nitc :: FromCCallContext

Context when calling generated code from user C code
class ToCCallContext

nitc :: ToCCallContext

Context when calling user C code from generated code

Redefined classes

redef class AExternCodeBlock

nitc :: light_c $ AExternCodeBlock

An full extern block
redef class FFILanguageAssignationPhase

nitc :: light_c $ FFILanguageAssignationPhase

Phase that assign a FFILanguage to all AExternCodeBlock
redef class Location

nitc :: light_c $ Location

A location inside a source file
redef class MModule

nitc :: light_c $ MModule

A Nit module is usually associated with a Nit source file.
redef class Sys

nitc :: light_c $ Sys

The main class of the program.

All class definitions

redef class AExternCodeBlock

nitc :: light_c $ AExternCodeBlock

An full extern block
redef class FFILanguageAssignationPhase

nitc :: light_c $ FFILanguageAssignationPhase

Phase that assign a FFILanguage to all AExternCodeBlock
class FromCCallContext

nitc $ FromCCallContext

Context when calling generated code from user C code
redef class Location

nitc :: light_c $ Location

A location inside a source file
redef class MModule

nitc :: light_c $ MModule

A Nit module is usually associated with a Nit source file.
redef class Sys

nitc :: light_c $ Sys

The main class of the program.
class ToCCallContext

nitc $ ToCCallContext

Context when calling user C code from generated code
package_diagram nitc::light_c light_c nitc::modelize_property modelize_property nitc::light_c->nitc::modelize_property nitc::light_ffi_base light_ffi_base nitc::light_c->nitc::light_ffi_base nitc::modelize_class modelize_class nitc::modelize_property->nitc::modelize_class nitc::annotation annotation nitc::modelize_property->nitc::annotation nitc::c_tools c_tools nitc::light_ffi_base->nitc::c_tools nitc::nitni_utilities nitni_utilities nitc::light_ffi_base->nitc::nitni_utilities ...nitc::modelize_class ... ...nitc::modelize_class->nitc::modelize_class ...nitc::annotation ... ...nitc::annotation->nitc::annotation ...nitc::c_tools ... ...nitc::c_tools->nitc::c_tools ...nitc::nitni_utilities ... ...nitc::nitni_utilities->nitc::nitni_utilities nitc::c c nitc::c->nitc::light_c nitc::light_ffi light_ffi nitc::light_ffi->nitc::light_c nitc::header_dependency header_dependency nitc::header_dependency->nitc::c nitc::pkgconfig pkgconfig nitc::pkgconfig->nitc::c nitc::cpp cpp nitc::cpp->nitc::c nitc::objc objc nitc::objc->nitc::c nitc::header_dependency... ... nitc::header_dependency...->nitc::header_dependency nitc::pkgconfig... ... nitc::pkgconfig...->nitc::pkgconfig nitc::cpp... ... nitc::cpp...->nitc::cpp nitc::objc... ... nitc::objc...->nitc::objc nitc::ffi ffi nitc::ffi->nitc::light_ffi nitc::light light nitc::light->nitc::light_ffi nitc::ffi... ... nitc::ffi...->nitc::ffi nitc::light... ... nitc::light...->nitc::light

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.
module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters
module annotation

nitc :: annotation

Management and utilities on annotations
module array

core :: array

This module introduces the standard array structure.
module bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
module c_tools

nitc :: c_tools

provides tools to write C .c and .h files
module caching

serialization :: caching

Services for caching serialization engines
module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.
module codec_base

core :: codec_base

Base for codecs to use with streams
module codecs

core :: codecs

Group module for all codec-related manipulations
module collection

core :: collection

This module define several collection classes.
module console

console :: console

Defines some ANSI Terminal Control Escape Sequences.
module core

core :: core

Standard classes and methods used by default by Nit programs and libraries.
module digraph

graph :: digraph

Implementation of directed graphs, also called digraphs.
module engine_tools

serialization :: engine_tools

Advanced services for serialization engines
module environ

core :: environ

Access to the environment variables of the process
module error

core :: error

Standard error-management infrastructure.
module exec

core :: exec

Invocation and management of operating system sub-processes.
module file

core :: file

File manipulations (create, read, write, etc.)
module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision
module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints
module flat

core :: flat

All the array-based text representations
module gc

core :: gc

Access to the Nit internal garbage collection mechanism
module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.
module ini

ini :: ini

Read and write INI configuration files
module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information
module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module kernel

core :: kernel

Most basic classes and methods.
module lexer

nitc :: lexer

Lexer and its tokens.
module lexer_work

nitc :: lexer_work

Internal algorithm and data structures for the Nit lexer
module list

core :: list

This module handle double linked lists
module literal

nitc :: literal

Parsing of literal values in the abstract syntax tree.
module loader

nitc :: loader

Loading of Nit source files
module location

nitc :: location

Nit source-file and locations in source-file
module math

core :: math

Mathematical operations
module mdoc

nitc :: mdoc

Documentation of model entities
module meta

meta :: meta

Simple user-defined meta-level to manipulate types of instances as object.
module mmodule

nitc :: mmodule

modules and module hierarchies in the metamodel
module mmodule_data

nitc :: mmodule_data

Define and retrieve data in modules
module model

nitc :: model

Classes, types and properties
module model_base

nitc :: model_base

The abstract concept of model and related common things
module modelbuilder_base

nitc :: modelbuilder_base

Load nit source files and build the associated model
module modelize_class

nitc :: modelize_class

Analysis and verification of class definitions to instantiate model element
module more_collections

more_collections :: more_collections

Highly specific, but useful, collections-related classes.
module mpackage

nitc :: mpackage

Modelisation of a Nit package
module native

core :: native

Native structures for text and bytes
module nitni_base

nitc :: nitni_base

Native interface related services (used underneath the FFI)
module nitpm_shared

nitc :: nitpm_shared

Services related to the Nit package manager
module numeric

core :: numeric

Advanced services for Numeric types
module opts

opts :: opts

Management of options on the command line
module ordered_tree

ordered_tree :: ordered_tree

Manipulation and presentation of ordered trees.
module parser

nitc :: parser

Parser.
module parser_nodes

nitc :: parser_nodes

AST nodes of the Nit language
module parser_prod

nitc :: parser_prod

Production AST nodes full definition.
module parser_work

nitc :: parser_work

Internal algorithm and data structures for the Nit parser
module phase

nitc :: phase

Phases of the processing of nit programs
module poset

poset :: poset

Pre order sets and partial order set (ie hierarchies)
module protocol

core :: protocol

module queue

core :: queue

Queuing data structures and wrappers
module range

core :: range

Module for range of discrete objects.
module re

core :: re

Regular expression support for all services based on Pattern
module ropes

core :: ropes

Tree-based representation of a String.
module serialization

serialization :: serialization

General serialization services
module serialization_core

serialization :: serialization_core

Abstract services to serialize Nit objects to different formats
module sorter

core :: sorter

This module contains classes used to compare things and sorts arrays.
module stream

core :: stream

Input and output streams of characters
module tables

nitc :: tables

Module that interfaces the parsing tables.
module template

template :: template

Basic template system
module text

core :: text

All the classes and methods related to the manipulation of text entities
module time

core :: time

Management of time and dates
module toolcontext

nitc :: toolcontext

Common command-line tool infrastructure than handle options and error messages
module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure
module utf8

core :: utf8

Codec for UTF-8 I/O
module version

nitc :: version

This file was generated by git-gen-version.sh

Parents

module light_ffi_base

nitc :: light_ffi_base

Tools and utilities for implement FFI with different languages
module modelize_property

nitc :: modelize_property

Analysis and verification of property definitions to instantiate model element

Children

module c

nitc :: c

Support for nesting C code within a Nit program using its FFI
module light_ffi

nitc :: light_ffi

Light FFI support, independent of the compiler

Descendants

module a_star-m

a_star-m

module abstract_compiler

nitc :: abstract_compiler

Abstract compiler
module android

nitc :: android

Compile program for the Android platform
module c_compiler_options

nitc :: c_compiler_options

Offers the annotations cflags and ldflags to specify
module compiler

nitc :: compiler

Compilation to C
module compiler_ffi

nitc :: compiler_ffi

Full FFI support for the compiler
module compiler_serialization

nitc :: compiler_serialization

Serialization support for the compiler
module cpp

nitc :: cpp

Supports the use of the C++ language through the FFI
module dynamic_loading_ffi

nitc :: dynamic_loading_ffi

Execute FFI code by creating and loading shared libraries
module emscripten

nitc :: emscripten

Compile to JavaScript using the Emscripten SDK
module extra_java_files

nitc :: extra_java_files

Intro the annotation extra_java_files to compile extra java files
module ffi

nitc :: ffi

Full FFI support, independent of the compiler
module global_compiler

nitc :: global_compiler

Global compilation of a Nit program
module header_dependency

nitc :: header_dependency

Tracks which modules has public header code that must be imported
module interpreter

nitc :: interpreter

Interpretation of Nit programs
module ios

nitc :: ios

Compile programs for the iOS platform
module java

nitc :: java

FFI support for the Java language
module light

nitc :: light

Light FFI support for the compiler
module light_only

nitc :: light_only

Compiler support for the light FFI only, detects unsupported usage of callbacks
module memory_logger

nitc :: memory_logger

Extension to inject memory-tracing instrumentation in code generated by nitc.
module nit

nitc :: nit

A naive Nit interpreter
module nitc

nitc :: nitc

A Nit compiler
module nith

nitc :: nith

A ligHt Nit compiler
module objc

nitc :: objc

FFI support for Objective-C
module on_demand_compiler

nitc :: on_demand_compiler

Compiles extern code within a module to a static library, as needed
module pkgconfig

nitc :: pkgconfig

Offers the PkgconfigPhase to use the external program "pkg-config" in order
module separate_compiler

nitc :: separate_compiler

Separate compilation of a Nit program
module separate_erasure_compiler

nitc :: separate_erasure_compiler

Separate compilation of a Nit program with generic type erasure
module test_astbuilder

nitc :: test_astbuilder

Program used to test the clone method of the astbuilder tool
module xcode_templates

nitc :: xcode_templates

Templates and other services to create XCode projects
# Support for nesting C code within a Nit program using its FFI
module light_c

import modelize::modelize_property

import light_ffi_base

redef class FFILanguageAssignationPhase
	var c_language: FFILanguage = new CLanguage(self)
end

class CLanguage
	super FFILanguage

	redef fun identify_language(n) do return n.is_c

	redef fun compile_module_block(block, ecc, mmodule)
	do
		if block.is_c_header then
			ecc.header_custom.add block.location.as_line_pragma
			ecc.header_custom.add "\n"
			ecc.header_custom.add block.code
		else if block.is_c_body then
			ecc.body_impl.add block.location.as_line_pragma
			ecc.body_impl.add "\n"
			ecc.body_impl.add block.code
		end
	end

	redef fun compile_extern_method(block, m, ecc, mmodule)
	do
		var fc = new ExternCFunction(m, mmodule)
		fc.decls.add( block.location.as_line_pragma )
		fc.exprs.add( block.code )
		ecc.body_impl.add fc.to_writer
	end

	redef fun compile_extern_class(block, m, ecc, mmodule) do end

	redef fun get_ftype(block, m) do return new ForeignCType(block.code)
end

redef class AExternCodeBlock
	fun is_c: Bool do return language_name == null or
		language_name_lowered == "c" or language_name_lowered.has_prefix( "c " )

	fun is_c_body: Bool do return language_name == null or
		language_name_lowered == "c" or language_name_lowered ==  "c body"

	fun is_c_header: Bool do return language_name_lowered == "c header"
end

redef class Location
	fun as_line_pragma: String do return "#line {line_start-1} \"{file.filename}\"\n"
end

redef class MModule
	# FIXME make nullable the key of `cflags`, `ldflags` and `cppflags` when
	# supported by the bootstrap

	# Custom options for the C compiler (CFLAGS)
	var cflags = new MultiHashMap[String, String]

	# Custom options for the C linker (LDFLAGS)
	var ldflags = new MultiHashMap[String, String]

	# Additional libraries needed for the compilation
	# Will be used with pkg-config
	var pkgconfigs = new Array[String]
end

class ForeignCType
	super ForeignType

	redef var ctype: String
end

# Context when calling user C code from generated code
fun to_c_call_context: ToCCallContext do return once new ToCCallContext

# Context when calling generated code from user C code
fun from_c_call_context: FromCCallContext do return once new FromCCallContext

# Context when calling user C code from generated code
class ToCCallContext
	super CallContext

	# TODO: private init because singleton instance (see `to_c_call_context`)

	redef fun name_mtype(mtype)
	do
		if mtype isa MClassType and mtype.mclass.kind == extern_kind then return "void *"
		return mtype.cname
	end
end

# Context when calling generated code from user C code
class FromCCallContext
	super CallContext

	# TODO: private init because singleton instance (see `from_c_call_context`)

	redef fun name_mtype(mtype) do return mtype.cname
end

class ExternCFunction
	super CFunction

	var method: AMethPropdef

	init (method: AMethPropdef, mmodule: MModule)
	do
		self.method = method

		var recv_mtype = method.mpropdef.mclassdef.bound_mtype
		var csignature = method.mpropdef.mproperty.build_csignature(recv_mtype, mmodule, "___impl", long_signature, from_c_call_context)

		super( csignature )
	end
end
src/ffi/light_c.nit:17,1--136,3