generator_util (library)

Author(s): Göran Smedbäck.

Usage and interface (`generator_util`)

Library usage: :- use_module(library(generator_util)).
Exports:
- Predicates: reading/4, reading/5, reading/6, open_node/6, close_node/5, close_nodeGut/4, open_PROTO/4, close_PROTO/6, open_EXTERNPROTO/5, close_EXTERNPROTO/6, open_DEF/5, close_DEF/5, open_Script/5, close_Script/5, decompose_field/3, indentation_list/2, start_vrmlScene/4, remove_comments/4.
Other modules used:
- System library modules: provrml/error, lists, provrml/io, provrml/field_value, provrml/field_value_check, provrml/lookup, provrml/parser_util.

PREDICATE: reading/4:

Usage 1: reading(IS, NodeTypeId, ParseIn, ParseOut)

Description: This predicate will refer to a formerly introduced interface. We do a checkup of the access type and output the values.
Call and exit should be compatible with: IS is an atom. (basic_props:atm/1) NodeTypeId is an atom. (basic_props:atm/1) ParseIn is a parse structure. (internal_types:parse/1) ParseOut is a parse structure. (internal_types:parse/1)
The following properties should hold at call time: IS is currently a term which is not a free variable. (term_typing:nonvar/1) NodeTypeId is currently a term which is not a free variable. (term_typing:nonvar/1) ParseIn is currently a term which is not a free variable. (term_typing:nonvar/1) ParseOut is a free variable. (term_typing:var/1)

Usage 2: reading(NodeGut, NodeName, ParseIn, ParseOut)

Description: This predicate will read a node gut and will check the field according to the name.
Call and exit should be compatible with: NodeGut is an atom. (basic_props:atm/1) NodeName is an atom. (basic_props:atm/1) ParseIn is a parse structure. (internal_types:parse/1) ParseOut is a parse structure. (internal_types:parse/1)
The following properties should hold at call time: NodeGut is currently a term which is not a free variable. (term_typing:nonvar/1) NodeName is currently a term which is not a free variable. (term_typing:nonvar/1) ParseIn is currently a term which is not a free variable. (term_typing:nonvar/1) ParseOut is a free variable. (term_typing:var/1)

PREDICATE: reading/5:: No further documentation available for this predicate.

PREDICATE: reading/6:: No further documentation available for this predicate.

PREDICATE: open_node/6:: No further documentation available for this predicate.

PREDICATE: close_node/5:: No further documentation available for this predicate.

PREDICATE: close_nodeGut/4:: No further documentation available for this predicate.

PREDICATE: open_PROTO/4:: No further documentation available for this predicate.

PREDICATE: close_PROTO/6:: No further documentation available for this predicate.

PREDICATE: open_EXTERNPROTO/5:: No further documentation available for this predicate.

PREDICATE: close_EXTERNPROTO/6:: No further documentation available for this predicate.

PREDICATE: open_DEF/5:: No further documentation available for this predicate.

PREDICATE: close_DEF/5:: No further documentation available for this predicate.

PREDICATE: open_Script/5:: No further documentation available for this predicate.

PREDICATE: close_Script/5:: No further documentation available for this predicate.

PREDICATE: decompose_field/3:: No further documentation available for this predicate.

PREDICATE: indentation_list/2:

Usage: indentation_list(Parse, IndList)

Description: This predcate will construct a list with indentations to be output before text. The information of the indentations is inside the parse structure.
Call and exit should be compatible with: Parse is a parse structure. (internal_types:parse/1) IndList is a list of atms. (basic_props:list/2)
The following properties should hold at call time: Parse is currently a term which is not a free variable. (term_typing:nonvar/1) IndList is a free variable. (term_typing:var/1)

PREDICATE: start_vrmlScene/4:: No further documentation available for this predicate.

PREDICATE: remove_comments/4:

Usage: remove_comments(Value, CommentsBefore, ValueClean, CommentsAfter)

Description: The predicate will remove comments and return the comments before and after the pure value.
Call and exit should be compatible with: Value is a list of atms. (basic_props:list/2) CommentsBefore is a list of atms. (basic_props:list/2) ValueClean is an atom. (basic_props:atm/1) CommentsAfter is a list of atms. (basic_props:list/2)
The following properties should hold at call time: Value is currently a term which is not a free variable. (term_typing:nonvar/1) CommentsBefore is a free variable. (term_typing:var/1) ValueClean is a free variable. (term_typing:var/1) CommentsAfter is a free variable. (term_typing:var/1)