class CParsedContainer

Represents a parsed object that can store other objects. More...

Definition#include <./classparser/ParsedContainer.h>
InheritsCParsedItem (unknown) [public ]
Inherited byCParsedClass, CParsedClassContainer, CParsedScopeContainer, CParsedStruct
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Members

Protected Members


Detailed Description

Represents a parsed object that can store other objects. The objects can be variables, functions or structures. Since this is a special case of a parsed item, the container inherits CParsedItem.

 CParsedContainer ()

CParsedContainer

 ~CParsedContainer ()

~CParsedContainer

QDict<CParsedAttribute> attributes

attributes

[protected]

QList<CParsedMethod> methods

methods

[protected]

QDict<CParsedMethod> methodsByNameAndArg

methodsByNameAndArg

[protected]

QDict<CParsedStruct> structs

structs

[protected]

bool useFullPath

useFullPath

[protected]

QListIterator<CParsedMethod> methodIterator

methodIterator

QDictIterator<CParsedAttribute> attributeIterator

attributeIterator

QDictIterator<CParsedStruct> structIterator

structIterator

void  addStruct ( CParsedStruct *aStruct )

addStruct

Add a struct.

Parameters:
aStructThe structure to add to the container.

void  addAttribute ( CParsedAttribute *anAttribute )

addAttribute

Add an attribute.

Parameters:
anAttributeAttribute to add to the container.

void  addMethod ( CParsedMethod *aMethod )

addMethod

Add a method.

Parameters:
aMethodMethod to add to the container.

inline void  setUseFullpath ( bool state )

setUseFullpath

Tells if the container should store objects using their full path.

Parameters:
stateIf to use full path or not.

CParsedMethodgetMethod ( CParsedMethod &aMethod )

getMethod

Get a method by comparing with another method.

Parameters:
aMethodMethod to compare with.

QList<CParsedMethod> * getMethodByName ( const char *aName )

getMethodByName

Get all methods matching the supplied name.

Parameters:
aNameName of the method.

Returns: List of methods matching the name.

CParsedMethodgetMethodByNameAndArg ( const char *aName )

getMethodByNameAndArg

Get a method by using its' name and arguments.

Parameters:
aNameOutput from a CParsedMethod->asString() call.

Returns: Pointer to the method or NULL if not found.

CParsedStructgetStructByName ( const char *aName )

getStructByName

Get a struct by using it's name.

Parameters:
aNameName of the struct to fetch.

Returns: Pointer to the struct or NULL if not found.

CParsedAttributegetAttributeByName ( const char *aName )

getAttributeByName

Get a attribute by using its' name.

Parameters:
aNameName of the attribute to fetch.

Returns: Pointer to the attribute or NULL if not found.

QList<CParsedMethod> * getSortedMethodList ()

getSortedMethodList

QStrList * getSortedAttributeAsStringList ()

getSortedAttributeAsStringList

Get all attributes in their string reprentation in sorted order.

Returns: List of attributes in sorted order.

QList<CParsedAttribute> * getSortedAttributeList ()

getSortedAttributeList

QStrList * getSortedStructNameList ()

getSortedStructNameList

Get the names of all structures in a sorted list.

Returns: List of all structs in alpabetical order.

QList<CParsedStruct> * getSortedStructList ()

getSortedStructList

bool  hasAttribute ( const char *aName )

hasAttribute

Does a attribute exist in the store?

Parameters:
aNameName of the attribute to check if it exists.

Returns: Does the attribute exist in the container.

bool  hasStruct ( const char *aName )

hasStruct

Does a struct exist in the store?

Parameters:
aNameName of the struct to check if it exists.

void  removeWithReferences ( const char *aFile )

removeWithReferences

Remove all items in the store with references to the file.

Parameters:
aFileThe file to check references to.

void  removeMethod ( CParsedMethod *aMethod )

removeMethod

Remove a method matching the specification.

Parameters:
aMethodSpecification of the method.

void  removeAttribute ( const char *aName )

removeAttribute

Remove an attribute with a specified name.

Parameters:
aNameName of the attribute to remove.

void  removeStruct ( const char *aName )

removeStruct

Remove a struct with a specified name.

Parameters:
aNameName of the struct to remove.

void  clear ()

clear

void  out ()

out

[virtual]

QString  asPersistantString ( QString &str )

asPersistantString

[virtual]

Return a string made for persistant storage.

Parameters:
strString to store the result in.

Returns: Pointer to str.

int  fromPersistantString ( const char *, int startPos )

fromPersistantString

[virtual]

Initialize the object from a persistant string.

Parameters:
strString to initialize from.
startPosPosition(0-based) at which to start.