Inheritance diagram for java_bytecode_parsert:

Collaboration diagram for java_bytecode_parsert:

Classes
struct	pool_entryt

Public Member Functions
	java_bytecode_parsert (bool skip_instructions)

bool	parse () override

Public Member Functions inherited from parsert
virtual void	clear ()

	parsert ()

virtual	~parsert ()

bool	read (char &ch)

bool	eof ()

void	parse_error (const std::string &message, const std::string &before)

void	inc_line_no ()

void	set_line_no (unsigned _line_no)

void	set_file (const irep_idt &file)

irep_idt	get_file () const

unsigned	get_line_no () const

unsigned	get_column () const

void	set_column (unsigned _column)

void	set_source_location (exprt &e)

void	set_function (const irep_idt &function)

void	advance_column (unsigned token_width)

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

Public Attributes
java_bytecode_parse_treet	parse_tree

Public Attributes inherited from parsert
std::istream *	in

std::string	this_line

std::string	last_line

std::vector< exprt >	stack

Private Types
using	classt = java_bytecode_parse_treet::classt

using	methodt = java_bytecode_parse_treet::methodt

using	fieldt = java_bytecode_parse_treet::fieldt

using	instructiont = java_bytecode_parse_treet::instructiont

using	annotationt = java_bytecode_parse_treet::annotationt

using	method_handle_typet = java_class_typet::method_handle_kindt

using	lambda_method_handlet = java_bytecode_parse_treet::classt::lambda_method_handlet

using	constant_poolt = std::vector< pool_entryt >

Private Member Functions
pool_entryt &	pool_entry (u2 index)

exprt &	constant (u2 index)

const typet	type_entry (u2 index)

void	rClassFile ()

void	rconstant_pool ()

void	rinterfaces ()

void	rfields ()

void	rmethods ()

void	rmethod ()

void	rinner_classes_attribute (const u4 &attribute_length)
	Corresponds to the element_value structure Described in Java 8 specification 4.7.6 https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.7.6 Parses the InnerClasses attribute for the current parsed class, which contains an array of information about its inner classes. More...

std::vector< irep_idt >	rexceptions_attribute ()
	Corresponds to the element_value structure Described in Java 8 specification 4.7.5 https://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.7.5 Parses the Exceptions attribute for the current method, and returns a vector of exceptions. More...

void	rclass_attribute ()

void	rRuntimeAnnotation_attribute (std::vector< annotationt > &)

void	rRuntimeAnnotation (annotationt &)

void	relement_value_pairs (annotationt::element_value_pairst &)

exprt	get_relement_value ()
	Corresponds to the element_value structure Described in Java 8 specification 4.7.16.1 https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.7.16.1. More...

void	rmethod_attribute (methodt &method)

void	rfield_attribute (fieldt &)

void	rcode_attribute (methodt &method)

void	read_verification_type_info (methodt::verification_type_infot &)

void	rbytecode (std::vector< instructiont > &)

void	get_class_refs ()
	Get the class references for the benefit of a dependency analysis. More...

void	get_class_refs_rec (const typet &)

void	get_annotation_class_refs (const std::vector< annotationt > &annotations)
	For each of the given annotations, get a reference to its class and recursively get class references of the values it stores. More...

void	get_annotation_value_class_refs (const exprt &value)
	See java_bytecode_parsert::get_annotation_class_refs. More...

void	parse_local_variable_type_table (methodt &method)
	Parses the local variable type table of a method. More...

optionalt< lambda_method_handlet >	parse_method_handle (const class method_handle_infot &entry)
	Read method handle pointed to from constant pool entry at index, return type of method handle and name if lambda function is found. More...

void	read_bootstrapmethods_entry ()
	Read all entries of the `BootstrapMethods` attribute of a class file. More...

void	skip_bytes (std::size_t bytes)

template<typename T >
T	read ()

void	store_unknown_method_handle (size_t bootstrap_method_index)
	Creates an unknown method handle and puts it into the parsed_class. More...

Private Attributes
constant_poolt	constant_pool

const bool	skip_instructions = false

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 parsert
source_locationt	source_location

unsigned	line_no

unsigned	previous_line_no

unsigned	column

Protected Attributes inherited from messaget
message_handlert *	message_handler

mstreamt	mstream

Detailed Description

Definition at line 28 of file java_bytecode_parser.cpp.

Member Typedef Documentation

◆ annotationt

using java_bytecode_parsert::annotationt = java_bytecode_parse_treet::annotationt

private

Definition at line 55 of file java_bytecode_parser.cpp.

◆ classt

using java_bytecode_parsert::classt = java_bytecode_parse_treet::classt

private

Definition at line 51 of file java_bytecode_parser.cpp.

◆ constant_poolt

using java_bytecode_parsert::constant_poolt = std::vector<pool_entryt>

private

Definition at line 60 of file java_bytecode_parser.cpp.

◆ fieldt

using java_bytecode_parsert::fieldt = java_bytecode_parse_treet::fieldt

private

Definition at line 53 of file java_bytecode_parser.cpp.

◆ instructiont

using java_bytecode_parsert::instructiont = java_bytecode_parse_treet::instructiont

private

Definition at line 54 of file java_bytecode_parser.cpp.

◆ lambda_method_handlet

using java_bytecode_parsert::lambda_method_handlet = java_bytecode_parse_treet::classt::lambda_method_handlet

private

Definition at line 58 of file java_bytecode_parser.cpp.

◆ method_handle_typet

using java_bytecode_parsert::method_handle_typet = java_class_typet::method_handle_kindt

private

Definition at line 56 of file java_bytecode_parser.cpp.

◆ methodt

using java_bytecode_parsert::methodt = java_bytecode_parse_treet::methodt

private

Definition at line 52 of file java_bytecode_parser.cpp.

Constructor & Destructor Documentation

◆ java_bytecode_parsert()

java_bytecode_parsert::java_bytecode_parsert ( bool skip_instructions )

inlineexplicit

Definition at line 31 of file java_bytecode_parser.cpp.

Member Function Documentation

◆ constant()

exprt& java_bytecode_parsert::constant ( u2 index )

inlineprivate

Definition at line 78 of file java_bytecode_parser.cpp.

◆ get_annotation_class_refs()

void java_bytecode_parsert::get_annotation_class_refs ( const std::vector< annotationt > & annotations )

private

For each of the given annotations, get a reference to its class and recursively get class references of the values it stores.

Definition at line 608 of file java_bytecode_parser.cpp.

◆ get_annotation_value_class_refs()

void java_bytecode_parsert::get_annotation_value_class_refs ( const exprt & value )

private

See java_bytecode_parsert::get_annotation_class_refs.

For the different cases of exprt, see java_bytecode_parsert::get_relement_value.

Definition at line 622 of file java_bytecode_parser.cpp.

◆ get_class_refs()

void java_bytecode_parsert::get_class_refs ( )

private

Get the class references for the benefit of a dependency analysis.

Definition at line 493 of file java_bytecode_parser.cpp.

◆ get_class_refs_rec()

void java_bytecode_parsert::get_class_refs_rec ( const typet & src )

private

Definition at line 578 of file java_bytecode_parser.cpp.

◆ get_relement_value()

exprt java_bytecode_parsert::get_relement_value ( )

private

Corresponds to the element_value structure Described in Java 8 specification 4.7.16.1 https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.7.16.1.

Returns: An exprt that represents the particular value of annotations field. This is usually one of: a byte, number of some sort, string, character, enum, Class type, array or another annotation.

Definition at line 1522 of file java_bytecode_parser.cpp.

◆ parse()

bool java_bytecode_parsert::parse ( )

overridevirtual

Implements parsert.

Definition at line 379 of file java_bytecode_parser.cpp.

◆ parse_local_variable_type_table()

void java_bytecode_parsert::parse_local_variable_type_table ( methodt & method )

private

Parses the local variable type table of a method.

The LVTT holds generic type information for variables in the local variable table (LVT). At most as many variables as present in the LVT can be in the LVTT.

Definition at line 1847 of file java_bytecode_parser.cpp.

◆ parse_method_handle()

optionalt< java_bytecode_parsert::lambda_method_handlet > java_bytecode_parsert::parse_method_handle ( const class method_handle_infot & entry )

private

Read method handle pointed to from constant pool entry at index, return type of method handle and name if lambda function is found.

Parameters

entry the constant pool entry of the methodhandle_info structure

Returns: the method_handle type of the methodhandle_structure, either for a recognized bootstrap method or for a lambda function

Definition at line 1917 of file java_bytecode_parser.cpp.

◆ pool_entry()

pool_entryt& java_bytecode_parsert::pool_entry ( u2 index )

inlineprivate

Definition at line 66 of file java_bytecode_parser.cpp.

◆ rbytecode()

void java_bytecode_parsert::rbytecode ( std::vector< instructiont > & instructions )

private

Definition at line 881 of file java_bytecode_parser.cpp.

◆ rclass_attribute()

void java_bytecode_parsert::rclass_attribute ( )

private

Definition at line 1679 of file java_bytecode_parser.cpp.

◆ rClassFile()

void java_bytecode_parsert::rClassFile ( )

private

Definition at line 429 of file java_bytecode_parser.cpp.

◆ rcode_attribute()

void java_bytecode_parsert::rcode_attribute ( methodt & method )

private

Definition at line 1283 of file java_bytecode_parser.cpp.

◆ rconstant_pool()

void java_bytecode_parsert::rconstant_pool ( )

private

Definition at line 640 of file java_bytecode_parser.cpp.

◆ read()

template<typename T >

T java_bytecode_parsert::read ( )

inlineprivate

Definition at line 129 of file java_bytecode_parser.cpp.

◆ read_bootstrapmethods_entry()

void java_bytecode_parsert::read_bootstrapmethods_entry ( )

private

Read all entries of the BootstrapMethods attribute of a class file.

Definition at line 1970 of file java_bytecode_parser.cpp.

◆ read_verification_type_info()

void java_bytecode_parsert::read_verification_type_info ( methodt::verification_type_infot & v )

private

Definition at line 1441 of file java_bytecode_parser.cpp.

◆ relement_value_pairs()

void java_bytecode_parsert::relement_value_pairs ( annotationt::element_value_pairst & element_value_pairs )

private

Definition at line 1502 of file java_bytecode_parser.cpp.

◆ rexceptions_attribute()

std::vector< irep_idt > java_bytecode_parsert::rexceptions_attribute ( )

private

Corresponds to the element_value structure Described in Java 8 specification 4.7.5 https://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.7.5 Parses the Exceptions attribute for the current method, and returns a vector of exceptions.

Definition at line 1664 of file java_bytecode_parser.cpp.

◆ rfield_attribute()

void java_bytecode_parsert::rfield_attribute ( fieldt & field )

private

Definition at line 1262 of file java_bytecode_parser.cpp.

◆ rfields()

void java_bytecode_parsert::rfields ( )

private

Definition at line 840 of file java_bytecode_parser.cpp.

◆ rinner_classes_attribute()

void java_bytecode_parsert::rinner_classes_attribute ( const u4 & attribute_length )

private

Corresponds to the element_value structure Described in Java 8 specification 4.7.6 https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.7.6 Parses the InnerClasses attribute for the current parsed class, which contains an array of information about its inner classes.

We are interested in getting information only for inner classes, which is determined by checking if the parsed class matches any of the inner classes in its inner class array. If the parsed class is not an inner class, then it is ignored. When a parsed class is an inner class, the accessibility information for the parsed class is overwritten, and the parsed class is marked as an inner class.

Definition at line 1588 of file java_bytecode_parser.cpp.

◆ rinterfaces()

void java_bytecode_parsert::rinterfaces ( )

private

Definition at line 831 of file java_bytecode_parser.cpp.

◆ rmethod()

void java_bytecode_parsert::rmethod ( )

private

Definition at line 1772 of file java_bytecode_parser.cpp.

◆ rmethod_attribute()

void java_bytecode_parsert::rmethod_attribute ( methodt & method )

private

Definition at line 1149 of file java_bytecode_parser.cpp.

◆ rmethods()

void java_bytecode_parsert::rmethods ( )

private

Definition at line 1749 of file java_bytecode_parser.cpp.

◆ rRuntimeAnnotation()

void java_bytecode_parsert::rRuntimeAnnotation ( annotationt & annotation )

private

Definition at line 1494 of file java_bytecode_parser.cpp.

◆ rRuntimeAnnotation_attribute()

void java_bytecode_parsert::rRuntimeAnnotation_attribute ( std::vector< annotationt > & annotations )

private

Definition at line 1481 of file java_bytecode_parser.cpp.

◆ skip_bytes()

void java_bytecode_parsert::skip_bytes ( std::size_t bytes )

inlineprivate

Definition at line 115 of file java_bytecode_parser.cpp.

◆ store_unknown_method_handle()

void java_bytecode_parsert::store_unknown_method_handle ( size_t bootstrap_method_index )

private

Creates an unknown method handle and puts it into the parsed_class.

Parameters

bootstrap_method_index The current index in the bootstrap entry table

Definition at line 2104 of file java_bytecode_parser.cpp.

◆ type_entry()

const typet java_bytecode_parsert::type_entry ( u2 index )

inlineprivate

Definition at line 83 of file java_bytecode_parser.cpp.

Member Data Documentation

◆ constant_pool

constant_poolt java_bytecode_parsert::constant_pool

private

Definition at line 62 of file java_bytecode_parser.cpp.

◆ parse_tree

java_bytecode_parse_treet java_bytecode_parsert::parse_tree

Definition at line 48 of file java_bytecode_parser.cpp.

◆ skip_instructions

const bool java_bytecode_parsert::skip_instructions = false

private

Definition at line 64 of file java_bytecode_parser.cpp.

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

/home/runner/work/cbmc-documentation/cbmc-documentation/jbmc/src/java_bytecode/java_bytecode_parser.cpp

Classes

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ annotationt

◆ classt

◆ constant_poolt

◆ fieldt

◆ instructiont

◆ lambda_method_handlet

◆ method_handle_typet

◆ methodt

Constructor & Destructor Documentation

◆ java_bytecode_parsert()

Member Function Documentation

◆ constant()

◆ get_annotation_class_refs()

◆ get_annotation_value_class_refs()

◆ get_class_refs()

◆ get_class_refs_rec()

◆ get_relement_value()

◆ parse()

◆ parse_local_variable_type_table()

◆ parse_method_handle()

◆ pool_entry()

◆ rbytecode()

◆ rclass_attribute()

◆ rClassFile()

◆ rcode_attribute()

◆ rconstant_pool()

◆ read()

◆ read_bootstrapmethods_entry()

◆ read_verification_type_info()

◆ relement_value_pairs()

◆ rexceptions_attribute()

◆ rfield_attribute()

◆ rfields()

◆ rinner_classes_attribute()

◆ rinterfaces()

◆ rmethod()

◆ rmethod_attribute()

◆ rmethods()

◆ rRuntimeAnnotation()

◆ rRuntimeAnnotation_attribute()

◆ skip_bytes()

◆ store_unknown_method_handle()

◆ type_entry()

Member Data Documentation

◆ constant_pool

◆ parse_tree

◆ skip_instructions