Frontend driver (monolithic)
This module provides the main entry points for loading source programs (in a suitable form for performing analysis and transformations) and print them back as source.Adding new frontend
(to be written)
Usage and interface
- Library usage:
:- use_module(ciaopp(frontend_driver)). This module is loaded by default in the CiaoPP toplevel and reexported from the ciaopp module. - Exports:
- Predicates:
supported_language/1, language_extension/2, language_output_extension/2, module/1, module/2, with_module_pp_flags/1, with_pp_flags/2, entry_assertion/3, assrt_used_as_entry/2, is_library/1, cleanup_history/0, push_history/1, pop_history/1, get_output_path/2, output/0, output/1, output/2, output_ext/1, output_by_ext/2, write_one_type/2, ensure_libcache_loaded/0, gen_and_load_libcache/0. - Multifiles:
hook_compact_global_prop/2, hook_compact_calls_prop/2, hook_native_prop/2, hook_pp_info_clause/3, hook_pp_info_lit/4, hook_print_opts/1, hook_legal_regtype/1, hook_insert_regtype/2, hook_post_init_regtypes/0, hook_cleanup_lib_regtypes/0, hook_restore_lib_regtypes/1, hook_save_lib_regtypes/1, file_search_path/2, library_directory/1.
- Predicates:
Documentation on exports
Indicates that a translation is available from language L to Ciao Prolog language.
E is an extension (including the dot) for files that must be translated from language L to Ciao.
E is the extension of the file produced as output by the Ciao printer for language L.
Usage 1:module(FileName)
Reads the code of FileName and its preprocessing unit, and sets it as the current module.
- The following properties should hold at call time:
(nonvar/1)FileName is currently a term which is not a free variable.
(sourcename/1)FileName is a source name.
Usage 2:module(FileNameList)
Reads the code of the list of file names FileNameList (and their preprocessing units), and sets them as the current modules.
Usage:module(Ms,Info)
Same as module/1 but it also prints the time required to read the module and returns extra information (including the time) on its second argument.
Usage:with_module_pp_flags(Goal)
Loads preprocessor flags set in the current module and executes Goal. Pop these flags independently of the exit status of Goal (success, failure, or exception). The predicate is expected to fail if the module preprocessor flags are not valid.
- The following properties should hold at call time:
(nonvar/1)Goal is currently a term which is not a free variable.
(cgoal/1)Goal is a term which represents a goal, i.e., an atom or a structure.
Usage:with_pp_flags(Flags,Goal)
Push preprocessor flags Flags ([flag1=val1, flag2=val2, ...]) and execute Goal. Pop these flags independently of the exit status of Goal (success, failure, or exception).
- The following properties should hold at call time:
(nonvar/1)Flags is currently a term which is not a free variable.
(nonvar/1)Goal is currently a term which is not a free variable.
(cgoal/1)Goal is a term which represents a goal, i.e., an atom or a structure.
Usage:entry_assertion(Goal,Call,Name)
There is an entry assertion for Goal with call pattern Call, uniquely identifiable by Name.
- The following properties should hold upon exit:
(cgoal/1)Goal is a term which represents a goal, i.e., an atom or a structure.
Usage:assrt_used_as_entry(Sg,AssrtType)
Assertion with head Sg and assertion type AssrtType is used as an analysis entry (depending on values of entry_points_auto and entry_calls_scope).
Usage:is_library(Base)
- The following properties should hold at call time:
(nonvar/1)Base is currently a term which is not a free variable.
Usage:
Cleanup history items.
Usage:push_history(X)
Push history item X.
- The following properties should hold at call time:
(atom/1)X is currently instantiated to an atom.
Usage:pop_history(X)
Pop history item X.
- The following properties should hold at call time:
(atom/1)X is currently instantiated to an atom.
Usage:
Outputs the current module preprocessing state with the default output options. Equivalent to output(File,[]).
Usage:output(File)
Outputs to File the current module preprocessing state with the default output options. If unbound, File is unified with a default name (encoding the preprocessing steps). Equivalent to output(File,[]).
Usage:output(File,Opts)
Outputs the current module preprocessing state to a file File. If unbound, File is unified with a default name (encoding the preprocessing steps). The output format (which should be valid for the loaded program) is guessed from the file extension. Opts is a list of options for this predicate (see output_option/1)
- The following properties should hold at call time:
(nonvar/1)Opts is currently a term which is not a free variable.
Usage:output_ext(Ext)
Extension Ext is a supported output extension.
- The following properties should hold at call time:
(atm/1)Ext is an atom.
Usage:output_by_ext(Ext,File)
Produce output File for the given extension Ext.
- The following properties should hold at call time:
(atm/1)Ext is an atom.
(sourcename/1)File is a source name.
Usage:
Ensure that the libcache is loaded (if use_libcache is enabled and the cache is generated) (see p_unit:load_libcache/1).
Documentation on multifiles
The predicate is of type dynamic.
The predicate is of type dynamic.
Documentation on imports
This module has the following direct dependencies:- Application modules:
ciaopp_log, analysis_stats, preprocess_flags, incanal, analyze_driver, intermod_ops, transform_driver, raw_printer, p_dump, prepare_ai_output, infer_db, infer_dom. - System library modules:
native_props, datafacts_rt, p_unit, p_printer, aggregates, c_translate, java_interface, annotator, sockets, unexpand, p_unit_db, lists, messages, port_reify, assrt_lib, native, typeslib, system, pathnames, pretty_print, terms, format, sort, terms_vars, formulae, stream_utils, dec10_io, write, c_assertions, process, rescostfunc. - Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basiccontrol, exceptions, term_compare, term_typing, debugger_support, basic_props, hiord_rt, internals, runtime_control, stream_basic, io_basic. - Packages:
prelude, initial, condcomp, assertions, assertions/assertions_basic, basicmodes, regtypes, nativeprops, hiord, datafacts, ciaopp(ciaopp_options), compiler/p_unit/p_unit_argnames, argnames.