OILModule Class Reference

This class hides the mechanism of loading modules via whatever OS calls are required. For example, under Windows it loads DLLs and interrogates them, whereas on the Arc something quite different could happen. It also provides a link between a kernel 'Module' item and the OIL transport mechanism used to load it. More...

#include <oilmods.h>

List of all members.

Public Member Functions
	OILModule ()
	Provides access to the OIL specific features of a module.
HINSTANCE	GetInstance ()
	Returns the HINSTANCE of the DLL that this module's resources are in.
Static Public Member Functions
static BOOL	Init ()
static void	Deinit ()
static void	DeinitExtras ()
static HINSTANCE	GetInstance (UINT32 ModuleID)
	Given a module ID, return the Windows HINSTANCE handle for the Windows 'module' containing this Camelot module.
Private Attributes
HINSTANCE	hInstance

---

Detailed Description

This class hides the mechanism of loading modules via whatever OS calls are required. For example, under Windows it loads DLLs and interrogates them, whereas on the Arc something quite different could happen. It also provides a link between a kernel 'Module' item and the OIL transport mechanism used to load it.

Author:

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

Date:

30/6/93

Definition at line 115 of file oilmods.h.

---

Constructor & Destructor Documentation

OILModule::OILModule (   )

Provides access to the OIL specific features of a module. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 14/7/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: GetInstance Definition at line 502 of file oilmods.cpp. { // Initialise to a value that can be easily recognised as invalid. hInstance = (HINSTANCE)HINSTANCE_ERROR; }

---

Member Function Documentation

static void OILModule::Deinit (   )  [static]

static void OILModule::DeinitExtras (   )  [static]

HINSTANCE OILModule::GetInstance (  UINT32  ModuleID  )  [static]

Given a module ID, return the Windows HINSTANCE handle for the Windows 'module' containing this Camelot module. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 1/7/93 Parameters: ModuleID  - ID of the module to get the instance for. [INPUTS] -  [OUTPUTS] Returns: The HINSTANCE value for the required module, or HINSTANCE_ERROR if the ID was not found. Errors: - Definition at line 471 of file oilmods.cpp. { // Find the module in question ModuleListItem *Item = Module::Find(ModuleID); // Extract the instance if the module was found if (Item == NULL) { TRACE( _T("OILModule::GetInstance() : ModuleID (%d) not found\n"), ModuleID); return (HINSTANCE)HINSTANCE_ERROR; } else return (Item->m_pOILModule->GetInstance()); }

HINSTANCE OILModule::GetInstance (   )

Returns the HINSTANCE of the DLL that this module's resources are in. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 14/7/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 524 of file oilmods.cpp. { return hInstance; }

BOOL OILModule::Init (  void   )  [static]

Kludged built in to .exe file Tool code: Definition at line 173 of file oilmods.cpp. { // The Viewer, and Mac version always read from the exe #ifdef STANDALONE // #define _READFROMEXE #endif #ifndef _READFROMEXE #ifdef _MAC #define _READFROMEXE #endif #endif HINSTANCE hLibrary = (HINSTANCE)HINSTANCE_ERROR; PORTNOTE("other", "Removed SetErrorMode usage" ) #ifndef EXCLUDE_FROM_XARALX SetErrorMode( SEM_NOOPENFILEERRORBOX ); // don't cause errors #endif // Still need the DLLs for the module/tool resources. #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) // Have a look to see if the tools resources are in the normal ones... HINSTANCE hResInst = AfxGetResourceHandle(); TCHAR Buf[200]; INT32 LoadStringResult = ::LoadString( hResInst, _R(IDS_ZOOMOP_STATUSHELP), Buf, 200); if(LoadStringResult) { // if(ExtraDLLs[Resources_DLL] != 0) // We don't want to load the tools.dll if we're using an external resource // dll anyway, since it should already have these resources in it... hLibrary = (HINSTANCE)HINSTANCE_ERROR; //AfxGetInstanceHandle(); } else { #ifndef _READFROMEXE LPTCHAR LibName = wxT(TOOL_DLL_NAME); hLibrary = LoadLibrary( LibName ); // for now the tools DLL is compulsory if (hLibrary < (HINSTANCE)HINSTANCE_ERROR) { /* TCHAR loaded[256], buf[256]; if (::LoadString( AfxGetResourceHandle(), _R(IDW_NOTOOLS), loaded, sizeof(loaded) ) ) { wsprintf(buf, loaded, LibName ); // assumes %s in message Error::SetError(0, buf, 0); // leave InformError for caller } return FALSE; */ // Rewrite the above to use MakeMsg, so the context-senstive help will work. String_256 buf; buf.MakeMsg(_R(IDW_NOTOOLS), (LPCTSTR) LibName); Error::SetError(0, buf, 0); // leave InformError to caller return FALSE; } #else // Mac version cannot open DLLs hLibrary = AfxGetInstanceHandle(); // read resource from us #endif } //#else // hLibrary = AfxGetInstanceHandle(); // read resource from us #endif // Bodge the DLL table DLLs[0] = hLibrary; DLLCount++; Module *NewModule = (Module *) new ViewModule; if (NewModule == NULL) goto AbnormalExit; // Construct an OILModule and make it point to this DLL for the module's resources. OILModule *pOILModule; pOILModule = new OILModule; if (pOILModule == NULL) { delete NewModule; goto AbnormalExit; } pOILModule->hInstance = hLibrary; // Declare this module. Module::Declare(NewModule, pOILModule); // Here you add your own built-in tools for in .exe testing - when in a DLL, // you can't do this. return TRUE; AbnormalExit: // Out of memory - clean up and fail TRACEUSER( "Tim", _T("OILModule::Init(): memory exhausted") ); PORTNOTE("other", "Removed FreeLibrary usage" ) #ifndef EXCLUDE_FROM_XARALX // FreeLibrary(hLibrary); #endif DLLs[0] = (HINSTANCE)HINSTANCE_ERROR; DLLCount--; return FALSE; }

---

Member Data Documentation

HINSTANCE OILModule::hInstance [private]

Definition at line 130 of file oilmods.h.

---

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

• wxOil/oilmods.h (r1785/r751)
• wxOil/oilmods.cpp (r1785/r1464)

---