swmgr.h

Go to the documentation of this file.

/******************************************************************************
 *
 * swmgr.h -    class SWMgr: used to interact with an install
 *      base of SWORD modules.
 *
 * $Id: swmgr.h 3820 2020-10-24 20:27:30Z scribe $
 *
 * Copyright 1997-2014 CrossWire Bible Society (http://www.crosswire.org)
 *  CrossWire Bible Society
 *  P. O. Box 2528
 *  Tempe, AZ  85280-2528
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation version 2.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 */

#ifndef SWMGR_H
#define SWMGR_H

#include <map>
#include <list>
#include <swbuf.h>
#include <swconfig.h>

#include <defs.h>

SWORD_NAMESPACE_START

class SWModule;
class SWFilter;
class SWOptionFilter;
class SWFilterMgr;
class SWBuf;
class SWKey;

typedef std::map < SWBuf, SWModule *, std::less < SWBuf > >ModMap;
typedef std::map < SWBuf, SWFilter * >FilterMap;
typedef std::map < SWBuf, SWOptionFilter * >OptionFilterMap;
typedef std::list < SWBuf >StringList;
typedef std::list < SWFilter* >FilterList;
typedef std::list < SWOptionFilter* >OptionFilterList;

class FileDesc;
class SWOptionFilter;

class SWDLLEXPORT SWMgr {
private:
    ModMap utilModules;
    bool mgrModeMultiMod;
    bool augmentHome;
    void commonInit(SWConfig *iconfig, SWConfig *isysconfig, bool autoload, SWFilterMgr *filterMgr, bool multiMod = false);

protected:
    SWFilterMgr *filterMgr;     //made protected because because BibleTime needs it
    SWConfig *myconfig;     //made protected because because BibleTime needs it
    SWConfig *mysysconfig;
    SWConfig *homeConfig;
    SWDEPRECATED void CreateMods(bool multiMod = false) { createAllModules(multiMod); };
    SWDEPRECATED void DeleteMods() { deleteAllModules(); }
    char configType;        // 0 = file; 1 = directory
    OptionFilterMap optionFilters;
    FilterMap cipherFilters;
    SWFilter *gbfplain;
    SWFilter *thmlplain;
    SWFilter *osisplain;
    SWFilter *teiplain;
    SWOptionFilter *transliterator;
    FilterList cleanupFilters;
    FilterMap extraFilters;
    StringList options;
    virtual void createAllModules(bool multiMod = false);
    virtual void deleteAllModules();

    virtual SWModule *createModule(const char *name, const char *driver, ConfigEntMap &section);

    virtual void init();


    SWDEPRECATED virtual void AddGlobalOptions(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) { addGlobalOptionFilters(module, section); }
    virtual void addGlobalOptionFilters(SWModule *module, ConfigEntMap &section);

    SWDEPRECATED virtual void AddLocalOptions(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) { addLocalOptionFilters(module, section); }
    virtual void addLocalOptionFilters(SWModule *module, ConfigEntMap &section);

    SWDEPRECATED virtual void AddEncodingFilters(SWModule *module, ConfigEntMap &section) { addEncodingFilters(module, section); }
    virtual void addEncodingFilters(SWModule *module, ConfigEntMap &section);

    SWDEPRECATED virtual void AddRenderFilters(SWModule *module, ConfigEntMap &section) { addRenderFilters(module, section); }
    virtual void addRenderFilters(SWModule *module, ConfigEntMap &section);

    SWDEPRECATED virtual void AddStripFilters(SWModule *module, ConfigEntMap &section) { addStripFilters(module, section); }
    virtual void addStripFilters(SWModule *module, ConfigEntMap &section);

    SWDEPRECATED virtual void AddStripFilters(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) { addLocalStripFilters(module, section); }
    virtual void addLocalStripFilters(SWModule *module, ConfigEntMap &section);

    SWDEPRECATED virtual void AddRawFilters(SWModule *module, ConfigEntMap &section) { addRawFilters(module, section); }
    virtual void addRawFilters(SWModule *module, ConfigEntMap &section);


    // still to be normalized below ...
    //
    StringList augPaths;
    virtual char addModToConfig(FileDesc *conffd, const char *fname);
    virtual void loadConfigDir(const char *ipath);

public:

    // constants which represent module types used in SWModule::getType
    static const char *MODTYPE_BIBLES;
    static const char *MODTYPE_COMMENTARIES;
    static const char *MODTYPE_LEXDICTS;
    static const char *MODTYPE_GENBOOKS;
    static const char *MODTYPE_DAILYDEVOS;


    static bool isICU;
    static const char *globalConfPath;

    SWDEPRECATED static SWBuf getHomeDir();

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

    SWConfig *config;

    SWConfig *sysConfig;

    char *prefixPath;

    char *configPath;


    ModMap Modules;

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

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

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


    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();

    virtual void augmentModules(const char *path, bool multiMod = false);

    void deleteModule(const char *);

    virtual void InstallScan(const char *dir);

    SWDEPRECATED virtual signed char Load() { return load(); }
    virtual signed char load();

    virtual void setGlobalOption(const char *option, const char *value);

    virtual const char *getGlobalOption(const char *option);

    virtual const char *getGlobalOptionTip(const char *option);

    virtual StringList getGlobalOptions();

    virtual StringList getGlobalOptionValues(const char *option);

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

    virtual signed char setCipherKey(const char *modName, const char *key);
};

SWORD_NAMESPACE_END
#endif