epsclist.cpp

Go to the documentation of this file.
00001 // $Id: epsclist.cpp 1282 2006-06-09 09:46:49Z 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 #include "camtypes.h"
00099 //#include "epsclist.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00100 #include "epscdef.h"
00101 
00102 CC_IMPLEMENT_DYNAMIC ( EPSCommentList, CCObject )
00103 
00104 /********************************************************************************************
00105 
00106 >   EPSCommentList::EPSCommentList ( void )
00107 
00108     Author:     Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
00109     Created:    28/4/00
00110     Inputs:     -
00111     Returns:    -
00112     Purpose:    Creates the class, and sets all the variables to be a default value.
00113     SeeAlso:    EPSCommentList::~EPSCommentList
00114 
00115 ********************************************************************************************/
00116 
00117 EPSCommentList::EPSCommentList ( void )
00118 {
00119     // Set the comment list pointer to be NULL, so as to avoid any problems with adding
00120     // items to it.
00121     mpCommentList   = NULL;
00122     mListSize       = 0;
00123 }
00124 
00125 /********************************************************************************************
00126 
00127 >   EPSCommentList::~EPSCommentList ( void )
00128 
00129     Author:     Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
00130     Created:    28/4/00
00131     Inputs:     -
00132     Returns:    -
00133     Purpose:    Destroys the class, and all of its member variables.
00134     SeeAlso:    EPSCommentList::EPSCommentList
00135 
00136 ********************************************************************************************/
00137 
00138 EPSCommentList::~EPSCommentList ( void )
00139 {
00140     // Delete the list. This invokes a recursive call to remove all successive items.
00141     delete mpCommentList;
00142 }
00143 
00144 /********************************************************************************************
00145 
00146 >   BOOL EPSCommentList::Add ( TCHAR    *pStart,
00147                                TCHAR    *pEnd,
00148                                BOOL     DoProcessComments,
00149                                UINT32       NestingDepth )
00150 
00151     Author:     Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
00152     Created:    28/4/00
00153     Inputs:     pStart              - Pointer to the comment starting a comment block.
00154                 pEnd                - Pointer to the comment that ends this block.
00155                 DoProcessComments   - Do the comments need processing?
00156                 NestingDepth        - The depth to which comments can be nested.
00157     Returns:    TRUE                - Success.
00158                 FALSE               - The object was not created.
00159     Purpose:    Adds a list item to the end of mpCommentList record.
00160     SeeAlso:    EPSCommentDef::EPSCommentDef
00161 
00162 ********************************************************************************************/
00163 
00164 BOOL EPSCommentList::Add ( TCHAR    *pStart,
00165                            TCHAR    *pEnd,
00166                            BOOL     DoProcessComments,
00167                            UINT32       NestingDepth )
00168 {
00169     // Create a new EPSCommentDef, and assign the appropriate values.
00170     EPSCommentDef   *pNewDef    = new EPSCommentDef ( pStart, pEnd, DoProcessComments,
00171                                                       NestingDepth );
00172 
00173     // Determine whether something was created.
00174     if ( pNewDef != NULL )
00175     {
00176         // Add it to the end of the list.
00177         if ( mpCommentList == NULL )
00178         {
00179             // The pointer is NULL, so just assign the value.
00180             mpCommentList = pNewDef;
00181         }
00182         else
00183         {
00184             // There already is a list, so add this to it.
00185             mpCommentList->Add ( pNewDef );
00186         }
00187 
00188         // Maintain a count of the number of elements in the list.
00189         mListSize ++;
00190 
00191         return TRUE;
00192     }
00193     else
00194     {
00195         // Not enough memory.
00196         return FALSE;
00197     }
00198 }
00199 
00200 /********************************************************************************************
00201 
00202 >   const EPSCommentDef& EPSCommentList::ReturnElement ( INT32 Index );
00203 
00204     Author:     Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
00205     Created:    1/5/00
00206     Inputs:     Index   - The number of the element to be accessed.
00207     Returns:    &pItem  - A reference to an item in the list.
00208     Purpose:    Returns a reference to the nth item in the linked list, where n = Index.
00209 
00210 ********************************************************************************************/
00211 
00212 const EPSCommentDef& EPSCommentList::ReturnElement ( INT32 Index )
00213 {
00214     // Set up the local variables.
00215     EPSCommentDef   *pItem  = mpCommentList;
00216     EPSCommentDef   *pNext  = NULL;
00217     INT32               Count   = 0;
00218 
00219     // Ensure that the comment list has been initialised.
00220     ERROR1IF ( pItem == NULL, EmptyDefinition,
00221                "The comment list hasn't been initialised!" );
00222 
00223     // Catch out-of-bounds calls.
00224     if ( Index >= mListSize )
00225         return EmptyDefinition;
00226 
00227     // Loop through the list until there are no more items, or we reach the right index.
00228     while ( pNext = pItem->GetNext (), Count < Index && pNext != NULL )
00229     {
00230         pItem = pNext;
00231         Count ++;
00232     }
00233 
00234     // Return the appropriate list item.
00235     return *pItem;
00236 }

Generated on Sat Nov 10 03:45:05 2007 for Camelot by  doxygen 1.4.4