DCTypedef Class Reference

This represents a single typedef declaration in the dc file. It assigns a particular type to a new name, just like a C typedef. More...

Inheritance diagram for DCTypedef:
DCDeclaration

Public Member Functions

str getDescription ()
 Returns a brief decription of the typedef, useful for human consumption. More...
 
str getName ()
 Returns the name of this typedef. More...
 
int getNumber ()
 Returns a unique index number associated with this typedef definition. This is defined implicitly when the .dc file(s) are read. More...
 
bool isBogusTypedef ()
 Returns true if the typedef has been flagged as a bogus typedef. This is set for typedefs that are generated by the parser as placeholder for missing typedefs, as when reading a partial file; it should not occur in a normal valid dc file. More...
 
bool isImplicitTypedef ()
 Returns true if the typedef has been flagged as an implicit typedef, meaning it was created for a DCClass that was referenced inline as a type. More...
 
- Public Member Functions inherited from DCDeclaration
DCClass asClass ()
 
const DCClass asClass ()
 
DCSwitch asSwitch ()
 
const DCSwitch asSwitch ()
 
 output (Ostream out)
 Write a string representation of this instance to <out>. More...
 
 write (Ostream out, int indent_level)
 Write a string representation of this instance to <out>. More...
 

Detailed Description

This represents a single typedef declaration in the dc file. It assigns a particular type to a new name, just like a C typedef.

Member Function Documentation

str getDescription ( )

Returns a brief decription of the typedef, useful for human consumption.

str getName ( )

Returns the name of this typedef.

int getNumber ( )

Returns a unique index number associated with this typedef definition. This is defined implicitly when the .dc file(s) are read.

bool isBogusTypedef ( )

Returns true if the typedef has been flagged as a bogus typedef. This is set for typedefs that are generated by the parser as placeholder for missing typedefs, as when reading a partial file; it should not occur in a normal valid dc file.

bool isImplicitTypedef ( )

Returns true if the typedef has been flagged as an implicit typedef, meaning it was created for a DCClass that was referenced inline as a type.