Ghidra Decompiler Analysis Engine
Public Member Functions | List of all members
ConstantPool Class Referenceabstract

An interface to the pool of constant objects for byte-code languages. More...

#include <cpool.hh>

Inheritance diagram for ConstantPool:
Inheritance graph
[legend]

Public Member Functions

virtual const CPoolRecordgetRecord (const vector< uintb > &refs) const =0
 Retrieve a constant pool record (CPoolRecord) given a reference to it. More...
 
void putRecord (const vector< uintb > &refs, uint4 tag, const string &tok, Datatype *ct)
 A a new constant pool record to this database. More...
 
const CPoolRecordrestoreXmlRecord (const vector< uintb > &refs, const Element *el, TypeFactory &typegrp)
 Restore a CPoolRecord given a reference and an XML stream. More...
 
virtual bool empty (void) const =0
 Is the container empty of records.
 
virtual void clear (void)=0
 Release any (local) resources.
 
virtual void saveXml (ostream &s) const =0
 Save all records in this container to an XML stream. More...
 
virtual void restoreXml (const Element *el, TypeFactory &typegrp)=0
 Restore constant pool records from an XML stream. More...
 

Detailed Description

An interface to the pool of constant objects for byte-code languages.

This is an abstract base class that acts as a container for CPoolRecords. A reference (1 or more integer constants) maps to an individual CPoolRecord. A CPoolRecord object can be queried for using getRecord(), and a new object can be added with putRecord(). Internally, the actual CPoolRecord object is produced by createRecord().

Member Function Documentation

◆ getRecord()

virtual const CPoolRecord* ConstantPool::getRecord ( const vector< uintb > &  refs) const
pure virtual

Retrieve a constant pool record (CPoolRecord) given a reference to it.

Parameters
refsis the reference (made up of 1 or more identifying integers)
Returns
the matching CPoolRecord or NULL if none matches the reference

Implemented in ConstantPoolInternal, and ConstantPoolGhidra.

◆ putRecord()

void ConstantPool::putRecord ( const vector< uintb > &  refs,
uint4  tag,
const string &  tok,
Datatype ct 
)

A a new constant pool record to this database.

Given the basic constituents of the record, type, name, and data-type, create a new CPoolRecord object and associate it with the given reference.

Parameters
refsis the reference (made up of 1 or more identifying integers)
tagis the type of record to create
tokis the name associated with the object
ctis the data-type associated with the object

◆ restoreXml()

virtual void ConstantPool::restoreXml ( const Element el,
TypeFactory typegrp 
)
pure virtual

Restore constant pool records from an XML stream.

(If supported) The container is populated with CPooLRecords initialized from a <constantpool> XML tag.

Parameters
elis the XML element
typegrpis the TypeFactory used to resolve data-type references in the XML

Implemented in ConstantPoolInternal, and ConstantPoolGhidra.

◆ restoreXmlRecord()

const CPoolRecord * ConstantPool::restoreXmlRecord ( const vector< uintb > &  refs,
const Element el,
TypeFactory typegrp 
)

Restore a CPoolRecord given a reference and an XML stream.

A <cpoolrec> element initializes the new record which is immediately associated with the reference.

Parameters
refsis the reference (made up of 1 or more identifying integers)
elis the XML element
typegrpis the TypeFactory used to resolve data-type references in XML
Returns
the newly allocated and initialized CPoolRecord

◆ saveXml()

virtual void ConstantPool::saveXml ( ostream &  s) const
pure virtual

Save all records in this container to an XML stream.

(If supported) An <constantpool> element is written containing <cpoolrec> child elements for each CPoolRecord in the container.

Parameters
sis the output stream

Implemented in ConstantPoolInternal, and ConstantPoolGhidra.


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