[ library(source_processor) | The ECLiPSe Libraries | Reference Manual | Alphabetic Index ]

source_open(+File, +OptionList, -SourcePos)

Open an ECLiPSe source code file for subsequent processing

File: Name of source file (Atom or string)
OptionList: List of options, possibly empty
SourcePos: Source position handle

Description

This predicates opens an ECLiPSe source file for subsequent reading with source_read/4. Compared to the standard primitives for reading from a file, this takes care of

nesting of included files
creating and keeping track of modules
syntax settings
comments (optional)
changing the current directory to the opened file's directory

OptionList can contain the following:

keep_comments: treat comments and spacing between source terms as data rather than ignoring it
no_macro_expansion: do not expand term macros (e.g. with/2 and of/2)
no_clause_expansion: do not expand clause macros (e.g. DCGs)
recreate_modules: erase and re-create module when encountering a module directive

source_open/3 and source_read/4 maintain a 'current source position', which is a structure containing (among others) the following fields:

    :- export struct(source_position(
	stream,			% Eclipse stream
	file,			% canonical file name
	line,			% integer
	offset,			% integer
	included_from,		% source_position or []
	module,			% current source module
	...
    )).

i.e. information about the module context and the precise location of a source term (e.g. for error messages).

source_open(+File, +OptionList, -SourcePos)

Description

See Also