contents index next

15. fsa_globals: Global Variables

This section lists the predicates of the fsa_globals module. This module maintains a number of global variables for FSA. These variables are maintained using the blackboard primitives of SICStus; all variables live in the fsa module.

15.1. List of Predicates

This section lists the predicates defined by this module.

15.1.1. fsa_global_set(+Key,?Val)

Predicate to set the global variable with name Key to *Val*.

15.1.2. fsa_global_get(+Key,?Val)

Predicate to query the value of the global variable with name *Key*. If the value is undefined then Val is unified to a default value. These default values are available as the third argument of the fsa_global_decl predicate.

15.1.3. fsa_global_decl(?Key,?Help,?Default,?Typical,Val^Goal)

Key is a global variable with default value *Default*. Some typical values are given in the list *Typical*. Help is a string explaining the variable. Val^Goal can be used to check that Val is an appropriate value for this flag.

15.1.4. fsa_global_list[-List]

List will be unified with a keylist of all the global variables with their associated values. If no argument is given, then this list is written to standard output

15.1.5. fsa_version

FSA version information is displayed on standard error. Note that the version information is available through the fsa_version global variable.

15.1.6. fsa_host_prolog(?Atom)

Atom is an atom indicating the current Prolog system. At the moment Atom is one of *sicstus*, *yap*, or *swi*.

contents index next