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