ON THIS PAGE
Term input from strings
Author(s): Francisco Bueno, Daniel Cabeza, Manuel Hermenegildo, Jose F. Morales.
This module implements predicates for reading (parsing) terms from strings or atom codes.
Usage and interface
- Library usage:
:- use_module(library(read_from_string)). - Exports:
Documentation on exports
Usage:read_from_string(String,Term)
Read a term Term from String.
- The following properties should hold at call time:
(term_typing:nonvar/1)String is currently a term which is not a free variable.
(term_typing:var/1)Term is a free variable.
Usage:read_from_string(String,Term,Rest)
Read a term Term from String up to Rest (which is the non-parsed rest of the list).
- The following properties should hold at call time:
(term_typing:nonvar/1)String is currently a term which is not a free variable.
(term_typing:var/1)Term is a free variable.
Usage:read_from_string_opts(String,Term,Rest,Opts)
String is parsed into Term up to Rest (which is the non-parsed rest of the list). The options in Opts can be:
- variable_names(Ns)
- Read variable names in Ns.
- The following properties should hold at call time:
(term_typing:nonvar/1)String is currently a term which is not a free variable.
(term_typing:var/1)Term is a free variable.
(term_typing:nonvar/1)Opts is currently a term which is not a free variable.
Usage:read_from_string_atmvars(String,Term)
Read a term Term from String. Variables are converted to atoms with the name of the variable. It there is some rest of the string left after parsing the term, it is ignored (see read_from_string_atmvars/3).
- The following properties should hold at call time:
(term_typing:nonvar/1)String is currently a term which is not a free variable.
(term_typing:var/1)Term is a free variable.
Usage:read_from_string_atmvars(String,Term,Rest)
Read a term Term from String up to Rest (which is the non-parsed rest of the list). Unquoted uppercase identifiers (variables) are read as atoms instead of variables (thus, the read term is always ground).
- The following properties should hold at call time:
(term_typing:nonvar/1)String is currently a term which is not a free variable.
(term_typing:var/1)Term is a free variable.
Usage:read_from_atom_atmvars(Atom,Term)
Like read_from_string_atmvars/2, but reads the term Term from the atom codes in Atom.
- The following properties should hold at call time:
(term_typing:nonvar/1)Atom is currently a term which is not a free variable.
(term_typing:var/1)Term is a free variable.
Usage:read_from_atom(Atom,Term)
Read the term Term from the codes in the name of Atom.
- The following properties should hold at call time:
(term_typing:nonvar/1)Atom is currently a term which is not a free variable.
(term_typing:var/1)Term is a free variable.
Documentation on imports
This module has the following direct dependencies:- System library modules:
dict, read, operators, port_reify. - Packages:
prelude, initial, condcomp, assertions, assertions/assertions_basic, basicmodes.