Module Class Reference

#include <ModuleManager.h>

Inheritance diagram for Module:

Collaboration diagram for Module:

Public Member Functions
	Module (const FilePath &name)
virtual	~Module ()
void	ShowLoadFailureError (const wxString &Error)
bool	Load (wxString &deferredErrorMessage)
void	Unload ()
bool	HasDispatch ()
int	Dispatch (ModuleDispatchTypes type)
void *	GetSymbol (const wxString &name)
const FilePath &	GetName () const

Private Attributes
const FilePath	mName
std::unique_ptr< wxDynamicLibrary >	mLib
fnModuleDispatch	mDispatch

Detailed Description

Definition at line 42 of file ModuleManager.h.

Constructor & Destructor Documentation

Module()

Module::Module

(

const FilePath &

name

)

Definition at line 44 of file ModuleManager.cpp.

   : mName{ name }
{
   mLib = std::make_unique<wxDynamicLibrary>();
   mDispatch = NULL;
}

References mDispatch, and mLib.

~Module()

Module::~Module ( )

virtual

Definition at line 51 of file ModuleManager.cpp.

{
   // DV: The current Registry code makes unloading of the modules
   // impossible. The order in which static objects are destroyed
   // may result in the Registry instance being destroyed after the ModuleManager.
   // The way Audacity is currently implemented, it is not possible to
   // guarantee that the ModuleManager instance is initialized before
   // any of the Registry instances.
   if (mLib != nullptr && mLib->IsLoaded())
      mLib->Detach();
}

References mLib.

Member Function Documentation

Dispatch()

int Module::Dispatch

(

ModuleDispatchTypes

type

)

Definition at line 158 of file ModuleManager.cpp.

{
   if (mLib->IsLoaded())
      if( mDispatch != NULL )
         return mDispatch(type);
 
   return 0;
}

References mDispatch, and mLib.

GetName()

const FilePath & Module::GetName ( ) const

inline

Definition at line 54 of file ModuleManager.h.

{ return mName; }

References mName.

GetSymbol()

void * Module::GetSymbol

(

const wxString &

name

)

Definition at line 167 of file ModuleManager.cpp.

{
   return mLib->GetSymbol(name);
}

References mLib, and name.

HasDispatch()

bool Module::HasDispatch ( )

inline

Definition at line 51 of file ModuleManager.h.

{ return mDispatch != NULL; };

References mDispatch.

Load()

bool Module::Load

(

wxString &

deferredErrorMessage

)

Definition at line 79 of file ModuleManager.cpp.

{
   deferredErrorMessage.clear();
   // Will this ever happen???
   if (mLib->IsLoaded()) {
      if (mDispatch) {
         return true;
      }
 
      // Any messages should have already been generated the first time it was loaded.
      return false;
   }
 
   auto ShortName = wxFileName(mName).GetName();
 
   if (!mLib->Load(mName, wxDL_NOW | wxDL_QUIET | wxDL_GLOBAL)) {
      // For this failure path, only, there is a possibility of retrial
      // after some other dependency of this module is loaded.  So the
      // error is not immediately reported.
      deferredErrorMessage = wxString(wxSysErrorMsg());
      return false;
   }
 
   // Check version string matches.  (For now, they must match exactly)
   tVersionFn versionFn = (tVersionFn)(mLib->GetSymbol(wxT(versionFnName)));
   if (versionFn == NULL){
      DoMessageBox(
         XO("The module \"%s\" does not provide a version string.\n\nIt will not be loaded.")
            .Format( ShortName));
      wxLogMessage(wxT("The module \"%s\" does not provide a version string. It will not be loaded."), mName);
      mLib->Unload();
      return false;
   }
 
   wxString moduleVersion = versionFn();
   if( moduleVersion != AUDACITY_VERSION_STRING) {
      DoMessageBox(
         XO("The module \"%s\" is matched with Audacity version \"%s\".\n\nIt will not be loaded.")
            .Format(ShortName, moduleVersion));
      wxLogMessage(wxT("The module \"%s\" is matched with Audacity version \"%s\". It will not be loaded."), mName, moduleVersion);
      mLib->Unload();
      return false;
   }
 
   mDispatch = (fnModuleDispatch) mLib->GetSymbol(wxT(ModuleDispatchName));
   if (!mDispatch) {
      // Module does not provide a dispatch function.
      return true;
   }
 
   // However if we do have it and it does not work, 
   // then the module is bad.
   bool res = ((mDispatch(ModuleInitialize))!=0);
   if (res) {
      return true;
   }
 
   mDispatch = NULL;
 
   DoMessageBox(
      XO("The module \"%s\" failed to initialize.\n\nIt will not be loaded.")
         .Format(ShortName));
   wxLogMessage(wxT("The module \"%s\" failed to initialize.\nIt will not be loaded."), mName);
   mLib->Unload();
 
   return false;
}

References DoMessageBox(), mDispatch, mLib, mName, ModuleDispatchName, ModuleInitialize, versionFnName, wxT(), and XO().

Here is the call graph for this function:

ShowLoadFailureError()

void Module::ShowLoadFailureError

(

const wxString &

Error

)

Definition at line 70 of file ModuleManager.cpp.

{
   auto ShortName = wxFileName(mName).GetName();
   DoMessageBox(
      XO("Unable to load the \"%s\" module.\n\nError: %s")
         .Format(ShortName, Error));
   wxLogMessage(wxT("Unable to load the module \"%s\". Error: %s"), mName, Error);
}

References DoMessageBox(), Error, mName, wxT(), and XO().

Here is the call graph for this function:

Unload()

void Module::Unload

(

)

Definition at line 148 of file ModuleManager.cpp.

{
   if (mLib->IsLoaded()) {
      if (mDispatch)
         mDispatch(ModuleTerminate);
   }
 
   mLib->Unload();
}

References mDispatch, mLib, and ModuleTerminate.

Member Data Documentation

mDispatch

fnModuleDispatch Module::mDispatch

private

Definition at line 59 of file ModuleManager.h.

Referenced by Dispatch(), HasDispatch(), Load(), Module(), and Unload().

mLib

std::unique_ptr<wxDynamicLibrary> Module::mLib

private

Definition at line 58 of file ModuleManager.h.

Referenced by Dispatch(), GetSymbol(), Load(), Module(), Unload(), and ~Module().

mName

const FilePath Module::mName

private

Definition at line 57 of file ModuleManager.h.

Referenced by GetName(), Load(), and ShowLoadFailureError().

---

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

• ModuleManager.h
• ModuleManager.cpp