ToolList Class Reference

Used by the kernel to hold information on all the tools it currently knows about. It has an overloaded Add function which will only add tools if their ID has not already been used by another tool. More...

#include <toollist.h>

Inheritance diagram for ToolList:

List of all members.

Public Member Functions
	~ToolList ()
	Destroys a ToolList object. Deletes the Tool and OILTool objects contained in the list items, and deletes the list items themselves.
ToolListItem *	Add (Tool *, UINT32 ParentID)
	Safe addition of tools to the kernel's list of known tools. A tool will only be added if its ID has not already been used.
Private Member Functions
	CC_DECLARE_MEMDUMP (ToolList)

---

Detailed Description

Used by the kernel to hold information on all the tools it currently knows about. It has an overloaded Add function which will only add tools if their ID has not already been used by another tool.

Author:

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

Date:

30/6/93

See also:

ToolListItem

Definition at line 153 of file toollist.h.

---

Constructor & Destructor Documentation

ToolList::~ToolList (   )

Destroys a ToolList object. Deletes the Tool and OILTool objects contained in the list items, and deletes the list items themselves. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: ~ToolListItem Definition at line 184 of file toollist.cpp. { // Call destructors on all objects in the list ToolListItem *Item = (ToolListItem *) RemoveHead(); while (Item != NULL) { // Delete the list item delete Item; // Try the next item Item = (ToolListItem *) RemoveHead(); } }

---

Member Function Documentation

ToolListItem * ToolList::Add (  Tool *  NewTool, UINT32  ParentID )

Safe addition of tools to the kernel's list of known tools. A tool will only be added if its ID has not already been used. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: NewTool  - pointer to the tool to add into the list. [INPUTS] ParentID - Module ID of the module that provides this tool. -  [OUTPUTS] Returns: Pointer to the new item in the list if the tool was successfully added, NULL otherwise. Errors: - See also: - Definition at line 219 of file toollist.cpp. { // Construct a tentative list item ToolListItem *NewItem = new ToolListItem(NewTool, ParentID); if (NewItem == NULL) goto AbnormalExit; // Create a new OIL tool for this node // NewItem->m_pOILTool = new OILTool(ParentID); // if (NewItem->m_pOILTool == NULL) // goto AbnormalExit; // Interrogate tool about itself. /* if (NewItem->ToolInfo.ID == TOOLID_INVALID) goto AbnormalExit; // Search list to make sure this ID is not already in use. // (If I use one line initialisation the compiler complains that the gotos avoid it.) ToolListItem *Item; Item = (ToolListItem *) GetHead(); while (Item != NULL) { if (Item->ToolInfo.ID == NewItem->ToolInfo.ID) // Found ID already in use - discard new list item and abort. goto AbnormalExit; // Try the next node in the list. Item = (ToolListItem *) GetNext(Item); } */ // The ID is not already in use so add the tool to the list. AddTail(NewItem); return NewItem; // Abnormal exit - clean up and return a NULL pointer to indicate it didn't work. AbnormalExit: // Set Tool pointer to NULL to avoid it being deleted by the ToolListItem's destructor, because // the caller is not expecting this tool to be deleted from under its feet. NewItem->m_pTool = NULL; // Delete the ToolListItem delete NewItem; return NULL; }

ToolList::CC_DECLARE_MEMDUMP (  ToolList   )  [private]

---

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

• Kernel/toollist.h (r1785/r1282)
• Kernel/toollist.cpp (r1785/r1361)

---