decompiler  1.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
TypeStruct Class Reference

A composite Datatype object: A "structure" with component "fields". More...

#include <type.hh>

Inheritance diagram for TypeStruct:

Public Member Functions

 TypeStruct (const TypeStruct &op)
 Construct from another TypeStruct.
 TypeStruct (const string &n)
 Construct empty TypeStruct from a name.
vector< TypeField >::const_iterator beginField (void) const
 Beginning of fields.
vector< TypeField >::const_iterator endField (void) const
 End of fields.
const TypeFieldgetField (int4 off, int4 sz, int4 *newoff) const
 Get field based on offset. More...
virtual DatatypegetSubType (uintb off, uintb *newoff) const
 Recover component data-type one-level down. More...
virtual int4 numDepend (void) const
 Return number of component sub-types.
virtual DatatypegetDepend (int4 index) const
 Return the i-th component sub-type.
virtual int4 compare (const Datatype &op, int4 level) const
 Compare for functional equivalence. More...
virtual int4 compareDependency (const Datatype &op) const
 Compare for storage in tree structure. More...
virtual Datatypeclone (void) const
 Clone the data-type.
virtual void saveXml (ostream &s) const
 Serialize the data-type to XML. More...
- Public Member Functions inherited from Datatype
 Datatype (const Datatype &op)
 Construct the base data-type copying low-level properties of another.
 Datatype (int4 s, type_metatype m)
 Construct the base data-type providing size and meta-type.
 Datatype (int4 s, type_metatype m, const string &n)
 Construct the base data-type providing size, meta-type, and name.
virtual ~Datatype (void)
bool isCoreType (void) const
 Is this a core data-type.
bool isCharPrint (void) const
 Does this print as a 'char'.
bool isEnumType (void) const
 Is this an enumerated type.
bool isPowerOfTwo (void) const
 Is this a flag-based enumeration.
bool isASCII (void) const
 Does this print as an ASCII 'char'.
bool isUTF16 (void) const
 Does this print as UTF16 'wchar'.
bool isUTF32 (void) const
 Does this print as UTF32 'wchar'.
uint4 getInheritable (void) const
 Get properties pointers inherit.
type_metatype getMetatype (void) const
 Get the type meta-type.
uint8 getId (void) const
 Get the type id.
int4 getSize (void) const
 Get the type size.
const string & getName (void) const
 Get the type name.
virtual void printRaw (ostream &s) const
 Print a description of the type to stream. More...
virtual void printNameBase (ostream &s) const
 Print name as short prefix.
int4 typeOrder (const Datatype &op) const
 Order this with -op- datatype.
void saveXmlBasic (ostream &s) const
 Save basic data-type properties. More...
void saveXmlRef (ostream &s) const
 Write an XML reference of this to stream. More...

Protected Member Functions

void setFields (const vector< TypeField > &fd)
 Establish fields for this. More...
int4 getFieldIter (int4 off) const
 Get index into field list. More...
virtual void restoreXml (const Element *el, TypeFactory &typegrp)
 Restore data-type from XML. More...
- Protected Member Functions inherited from Datatype
void restoreXmlBasic (const Element *el)
 Recover basic data-type properties. More...

Protected Attributes

vector< TypeFieldfield
 The list of fields.
- Protected Attributes inherited from Datatype
int4 size
 Size (of variable holding a value of this type)
string name
 Name of type.
type_metatype metatype
 Meta-type - type disregarding size.
uint4 flags
 Boolean properties of the type.
uint8 id
 A unique id for the type (or 0 if an id is not assigned)


class TypeFactory

Additional Inherited Members

- Protected Types inherited from Datatype
enum  {
  coretype = 1, chartype = 2, enumtype = 4, poweroftwo = 8,
  utf16 = 16, utf32 = 32
 Boolean properties of datatypes. More...
- Static Protected Member Functions inherited from Datatype
static uint8 hashName (const string &nm)
 Produce a data-type id by hashing the type name. More...

Detailed Description

A composite Datatype object: A "structure" with component "fields".

Member Function Documentation

◆ compare()

int4 TypeStruct::compare ( const Datatype op,
int4  level 
) const

Compare for functional equivalence.

Compare this with another data-type. 0 (equality) means the data-types are functionally equivalent (even if names differ) Smaller types come earlier. More specific types come earlier.

opis the data-type to compare with this
levelis maximum level to descend when recursively comparing
negative, 0, positive depending on ordering of types

Reimplemented from Datatype.

◆ compareDependency()

int4 TypeStruct::compareDependency ( const Datatype op) const

Compare for storage in tree structure.

Ordering of data-types for the main TypeFactory container. Comparison only goes down one-level in the component structure, before just comparing pointers.

opis the data-type to compare with this
negative, 0, positive depending on ordering of types

Reimplemented from Datatype.

◆ getField()

const TypeField * TypeStruct::getField ( int4  off,
int4  sz,
int4 *  newoff 
) const

Get field based on offset.

Given a byte range within this data-type, determine the field it is contained in and pass back the renormalized offset.

offis the byte offset into this
szis the size of the byte range
newoffpoints to the renormalized offset to pass back
the containing field or NULL if the range is not contained

◆ getFieldIter()

int4 TypeStruct::getFieldIter ( int4  off) const

Get index into field list.

Find the proper subfield given an offset. Return the index of that field or -1 if the offset is not inside a field.

offis the offset into the structure
the index into the field list or -1

◆ getSubType()

Datatype * TypeStruct::getSubType ( uintb  off,
uintb *  newoff 
) const

Recover component data-type one-level down.

Given an offset into this data-type, return the component data-type at that offset. Also, pass back a "renormalized" offset suitable for recursize getSubType() calls: i.e. if the original offset hits the exact start of the sub-type, 0 is passed back. If there is no valid component data-type at the offset, return NULL and pass back the original offset

offis the offset into this data-type
newoffis a pointer to the passed-back offset
a pointer to the component data-type or NULL

Reimplemented from Datatype.

◆ restoreXml()

void TypeStruct::restoreXml ( const Element el,
TypeFactory typegrp 

Restore data-type from XML.

Restore a Datatype object from an XML element

elis the XML element
typegrpis the underlying TypeFactory that will hold the new object

Reimplemented from Datatype.

Referenced by TypeFactory::restoreXmlTypeNoRef().

◆ saveXml()

void TypeStruct::saveXml ( ostream &  s) const

Serialize the data-type to XML.

Write out a formal description of the data-type as an XML <type> tag. For composite data-types, the description goes down one level, describing the component types only by reference.

sis the stream to write to

Reimplemented from Datatype.

◆ setFields()

void TypeStruct::setFields ( const vector< TypeField > &  fd)

Establish fields for this.

Copy a list of fields into this structure, establishing its size. Should only be called once when constructing the type

fdis the list of fields to copy in

Referenced by TypeFactory::setFields().

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