SWMgr Class Reference

#include <swmgr.h>

Collaboration diagram for SWMgr:

Public Member Functions
virtual void	augmentModules (const char *path, bool multiMod=false)
void	deleteModule (const char *)
virtual char	filterText (const char *filterName, SWBuf &text, const SWKey *key=0, const SWModule *module=0)
virtual const char *	getGlobalOption (const char *option)
virtual StringList	getGlobalOptions ()
virtual const char *	getGlobalOptionTip (const char *option)
virtual StringList	getGlobalOptionValues (const char *option)
SWModule *	getModule (const char *modName)
const SWModule *	getModule (const char *modName) const
ModMap &	getModules ()
const ModMap &	getModules () const
ModMap &	getUtilModules ()
const ModMap &	getUtilModules () const
virtual void	InstallScan (const char *dir)
virtual SWDEPRECATED signed char	Load ()
virtual signed char	load ()
virtual signed char	setCipherKey (const char *modName, const char *key)
virtual void	setGlobalOption (const char *option, const char *value)
	SWMgr (SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false)
	SWMgr (SWFilterMgr *filterMgr, bool multiMod=false)
	SWMgr (const char *iConfigPath, bool autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false, bool augmentHome=true)
virtual	~SWMgr ()

Static Public Member Functions
static void	findConfig (char *configType, char **prefixPath, char **configPath, StringList *augPaths=0, SWConfig **providedSysConf=0)
static SWDEPRECATED SWBuf	getHomeDir ()

Public Attributes
SWConfig *	config
char *	configPath
ModMap	Modules
char *	prefixPath
SWConfig *	sysConfig

Static Public Attributes
static const char *	globalConfPath = "/etc/sword.conf:/usr/local/etc/sword.conf"
static bool	isICU = false
static const char *	MODTYPE_BIBLES = "Biblical Texts"
static const char *	MODTYPE_COMMENTARIES = "Commentaries"
static const char *	MODTYPE_DAILYDEVOS = "Daily Devotional"
static const char *	MODTYPE_GENBOOKS = "Generic Books"
static const char *	MODTYPE_LEXDICTS = "Lexicons / Dictionaries"

Protected Member Functions
virtual SWDEPRECATED void	AddEncodingFilters (SWModule *module, ConfigEntMap &section)
virtual void	addEncodingFilters (SWModule *module, ConfigEntMap &section)
virtual void	addGlobalOptionFilters (SWModule *module, ConfigEntMap &section)
virtual SWDEPRECATED void	AddGlobalOptions (SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)
virtual void	addLocalOptionFilters (SWModule *module, ConfigEntMap &section)
virtual SWDEPRECATED void	AddLocalOptions (SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)
virtual void	addLocalStripFilters (SWModule *module, ConfigEntMap &section)
virtual char	addModToConfig (FileDesc *conffd, const char *fname)
virtual SWDEPRECATED void	AddRawFilters (SWModule *module, ConfigEntMap &section)
virtual void	addRawFilters (SWModule *module, ConfigEntMap &section)
virtual SWDEPRECATED void	AddRenderFilters (SWModule *module, ConfigEntMap &section)
virtual void	addRenderFilters (SWModule *module, ConfigEntMap &section)
virtual SWDEPRECATED void	AddStripFilters (SWModule *module, ConfigEntMap &section)
virtual void	addStripFilters (SWModule *module, ConfigEntMap &section)
virtual SWDEPRECATED void	AddStripFilters (SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)
virtual void	createAllModules (bool multiMod=false)
SWDEPRECATED void	CreateMods (bool multiMod=false)
virtual SWModule *	createModule (const char *name, const char *driver, ConfigEntMap &section)
virtual void	deleteAllModules ()
SWDEPRECATED void	DeleteMods ()
virtual void	init ()
virtual void	loadConfigDir (const char *ipath)

Protected Attributes
StringList	augPaths
FilterMap	cipherFilters
FilterList	cleanupFilters
char	configType
FilterMap	extraFilters
SWFilterMgr *	filterMgr
SWFilter *	gbfplain
SWConfig *	homeConfig
SWConfig *	myconfig
SWConfig *	mysysconfig
OptionFilterMap	optionFilters
StringList	options
SWFilter *	osisplain
SWFilter *	teiplain
SWFilter *	thmlplain
SWOptionFilter *	transliterator

Private Member Functions
void	commonInit (SWConfig *iconfig, SWConfig *isysconfig, bool autoload, SWFilterMgr *filterMgr, bool multiMod=false)

Private Attributes
bool	augmentHome
bool	mgrModeMultiMod
ModMap	utilModules

Detailed Description

SWMgr exposes an installed module set

SWMgr exposes an installed module set and can be asked to configure the desired markup and options which modules will produce.

Version

Id:

swmgr.h 3820 2020-10-24 20:27:30Z scribe

Definition at line 93 of file swmgr.h.

Constructor & Destructor Documentation

SWMgr::SWMgr	(	SWConfig *	iconfig = 0,
		SWConfig *	isysconfig = 0,
		bool	autoload = true,
		SWFilterMgr *	filterMgr = 0,
		bool	multiMod = false
	)

Constructs an instance of SWMgr

Parameters

iconfig	manually supply a configuration. If not supplied, SWMgr will look on the system using a complex hierarchical search. See README for detailed specifics.
isysconfig	manually supply a an isysconfig (e.g. /etc/sword.conf)
autoload	whether or not to immediately load modules on construction of this SWMgr. If you reimplemented SWMgr you can set this to false and call SWMgr::load() after you have completed the contruction and setup of your SWMgr subclass.
filterMgr	an SWFilterMgr subclass to use to manager filters on modules SWMgr TAKES OWNERSHIP FOR DELETING THIS OBJECT For example, this will create an SWMgr and cause its modules to produce HTMLHREF formatted output when asked for renderable text:

SWMgr *myMgr = new SWMgr(0, 0, true, new MarkupFilterMgr(FMT_HTMLHREF));

Definition at line 368 of file swmgr.cpp.

                                                                                                          {
    commonInit(iconfig, isysconfig, autoload, filterMgr, multiMod);
}

SWMgr::SWMgr	(	SWFilterMgr *	filterMgr,
		bool	multiMod = false
	)

Definition at line 363 of file swmgr.cpp.

                                                  {
    commonInit(0, 0, true, filterMgr, multiMod);
}

SWMgr::SWMgr	(	const char *	iConfigPath,
		bool	autoload = true,
		SWFilterMgr *	filterMgr = 0,
		bool	multiMod = false,
		bool	augmentHome = true
	)

Parameters

iConfigPath

provide a custom path to use for module set location, instead of searching the system for it.

Definition at line 377 of file swmgr.cpp.

                                                                                                            {

    init();

    mgrModeMultiMod = multiMod;
    SWBuf path;
    
    this->filterMgr = filterMgr;
    if (filterMgr)
        filterMgr->setParentMgr(this);
    
    this->augmentHome = augmentHome;

    path = iConfigPath;
    int len = (int)path.length();
    if ((len < 1) || ((iConfigPath[len-1] != '\\') && (iConfigPath[len-1] != '/')))
        path += "/";
    SWLOGTI("Checking at provided path: %s...", path.c_str());
    if (FileMgr::existsFile(path.c_str(), "mods.conf")) {
        stdstr(&prefixPath, path.c_str());
        path += "mods.conf";
        stdstr(&configPath, path.c_str());
    }
    else if (FileMgr::existsDir(path.c_str(), "mods.d")) {
        SWLOGTI("Found mods.d/");
        stdstr(&prefixPath, path.c_str());
        path += "mods.d";
        stdstr(&configPath, path.c_str());
        configType = 1;
    }
    else {
        SWLOGTI("Config not found at provided path.");
    }

    config = 0;
    sysConfig = 0;

    if (autoload && configPath)
        Load();
}

SWMgr::~SWMgr ( )

virtual

The destructor of SWMgr. This function cleans up the modules and deletes the created object. Destroying the SWMgr causes all retrieved SWModule object to be invalid, so be sure to destroy only when retrieved objects are no longer needed.

Definition at line 422 of file swmgr.cpp.

              {

    deleteAllModules();

    for (FilterList::iterator it = cleanupFilters.begin(); it != cleanupFilters.end(); it++)
        delete (*it);
            
    if (homeConfig)
        delete homeConfig;

    if (mysysconfig)
        delete mysysconfig;

    if (myconfig)
        delete myconfig;

    if (prefixPath)
        delete [] prefixPath;

    if (configPath)
        delete [] configPath;

    if (filterMgr)
        delete filterMgr;
}

Member Function Documentation

virtual SWDEPRECATED void SWMgr::AddEncodingFilters ( SWModule *  module, ConfigEntMap &  section  )

inlineprotectedvirtual

Deprecated:

Use addEncodingFilters instead

Definition at line 196 of file swmgr.h.

{ addEncodingFilters(module, section); }

void SWMgr::addEncodingFilters ( SWModule *  module, ConfigEntMap &  section  )

protectedvirtual

Adds appropriate encoding filters to a module. Override to add any special encoding filters. See the module.conf Encoding= entry.

Parameters

module	module to which to add encoding filters
section	configuration information for module

Definition at line 1266 of file swmgr.cpp.

                                                                      {
    if (filterMgr)
        filterMgr->addEncodingFilters(module, section);
}

void SWMgr::addGlobalOptionFilters ( SWModule *  module, ConfigEntMap &  section  )

protectedvirtual

Adds appropriate global option filters to a module. Override to add any special global option filters. Global option filters typically update SourceType markup to turn on and off specific features of a text when a user has optionally chosen to show or hide that feature, e.g. Strongs, Footnotes, Headings, etc. Global options can also have more than On and Off values, but these are the most common. A set of all global options included from an entire library of installed modules can be obtained from getGlobalOptions and presented to the user. Values to which each global option may be set can be obtain from getGlobalOptionValues, and similar. See that family of methods for more information. See the module.conf GlobalOptionFilter= entries.

Parameters

module	module to which to add encoding filters
section	configuration information for module

Definition at line 1140 of file swmgr.cpp.

                                                                          {

    ConfigEntMap::iterator start = section.lower_bound("GlobalOptionFilter");
    ConfigEntMap::iterator end   = section.upper_bound("GlobalOptionFilter");

    for (;start != end; ++start) {
        OptionFilterMap::iterator it;
        SWBuf filterName = start->second;


        // special cases for filters with parameters

        if (filterName.startsWith("OSISReferenceLinks")) {
            SWBuf params = filterName;
            filterName = params.stripPrefix('|', true);
            SWBuf optionName = params.stripPrefix('|', true);
            SWBuf optionTip = params.stripPrefix('|', true);
            SWBuf optionType = params.stripPrefix('|', true);
            SWBuf optionSubType = params.stripPrefix('|', true);
            SWBuf optionDefaultValue = params.stripPrefix('|', true);
            // we'll key off of type and subtype.
            filterName = filterName + "." + optionType + "." + optionSubType;

            it = optionFilters.find(filterName);
            if (it == optionFilters.end()) {
                SWOptionFilter *tmpFilter = new OSISReferenceLinks(optionName, optionTip, optionType, optionSubType, optionDefaultValue);
                optionFilters.insert(OptionFilterMap::value_type(filterName, tmpFilter));
                cleanupFilters.push_back(tmpFilter);
            }
        }


        it = optionFilters.find(filterName);
        if (it != optionFilters.end()) {
            module->addOptionFilter((*it).second);  // add filter to module and option as a valid option
            StringList::iterator loop;
            for (loop = options.begin(); loop != options.end(); loop++) {
                if (!strcmp((*loop).c_str(), (*it).second->getOptionName()))
                    break;
            }
            if (loop == options.end())  // if we have not yet included the option
                options.push_back((*it).second->getOptionName());
        }
    }
    if (filterMgr)
        filterMgr->addGlobalOptions(module, section, start, end);
#ifdef _ICU_
    module->addOptionFilter(transliterator);
#endif
}

virtual SWDEPRECATED void SWMgr::AddGlobalOptions ( SWModule *  module, ConfigEntMap &  section, ConfigEntMap::iterator  start, ConfigEntMap::iterator  end  )

inlineprotectedvirtual

Deprecated:

Use addGlobalOptionFilters instead.

Definition at line 160 of file swmgr.h.

{ addGlobalOptionFilters(module, section); }

void SWMgr::addLocalOptionFilters ( SWModule *  module, ConfigEntMap &  section  )

protectedvirtual

Adds appropriate local option filters to a module. Override to add any special local option filters. Local options are similar to global options in that they may be toggled on or off or set to some value from a range of choices but local option See the module.conf LocalOptionFilter= entries.

Parameters

module	module to which to add encoding filters
section	configuration information for module

Definition at line 1215 of file swmgr.cpp.

                                                                         {

    ConfigEntMap::iterator start = section.lower_bound("LocalOptionFilter");
    ConfigEntMap::iterator end   = section.upper_bound("LocalOptionFilter");

    for (;start != end; start++) {
        OptionFilterMap::iterator it;
        it = optionFilters.find((*start).second);
        if (it != optionFilters.end()) {
            module->addOptionFilter((*it).second);  // add filter to module
        }
    }

    if (filterMgr)
        filterMgr->addLocalOptions(module, section, start, end);
}

virtual SWDEPRECATED void SWMgr::AddLocalOptions ( SWModule *  module, ConfigEntMap &  section, ConfigEntMap::iterator  start, ConfigEntMap::iterator  end  )

inlineprotectedvirtual

Deprecated:

Use addLocalOptionFilters instead.

Definition at line 181 of file swmgr.h.

{ addLocalOptionFilters(module, section); }

void SWMgr::addLocalStripFilters ( SWModule *  module, ConfigEntMap &  section  )

protectedvirtual

Adds manually specified strip filters specified in module configuration as LocalStripFilters. These might take care of special cases of preparation for searching, e.g., removing ()[] and underdot symbols from manuscript modules

Parameters

module	module to which to add local strip filters
section	configuration information for module

Definition at line 1234 of file swmgr.cpp.

                                                                        {

    ConfigEntMap::iterator start = section.lower_bound("LocalStripFilter");
    ConfigEntMap::iterator end   = section.upper_bound("LocalStripFilter");

    for (;start != end; start++) {
        OptionFilterMap::iterator it;
        it = optionFilters.find((*start).second);
        if (it != optionFilters.end()) {
            module->addStripFilter((*it).second);   // add filter to module
        }
    }
}

char SWMgr::addModToConfig ( FileDesc *  conffd, const char *  fname  )

protectedvirtual

Definition at line 1374 of file swmgr.cpp.

{
    FileDesc *modfd;
    char ch;

    SWLOGTI("Found new module [%s]. Installing...", fname);
    modfd = FileMgr::getSystemFileMgr()->open(fname, FileMgr::RDONLY);
    ch = '\n';
    conffd->write(&ch, 1);
    while (modfd->read(&ch, 1) == 1)
        conffd->write(&ch, 1);
    ch = '\n';
    conffd->write(&ch, 1);
    FileMgr::getSystemFileMgr()->close(modfd);
    return 0;
}

virtual SWDEPRECATED void SWMgr::AddRawFilters ( SWModule *  module, ConfigEntMap &  section  )

inlineprotectedvirtual

Deprecated:

Use addRawFilters instead.

Definition at line 251 of file swmgr.h.

{ addRawFilters(module, section); }

void SWMgr::addRawFilters ( SWModule *  module, ConfigEntMap &  section  )

protectedvirtual

Add appropriate raw filters to a module. Override to add any special raw filters. Raw filters are used to manipulate a buffer immediately after it has been read from storage. For example, any decryption that might need to be done. See the module.conf CipherKey= entry.

Parameters

module	module to which to add raw filters
section	configuration information for module

Definition at line 1249 of file swmgr.cpp.

                                                                 {
    SWBuf sourceformat, cipherKey;
    ConfigEntMap::iterator entry;

    cipherKey = ((entry = section.find("CipherKey")) != section.end()) ? (*entry).second : (SWBuf)"";
    if (cipherKey.length()) {
        SWFilter *cipherFilter = new CipherFilter(cipherKey.c_str());
        cipherFilters.insert(FilterMap::value_type(module->getName(), cipherFilter));
        cleanupFilters.push_back(cipherFilter);
        module->addRawFilter(cipherFilter);
    }

    if (filterMgr)
        filterMgr->addRawFilters(module, section);
}

virtual SWDEPRECATED void SWMgr::AddRenderFilters ( SWModule *  module, ConfigEntMap &  section  )

inlineprotectedvirtual

Deprecated:

Use addRenderFilters instead.

Definition at line 209 of file swmgr.h.

{ addRenderFilters(module, section); }

void SWMgr::addRenderFilters ( SWModule *  module, ConfigEntMap &  section  )

protectedvirtual

Add appropriate render filters to a module. Override to add any special render filters. Render filters are used for preparing a text for display and typically convert markup from SourceType to desired display markup. See the module.conf SourceType= entry.

Parameters

module	module to which to add render filters
section	configuration information for module

Definition at line 1272 of file swmgr.cpp.

                                                                    {
    SWBuf sourceformat;
    ConfigEntMap::iterator entry;

    sourceformat = ((entry = section.find("SourceType")) != section.end()) ? (*entry).second : (SWBuf)"";

    // Temporary: To support old module types
    // TODO: Remove at 1.6.0 release?
    if (!sourceformat.length()) {
        sourceformat = ((entry = section.find("ModDrv")) != section.end()) ? (*entry).second : (SWBuf)"";
        if (!stricmp(sourceformat.c_str(), "RawGBF"))
            sourceformat = "GBF";
        else sourceformat = "";
    }

// process module   - eg. follows
//  if (!stricmp(sourceformat.c_str(), "GBF")) {
//      module->AddRenderFilter(gbftortf);
//  }

    if (filterMgr)
        filterMgr->addRenderFilters(module, section);

}

virtual SWDEPRECATED void SWMgr::AddStripFilters ( SWModule *  module, ConfigEntMap &  section  )

inlineprotectedvirtual

Deprecated:

Use addStripFilters instead.

Definition at line 224 of file swmgr.h.

{ addStripFilters(module, section); }

void SWMgr::addStripFilters ( SWModule *  module, ConfigEntMap &  section  )

protectedvirtual

Adds appropriate strip filters to a module. Override to add any special strip filters. Strip filters are used for preparing text for searching and typically strip out all markup and leave only searchable words See the module.conf SourceType= entry.

Parameters

module	module to which to add strip filters
section	configuration information for module

Definition at line 1298 of file swmgr.cpp.

{
    SWBuf sourceformat;
    ConfigEntMap::iterator entry;

    sourceformat = ((entry = section.find("SourceType")) != section.end()) ? (*entry).second : (SWBuf)"";
    // Temporary: To support old module types
    if (!sourceformat.length()) {
        sourceformat = ((entry = section.find("ModDrv")) != section.end()) ? (*entry).second : (SWBuf)"";
        if (!stricmp(sourceformat.c_str(), "RawGBF"))
            sourceformat = "GBF";
        else sourceformat = "";
    }
    
    if (!stricmp(sourceformat.c_str(), "GBF")) {
        module->addStripFilter(gbfplain);
    }
    else if (!stricmp(sourceformat.c_str(), "ThML")) {
        module->addStripFilter(thmlplain);
    }
    else if (!stricmp(sourceformat.c_str(), "OSIS")) {
        module->addStripFilter(osisplain);
    }
    else if (!stricmp(sourceformat.c_str(), "TEI")) {
        module->addStripFilter(teiplain);
    }

    if (filterMgr)
        filterMgr->addStripFilters(module, section);

}

virtual SWDEPRECATED void SWMgr::AddStripFilters ( SWModule *  module, ConfigEntMap &  section, ConfigEntMap::iterator  start, ConfigEntMap::iterator  end  )

inlineprotectedvirtual

Deprecated:

Use addLocalStripFilters instead.

Definition at line 238 of file swmgr.h.

{ addLocalStripFilters(module, section); }

void SWMgr::augmentModules ( const char *  path, bool  multiMod = false  )

virtual

Adds books from a new path to the library

Parameters

path	the path in which to search for books
multiMod	whether or not to keep multiple copies of the same book if found in different paths default - false, uses last found version of the book

Definition at line 776 of file swmgr.cpp.

                                                           {
    SWBuf path = ipath;
    if (!path.endsWith("/") && !path.endsWith("\\")) path += "/";
    if (FileMgr::existsDir(path.c_str(), "mods.d")) {
        char *savePrefixPath = 0;
        char *saveConfigPath = 0;
        SWConfig *saveConfig = 0;
        stdstr(&savePrefixPath, prefixPath);
        stdstr(&prefixPath, path.c_str());
        path += "mods.d";
        stdstr(&saveConfigPath, configPath);
        stdstr(&configPath, path.c_str());
        saveConfig = config;
        config = myconfig = 0;
        loadConfigDir(configPath);

        if (multiMod) {
            // fix config's Section names to rename modules which are available more than once
            // find out which sections are in both config objects
            // inserting all configs first is not good because that overwrites old keys and new modules would share the same config
            for (SectionMap::iterator it = config->getSections().begin(); it != config->getSections().end();) {
                if (saveConfig->getSections().find((*it).first) != saveConfig->getSections().end()) { //if the new section is already present rename it
                    ConfigEntMap entMap((*it).second);
                    
                    SWBuf name;
                    int i = 1;
                    do { //module name already used?
                        name.setFormatted("%s_%d", (*it).first.c_str(), i);
                        i++;
                    } while (config->getSections().find(name) != config->getSections().end());
                    
                    config->getSections().insert(SectionMap::value_type(name, entMap) );
                    SectionMap::iterator toErase = it++;
                    config->getSections().erase(toErase);
                }
                else ++it;
            }
        }
        
        createAllModules(multiMod);

        stdstr(&prefixPath, savePrefixPath);
        delete []savePrefixPath;
        stdstr(&configPath, saveConfigPath);
        delete []saveConfigPath;

        (*saveConfig) += *config;
        
        homeConfig = myconfig;
        config = myconfig = saveConfig;
    }
}

void SWMgr::commonInit ( SWConfig *  iconfig, SWConfig *  isysconfig, bool  autoload, SWFilterMgr *  filterMgr, bool  multiMod = false  )

private

Definition at line 335 of file swmgr.cpp.

                                                                                                                    {

    init();

    mgrModeMultiMod = multiMod;
    this->filterMgr = filterMgr;
    if (filterMgr)
        filterMgr->setParentMgr(this);
    
    if (iconfig) {
        config   = iconfig;
        myconfig = 0;
    }
    else config = 0;
    if (isysconfig) {
        sysConfig   = isysconfig;
        mysysconfig = 0;
    }
    else sysConfig = 0;

    if (autoload)
        Load();
}

void SWMgr::createAllModules ( bool  multiMod = false )

protectedvirtual

method to create all modules from configuration.

Override to add any special processing before or after calling SWMgr::createAllModules

e.g., augmenting a localConfig.conf to SWMgr::config that might store CipheyKey or Font preferences per module before actual construction of modules

Definition at line 1456 of file swmgr.cpp.

                                          {
SWLOGD("libsword: SWMgr::createAllModules");
    SectionMap::iterator it;
    ConfigEntMap::iterator entry;
    SWModule *newmod;
    SWBuf driver, misc1;
    for (it = config->getSections().begin(); it != config->getSections().end(); it++) {
        ConfigEntMap &section = (*it).second;
        newmod = 0;
        
        driver = ((entry = section.find("ModDrv")) != section.end()) ? (*entry).second : (SWBuf)"";
        if (driver.length()) {
            newmod = createModule((*it).first, driver, section);
            if (newmod) {
                // Filters to add for this module and globally announce as an option to the user
                // e.g. translit, strongs, redletterwords, etc, so users can turn these on and off globally
                // TODO: addGlobalOptionFilters(newmod, section);
                AddGlobalOptions(newmod, section, section.lower_bound("GlobalOptionFilter"), section.upper_bound("GlobalOptionFilter"));

                // Only add the option to the module, don't announce it's availability
                // These are useful for like: filters that parse special entryAttribs in a text
                // or whatever you might want to happen on entry lookup
                // TODO: addLocalOptionFilters(newmod, section);
                AddLocalOptions(newmod, section, section.lower_bound("LocalOptionFilter"), section.upper_bound("LocalOptionFilter"));

                //STRIP FILTERS

                // add all basic strip filters for for the modtype
                // TODO: addStripFilters(newmod, section);
                addStripFilters(newmod, section);

                // Any module-specific processing specified in module config
                // as entries LocalStripFilter=
                // e.g. for papyri, removed all [](). notation
                // TODO: addLocalStripFilters(newmod, section);
                AddStripFilters(newmod, section, section.lower_bound("LocalStripFilter"), section.upper_bound("LocalStripFilter"));

                // TODO: addRawFilters(newmod, section);
                addRawFilters(newmod, section);
                // TODO: addRenderFilters(newmod, section);
                addRenderFilters(newmod, section);
                // TODO: addEncodingFilters(newmod, section);
                addEncodingFilters(newmod, section);
                
                // place our module in module container, removing first if one
                // already exists by our same name
                SWModule *oldmod = getModule(newmod->getName());
                if (oldmod) {
                    delete oldmod;
                }
                
                // if it's not a utility module save it to Modules
                if (    SWBuf("Utility") != newmod->getType() &&
                    SWBuf("Utility") != newmod->getConfigEntry("Category")) {
                    Modules[newmod->getName()] = newmod;
                }
                else    utilModules[newmod->getName()] = newmod;
            }
        }
    }
}

SWDEPRECATED void SWMgr::CreateMods ( bool  multiMod = false )

inlineprotected

Deprecated:

. Use createAllModules instead

Definition at line 108 of file swmgr.h.

{ createAllModules(multiMod); };

SWModule * SWMgr::createModule ( const char *  name, const char *  driver, ConfigEntMap &  section  )

protectedvirtual

called to create exactly one module from a config entry override to do any extra work before or after each module is created

Definition at line 909 of file swmgr.cpp.

{
    SWBuf description, datapath, misc1;
    ConfigEntMap::iterator entry;
    SWModule *newmod = 0;
    SWBuf lang, sourceformat, encoding;
    signed char direction, enc, markup;

    description  = ((entry = section.find("Description")) != section.end()) ? (*entry).second : (SWBuf)"";
    lang  = ((entry = section.find("Lang")) != section.end()) ? (*entry).second : (SWBuf)"en";
    sourceformat = ((entry = section.find("SourceType"))  != section.end()) ? (*entry).second : (SWBuf)"";
    encoding = ((entry = section.find("Encoding"))  != section.end()) ? (*entry).second : (SWBuf)"";
    datapath = prefixPath;
    if ((prefixPath[strlen(prefixPath)-1] != '\\') && (prefixPath[strlen(prefixPath)-1] != '/'))
        datapath += "/";

    SWBuf versification = ((entry = section.find("Versification"))  != section.end()) ? (*entry).second : (SWBuf)"KJV";

    // DataPath - relative path to data used by module driver.  May be a directory, may be a File.
    //   Typically not useful by outside world.  See AbsoluteDataPath, PrefixPath, and RelativePrefixPath
    //   below.
    misc1 += ((entry = section.find("DataPath")) != section.end()) ? (*entry).second : (SWBuf)"";
    char *buf = new char [ strlen(misc1.c_str()) + 1 ];
    char *buf2 = buf;
    strcpy(buf, misc1.c_str());
//  for (; ((*buf2) && ((*buf2 == '.') || (*buf2 == '/') || (*buf2 == '\\'))); buf2++);
    for (; ((*buf2) && ((*buf2 == '/') || (*buf2 == '\\'))); buf2++);
    if (!strncmp(buf2, "./", 2)) { //remove the leading ./ in the module data path to make it look better
        buf2 += 2;
    }
    // PrefixPath - absolute directory path to the repository in which this module was found
    section["PrefixPath"] = datapath;
    if (*buf2)
        datapath += buf2;
    delete [] buf;

    section["AbsoluteDataPath"] = datapath;

    if (!stricmp(sourceformat.c_str(), "GBF"))
        markup = FMT_GBF;
    else if (!stricmp(sourceformat.c_str(), "ThML"))
        markup = FMT_THML;
    else if (!stricmp(sourceformat.c_str(), "OSIS"))
        markup = FMT_OSIS;
    else if (!stricmp(sourceformat.c_str(), "TEI"))
        markup = FMT_TEI;
    else
        markup = FMT_GBF;

    if (!stricmp(encoding.c_str(), "UTF-8")) {
        enc = ENC_UTF8;
    }
    else if (!stricmp(encoding.c_str(), "SCSU")) {
        enc = ENC_SCSU;
    }
    else if (!stricmp(encoding.c_str(), "UTF-16")) {
        enc = ENC_UTF16;
    }
    else enc = ENC_LATIN1;

    if ((entry = section.find("Direction")) == section.end()) {
        direction = DIRECTION_LTR;
    }
    else if (!stricmp((*entry).second.c_str(), "rtol")) {
        direction = DIRECTION_RTL;
    }
    else if (!stricmp((*entry).second.c_str(), "bidi")) {
        direction = DIRECTION_BIDI;
    }
    else {
        direction = DIRECTION_LTR;
    }

    if ((!stricmp(driver, "zText")) || (!stricmp(driver, "zCom")) || (!stricmp(driver, "zText4")) || (!stricmp(driver, "zCom4"))) {
        SWCompress *compress = 0;
        int blockType = CHAPTERBLOCKS;
        misc1 = ((entry = section.find("BlockType")) != section.end()) ? (*entry).second : (SWBuf)"CHAPTER";
        if (!stricmp(misc1.c_str(), "VERSE"))
            blockType = VERSEBLOCKS;
        else if (!stricmp(misc1.c_str(), "CHAPTER"))
            blockType = CHAPTERBLOCKS;
        else if (!stricmp(misc1.c_str(), "BOOK"))
            blockType = BOOKBLOCKS;
        
        misc1 = ((entry = section.find("CompressType")) != section.end()) ? (*entry).second : (SWBuf)"LZSS";
#ifndef EXCLUDEZLIB
        if (!stricmp(misc1.c_str(), "ZIP"))
            compress = new ZipCompress();
        else
#endif
#ifndef EXCLUDEBZIP2
        if (!stricmp(misc1.c_str(), "BZIP2"))
            compress = new Bzip2Compress();
        else
#endif
#ifndef EXCLUDEXZ
        if (!stricmp(misc1.c_str(), "XZ"))
            compress = new XzCompress();
        else
#endif
        if (!stricmp(misc1.c_str(), "LZSS"))
            compress = new LZSSCompress();

        if (compress) {
            if (!stricmp(driver, "zText"))
                newmod = new zText(datapath.c_str(), name, description.c_str(), blockType, compress, 0, enc, direction, markup, lang.c_str(), versification);
            else if (!stricmp(driver, "zText4"))
                newmod = new zText4(datapath.c_str(), name, description.c_str(), blockType, compress, 0, enc, direction, markup, lang.c_str(), versification);
            else if (!stricmp(driver, "zCom4"))
                newmod = new zCom4(datapath.c_str(), name, description.c_str(), blockType, compress, 0, enc, direction, markup, lang.c_str(), versification);
            else
                newmod = new zCom(datapath.c_str(), name, description.c_str(), blockType, compress, 0, enc, direction, markup, lang.c_str(), versification);
        }
    }

    if (!stricmp(driver, "RawText")) {
        newmod = new RawText(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str(), versification);
    }

    if (!stricmp(driver, "RawText4")) {
        newmod = new RawText4(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str(), versification);
    }

    // backward support old drivers
    if (!stricmp(driver, "RawGBF")) {
        newmod = new RawText(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str());
    }

    if (!stricmp(driver, "RawCom")) {
        newmod = new RawCom(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str(), versification);
    }

    if (!stricmp(driver, "RawCom4")) {
        newmod = new RawCom4(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str(), versification);
    }

    if (!stricmp(driver, "RawFiles")) {
        newmod = new RawFiles(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str());
    }

    if (!stricmp(driver, "HREFCom")) {
        misc1 = ((entry = section.find("Prefix")) != section.end()) ? (*entry).second : (SWBuf)"";
        newmod = new HREFCom(datapath.c_str(), misc1.c_str(), name, description.c_str());
    }

    int pos = 0;  //used for position of final / in AbsoluteDataPath, but also set to 1 for modules types that need to strip module name
    if (!stricmp(driver, "RawLD")) {
        bool caseSensitive = ((entry = section.find("CaseSensitiveKeys")) != section.end()) ? (*entry).second == "true": false;
        bool strongsPadding = ((entry = section.find("StrongsPadding")) != section.end()) ? (*entry).second == "true": true;
        newmod = new RawLD(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str(), caseSensitive, strongsPadding);
        pos = 1;
    }

    if (!stricmp(driver, "RawLD4")) {
        bool caseSensitive = ((entry = section.find("CaseSensitiveKeys")) != section.end()) ? (*entry).second == "true": false;
        bool strongsPadding = ((entry = section.find("StrongsPadding")) != section.end()) ? (*entry).second == "true": true;
        newmod = new RawLD4(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str(), caseSensitive, strongsPadding);
        pos = 1;
    }

    if (!stricmp(driver, "zLD")) {
        SWCompress *compress = 0;
        int blockCount;
        bool caseSensitive = ((entry = section.find("CaseSensitiveKeys")) != section.end()) ? (*entry).second == "true": false;
        bool strongsPadding = ((entry = section.find("StrongsPadding")) != section.end()) ? (*entry).second == "true": true;
        misc1 = ((entry = section.find("BlockCount")) != section.end()) ? (*entry).second : (SWBuf)"200";
        blockCount = atoi(misc1.c_str());
        blockCount = (blockCount) ? blockCount : 200;

        misc1 = ((entry = section.find("CompressType")) != section.end()) ? (*entry).second : (SWBuf)"LZSS";
#ifndef EXCLUDEZLIB
        if (!stricmp(misc1.c_str(), "ZIP"))
            compress = new ZipCompress();
        else
#endif
#ifndef EXCLUDEBZIP2
        if (!stricmp(misc1.c_str(), "BZIP2"))
            compress = new Bzip2Compress();
        else
#endif
#ifndef EXCLUDEXZ
        if (!stricmp(misc1.c_str(), "XZ"))
            compress = new XzCompress();
        else
#endif
        if (!stricmp(misc1.c_str(), "LZSS"))
            compress = new LZSSCompress();

        if (compress) {
            newmod = new zLD(datapath.c_str(), name, description.c_str(), blockCount, compress, 0, enc, direction, markup, lang.c_str(), caseSensitive, strongsPadding);
        }
        pos = 1;
    }

    if (!stricmp(driver, "RawGenBook")) {
        misc1 = ((entry = section.find("KeyType")) != section.end()) ? (*entry).second : (SWBuf)"TreeKey";
        newmod = new RawGenBook(datapath.c_str(), name, description.c_str(), 0, enc, direction, markup, lang.c_str(), misc1.c_str());
        pos = 1;
    }

    if (pos == 1) {
        SWBuf &dp = section["AbsoluteDataPath"];
        for (int i = (int)dp.length() - 1; i; i--) {
            if (dp[i] == '/') {
                dp.setSize(i);
                break;
            }
        }
/*
        SWBuf &rdp = section["RelativeDataPath"];
        for (int i = rdp.length() - 1; i; i--) {
            if (rdp[i] == '/') {
                rdp.setSize(i);
                break;
            }
        }
*/
    }

    if (newmod) {
        // if a specific module type is set in the config, use this
        if ((entry = section.find("Type")) != section.end())
            newmod->setType(entry->second.c_str());

        newmod->setConfig(&section);
    }
    
    return newmod;
}

void SWMgr::deleteAllModules ( )

protectedvirtual

called to delete all contructed modules. Undoes createAllModules override to clean anything up before or after all modules are deleted

Definition at line 1519 of file swmgr.cpp.

                             {

    ModMap::iterator it;

    for (it = getModules().begin(); it != getModules().end(); ++it) {
        delete (*it).second;
    }
    for (it = getUtilModules().begin(); it != getUtilModules().end(); ++it) {
        delete (*it).second;
    }

    Modules.clear();
    utilModules.clear();
}

SWDEPRECATED void SWMgr::DeleteMods ( )

inlineprotected

Deprecated:

. Use deleteAllModules instead

Definition at line 112 of file swmgr.h.

{ deleteAllModules(); }

void SWMgr::deleteModule

(

const char *

modName

)

Definition at line 1535 of file swmgr.cpp.

                                            {
    ModMap::iterator it = Modules.find(modName);
    if (it != Modules.end()) {
        delete (*it).second;
        Modules.erase(it);
    }
    else {
        it = utilModules.find(modName);
        if (it != utilModules.end()) {
            delete (*it).second;
            utilModules.erase(it);
        }
    }
}

char SWMgr::filterText ( const char *  filterName, SWBuf &  text, const SWKey *  key = 0, const SWModule *  module = 0  )

virtual

Filters a buffer thru a named filter

Parameters

filterName	name of filter which the buffer should be filtered through
text	buffer to filter
key	context key if filter needs this for processing
module	context module if filter needs this for processing

Returns

error status

Definition at line 1192 of file swmgr.cpp.

                                                                                                    {
    signed char retVal = -1;
    // why didn't we use find here?
    for (OptionFilterMap::iterator it = optionFilters.begin(); it != optionFilters.end(); it++) {
        if ((*it).second->getOptionName()) {
            if (!stricmp(filterName, (*it).second->getOptionName())) {
                retVal = it->second->processText(text, key, module);
                break;
            }
        }
    }

    if (retVal == -1) {
        FilterMap::iterator it = extraFilters.find(filterName);
        if (it != extraFilters.end()) {
            retVal = it->second->processText(text, key, module);
        }
    }

    return retVal;
}

void SWMgr::findConfig ( char *  configType, char **  prefixPath, char **  configPath, StringList *  augPaths = 0, SWConfig **  providedSysConf = 0  )

static

Perform all the logic to discover a SWORD configuration and libraries on a system

Definition at line 449 of file swmgr.cpp.

                                                                                                                                   {
    static bool setLogLevel = false;
    SWBuf path;
    SWBuf sysConfPath;
    ConfigEntMap::iterator entry;
    ConfigEntMap::iterator lastEntry;

    if (!setLogLevel) {
        SWBuf envLogLevel = FileMgr::getEnvValue("SWORD_LOGLEVEL");
        if (envLogLevel.length()) {
            setSystemLogLevel(0, envLogLevel);
            setLogLevel = true;
        }
    }

    SWConfig *sysConf = 0;
    SWBuf sysConfDataPath = "";

    *configType = 0;

    SWBuf homeDir = FileMgr::getSystemFileMgr()->getHomeDir();

    // check for a sysConf passed in to us
    SWLOGTI("Checking for provided SWConfig(\"sword.conf\")...");
    if (providedSysConf && *providedSysConf) {
        sysConf = *providedSysConf;
        SWLOGTI("found.");
        if (!setLogLevel) { setSystemLogLevel(sysConf); setLogLevel = true; }
    }

    // if we haven't been given our datapath in a sysconf, we need to track it down
    if (!sysConf) {
        // check working directory
        SWLOGTI("Checking working directory for sword.conf...");
        if (FileMgr::existsFile(".", "sword.conf")) {
            SWLOGTI("Overriding any systemwide or ~/.sword/ sword.conf with one found in current directory.");
            sysConfPath = "./sword.conf";
            sysConf = new SWConfig(sysConfPath);
            if ((entry = sysConf->getSection("Install").find("DataPath")) != sysConf->getSection("Install").end()) {
                sysConfDataPath = (*entry).second;
            }
            if (!setLogLevel) { setSystemLogLevel(sysConf); setLogLevel = true; }
            if (providedSysConf) {
                *providedSysConf = sysConf;
            }
            else {
                delete sysConf;
                sysConf = 0;
            }
        }
        if (!sysConfDataPath.size()) {
            SWLOGTI("Checking working directory for mods.conf...");
            if (FileMgr::existsFile(".", "mods.conf")) {
                SWLOGTI("found.");
                stdstr(prefixPath, "./");
                stdstr(configPath, "./mods.conf");
                return;
            }

            SWLOGTI("Checking working directory for mods.d...");
            if (FileMgr::existsDir(".", "mods.d")) {
                SWLOGTI("found.");
                stdstr(prefixPath, "./");
                stdstr(configPath, "./mods.d");
                *configType = 1;
                return;
            }

            // check working directory ../library/
            SWLOGTI("Checking working directory ../library/ for mods.d...");
            if (FileMgr::existsDir("../library", "mods.d")) {
                SWLOGTI("found.");
                stdstr(prefixPath, "../library/");
                stdstr(configPath, "../library/mods.d");
                *configType = 1;
                return;
            }

            // check environment variable SWORD_PATH
            SWLOGTI("Checking $SWORD_PATH...");

            SWBuf envsworddir = FileMgr::getEnvValue("SWORD_PATH");
            if (envsworddir.length()) {
                
                SWLOGTI("found (%s).", envsworddir.c_str());
                path = envsworddir;
                if ((envsworddir[envsworddir.length()-1] != '\\') && (envsworddir[envsworddir.length()-1] != '/'))
                    path += "/";

                SWLOGTI("Checking $SWORD_PATH for mods.conf...");
                if (FileMgr::existsFile(path.c_str(), "mods.conf")) {
                    SWLOGTI("found.");
                    stdstr(prefixPath, path.c_str());
                    path += "mods.conf";
                    stdstr(configPath, path.c_str());
                    return;
                }

                SWLOGTI("Checking $SWORD_PATH for mods.d...");
                if (FileMgr::existsDir(path.c_str(), "mods.d")) {
                    SWLOGTI("found.");
                    stdstr(prefixPath, path.c_str());
                    path += "mods.d";
                    stdstr(configPath, path.c_str());
                    *configType = 1;
                    return;
                }
            }


            // check for systemwide globalConfPath

            SWLOGTI("Parsing %s...", globalConfPath);
            char *globPaths = 0;
            char *gfp;
            stdstr(&globPaths, globalConfPath);
            for (gfp = strtok(globPaths, ":"); gfp; gfp = strtok(0, ":")) {
                SWLOGTI("Checking for %s...", gfp);
                if (FileMgr::existsFile(gfp)) {
                    SWLOGTI("found.");
                    break;
                }
            }
            if (gfp)
                sysConfPath = gfp;
            delete [] globPaths;

            if (homeDir.length()) {
                SWBuf tryPath = homeDir;
                tryPath += ".sword/sword.conf";
                if (FileMgr::existsFile(tryPath)) {
                    SWLOGTI("Overriding any systemwide sword.conf with one found in users home directory (%s)", tryPath.c_str());
                    sysConfPath = tryPath;
                }
                else {
                    SWBuf tryPath = homeDir;
                    tryPath += "sword/sword.conf";
                    if (FileMgr::existsFile(tryPath)) {
                        SWLOGTI("Overriding any systemwide sword.conf with one found in users home directory (%s)", tryPath.c_str());
                        sysConfPath = tryPath;
                    }
                }
            }
        }
    }

    if (!sysConf && sysConfPath.size()) {
        sysConf = new SWConfig(sysConfPath);
    }

    if (sysConf) {
        if (!setLogLevel) { setSystemLogLevel(sysConf); setLogLevel = true; }
        if ((entry = sysConf->getSection("Install").find("DataPath")) != sysConf->getSection("Install").end()) {
            sysConfDataPath = (*entry).second;
        }
        if (sysConfDataPath.size()) {
            if ((!sysConfDataPath.endsWith("\\")) && (!sysConfDataPath.endsWith("/")))
                sysConfDataPath += "/";

            path = sysConfDataPath;
            SWLOGTI("DataPath in %s is set to %s.", sysConfPath.c_str(), path.c_str());
            SWLOGTI("Checking for mods.conf in DataPath...");
            
            if (FileMgr::existsFile(path.c_str(), "mods.conf")) {
                SWLOGTI("found.");
                stdstr(prefixPath, path.c_str());
                path += "mods.conf";
                stdstr(configPath, path.c_str());
                *configType = 1;
            }

            SWLOGTI("Checking for mods.d in DataPath...");

            if (FileMgr::existsDir(path.c_str(), "mods.d")) {
                SWLOGTI("found.");
                stdstr(prefixPath, path.c_str());
                path += "mods.d";
                stdstr(configPath, path.c_str());
                *configType = 1;
            }
        }
    }

    // do some extra processing of sysConf if we have one
    if (sysConf) {
        if (!setLogLevel) { setSystemLogLevel(sysConf); setLogLevel = true; }
        if (augPaths) {
            augPaths->clear();
            entry     = sysConf->getSection("Install").lower_bound("AugmentPath");
            lastEntry = sysConf->getSection("Install").upper_bound("AugmentPath");
            for (;entry != lastEntry; entry++) {
                path = entry->second;
                if ((entry->second.c_str()[strlen(entry->second.c_str())-1] != '\\') && (entry->second.c_str()[strlen(entry->second.c_str())-1] != '/'))
                    path += "/";
                augPaths->push_back(path);
            }
        }
        if (providedSysConf) {
            *providedSysConf = sysConf;
        }
        else delete sysConf;
    }

    if (*configType)
        return;

    // WE STILL HAVEN'T FOUND A CONFIGURATION.  LET'S LOOK IN SOME OS SPECIFIC
    // LOCATIONS
    //
    // for various flavors of windoze...
    // check %ALLUSERSPROFILE%/Application Data/sword/

    SWLOGTI("Checking $ALLUSERSPROFILE/Application Data/sword/...");

    SWBuf envallusersdir = FileMgr::getEnvValue("ALLUSERSPROFILE");
    if (envallusersdir.length()) {
        SWLOGTI("found (%s).", envallusersdir.c_str());
        path = envallusersdir;
        if ((!path.endsWith("\\")) && (!path.endsWith("/")))
            path += "/";

        path += "Application Data/sword/";
        SWLOGTI("Checking %s for mods.d...", path.c_str());
        if (FileMgr::existsDir(path.c_str(), "mods.d")) {
            SWLOGTI("found.");
            stdstr(prefixPath, path.c_str());
            path += "mods.d";
            stdstr(configPath, path.c_str());
            *configType = 1;
            return;
        }
    }

    // for Mac OSX...
    // check $HOME/Library/Application Support/Sword/

    SWLOGTI("Checking $HOME/Library/Application Support/Sword/...");

    SWBuf pathCheck = FileMgr::getSystemFileMgr()->getHomeDir();
    if (pathCheck.length()) {
        SWLOGTI("found (%s).", pathCheck.c_str());
        path = pathCheck;
        if ((!path.endsWith("\\")) && (!path.endsWith("/")))
            path += "/";

        SWLOGTI("Checking %s for mods.d...", path.c_str());
        if (FileMgr::existsDir(path.c_str(), "mods.d")) {
            SWLOGTI("found.");
            stdstr(prefixPath, path.c_str());
            path += "mods.d";
            stdstr(configPath, path.c_str());
            *configType = 1;
            return;
        }
    }

    // FINALLY CHECK PERSONAL HOME DIRECTORY LOCATIONS
    // check ~/.sword/

    SWLOGTI("Checking home directory for ~/.sword...");

    if (homeDir.length()) {
        path = homeDir;
        path += ".sword/";
        SWLOGTI("  Checking for %smods.conf...", path.c_str());
        if (FileMgr::existsFile(path.c_str(), "mods.conf")) {
            SWLOGTI("found.");
            stdstr(prefixPath, path.c_str());
            path += "mods.conf";
            stdstr(configPath, path.c_str());
            return;
        }

        SWLOGTI("  Checking for %smods.d...", path.c_str());
        if (FileMgr::existsDir(path.c_str(), "mods.d")) {
            SWLOGTI("found.");
            stdstr(prefixPath, path.c_str());
            path += "mods.d";
            stdstr(configPath, path.c_str());
            *configType = 2;
            return;
        }

        path = homeDir;
        path += "sword/";
        SWLOGTI("  Checking for %smods.d...", path.c_str());
        if (FileMgr::existsDir(path.c_str(), "mods.d")) {
            SWLOGTI("found.");
            stdstr(prefixPath, path.c_str());
            path += "mods.d";
            stdstr(configPath, path.c_str());
            *configType = 2;
            return;
        }
    }
}

const char * SWMgr::getGlobalOption ( const char *  option )

virtual

Get the current value of the given option

Parameters

option

the name of the option, who's value is desired

Returns

the value of the given option

Definition at line 1403 of file swmgr.cpp.

{
    for (OptionFilterMap::iterator it = optionFilters.begin(); it != optionFilters.end(); it++) {
        if ((*it).second->getOptionName()) {
            if (!stricmp(option, (*it).second->getOptionName()))
                return (*it).second->getOptionValue();
        }
    }
    return 0;
}

StringList SWMgr::getGlobalOptions ( )

virtual

Gets a list of all available option names

Returns

list of option names

Definition at line 1427 of file swmgr.cpp.

{
    return options;
}

const char * SWMgr::getGlobalOptionTip ( const char *  option )

virtual

Gets a brief description for the given option

Parameters

option

the name of the option, who's tip is desired

Returns

description text

See Also

setGlobalOption, getGlobalOption, getGlobalOptions

Definition at line 1415 of file swmgr.cpp.

{
    for (OptionFilterMap::iterator it = optionFilters.begin(); it != optionFilters.end(); it++) {
        if ((*it).second->getOptionName()) {
            if (!stricmp(option, (*it).second->getOptionName()))
                return (*it).second->getOptionTip();
        }
    }
    return 0;
}

StringList SWMgr::getGlobalOptionValues ( const char *  option )

virtual

Gets a list of legal values to which a specific option may be set

Parameters

option

the name of the option, who's legal values are desired

Returns

a list of legal values for the given option

Definition at line 1433 of file swmgr.cpp.

{
    StringList options;
    for (OptionFilterMap::iterator it = optionFilters.begin(); it != optionFilters.end(); it++) {
        if ((*it).second->getOptionName()) {
            if (!stricmp(option, (*it).second->getOptionName())) {
                options = (*it).second->getOptionValues();
                break;  // just find the first one.  All option filters with the same option name should expect the same values
            }
        }
    }
    return options;
}

SWBuf SWMgr::getHomeDir ( )

static

Deprecated:

Used FileMgr::getSystemFileMgr()->getHomeDir() instead.

Definition at line 1577 of file swmgr.cpp.

{ return FileMgr::getSystemFileMgr()->getHomeDir(); }

SWModule* SWMgr::getModule ( const char *  modName )

inline

Gets a specific module by name. e.g. SWModule *kjv = myManager.getModule("KJV");

Parameters

modName

the name of the module to retrieve

Returns

the module, if found, otherwise 0

Definition at line 360 of file swmgr.h.

                                             {
        ModMap::iterator it = getModules().find(modName);
        if (it == getModules().end()) it = getUtilModules().find(modName);
        return ((it != getUtilModules().end()) ? it->second : 0);
    }

const SWModule* SWMgr::getModule ( const char *  modName ) const

inline

Definition at line 365 of file swmgr.h.

                                                         {
        ModMap::const_iterator it = getModules().find(modName);
        if (it == getModules().end()) it = getUtilModules().find(modName);
        return ((it != getUtilModules().end()) ? it->second : 0);
    }

ModMap & SWMgr::getModules

(

)

The map of available modules. This map exposes the installed modules.

Here's an example how to iterate over all the installed modules and check the module name and type of each module and do something special if the module type is a Bible.

for (ModMap::iterator it = getModules().begin(); it != getModules().end(); ++it) {

    SWBuf modName = it->first;
    SWModule *mod = it->second;

    SWBuf modType = mod->getType();

    if (modType == SWMgr::MODTYPE_BIBLES) {
        // do something with mod
    }
}

Definition at line 1574 of file swmgr.cpp.

{ return Modules; }

const ModMap& SWMgr::getModules ( ) const

inline

Definition at line 348 of file swmgr.h.

{ return const_cast<SWMgr *>(this)->getModules(); }

ModMap & SWMgr::getUtilModules

(

)

Utility modules are not meant for user to see as general addins, but instead are modules which provide utility tools for frontends which may wish to use them.

Definition at line 1575 of file swmgr.cpp.

{ return utilModules; }

const ModMap& SWMgr::getUtilModules ( ) const

inline

Definition at line 354 of file swmgr.h.

{ return const_cast<SWMgr *>(this)->getUtilModules(); }

void SWMgr::init ( )

protectedvirtual

call by every constructor to initialize SWMgr object override to include any addition common initialization

Definition at line 163 of file swmgr.cpp.

                 {
    SWOptionFilter *tmpFilter = 0;
    configPath  = 0;
    prefixPath  = 0;
    configType  = 0;
    myconfig    = 0;
    mysysconfig = 0;
    homeConfig  = 0;
    augmentHome = true;

    cipherFilters.clear();
    optionFilters.clear();
    cleanupFilters.clear();
    extraFilters.clear();
    tmpFilter = new ThMLVariants();
    optionFilters.insert(OptionFilterMap::value_type("ThMLVariants", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new GBFStrongs();
    optionFilters.insert(OptionFilterMap::value_type("GBFStrongs", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new GBFFootnotes();
    optionFilters.insert(OptionFilterMap::value_type("GBFFootnotes", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new GBFRedLetterWords();
    optionFilters.insert(OptionFilterMap::value_type("GBFRedLetterWords", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new GBFMorph();
    optionFilters.insert(OptionFilterMap::value_type("GBFMorph", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new GBFHeadings();
    optionFilters.insert(OptionFilterMap::value_type("GBFHeadings", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISHeadings();
    optionFilters.insert(OptionFilterMap::value_type("OSISHeadings", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISStrongs();
    optionFilters.insert(OptionFilterMap::value_type("OSISStrongs", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISMorph();
    optionFilters.insert(OptionFilterMap::value_type("OSISMorph", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISLemma();
    optionFilters.insert(OptionFilterMap::value_type("OSISLemma", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISFootnotes();
    optionFilters.insert(OptionFilterMap::value_type("OSISFootnotes", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISScripref();
    optionFilters.insert(OptionFilterMap::value_type("OSISScripref", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISRedLetterWords();
    optionFilters.insert(OptionFilterMap::value_type("OSISRedLetterWords", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISMorphSegmentation();
    optionFilters.insert(OptionFilterMap::value_type("OSISMorphSegmentation", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISGlosses();
    optionFilters.insert(OptionFilterMap::value_type("OSISGlosses", tmpFilter));
    optionFilters.insert(OptionFilterMap::value_type("OSISRuby", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISXlit();
    optionFilters.insert(OptionFilterMap::value_type("OSISXlit", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISEnum();
    optionFilters.insert(OptionFilterMap::value_type("OSISEnum", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new OSISVariants();
    optionFilters.insert(OptionFilterMap::value_type("OSISVariants", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new ThMLStrongs();
    optionFilters.insert(OptionFilterMap::value_type("ThMLStrongs", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new ThMLFootnotes();
    optionFilters.insert(OptionFilterMap::value_type("ThMLFootnotes", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new ThMLMorph();
    optionFilters.insert(OptionFilterMap::value_type("ThMLMorph", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new ThMLHeadings();
    optionFilters.insert(OptionFilterMap::value_type("ThMLHeadings", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new ThMLLemma();
    optionFilters.insert(OptionFilterMap::value_type("ThMLLemma", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new ThMLScripref();
    optionFilters.insert(OptionFilterMap::value_type("ThMLScripref", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new UTF8GreekAccents();
    optionFilters.insert(OptionFilterMap::value_type("UTF8GreekAccents", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new UTF8HebrewPoints();
    optionFilters.insert(OptionFilterMap::value_type("UTF8HebrewPoints", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new UTF8ArabicPoints();
    optionFilters.insert(OptionFilterMap::value_type("UTF8ArabicPoints", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new UTF8Cantillation();
    optionFilters.insert(OptionFilterMap::value_type("UTF8Cantillation", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new GreekLexAttribs();
    optionFilters.insert(OptionFilterMap::value_type("GreekLexAttribs", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

    tmpFilter = new PapyriPlain();
    optionFilters.insert(OptionFilterMap::value_type("PapyriPlain", tmpFilter));
    cleanupFilters.push_back(tmpFilter);

// UTF8Transliterator needs to be handled differently because it should always available as an option, for all modules
#ifdef _ICU_
    transliterator = new UTF8Transliterator();
    optionFilters.insert(OptionFilterMap::value_type("UTF8Transliterator", transliterator));
    options.push_back(transliterator->getOptionName());
    cleanupFilters.push_back(transliterator);
#endif

    gbfplain = new GBFPlain();
    cleanupFilters.push_back(gbfplain);
    extraFilters.insert(FilterMap::value_type("GBFPlain", gbfplain));

    thmlplain = new ThMLPlain();
    cleanupFilters.push_back(thmlplain);
    extraFilters.insert(FilterMap::value_type("ThMLPlain", thmlplain));

    osisplain = new OSISPlain();
    cleanupFilters.push_back(osisplain);
    extraFilters.insert(FilterMap::value_type("OSISPlain", osisplain));

    teiplain = new TEIPlain();
    cleanupFilters.push_back(teiplain);
    extraFilters.insert(FilterMap::value_type("TEIPlain", teiplain));

    // filters which aren't really used anywhere but which we want available for a "FilterName" -> filter mapping (e.g., filterText)
    SWFilter *f = new RTFHTML();
    extraFilters.insert(FilterMap::value_type("RTFHTML", f));
    cleanupFilters.push_back(f);
    
}

void SWMgr::InstallScan ( const char *  dir )

virtual

Looks for any newly installed module.conf file in the path provided, displays the copyright information to the user, and then copies the module.conf to the main module set's mods.d directory

Parameters

dir	where to search for new modules

Definition at line 1331 of file swmgr.cpp.

{
    FileDesc *conffd = 0;
    SWBuf newModFile;
    SWBuf targetName;
    SWBuf basePath = dirname;
    if (!basePath.endsWith("/") && !basePath.endsWith("\\")) basePath += "/";

    std::vector<DirEntry> dirList = FileMgr::getDirList(dirname);
    for (unsigned int i = 0; i < dirList.size(); ++i) {
        newModFile = basePath + dirList[i].name;

        // mods.d
        if (configType) {
            if (conffd)
                FileMgr::getSystemFileMgr()->close(conffd);
            targetName = configPath;
            if ((configPath[strlen(configPath)-1] != '\\') && (configPath[strlen(configPath)-1] != '/'))
                targetName += "/";
            targetName += dirList[i].name;
            conffd = FileMgr::getSystemFileMgr()->open(targetName.c_str(), FileMgr::WRONLY|FileMgr::CREAT, FileMgr::IREAD|FileMgr::IWRITE);
        }

        // mods.conf
        else {
            if (!conffd) {
                conffd = FileMgr::getSystemFileMgr()->open(config->getFileName().c_str(), FileMgr::WRONLY|FileMgr::APPEND);
                if (conffd && conffd->getFd() >= 0)
                    conffd->seek(0L, SEEK_END);
                else {
                    FileMgr::getSystemFileMgr()->close(conffd);
                    conffd = 0;
                }
            }
        }
        addModToConfig(conffd, newModFile.c_str());
        FileMgr::removeFile(newModFile.c_str());
    }
    if (conffd)
        FileMgr::getSystemFileMgr()->close(conffd);
}

virtual SWDEPRECATED signed char SWMgr::Load ( )

inlinevirtual

Deprecated:

Use load

Definition at line 426 of file swmgr.h.

{ return load(); }

signed char SWMgr::load ( )

virtual

Loads installed library of SWORD modules. Should only be manually called if SWMgr was constructed without autoload; otherwise, this will be called on SWMgr construction Reimplement this function to supply special functionality when modules are initially loaded. This includes discovery of config path with SWMgr::fileconfig, loading of composite SWMgr::config, and construction of all modules from config using SWMgr::createAllModules

Definition at line 837 of file swmgr.cpp.

                        {
    signed char ret = 0;

    if (!config) {  // If we weren't passed a config object at construction, find a config file
        if (!configPath) {  // If we weren't passed a config path at construction...
            SWLOGTI("LOOKING UP MODULE CONFIGURATION...");
            SWConfig *externalSysConf = sysConfig;  // if we have a sysConf before findConfig, then we were provided one from an external source.
            findConfig(&configType, &prefixPath, &configPath, &augPaths, &sysConfig);
            if (!externalSysConf) mysysconfig = sysConfig;  // remind us to delete our own sysConfig in d-tor
            SWLOGTI("LOOKING UP MODULE CONFIGURATION COMPLETE.");
        }
        if (configPath) {
            SWLOGTI("LOADING MODULE CONFIGURATIONS...");
            if (configType)
                loadConfigDir(configPath);
            else    config = myconfig = new SWConfig(configPath);
            SWLOGTI("LOADING MODULE CONFIGURATIONS COMPLETE.");
        }
    }

    if (config) {

        SWLOGTI("LOADING MODULE LIBRARY...");

        SectionMap::iterator Sectloop, Sectend;
        ConfigEntMap::iterator Entryloop, Entryend;

        deleteAllModules();

        for (Sectloop = config->getSections().lower_bound("Globals"), Sectend = config->getSections().upper_bound("Globals"); Sectloop != Sectend; Sectloop++) {        // scan thru all 'Globals' sections
            for (Entryloop = (*Sectloop).second.lower_bound("AutoInstall"), Entryend = (*Sectloop).second.upper_bound("AutoInstall"); Entryloop != Entryend; Entryloop++)   // scan thru all AutoInstall entries
                InstallScan((*Entryloop).second.c_str());       // Scan AutoInstall entry directory for new modules and install
        }       
        if (configType) {   // force reload on config object because we may have installed new modules
            delete myconfig;
            config = myconfig = 0;
            loadConfigDir(configPath);
        }
        else    config->load();

        createAllModules(mgrModeMultiMod);

        for (std::list<SWBuf>::iterator pathIt = augPaths.begin(); pathIt != augPaths.end(); pathIt++) {
            augmentModules(pathIt->c_str(), mgrModeMultiMod);
        }
        if (augmentHome) {
            // augment config with ~/.sword/mods.d if it exists ---------------------
            SWBuf homeDir = FileMgr::getSystemFileMgr()->getHomeDir();
            if (homeDir.length() && configType != 2) { // 2 = user only
                SWBuf path = homeDir;
                path += ".sword/";
                augmentModules(path.c_str(), mgrModeMultiMod);
                path = homeDir;
                path += "sword/";
                augmentModules(path.c_str(), mgrModeMultiMod);
            }
        }
// -------------------------------------------------------------------------
        if (!getModules().size()) // config exists, but no modules
            ret = 1;

        SWLOGTI("LOADING MODULE LIBRARY COMPLETE.");
    }
    else {
        SWLog::getSystemLog()->logError("SWMgr: Can't find 'mods.conf' or 'mods.d'.  Try setting:\n\tSWORD_PATH=<directory containing mods.conf>\n\tOr see the README file for a full description of setup options (%s)", (configPath) ? configPath : "<configPath is null>");
        ret = -1;
    }

    return ret;
}

void SWMgr::loadConfigDir ( const char *  ipath )

protectedvirtual

Definition at line 747 of file swmgr.cpp.

{
    SWBuf basePath = ipath;
    if (!basePath.endsWith("/") && !basePath.endsWith("\\")) basePath += "/";

    SWBuf newModFile;

    std::vector<DirEntry> dirList = FileMgr::getDirList(ipath);
    for (unsigned int i = 0; i < dirList.size(); ++i) {
        //check whether it ends with .conf, if it doesn't skip it!
        if (!dirList[i].name.endsWith(".conf")) {
            continue;
        }

        newModFile = basePath + dirList[i].name;
        if (config) {
            SWConfig tmpConfig(newModFile);
            config->augment(tmpConfig);
        }
        else    config = myconfig = new SWConfig(newModFile);
    }

    if (!config) {  // if no .conf file exist yet, create a default
        newModFile = basePath + "globals.conf";
        config = myconfig = new SWConfig(newModFile);
    }
}

signed char SWMgr::setCipherKey ( const char *  modName, const char *  key  )

virtual

Sets the cipher key for the given module. This function updates the key at runtime, but it does not write to the config file. This method is NOT the recommended means for applying a CipherKey to a module.

Typically CipherKey entries and other per module user configuration settings are all saved in a separate localConfig.conf that is updated by a UI or other client of the library. e.g.,

[KJV] Font=Arial LocalOptionFilter=SomeSpecialFilterMyUIAppliesToTheKJV

[ISV] CipherKey=xyzzy

[StrongsGreek] SomeUISetting=false

Then these extra config settings in this separate file are applied just before module creation by overriding SWMgr::createAllModules and augmenting SWMgr::config with code like this:

void createAllModules(bool multiMod) {

    // after SWMgr::config is loaded
 // see if we have our own local settings
    SWBuf myExtraConf = "~/.myapp/localConf.conf";
    bool exists = FileMgr::existsFile(extraConf);
    if (exists) {
        SWConfig addConfig(extraConf);
        this->config->augment(addConfig);
    }

    // now that we've augmented SWMgr::config with our own custom
    // settings, proceed on with creating modules

    SWMgr::createAllModules(multiMod);

}

The above convention is preferred to using this setCipherKey method

Parameters

modName	For this module we change the unlockKey
key	This is the new unlock key we use for the module.

Definition at line 1550 of file swmgr.cpp.

                                                                    {
    FilterMap::iterator it;

    // check for filter that already exists
    it = cipherFilters.find(modName);
    if (it != cipherFilters.end()) {
        ((CipherFilter *)(*it).second)->getCipher()->setCipherKey(key);
        return 0;
    }
    // check if module exists
    else {
        SWModule *mod = getModule(modName);
        if (mod) {
            SWFilter *cipherFilter = new CipherFilter(key);
            cipherFilters.insert(FilterMap::value_type(modName, cipherFilter));
            cleanupFilters.push_back(cipherFilter);
            mod->addRawFilter(cipherFilter);
            return 0;
        }
    }
    return -1;
}

void SWMgr::setGlobalOption ( const char *  option, const char *  value  )

virtual

Change the values of global options (e.g. Footnotes, Strong's Number, etc.)

Parameters

option	The name of the option, for which you want to change the value. Well known and often used values are "Footnotes" or "Strong's Numbers"
value	new value. Common values are "On" and "Off"

Definition at line 1392 of file swmgr.cpp.

{
    for (OptionFilterMap::iterator it = optionFilters.begin(); it != optionFilters.end(); it++) {
        if ((*it).second->getOptionName()) {
            if (!stricmp(option, (*it).second->getOptionName()))
                (*it).second->setOptionValue(value);
        }
    }
}

Member Data Documentation

bool SWMgr::augmentHome

private

Definition at line 97 of file swmgr.h.

StringList SWMgr::augPaths

protected

Definition at line 266 of file swmgr.h.

FilterMap SWMgr::cipherFilters

protected

Definition at line 115 of file swmgr.h.

FilterList SWMgr::cleanupFilters

protected

Definition at line 121 of file swmgr.h.

SWConfig* SWMgr::config

The configuration of a loaded library of SWORD modules e.g., from /usr/share/sword/mods.d/ augmented with ~/.sword/mods.d/

This represents all discovered modules and their configuration compiled into a single SWConfig object with each [section] representing each module. e.g. [KJV]

Definition at line 302 of file swmgr.h.

char* SWMgr::configPath

path to main module set configuration

Definition at line 316 of file swmgr.h.

char SWMgr::configType

protected

Definition at line 113 of file swmgr.h.

FilterMap SWMgr::extraFilters

protected

Definition at line 122 of file swmgr.h.

SWFilterMgr* SWMgr::filterMgr

protected

Definition at line 101 of file swmgr.h.

SWFilter* SWMgr::gbfplain

protected

Definition at line 116 of file swmgr.h.

const char * SWMgr::globalConfPath = "/etc/sword.conf:/usr/local/etc/sword.conf"

static

Definition at line 281 of file swmgr.h.

SWConfig* SWMgr::homeConfig

protected

Definition at line 104 of file swmgr.h.

SWORD_NAMESPACE_START bool SWMgr::isICU = false

static

Definition at line 280 of file swmgr.h.

bool SWMgr::mgrModeMultiMod

private

Definition at line 96 of file swmgr.h.

const char * SWMgr::MODTYPE_BIBLES = "Biblical Texts"

static

Definition at line 273 of file swmgr.h.

const char * SWMgr::MODTYPE_COMMENTARIES = "Commentaries"

static

Definition at line 274 of file swmgr.h.

const char * SWMgr::MODTYPE_DAILYDEVOS = "Daily Devotional"

static

Definition at line 277 of file swmgr.h.

const char * SWMgr::MODTYPE_GENBOOKS = "Generic Books"

static

Definition at line 276 of file swmgr.h.

const char * SWMgr::MODTYPE_LEXDICTS = "Lexicons / Dictionaries"

static

Definition at line 275 of file swmgr.h.

ModMap SWMgr::Modules

Deprecated. Use getModules instead.

Definition at line 322 of file swmgr.h.

SWConfig* SWMgr::myconfig

protected

Definition at line 102 of file swmgr.h.

SWConfig* SWMgr::mysysconfig

protected

Definition at line 103 of file swmgr.h.

OptionFilterMap SWMgr::optionFilters

protected

Definition at line 114 of file swmgr.h.

StringList SWMgr::options

protected

Definition at line 123 of file swmgr.h.

SWFilter* SWMgr::osisplain

protected

Definition at line 118 of file swmgr.h.

char* SWMgr::prefixPath

The path to main module set and locales

Definition at line 312 of file swmgr.h.

SWConfig* SWMgr::sysConfig

The configuration file for SWORD e.g., /etc/sword.conf

Definition at line 308 of file swmgr.h.

SWFilter* SWMgr::teiplain

protected

Definition at line 119 of file swmgr.h.

SWFilter* SWMgr::thmlplain

protected

Definition at line 117 of file swmgr.h.

SWOptionFilter* SWMgr::transliterator

protected

Definition at line 120 of file swmgr.h.

ModMap SWMgr::utilModules

private

Definition at line 95 of file swmgr.h.

---

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

• include/swmgr.h
• src/mgr/swmgr.cpp