EPSCommentList Class Reference

Wraps up the EPSCommentDef structs into a list class. This will allow me to have a changeable list for different versions of the file, and as a result the whole importing of comments much less restrictive, but at the penalty of a speed hit. Looking up a token will be on O(n) operation, rather than the much quicker array look-up that currently exists. More...

#include <epsclist.h>

Inheritance diagram for EPSCommentList:

List of all members.

Public Member Functions
	EPSCommentList (void)
	Creates the class, and sets all the variables to be a default value.
	~EPSCommentList (void)
	Destroys the class, and all of its member variables.
BOOL	Add (TCHAR *pStart, TCHAR *pEnd, BOOL DoProcessComments, UINT32 NestingDepth)
	Adds a list item to the end of mpCommentList record.
const EPSCommentDef &	ReturnElement (INT32 Index)
	Returns a reference to the nth item in the linked list, where n = Index.
Private Member Functions
	CC_DECLARE_DYNAMIC (EPSCommentList)
Private Attributes
EPSCommentDef *	mpCommentList
INT32	mListSize

---

Detailed Description

Wraps up the EPSCommentDef structs into a list class. This will allow me to have a changeable list for different versions of the file, and as a result the whole importing of comments much less restrictive, but at the penalty of a speed hit. Looking up a token will be on O(n) operation, rather than the much quicker array look-up that currently exists.

Author:

Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>

Date:

28/4/00

See also:

EPSFilter

Definition at line 119 of file epsclist.h.

---

Constructor & Destructor Documentation

EPSCommentList::EPSCommentList (  void   )

Creates the class, and sets all the variables to be a default value. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 28/4/00 Parameters: -  [INPUTS] Returns: - See also: EPSCommentList::~EPSCommentList Definition at line 117 of file epsclist.cpp. { // Set the comment list pointer to be NULL, so as to avoid any problems with adding // items to it. mpCommentList = NULL; mListSize = 0; }

EPSCommentList::~EPSCommentList (  void   )

Destroys the class, and all of its member variables. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 28/4/00 Parameters: -  [INPUTS] Returns: - See also: EPSCommentList::EPSCommentList Definition at line 138 of file epsclist.cpp. { // Delete the list. This invokes a recursive call to remove all successive items. delete mpCommentList; }

---

Member Function Documentation

BOOL EPSCommentList::Add (  TCHAR *  pStart, TCHAR *  pEnd, BOOL  DoProcessComments, UINT32  NestingDepth )

Adds a list item to the end of mpCommentList record. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 28/4/00 Parameters: pStart  - Pointer to the comment starting a comment block. [INPUTS] pEnd - Pointer to the comment that ends this block. DoProcessComments - Do the comments need processing? NestingDepth - The depth to which comments can be nested. Returns: TRUE - Success. FALSE - The object was not created. See also: EPSCommentDef::EPSCommentDef Definition at line 164 of file epsclist.cpp. { // Create a new EPSCommentDef, and assign the appropriate values. EPSCommentDef *pNewDef = new EPSCommentDef ( pStart, pEnd, DoProcessComments, NestingDepth ); // Determine whether something was created. if ( pNewDef != NULL ) { // Add it to the end of the list. if ( mpCommentList == NULL ) { // The pointer is NULL, so just assign the value. mpCommentList = pNewDef; } else { // There already is a list, so add this to it. mpCommentList->Add ( pNewDef ); } // Maintain a count of the number of elements in the list. mListSize ++; return TRUE; } else { // Not enough memory. return FALSE; } }

EPSCommentList::CC_DECLARE_DYNAMIC (  EPSCommentList   )  [private]

const EPSCommentDef & EPSCommentList::ReturnElement (  INT32  Index  )

Returns a reference to the nth item in the linked list, where n = Index. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 1/5/00 Parameters: Index  - The number of the element to be accessed. [INPUTS] Returns: &pItem - A reference to an item in the list. Definition at line 212 of file epsclist.cpp. { // Set up the local variables. EPSCommentDef *pItem = mpCommentList; EPSCommentDef *pNext = NULL; INT32 Count = 0; // Ensure that the comment list has been initialised. ERROR1IF ( pItem == NULL, EmptyDefinition, "The comment list hasn't been initialised!" ); // Catch out-of-bounds calls. if ( Index >= mListSize ) return EmptyDefinition; // Loop through the list until there are no more items, or we reach the right index. while ( pNext = pItem->GetNext (), Count < Index && pNext != NULL ) { pItem = pNext; Count ++; } // Return the appropriate list item. return *pItem; }

---

Member Data Documentation

INT32 EPSCommentList::mListSize [private]

Definition at line 139 of file epsclist.h.

EPSCommentDef* EPSCommentList::mpCommentList [private]

Definition at line 138 of file epsclist.h.

---

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

• Kernel/epsclist.h (r1785/r751)
• Kernel/epsclist.cpp (r1785/r1282)

---