Input/Output of LTL formulae
[Algorithms for LTL formulae]

Classes
class	spot::ltl::random_ltl
	Generate random LTL formulae. More...
Typedefs
typedef std::pair< ltlyy::location, std::string >	spot::ltl::parse_error
	A parse diagnostic with its location.
typedef std::list< parse_error >	spot::ltl::parse_error_list
	A list of parser diagnostics, as filled by parse.
Functions
formula *	spot::ltl::parse (const std::string &ltl_string, parse_error_list &error_list, environment &env=default_environment::instance(), bool debug=false)
	Build a formula from an LTL string.
bool	spot::ltl::format_parse_errors (std::ostream &os, const std::string &ltl_string, parse_error_list &error_list)
	Format diagnostics produced by spot::ltl::parse.
std::ostream &	spot::ltl::dotty (std::ostream &os, const formula *f)
	Write a formula tree using dot's syntax.
std::ostream &	spot::ltl::dump (std::ostream &os, const formula *f)
	Dump a formula tree.
std::ostream &	spot::ltl::to_string (const formula *f, std::ostream &os)
	Output a formula as a (parsable) string.
std::string	spot::ltl::to_string (const formula *f)
	Convert a formula into a (parsable) string.
std::ostream &	spot::ltl::to_spin_string (const formula *f, std::ostream &os)
	Output a formula as a (parsable by Spin) string.
std::string	spot::ltl::to_spin_string (const formula *f)
	Convert a formula into a (parsable by Spin) string.

---

Typedef Documentation

typedef std::pair<ltlyy::location, std::string> spot::ltl::parse_error

A parse diagnostic with its location.

typedef std::list<parse_error> spot::ltl::parse_error_list

A list of parser diagnostics, as filled by parse.

---

Function Documentation

std::ostream& spot::ltl::dotty	(	std::ostream &	os,
		const formula *	f
	)

Write a formula tree using dot's syntax.

Parameters:

	os	The stream where it should be output.
	f	The formula to translate.

dot is part of the GraphViz package http://www.research.att.com/sw/tools/graphviz/

std::ostream& spot::ltl::dump	(	std::ostream &	os,
		const formula *	f
	)

Dump a formula tree.

Parameters:

	os	The stream where it should be output.
	f	The formula to dump.

This is useful to display a formula when debugging.

bool spot::ltl::format_parse_errors	(	std::ostream &	os,
		const std::string &	ltl_string,
		parse_error_list &	error_list
	)

Format diagnostics produced by spot::ltl::parse.

Parameters:

	os	Where diagnostics should be output.
	ltl_string	The string that were parsed.
	error_list	The error list filled by spot::ltl::parse while parsing ltl_string.

Returns:

true iff any diagnostic was output.

formula* spot::ltl::parse	(	const std::string &	ltl_string,
		parse_error_list &	error_list,
		environment &	env = default_environment::instance(),
		bool	debug = false
	)

Build a formula from an LTL string.

Parameters:

	ltl_string	The string to parse.
	error_list	A list that will be filled with parse errors that occured during parsing.
	env	The environment into which parsing should take place.
	debug	When true, causes the parser to trace its execution.

Returns:

A pointer to the formula built from ltl_string, or 0 if the input was unparsable.

Note that the parser usually tries to recover from errors. It can return an non zero value even if it encountered error during the parsing of ltl_string. If you want to make sure ltl_string was parsed succesfully, check error_list for emptiness.

Warning:

This function is not reentrant.

std::string spot::ltl::to_spin_string

(

const formula *

f

)

Convert a formula into a (parsable by Spin) string.

Parameters:

f

The formula to translate.

std::ostream& spot::ltl::to_spin_string	(	const formula *	f,
		std::ostream &	os
	)

Output a formula as a (parsable by Spin) string.

Parameters:

	f	The formula to translate.
	os	The stream where it should be output.

std::string spot::ltl::to_string

(

const formula *

f

)

Convert a formula into a (parsable) string.

Parameters:

f

The formula to translate.

std::ostream& spot::ltl::to_string	(	const formula *	f,
		std::ostream &	os
	)

Output a formula as a (parsable) string.

Parameters:

	f	The formula to translate.
	os	The stream where it should be output.

---

Please comment this page and report errors about it on the RefDocComments page.