ModuleManager

Engine/source/module/moduleManager.h

Inheritance diagram for ModuleManager ↕

More...

Classes:

class

ModuleManager::LockDatabase

Database locking.

class

ModuleManager::ModuleDefinitionEntry

class

ModuleManager::ModuleLoadEntry

Loaded module entry.

Private Types

SimObject

Parent

HashMap< StringTableEntry, typeModuleIdVector * >

typeGroupModuleHash

Vector< StringTableEntry >

typeGroupVector

HashMap< StringTableEntry, ModuleDefinitionEntry * >

typeModuleIdDatabaseHash

Module databases.

Vector< StringTableEntry >

typeModuleIdVector

Module loading.

Vector< ModuleLoadEntry >

typeModuleLoadEntryVector

Public Types

Vector< const ModuleDefinition * >

typeConstModuleDefinitionVector

Vector< ModuleDefinition * >

typeModuleDefinitionVector

Module definitions.

Private Attributes

S32

mDatabaseLocks

bool

mEchoInfo

bool

mEnforceDependencies

Miscellaneous.

typeGroupModuleHash

mGroupModules

typeGroupVector

mGroupsLoaded

bool

mIgnoreLoadedGroups

char

mModuleExtension [256]

typeModuleIdDatabaseHash

mModuleIdDatabase

typeModuleLoadEntryVector

mModulesLoaded

SimSet

mNotificationListeners

Taml

mTaml

Public Functions

ModuleManager()

~ModuleManager()

void

addListener(SimObject * pListener)

Module notifications.

bool

canMergeModules(const char * pMergeSourcePath)

StringTableEntry

copyModule(ModuleDefinition * pSourceModuleDefinition, const char * pTargetModuleId, const char * pTargetPath, const bool useVersionPathing)

Module synchronization.

DECLARE_CONOBJECT(ModuleManager )

Declare Console Object.

ModuleDefinition *

findLoadedModule(const char * pModuleId)

ModuleDefinition *

findModule(const char * pModuleId, const U32 versionId)

Module type enumeration.

ModuleDefinition *

findModuleByFilePath(StringTableEntry filePath)

void

findModules(const bool loadedOnly, typeConstModuleDefinitionVector & moduleDefinitions)

void

findModuleTypes(const char * pModuleType, const bool loadedOnly, typeConstModuleDefinitionVector & moduleDefinitions)

bool

isModuleMergeAvailable(void )

Module updates.

bool

loadModuleExplicit(const char * pModuleId, const U32 versionId)

bool

loadModuleGroup(const char * pModuleGroup)

Module (un)loading.

bool

mergeModules(const char * pMergeTargetPath, const bool removeMergeDefinition, const bool registerNewModules)

bool

onAdd()

SimObject overrides.

void

onDeleteNotify(SimObject * object)

Called when a SimObject is deleted.

void

onRemove()

Called when the object is removed from the sim.

bool

registerModule(const char * pModulePath, const char * pModuleFile)

Module unregister.

void

removeListener(SimObject * pListener)

bool

renameModule(ModuleDefinition * pSourceModuleDefinition, const char * pNewModuleName)

Editing modules.

bool

scanModules(const char * pPath, const bool rootOnly)

Module discovery.

void

setIgnoreLoadedGroups(bool doIgnore)

bool

setModuleExtension(const char * pExtension)

Module definitions.

bool

synchronizeDependencies(ModuleDefinition * pRootModuleDefinition, const char * pTargetDependencyPath)

bool

unloadModuleExplicit(const char * pModuleId)

bool

unloadModuleGroup(const char * pModuleGroup)

bool

unregisterModule(const char * pModuleId, const U32 versionId)

Public Static Functions

void

initPersistFields()

Private Functions

void

clearDatabase(void )

typeGroupVector::iterator

findGroupLoaded(StringTableEntry moduleGroup)

ModuleDefinitionEntry::iterator

findModuleDefinition(StringTableEntry moduleId, const U32 versionId)

ModuleDefinitionEntry *

findModuleId(StringTableEntry moduleId)

typeModuleLoadEntryVector::iterator

findModuleLoaded(StringTableEntry moduleId, const U32 versionId)

ModuleLoadEntry *

findModuleReady(StringTableEntry moduleId, typeModuleLoadEntryVector & moduleReadyQueue)

ModuleLoadEntry *

findModuleResolving(StringTableEntry moduleId, typeModuleLoadEntryVector & moduleResolvingQueue)

StringTableEntry

getModuleMergeFilePath(void )

void

raiseModulePostLoadNotifications(ModuleDefinition * pModuleDefinition)

void

raiseModulePostUnloadNotifications(ModuleDefinition * pModuleDefinition)

void

raiseModulePreLoadNotifications(ModuleDefinition * pModuleDefinition)

void

raiseModulePreUnloadNotifications(ModuleDefinition * pModuleDefinition)

bool

removeModuleDefinition(ModuleDefinition * pModuleDefinition)

bool

resolveModuleDependencies(StringTableEntry moduleId, const U32 versionId, StringTableEntry moduleGroup, bool synchronizedOnly, typeModuleLoadEntryVector & moduleResolvingQueue, typeModuleLoadEntryVector & moduleReadyQueue)

Detailed Description

see:

moduleGroup

Private Types

typedef SimObject Parent

typedef HashMap< StringTableEntry, typeModuleIdVector * > typeGroupModuleHash

typedef Vector< StringTableEntry > typeGroupVector

typedef HashMap< StringTableEntry, ModuleDefinitionEntry * > typeModuleIdDatabaseHash

Module databases.

typedef Vector< StringTableEntry > typeModuleIdVector

Module loading.

typedef Vector< ModuleLoadEntry > typeModuleLoadEntryVector

Public Types

typedef Vector< const ModuleDefinition * > typeConstModuleDefinitionVector

typedef Vector< ModuleDefinition * > typeModuleDefinitionVector

Module definitions.

Private Attributes

S32 mDatabaseLocks

bool mEchoInfo

bool mEnforceDependencies

Miscellaneous.

typeGroupModuleHash mGroupModules

typeGroupVector mGroupsLoaded

bool mIgnoreLoadedGroups

char mModuleExtension [256]

typeModuleIdDatabaseHash mModuleIdDatabase

typeModuleLoadEntryVector mModulesLoaded

SimSet mNotificationListeners

Taml mTaml

Public Functions

ModuleManager()

~ModuleManager()

addListener(SimObject * pListener)

Module notifications.

canMergeModules(const char * pMergeSourcePath)

copyModule(ModuleDefinition * pSourceModuleDefinition, const char * pTargetModuleId, const char * pTargetPath, const bool useVersionPathing)

Module synchronization.

DECLARE_CONOBJECT(ModuleManager )

Declare Console Object.

findLoadedModule(const char * pModuleId)

findModule(const char * pModuleId, const U32 versionId)

Module type enumeration.

findModuleByFilePath(StringTableEntry filePath)

findModules(const bool loadedOnly, typeConstModuleDefinitionVector & moduleDefinitions)

findModuleTypes(const char * pModuleType, const bool loadedOnly, typeConstModuleDefinitionVector & moduleDefinitions)

isModuleMergeAvailable(void )

Module updates.

loadModuleExplicit(const char * pModuleId, const U32 versionId)

loadModuleGroup(const char * pModuleGroup)

Module (un)loading.

mergeModules(const char * pMergeTargetPath, const bool removeMergeDefinition, const bool registerNewModules)

onAdd()

Reimplemented from: SimObject

onDeleteNotify(SimObject * object)

Reimplemented from: SimObject

onRemove()

Reimplemented from: SimObject

registerModule(const char * pModulePath, const char * pModuleFile)

Module unregister.

removeListener(SimObject * pListener)

renameModule(ModuleDefinition * pSourceModuleDefinition, const char * pNewModuleName)

Editing modules.

scanModules(const char * pPath, const bool rootOnly)

Module discovery.

setIgnoreLoadedGroups(bool doIgnore)

setModuleExtension(const char * pExtension)

Module definitions.

synchronizeDependencies(ModuleDefinition * pRootModuleDefinition, const char * pTargetDependencyPath)

unloadModuleExplicit(const char * pModuleId)

unloadModuleGroup(const char * pModuleGroup)

unregisterModule(const char * pModuleId, const U32 versionId)

Public Static Functions

initPersistFields()

Private Functions

clearDatabase(void )

findGroupLoaded(StringTableEntry moduleGroup)

findModuleDefinition(StringTableEntry moduleId, const U32 versionId)

findModuleId(StringTableEntry moduleId)

findModuleLoaded(StringTableEntry moduleId, const U32 versionId)

findModuleReady(StringTableEntry moduleId, typeModuleLoadEntryVector & moduleReadyQueue)

findModuleResolving(StringTableEntry moduleId, typeModuleLoadEntryVector & moduleResolvingQueue)

getModuleMergeFilePath(void )

raiseModulePostLoadNotifications(ModuleDefinition * pModuleDefinition)

raiseModulePostUnloadNotifications(ModuleDefinition * pModuleDefinition)

raiseModulePreLoadNotifications(ModuleDefinition * pModuleDefinition)

raiseModulePreUnloadNotifications(ModuleDefinition * pModuleDefinition)

removeModuleDefinition(ModuleDefinition * pModuleDefinition)

resolveModuleDependencies(StringTableEntry moduleId, const U32 versionId, StringTableEntry moduleGroup, bool synchronizedOnly, typeModuleLoadEntryVector & moduleResolvingQueue, typeModuleLoadEntryVector & moduleReadyQueue)