toollist.cpp

Go to the documentation of this file.
00001 // $Id: toollist.cpp 1361 2006-06-25 16:43:38Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 
00099 /*
00100 */
00101 
00102 #include "camtypes.h"
00103 
00104 #include "toollist.h"
00105 //#include "oiltool.h"
00106 //#include "ensure.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00107 
00108 DECLARE_SOURCE("$Revision: 1361 $");
00109 
00110 CC_IMPLEMENT_MEMDUMP(ToolListItem, ListItem);
00111 // Declare smart memory handling in Debug builds
00112 #define new CAM_DEBUG_NEW
00113 
00114 /********************************************************************************************
00115 
00116 >   ToolListItem(Tool *NewTool, UINT32 ParentID)
00117 
00118     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00119     Created:    30/6/93
00120     Inputs:     NewTool - Pointer to the tool to fill in the list item with.
00121                 ParentID - Module ID of the module that provides this tool.
00122     Purpose:    Create a new ToolListItem with the tool pointer and info fields
00123                 filled in.  The info fields are filled in by interrogating the tool.
00124                 A new OILTool object is created for this tool, and linked in to the
00125                 list item.
00126                 The tool is linked to the ToolListItem via the Parent member variable, as
00127                 this means it is easy to get hold of the tool's info (ToolInfo object)
00128                 given a pointer to a tool (otherwise you have to do GetID() and call
00129                 Tool::Find() to get the Tool info, which is a bit daft).
00130 
00131 ********************************************************************************************/
00132 
00133 ToolListItem::ToolListItem(Tool *NewTool, UINT32 ParentID)
00134 {
00135     m_fInitialised = FALSE;
00136     NewTool->Describe( &m_ToolInfo );
00137     m_ToolInfo.ParentModuleID = ParentID;
00138     m_pTool = NewTool;
00139     NewTool->Parent = this;
00140 }
00141 
00142 /********************************************************************************************
00143 
00144 >   ToolListItem::~ToolListItem()
00145 
00146     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00147     Created:    6/7/93
00148     Purpose:    Destructor.  Deletes the associated Tool and OILTool objects.
00149     Errors:     Asserts if the Tool object is not valid (i.e. NULL)
00150 
00151 ********************************************************************************************/
00152 
00153 ToolListItem::~ToolListItem()
00154 {
00155     // m_pTool may be NULL if the tool didn't initialise properly, because the Add() function 
00156     // will 'de-install' the tool from this list item to stop it being deleted
00157     // prematurely.
00158     delete m_pTool;
00159 
00160     // m_pOILTool may be NULL if the 'new' failed so don't assert (and our 
00161     // SimpleCCObject::delete can handle 'delete NULL;').
00162 //  delete m_pOILTool;
00163 }
00164 
00165 
00166 CC_IMPLEMENT_MEMDUMP(ToolList, List);
00167 
00168 /********************************************************************************************
00169 
00170 >   ToolList::~ToolList()
00171 
00172     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00173     Created:    7/7/93
00174     Inputs:     -
00175     Outputs:    -
00176     Returns:    -
00177     Purpose:    Destroys a ToolList object.  Deletes the Tool and OILTool objects contained
00178                 in the list items, and deletes the list items themselves.
00179     Errors:     -
00180     SeeAlso:    ~ToolListItem
00181 
00182 ********************************************************************************************/
00183 
00184 ToolList::~ToolList()
00185 {
00186     // Call destructors on all objects in the list
00187     
00188     ToolListItem *Item = (ToolListItem *) RemoveHead();
00189     
00190     while (Item != NULL)
00191     {
00192         // Delete the list item
00193         delete Item;
00194         
00195         // Try the next item
00196         Item = (ToolListItem *) RemoveHead();
00197     }
00198 }
00199 
00200 
00201 /********************************************************************************************
00202 
00203 >   ToolListItem *ToolList::Add(Tool *NewTool, UINT32 ParentID)
00204 
00205     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00206     Created:    30/6/93
00207     Inputs:     NewTool - pointer to the tool to add into the list.
00208                 ParentID - Module ID of the module that provides this tool.
00209     Outputs:    -
00210     Returns:    Pointer to the new item in the list if the tool was successfully added,
00211                 NULL otherwise.
00212     Purpose:    Safe addition of tools to the kernel's list of known tools.  A tool
00213                 will only be added if its ID has not already been used.
00214     Errors:     -
00215     SeeAlso:    -
00216 
00217 ********************************************************************************************/
00218 
00219 ToolListItem *ToolList::Add(Tool *NewTool, UINT32 ParentID)
00220 {
00221     // Construct a tentative list item
00222     ToolListItem *NewItem = new ToolListItem(NewTool, ParentID);
00223     if (NewItem == NULL)
00224         goto AbnormalExit;
00225     
00226     // Create a new OIL tool for this node
00227 //  NewItem->m_pOILTool = new OILTool(ParentID);
00228 //  if (NewItem->m_pOILTool == NULL)
00229 //      goto AbnormalExit;
00230     
00231     // Interrogate tool about itself.
00232 /*  if (NewItem->ToolInfo.ID == TOOLID_INVALID)
00233         goto AbnormalExit;
00234     
00235     
00236     // Search list to make sure this ID is not already in use.
00237     // (If I use one line initialisation the compiler complains that the gotos avoid it.)
00238     ToolListItem *Item;
00239     Item = (ToolListItem *) GetHead();
00240     
00241     while (Item != NULL)
00242     {
00243         if (Item->ToolInfo.ID == NewItem->ToolInfo.ID)
00244             // Found ID already in use - discard new list item and abort.
00245             goto AbnormalExit;
00246         
00247         // Try the next node in the list.
00248         Item = (ToolListItem *) GetNext(Item);
00249     }
00250 */  
00251     // The ID is not already in use so add the tool to the list.
00252     AddTail(NewItem);
00253     return NewItem;
00254     
00255     // Abnormal exit - clean up and return a NULL pointer to indicate it didn't work.
00256 AbnormalExit:
00257     // Set Tool pointer to NULL to avoid it being deleted by the ToolListItem's destructor, because
00258     // the caller is not expecting this tool to be deleted from under its feet.
00259     NewItem->m_pTool = NULL;
00260 
00261     // Delete the ToolListItem
00262     delete NewItem;
00263 
00264     return NULL;
00265 }
00266 
00267 

Generated on Sat Nov 10 03:47:11 2007 for Camelot by  doxygen 1.4.4