OILFilter 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 <oilfltrs.h>

Inheritance diagram for OILFilter:

List of all members.

Public Member Functions
	OILFilter ()
virtual	~OILFilter ()
	OILFilter (Filter *pFilter)
	Initialise an OILFilter object, and link it to its parent Filter.
virtual TCHAR *	ConstructFilterString (UINT32 NumberToExport=1)
	Construct a COMMDLG filter definition string to put in the drop-down list of filters in the dialog box.
virtual String_64	GetFilterName (UINT32 NumberToExport)
	Allows derived classes to supply differnt filter names.
BOOL	DoesExtensionOfFileMatch (CCLexFile *File)
	Sees if the extension of the given file matches one of the extensions given in the filter extension string. Used for ensuring a good match in filters.cpp.
BOOL	DoesExtensionOfPathNameMatch (PathName *Path)
	Sees if the extension of the given pathname matches one of the extensions given in the filter extension string. Used for ensuring a good match in filters.cpp and stuff.
BOOL	FixExtensionOfPathName (PathName *Path)
	Replace the extension in the pathname supplied with one for this filter. If more than one extension exists then replace with the first available one.
Static Public Member Functions
static BOOL	InitFilters (List &)
	Scans all OILy filters to find out which filters are available for use, and instantiates one of each, and holds them in a list.
static BOOL	CreatePluginFilters (List &)
	Creates a filter object for each installed plugin filter.
Public Attributes
String_64	FilterName
String_32	FilterExt
INT32	Position
Filter *	Parent
Private Member Functions
	CC_DECLARE_MEMDUMP (OILFilter)

---

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:

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

Date:

18/03/94

See also:

Filter

Definition at line 124 of file oilfltrs.h.

---

Constructor & Destructor Documentation

OILFilter::OILFilter (   )  [inline]

Definition at line 129 of file oilfltrs.h. {}

virtual OILFilter::~OILFilter (   )  [inline, virtual]

Definition at line 130 of file oilfltrs.h. { }

OILFilter::OILFilter (  Filter *  pFilter  )

Initialise an OILFilter object, and link it to its parent Filter. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/07/94 Parameters: pFilter  - the filter that this OILFilter object belongs to. [INPUTS] Returns: Errors: ENSURe failure if pFilter is NULL See also: - Definition at line 176 of file oilfltrs.cpp. { ENSURE(pFilter != NULL, "No parent filter for OILFilter object"); Position = -1; Parent = pFilter; }

---

Member Function Documentation

OILFilter::CC_DECLARE_MEMDUMP (  OILFilter   )  [private]

TCHAR * OILFilter::ConstructFilterString (  UINT32  NumberToExport = 1  )  [virtual]

Construct a COMMDLG filter definition string to put in the drop-down list of filters in the dialog box. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/07/94 Parameters: NumberToExport  - The number of files being exported (allows different names) [INPUTS] Returns: Pointer to the string for this filter. This is a pointer to a static buffer, so it should be used immediately, and the caller should not attempt to deallocate this string. See also: OILFilter; OpMenuImport; OpMenuExport Reimplemented in OILFilterFamily. Definition at line 455 of file oilfltrs.cpp. { // Load in the filter name and extensions... static String_128 FilterStr; String_32 Extensions; FilterStr = GetFilterName(NumberToExport); // Construct the filter string from these two strings: FilterStr += _T(" ("); // Extract each extension and see if we need to add it String_32 ExtStr; ExtStr = FilterExt; TCHAR* pPointer; TCHAR* pExt = camStrtok( (TCHAR*)ExtStr, _T(","), &pPointer ); BOOL NoneFound = TRUE; while (pExt != NULL) { if (camStrstr((TCHAR *) Extensions, pExt) == NULL) { // Not already present - add the string. if (!NoneFound) // Don't add a semi-colon if this is the first one we find. Extensions += _T(";"); String_16 Ext( pExt ); Extensions += _T("*."); Ext.toLower(); Extensions += Ext; Extensions += _T(";*."); Ext.toUpper(); Extensions += Ext; NoneFound = FALSE; } pExt = camStrtok( NULL, _T(","), &pPointer ); } FilterStr += Extensions; FilterStr += _T(")|"); FilterStr += Extensions; // Return a pointer to the string. return (TCHAR *) FilterStr; }

BOOL OILFilter::CreatePluginFilters (  List &  FilterList  )  [static]

Creates a filter object for each installed plugin filter. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 26/01/2005 Parameters: FilterList  - [INPUTS] Returns: TRUE if ok, FALSE if bother Definition at line 341 of file oilfltrs.cpp. { PORTNOTETRACE("filters","OILFilter::CreatePluginFilters - bodged"); #if 0 PluginNativeFilter* pFilter = new PluginNativeFilter; if (pFilter == NULL) return FALSE; if (pFilter->Init( (xmlNode*)NULL )) FilterList.AddTail(pFilter); else delete pFilter; #endif // Check the config dir exists, if not bomb out wxString strConfigPath( (TCHAR*)CCamApp::GetResourceDirectory() ); strConfigPath += _T("/filters"); TRACEUSER( "jlh92", _T("Using filter discovery directory \"%s\"\n"), PCTSTR(strConfigPath) ); if( !wxDir::Exists( strConfigPath ) ) { // We'll try default location under debug to make life easier #if defined(_DEBUG) strConfigPath = _T("/usr/share/xaralx/filters"); if( !wxDir::Exists( strConfigPath ) ) #endif return TRUE; } TRACEUSER( "luke", _T("Using %s as filter store\n"), PCTSTR(strConfigPath) ); // Setup the directory scan wxDir dir( strConfigPath ); if( !dir.IsOpened() ) { // wxDir is susposed to explain why this failed, so we can just // bomb-out return FALSE; } // Scan all files in directory wxString strFilename; bool fOk = dir.GetFirst( &strFilename, _T("*"), wxDIR_FILES ); while( fOk ) { strFilename = strConfigPath + _T("/") + strFilename; // Convert the filename to ASCII size_t cchFile = strFilename.Length(); PSTR pszFile = (PSTR)alloca( sizeof(char) * ( cchFile + 1 ) ); camWcstombs( pszFile, (PCTSTR)strFilename, cchFile ); pszFile[cchFile] = '\0'; // Open the xml file xmlDoc* pDoc = xmlReadFile( pszFile, NULL, 0 ); if( NULL != pDoc ) { // Scan the root elements for FilterConfig element xmlNode* pRootElement = xmlDocGetRootElement( pDoc ); xmlNode* pConfigElem = NULL; for( xmlNode* pNode = pRootElement; NULL != pNode; pNode = pNode->next ) { if( XML_ELEMENT_NODE == pNode->type && 0 == strcmp( "FilterConfig", PCSTR(pNode->name) ) ) { pConfigElem = pNode; break; } } if( NULL != pConfigElem ) { // Scan the elements below FilterConfig for filters for( xmlNode* pNode = pConfigElem->children; NULL != pNode; pNode = pNode->next ) { if( XML_ELEMENT_NODE == pNode->type && 0 == strcmp( "Filter", PCSTR(pNode->name) ) ) { // Create a new filter, Init it and add to list if success // Note will be auto deleted if not added std::auto_ptr<PluginNativeFilter> pFilter( new PluginNativeFilter ); if( pFilter->Init( pNode ) ) FilterList.AddTail( pFilter.release() ); } } } xmlFreeDoc( pDoc ); pDoc = NULL; } fOk = dir.GetNext( &strFilename ); } return TRUE; }

BOOL OILFilter::DoesExtensionOfFileMatch (  CCLexFile *  File  )

Sees if the extension of the given file matches one of the extensions given in the filter extension string. Used for ensuring a good match in filters.cpp. Author: Ben_Summers (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/95 Definition at line 649 of file oilfltrs.cpp. { ERROR2IF(File == NULL,FALSE,"OILFilter::DoesExtensionOfFileMatch File supplied is null"); TRACEUSER( "Ben", _T("Checking extension for filter %s\n"), (TCHAR *)FilterName); if(File->IsKindOf(CC_RUNTIME_CLASS(CCDiskFile))) { // check the filename CCDiskFile *pDiskFile = (CCDiskFile *)File; PathName Path; Path = pDiskFile->GetPathName(); return DoesExtensionOfPathNameMatch(&Path); } return FALSE; }

BOOL OILFilter::DoesExtensionOfPathNameMatch (  PathName *  Path  )

Sees if the extension of the given pathname matches one of the extensions given in the filter extension string. Used for ensuring a good match in filters.cpp and stuff. Author: Ben_Summers (Xara Group Ltd) <camelotdev@xara.com> Date: 16/05/95 Definition at line 681 of file oilfltrs.cpp. { ERROR2IF(Path == NULL,FALSE,"OILFilter::DoesExtensionOfPathNameMatch Path supplied is null"); String_256 Ext; TCHAR *fe; TCHAR *pex; TCHAR ex[256]; Ext = Path->GetType(); // Retrieve a copy of the filter extension(s) defined to this filter fe = FilterExt; pex = Ext; INT32 l = 0; while(pex[l] != _T('\0')) { ex[l] = camTolower(pex[l]); l++; } ex[l] = _T('\0'); TRACEUSER( "Ben", _T("Checking extension matches, of file = '%s', supported = '%s'\nLard\n"), (TCHAR *)ex, fe); if(ex[0] == _T('\0')) { // it's a blank extension. It can't match then, can it? TRACEUSER( "Ben", _T("File didn't have an extension\n")); return FALSE; } // see if the extension is in the list of supported extensions in the filter if(camStrstr(fe, (ex[0] == _T('.'))?(ex + 1):ex) != NULL) return TRUE; return FALSE; }

BOOL OILFilter::FixExtensionOfPathName (  PathName *  Path  )

Replace the extension in the pathname supplied with one for this filter. If more than one extension exists then replace with the first available one. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 04/01/96 Parameters: Path  the pathname of the file to be fixed [OUTPUTS] Returns: True if replace the extension ok, False otherwise. Definition at line 733 of file oilfltrs.cpp. { ERROR2IF(Path == NULL,FALSE,"OILFilter::FixExtensionOfPathName Path supplied is null"); // Retrieve a copy of the filter extension(s) defined to this filter String_256 ExtStr = FilterExt; // If there is no filter extension string then all we can do is return False if (ExtStr.IsEmpty()) return FALSE; // Filters might have multiple extensions listed separated by commas // so use first e.g. AI eps filter has ai and eps. // Work out the position of the first separator character, - 1 if none INT32 Position; String_8 SepMark = _T(","); Position = ExtStr.Sub(SepMark); // If comma separator was found use up to the separator if (Position > 0) ExtStr.Left(&ExtStr, Position); // Put the found extension string in the path we were told to fix Path->SetType(ExtStr); return FALSE; }

String_64 OILFilter::GetFilterName (  UINT32  NumberToExport  )  [virtual]

Allows derived classes to supply differnt filter names. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/96 Parameters: NumberToExport  - the number of files being exported. [INPUTS] Returns: The name of the filter Reimplemented in GIFOILFilter. Definition at line 517 of file oilfltrs.cpp. { return FilterName; }

BOOL OILFilter::InitFilters (  List &  FilterList  )  [static]

Scans all OILy filters to find out which filters are available for use, and instantiates one of each, and holds them in a list. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 22/02/94 Parameters: The  list of filters to which the OILy filters should be added. [INPUTS] The  updated list of filters. [OUTPUTS] Returns: TRUE if initialised ok, FALSE if not. Errors: Out of memory (if a filter fails to initialise for other reasons then an error is reported, but Camelot will still start up ok, i.e. TRUE is returned). See also: Filter::InitFilters Definition at line 222 of file oilfltrs.cpp. { // Find the OILy filters Filter *pFilter; #if !defined(EXCLUDE_FROM_RALPH) if (!CreatePluginFilters(FilterList)) { // Error has already been set return(FALSE); } #if !defined(EXCLUDE_FROM_XARALX) // Create, initialise and install the Windows MetaFile import filter ADD_FILTER(MetaFileFilter) // If the OS can do enhanced metafiles then do them if (IsWin32NT() || IsWin32c()) { ADD_FILTER(EnhancedMetaFilter) } ADD_FILTER(MSPaletteFilter) ADD_FILTER(PaintShopProPaletteFilter) // AldusFormatFilter::InitAll(FilterList); // Call the init function of the main external filters class so that the Accusoft DLL // gets loaded. Acts as a dummy filter that can neither import nor export. // If it gets the DLL then it initialises each of the filters otherwise it will exit // from the function immediately. // WEBSTER-Martin-19/12/96 no Accusoft #ifndef WEBSTER ADD_FILTER(AccusoftFilters) // Create, initialise and install the external filters supplied by the Accusoft software. // These are at present supplied in the Intel and Mac directories as we have Intel versions // but no MAC versions. The Mac versions just do nothing at present except return FALSE. // Hence the first filter will fail and we will immediately return TRUE to the caller. ADD_FILTER(AccusoftBMPFilter) // Mac version fails and returns here ADD_FILTER(BrookTroutFilter) ADD_FILTER(CALSFilter) ADD_FILTER(DCXFilter) ADD_FILTER(GX2Filter) ADD_FILTER(IFFFilter) ADD_FILTER(IMGFilter) ADD_FILTER(IOCAFilter) ADD_FILTER(HaloCUTFilter) ADD_FILTER(KOFAXFilter) ADD_FILTER(LaserDataFilter) ADD_FILTER(MacPaintFilter) ADD_FILTER(MSIconsFilter) ADD_FILTER(MSPaintFilter) ADD_FILTER(PCXFilter) ADD_FILTER(PICTFilter) ADD_FILTER(PhotoCDFilter) ADD_FILTER(PhotoShopFilter) ADD_FILTER(SUNFilter) ADD_FILTER(TARGAFilter) ADD_FILTER(WPGFilter) ADD_FILTER(XWindowsFilter) // Preview filters ADD_FILTER(AccPreviewFilter) ADD_FILTER(PreviewFilterTIFF) //this is still an Accusoft filter #endif //WEBSTER #endif // EXCLUDE_FROM_XARALX ADD_FILTER(PPMFilter) ADD_FILTER(PGMFilter) ADD_FILTER(PBMFilter) #if !defined(EXCLUDE_FROM_XARALX) ADD_FILTER(SpriteFilter) #endif //WEBSTER-Martin-19/12/96 // possibly these next ones should now be in Filter::InitFilters as it's native code now #if defined(EXCLUDE_FROM_XARALX) ADD_FILTER(JPEGImportFilter) #endif // Add the Preview Bitmap Filter // Tricky one this. Don't really need this any more (14/3/97)- its only use is the // PreviewFilter::PreviewBitmapSize static that has historically been used all over the place ADD_FILTER(PreviewFilter) // Add the preview bitmap filters that we can use in the new native/web format ADD_FILTER(PreviewFilterBMP) ADD_FILTER(PreviewFilterGIF) ADD_FILTER(PreviewFilterJPEG) ADD_FILTER(PreviewFilterPNG) ADD_FILTER(ThumbnailFilterPNG) #endif // All ok return TRUE; }

---

Member Data Documentation

String_32 OILFilter::FilterExt

Definition at line 135 of file oilfltrs.h.

String_64 OILFilter::FilterName

Definition at line 134 of file oilfltrs.h.

Filter* OILFilter::Parent

Definition at line 141 of file oilfltrs.h.

INT32 OILFilter::Position

Definition at line 139 of file oilfltrs.h.

---

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

• wxOil/oilfltrs.h (r1785/r1473)
• wxOil/oilfltrs.cpp (r1785/r1679)

---