Class to hold type with generic type arguments, for example java.util.List in either a reference of type List<Integer> or List<T> (here T must have been concretized already to create this object so technically it is an argument rather than parameter/variable, but in the symbol table this still shows as the parameter T). More...

#include <java_types.h>

Inheritance diagram for java_generic_struct_tag_typet:

Collaboration diagram for java_generic_struct_tag_typet:

Public Types
typedef std::vector< reference_typet >	generic_typest

Public Types inherited from irept
using	baset = tree_implementationt

Public Types inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
using	dt = tree_nodet< irept, forward_list_as_mapt< irep_idt, irept >, true >

using	subt = typename dt::subt

using	named_subt = typename dt::named_subt

using	tree_implementationt = sharing_treet
	Used to refer to this class from derived classes. More...

Public Member Functions
	java_generic_struct_tag_typet (const struct_tag_typet &type)

	java_generic_struct_tag_typet (const struct_tag_typet &type, const std::string &base_ref, const std::string &class_name_prefix)
	Construct a generic symbol type by extending the symbol type `type` with generic types extracted from the reference `base_ref`. More...

const generic_typest &	generic_types () const

generic_typest &	generic_types ()

std::optional< size_t >	generic_type_index (const java_generic_parametert &type) const
	Check if this symbol has the given generic type. More...

Public Member Functions inherited from struct_tag_typet
	struct_tag_typet (const irep_idt &identifier)

Public Member Functions inherited from tag_typet
	tag_typet (const irep_idt &_id, const irep_idt &identifier)

void	set_identifier (const irep_idt &identifier)

const irep_idt &	get_identifier () const

Public Member Functions inherited from typet
	typet ()

	typet (const irep_idt &_id)

	typet (irep_idt _id, typet _subtype)

typet &	add_subtype ()

bool	has_subtypes () const

bool	has_subtype () const

void	remove_subtype ()

const source_locationt &	source_location () const

source_locationt &	add_source_location ()

typet &&	with_source_location (source_locationt location) &&
	This is a 'fluent style' method for creating a new type with an added-on source location. More...

typet &	with_source_location (source_locationt location) &
	This is a 'fluent style' method for adding a source location. More...

typet &&	with_source_location (const typet &type) &&
	This is a 'fluent style' method for creating a new type with an added-on source location. More...

typet &	with_source_location (const typet &type) &
	This is a 'fluent style' method for adding a source location. More...

typet &	add_type (const irep_idt &name)

const typet &	find_type (const irep_idt &name) const

Public Member Functions inherited from irept
bool	is_nil () const

bool	is_not_nil () const

	irept (const irep_idt &_id)

	irept (const irep_idt &_id, const named_subt &_named_sub, const subt &_sub)

	irept ()=default

const irep_idt &	id () const

const std::string &	id_string () const

void	id (const irep_idt &_data)

const irept &	find (const irep_idt &name) const

irept &	add (const irep_idt &name)

irept &	add (const irep_idt &name, irept irep)

const std::string &	get_string (const irep_idt &name) const

const irep_idt &	get (const irep_idt &name) const

bool	get_bool (const irep_idt &name) const

signed int	get_int (const irep_idt &name) const

std::size_t	get_size_t (const irep_idt &name) const

long long	get_long_long (const irep_idt &name) const

void	set (const irep_idt &name, const irep_idt &value)

void	set (const irep_idt &name, irept irep)

void	set (const irep_idt &name, const long long value)

void	set_size_t (const irep_idt &name, const std::size_t value)

void	remove (const irep_idt &name)

void	move_to_sub (irept &irep)

void	move_to_named_sub (const irep_idt &name, irept &irep)

bool	operator== (const irept &other) const

bool	operator!= (const irept &other) const

void	swap (irept &irep)

bool	operator< (const irept &other) const
	defines ordering on the internal representation More...

bool	ordering (const irept &other) const
	defines ordering on the internal representation More...

int	compare (const irept &i) const
	defines ordering on the internal representation comments are ignored More...

void	clear ()

void	make_nil ()

subt &	get_sub ()

const subt &	get_sub () const

named_subt &	get_named_sub ()

const named_subt &	get_named_sub () const

std::size_t	hash () const

std::size_t	full_hash () const

bool	full_eq (const irept &other) const

std::string	pretty (unsigned indent=0, unsigned max_indent=0) const

Public Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
	sharing_treet (irep_idt _id)

	sharing_treet (irep_idt _id, named_subt _named_sub, subt _sub)

	sharing_treet ()

	sharing_treet (const sharing_treet &irep)

	sharing_treet (sharing_treet &&irep)

sharing_treet &	operator= (const sharing_treet &irep)

sharing_treet &	operator= (sharing_treet &&irep)

	~sharing_treet ()

const dt &	read () const

dt &	write ()

Additional Inherited Members
Static Public Member Functions inherited from typet
static void	check (const typet &, const validation_modet=validation_modet::INVARIANT)
	Check that the type is well-formed (shallow checks only, i.e., subtypes are not checked) More...

static void	validate (const typet &type, const namespacet &, const validation_modet vm=validation_modet::INVARIANT)
	Check that the type is well-formed, assuming that its subtypes have already been checked for well-formedness. More...

static void	validate_full (const typet &type, const namespacet &ns, const validation_modet vm=validation_modet::INVARIANT)
	Check that the type is well-formed (full check, including checks of subtypes) More...

Static Public Member Functions inherited from irept
static bool	is_comment (const irep_idt &name)

static std::size_t	number_of_non_comments (const named_subt &)
	count the number of named_sub elements that are not comments More...

Protected Member Functions inherited from struct_or_union_tag_typet
	struct_or_union_tag_typet (const irep_idt &id, const irep_idt &identifier)

Protected Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
void	detach ()

Static Protected Member Functions inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
static void	remove_ref (dt *old_data)

static void	nonrecursive_destructor (dt *old_data)
	Does the same as remove_ref, but using an explicit stack instead of recursion. More...

Protected Attributes inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
dt *	data

Static Protected Attributes inherited from sharing_treet< irept, forward_list_as_mapt< irep_idt, irept > >
static dt	empty_d

Detailed Description

Class to hold type with generic type arguments, for example java.util.List in either a reference of type List<Integer> or List<T> (here T must have been concretized already to create this object so technically it is an argument rather than parameter/variable, but in the symbol table this still shows as the parameter T).

The vector holds the types of the type arguments (all of type or subtype of reference_typet), that is the vector has the length of the number of type parameters of the generic class. For example:

in HashMap<K, V> it would contain two elements, each of type java_generic_parametert,
in HashMap<Integer, V> it would contain two elements, the first of type reference_typet and the second of type java_generic_parametert,
in HashMap<List<T>, V> it would contain two elements, the first of type java_generic_typet and the second of type java_generic_parametert.

Definition at line 856 of file java_types.h.

Member Typedef Documentation

◆ generic_typest

typedef std::vector<reference_typet> java_generic_struct_tag_typet::generic_typest

Definition at line 859 of file java_types.h.

Constructor & Destructor Documentation

◆ java_generic_struct_tag_typet() [1/2]

java_generic_struct_tag_typet::java_generic_struct_tag_typet ( const struct_tag_typet & type )

inlineexplicit

Definition at line 861 of file java_types.h.

◆ java_generic_struct_tag_typet() [2/2]

java_generic_struct_tag_typet::java_generic_struct_tag_typet	(	const struct_tag_typet &	type,
		const std::string &	base_ref,
		const std::string &	class_name_prefix
	)

Construct a generic symbol type by extending the symbol type type with generic types extracted from the reference base_ref.

This assumes that the class named class_name_prefix extends or implements the class type, and that base_ref corresponds to a generic class. For instance since HashMap<K,V> extends Map<K,V> we would call java_generic_struct_tag_typet(struct_tag_typet("Map"), "Ljava/util/Map<TK;TV;>;", "java.util.HashMap") which generates a symbol type with identifier "Map", and two generic types with identifier "java.util.HashMap::K" and "java.util.HashMap::V" respectively.

Definition at line 1048 of file java_types.cpp.

Member Function Documentation

◆ generic_type_index()

std::optional< size_t > java_generic_struct_tag_typet::generic_type_index ( const java_generic_parametert & type ) const

Check if this symbol has the given generic type.

If yes, return its index in the vector of generic types.

Parameters

type	The parameter type we are looking for.

Returns: The index of the type in the vector of generic types.

Definition at line 1075 of file java_types.cpp.

◆ generic_types() [1/2]

generic_typest& java_generic_struct_tag_typet::generic_types ( )

inline

Definition at line 877 of file java_types.h.

◆ generic_types() [2/2]

const generic_typest& java_generic_struct_tag_typet::generic_types ( ) const

inline

Definition at line 872 of file java_types.h.

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

/home/runner/work/cbmc/cbmc/jbmc/src/java_bytecode/java_types.h
/home/runner/work/cbmc/cbmc/jbmc/src/java_bytecode/java_types.cpp

Public Types

Public Member Functions

Additional Inherited Members