The Sword Project: swmgr.h Source File

swmgr.h

/******************************************************************************
 *  swmgr.h   - definition of class SWMgr used to interact with an install
 *                              base of sword modules.
 *
 * $Id: swmgr.h 2077 2007-09-14 01:34:37Z scribe $
 *
 * Copyright 1998 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:
        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;
        void CreateMods(bool multiMod = false);
        SWModule *CreateMod(const char *name, const char *driver, ConfigEntMap &section);
        void DeleteMods();
        char configType;                // 0 = file; 1 = directory
        OptionFilterMap optionFilters;
        FilterMap cipherFilters;
        SWFilter *gbfplain;
        SWFilter *thmlplain;
        SWFilter *osisplain;
        SWFilter *teiplain;
        SWOptionFilter *transliterator;
        FilterList cleanupFilters;
        StringList options;
        virtual void init(); // use to initialize before loading modules
        virtual char AddModToConfig(FileDesc *conffd, const char *fname);
        virtual void loadConfigDir(const char *ipath);
        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);
        StringList augPaths;

        virtual void AddEncodingFilters(SWModule *module, ConfigEntMap &section);

        virtual void AddRenderFilters(SWModule *module, ConfigEntMap &section);

        virtual void AddStripFilters(SWModule *module, ConfigEntMap &section);

        // ones manually specified in .conf file
        virtual void AddStripFilters(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end);

        virtual void AddRawFilters(SWModule *module, ConfigEntMap &section);


public:
        static bool debug;

        static bool isICU;
        static const char *globalConfPath;

        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;

        SWModule *getModule(const char *modName) { ModMap::iterator it = Modules.find(modName); return ((it != Modules.end()) ? it->second : 0); }
        const SWModule *getModule(const char *modName) const { ModMap::const_iterator it = Modules.find(modName); return ((it != Modules.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);

        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

The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA