CamResource Class Reference

To control the translation of resources within Camelot Notes: In the OIL See Also:. More...

#include <camresource.h>

Inheritance diagram for CamResource:

List of all members.

Public Member Functions
virtual CCRuntimeClass *	GetRuntimeClass () const
	This function allows access to the CCRuntimeClass object for this class, which in turn allows dynamic classing and construction. This function is automatically overridden on derived classes if you use the CC_DECLARE_... and CC_IMPLEMENT_... macros.
	CamResource ()
	Constructor.
virtual	~CamResource ()
	Destructor.
CCLexFile *	Open (ResourceID ID, BOOL ErrorReporting=TRUE, BOOL ExceptionThrowing=FALSE)
	Return a pointer to the open file.
CCLexFile *	Open (const TCHAR *pFileName, BOOL ErrorReporting=TRUE, BOOL ExceptionThrowing=FALSE)
	Return a pointer to the open file.
wxFSFile *	OpenwxFSFile (ResourceID ID)
	Return a pointer to the open file.
wxFSFile *	OpenwxFSFile (const TCHAR *pFileName)
	Return a pointer to the open file.
void	Close ()
	Close the relevant file.
CCLexFile *	Get ()
wxFSFile *	GetwxFSFile ()
Static Public Member Functions
static CCRuntimeClass *	GetMyClass ()
static void PASCAL	Construct (void *p)
static BOOL	LoadwxImage (wxImage &rImage, const TCHAR *pFileName, BOOL Grey=FALSE)
	Static function to load a bitmap.
static BOOL	LoadwxBitmap (wxBitmap &rBitmap, const TCHAR *pFileName, BOOL Grey=FALSE)
	Static function to load a bitmap.
static wxImage *	GetCachedBitmap (const TCHAR *pName)
	Returns a pointer to the preloaded bitmap.
static void	MakeGreyImage (wxImage &rImage)
	Static function to grey an image.
static void	MakeHotImage (wxImage &rImage)
	Static function to make a hot version of an image.
static ResourceID	GetResourceID (const TCHAR *ObjectName)
static const TCHAR *	GetTextFail (ResourceID Resource)
static const TCHAR *	GetText (ResourceID Resource)
static const TCHAR *	GetObjectNameFail (ResourceID Resource)
static const TCHAR *	GetObjectName (ResourceID Resource)
static wxString	GetResourceFilePath (const wxString &str, BOOL AllowOverride=TRUE)
	Destructor.
static void	SetResourceFilePath (const wxString &str)
	Destructor.
static BOOL	IsBitmapName (const wxString &str)
	Determine whether or not a path points to a bitmap.
static wxString	GetBitmapExtension (const wxString &str)
	Determines the extension of a bitmap.
static wxString	GetBitmapBaseName (const wxString &str)
	Determines the extension of a bitmap.
static wxString	GetBitmapFlagString (const wxString &str)
	Determines the extension of a bitmap.
static wxString	MakeBitmapString (const wxString base, const wxString flags, const wxString ext)
static BOOL	Init ()
	Initialize resources.
static BOOL	DeInit ()
	Initialize resources.
static BOOL	DoneInit (BOOL CanYield=TRUE)
	Signals to the resouce system initialization is completed. The splah screen can thus be removed.
static wxLocale *	GetLocale ()
static void	SetGenerateXRCCheck (BOOL flag)
static void *	LoadFile (const wxString &str1, UINT32 *pSize)
Static Public Attributes
static CCRuntimeClass	cc_classCamResource
static wxArrayString	BitmapExtensions
Static Private Member Functions
static void	AddStringResource (const TCHAR *name, const TCHAR *text, ResourceID r=0)
	Initialize resources.
static void	RememberDuringStaticInit (const TCHAR *ObjectName)
	Remembers an objectname that has been GetResourceID'd prior to the ObjectHash existing.
static BOOL	ReadStringTableFile ()
	Initialize resources.
static void	ProcessWindowAndChildren (wxWindow *pWindow)
	Initialize resources.
static void	GetBinaryFileInfo (void **pPtr, UINT32 *pSize)
static BOOL	InitXmlResource ()
	Initialize resources.
static BOOL	Splash ()
	Put up a splash screen.
static BOOL	CheckResourcePath (const wxString &str1, const wxString &str2)
static const TCHAR *	FixObjectName (const TCHAR *ObjectName)
static BOOL	AddBitmaps (wxString &Path)
	Add all bitmaps in the path.
static BOOL	LoadBitmaps ()
	Add internal and external bitmaps.
static void	DeleteBitmapHashEntries ()
	Delete every bitmap hash table entry.
static void	MakeVariantBitmaps (ResourceStringToBitmap::iterator *it=NULL)
	Make variant copies of all bitmaps.
Private Attributes
CCLexFile *	pFile
void *	pMemory
UINT32	Size
wxFSFile *	pwxFSFile
Static Private Attributes
static wxFileSystem *	pwxFileSystem = NULL
static wxLocale *	m_pLocale = NULL
static wxHelpProvider *	m_pHelpProvider = NULL
static BOOL	s_GenerateXRCCheck = FALSE
static ResIDToString *	pHash = NULL
static ResIDToString *	pObjectNameHash = NULL
static TCHAR *	DefaultString = _T("[Resource string not found]")
static TCHAR *	DefaultObjectName = _T("[Object name not Found]")
static wxString *	pResourcePath = NULL
static BOOL	HaveCheckedResourcePath = FALSE
static CamResourceRemember *	pFirstRemember = NULL
static wxBitmap *	pSplashBitmap = NULL
static wxAdvSplashScreen *	pSplashScreen = NULL
static ResourceStringToBitmap *	pBitmapHash = NULL

---

Detailed Description

To control the translation of resources within Camelot Notes: In the OIL See Also:.

Author:

Alex_Bligh <alex@alex.org.uk>

Date:

02/12/2005

This is a class composed of static member functions which rapidly translates resources, and a dynamic object which provides capabilities of loading from the disk.

String tables

The GetText() member functions look up the integer ID's passed to it in a hash map, via inline functions, so should be pretty rapid in execution. Thus the actual mechanism of loading the strings is effectively encapsulated.

Dialogs and other resources

The GetResourceID() member function implements the _R() macro, which allows a resource in a dialog (or a stringtable resource) to be translated into the numeric ID's Camelot likes.

Example usage:

ResourceID myResource; myResource = _R("_R(IDS_BLOBBYSTRING)"); // Uses CamResource::GetResourceID()

... pass around the integer value ...

const TCHAR * myString = CamResource::GetText(myResource); // Can't fail ... do something with the text of the entry ...

Note that the _R() macros is clevere than you think. That's because it can be used as a static initializer (e.g. in wxWidgets event tables). What is happening here is that the GetXRCID() hash table gets initialized at static initialization time creating a map from the resource string (IDS_ etc.) to a unique integer value, and when the XML resources are loaded later, they are assigned that integer value.

Note this is a static class, and thus no constructors and destructors are offered.

Definition at line 199 of file camresource.h.

---

Constructor & Destructor Documentation

CamResource::CamResource (   )

Constructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Example of how to use this class: CamResource myResource; // Allocate a new resource object CCLexFile * myFile = myResource.Open(_R(IDB_BLOBBY)); // Open the BLOBBY bitmap Could have specified a string instead myFile->Read( ... ) // or whatever The user can either close the file, or not. However, operations must NOT be done on the file once the corresponding resource object is destroyed (as the resource object may have allocated a memory copy of the image). To prevent damage, the destructor will ALWAYS close the file and free the resources. The caller should NOT delete the open CCLexFile object that is returned. Either use our Close mechanism, or let the destructor take its course. Definition at line 1883 of file camresource.cpp. { Size = 0; pMemory = NULL; pFile = NULL; pwxFSFile = NULL; return; }

CamResource::~CamResource (   )  [virtual]

Destructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1909 of file camresource.cpp. { Close(); // releases pFile and pMemory }

---

Member Function Documentation

BOOL CamResource::AddBitmaps (  wxString &  Path  )  [static, private]

Add all bitmaps in the path. Author: Alex_Bligh <alex@alex.org.uk> Date: 01/01/2005 Parameters: Path  - the path to add [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 979 of file camresource.cpp. { ERROR2IF(!pBitmapHash, FALSE, "No bitmap hash"); ERROR2IF(!pwxFileSystem, FALSE, "No filesystem"); TRACEUSER("amb",_T("Adding bitmaps from %s"),Path.c_str()); wxString fn = pwxFileSystem->FindFirst(Path+_T("*.*"), wxFILE); // This isn't an MSDOS-ism - we are looking for files with an extension while (!fn.IsEmpty()) { wxString LeafName = fn.Mid(Path.Length()); if (IsBitmapName(LeafName)) { ResourceStringToBitmap::iterator i=pBitmapHash->find(LeafName); if (i==pBitmapHash->end()) // ignore if we already have an entry { #if PRELOAD_BITMAPS wxImage * pBitmap=new wxImage; if (!pBitmap) return FALSE; // TRACE(_T("Loading bitmap %s"),fn.c_str()); if (LoadwxImage(*pBitmap, LeafName)) (*pBitmapHash)[camStrdup(LeafName.c_str())]=pBitmap; else { ERROR3_PF((_T("Could not load bitmap %s"),fn.c_str())); delete pBitmap; } #else (*pBitmapHash)[camStrdup(LeafName.c_str())]=NULL; // Mark as there, but needs to be loaded #endif } } fn = pwxFileSystem->FindNext(); } return TRUE; }

void CamResource::AddStringResource (  const TCHAR *  name, const TCHAR *  text, ResourceID  r = 0 )  [static, private]

Initialize resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: name  - object name to add [INPUTS] text - text asssociated with it r - numeric ResourceID or 0 to allocate it None  [OUTPUTS] Returns: None Errors: via wxMessageBox See also: - Read controls out of this window, and put into string table. Then process children recursively. Definition at line 449 of file camresource.cpp. { ResourceID r2=GetResourceID(name); if (r) { if (r != r2) { TRACE(_T("Possible duplicate label %s\n"),text); } } else { r = r2; } if (!name || !text) { TRACE(_T("Resource ID %d is blank\n"),r); ERROR3("Resource is blank"); } else { ResIDToString::iterator i=pHash->find(r); if (i!=pHash->end()) { TRACE(_T("Resource ID %d name <%s> has duplicate definitions: <%s> and <%s>\n"),r,name,text,i->second); } else { const TCHAR * tcopy = camStrdup(text); (*pHash)[r] = tcopy; const TCHAR * t = GetText(r); if (t!=tcopy) { ERROR3("Resource string does not match local copy"); } } } }

BOOL CamResource::CheckResourcePath (  const wxString &  str1, const wxString &  str2 )  [static, private]

Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: str1,str2  - filenames to check [INPUTS] [OUTPUTS]  Returns: TRUE if the files are identical, else false Errors: - See also: - This routine compares two small files. If they are equal, it returns true, else it returns false. This allows checking of the checksum. This is reasonably resilient to some fool creating a huge xrc.check as we only read the files if the lengths are equal, which means we never read more than the size of the file bound into the executable. Definition at line 878 of file camresource.cpp. { if (!pwxFileSystem) return FALSE; UINT32 size1=0; UINT32 size2=0; void * mem1=LoadFile(str1, &size1); void * mem2=LoadFile(str2, &size2); if (!mem1) { if (mem2) free(mem2); return FALSE; // and we can't generate an xrc.check } BOOL same = mem2 && ( size1 == size2) && !memcmp(mem1, mem2, size1); if (!same && s_GenerateXRCCheck) { wxMessageBox(_T("You have requested XaraLX to generate a checksum for resources which may not match the binary in question. " "A checksum will be generated, but the program may not be stable."), _T("XaraLX Resource system warning")); wxFile f; f.Create(str2, wxFile::write); if (!f.IsOpened() || (f.Write(mem1, size1) != size1)) { wxMessageBox(_T("Failed to write xrc.check file ")+str2, _T("XaraLX resource system")); } f.Close(); same=TRUE; } if (mem1) free (mem1); if (mem2) free (mem2); return same; }

void CamResource::Close (  void   )

Close the relevant file. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1930 of file camresource.cpp. { if (pFile) { pFile->close(); delete (pFile); pFile = NULL; } if (pwxFSFile) { delete (pwxFSFile); pwxFSFile=NULL; } if (pMemory) free(pMemory); pMemory = NULL; Size = 0; // leave in tidy state }

static void PASCAL CamResource::Construct (  void *  p  )  [static]

BOOL CamResource::DeInit (  void   )  [static]

Initialize resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 1672 of file camresource.cpp. { if (m_pHelpProvider) { wxHelpProvider::Set(NULL); delete m_pHelpProvider; m_pHelpProvider = NULL; } if (pwxFileSystem) { delete (pwxFileSystem); pwxFileSystem = NULL; } #if !defined(EXCLUDE_FROM_XARLIB) if (pBitmapHash) { DeleteBitmapHashEntries(); delete pBitmapHash; pBitmapHash = NULL; } #endif // EXCLUDE_FROM_XARLIB if (pHash) { ResIDToString::iterator current; while (!pHash->empty()) { current = pHash->begin(); ResourceString s=current->second; pHash->erase(current); free((void *)s); } // for good measure pHash->clear(); delete (pHash); pHash = NULL; } if (pObjectNameHash) { ResIDToString::iterator current; while (!pObjectNameHash->empty()) { current = pObjectNameHash->begin(); ResourceString s=current->second; pObjectNameHash->erase(current); free((void *)s); } // for good measure pObjectNameHash->clear(); delete (pObjectNameHash); pObjectNameHash = NULL; } #if !defined(EXCLUDE_FROM_XARLIB) if (pSplashScreen) { delete (pSplashScreen); pSplashScreen = NULL; } if (pSplashBitmap) { delete (pSplashBitmap); pSplashBitmap = NULL; } #endif // EXCLUDE_FROM_XARLIB if (m_pLocale) { delete (m_pLocale); m_pLocale = NULL; } return TRUE; }

void CamResource::DeleteBitmapHashEntries (   )  [static, private]

Delete every bitmap hash table entry. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1633 of file camresource.cpp. { if (pBitmapHash) { ResourceStringToBitmap::iterator current; while (!pBitmapHash->empty()) { current = pBitmapHash->begin(); wxImage * b=current->second; TCHAR * s=(TCHAR *)current->first; pBitmapHash->erase(current); if (b) delete b; free(s); } // for good measure pBitmapHash->clear(); } }

BOOL CamResource::DoneInit (  BOOL  CanYield = TRUE  )  [static]

Signals to the resouce system initialization is completed. The splah screen can thus be removed. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 1827 of file camresource.cpp. { TRACET(_T("CamResource::DoneInit() called")); #if !defined(EXCLUDE_FROM_XARLIB) if (pSplashScreen) { if (CanYield) ::wxYield(); pSplashScreen->Destroy(); pSplashScreen = NULL; if (CanYield) ::wxYield(); } if (pSplashBitmap) { delete (pSplashBitmap); pSplashBitmap = NULL; } #endif // EXCLUDE_FROM_XARLIB return TRUE; }

const TCHAR * CamResource::FixObjectName (  const TCHAR *  ObjectName  )  [static, private]

Definition at line 354 of file camresource.cpp. { if (!CamResourceFixNameEntry::pArray) { // Don't delete the comments or normalize.pl will unhelpfully convert the bits in quotes FNOMAP("IDOK", "wxID_OK"); //NORESOURCEFIX FNOMAP("IDCANCEL", "wxID_CANCEL"); //NORESOURCEFIX FNOMAP("IDAPPLY", "wxID_APPLY"); //NORESOURCEFIX FNOMAP("ID_APPLY_NOW", "wxID_APPLY"); //NORESOURCEFIX FNOMAP("ID_CC_APPLY_NOW", "wxID_APPLY"); //NORESOURCEFIX FNOMAP("ID_FILE_OPEN", "wxID_OPEN"); //NORESOURCEFIX FNOMAP("ID_FILE_CLOSE", "wxID_CLOSE"); //NORESOURCEFIX FNOMAP("ID_FILE_SAVE", "wxID_SAVE"); //NORESOURCEFIX FNOMAP("ID_FILE_SAVE_AS", "wxID_SAVEAS"); //NORESOURCEFIX FNOMAP("ID_APP_EXIT", "wxID_EXIT"); //NORESOURCEFIX FNOMAP("ID_FILE_PRINT", "wxID_PRINT"); //NORESOURCEFIX FNOMAP("ID_FILE_PRINT_PREVIEW", "wxID_PREVIEW"); //NORESOURCEFIX FNOMAP("ID_FILE_PRINT_SETUP", "wxID_PRINT_SETUP"); //NORESOURCEFIX FNOMAP("ID_APP_ABOUT", "wxID_ABOUT"); //NORESOURCEFIX FNOMAP("ID_EDIT_UNDO", "wxID_UNDO"); //NORESOURCEFIX FNOMAP("ID_EDIT_CUT", "wxID_CUT"); //NORESOURCEFIX FNOMAP("ID_EDIT_COPY", "wxID_COPY"); //NORESOURCEFIX FNOMAP("ID_EDIT_PASTE", "wxID_PASTE"); //NORESOURCEFIX FNOMAP("IDYES", "wxID_YES"); //NORESOURCEFIX FNOMAP("IDNO", "wxID_NO"); //NORESOURCEFIX FNOMAP("IDHELP", "wxID_HELP"); //NORESOURCEFIX CamResourceFixNameEntry::MakeResources(); } const TCHAR * ret= CamResourceFixNameEntry::Find(ObjectName); if (pObjectNameHash && ret !=ObjectName) // don't do during static init { TRACEUSER("amb",_T("**Mapped %s to %s"),ObjectName,ret); } return ret; }

CCLexFile* CamResource::Get (   )  [inline]

Definition at line 225 of file camresource.h. {return pFile;}

void CamResource::GetBinaryFileInfo (  void **  pPtr, UINT32 *  pSize )  [static, private]

Definition at line 50484 of file winresources.cpp. { *pPtr=(void *)&(binfile[0]); *pSize=sizeof(binfile)-1; return; }

wxString CamResource::GetBitmapBaseName (  const wxString &  str  )  [static]

Determines the extension of a bitmap. Author: Alex_Bligh <alex@alex.org.uk> Date: 24/01/2005 Parameters: str  - sting to look at [INPUTS] None  [OUTPUTS] Returns: Empty string if none found, else the BaseName (without flags or extension) Errors: - See also: - Definition at line 1086 of file camresource.cpp. { // Find the rightmost dot INT32 i=str.Find(_T('.'), TRUE); if (i<0) return wxEmptyString; wxString barestr = str.Left(i); // Find the rightmost "-"; i=barestr.Find(_T('-'), TRUE); if (i<0) return barestr; // Now check all characters after the "-" are alphanumeric INT32 j; for (j=i+1; j<(INT32)barestr.Length(); j++) { wxChar c=barestr[j]; if ((c<_T('a')) || (c>_T('z'))) return barestr; } return barestr.Left(i); }

wxString CamResource::GetBitmapExtension (  const wxString &  str  )  [static]

Determines the extension of a bitmap. Author: Alex_Bligh <alex@alex.org.uk> Date: 24/01/2005 Parameters: str  - sting to look at [INPUTS] None  [OUTPUTS] Returns: Empty string if none found, else the extenstion Errors: - See also: - Definition at line 1060 of file camresource.cpp. { // Find the rightmost dot INT32 i=str.Find(_T('.'), TRUE); if (i<0) return wxEmptyString; else return str.Mid(i+1); }

wxString CamResource::GetBitmapFlagString (  const wxString &  str  )  [static]

Determines the extension of a bitmap. Author: Alex_Bligh <alex@alex.org.uk> Date: 24/01/2005 Parameters: str  - sting to look at [INPUTS] None  [OUTPUTS] Returns: Empty string if none found, else the flags string (without the '-') Errors: - See also: - Definition at line 1126 of file camresource.cpp. { // Find the rightmost dot INT32 i=str.Find(_T('.'), TRUE); if (i<0) return wxEmptyString; wxString barestr = str.Left(i); // Find the rightmost "-"; i=barestr.Find(_T('-'), TRUE); if (i<0) return wxEmptyString; // Now check all characters after the "-" are alphanumeric INT32 j; for (j=i+1; j<(INT32)barestr.Length(); j++) { wxChar c=barestr[j]; if ((c<_T('a')) || (c>_T('z'))) return wxEmptyString; } return barestr.Mid(i+1); }

wxImage * CamResource::GetCachedBitmap (  const TCHAR *  pName  )  [static]

Returns a pointer to the preloaded bitmap. Author: Alex_Bligh <alex@alex.org.uk> Date: 01/01/2005 Parameters: pName  - pointer to name of bitmap (leaf name) [INPUTS] None  [OUTPUTS] Returns: a pointer to the bitmap Errors: via wxMessageBox See also: - Definition at line 1280 of file camresource.cpp. { if (!pBitmapHash) return NULL; ResourceStringToBitmap::iterator i=pBitmapHash->find(pName); if (i==pBitmapHash->end()) { // We know this file does not exist in the resources. However, we might be able to // make one if it's greyed and we can get the ungreyed version wxString fn(pName); // Clear each of the flags in sequence BOOL Found=FALSE; // Do this entire lot for each flag CamArtFlags flag=CAF_CACHE_MAX; while ((flag=(CamArtFlags)(flag>>1)) !=0 ) { if ((flag==CAF_GREYED) || (flag!=CAF_SELECTED)) // We don't know how to produce anything else, so ignore { if (IsBitmapName(fn) && (CamArtProvider::GetBitmapFlags(fn) & flag)) { // Find the ungreyed name of the bitmap wxString ugfn=MakeBitmapString(GetBitmapBaseName(fn), CamArtProvider::MakeBitmapFlagString((CamArtFlags) (CamArtProvider::GetBitmapFlags(fn) & ~flag)), GetBitmapExtension(fn)); Found = TRUE; // we should at least look for another bitmap // Recursively call ourself to load the ungreyed bitmap. We don't care about the result, but this // will insert the greyed version into the cache as a byproduct #ifdef _DEBUG static INT32 recursion=0; recursion++; ERROR3IF(recursion>16,"Too much recursion in CamResource::GetCachedBitmap"); #endif GetCachedBitmap(ugfn.c_str()); #ifdef _DEBUG recursion--; #endif } } } if (!Found) return NULL; i=pBitmapHash->find(pName); // reset iterator if (i==pBitmapHash->end()) return NULL; // we couldn't find a greyed version } if (!i->second) { // There is no bitmap there, but the name is there. We must be demand loading wxImage * pBitmap = new wxImage; if (!pBitmap) return NULL; if (!LoadwxImage(*pBitmap, pName)) { ERROR3_PF((_T("Could not load bitmap %s"), pName)); delete pBitmap; return NULL; } // Add it to the cache i->second=pBitmap; // Generate variant versions if we should MakeVariantBitmaps(&i); return pBitmap; } return i->second; }

static wxLocale* CamResource::GetLocale (   )  [inline, static]

Definition at line 330 of file camresource.h. {return m_pLocale;}

static CCRuntimeClass* CamResource::GetMyClass (   )  [static]

Reimplemented from CCObject.

static const TCHAR* CamResource::GetObjectName (  ResourceID  Resource  )  [inline, static]

Definition at line 301 of file camresource.h. { if (!pObjectNameHash) return DefaultString; ResIDToString::iterator i=pObjectNameHash->find(Resource); const TCHAR * text = (const TCHAR *)((i==pObjectNameHash->end())?NULL:i->second); return text?text:DefaultString; };

static const TCHAR* CamResource::GetObjectNameFail (  ResourceID  Resource  )  [inline, static]

Definition at line 295 of file camresource.h. { if (!pObjectNameHash) return NULL; ResIDToString::iterator i=pObjectNameHash->find(Resource); return (const TCHAR *)((i==pObjectNameHash->end())?NULL:i->second); };

wxString CamResource::GetResourceFilePath (  const wxString &  str, BOOL  AllowOverride = TRUE )  [static]

Destructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: str  - the string to look up [INPUTS] [OUTPUTS]  Returns: the path to load it from Errors: - See also: - By default this will return the MemoryFS path, however, if & when we support overriding of resources in a resource directory, this will under the appopriate circumstances use a differnt path. Note this can only be called AFTER the resource system is initialized. If an empty string is specified, it returns the overridden resource path (if one exists) (so long as the override is set to TRUE), or failing that the memory resource path Definition at line 749 of file camresource.cpp. { // If we are given a full path, then return. For the time being that's anything with a colon or a slash in it // as the resources file is flat if ( ((str.Find(_T(':')))>=0) || ((str.Find(_T('/')))>=0) || ((str.Find(_T('\\')))>=0) ) { return str; } wxString mfn = _T("memory:resources#zip:"); if (AllowOverride && pResourcePath && pwxFileSystem) { wxString fn = *pResourcePath + _T('/'); // If we have not run the check on the checksum do it now. if (!HaveCheckedResourcePath) { if (CheckResourcePath(mfn+_T("xrc.check"),fn+_T("xrc.check"))) { HaveCheckedResourcePath = TRUE; } else { wxMessageBox(_T("Ignoring resource path specified on command line due to bad resource checksum"), _T("Resource loading error")); delete (pResourcePath); pResourcePath = NULL; } } if (str.IsEmpty() && pResourcePath) return fn; fn += str; if (pResourcePath) // may have been cleared { wxFSFile * pTwxFSFile = pwxFileSystem->OpenFile(fn); if (pTwxFSFile) { // we found it, so close it & return delete pTwxFSFile; return fn; } } } return mfn + str; }

static ResourceID CamResource::GetResourceID (  const TCHAR *  ObjectName  )  [inline, static]

Definition at line 267 of file camresource.h. { const TCHAR * fObjectName=FixObjectName(ObjectName); ResourceID Resource = wxXmlResource::GetXRCID(fObjectName); // need to record it in the hash that goes the other way lest we be asked. Note this will always // work as the caller to GetObjectName can't have a ResourceID without _R()'ing it (or at least // cannot legally have one). if (pObjectNameHash) // skip on static initialization phase or we'll be dead { ResIDToString::iterator i=pObjectNameHash->find(Resource); if (i==pObjectNameHash->end()) (*pObjectNameHash)[Resource]=camStrdup(fObjectName); } else RememberDuringStaticInit(fObjectName); // add it to the hash later return Resource; }

virtual CCRuntimeClass* CamResource::GetRuntimeClass (   )  const [virtual]

This function allows access to the CCRuntimeClass object for this class, which in turn allows dynamic classing and construction. This function is automatically overridden on derived classes if you use the CC_DECLARE_... and CC_IMPLEMENT_... macros. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 19/7/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Pointer to the CCRuntimeClass object associated with CCObject. Errors: - See also: CCObject; CCRuntimeClass; CCObject::IsKindOf; CCRuntimeClass::CreateObject; CC_DECLARE_DYNAMIC; CC_IMPLEMENT_DYNAMIC; CC_DECLARE_DYNCREATE; CC_IMPLEMENT_DYNCREATE; CC_CLASS_MEMDUMP; CC_DECLARE_MEMDUMP; CC_IMPLEMENT_MEMDUMP; CCObject::GetRuntimeClass; Reimplemented from CCObject.

static const TCHAR* CamResource::GetText (  ResourceID  Resource  )  [inline, static]

Definition at line 288 of file camresource.h. { if (!pHash) return DefaultString; ResIDToString::iterator i=pHash->find(Resource); const TCHAR * text = (const TCHAR *)((i==pHash->end())?NULL:i->second); return text?text:DefaultString; };

static const TCHAR* CamResource::GetTextFail (  ResourceID  Resource  )  [inline, static]

Definition at line 282 of file camresource.h. { if (!pHash) return NULL; ResIDToString::iterator i=pHash->find(Resource); return (const TCHAR *)((i==pHash->end())?NULL:i->second); };

wxFSFile* CamResource::GetwxFSFile (   )  [inline]

Definition at line 226 of file camresource.h. {return pwxFSFile;}

BOOL CamResource::Init (  void   )  [static]

Initialize resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Reimplemented from SimpleCCObject. Definition at line 1409 of file camresource.cpp. { void * pFile=NULL; UINT32 Length=0; TRACET(_T("CamResource::Init() called")); pHash = new (ResIDToString); if (!pHash) return FALSE; pHash->clear(); pObjectNameHash = new (ResIDToString); if (!pObjectNameHash) return FALSE; pObjectNameHash->clear(); #if !defined(EXCLUDE_FROM_XARLIB) pBitmapHash = new (ResourceStringToBitmap); if (!pBitmapHash) return FALSE; pBitmapHash->clear(); #endif // Now go through ID's translated before we got here CamResourceRemember * pRem = pFirstRemember; pFirstRemember = NULL; while (pRem) { if (pRem->text) { // Do not comment out the next line. It does something useful (make the inverse object // map work for static text) /*ResourceID r =*/ GetResourceID(pRem->text); // TRACEUSER("amb",_T("Fixed up static init translation from %s to %d"),pRem->text,r); free (pRem->text); } CamResourceRemember * pORem = pRem; pRem = pRem->next; delete pORem; } // Initialize the handlers wxXmlResource::Get()->InitAllHandlers(); #if !defined(EXCLUDE_FROM_XARLIB) wxXmlResource::Get()->AddHandler(new wxCamArtControlXmlHandler); wxXmlResource::Get()->AddHandler(new wxCamDrawControlXmlHandler); #ifdef wxXTRA_XH_ODCOMBO wxXmlResource::Get()->AddHandler(new wxOwnerDrawnComboBoxXmlHandler); // wxXmlResource::Get()->AddHandler(new wxComboControlXmlHandler); #endif #ifdef wxXTRA_XH_SLIDERCOMBO wxXmlResource::Get()->AddHandler(new wxSliderComboXmlHandler); #endif #if WXXTRA_TREEBOOK wxXmlResource::Get()->AddHandler(new wxTreebookXmlHandler); #endif wxXmlResource::Get()->AddHandler(new wxGridComboXmlHandler); #endif if (!pwxFileSystem) pwxFileSystem = new wxFileSystem; if (!pwxFileSystem) { TRACE(_T("Failed to allocate file system")); return FALSE; } // Check for memory FS. If not present, load the handler: // No idea for the reason for the additional braces, but let's keep them ther { wxMemoryFSHandler::AddFile(_T("XRC_resource/dummy_file"), _T("dummy one")); wxFSFile *f = pwxFileSystem->OpenFile(_T("memory:XRC_resource/dummy_file")); wxMemoryFSHandler::RemoveFile(_T("XRC_resource/dummy_file")); if (f) delete f; else wxFileSystem::AddHandler(new wxMemoryFSHandler); } TRACET(_T("CamResource::Init() added MemoryFSHandler")); wxFileSystem::AddHandler(new wxZipFSHandler); TRACET(_T("CamResource::Init() added Zip handler, now doing AddFile() on resources")); GetBinaryFileInfo(&pFile, &Length); // Do not use a file extension, as unbelievably this adds 3 seconds to startup time pre-splash box // This is because it tries to initialize the MIME system (sigh) wxMemoryFSHandler::AddFile(_T("resources"), pFile, Length); // Irritatingly does not return errors wxXmlResource::Get()->SetFlags(wxXRC_NO_RELOADING); // reloading fails with assert due to missing timestamps #if !defined(EXCLUDE_FROM_XARLIB) // Add bitmap extenstions BitmapExtensions.Add(_T("png")); BitmapExtensions.Add(_T("cur")); #endif // Initialize locale m_pLocale = new wxLocale(); if (!m_pLocale) return FALSE; m_pLocale->Init(wxLANGUAGE_DEFAULT, wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING); m_pLocale->AddCatalogLookupPathPrefix(GetResourceFilePath(_T(""))); m_pLocale->AddCatalog(_T("XaraLX")); #if !defined(EXCLUDE_FROM_XARLIB) TRACET(_T("CamResource::Init() launching splash screen")); if (!Splash()) return FALSE; #endif #ifdef XML_STRINGS TRACET(_T("CamResource::Init() now loading internal resources, calling InitXmlResource")); // Load the internal resources // We should offer the possibility of loading them from a non-XML file here if (!InitXmlResource()) return FALSE; wxYield(); // yield again to allow repaint TRACET(_T("CamResource::Init() starting to load string table dialog")); // Read the string table into the hash map wxDialog * pStringTable = wxXmlResource::Get()->LoadDialog(NULL, _T("STRINGTABLE")); if (!pStringTable) { // We can hardly internationalize the message box, as we have no strings to play with yet. wxMessageBox(_T("Could not load resources: Failed to locate string table"), _T("Resource loading error")); return FALSE; } wxYield(); // yield again to allow repaint TRACET(_T("CamResource::Init() starting to process string table")); // Now do a depth-first search of this window's children ProcessWindowAndChildren(pStringTable); wxYield(); // yield again to allow repaint TRACET(_T("CamResource::Init() and deleting the dialog")); delete pStringTable; #else TRACET(_T("CamResource::Init() now loading internal resources, calling ReadStringTableFile()")); if (!ReadStringTableFile()) { // We can hardly internationalize the message box, as we have no strings to play with yet. wxMessageBox(_T("Could not load resources: Failed to locate string table"), _T("Resource loading error")); return FALSE; } #endif TRACET(_T("CamResource::Init() done processing string table, starting to load bitmaps")); wxYield(); // yield again to allow repaint #if !defined(EXCLUDE_FROM_XARLIB) // Note this won't actually load the bitmaps if we are demand loading, but it will at least get a list of them if (!LoadBitmaps()) return FALSE; TRACET(_T("CamResource::Init() done processing bitmaps, starting to load toolbar images")); wxYield(); // yield again to allow repaint #if 0 LoadwxImage(imageBevelTool, _T("lbeveltool32.png") ); LoadwxImage(imageBezTool, _T("lbeztool32.png") ); LoadwxImage(imageBlendTool, _T("lblendtool32.png") ); LoadwxImage(imageContourTool, _T("lcontourtool32.png") ); LoadwxImage(imageElipTool, _T("leliptool32.png") ); LoadwxImage(imageFHandTool, _T("lfhandtool32.png") ); LoadwxImage(imageGradTool, _T("lgradtool32.png") ); LoadwxImage(imageLiveEffectTool, _T("lliveeffecttool32.png") ); LoadwxImage(imageMouldTool, _T("lmouldtool32.png") ); LoadwxImage(imagePenTool, _T("lpentool32.png") ); LoadwxImage(imagePush, _T("lpushtool32.png") ); LoadwxImage(imageRectTool, _T("lrecttool32.png") ); LoadwxImage(imageRegShapeTool, _T("lregshapetool32.png") ); LoadwxImage(imageSelTool, _T("lselrtool32.png") ); LoadwxImage(imageShadrwTool, _T("lsoftshadowtool32.png") ); LoadwxImage(imageSlicetool, _T("lslicetool32.png") ); LoadwxImage(imageTextTool, _T("ltexttool32.png") ); LoadwxImage(imageTransTool, _T("ltransptool32.png") ); LoadwxImage(imageZoomTool, _T("lzoomtool32.png") ); TRACET(_T("CamResource::Init() Added images")); wxYield(); // yield again to allow repaint #endif m_pHelpProvider = new wxHelpControllerHelpProvider; if (!m_pHelpProvider) return FALSE; wxHelpProvider::Set(m_pHelpProvider); if (!wxXmlResource::Get()->Load(GetResourceFilePath(_T("dialogs.xrc")))) { TRACE(_T("Could not load dialogs.xrc")); return FALSE; } TRACET(_T("CamResource::Init - loaded dialogs")); wxYield(); // yield again to allow repaint #endif return TRUE; }

BOOL CamResource::InitXmlResource (   )  [static, private]

Initialize resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 711 of file camresource.cpp. { TRACET(_T("CamResource::InitXmlResource() called, doing Load() of strings.xrc")); if (!wxXmlResource::Get()->Load(GetResourceFilePath(_T("strings.xrc")))) { TRACE(_T("Could not load strings.xrc")); return FALSE; } TRACET(_T("CamResource::InitXmlResource() called - loaded strings")); return true; }

BOOL CamResource::IsBitmapName (  const wxString &  str  )  [static]

Determine whether or not a path points to a bitmap. Author: Alex_Bligh <alex@alex.org.uk> Date: 24/01/2005 Parameters: str  - sting to look at [INPUTS] None  [OUTPUTS] Returns: TRUE if the extension is a bitmap type Errors: - See also: - Definition at line 1038 of file camresource.cpp. { wxString ext=GetBitmapExtension(str); return (BitmapExtensions.Index(ext) != wxNOT_FOUND); }

BOOL CamResource::LoadBitmaps (   )  [static, private]

Add internal and external bitmaps. Author: Alex_Bligh <alex@alex.org.uk> Date: 01/01/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 1375 of file camresource.cpp. { TRACET(_T("LoadBitmaps() called")); wxString ExternalRes = GetResourceFilePath(wxString(_T("")), TRUE); wxString InternalRes = GetResourceFilePath(wxString(_T("")), FALSE); TRACET(_T("LoadBitmaps() adding External bitmaps")); if (!AddBitmaps(ExternalRes)) return FALSE; TRACET(_T("LoadBitmaps() adding Internal bitmaps")); if (InternalRes != ExternalRes) if (!AddBitmaps(InternalRes)) return FALSE; TRACET(_T("LoadBitmaps() making grey copies")); MakeVariantBitmaps(); // make grey copies of each bitmap TRACET(_T("LoadBitmaps() done")); return TRUE; }

void * CamResource::LoadFile (  const wxString &  str1, UINT32 *  pSize )  [static]

Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: str1  - filename to load [INPUTS] size  - the size of the file [OUTPUTS] Returns: A pointer to the file (free with free()) or NULL Errors: - See also: - Definition at line 815 of file camresource.cpp. { wxFSFile * pTwxFSFile1 = pwxFileSystem->OpenFile(str1); if (!pTwxFSFile1) { delete pTwxFSFile1; return NULL; } wxInputStream * pStream1 = pTwxFSFile1->GetStream(); // we don't have to delete this ourselves if (!pStream1) { delete (pTwxFSFile1); return NULL; } UINT32 size1=pStream1->GetSize(); if (!size1) { delete (pTwxFSFile1); return NULL; } void * mem1 = malloc(size1+4); // safety if (!mem1) { delete (pTwxFSFile1); return NULL; } memset(mem1, 0, size1); pStream1->Read(mem1, size1); // throws exceptions if can't read delete (pTwxFSFile1); // Closes it if (pSize) *pSize=size1; return mem1; }

BOOL CamResource::LoadwxBitmap (  wxBitmap &  rBitmap, const TCHAR *  pFileName, BOOL  Grey = FALSE )  [static]

Static function to load a bitmap. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: Image  - Image to alter. pFileName - pointer to the LEAF filename [INPUTS] Grey - to Grey the image [OUTPUTS]  Returns: Success or otherwise Errors: - See also: - Definition at line 2277 of file camresource.cpp. { // Annoyingly, wxBitmap does not support the stream class wxImage i; if (!LoadwxImage(i, pFileName)) return FALSE; wxBitmap b(i, -1); // for now, always use screen depth, not least as GDK doesn't support anything except this & 1bpp rBitmap = b; return TRUE; }

BOOL CamResource::LoadwxImage (  wxImage &  rImage, const TCHAR *  pFileName, BOOL  Grey = FALSE )  [static]

Static function to load a bitmap. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: Image  - Image to alter. pFileName - pointer to the LEAF filename [INPUTS] Grey - to grey the image [OUTPUTS]  Returns: Success or otherwise Errors: - See also: - Definition at line 2246 of file camresource.cpp. { CamResource Resource; wxFSFile* f=Resource.OpenwxFSFile(pFileName); if (!f) return FALSE; wxInputStream * pStream=f->GetStream(); if (!pStream) return FALSE; if (!rImage.LoadFile(*pStream, wxBITMAP_TYPE_ANY)) return FALSE; // Grey the image if required if (Grey) MakeGreyImage(rImage); return TRUE; }

static wxString CamResource::MakeBitmapString (  const wxString  base, const wxString  flags, const wxString  ext )  [inline, static]

Definition at line 317 of file camresource.h. { if (flags.IsEmpty()) return base+wxString(_T("."))+ext; else return base+wxString(_T("-"))+flags+wxString(_T("."))+ext; }

void CamResource::MakeGreyImage (  wxImage &  rImage  )  [static]

Static function to grey an image. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: Image  - Image to make grey [INPUTS] [OUTPUTS]  Returns: - Errors: - See also: - Definition at line 2112 of file camresource.cpp. { // now we want to grey the thing ourselves INT32 x; INT32 y; BOOL hasalpha = rImage.HasAlpha(); // give it an alpha channel if (!hasalpha) rImage.InitAlpha(); // copies alpha into the mask if it had one. rImage.SetMask(FALSE); // ignore the mask - we now have alpha UINT8 * p = rImage.GetData(); UINT8 * alpha = rImage.GetAlpha(); INT32 w=rImage.GetWidth(); INT32 h=rImage.GetHeight(); ColourMatrix Whiten = ColourMatrix::Whiten(); ColourMatrix Grey = ColourMatrix::Grey(); // If we do the copy backwards we can avoid copying the data // Start off pointing at the last pixel const INT32 size = w * h; INT32 m = size - 1; INT32 n = (size - 1) * 3; // Don't use SetRGB - it does funny things to the alpha channel for (y = h-1; y>=0; y--) for (x = w-1 ; x>=0; x--) { // packed bytes, same order on each platform ColourVector togrey; togrey.SetRGBA (p[n], p[n+1], p[n+2], alpha[m]); togrey=togrey.Apply(Grey); ColourVector towhiten(0.0,0.0,0.0,0.0); // transparent // whitened image is displaced by one pixel down and right. So we sample // from a pixel left and up (this is width + 1 pixels earlier in the image) if ((y>0) && (x>0)) { towhiten.SetRGBA(p[n-(w+1)*3], p[n-(w+1)*3+1], p[n-(w+1)*3+2], alpha[m-(w+1)]); } towhiten=towhiten.Apply(Whiten); ColourVector result = towhiten.ComposeOnTop(togrey); // Write the colour back into the image p[n]=result.GetR(); p[n+1]=result.GetG(); p[n+2]=result.GetB(); alpha[m]=result.GetA(); // Go to "next" pixel (going backwards) n-=3; m--; } }

void CamResource::MakeHotImage (  wxImage &  rImage  )  [static]

Static function to make a hot version of an image. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: Image  - Image to make hot [INPUTS] [OUTPUTS]  Returns: - Errors: - See also: - Definition at line 2188 of file camresource.cpp. { // now we want to grey the thing ourselves INT32 x; INT32 y; INT32 n=0; INT32 m=0; BOOL hasalpha = rImage.HasAlpha(); // give it an alpha channel if (!hasalpha) rImage.InitAlpha(); // copies alpha into the mask if it had one. rImage.SetMask(FALSE); // ignore the mask - we now have alpha UINT8 * p = rImage.GetData(); UINT8 * alpha = rImage.GetAlpha(); INT32 w=rImage.GetWidth(); INT32 h=rImage.GetHeight(); ColourMatrix Boost = ColourMatrix::Boost(); // Don't use SetRGB - it does funny things to the alpha channel for (y = 0; y<h; y++) for (x = 0 ; x<w; x++) { // packed bytes, same order on each platform ColourVector result; result.SetRGBA (p[n], p[n+1], p[n+2], alpha[m]); result=result.Apply(Boost); p[n]=result.GetR(); p[n+1]=result.GetG(); p[n+2]=result.GetB(); alpha[m]=result.GetA(); n+=3; m++; } }

void CamResource::MakeVariantBitmaps (  ResourceStringToBitmap::iterator *  it = NULL  )  [static, private]

Make variant copies of all bitmaps. Author: Alex_Bligh <alex@alex.org.uk> Date: 01/01/2005 Parameters: it  - iterator [INPUTS] None  [OUTPUTS] Returns: None Errors: - See also: - If "it" is set, it will look at a single source bitmap, and make variants of that. Else it will walk the table. Definition at line 1170 of file camresource.cpp. { if (!pBitmapHash) return; // Do this entire lot for each flag CamArtFlags flag=CAF_CACHE_MAX; while ((flag=(CamArtFlags)(flag>>1)) !=0 ) { if ((flag==CAF_GREYED) || (flag==CAF_SELECTED)) // We don't know how to produce anything else, so ignore { // a convenient place to store the new grey bitmaps without breaking the iterator ResourceStringToBitmap NewHash; NewHash.clear(); ResourceStringToBitmap::iterator current; if (it) current=*it; else current = pBitmapHash->begin(); // iterate through the old hash (if needs be) while (current != pBitmapHash->end()) { if (current->second) // don't bother with bitmaps we have yet to demand load { wxString fn(current->first); //TRACEUSER("amb",_T("Trying to grey bitmap %s"),fn.c_str()); // If it's a .png, but without the particular flag set if (IsBitmapName(fn) && !(CamArtProvider::GetBitmapFlags(fn) & flag)) { // Find the greyed name of the bitmap wxString gfn=MakeBitmapString(GetBitmapBaseName(fn), CamArtProvider::MakeBitmapFlagString((CamArtFlags) (CamArtProvider::GetBitmapFlags(fn) | flag)), GetBitmapExtension(fn)); ResourceStringToBitmap::iterator i=pBitmapHash->find(gfn.c_str()); if (i==pBitmapHash->end()) // ignore if we already have an entry { // TRACEUSER("amb",_T("Greying bitmap %s to bitmap %s"),fn.c_str(),gfn.c_str()); // We want to do this, but it doesn't actually copy the image data (boo hiss) // wxImage *pBitmap=new wxImage(*(current->second)); //wxBitmap b(*(current->second)); wxImage *pBitmap = new wxImage; if (pBitmap) { *pBitmap=current->second->Copy(); // WX bug - on 2.6.2 this does not copy the alpha channel. Work aroud it if (current->second->HasAlpha() && !pBitmap->HasAlpha()) { // This will never happen if wxWidgets is fixed pBitmap->SetAlpha(); memcpy( pBitmap->GetAlpha(), current->second->GetAlpha(), pBitmap->GetWidth()*pBitmap->GetHeight()); } switch (flag) { case CAF_GREYED: MakeGreyImage(*pBitmap); break; case CAF_SELECTED: MakeHotImage(*pBitmap); break; default: ERROR3("Unsupported automatic variant"); break; } NewHash[camStrdup(gfn.c_str())] = pBitmap; } } } } if (it) { break; // jump out loop } else { ++current; } } // Now dump the new hash into the old hash for( current = NewHash.begin(); current != NewHash.end(); ++current ) (*pBitmapHash)[current->first]=current->second; } } return; }

CCLexFile * CamResource::Open (  const TCHAR *  pFileName, BOOL  ErrorReporting = TRUE, BOOL  ExceptionThrowing = FALSE )

Return a pointer to the open file. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pFileName  - **LEAF** element of filename - e.g. "deffill.bmp" [INPUTS] -  [OUTPUTS] Returns: Pointer to the open file, or NULL for a failure Errors: - See also: - Definition at line 1967 of file camresource.cpp. { Close(); // For the time being, we always use a memory file. We load the resource in using the // wxWidgets VFS code (allowing us to load it out the Zip file), and keep the memory // around till we need to zap it. wxFSFile * pTwxFSFile = pwxFileSystem->OpenFile(GetResourceFilePath(pFileName)); if (!pTwxFSFile) { return NULL; } wxInputStream * pStream = pTwxFSFile->GetStream(); // we don't have to delete this ourselves if (!pStream) { delete (pTwxFSFile); return NULL; } UINT32 newsize=pStream->GetSize(); if (!newsize) { delete (pTwxFSFile); return NULL; } void * newmem = malloc(newsize+4); // safety if (!newmem) { delete (pTwxFSFile); return NULL; } memset(newmem, 0, newsize); pStream->Read(newmem, newsize); // throws exceptions if can't read delete (pTwxFSFile); // which closes it CCMemFile * pMemFile=new CCMemFile (newmem, newsize, CCMemRead, ErrorReporting, ExceptionThrowing); if (!pMemFile) { free(newmem); return NULL; } // OK, we've done it. So we can store the variables we have pFile = pMemFile; Size = newsize; pMemory = newmem; return (pFile); }

CCLexFile * CamResource::Open (  ResourceID  ID, BOOL  ErrorReporting = TRUE, BOOL  ExceptionThrowing = FALSE )

Return a pointer to the open file. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: ResourceID  of the file in question [INPUTS] -  [OUTPUTS] Returns: Pointer to the open file, or NULL for a failure Errors: - See also: - Definition at line 2040 of file camresource.cpp. { return Open(GetText(ID), (BOOL) ErrorReporting, (BOOL) ExceptionThrowing); }

wxFSFile * CamResource::OpenwxFSFile (  const TCHAR *  pFileName  )

Return a pointer to the open file. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pFileName  - pointer to the LEAF filename [INPUTS] -  [OUTPUTS] Returns: Pointer to the open file stream, or NULL for a failure Errors: - See also: - Definition at line 2082 of file camresource.cpp. { wxFSFile * pTwxFSFile = pwxFileSystem->OpenFile(GetResourceFilePath(pFileName)); if (!pTwxFSFile) { return NULL; } pwxFSFile=pTwxFSFile; return pwxFSFile; }

wxFSFile * CamResource::OpenwxFSFile (  ResourceID  ID  )

Return a pointer to the open file. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: ResourceID  of the file in question [INPUTS] -  [OUTPUTS] Returns: Pointer to the open file stream, or NULL for a failure Errors: - See also: - Definition at line 2061 of file camresource.cpp. { return OpenwxFSFile(GetText(ID)); }

void CamResource::ProcessWindowAndChildren (  wxWindow *  pWindow  )  [static, private]

Initialize resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pWindow  - pointer to window to process [INPUTS] None  [OUTPUTS] Returns: None Errors: via wxMessageBox See also: - Read controls out of this window, and put into string table. Then process children recursively. Definition at line 664 of file camresource.cpp. { // Process this one if (pWindow->IsKindOf(CLASSINFO(wxStaticText))) { ResourceID r=(ResourceID) pWindow->GetId(); // Don't be so foolish as to think the following would work. Oh no. What this would // do is return a temporary wxString, take the address of it's data member, then // mark it as discardable on the stack leaving the data member to be overwritten. // Ho de ho de ho. // const TCHAR * name = pWindow->GetName().c_str(); // const TCHAR * text = pWindow->GetLabel().c_str(); wxString sname = pWindow->GetName(); wxString stext = pWindow->GetLabel(); AddStringResource((const TCHAR *)sname.c_str(),(const TCHAR *)stext.c_str(), r); } // Now process children if any wxWindowList::Node * pNode = pWindow->GetChildren().GetFirst(); while (pNode) { ProcessWindowAndChildren(pNode->GetData()); pNode = pNode->GetNext(); } return; }

BOOL CamResource::ReadStringTableFile (   )  [static, private]

Initialize resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - We can't use the CCLexFile stuff because it has not yet been initiated. Definition at line 508 of file camresource.cpp. { TRACET(_T("ReadStringTableFile() called")); CamResource res; INT32 count=0; wxFSFile* f = res.OpenwxFSFile(_T("strings.lst")); // NB destructor of 'res' deletes this if (!f) { TRACE(_T("Could not load strings.lst")); return FALSE; } wxInputStream * s = f->GetStream(); if (!s) { TRACE(_T("Could not load strings.lst - no stream")); return FALSE; } while (!s->Eof()) { #define MAX_TAG_LENGTH 1024 char buf[MAX_TAG_LENGTH]; char c=0; // Deliberate - file is not Unicode for now INT32 l=0; while (!s->Eof() && (c=s->GetC()) && (c != '\n') && (c != '\t') && (l<MAX_TAG_LENGTH)) { buf[l++]=c; } buf[l++]=0; buf[MAX_TAG_LENGTH-1]=0; if (buf[0]) { wxString name(buf, wxConvUTF8); if (c == '\n') { buf[0]=0; } else { l=0; while (!s->Eof() && (c=s->GetC()) && (c != '\n') && (l<MAX_TAG_LENGTH)) { buf[l++]=c; } buf[MAX_TAG_LENGTH-1]=0; } buf[l++]=0; wxString text(buf, wxConvUTF8); // Now de-XMLize it wxString otext; UINT32 n=0; while (n<text.Length()) { wxChar tc=text.GetChar(n++); if (tc==_T('&')) { // It's an ampersand escape sequence. Read till a semicolon wxString seq; while (tc !=_T(';') && n<text.Length()) { tc=text.GetChar(n++); seq+=tc; } if (seq == _T("amp;")) { tc=_T('&'); } else if (seq == _T("lt;")) { tc=_T('<'); } else if (seq == _T("gt;")) { tc=_T('>'); } else if (seq == _T("quot;")) { tc=_T('"'); } else if ((seq.Length()>3) && (seq.GetChar(0)==_T('#')) && (seq.GetChar(1)==_T('x'))) { tc=_T('?'); UINT32 code=tc; // It's an alphanumeric form of a unicode character in hex #if wxUSE_UNICODE sscanf((const char*)seq.mb_str(wxConvUTF8), "#x%x;", &code); #else sscanf((const char*)seq.c_str(), "#x%x;", &code); #endif tc=(TCHAR)(code); } else if ((seq.Length()>2) && (seq.GetChar(0)==_T('#')) && ((seq.GetChar(1)>=_T('0')) && (seq.GetChar(1)<=_T('9')))) { tc=_T('?'); UINT32 code=tc; // It's an alphanumeric form of a unicode character in decimal #if wxUSE_UNICODE sscanf((const char*)seq.mb_str(wxConvUTF8), "#%d;", &code); #else sscanf((const char*)seq.c_str(), "#%d;", &code); #endif tc=(TCHAR)(code); } else { TRACE(_T("CamResource::ReadStringTableFile - Unknown XML escape sequence [&%s] in %s, %s"),seq.c_str(),name.c_str(),text.c_str()); otext+=_T('&')+seq; tc=0; // don't add } } if (tc) { otext+=tc; } } // Here we could translate it using wxGetTranslation // Or we could muck around on non UTF-8 encodings // but that would be really boring. count++; AddStringResource(name.c_str(), ::wxGetTranslation(otext.c_str())); } } TRACE(_T("Added %d strings"),count); if (count<1000) return FALSE; // some bad thing has happened. return TRUE; }

void CamResource::RememberDuringStaticInit (  const TCHAR *  ObjectName  )  [static, private]

Remembers an objectname that has been GetResourceID'd prior to the ObjectHash existing. Author: Alex_Bligh <alex@alex.org.uk> Date: 19/12/2005 Parameters: ObjectName  - the name of the object to remember [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - As GetResourceID is called during StaticInit, the ObjectHash won't be set up. wxHash cannot safely be used in static initialization (no, I don't really know why, it seems to work), so we remember a list of these, then blat them out back through GetResourceID during Init. Definition at line 413 of file camresource.cpp. { TCHAR * text = camStrdup(ObjectName); if (!text) return; // we can't error, we can't trace, so meekly forget it CamResourceRemember * pRem = new CamResourceRemember; if (!pRem) return; // we can't error, we can't trace, so meekly forget it pRem->text = text; // fill in text // Now add to our linked list, and return pRem->next = pFirstRemember?pFirstRemember:NULL; pFirstRemember=pRem; return; }

static void CamResource::SetGenerateXRCCheck (  BOOL  flag  )  [inline, static]

Definition at line 334 of file camresource.h. {s_GenerateXRCCheck=flag;}

void CamResource::SetResourceFilePath (  const wxString &  str  )  [static]

Destructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: str  - the string to set [INPUTS] [OUTPUTS]  Returns: the path to load it from Errors: - See also: - This sets the override resource path - this function can be called before CamResource::Init() Definition at line 942 of file camresource.cpp. { if (pResourcePath) { delete (pResourcePath); pResourcePath = NULL; } HaveCheckedResourcePath=FALSE; if (!str.IsEmpty()) { pResourcePath = new(wxString); if (pResourcePath) *pResourcePath = str; } return; }

BOOL CamResource::Splash (   )  [static, private]

Put up a splash screen. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 1773 of file camresource.cpp. { TRACET(_T("CamResource::Splash() called")); if (pSplashBitmap) delete pSplashBitmap; pSplashBitmap=NULL; pSplashBitmap = new wxBitmap(); if (!pSplashBitmap) return FALSE; // We'd like to get the bitmap name from the resources, but, urm, we haven't yet // loaded them if (!LoadwxBitmap(*pSplashBitmap, _T("startup-lx.png") )) { TRACE(_T("Cannot load splash bitmap - possible resource compilation error?")); return TRUE; } if (!pSplashBitmap->Ok()) return FALSE; pSplashScreen = new wxAdvSplashScreen(*pSplashBitmap, wxSPLASH_CENTRE_ON_SCREEN | wxSPLASH_NO_TIMEOUT, 0, NULL, -1, wxDefaultPosition, wxDefaultSize, wxNO_BORDER #if 0 && !defined (_DEBUG) |wxSTAY_ON_TOP // Only stay on top in non-debug builds - too annoying for preinit debugging #endif ); if (!pSplashScreen) return FALSE; wxYield(); return TRUE; }

---

Member Data Documentation

wxArrayString CamResource::BitmapExtensions [static]

Definition at line 332 of file camresource.h.

CCRuntimeClass CamResource::cc_classCamResource [static]

Definition at line 201 of file camresource.h.

TCHAR * CamResource::DefaultObjectName = _T("[Object name not Found]") [static, private]

Definition at line 248 of file camresource.h.

TCHAR * CamResource::DefaultString = _T("[Resource string not found]") [static, private]

Definition at line 247 of file camresource.h.

BOOL CamResource::HaveCheckedResourcePath = FALSE [static, private]

Definition at line 250 of file camresource.h.

wxHelpProvider * CamResource::m_pHelpProvider = NULL [static, private]

Definition at line 216 of file camresource.h.

wxLocale * CamResource::m_pLocale = NULL [static, private]

Definition at line 215 of file camresource.h.

ResourceStringToBitmap * CamResource::pBitmapHash = NULL [static, private]

Definition at line 256 of file camresource.h.

CCLexFile* CamResource::pFile [private]

Definition at line 210 of file camresource.h.

CamResourceRemember * CamResource::pFirstRemember = NULL [static, private]

Definition at line 251 of file camresource.h.

ResIDToString * CamResource::pHash = NULL [static, private]

Definition at line 245 of file camresource.h.

void* CamResource::pMemory [private]

Definition at line 211 of file camresource.h.

ResIDToString * CamResource::pObjectNameHash = NULL [static, private]

Definition at line 246 of file camresource.h.

wxString * CamResource::pResourcePath = NULL [static, private]

Definition at line 249 of file camresource.h.

wxBitmap * CamResource::pSplashBitmap = NULL [static, private]

Definition at line 253 of file camresource.h.

wxAdvSplashScreen * CamResource::pSplashScreen = NULL [static, private]

Definition at line 254 of file camresource.h.

wxFileSystem * CamResource::pwxFileSystem = NULL [static, private]

Definition at line 214 of file camresource.h.

wxFSFile* CamResource::pwxFSFile [private]

Definition at line 213 of file camresource.h.

BOOL CamResource::s_GenerateXRCCheck = FALSE [static, private]

Definition at line 217 of file camresource.h.

UINT32 CamResource::Size [private]

Definition at line 212 of file camresource.h.

---

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

• wxOil/camresource.h (r1785/r1184)
• wxOil/camresource.cpp (r1785/r1702)
• wxOil/xrc/winresources.cpp (r1785/r839)

---