cprover
java_generic_struct_tag_typet Class Reference

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_typetgeneric_typest
 
- Public Types inherited from irept
using baset = tree_implementationt
 
- Public Types inherited from sharing_treet< irept, std::map< irep_namet, irept > >
using dt = tree_nodet< irept, std::map< irep_namet, 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_typestgeneric_types () const
 
generic_typestgeneric_types ()
 
optionalt< 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_idtget_identifier () const
 
- Public Member Functions inherited from typet
 typet ()
 
 typet (const irep_idt &_id)
 
 typet (irep_idt _id, typet _subtype)
 
const typetsubtype () const
 
typetsubtype ()
 
bool has_subtypes () const
 
bool has_subtype () const
 
void remove_subtype ()
 
const source_locationtsource_location () const
 
source_locationtadd_source_location ()
 
typetadd_type (const irep_namet &name)
 
const typetfind_type (const irep_namet &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_idtid () const
 
const std::string & id_string () const
 
void id (const irep_idt &_data)
 
const ireptfind (const irep_namet &name) const
 
ireptadd (const irep_namet &name)
 
ireptadd (const irep_namet &name, irept irep)
 
const std::string & get_string (const irep_namet &name) const
 
const irep_idtget (const irep_namet &name) const
 
bool get_bool (const irep_namet &name) const
 
signed int get_int (const irep_namet &name) const
 
std::size_t get_size_t (const irep_namet &name) const
 
long long get_long_long (const irep_namet &name) const
 
void set (const irep_namet &name, const irep_idt &value)
 
void set (const irep_namet &name, irept irep)
 
void set (const irep_namet &name, const long long value)
 
void remove (const irep_namet &name)
 
void move_to_sub (irept &irep)
 
void move_to_named_sub (const irep_namet &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 ()
 
subtget_sub ()
 
const subtget_sub () const
 
named_subtget_named_sub ()
 
const named_subtget_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, std::map< irep_namet, 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_treetoperator= (const sharing_treet &irep)
 
sharing_treetoperator= (sharing_treet &&irep)
 
 ~sharing_treet ()
 
const dtread () const
 
dtwrite ()
 

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_namet &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 sharing_treet< irept, std::map< irep_namet, irept > >
void detach ()
 
- Static Protected Member Functions inherited from sharing_treet< irept, std::map< irep_namet, 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, std::map< irep_namet, irept > >
dtdata
 
- Static Protected Attributes inherited from sharing_treet< irept, std::map< irep_namet, 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:

Definition at line 858 of file java_types.h.

Member Typedef Documentation

◆ generic_typest

Definition at line 861 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 863 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 1041 of file java_types.cpp.

Member Function Documentation

◆ generic_type_index()

optionalt< 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
typeThe parameter type we are looking for.
Returns
The index of the type in the vector of generic types.

Definition at line 1068 of file java_types.cpp.

◆ generic_types() [1/2]

generic_typest& java_generic_struct_tag_typet::generic_types ( )
inline

Definition at line 879 of file java_types.h.

◆ generic_types() [2/2]

const generic_typest& java_generic_struct_tag_typet::generic_types ( ) const
inline

Definition at line 874 of file java_types.h.


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