Implements the language interface for the Statement List language. More...

#include <statement_list_language.h>

Inheritance diagram for statement_list_languaget:

Collaboration diagram for statement_list_languaget:

Public Member Functions
void	set_language_options (const optionst &options) override
	Sets language specific options. More...

bool	parse (std::istream &instream, const std::string &path) override
	Parses input given by `instream` and saves this result to this instance's parse tree. More...

bool	generate_support_functions (symbol_tablet &symbol_table) override
	Currently unused. More...

bool	typecheck (symbol_tablet &symbol_table, const std::string &module, const bool keep_file_local) override
	Converts the current parse tree into a symbol table. More...

bool	typecheck (symbol_tablet &symbol_table, const std::string &module) override

bool	can_keep_file_local () override
	Is it possible to call three-argument typecheck() on this object? More...

void	show_parse (std::ostream &out) override
	Prints the parse tree to the given output stream. More...

	~statement_list_languaget () override

	statement_list_languaget ()

bool	from_expr (const exprt &expr, std::string &code, const namespacet &ns) override
	Formats the given expression in a language-specific way. More...

bool	from_type (const typet &type, std::string &code, const namespacet &ns) override
	Formats the given type in a language-specific way. More...

bool	type_to_name (const typet &type, std::string &name, const namespacet &ns) override
	Encodes the given type in a language-specific way. More...

bool	to_expr (const std::string &code, const std::string &module, exprt &expr, const namespacet &ns) override
	Parses the given string into an expression. More...

std::unique_ptr< languaget >	new_language () override

std::string	id () const override

std::string	description () const override

std::set< std::string >	extensions () const override

void	modules_provided (std::set< std::string > &modules) override

Public Member Functions inherited from languaget
virtual bool	preprocess (std::istream &instream, const std::string &path, std::ostream &outstream)

virtual void	dependencies (const std::string &module, std::set< std::string > &modules)

virtual void	methods_provided (std::unordered_set< irep_idt > &methods) const
	Should fill `methods` with the symbol identifiers of all methods this `languaget` can provide a body for, but doesn't populate that body in languaget::typecheck (i.e. More...

virtual void	convert_lazy_method (const irep_idt &function_id, symbol_table_baset &symbol_table)
	Requests this `languaget` should populate the body of method `function_id` in `symbol_table`. More...

virtual bool	final (symbol_table_baset &symbol_table)
	Final adjustments, e.g. More...

virtual bool	interfaces (symbol_tablet &symbol_table)

	languaget ()

virtual	~languaget ()

Public Member Functions inherited from messaget
virtual void	set_message_handler (message_handlert &_message_handler)

message_handlert &	get_message_handler ()

	messaget ()

	messaget (const messaget &other)

messaget &	operator= (const messaget &other)

	messaget (message_handlert &_message_handler)

virtual	~messaget ()

mstreamt &	get_mstream (unsigned message_level) const

mstreamt &	error () const

mstreamt &	warning () const

mstreamt &	result () const

mstreamt &	status () const

mstreamt &	statistics () const

mstreamt &	progress () const

mstreamt &	debug () const

void	conditional_output (mstreamt &mstream, const std::function< void(mstreamt &)> &output_generator) const
	Generate output to `message_stream` using `output_generator` if the configured verbosity is at least as high as that of `message_stream`. More...

Private Attributes
statement_list_parse_treet	parse_tree

std::string	parse_path

object_factory_parameterst	params

Additional Inherited Members
Public Types inherited from messaget
enum	message_levelt { M_ERROR =1, M_WARNING =2, M_RESULT =4, M_STATUS =6, M_STATISTICS =8, M_PROGRESS =9, M_DEBUG =10 }

Static Public Member Functions inherited from messaget
static unsigned	eval_verbosity (const std::string &user_input, const message_levelt default_verbosity, message_handlert &dest)
	Parse a (user-)provided string as a verbosity level and set it as the verbosity of dest. More...

static commandt	command (unsigned c)
	Create an ECMA-48 SGR (Select Graphic Rendition) command. More...

Static Public Attributes inherited from messaget
static eomt	eom

static const commandt	reset
	return to default formatting, as defined by the terminal More...

static const commandt	red
	render text with red foreground color More...

static const commandt	green
	render text with green foreground color More...

static const commandt	yellow
	render text with yellow foreground color More...

static const commandt	blue
	render text with blue foreground color More...

static const commandt	magenta
	render text with magenta foreground color More...

static const commandt	cyan
	render text with cyan foreground color More...

static const commandt	bright_red
	render text with bright red foreground color More...

static const commandt	bright_green
	render text with bright green foreground color More...

static const commandt	bright_yellow
	render text with bright yellow foreground color More...

static const commandt	bright_blue
	render text with bright blue foreground color More...

static const commandt	bright_magenta
	render text with bright magenta foreground color More...

static const commandt	bright_cyan
	render text with bright cyan foreground color More...

static const commandt	bold
	render text with bold font More...

static const commandt	faint
	render text with faint font More...

static const commandt	italic
	render italic text More...

static const commandt	underline
	render underlined text More...

Protected Attributes inherited from messaget
message_handlert *	message_handler

mstreamt	mstream

Detailed Description

Implements the language interface for the Statement List language.

Includes functions for parsing input streams and for converting the resulting parse tree into a symbol table.

Definition at line 23 of file statement_list_language.h.

Constructor & Destructor Documentation

◆ ~statement_list_languaget()

statement_list_languaget::~statement_list_languaget ( )

override

Definition at line 130 of file statement_list_language.cpp.

◆ statement_list_languaget()

statement_list_languaget::statement_list_languaget ( )

Definition at line 126 of file statement_list_language.cpp.

Member Function Documentation

◆ can_keep_file_local()

bool statement_list_languaget::can_keep_file_local ( )

overridevirtual

Is it possible to call three-argument typecheck() on this object?

Reimplemented from languaget.

Definition at line 79 of file statement_list_language.cpp.

◆ description()

std::string statement_list_languaget::description ( ) const

overridevirtual

Implements languaget.

Definition at line 160 of file statement_list_language.cpp.

◆ extensions()

std::set< std::string > statement_list_languaget::extensions ( ) const

overridevirtual

Implements languaget.

Definition at line 140 of file statement_list_language.cpp.

◆ from_expr()

bool statement_list_languaget::from_expr	(	const exprt &	expr,
		std::string &	code,
		const namespacet &	ns
	)

overridevirtual

Formats the given expression in a language-specific way.

Parameters

expr	the expression to format
code	the formatted expression
ns	a namespace

Returns: false if conversion succeeds

Reimplemented from languaget.

Definition at line 91 of file statement_list_language.cpp.

◆ from_type()

bool statement_list_languaget::from_type	(	const typet &	type,
		std::string &	code,
		const namespacet &	ns
	)

overridevirtual

Formats the given type in a language-specific way.

Parameters

type	the type to format
code	the formatted type
ns	a namespace

Returns: false if conversion succeeds

Reimplemented from languaget.

Definition at line 100 of file statement_list_language.cpp.

◆ generate_support_functions()

bool statement_list_languaget::generate_support_functions ( symbol_tablet & symbol_table )

overridevirtual

Currently unused.

Implements languaget.

Definition at line 30 of file statement_list_language.cpp.

◆ id()

std::string statement_list_languaget::id ( ) const

overridevirtual

Implements languaget.

Definition at line 155 of file statement_list_language.cpp.

◆ modules_provided()

void statement_list_languaget::modules_provided ( std::set< std::string > & modules )

overridevirtual

Reimplemented from languaget.

Definition at line 135 of file statement_list_language.cpp.

◆ new_language()

std::unique_ptr< languaget > statement_list_languaget::new_language ( )

overridevirtual

Implements languaget.

Definition at line 150 of file statement_list_language.cpp.

◆ parse()

bool statement_list_languaget::parse	(	std::istream &	instream,
		const std::string &	path
	)

overridevirtual

Parses input given by instream and saves this result to this instance's parse tree.

Parameters

instream	Input to parse.
path	Path of the input.

Returns: False if successful.

Implements languaget.

Definition at line 56 of file statement_list_language.cpp.

◆ set_language_options()

void statement_list_languaget::set_language_options ( const optionst & options )

overridevirtual

Sets language specific options.

Parameters

options Options that shall apply during the parse and typecheck process.

Reimplemented from languaget.

Definition at line 25 of file statement_list_language.cpp.

◆ show_parse()

void statement_list_languaget::show_parse ( std::ostream & out )

overridevirtual

Prints the parse tree to the given output stream.

Implements languaget.

Definition at line 74 of file statement_list_language.cpp.

◆ to_expr()

bool statement_list_languaget::to_expr	(	const std::string &	code,
		const std::string &	module,
		exprt &	expr,
		const namespacet &	ns
	)

overridevirtual

Parses the given string into an expression.

Parameters

code	the string to parse
module	prefix to be used for identifiers
expr	the parsed expression
ns	a namespace

Returns: false if the conversion succeeds

Implements languaget.

Definition at line 117 of file statement_list_language.cpp.

◆ type_to_name()

bool statement_list_languaget::type_to_name	(	const typet &	type,
		std::string &	name,
		const namespacet &	ns
	)

overridevirtual

Encodes the given type in a language-specific way.

Parameters

type	the type to encode
name	the encoded type
ns	a namespace

Returns: false if the conversion succeeds

Reimplemented from languaget.

Definition at line 109 of file statement_list_language.cpp.

◆ typecheck() [1/2]

bool statement_list_languaget::typecheck	(	symbol_tablet &	symbol_table,
		const std::string &	module
	)

overridevirtual

Implements languaget.

Definition at line 84 of file statement_list_language.cpp.

◆ typecheck() [2/2]

bool statement_list_languaget::typecheck	(	symbol_tablet &	symbol_table,
		const std::string &	module,
		const bool	keep_file_local
	)

overridevirtual

Converts the current parse tree into a symbol table.

Parameters

[out]	symbol_table	Object that shall be filled by this function. If the symbol table is not empty when calling this function, its contents are merged with the new entries.
	module	Name of the file that has been parsed.
	keep_file_local	Set to true if local variables of this module should be included in the table.

Returns: False if no errors occurred, true otherwise.

Reimplemented from languaget.

Definition at line 36 of file statement_list_language.cpp.

Member Data Documentation

◆ params

object_factory_parameterst statement_list_languaget::params

private

Definition at line 113 of file statement_list_language.h.

◆ parse_path

std::string statement_list_languaget::parse_path

private

Definition at line 112 of file statement_list_language.h.

◆ parse_tree

statement_list_parse_treet statement_list_languaget::parse_tree

private

Definition at line 111 of file statement_list_language.h.

The documentation for this class was generated from the following files:

/home/runner/work/cbmc-documentation/cbmc-documentation/src/statement-list/statement_list_language.h
/home/runner/work/cbmc-documentation/cbmc-documentation/src/statement-list/statement_list_language.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~statement_list_languaget()

◆ statement_list_languaget()

Member Function Documentation

◆ can_keep_file_local()

◆ description()

◆ extensions()

◆ from_expr()

◆ from_type()

◆ generate_support_functions()

◆ id()

◆ modules_provided()

◆ new_language()

◆ parse()

◆ set_language_options()

◆ show_parse()

◆ to_expr()

◆ type_to_name()

◆ typecheck() [1/2]

◆ typecheck() [2/2]

Member Data Documentation

◆ params

◆ parse_path

◆ parse_tree