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 (void)
	Construct incomplete/empty TypeStruct.

vector< TypeField >::const_iterator	beginField (void) const
	Beginning of fields.

vector< TypeField >::const_iterator	endField (void) const
	End of fields.

const TypeField *	getField (int4 off, int4 sz, int4 *newoff) const
	Get field based on offset. More...

virtual Datatype *	getSubType (uintb off, uintb *newoff) const
	Recover component data-type one-level down. More...

virtual Datatype *	nearestArrayedComponentForward (uintb off, uintb newoff, int4 elSize) const

virtual Datatype *	nearestArrayedComponentBackward (uintb off, uintb newoff, int4 elSize) const

virtual int4	numDepend (void) const
	Return number of component sub-types. More...

virtual Datatype *	getDepend (int4 index) const
	Return the i-th component sub-type. More...

virtual int4	compare (const Datatype &op, int4 level) const
	Order types for propagation. More...

virtual int4	compareDependency (const Datatype &op) const
	Compare for storage in tree structure. More...

virtual Datatype *	clone (void) const
	Clone the data-type. More...

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.

virtual	~Datatype (void)
	Destructor.

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

bool	isVariableLength (void) const
	Is this a variable length structure.

bool	hasSameVariableBase (const Datatype *ct) const
	Are these the same variable length data-type. More...

bool	isOpaqueString (void) const
	Is this an opaquely encoded string.

bool	isPointerRel (void) const
	Is this a TypePointerRel.

bool	isFormalPointerRel (void) const
	Is this a non-ephemeral TypePointerRel.

bool	hasStripped (void) const
	Return true if this has a stripped form.

bool	isIncomplete (void) const
	Is this an incompletely defined data-type.

uint4	getInheritable (void) const
	Get properties pointers inherit.

type_metatype	getMetatype (void) const
	Get the type meta-type.

sub_metatype	getSubMeta (void) const
	Get the sub-metatype.

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.

Datatype *	getTypedef (void) const
	Get the data-type immediately typedefed by this (or null)

virtual void	printRaw (ostream &s) const
	Print a description of the type to stream. More...

virtual Datatype *	getSubType (uintb off, uintb *newoff) const
	Recover component data-type one-level down. More...

virtual Datatype *	nearestArrayedComponentForward (uintb off, uintb newoff, int4 elSize) const

virtual Datatype *	nearestArrayedComponentBackward (uintb off, uintb newoff, int4 elSize) const

virtual int4	numDepend (void) const
	Return number of component sub-types. More...

virtual Datatype *	getDepend (int4 index) const
	Return the i-th component sub-type. More...

virtual void	printNameBase (ostream &s) const
	Print name as short prefix. More...

virtual int4	compare (const Datatype &op, int4 level) const
	Order types for propagation. More...

virtual int4	compareDependency (const Datatype &op) const
	Compare for storage in tree structure. More...

virtual void	saveXml (ostream &s) const
	Serialize the data-type to XML. More...

virtual bool	isPtrsubMatching (uintb off) const
	Is this data-type suitable as input to a CPUI_PTRSUB op. More...

virtual Datatype *	getStripped (void) const
	Get a stripped version of this for formal use in formal declarations. More...

int4	typeOrder (const Datatype &op) const
	Order this with -op- datatype.

int4	typeOrderBool (const Datatype &op) const
	Order this with -op-, treating bool data-type as special. 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...

int4	getLowerBoundField (int4 off) const
	Get index of last field before or equal to given offset. More...

void	restoreFields (const Element *el, TypeFactory &typegrp)
	Restore fields from XML description. More...

Protected Member Functions inherited from Datatype
void	restoreXmlBasic (const Element *el)
	Recover basic data-type properties. More...

void	saveXmlBasic (type_metatype meta, ostream &s) const
	Save basic data-type properties. More...

void	saveXmlTypedef (ostream &s) const
	Write this as a typedef tag to stream. More...

void	markComplete (void)
	Mark this data-type as completely defined.

virtual Datatype *	clone (void) const =0
	Clone the data-type. More...

Protected Attributes
vector< TypeField >	field
	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.

sub_metatype	submeta
	Sub-type of of the meta-type, for comparisons.

uint4	flags
	Boolean properties of the type.

uint8	id
	A unique id for the type (or 0 if an id is not assigned)

Datatype *	typedefImm
	The immediate data-type being typedefed by this.

Friends
class	TypeFactory

Additional Inherited Members
Protected Types inherited from Datatype
enum	{ coretype = 1 , chartype = 2 , enumtype = 4 , poweroftwo = 8 , utf16 = 16 , utf32 = 32 , opaque_string = 64 , variable_length = 128 , has_stripped = 0x100 , is_ptrrel = 0x200 , type_incomplete = 0x400 }
	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...

static uint8	hashSize (uint8 id, int4 size)
	Reversibly hash size into id. More...

Static Protected Attributes inherited from Datatype
static sub_metatype	base2sub [13]

Detailed Description

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

Member Function Documentation

◆ clone()

virtual Datatype * TypeStruct::clone ( void ) const

inlinevirtual

Clone the data-type.

Implements Datatype.

References TypeStruct().

◆ compare()

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

virtual

Order types for propagation.

Order this with another data-type, in a way suitable for the type propagation algorithm. Bigger types come earlier. More specific types come earlier.

Parameters

op	is the data-type to compare with this
level	is maximum level to descend when recursively comparing

Returns: negative, 0, positive depending on ordering of types

Reimplemented from Datatype.

◆ compareDependency()

int4 TypeStruct::compareDependency ( const Datatype & op ) const

virtual

Compare for storage in tree structure.

Sort data-types for the main TypeFactory container. The sort needs to be based on the data-type structure so that an example data-type, constructed outside the factory, can be used to find the equivalent object inside the factory. This means the comparison should not examine the data-type id. In practice, the comparison only needs to go down one level in the component structure before just comparing component pointers.

Parameters

op	is the data-type to compare with this

Returns: negative, 0, positive depending on ordering of types

Reimplemented from Datatype.

◆ getDepend()

virtual Datatype * TypeStruct::getDepend ( int4 index ) const

inlinevirtual

Return the i-th component sub-type.

Reimplemented from Datatype.

References field.

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

Parameters

off	is the byte offset into this
sz	is the size of the byte range
newoff	points to the renormalized offset to pass back

Returns: the containing field or NULL if the range is not contained

◆ getFieldIter()

int4 TypeStruct::getFieldIter ( int4 off ) const

protected

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.

Parameters

off	is the offset into the structure

Returns: the index into the field list or -1

◆ getLowerBoundField()

int4 TypeStruct::getLowerBoundField ( int4 off ) const

protected

Get index of last field before or equal to given offset.

The field returned may or may not contain the offset. If there are no fields that occur earlier than the offset, return -1.

Parameters

off	is the given offset

Returns: the index of the nearest field or -1

◆ getSubType()

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

virtual

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

Parameters

off	is the offset into this data-type
newoff	is a pointer to the passed-back offset

Returns: a pointer to the component data-type or NULL

Reimplemented from Datatype.

◆ nearestArrayedComponentBackward()

Datatype * TypeStruct::nearestArrayedComponentBackward	(	uintb	off,
		uintb *	newoff,
		int4 *	elSize
	)		const

virtual

Find the first component data-type before the given offset that is (or contains) an array, and pass back the difference between the component's start and the given offset. Return the component data-type or null if no array is found.

Parameters

off	is the given offset into this data-type
newoff	is used to pass back the offset difference
elSize	is used to pass back the array element size

Returns: the component data-type or null

Reimplemented from Datatype.

◆ nearestArrayedComponentForward()

Datatype * TypeStruct::nearestArrayedComponentForward	(	uintb	off,
		uintb *	newoff,
		int4 *	elSize
	)		const

virtual

Find the first component data-type after the given offset that is (or contains) an array, and pass back the difference between the component's start and the given offset. Return the component data-type or null if no array is found.

Parameters

off	is the given offset into this data-type
newoff	is used to pass back the offset difference
elSize	is used to pass back the array element size

Returns: the component data-type or null

Reimplemented from Datatype.

◆ numDepend()

virtual int4 TypeStruct::numDepend ( void ) const

inlinevirtual

Return number of component sub-types.

Reimplemented from Datatype.

References field.

Referenced by ActionSetCasts::testStructOffset0().

◆ restoreFields()

void TypeStruct::restoreFields	(	const Element *	el,
		TypeFactory &	typegrp
	)

protected

Restore fields from XML description.

Children of the structure element describe each field.

Parameters

el	is the root structure element
typegrp	is the factory owning the new structure

Referenced by TypeFactory::restoreStruct().

◆ saveXml()

void TypeStruct::saveXml ( ostream & s ) const

virtual

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.

Parameters

s	is the stream to write to

Reimplemented from Datatype.

◆ setFields()

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

protected

Establish fields for this.

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

Parameters

fd	is the list of fields to copy in

Referenced by TypeFactory::setFields().

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

type.hh
type.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ compare()

◆ compareDependency()

◆ getDepend()

◆ getField()

◆ getFieldIter()

◆ getLowerBoundField()

◆ getSubType()

◆ nearestArrayedComponentBackward()

◆ nearestArrayedComponentForward()

◆ numDepend()

◆ restoreFields()

◆ saveXml()

◆ setFields()