00001 // $Id: xpoilflt.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 // The module that controls the OIL side of plugin import/export filters. 00100 00101 #ifndef INC_XPOILFLT 00102 #define INC_XPOILFLT 00103 00104 //#include "oilfltrs.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00105 #include "xpfcaps.h" 00106 #include "xmlutils.h" 00107 #include "camprocess.h" 00108 00109 class PluginNativeFilter; 00110 00111 class PluginFilterProcess : public CamProcess 00112 { 00113 public: 00114 PluginFilterProcess(PluginNativeFilter* pFilter, CCLexFile* pInFile = NULL, CCLexFile* pOutFile = NULL); 00115 virtual ~PluginFilterProcess(); 00116 00117 // These are called to handle the various streams 00118 virtual void ProcessStdErr(); 00119 00120 BOOL ReportError(); 00121 void ReportWarning(); 00122 00123 protected: 00124 PluginNativeFilter* m_pFilter; 00125 wxArrayString m_Errors; 00126 wxArrayString m_Warnings; 00127 }; 00128 00129 00130 /******************************************************************************************** 00131 00132 > class PluginOILFilter : public OILFilter 00133 00134 Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> 00135 Created: 26/01/05 00136 Purpose: This class is used to encapsulate the platform specific features of a filter. 00137 Every Filter object has a pointer to an OILFilter object. For example, 00138 under Windows, it holds the file extensions that this file understands. 00139 SeeAlso: Filter 00140 00141 ********************************************************************************************/ 00142 00143 class PluginOILFilter : public OILFilter 00144 { 00145 CC_DECLARE_MEMDUMP(PluginOILFilter); 00146 00147 public: 00148 PluginOILFilter(Filter *pFilter); 00149 00150 // This function initialises the filter setting up the import and export flags, 00151 // the filter name and file extension 00152 // The parameter will almost certainly need to change when OILFilter::CreatePluginFilters 00153 // is implemented properly by scanning the installed filters 00154 BOOL Init( xmlNode* pFilterNode ); 00155 00156 BOOL IsImport() { return(m_bImport); } 00157 BOOL IsExport() { return(m_bExport); } 00158 00159 // The import and export functions 00160 // The mechanism may need to be modified to efficiently launch processes and 00161 // attach CCLexFile derived classes. 00162 // Currently GetExportFile is called first so it will only really support 00163 // outputting the Xar data to a temporary location so that it can be sent to the 00164 // filter's stdin when DoExport is called. 00165 // GetCapabilities doesn't really need the pFile parameter so it could be called 00166 // before GetExportFile. 00167 // At the moment, the easiest thing to do would probably be to load and save the 00168 // Xar data from temporary files and simply redirect stdin and stdout when running 00169 // the filter 00170 // I expect this will involve far less work than trying to attach a CCFile to a 00171 // external process though to handle the progress indication correctly, stderr will 00172 // need to be attached to in such a way that the loop that waits for the process to 00173 // exit can read the progress values from stderr and update the XaraLX progress system 00174 BOOL GetExportFile(PathName* pPath, CCLexFile** ppNewFile); 00175 BOOL GetCapabilities(CCLexFile* pFile, PathName* pPath, CapabilityTree* pCapTree); 00176 BOOL DoExport(CCLexFile* pXarFile, PathName* pPath); 00177 INT32 HowCompatible(PathName& FileName); 00178 BOOL GetImportFile(CCLexFile* pFile, CCLexFile** ppNewFile); 00179 00180 void Cleanup(); 00181 00182 protected: 00183 // This function is called from GetCapabilities to parse the XML 00184 BOOL BuildCapabilityTree(wxString strXML, CapabilityTree* pCapTree); 00185 00186 // The functions from here down to CreateColourNode are all concerned with the 00187 // parsing of the XML and the creation of the CapabilityTree 00188 BOOL ReadOptions(xmlNodePtr pNode, CapabilityTree* pCapTree); 00189 BOOL ReadRasterise(xmlNodePtr pNode, CapabilityTree* pCapTree); 00190 BOOL ReadSpread(xmlNodePtr pNode, CapabilityTree* pCapTree); 00191 BOOL ReadObjects(xmlNodePtr pNode, CapabilityTree* pCapTree); 00192 BOOL ReadAttributes(xmlNodePtr pNode, CapabilityTree* pCapTree); 00193 BOOL ReadColour(xmlNodePtr pNode, CapabilityTree* pCapTree); 00194 00195 BOOL GetConvertAsType(xmlNodePtr pNode, XPFConvertType* pValue); 00196 BOOL GetXPFBOOL(xmlNodePtr pNode, LPTSTR pAttrName, XPFBOOL* pbValue); 00197 BOOL GetXPFProp(xmlNodePtr pNode, LPTSTR pAttrName, PropMapEntry aMap[], XPFProp* pValue); 00198 XPFCapability* CreateObjectNode(xmlNodePtr pNode); 00199 XPFCapability* CreateAttributeNode(xmlNodePtr pNode); 00200 XPFCapability* CreateColourNode(xmlNodePtr pNode); 00201 00202 protected: 00203 BOOL m_bImport; 00204 BOOL m_bExport; 00205 00206 wxString m_InternalName; // Internal name for filter (used to build path for XML config) 00207 wxString m_PrepareExport; // Command for PrepareExport 00208 wxString m_DoExport; // Command for DoExport 00209 wxString m_CanImport; // Command for CanImport 00210 wxString m_DoImport; // Command for DoImport 00211 00212 wxFileName m_XMLFile; // Full path to filter XML config file for the current user 00213 PathName m_TempXarFile; // Full path to temporary Xar file 00214 }; 00215 00216 00217 class AutoCleanOILFilter 00218 { 00219 public: 00220 AutoCleanOILFilter(PluginOILFilter* pOILFilter) : m_pOILFilter(pOILFilter) {} 00221 ~AutoCleanOILFilter() 00222 { 00223 if (m_pOILFilter) 00224 m_pOILFilter->Cleanup(); 00225 } 00226 00227 protected: 00228 PluginOILFilter* m_pOILFilter; 00229 }; 00230 00231 00232 class PathNameListItem : public ListItem 00233 { 00234 public: 00235 CC_DECLARE_DYNAMIC( PathNameListItem ) 00236 PathNameListItem(const PathName& Path) 00237 { 00238 m_Path = Path; 00239 } 00240 00241 PathName m_Path; 00242 }; 00243 00244 00245 #endif // INC_XPOILFLT