Foreign Language Interface Builder

Author(s): Jose Morales, Manuel Carro.

Version: 1.11#222 (2004/5/24, 13:8:7 CEST)

Version of last change: 1.11#218 (2004/4/13, 18:31:33 CEST)

Low-level utilities for building foreign interfaces. End-users should not need to use them, as the Ciao Prolog Compiler reads the user assertions and calls appropriately the predicates in this module.

• Usage and interface (build_foreign_interface)
• Documentation on exports (build_foreign_interface)

Usage and interface (build_foreign_interface)

Documentation on exports (build_foreign_interface)

PREDICATE: build_foreign_interface/1:

Usage: build_foreign_interface(File)

• Description: Reads assertions from File, generates the gluecode for the Ciao Prolog interface, compiles the foreign files and the gluecode file, and links everything in a shared object. Checks modification times to determine automatically which files must be generated/compiled/linked.
• Call and exit should be compatible with: File is a source name. (streams_basic:sourcename/1)
• The following properties should hold at call time: File is currently ground (it contains no variables). (term_typing:ground/1)
• The following properties should hold upon exit: File is currently ground (it contains no variables). (term_typing:ground/1)

PREDICATE: rebuild_foreign_interface/1:

Usage: rebuild_foreign_interface(File)

• Description: Like build_foreign_interface/1, but it does not check the modification time of any file.
• Call and exit should be compatible with: File is a source name. (streams_basic:sourcename/1)
• The following properties should hold at call time: File is currently ground (it contains no variables). (term_typing:ground/1)
• The following properties should hold upon exit: File is currently ground (it contains no variables). (term_typing:ground/1)

PREDICATE: build_foreign_interface_explicit_decls/2:

Usage: build_foreign_interface_explicit_decls(File, Decls)

• Description: Like build_foreign_interface/1, but use declarations in Decls instead of reading the declarations from File.
• Call and exit should be compatible with: File is a source name. (streams_basic:sourcename/1) Decls is a list of terms. (basic_props:list/2)
• The following properties should hold at call time: File is currently ground (it contains no variables). (term_typing:ground/1) Decls is currently ground (it contains no variables). (term_typing:ground/1)
• The following properties should hold upon exit: File is currently ground (it contains no variables). (term_typing:ground/1) Decls is currently ground (it contains no variables). (term_typing:ground/1)

PREDICATE: rebuild_foreign_interface_explicit_decls/2:

Usage: rebuild_foreign_interface_explicit_decls(File, Decls)

• Description: Like build_foreign_interface_explicit_decls/1, but it does not check the modification time of any file.
• Call and exit should be compatible with: File is a source name. (streams_basic:sourcename/1) Decls is a list of terms. (basic_props:list/2)
• The following properties should hold at call time: File is currently ground (it contains no variables). (term_typing:ground/1) Decls is currently ground (it contains no variables). (term_typing:ground/1)
• The following properties should hold upon exit: File is currently ground (it contains no variables). (term_typing:ground/1) Decls is currently ground (it contains no variables). (term_typing:ground/1)

PREDICATE: build_foreign_interface_object/1:

Usage: build_foreign_interface_object(File)

• Description: Compiles the gluecode file with the foreign source files producing an unique object file.
• Call and exit should be compatible with: File is a source name. (streams_basic:sourcename/1)
• The following properties should hold at call time: File is currently ground (it contains no variables). (term_typing:ground/1)
• The following properties should hold upon exit: File is currently ground (it contains no variables). (term_typing:ground/1)

PREDICATE: rebuild_foreign_interface_object/1:

Usage: rebuild_foreign_interface_object(File)

• Description: Compiles (again) the gluecode file with the foreign source files producing an unique object file.
• Call and exit should be compatible with: File is a source name. (streams_basic:sourcename/1)
• The following properties should hold at call time: File is currently ground (it contains no variables). (term_typing:ground/1)
• The following properties should hold upon exit: File is currently ground (it contains no variables). (term_typing:ground/1)

PREDICATE: do_interface/1:

Usage: do_interface(Decls)

• Description: Given the declarations in Decls, this predicate succeeds if these declarations involve the creation of the foreign interface
• Call and exit should be compatible with: Decls is a list of terms. (basic_props:list/2)
• The following properties should hold at call time: Decls is currently ground (it contains no variables). (term_typing:ground/1)
• The following properties should hold upon exit: Decls is currently ground (it contains no variables). (term_typing:ground/1)

Go to the first, previous, next, last section, table of contents.