SWMgr Class Reference

#include <swmgr.h>

Collaboration diagram for SWMgr:

[legend]

List of all members.

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)
const SWModule *	getModule (const char *modName) const
SWModule *	getModule (const char *modName)
virtual void	InstallScan (const char *dir)
virtual signed char	Load ()
virtual signed char	setCipherKey (const char *modName, const char *key)
virtual void	setGlobalOption (const char *option, const char *value)
	SWMgr (const char *iConfigPath, bool autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false, bool augmentHome=true)
	SWMgr (SWFilterMgr *filterMgr, bool multiMod=false)
	SWMgr (SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false)
virtual	~SWMgr ()
Static Public Member Functions
static void	findConfig (char *configType, char **prefixPath, char **configPath, StringList *augPaths=0, SWConfig **providedSysConf=0)
static 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 void	AddEncodingFilters (SWModule *module, ConfigEntMap &section)
virtual void	AddGlobalOptions (SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)
virtual void	AddLocalOptions (SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)
virtual char	AddModToConfig (FileDesc *conffd, const char *fname)
virtual void	AddRawFilters (SWModule *module, ConfigEntMap &section)
virtual void	AddRenderFilters (SWModule *module, ConfigEntMap &section)
virtual void	AddStripFilters (SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)
virtual void	AddStripFilters (SWModule *module, ConfigEntMap &section)
void	CreateMods (bool multiMod=false)
virtual SWModule *	createModule (const char *name, const char *driver, ConfigEntMap &section)
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

---

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 2764 2013-01-19 16:19:47Z scribe

Definition at line 89 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
	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 318 of file swmgr.cpp.

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

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

Definition at line 313 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 323 of file swmgr.cpp.

                                                                                                            {

    init();

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

    path = iConfigPath;
    int len = path.length();
    if ((len < 1) || ((iConfigPath[len-1] != '\\') && (iConfigPath[len-1] != '/')))
        path += "/";
    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")) {
            stdstr(&prefixPath, path.c_str());
            path += "mods.d";
            stdstr(&configPath, path.c_str());
            configType = 1;
        }
    }

    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 362 of file swmgr.cpp.

              {

    DeleteMods();

    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

void SWMgr::AddEncodingFilters	(	SWModule *	module,
		ConfigEntMap &	section
	)			[protected, virtual]

Called to add appropriate Encoding Filters to a module. Override to do special actions, if desired. See the module.conf Encoding= entry.

Parameters:

	module	module to which to add Encoding Filters
	section	configuration information from module.conf

Definition at line 1130 of file swmgr.cpp.

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

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

Definition at line 1038 of file swmgr.cpp.

                                                                                                                          {
    for (;start != end; start++) {
        OptionFilterMap::iterator it;
        it = optionFilters.find((*start).second);
        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
}

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

Definition at line 1085 of file swmgr.cpp.

{
    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);
}

char SWMgr::AddModToConfig	(	FileDesc *	conffd,
		const char *	fname
	)			[protected, virtual]

Definition at line 1323 of file swmgr.cpp.

{
    FileDesc *modfd;
    char ch;

    SWLog::getSystemLog()->logTimedInformation("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;
}

void SWMgr::AddRawFilters	(	SWModule *	module,
		ConfigEntMap &	section
	)			[protected, virtual]

Called to add appropriate Raw Filters to a module. Override to do special actions, if desired. See the module.conf CipherKey= entry.

Parameters:

	module	module to which to add Raw Filters
	section	configuration information from module.conf

Definition at line 1113 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);
}

void SWMgr::AddRenderFilters	(	SWModule *	module,
		ConfigEntMap &	section
	)			[protected, virtual]

Called to add appropriate Render Filters to a module. Override to do special actions, if desired. See the module.conf SourceType= entry.

Parameters:

	module	module to which to add Render Filters
	section	configuration information from module.conf

Definition at line 1136 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);

}

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

Definition at line 1101 of file swmgr.cpp.

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

void SWMgr::AddStripFilters	(	SWModule *	module,
		ConfigEntMap &	section
	)			[protected, virtual]

Called to add appropriate Strip Filters to a module. Override to do special actions, if desired. See the module.conf SourceType= entry.

Parameters:

	module	module to which to add Strip Filters
	section	configuration information from module.conf

Definition at line 1162 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);

}

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 711 of file swmgr.cpp.

                                                           {
    SWBuf path = ipath;
    if ((ipath[strlen(ipath)-1] != '\\') && (ipath[strlen(ipath)-1] != '/'))
        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->Sections.begin(); it != config->Sections.end();) {
                if (saveConfig->Sections.find( (*it).first ) != saveConfig->Sections.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->Sections.find(name) != config->Sections.end());
                    
                    config->Sections.insert(SectionMap::value_type(name, entMap) );
                    SectionMap::iterator toErase = it++;
                    config->Sections.erase(toErase);
                }
                else ++it;
            }
        }
        
        CreateMods(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 288 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::CreateMods

(

bool

multiMod = false

)

[protected]

Definition at line 1195 of file swmgr.cpp.

                                    {
    SectionMap::iterator it;
    ConfigEntMap::iterator start;
    ConfigEntMap::iterator end;
    ConfigEntMap::iterator entry;
    SWModule *newmod;
    SWBuf driver, misc1;
    for (it = config->Sections.begin(); it != config->Sections.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
                start = (*it).second.lower_bound("GlobalOptionFilter");
                end   = (*it).second.upper_bound("GlobalOptionFilter");
                AddGlobalOptions(newmod, section, start, end);

                // 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
                start = (*it).second.lower_bound("LocalOptionFilter");
                end   = (*it).second.upper_bound("LocalOptionFilter");
                AddLocalOptions(newmod, section, start, end);

                //STRIP FILTERS

                // add all basic ones for for the modtype
                AddStripFilters(newmod, section);

                // Any special processing for this module when searching:
                // e.g. for papyri, removed all [](). notation
                start = (*it).second.lower_bound("LocalStripFilter");
                end   = (*it).second.upper_bound("LocalStripFilter");
                AddStripFilters(newmod, section, start, end);

                AddRawFilters(newmod, section);
                AddRenderFilters(newmod, section);
                AddEncodingFilters(newmod, section);
                
                SWModule *oldmod = Modules[newmod->getName()];
                if (oldmod) {
                    delete oldmod;
                }
                
                Modules[newmod->getName()] = newmod;
            }
        }
    }
}

SWModule * SWMgr::createModule	(	const char *	name,
		const char *	driver,
		ConfigEntMap &	section
	)			[protected, virtual]

Definition at line 838 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 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"))) {
        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
        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    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
        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 = 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::DeleteMods

(

)

[protected]

Definition at line 1250 of file swmgr.cpp.

                       {

    ModMap::iterator it;

    for (it = Modules.begin(); it != Modules.end(); it++)
        delete (*it).second;

    Modules.clear();
}

void SWMgr::deleteModule

(

const char *

modName

)

Definition at line 1261 of file swmgr.cpp.

                                            {
    ModMap::iterator it = Modules.find(modName);
    if (it != Modules.end()) {
        delete (*it).second;
        Modules.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
	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 1061 of file swmgr.cpp.

 {
    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]

Definition at line 389 of file swmgr.cpp.

                                                                                                                                   {
    SWBuf path;
    SWBuf sysConfPath;
    ConfigEntMap::iterator entry;
    ConfigEntMap::iterator lastEntry;

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

    *configType = 0;

    SWBuf homeDir = getHomeDir();

    // check for a sysConf passed in to us
    SWLog::getSystemLog()->logDebug("Checking for provided SWConfig(\"sword.conf\")...");
    if (providedSysConf && *providedSysConf) {
        sysConf = *providedSysConf;
        SWLog::getSystemLog()->logDebug("found.");
    }

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

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

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

            // check environment variable SWORD_PATH
            SWLog::getSystemLog()->logDebug("Checking $SWORD_PATH...");

            SWBuf envsworddir = getenv("SWORD_PATH");
            if (envsworddir.length()) {
                
                SWLog::getSystemLog()->logDebug("found (%s).", envsworddir.c_str());
                path = envsworddir;
                if ((envsworddir[envsworddir.length()-1] != '\\') && (envsworddir[envsworddir.length()-1] != '/'))
                    path += "/";

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

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


            // check for systemwide globalConfPath

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

            if (homeDir.length()) {
                SWBuf tryPath = homeDir;
                tryPath += ".sword/sword.conf";
                if (FileMgr::existsFile(tryPath)) {
                    SWLog::getSystemLog()->logDebug("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)) {
                        SWLog::getSystemLog()->logDebug("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 ((entry = sysConf->Sections["Install"].find("DataPath")) != sysConf->Sections["Install"].end()) {
            sysConfDataPath = (*entry).second;
        }
        if (sysConfDataPath.size()) {
            if ((!sysConfDataPath.endsWith("\\")) && (!sysConfDataPath.endsWith("/")))
                sysConfDataPath += "/";

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

            SWLog::getSystemLog()->logDebug("Checking for mods.d in DataPath...");

            if (FileMgr::existsDir(path.c_str(), "mods.d")) {
                SWLog::getSystemLog()->logDebug("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 (augPaths) {
            augPaths->clear();
            entry     = sysConf->Sections["Install"].lower_bound("AugmentPath");
            lastEntry = sysConf->Sections["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/

    SWLog::getSystemLog()->logDebug("Checking $ALLUSERSPROFILE/Application Data/sword/...");

    SWBuf envallusersdir  = getenv("ALLUSERSPROFILE");
    if (envallusersdir.length()) {
        SWLog::getSystemLog()->logDebug("found (%s).", envallusersdir.c_str());
        path = envallusersdir;
        if ((!path.endsWith("\\")) && (!path.endsWith("/")))
            path += "/";

        path += "Application Data/sword/";
        SWLog::getSystemLog()->logDebug("Checking %s for mods.d...", path.c_str());
        if (FileMgr::existsDir(path.c_str(), "mods.d")) {
            SWLog::getSystemLog()->logDebug("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/

    SWLog::getSystemLog()->logDebug("Checking $HOME/Library/Application Support/Sword/...");

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

        SWLog::getSystemLog()->logDebug("Checking %s for mods.d...", path.c_str());
        if (FileMgr::existsDir(path.c_str(), "mods.d")) {
            SWLog::getSystemLog()->logDebug("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/

    SWLog::getSystemLog()->logDebug("Checking home directory for ~/.sword...");

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

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

        path = homeDir;
        path += "sword/";
        SWLog::getSystemLog()->logDebug("  Checking for %smods.d...", path.c_str());
        if (FileMgr::existsDir(path.c_str(), "mods.d")) {
            SWLog::getSystemLog()->logDebug("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 1352 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 1376 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 1364 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 1382 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]

Definition at line 270 of file swmgr.cpp.

                        {

    // figure out 'home' directory for app data
    SWBuf homeDir = getenv("HOME");
    if (!homeDir.length()) {
        // silly windows
        homeDir = getenv("APPDATA");
    }
    if (homeDir.length()) {
        if ((homeDir[homeDir.length()-1] != '\\') && (homeDir[homeDir.length()-1] != '/')) {
            homeDir += "/";
        }
    }

    return homeDir;
}

const SWModule* SWMgr::getModule

(

const char *

modName

)

const [inline]

Definition at line 216 of file swmgr.h.

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

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 215 of file swmgr.h.

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

void SWMgr::init

(

)

[protected, virtual]

Definition at line 120 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 OSISRuby();
    optionFilters.insert(OptionFilterMap::value_type("OSISRuby", 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);

    thmlplain = new ThMLPlain();
    cleanupFilters.push_back(thmlplain);

    osisplain = new OSISPlain();
    cleanupFilters.push_back(osisplain);

    teiplain = new TEIPlain();
    cleanupFilters.push_back(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 1270 of file swmgr.cpp.

{
   DIR *dir;
   struct dirent *ent;
   FileDesc *conffd = 0;
   SWBuf newmodfile;
   SWBuf targetName;
 
    if (FileMgr::existsDir(dirname)) {
        if ((dir = opendir(dirname))) {
            rewinddir(dir);
            while ((ent = readdir(dir))) {
                if ((strcmp(ent->d_name, ".")) && (strcmp(ent->d_name, ".."))) {
                    newmodfile = dirname;
                    if ((dirname[strlen(dirname)-1] != '\\') && (dirname[strlen(dirname)-1] != '/'))
                        newmodfile += "/";
                    newmodfile += ent->d_name;

                    // mods.d
                    if (configType) {
                        if (conffd)
                            FileMgr::getSystemFileMgr()->close(conffd);
                        targetName = configPath;
                        if ((configPath[strlen(configPath)-1] != '\\') && (configPath[strlen(configPath)-1] != '/'))
                            targetName += "/";
                        targetName += ent->d_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->filename.c_str(), FileMgr::WRONLY|FileMgr::APPEND);
                            if (conffd > 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);
            closedir(dir);
        }
    }
}

signed char SWMgr::Load

(

)

[virtual]

Load all 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.

Definition at line 773 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...
            SWLog::getSystemLog()->logDebug("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
            SWLog::getSystemLog()->logDebug("LOOKING UP MODULE CONFIGURATION COMPLETE.");
        }
        if (configPath) {
            if (configType)
                loadConfigDir(configPath);
            else    config = myconfig = new SWConfig(configPath);
        }
    }

    if (config) {
        SectionMap::iterator Sectloop, Sectend;
        ConfigEntMap::iterator Entryloop, Entryend;

        DeleteMods();

        for (Sectloop = config->Sections.lower_bound("Globals"), Sectend = config->Sections.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();

        CreateMods(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 = 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 (!Modules.size()) // config exists, but no modules
            ret = 1;

    }
    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

)

[protected, virtual]

Definition at line 674 of file swmgr.cpp.

{
    DIR *dir;
    struct dirent *ent;
    SWBuf newmodfile;
 
    if ((dir = opendir(ipath))) {
        rewinddir(dir);
        while ((ent = readdir(dir))) {
            //check whether it ends with .conf, if it doesn't skip it!
            if (!ent->d_name || (strlen(ent->d_name) <= 5) || strncmp(".conf", (ent->d_name + strlen(ent->d_name) - 5), 5 )) {
                continue;
            }
            
            newmodfile = ipath;
            if ((ipath[strlen(ipath)-1] != '\\') && (ipath[strlen(ipath)-1] != '/'))
                newmodfile += "/";
            newmodfile += ent->d_name;
            if (config) {
                SWConfig tmpConfig(newmodfile.c_str());
                *config += tmpConfig;
            }
            else    config = myconfig = new SWConfig(newmodfile.c_str());
        }
        closedir(dir);
        
        if (!config) {  // if no .conf file exist yet, create a default
            newmodfile = ipath;
            if ((ipath[strlen(ipath)-1] != '\\') && (ipath[strlen(ipath)-1] != '/'))
                newmodfile += "/";
            newmodfile += "globals.conf";
            config = myconfig = new SWConfig(newmodfile.c_str());
        }
    }
}

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. To write the new unlock key to the config file use code like this:

 SectionMap::iterator section;
 ConfigEntMap::iterator entry;
 DIR *dir = opendir(configPath);
 struct dirent *ent;
 char* modFile;
 if (dir) {    // find and update .conf file
   rewinddir(dir);
   while ((ent = readdir(dir)))
   {
     if ((strcmp(ent->d_name, ".")) && (strcmp(ent->d_name, "..")))
     {
       modFile = m_backend->configPath;
       modFile += "/";
       modFile += ent->d_name;
       SWConfig *myConfig = new SWConfig( modFile );
       section = myConfig->Sections.find( m_module->Name() );
       if ( section != myConfig->Sections.end() )
       {
         entry = section->second.find("CipherKey");
         if (entry != section->second.end())
         {
           entry->second = unlockKey;//set cipher key
           myConfig->Save();//save config file
         }
       }
       delete myConfig;
     }
   }
 }
 closedir(dir);

Parameters:

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

Definition at line 1397 of file swmgr.cpp.

                                                                    {
    FilterMap::iterator it;
    ModMap::iterator it2;

    // 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 {
        it2 = Modules.find(modName);
        if (it2 != Modules.end()) {
            SWFilter *cipherFilter = new CipherFilter(key);
            cipherFilters.insert(FilterMap::value_type(modName, cipherFilter));
            cleanupFilters.push_back(cipherFilter);
            (*it2).second->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 1341 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 92 of file swmgr.h.

StringList SWMgr::augPaths [protected]

Definition at line 119 of file swmgr.h.

FilterMap SWMgr::cipherFilters [protected]

Definition at line 105 of file swmgr.h.

FilterList SWMgr::cleanupFilters [protected]

Definition at line 111 of file swmgr.h.

SWConfig* SWMgr::config

Definition at line 176 of file swmgr.h.

char* SWMgr::configPath

path to main module set configuration

Definition at line 185 of file swmgr.h.

char SWMgr::configType [protected]

Definition at line 103 of file swmgr.h.

FilterMap SWMgr::extraFilters [protected]

Definition at line 112 of file swmgr.h.

SWFilterMgr* SWMgr::filterMgr [protected]

Definition at line 96 of file swmgr.h.

SWFilter* SWMgr::gbfplain [protected]

Definition at line 106 of file swmgr.h.

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

Definition at line 168 of file swmgr.h.

SWConfig* SWMgr::homeConfig [protected]

Definition at line 99 of file swmgr.h.

SWORD_NAMESPACE_START bool SWMgr::isICU = false [static]

Definition at line 167 of file swmgr.h.

bool SWMgr::mgrModeMultiMod [private]

Definition at line 91 of file swmgr.h.

const char * SWMgr::MODTYPE_BIBLES = "Biblical Texts" [static]

Definition at line 160 of file swmgr.h.

const char * SWMgr::MODTYPE_COMMENTARIES = "Commentaries" [static]

Definition at line 161 of file swmgr.h.

const char * SWMgr::MODTYPE_DAILYDEVOS = "Daily Devotional" [static]

Definition at line 164 of file swmgr.h.

const char * SWMgr::MODTYPE_GENBOOKS = "Generic Books" [static]

Definition at line 163 of file swmgr.h.

const char * SWMgr::MODTYPE_LEXDICTS = "Lexicons / Dictionaries" [static]

Definition at line 162 of file swmgr.h.

ModMap SWMgr::Modules

The map of available modules. This map exposes the installed modules. Here's an example how to iterate over the map and check the module type of each module.

 ModMap::iterator it;
 SWModule *curMod = 0;

 for (it = Modules.begin(); it != Modules.end(); it++) {
      curMod = (*it).second;
      if (!strcmp(curMod->Type(), "Biblical Texts")) {
           // do something with curMod
      }
      else if (!strcmp(curMod->Type(), "Commentaries")) {
           // do something with curMod
      }
      else if (!strcmp(curMod->Type(), "Lexicons / Dictionaries")) {
           // do something with curMod
      }
 }

Definition at line 209 of file swmgr.h.

SWConfig* SWMgr::myconfig [protected]

Definition at line 97 of file swmgr.h.

SWConfig* SWMgr::mysysconfig [protected]

Definition at line 98 of file swmgr.h.

OptionFilterMap SWMgr::optionFilters [protected]

Definition at line 104 of file swmgr.h.

StringList SWMgr::options [protected]

Definition at line 113 of file swmgr.h.

SWFilter* SWMgr::osisplain [protected]

Definition at line 108 of file swmgr.h.

char* SWMgr::prefixPath

The path to main module set and locales

Definition at line 181 of file swmgr.h.

SWConfig* SWMgr::sysConfig

Definition at line 177 of file swmgr.h.

SWFilter* SWMgr::teiplain [protected]

Definition at line 109 of file swmgr.h.

SWFilter* SWMgr::thmlplain [protected]

Definition at line 107 of file swmgr.h.

SWOptionFilter* SWMgr::transliterator [protected]

Definition at line 110 of file swmgr.h.

---

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

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