00001 // $Id: filtrmgr.h 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 // 00099 00100 #ifndef INC_FILTRMGR 00101 #define INC_FILTRMGR 00102 00103 #include "ccarray.h" 00104 //#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00105 00106 typedef UINT32 FileFormatID; 00107 00108 class Filter; 00109 /************************************************************************************** 00110 00111 > class FilterList : public List 00112 00113 Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> 00114 Created: Today 00115 Purpose: Take out some of the functionality from filters 00116 00117 **************************************************************************************/ 00118 class FilterList : public List 00119 { 00120 CC_DECLARE_MEMDUMP(FilterList) 00121 public: 00122 FilterList(); 00123 00124 BOOL AddFilter(Filter* const pFilter, const UINT32 ID); 00125 }; 00126 00127 00128 class FileFormat; 00129 class FormatEntry; 00130 class FilterEntry; 00131 class FilterList; 00132 class FilterSearchCriteria; 00133 00134 class FormatArray : public CCArray<FormatEntry*, FormatEntry*&> 00135 { 00136 }; 00137 00138 class FileFormat; 00139 /************************************************************************************** 00140 00141 > class FilterManager : public CC_CLASS_MEMDUMP 00142 00143 Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> 00144 Created: Today 00145 Purpose: Take out some of the functionality from filters 00146 00147 **************************************************************************************/ 00148 class FilterManager : public CC_CLASS_MEMDUMP 00149 { 00150 // Declare the class for memory tracking 00151 CC_DECLARE_MEMDUMP(FilterManager); 00152 00153 public: 00154 FilterManager(); 00155 00156 BOOL Init(); 00157 INT32 DeInit(); 00158 00159 // Registering functions 00160 // What to do with filters, formats & families at the end of the day 00161 enum DESTRUCTION_METHOD 00162 { 00163 DM_INVALID = 0, // don't use this, it's for catching duff initialization 00164 DM_DELETE_WHEN_DONE = 1, 00165 DM_KEEP_WHEN_DONE 00166 }; 00167 00168 UINT32 RegisterFilter( Filter* const pFilter, 00169 const DESTRUCTION_METHOD DestructMethod); 00170 FileFormatID RegisterFileFormat( FileFormat* const pFormat, 00171 const DESTRUCTION_METHOD DestructMethod); 00172 00173 // Aggregation functions 00174 BOOL AssociateFilterWithFormat( const UINT32 FilterID, 00175 const FileFormatID FileFormatID); 00176 00177 // Search functions 00178 // Filters... 00179 Filter* FindFilterFromID(const UINT32 FilterID) const; 00180 00181 Filter* FindFilter(FilterSearchCriteria& Criteria) const; 00182 FilterList* ListMatchingFilters(FilterSearchCriteria& Criteria); 00183 00184 // FileFormats... 00185 FileFormat* FindFormatFromID(const FileFormatID FormatID) const; 00186 FileFormat* FindFormatFromName(const StringBase& FormatName) const; 00187 FileFormatID FindFormatIDFromName(const StringBase& Name) const; 00188 00189 protected: 00190 List& GetFilters() const; 00191 const UINT32 FILTERID_START; 00192 UINT32 GetNewFilterID(); 00193 00194 FormatArray& GetFormats(); 00195 const FormatArray& GetFormats() const { return m_Formats; } 00196 const FileFormatID FORMATID_START; 00197 FileFormatID GetNewFormatID(); 00198 FileFormatID GetLastFormatID() const { return m_NextFormatID - 1; } 00199 00200 // And for searching 00201 FormatEntry* FindFormatEntryFromID(const FileFormatID FormatID) const; 00202 FormatEntry* FindFormatEntryFromName(const StringBase& FormatName) const; 00203 00204 private: 00205 // Lists of things the filter manager works with 00206 UINT32 m_NextFilterID; 00207 00208 FormatArray m_Formats; 00209 FileFormatID m_NextFormatID; 00210 }; 00211 00212 00213 /******************************************************************************************** 00214 00215 > class FilterEntry : public ListItem 00216 00217 Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim) 00218 Created: 28/03/94 00219 Purpose: A simple ListItem derived class to allow a list of filters to be 00220 maintained - the list holds all the filters that claim to understand a 00221 particular file (see FilterFamily). 00222 It is not derived from the Filter class itself because although the Filter 00223 class is derived from ListItem too, we want to store a list of pointers to 00224 existing filters, rather than actual instances of the Filter class. 00225 For each entry, a 'compatibility rating' is held, to allow the 00226 FilterFamily class (the client of this class) to choose the most 00227 compatible filter from the list. 00228 SeeAlso: CompatibleFilterList; Filter; ListItem 00229 00230 ********************************************************************************************/ 00231 class FilterEntry : public ListItem 00232 { 00233 CC_DECLARE_MEMDUMP(FilterEntry) 00234 00235 public: 00236 FilterEntry(Filter* const pFilter, const UINT32 ID); 00237 00238 protected: 00239 // Compatibility rating for this filter. 00240 Filter* m_pFilter; 00241 UINT32 m_FilterID; 00242 00243 }; 00244 00245 /******************************************************************************************** 00246 00247 > class FormatEntry : protected CC_CLASS_MEMDUMP 00248 00249 Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> 00250 Created: 28/11/96 00251 Purpose: A simple ListItem derived class to allow a list of filters to be 00252 maintained 00253 SeeAlso: FilterList 00254 Scope: private to FilterManager 00255 00256 ********************************************************************************************/ 00257 class FilterManager; 00258 00259 class FormatEntry : public CC_CLASS_MEMDUMP 00260 { 00261 CC_DECLARE_MEMDUMP(FormatEntry) 00262 00263 public: 00264 FormatEntry(const FileFormatID ID, FileFormat* const pFormat, 00265 const FilterManager::DESTRUCTION_METHOD DestructMethod); 00266 00267 ~FormatEntry(); 00268 00269 FileFormat* GetFormat() const { return m_pFormat; } 00270 FileFormatID GetID() const { return m_FormatID; } 00271 FilterList& GetFilters() { return m_AssociatedFilters; } 00272 00273 FilterManager::DESTRUCTION_METHOD GetDestructionMethod() const 00274 { return m_DestructMethod; } 00275 00276 protected: 00277 00278 FileFormat* m_pFormat; // Pointer to the format in question. 00279 FileFormatID m_FormatID; // and it's ID 00280 FilterList m_AssociatedFilters; // A list of filters that think they can cope 00281 00282 // What to do with the format at the end... 00283 FilterManager::DESTRUCTION_METHOD m_DestructMethod; 00284 }; 00285 00286 00287 #endif // INC_FILTRMGR