Class CCleanup

class CCleanup : public CBase;

Description

Implements the cleanup stack.

An object of this type is created and used by the cleanup stack interface, CTrapCleanup.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CCleanup - Implements the cleanup stack.

Members

Defined in CCleanup:

• CCleanup()Default constructor.
• Check(TAny *)Checks that the cleanup item at the top of the cleanup stack represents a cleanu...
• DoPop(TInt,TBool)Provides an implementation for CCleanup::Pop() and CCleanup::PopAndDestroy().
• DoPopAll(TBool)Provides an implementation for CCleanup::PopAll() and CCleanup::PopAndDestroyAll...
• New()Creates a new cleanup stack object.
• NewL()Creates a new cleanup stack object, and leaves if there is insufficient memory t...
• NextLevel()Goes to the next cleanup level.
• Pop()Pops a single cleanup item from the cleanup stack.
• Pop(TInt)Pops the specified number of cleanup items from the cleanup stack.
• PopAll()Pops all cleanup items at the current level, and then decrements the level.
• PopAndDestroy()Pops a single cleanup item from the cleanup stack, and invokes its cleanup opera...
• PopAndDestroy(TInt)Pops the specified number of cleanup items from the cleanup stack, and invokes t...
• PopAndDestroyAll()Pops all cleanup items at the current level, invokes their cleanup operations an...
• PreviousLevel()Goes to the previous cleanup level.
• PushL(CBase *)Pushes a cleanup item onto the cleanup stack.
• PushL(TAny *)Pushes a cleanup item onto the cleanup stack.
• PushL(TCleanupItem)Pushes a cleanup item onto the cleanup stack.
• iBasePointer to the bottom of the cleanup stack.
• iNextPointer to the next availaible slot in the cleanup stack.
• iTopPointer to the top of the cleanup stack.
• ~CCleanup()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CCleanup* NewL();

Description

Creates a new cleanup stack object, and leaves if there is insufficient memory to create it.

The cleanup stack itself is allocated with enough space initially to hold a number of stack items.

Return value

IMPORT_C ~CCleanup();

Description

Destructor.

Pops and destroys all items from the cleanup stack and then destroys the cleanup stack itself.

protected: IMPORT_C CCleanup();

Description

Default constructor.

IMPORT_C static CCleanup* New();

Description

Creates a new cleanup stack object.

The cleanup stack itself is allocated with enough space initially to hold a number of stack items.

Return value

IMPORT_C void NextLevel();

Description

Goes to the next cleanup level.

IMPORT_C void PreviousLevel();

Description

Goes to the previous cleanup level.

Panic codes

IMPORT_C void PushL(TAny *aPtr);

Description

Pushes a cleanup item onto the cleanup stack.

The cleanup item represents an operation that frees the specified heap cell.

Parameters

IMPORT_C void PushL(CBase *anObject);

Description

Pushes a cleanup item onto the cleanup stack.

The cleanup item represents an operation that deletes the specified CBase derived object.

Parameters

IMPORT_C void PushL(TCleanupItem anItem);

Description

Pushes a cleanup item onto the cleanup stack.

The cleanup item represents a call back operation that performs the required cleanup.

Parameters

IMPORT_C void Pop();

Description

Pops a single cleanup item from the cleanup stack.

Panic codes

IMPORT_C void Pop(TInt aCount);

Description

Pops the specified number of cleanup items from the cleanup stack.

Parameters

Panic codes

IMPORT_C void PopAll();

Description

Pops all cleanup items at the current level, and then decrements the level.

IMPORT_C void PopAndDestroy();

Description

Pops a single cleanup item from the cleanup stack, and invokes its cleanup operation.

Panic codes

IMPORT_C void PopAndDestroy(TInt aCount);

Description

Pops the specified number of cleanup items from the cleanup stack, and invokes their cleanup operations.

Parameters

Panic codes

IMPORT_C void PopAndDestroyAll();

Description

Pops all cleanup items at the current level, invokes their cleanup operations and then decrements the level.

IMPORT_C void Check(TAny *aExpectedItem);

Description

Checks that the cleanup item at the top of the cleanup stack represents a cleanup operation for the specified object.

Parameters

protected: IMPORT_C void DoPop(TInt aCount, TBool aDestroy);

Description

Provides an implementation for CCleanup::Pop() and CCleanup::PopAndDestroy().

Parameters

protected: IMPORT_C void DoPopAll(TBool aDestroy);

Description

Provides an implementation for CCleanup::PopAll() and CCleanup::PopAndDestroyAll().

Parameters

protected: TCleanupStackItem * iBase;

Description

Pointer to the bottom of the cleanup stack.

protected: TCleanupStackItem * iTop;

Description

Pointer to the top of the cleanup stack.

protected: TCleanupStackItem * iNext;

Description

Pointer to the next availaible slot in the cleanup stack.