ModuleList Class Reference

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

#include <modlist.h>

Inheritance diagram for ModuleList:

List of all members.

Public Member Functions
	~ModuleList ()
	Destroys a module list, destroying all modules in the list too.
ModuleListItem *	Add (Module *, OILModule *)
	Safe addition of modules to the kernel's list of known modules. A module will only be added if its ID has not already been used.
Private Member Functions
	CC_DECLARE_MEMDUMP (ModuleList)

---

Detailed Description

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

Author:

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

Date:

30/6/93

See also:

ModuleListItem

Definition at line 158 of file modlist.h.

---

Constructor & Destructor Documentation

ModuleList::~ModuleList (   )

Destroys a module list, destroying all modules in the list too. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 184 of file modlist.cpp. { // Call destructors on all objects in the list ModuleListItem *Item = (ModuleListItem *) RemoveHead(); while (Item != NULL) { // Delete the list item delete Item; // Try the next item Item = (ModuleListItem *) RemoveHead(); } }

---

Member Function Documentation

ModuleListItem * ModuleList::Add (  Module *  pNewModule, OILModule *  pNewOILModule )

Safe addition of modules to the kernel's list of known modules. A module 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: pNewModule  - pointer to the module to add into the list. [INPUTS] pNewOILModule - pointer to the OILModule object to associate with this module. -  [OUTPUTS] Returns: Pointer to the new item in the list if the module was successfully added, NULL otherwise. Errors: - See also: ModuleListItem Definition at line 220 of file modlist.cpp. { // Construct a tentative list item. ModuleListItem *NewItem = new ModuleListItem(pNewModule, pNewOILModule); if (NewItem == NULL) return NULL; // Fill in the OILModule pointer with the pointer provided by the caller. NewItem->m_pOILModule = pNewOILModule; // Interrogate module about itself. if( NewItem->m_ModInfo.ID == MODULEID_INVALID ) { // Invalid ID - discard new list item and abort. NewItem->m_pModule = NULL; // dont delete the module delete NewItem; return NULL; } // Search list to make sure this ID is not already in use. ModuleListItem *Item = (ModuleListItem *) GetHead(); while (Item != NULL) { if( Item->m_ModInfo.ID == NewItem->m_ModInfo.ID ) { // Found ID already in use - discard new list item and abort. NewItem->m_pModule = NULL; // dont delete the module delete NewItem; return NULL; } // Try the next node in the list. Item = (ModuleListItem *) GetNext(Item); } // The ID is not already in use so add the module to the list. AddTail(NewItem); return NewItem; }

ModuleList::CC_DECLARE_MEMDUMP (  ModuleList   )  [private]

---

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

• Kernel/modlist.h (r1785/r1282)
• Kernel/modlist.cpp (r1785/r1464)

---