PluginOILFilter Class Reference

This class is used to encapsulate the platform specific features of a filter. Every Filter object has a pointer to an OILFilter object. For example, under Windows, it holds the file extensions that this file understands. More...

#include <xpoilflt.h>

Inheritance diagram for PluginOILFilter:

List of all members.

Public Member Functions
	PluginOILFilter (Filter *pFilter)
	Sets up the list of filename extensions that this filter understands and handles connection to external plugin object.
BOOL	Init (xmlNode *pFilterNode)
	Initialises the OIL specific parts of this filter (file extension, file type name, link to COM object etc).
BOOL	IsImport ()
BOOL	IsExport ()
BOOL	GetExportFile (PathName *pPath, CCLexFile **ppNewFile)
BOOL	GetCapabilities (CCLexFile *pFile, PathName *pPath, CapabilityTree *pCapTree)
BOOL	DoExport (CCLexFile *pXarFile, PathName *pPath)
INT32	HowCompatible (PathName &FileName)
	This function is called to determine if this plugin object can accept the specified file.
BOOL	GetImportFile (CCLexFile *pFile, CCLexFile **ppNewFile)
void	Cleanup ()
Protected Member Functions
BOOL	BuildCapabilityTree (wxString strXML, CapabilityTree *pCapTree)
	Populates a CapabilityTree object with the XML.
BOOL	ReadOptions (xmlNodePtr pNode, CapabilityTree *pCapTree)
BOOL	ReadRasterise (xmlNodePtr pNode, CapabilityTree *pCapTree)
BOOL	ReadSpread (xmlNodePtr pNode, CapabilityTree *pCapTree)
BOOL	ReadObjects (xmlNodePtr pNode, CapabilityTree *pCapTree)
BOOL	ReadAttributes (xmlNodePtr pNode, CapabilityTree *pCapTree)
BOOL	ReadColour (xmlNodePtr pNode, CapabilityTree *pCapTree)
BOOL	GetConvertAsType (xmlNodePtr pNode, XPFConvertType *pValue)
BOOL	GetXPFBOOL (xmlNodePtr pNode, LPTSTR pAttrName, XPFBOOL *pbValue)
BOOL	GetXPFProp (xmlNodePtr pNode, LPTSTR pAttrName, PropMapEntry aMap[], XPFProp *pValue)
XPFCapability *	CreateObjectNode (xmlNodePtr pNode)
XPFCapability *	CreateAttributeNode (xmlNodePtr pNode)
XPFCapability *	CreateColourNode (xmlNodePtr pNode)
Protected Attributes
BOOL	m_bImport
BOOL	m_bExport
wxString	m_InternalName
wxString	m_PrepareExport
wxString	m_DoExport
wxString	m_CanImport
wxString	m_DoImport
wxFileName	m_XMLFile
PathName	m_TempXarFile
Private Member Functions
	CC_DECLARE_MEMDUMP (PluginOILFilter)

---

Detailed Description

This class is used to encapsulate the platform specific features of a filter. Every Filter object has a pointer to an OILFilter object. For example, under Windows, it holds the file extensions that this file understands.

Author:

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

Date:

26/01/05

See also:

Filter

Definition at line 143 of file xpoilflt.h.

---

Constructor & Destructor Documentation

PluginOILFilter::PluginOILFilter (  Filter *  pFilter  )

Sets up the list of filename extensions that this filter understands and handles connection to external plugin object. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 26/01/05 Definition at line 223 of file xpoilflt.cpp. : OILFilter(pFilter) { m_bImport = FALSE; m_bExport = FALSE; }

---

Member Function Documentation

BOOL PluginOILFilter::BuildCapabilityTree (  wxString  strXmlFilename, CapabilityTree *  pCapTree )  [protected]

Populates a CapabilityTree object with the XML. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 17/03/2005 Parameters: bsXML  - The XML to load [INPUTS] pCapTree - pointer to a CapabilityTree to be filled in Returns: Standard HRESULT Definition at line 686 of file xpoilflt.cpp. { // First we need to load the XML into an XML DOM object // Set Parser flags here? // hRes = pDoc->setProperty(CComBSTR(_T("SelectionLanguage")), CComVariant(_T("XPath"))); // hRes = pDoc->put_async(VARIANT_FALSE); // hRes = pDoc->put_preserveWhiteSpace(VARIANT_TRUE); // hRes = pDoc->put_validateOnParse(VARIANT_FALSE); // hRes = pDoc->put_resolveExternals(VARIANT_FALSE); BOOL bOK = TRUE; xmlDocPtr doc; // If string param contains xml (like original Windows version) // wxCharBuffer buf = strXML.mb_str(wxConvUTF8); // doc = xmlParseDoc((const xmlChar*)buf.data()); // buf will be deallocated when it goes out of scope // If string param gives xml filename (like new LX version) wxCharBuffer buf = strXmlFilename.ToAscii(); doc = xmlParseFile(buf.data()); // buf will be deallocated when it goes out of scope #if _DEBUG if (doc==NULL) doc = xmlParseFile("/tmp/XaraLX/capstest.xml"); #endif ERROR1IF(doc==NULL, FALSE, _R(IDE_XPF_BADXML)); // The name of the root element should be XPFilterConfig xmlNodePtr node = xmlDocGetRootElement(doc); wxString strName = CXMLUtils::ConvertToWXString(node->name); if (strName!=_T("XPFilterConfig")) ERROR1(FALSE, _R(IDE_XPF_BADXML)); xmlNodePtr pChild = node->children; INT32 Phase =0; // There are 7 phases to the parsing // We will loop round until we run out of child elements // After parsing a node the phase counter will be set to the phase just parsed // If an element should have already been parsed (using the phase counter) // then an error will be indicated while (pChild && bOK) { wxString strChildName = CXMLUtils::ConvertToWXString(pChild->name); if (strChildName == _T("#text") || xmlNodeIsText(pChild)) { // ignore it } else if (strChildName == _T("Private")) { if (Phase > 0) { ERROR1(FALSE, _R(IDE_XPF_BADXML_PHASE0)); } // Ignore the entire element Phase = 1; } else if (strChildName == _T("Options")) { if (Phase > 1) { ERROR1(FALSE, _R(IDE_XPF_BADXML_PHASE1)); } bOK = ReadOptions(pChild, pCapTree); // Read the options attributes Phase = 2; } else if (strChildName == _T("Rasterise")) { if (Phase > 2) { ERROR1(FALSE, _R(IDE_XPF_BADXML_PHASE2)); } bOK = ReadRasterise(pChild, pCapTree); // Read the dpi and alpha attributes Phase = 3; } else if (strChildName == _T("Spread")) { if (Phase > 3) { ERROR1(FALSE, _R(IDE_XPF_BADXML_PHASE3)); } bOK = ReadSpread(pChild, pCapTree); // Read the as attribute Phase = 4; } else if (strChildName == _T("Objects")) { if (Phase > 4) { ERROR1(FALSE, _R(IDE_XPF_BADXML_PHASE4)); } bOK = ReadObjects(pChild, pCapTree); // Build the tree of XPFCapability derived objects Phase = 5; } else if (strChildName == _T("Attributes")) { if (Phase > 5) { ERROR1(FALSE, _R(IDE_XPF_BADXML_PHASE5)); } bOK = ReadAttributes(pChild, pCapTree); // Build the tree of XPFCapability derived objects Phase = 6; } else if (strChildName == _T("Colour")) { if (Phase > 6) { ERROR1(FALSE, _R(IDE_XPF_BADXML_PHASE6)); } bOK = ReadColour(pChild, pCapTree); // Build the tree of XPFColour objects Phase = 7; } else { ERROR1(FALSE, _R(IDE_XPF_BADXML_UNEXPECTED_PHASE)); } pChild = pChild->next; } xmlFreeDoc(doc); return bOK; }

PluginOILFilter::CC_DECLARE_MEMDUMP (  PluginOILFilter   )  [private]

void PluginOILFilter::Cleanup (   )

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 18/02/2005 Definition at line 1594 of file xpoilflt.cpp. { }

XPFCapability * PluginOILFilter::CreateAttributeNode (  xmlNodePtr  pNode  )  [protected]

Definition at line 1414 of file xpoilflt.cpp. { XPFCapability* pCap = NULL; wxString strName = CXMLUtils::ConvertToWXString(pNode->name); if (strName == _T("#text") || xmlNodeIsText(pNode)) { wxString str = CXMLUtils::ConvertToWXString(xmlNodeGetContent(pNode)); TRACEUSER("Phil", _T("CreateAttributeNode ignoring text %s\n"), (LPCTSTR)str); return(NULL); } XPFConvertType AsType = XPFCONVTYPE_UNKNOWN; BOOL bOK = GetConvertAsType(pNode, &AsType); if (!bOK) { TRACEUSER("Phil", _T("CreateAttributeNode GetConvertAsType failed\n")); return NULL; } if (strName == _T("Fill")) { XPFProp Shape = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("shape"), aFillShapes, &Shape); XPFProp Repeat = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("repeat"), aFillRepeats, &Repeat); XPFBOOL bMultistage = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("multistage"), &bMultistage); XPFProp Effect = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("effect"), aColourEffects, &Effect); XPFBOOL bProfile = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("profile"), &bProfile); XPFBOOL bContone = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("contone"), &bContone); pCap = new XPFCFill(AsType, Shape, Repeat, bMultistage, Effect, bProfile, bContone); } else if (strName == _T("FillTrans")) { XPFProp Shape = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("shape"), aFillShapes, &Shape); XPFProp Type = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("type"), aTransTypes, &Type); XPFProp Repeat = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("repeat"), aFillRepeats, &Repeat); XPFBOOL bProfile = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("profile"), &bProfile); pCap = new XPFCFillTrans(AsType, Shape, Type, Repeat, bProfile); } else if (strName == _T("Line")) { XPFBOOL bDash = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("dash"), &bDash); XPFBOOL bArrowhead = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("arrowhead"), &bArrowhead); XPFProp Cap = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("cap"), aLineCaps, &Cap); XPFProp Join = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("join"), aLineJoins, &Join); XPFBOOL bStroke = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("stroke"), &bStroke); XPFBOOL bBrush = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("brush"), &bBrush); pCap = new XPFCLine(AsType, bDash, bArrowhead, Cap, Join, bStroke, bBrush); } else if (strName == _T("LineTrans")) { XPFProp Type = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("type"), aTransTypes, &Type); pCap = new XPFCLineTrans(AsType, Type); } else if (strName == _T("Feather")) { pCap = new XPFCFeather(AsType); } else { ERROR1(NULL, _R(IDE_XPF_BADXML_UNEXPECTED_ATTRTYPE)); } xmlNodePtr pChild; pChild = pNode->children; XPFCapability* pLast = NULL; while (pChild) { XPFCapability* pCapNode = CreateAttributeNode(pChild); if (pCapNode) { // If we have a node then add it to the list // If we do not have a node already then set m_pObjects if (pLast) { pLast->SetNext(pCapNode); } else { pCap->SetChild(pCapNode); } pLast = pCapNode; } pChild = pChild->next; } return(pCap); }

XPFCapability * PluginOILFilter::CreateColourNode (  xmlNodePtr  pNode  )  [protected]

Definition at line 1524 of file xpoilflt.cpp. { XPFCapability* pCap = NULL; wxString strName = CXMLUtils::ConvertToWXString(pNode->name); if (strName == _T("#text") || xmlNodeIsText(pNode)) { wxString str = CXMLUtils::ConvertToWXString(xmlNodeGetContent(pNode)); TRACEUSER("Phil", _T("CreateColourNode ignoring text %s\n"), (LPCTSTR)str); return(NULL); } XPFConvertType AsType = XPFCONVTYPE_UNKNOWN; BOOL bOK = GetConvertAsType(pNode, &AsType); if (!bOK) { TRACEUSER("Phil", _T("CreateColourNode GetConvertAsType failed\n")); return NULL; } if (strName == _T("Colour")) { pCap = new XPFCColour(AsType); } else { ERROR1(NULL, _R(IDE_XPF_BADXML_UNEXPECTED_COLOURTYPE)); } xmlNodePtr pChild; pChild = pNode->children; XPFCapability* pLast = NULL; while (pChild) { XPFCapability* pCapNode = CreateColourNode(pChild); if (pCapNode) { // If we have a node then add it to the list // If we do not have a node already then set m_pObjects if (pLast) { pLast->SetNext(pCapNode); } else { pCap->SetChild(pCapNode); } pLast = pCapNode; } pChild = pChild->next; } return(pCap); }

XPFCapability * PluginOILFilter::CreateObjectNode (  xmlNodePtr  pNode  )  [protected]

Definition at line 1230 of file xpoilflt.cpp. { XPFCapability* pCap = NULL; wxString strName = CXMLUtils::ConvertToWXString(pNode->name); if (strName == _T("#text") || xmlNodeIsText(pNode)) { wxString str = CXMLUtils::ConvertToWXString(xmlNodeGetContent(pNode)); TRACEUSER("Phil", _T("CreateObjectNode ignoring text %s\n"), (LPCTSTR)str); return(NULL); } XPFConvertType AsType = XPFCONVTYPE_UNKNOWN; BOOL bOK = GetConvertAsType(pNode, &AsType); if (!bOK) { TRACEUSER("Phil", _T("CreateObjectNode GetConvertAsType failed\n")); return NULL; } if (strName == _T("Layer")) { // Read the visible and locked attributes XPFBOOL bVisible = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("visible"), &bVisible); XPFBOOL bLocked = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("locked"), &bLocked); XPFBOOL bPrintable = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("printable"), &bPrintable); XPFBOOL bActive = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("active"), &bActive); XPFBOOL bBackground = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("background"), &bBackground); XPFBOOL bGuide = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("guide"), &bGuide); XPFProp ContentOnly = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("onlycontent"), aContentOnly, &ContentOnly); pCap = new XPFCLayer(AsType, bVisible, bLocked, bPrintable, bActive, bBackground, bGuide, ContentOnly); } else if (strName == _T("Contour")) { pCap = new XPFCContour(AsType); } else if (strName == _T("Shadow")) { // Read the type attribute XPFProp Type = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("type"), aShadowTypes, &Type); pCap = new XPFCShadow(AsType, Type); } else if (strName == _T("Bevel")) { // Read the type and side attributes XPFProp Type = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("type"), aBevelTypes, &Type); XPFProp Side = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("side"), aBevelSides, &Side); pCap = new XPFCBevel(AsType, Type, Side); } else if (strName == _T("Blend")) { // Read the effect, oncurve, posprofile and attrprofile attributes XPFProp Effect = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("effect"), aColourEffects, &Effect); XPFBOOL bOnCurve = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("oncurve"), &bOnCurve); XPFBOOL bObjProfile = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("posprofile"), &bObjProfile); XPFBOOL bAttrProfile = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("attrprofile"), &bAttrProfile); pCap = new XPFCBlend(AsType, Effect, bOnCurve, bObjProfile, bAttrProfile); } else if (strName == _T("Mould")) { // Read the as and type attributes XPFProp Type = XPFP_UNKNOWN; bOK = GetXPFProp(pNode, _T("type"), aMouldTypes, &Type); XPFBOOL bGradFill = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("gradfill"), &bGradFill); pCap = new XPFCMould(AsType, Type, bGradFill); } else if (strName == _T("Rectangle")) { // Read the as, rounded and complex attributes XPFBOOL bComplex = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("complex"), &bComplex); XPFBOOL bRounded = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("rounded"), &bRounded); XPFBOOL bStellated = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("stellated"), &bStellated); XPFBOOL bReformed = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("reformed"), &bReformed); pCap = new XPFCRectangle(AsType, bComplex, bRounded, bStellated, bReformed); } else if (strName == _T("Ellipse")) { // Read the as and complex attributes XPFBOOL bComplex = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("complex"), &bComplex); pCap = new XPFCEllipse(AsType, bComplex); } else if (strName == _T("Polygon")) { // Read the as, rounded, stellated and reformed attributes XPFBOOL bRounded = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("rounded"), &bRounded); XPFBOOL bStellated = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("stellated"), &bStellated); XPFBOOL bReformed = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("reformed"), &bReformed); pCap = new XPFCPolygon(AsType, bRounded, bStellated, bReformed); } else if (strName == _T("Bitmap")) { // Read the complex and contone attributes XPFBOOL bComplex = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("complex"), &bComplex); XPFBOOL bContone = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("contone"), &bContone); pCap = new XPFCBitmap(AsType, bComplex, bContone); } else if (strName == _T("Text")) { // Read the onpath, complex and plain attributes XPFBOOL bOnPath = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("onpath"), &bOnPath); XPFBOOL bComplex = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("complex"), &bComplex); XPFBOOL bPlain = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("plain"), &bPlain); XPFBOOL bAutoKern = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("autokern"), &bAutoKern); XPFBOOL bJustified = XPFB_UNKNOWN; bOK = GetXPFBOOL(pNode, _T("justified"), &bJustified); pCap = new XPFCText(AsType, bOnPath, bComplex, bPlain, bAutoKern, bJustified); } else if (strName == _T("ClipView")) { pCap = new XPFCClipView(AsType); } else if (strName == _T("BitmapEffect")) { pCap = new XPFCBitmapEffect(AsType); } else if (strName == _T("Feather")) { pCap = new XPFCFeather(AsType); } else { ERROR1(NULL, _R(IDE_XPF_BADXML_UNEXPECTED_OBJTYPE)); } xmlNodePtr pChild; pChild = pNode->children; XPFCapability* pLast = NULL; while (pChild) { XPFCapability* pCapNode = CreateObjectNode(pChild); if (pCapNode) { // If we have a node then add it to the list // If we do not have a node already then set m_pObjects if (pLast) { pLast->SetNext(pCapNode); } else { pCap->SetChild(pCapNode); } pLast = pCapNode; } pChild = pChild->next; } return(pCap); }

BOOL PluginOILFilter::DoExport (  CCLexFile *  pXarFile, PathName *  pPath )

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 18/02/2005 Parameters: pXarFile  - pointer to a CCLexFile [INPUTS] pPath - pointer to a PathName Returns: TRUE if ok, FALSE if bother Definition at line 621 of file xpoilflt.cpp. { // Here we should just need to wait for the process started in GetExportFile // to finish // Check stderr for errors and progress // However for now we will instead // Run the plugin with the following options // -e -g -f <filename> -x <xmlfilename> // The xmlfilename is a path to a user and filter specific file // e.g. ~/.XaraLX/filtername.xml // Check stderr for errors wxString sCommand(m_DoExport); sCommand.Replace(_T("%OUT%"), (LPCTSTR)pPath->GetPath()); sCommand.Replace(_T("%XML%"), m_XMLFile.GetFullPath()); TRACEUSER("Gerry", _T("Running '%s'"), sCommand.c_str()); CCDiskFile TempFile(CCFILE_DEFAULTSIZE, FALSE, FALSE); if (!TempFile.open(m_TempXarFile, ios::in | ios::binary)) { // report an error here return FALSE; } // Create a process with the TempFile as the stdin PluginFilterProcess* pTheProc = new PluginFilterProcess((PluginNativeFilter*)Parent, &TempFile, NULL); INT32 code = pTheProc->Execute(sCommand); TRACEUSER("Gerry", _T("Execute returned %d"), code); TempFile.close(); if (code != 0) { TRACEUSER("Gerry", _T("Execution of '%s' failed (%d)"), sCommand.c_str(), code); // Extract error and report it pTheProc->ReportError(); delete pTheProc; return(FALSE); } pTheProc->ReportWarning(); delete pTheProc; return(TRUE); }

BOOL PluginOILFilter::GetCapabilities (  CCLexFile *  pFile, PathName *  pPath, CapabilityTree *  pCapTree )

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 18/02/2005 Parameters: pPlugCaps  - pointer to a PluginCapabilities [INPUTS] Returns: TRUE if ok, FALSE if bother Definition at line 536 of file xpoilflt.cpp. { // Here we need to run the plugin synchronously with the following options // -p -f <filename> -x <xmlfilename> // The xmlfilename is a path to a user and filter specific file // e.g. ~/.XaraLX/filtername.xml // The XML is returned via the file // Does this need double quotes to cope with spaces in filenames? wxString sCommand(m_PrepareExport); sCommand.Replace(_T("%OUT%"), (LPCTSTR)pPath->GetPath()); sCommand.Replace(_T("%XML%"), m_XMLFile.GetFullPath()); TRACEUSER("Gerry", _T("Running '%s'"), sCommand.c_str()); wxArrayString saOutput; wxArrayString saErrors; INT32 code = wxExecute(sCommand, saOutput, saErrors, wxEXEC_NODISABLE); #ifdef _DEBUG for (UINT32 i = 0; i < saErrors.GetCount(); i++) { TRACEUSER("Gerry", _T("stderr: %s"), saErrors[i].c_str()); } #endif if (code == 0) { BOOL bOK = BuildCapabilityTree(m_XMLFile.GetFullPath(), pCapTree); if (!bOK) { // Assume BuildCapabilityTree has already set an error return FALSE; } } else { TRACEUSER("Gerry", _T("Command '%s' exited with code %d"), sCommand.c_str(), code); // Get error message from saErrors // Look for the first entry that starts "ERROR:" and set the remainder of // the line as the error message wxString line; size_t index = 0; while (index < saErrors.GetCount()) { wxString rest; if (saErrors[index].StartsWith(_T("ERROR:"), &rest)) { Error::SetError(0, rest.c_str(), 0); break; } index++; } if (index == saErrors.GetCount()) { ERROR1(FALSE, _R(IDS_XPF_NO_ERROR_SET)); } return(FALSE); } return(TRUE); }

BOOL PluginOILFilter::GetConvertAsType (  xmlNodePtr  pNode, XPFConvertType *  pValue )  [protected]

Definition at line 1076 of file xpoilflt.cpp. { XPFConvertType AsType = XPFCONVTYPE_UNKNOWN; if (pNode) { wxString str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"as")); if (!str.IsEmpty()) { if (str == _T("native")) { AsType = XPFCONVTYPE_NATIVE; } else if (str == _T("simple")) { AsType = XPFCONVTYPE_SIMPLE; } else if (str == _T("stroked")) { AsType = XPFCONVTYPE_STROKED; } else if (str == _T("bitmap")) { AsType = XPFCONVTYPE_BITMAP; } else if (str == _T("bitmapfill")) { AsType = XPFCONVTYPE_BITMAPFILL; } else if (str == _T("bitmaptrans")) { AsType = XPFCONVTYPE_BITMAPTRANS; } else if (str == _T("bitmapfilltrans")) { AsType = XPFCONVTYPE_BITMAPFILLTRANS; } else if (str == _T("bitmapspan")) { AsType = XPFCONVTYPE_BITMAPSPAN; } else if (str == _T("reformat")) { AsType = XPFCONVTYPE_REFORMAT; } else if (str == _T("remove")) { AsType = XPFCONVTYPE_REMOVE; } else if (str == _T("simplergb")) { AsType = XPFCONVTYPE_SIMPLERGB; } else if (str == _T("rgb")) { AsType = XPFCONVTYPE_RGB; } else if (str == _T("cmyk")) { AsType = XPFCONVTYPE_CMYK; } else { ERROR1(FALSE, _R(IDE_XPF_BADXML_UNKNOWN_CONVTYPE)); } } } else { ERROR1(FALSE, _R(IDE_XPF_BADXML_EXPECTED_CONVTYPE)); } *pValue = AsType; return TRUE; }

BOOL PluginOILFilter::GetExportFile (  PathName *  pPath, CCLexFile **  ppNewFile )

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 18/02/2005 Parameters: ppNewFile  - pointer to a pointer to a CCLexFile [INPUTS] Returns: TRUE if ok, FALSE if bother Definition at line 485 of file xpoilflt.cpp. { ERROR2IF(ppNewFile == NULL, FALSE,"PluginOILFilter::GetExportFile no newfile pointer"); *ppNewFile = NULL; // Here we should run the plugin asynchronously with the following options // -e -g -f <filename> -x <xmlfilename> // The xmlfilename is a path to a user and filter specific file // e.g. ~/.XaraLX/filtername.xml // Create a CCLexFile derived object that sends its data to stdin // Check stderr during the Xar export and abort if an error is reported // However, this will not be trivial so intsead we will just create a // CCDiskFile attached to a temporary filename and run the export process // in DoExport instead // Generate a temporary file name m_TempXarFile.SetPathName(_T("/tmp/xpftemp.xar")); CCDiskFile* pFile = new CCDiskFile(); if (pFile) { if (pFile->open(m_TempXarFile, ios::out | ios::binary | ios::trunc)) { *ppNewFile = pFile; return(TRUE); } delete pFile; } return(FALSE); }

BOOL PluginOILFilter::GetImportFile (  CCLexFile *  pFile, CCLexFile **  ppNewFile )

Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 16/02/2005 Parameters: pFile  - pointer to a CCLexFile [INPUTS] ppNewFile - pointer to a pointer to a CCLexFile Returns: TRUE if ok, FALSE if bother Definition at line 408 of file xpoilflt.cpp. { ERROR2IF(pFile == NULL, FALSE,"PluginOILFilter::GetImportFile no file to import from"); ERROR2IF(ppNewFile == NULL, FALSE,"PluginOILFilter::GetImportFile no newfile pointer"); *ppNewFile = NULL; // Here we should really run the plugin asynchronously with the following options // -i -g -f <filename> // Redirect stdout to a CCLexFile // Check stderr during the Xar import and abort if an error is reported m_TempXarFile.SetPathName(_T("/tmp/xpftemp.xar")); CCDiskFile TempFile; if (!TempFile.open(m_TempXarFile, ios::out | ios::trunc | ios::binary)) { // report an error here return FALSE; } PathName FileName = pFile->GetPathName(); wxString sCommand(m_DoImport); sCommand.Replace(_T("%IN%"), (LPCTSTR)FileName.GetPath()); TRACEUSER("Gerry", _T("Running '%s'"), sCommand.c_str()); // Create a process with the TempFile as the stdout PluginFilterProcess* pTheProc = new PluginFilterProcess((PluginNativeFilter*)Parent, NULL, &TempFile); INT32 code = pTheProc->Execute(sCommand); TempFile.close(); if (code != 0) { TRACEUSER("Gerry", _T("Execution of '%s' failed."), sCommand.c_str()); // Extract error from a derived CamProcess class and report it pTheProc->ReportError(); delete pTheProc; return(FALSE); } pTheProc->ReportWarning(); delete pTheProc; pTheProc = NULL; CCDiskFile* pTempFile = new CCDiskFile(); if (pTempFile) { if (pTempFile->open(m_TempXarFile, ios::in | ios::binary)) { *ppNewFile = pTempFile; return(TRUE); } delete pTempFile; } return(FALSE); }

BOOL PluginOILFilter::GetXPFBOOL (  xmlNodePtr  pNode, LPTSTR  pAttrName, XPFBOOL *  pbValue )  [protected]

Definition at line 1154 of file xpoilflt.cpp. { XPFBOOL bValue = XPFB_UNKNOWN; if (pNode) { wxString strAttrName(pAttrName); wxCharBuffer buf = strAttrName.mb_str(wxConvUTF8); // buf will remain allocated in this scope wxString str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)buf.data())); if (!str.IsEmpty()) { if (str == _T("true")) { bValue = XPFB_TRUE; } else if (str == _T("false")) { bValue = XPFB_FALSE; } else { ERROR1(FALSE, _R(IDE_XPF_BADXML_UNEXPECTED_BOOLVALUE)); } } } else { ERROR1(FALSE, _R(IDE_XPF_BADXML_NULLNODE)); } *pbValue = bValue; return TRUE; }

BOOL PluginOILFilter::GetXPFProp (  xmlNodePtr  pNode, LPTSTR  pAttrName, PropMapEntry  aMap[], XPFProp *  pValue )  [protected]

Definition at line 1190 of file xpoilflt.cpp. { XPFProp Value = XPFP_UNKNOWN; if (pNode) { wxString strAttrName(pAttrName); wxCharBuffer buf = strAttrName.mb_str(wxConvUTF8); // buf will remain allocated in this scope wxString str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)buf.data())); if (!str.IsEmpty()) { // Loop through the map until we find it or the NULL indicating the end INT32 Index = 0; while (aMap[Index].pName) { if (str == aMap[Index].pName) { Value = aMap[Index].Value; break; } Index++; } if (Value == XPFP_UNKNOWN) { ERROR1(FALSE, _R(IDE_XPF_BADXML_UNEXPECTED_PROPVALUE)); } } } else { ERROR1(FALSE, _R(IDE_XPF_BADXML_NULLNODE)); } *pValue = Value; return TRUE; }

INT32 PluginOILFilter::HowCompatible (  PathName &  FileName  )

This function is called to determine if this plugin object can accept the specified file. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 16/02/2005 Parameters: Filename  - The file to test compatability of [INPUTS] Returns: An integer from 0 to 10, 0 meaning not interested and 10 meaning it is definitely my format Definition at line 344 of file xpoilflt.cpp. { INT32 HowCompatible = 0; // Here we need to run the plugin synchronously with the following options // -c -f <filename> // Check stderr for errors // Get HowCompatible from stdout if (!m_CanImport.IsEmpty()) { wxString sCommand(m_CanImport); sCommand.Replace(_T("%IN%"), (LPCTSTR)FileName.GetPath()); TRACEUSER("Gerry", _T("Running '%s'"), sCommand.c_str()); wxArrayString saOutput; wxArrayString saErrors; INT32 code = wxExecute(sCommand, saOutput, saErrors, wxEXEC_NODISABLE); TRACEUSER("Gerry", _T("wxExecute returned %d"), code); if (code == 0) { // Extract the value from saOutput if (saOutput.Count() > 0) { INT32 Val = wxAtoi(saOutput[0]); TRACEUSER("Gerry", _T("Command '%s' returned string '%s'"), sCommand.c_str(), saOutput[0].c_str()); TRACEUSER("Gerry", _T("Value = %d"), Val); if (Val >= 0 && Val <= 10) { HowCompatible = Val; } } else { TRACEUSER("Gerry", _T("Command '%s' returned no output value"), sCommand.c_str()); } } else { TRACEUSER("Gerry", _T("Command '%s' exited with code %d"), sCommand.c_str(), code); } } return(HowCompatible); }

BOOL PluginOILFilter::Init (  xmlNode *  pFilterNode  )

Initialises the OIL specific parts of this filter (file extension, file type name, link to COM object etc). Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 16/02/2005 Parameters: rCLSID  - [INPUTS] Returns: TRUE if ok, FALSE if we find a problem and shouldn't use it Definition at line 246 of file xpoilflt.cpp. { // This would look a lot neater using functions from xmlutils.h m_InternalName = CXMLUtils::ConvertToWXString(xmlGetProp(pFilterNode, (xmlChar*)"name")); xmlNodePtr pChild = pFilterNode->children; // We will loop round until we run out of child elements // If an element has already been parsed then an error should be indicated while (pChild) { wxString strChildName = CXMLUtils::ConvertToWXString(pChild->name); if (strChildName == _T("#text") || xmlNodeIsText(pChild)) { // ignore it } else if (strChildName == _T("DisplayName")) { xmlChar* pStr = xmlNodeListGetString(pChild->doc, pChild->xmlChildrenNode, 1); wxString sTemp = CXMLUtils::ConvertToWXString(pStr); FilterName = sTemp; xmlFree(pStr); } else if (strChildName == _T("Extensions")) { xmlChar* pStr = xmlNodeListGetString(pChild->doc, pChild->xmlChildrenNode, 1); wxString sTemp = CXMLUtils::ConvertToWXString(pStr); FilterExt = sTemp; xmlFree(pStr); } else if (strChildName == _T("CanImport")) { xmlChar* pStr = xmlNodeListGetString(pChild->doc, pChild->xmlChildrenNode, 1); m_CanImport = CXMLUtils::ConvertToWXString(pStr); xmlFree(pStr); } else if (strChildName == _T("DoImport")) { xmlChar* pStr = xmlNodeListGetString(pChild->doc, pChild->xmlChildrenNode, 1); m_DoImport = CXMLUtils::ConvertToWXString(pStr); xmlFree(pStr); } else if (strChildName == _T("PrepareExport")) { xmlChar* pStr = xmlNodeListGetString(pChild->doc, pChild->xmlChildrenNode, 1); m_PrepareExport = CXMLUtils::ConvertToWXString(pStr); xmlFree(pStr); } else if (strChildName == _T("DoExport")) { xmlChar* pStr = xmlNodeListGetString(pChild->doc, pChild->xmlChildrenNode, 1); m_DoExport = CXMLUtils::ConvertToWXString(pStr); xmlFree(pStr); } else { TRACEUSER("Gerry", _T("Ignoring '%s' element"), strChildName.c_str()); // ERROR1(FALSE, _R(IDE_XPF_BADXML)); } pChild = pChild->next; } // This should be set to some sensible path but I've hardcoded it for now // We should change to making ~/.XaraLX into a directory and store the main config // file and these filter config files in there m_XMLFile.AssignHomeDir(); m_XMLFile.AppendDir(_T(".XaraLXFilters")); m_XMLFile.Mkdir(0777, wxPATH_MKDIR_FULL); m_XMLFile.SetName(m_InternalName); m_XMLFile.SetExt(_T("xml")); m_bImport = !(m_DoImport.IsEmpty()); m_bExport = !(m_DoExport.IsEmpty()); return(m_bImport || m_bExport); // If it doesn't do either then it isn't a filter }

BOOL PluginOILFilter::IsExport (   )  [inline]

Definition at line 157 of file xpoilflt.h. { return(m_bExport); }

BOOL PluginOILFilter::IsImport (   )  [inline]

Definition at line 156 of file xpoilflt.h. { return(m_bImport); }

BOOL PluginOILFilter::ReadAttributes (  xmlNodePtr  pNode, CapabilityTree *  pCapTree )  [protected]

Definition at line 974 of file xpoilflt.cpp. { // We must loop through the tree of elements // pNode is the Attributes element so read the default as attribute XPFCapability* pAttrs = NULL; XPFConvertType AttrType = XPFCONVTYPE_UNKNOWN; BOOL bOK = GetConvertAsType(pNode, &AttrType); if (!bOK) { TRACEUSER("Phil", _T("ReadAttributes GetConvertAsType failed\n")); return FALSE; } // Loop through each child calling the CreateAttributeNode recursive function // for each one xmlNodePtr pChild; pChild = pNode->children; XPFCapability* pLast = NULL; while (pChild) { XPFCapability* pCap = CreateAttributeNode(pChild); if (pCap) { // If we have a node then add it to the list // If we do not have a node already then set m_pObjects if (pLast) { pLast->SetNext(pCap); } else { pAttrs = pCap; } pLast = pCap; } pChild = pChild->next; } pCapTree->SetAttributesTree(pAttrs, AttrType); return TRUE; }

BOOL PluginOILFilter::ReadColour (  xmlNodePtr  pNode, CapabilityTree *  pCapTree )  [protected]

Definition at line 1025 of file xpoilflt.cpp. { // We must loop through the tree of elements // pNode is the Attributes element so read the default as attribute XPFCapability* pCols = NULL; XPFConvertType ColType = XPFCONVTYPE_UNKNOWN; BOOL bOK = GetConvertAsType(pNode, &ColType); if (!bOK) { TRACEUSER("Phil", _T("ReadColour GetConvertAsType failed\n")); return FALSE; } // Loop through each child calling the CreateColourNode recursive function // for each one xmlNodePtr pChild; pChild = pNode->children; XPFCapability* pLast = NULL; while (pChild) { XPFCapability* pCap = CreateColourNode(pChild); if (pCap) { // If we have a node then add it to the list // If we do not have a node already then set m_pObjects if (pLast) { pLast->SetNext(pCap); } else { pCols = pCap; } pLast = pCap; } pChild = pChild->next; } pCapTree->SetColoursTree(pCols, ColType); return TRUE; }

BOOL PluginOILFilter::ReadObjects (  xmlNodePtr  pNode, CapabilityTree *  pCapTree )  [protected]

Definition at line 923 of file xpoilflt.cpp. { // We must loop through the tree of elements // pNode is the Objects element so read the default as attribute XPFCapability* pObjects = NULL; XPFConvertType ObjectsType = XPFCONVTYPE_UNKNOWN; BOOL bOK = GetConvertAsType(pNode, &ObjectsType); if (!bOK) { TRACEUSER("Phil", _T("ReadObjects GetConvertAsType failed\n")); return FALSE; } // Loop through each child calling the CreateObjectNode recursive function // for each one xmlNodePtr pChild; pChild = pNode->children; XPFCapability* pLast = NULL; while (pChild) { XPFCapability* pCap = CreateObjectNode(pChild); if (pCap) { // If we have a capability node then add it to the list // If we do not have a node already then set pObjects if (pLast) { pLast->SetNext(pCap); } else { pObjects = pCap; } pLast = pCap; } pChild = pChild->next; } pCapTree->SetObjectsTree(pObjects, ObjectsType); return TRUE; }

BOOL PluginOILFilter::ReadOptions (  xmlNodePtr  pNode, CapabilityTree *  pCapTree )  [protected]

Definition at line 814 of file xpoilflt.cpp. { BoundsWriteLevel Level = BWL_NONE; wxString strLevel = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"boundslevel")); if (strLevel == _T("none")) { Level = BWL_NONE; } else if (strLevel == _T("compound")) { Level = BWL_COMPOUND; } else if (strLevel == _T("all")) { Level = BWL_ALL; } else if (strLevel != _T("")) { ERROR1(FALSE, _R(IDE_XPF_BADXML_OPTIONS_BOUNDSLEVEL)); } pCapTree->SetBoundsLevel(Level); BOOL bSelection = FALSE; wxString strSelection = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"selection")); bSelection = (strSelection == _T("true")); pCapTree->SetSelection(bSelection); BOOL bPreviewBitmap = FALSE; wxString strPreviewBitmap = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"thumbnail")); bPreviewBitmap = (strPreviewBitmap == _T("true")); pCapTree->SetPreviewBitmap(bPreviewBitmap); return TRUE; }

BOOL PluginOILFilter::ReadRasterise (  xmlNodePtr  pNode, CapabilityTree *  pCapTree )  [protected]

Definition at line 854 of file xpoilflt.cpp. { double DPI = 96.0; BOOL bAlpha = TRUE; long Compression = 200; String_256 CommonTrans; BOOL bResample = FALSE; wxString str; str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"dpi")); if (!str.IsEmpty()) { str.ToDouble(&DPI); } str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"alpha")); if (!str.IsEmpty()) { bAlpha = (str == _T("true")); } str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"compression")); if (!str.IsEmpty()) { str.ToLong(&Compression); } str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"commontrans")); if (!str.IsEmpty()) { CommonTrans = str; } str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"resample")); if (!str.IsEmpty()) { bResample = (str == _T("true")); } pCapTree->SetRasterise(DPI, bAlpha, (INT32)Compression, CommonTrans, bResample); return TRUE; }

BOOL PluginOILFilter::ReadSpread (  xmlNodePtr  pNode, CapabilityTree *  pCapTree )  [protected]

Definition at line 899 of file xpoilflt.cpp. { XPFConvertType Type = XPFCONVTYPE_UNKNOWN; wxString str = CXMLUtils::ConvertToWXString(xmlGetProp(pNode, (xmlChar*)"as")); if (str.IsEmpty()) { Type = XPFCONVTYPE_NATIVE; } else if (str == _T("bitmap")) { Type = XPFCONVTYPE_BITMAP; } else { ERROR1(FALSE, _R(IDE_XPF_BADXML_SPREAD_CONVERTAS)); } if (Type != XPFCONVTYPE_UNKNOWN) pCapTree->SetSpreadType(Type); return TRUE; }

---

Member Data Documentation

BOOL PluginOILFilter::m_bExport [protected]

Definition at line 204 of file xpoilflt.h.

BOOL PluginOILFilter::m_bImport [protected]

Definition at line 203 of file xpoilflt.h.

wxString PluginOILFilter::m_CanImport [protected]

Definition at line 209 of file xpoilflt.h.

wxString PluginOILFilter::m_DoExport [protected]

Definition at line 208 of file xpoilflt.h.

wxString PluginOILFilter::m_DoImport [protected]

Definition at line 210 of file xpoilflt.h.

wxString PluginOILFilter::m_InternalName [protected]

Definition at line 206 of file xpoilflt.h.

wxString PluginOILFilter::m_PrepareExport [protected]

Definition at line 207 of file xpoilflt.h.

PathName PluginOILFilter::m_TempXarFile [protected]

Definition at line 213 of file xpoilflt.h.

wxFileName PluginOILFilter::m_XMLFile [protected]

Definition at line 212 of file xpoilflt.h.

---

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

• wxOil/xpoilflt.h (r1785/r1282)
• wxOil/xpoilflt.cpp (r1785/r1708)

---