#include <json_symtab_language.h>

Inheritance diagram for json_symtab_languaget:

Collaboration diagram for json_symtab_languaget:

Public Member Functions
bool	parse (std::istream &instream, const std::string &path) override
	Parse a goto program in json form. More...

bool	typecheck (symbol_tablet &symbol_table, const std::string &module) override
	Typecheck a goto program in json form. More...

void	show_parse (std::ostream &out) override
	Output the result of the parsed json file to the output stream passed as a parameter to this function. More...

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

std::string	id () const override

std::string	description () const override

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

std::unique_ptr< languaget >	new_language () override

bool	generate_support_functions (symbol_tablet &symbol_table) override
	Create language-specific support functions, such as __CPROVER_start, __CPROVER_initialize and language-specific library functions. More...

	~json_symtab_languaget () override=default

Public Member Functions inherited from languaget
virtual void	set_language_options (const optionst &)
	Set language-specific options. More...

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	modules_provided (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)

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

virtual bool	typecheck (symbol_tablet &symbol_table, const std::string &module, const bool keep_file_local)
	typecheck without removing specified entries from the symbol table More...

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

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

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

	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...

Protected Attributes
jsont	parsed_json_file

Protected Attributes inherited from messaget
message_handlert *	message_handler

mstreamt	mstream

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...

Detailed Description

Definition at line 24 of file json_symtab_language.h.

Constructor & Destructor Documentation

◆ ~json_symtab_languaget()

json_symtab_languaget::~json_symtab_languaget ( )

overridedefault

Member Function Documentation

◆ description()

std::string json_symtab_languaget::description ( ) const

inlineoverridevirtual

Implements languaget.

Definition at line 45 of file json_symtab_language.h.

◆ extensions()

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

inlineoverridevirtual

Implements languaget.

Definition at line 50 of file json_symtab_language.h.

◆ generate_support_functions()

bool json_symtab_languaget::generate_support_functions ( symbol_tablet & symbol_table )

inlineoverridevirtual

Create language-specific support functions, such as __CPROVER_start, __CPROVER_initialize and language-specific library functions.

This runs after the typecheck phase but before lazy function loading. Anything that must wait until lazy function loading is done can be deferred until final, which runs after lazy function loading is complete. Functions introduced here are visible to lazy loading and can influence its decisions (e.g. picking the types of input parameters and globals), whereas anything introduced during final cannot.

Implements languaget.

Definition at line 60 of file json_symtab_language.h.

◆ id()

std::string json_symtab_languaget::id ( ) const

inlineoverridevirtual

Implements languaget.

Definition at line 41 of file json_symtab_language.h.

◆ new_language()

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

inlineoverridevirtual

Implements languaget.

Definition at line 55 of file json_symtab_language.h.

◆ parse()

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

overridevirtual

Parse a goto program in json form.

Parameters

instream	The input stream
path	A file path

Returns: boolean signifying success or failure of the parsing

Implements languaget.

Definition at line 21 of file json_symtab_language.cpp.

◆ show_parse()

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

overridevirtual

Output the result of the parsed json file to the output stream passed as a parameter to this function.

Parameters

out	The stream to use to output the parsed_json_file.

Implements languaget.

Definition at line 55 of file json_symtab_language.cpp.

◆ to_expr()

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

inlineoverridevirtual

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 35 of file json_symtab_language.h.

◆ typecheck()

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

overridevirtual

Typecheck a goto program in json form.

Parameters

symbol_table	The symbol table containing symbols read from file.
module	A useless parameter, there for interface consistency.

Returns: boolean signifying success or failure of the typechecking.

Implements languaget.

Definition at line 32 of file json_symtab_language.cpp.

Member Data Documentation

◆ parsed_json_file

jsont json_symtab_languaget::parsed_json_file

protected

Definition at line 72 of file json_symtab_language.h.

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

/home/runner/work/cbmc-documentation/cbmc-documentation/src/json-symtab-language/json_symtab_language.h
/home/runner/work/cbmc-documentation/cbmc-documentation/src/json-symtab-language/json_symtab_language.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~json_symtab_languaget()

Member Function Documentation

◆ description()

◆ extensions()

◆ generate_support_functions()

◆ id()

◆ new_language()

◆ parse()

◆ show_parse()

◆ to_expr()

◆ typecheck()

Member Data Documentation

◆ parsed_json_file