MarkupFilterMgr Class Reference

#include <markupfiltmgr.h>

Inheritance diagram for MarkupFilterMgr:

Collaboration diagram for MarkupFilterMgr:

Public 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 void	addRawFilters (SWModule *module, ConfigEntMap &section)
virtual void	addRenderFilters (SWModule *module, ConfigEntMap &section)
virtual void	addStripFilters (SWModule *module, ConfigEntMap &section)
char	Encoding (char enc)
char	getEncoding () const
char	getMarkup () const
virtual SWMgr *	getParentMgr ()
SWDEPRECATED char	Markup (char m=FMT_UNKNOWN)
	MarkupFilterMgr (char markup=FMT_THML, char encoding=ENC_UTF8)
void	setEncoding (char enc)
void	setMarkup (char m)
virtual void	setParentMgr (SWMgr *parentMgr)
	~MarkupFilterMgr ()

Protected Member Functions
void	createFilters (char markup)

Protected Attributes
char	encoding
SWFilter *	fromgbf
SWFilter *	fromosis
SWFilter *	fromplain
SWFilter *	fromtei
SWFilter *	fromthml
SWFilter *	latin1utf8
char	markup
SWFilter *	scsuutf8
SWFilter *	targetenc
SWFilter *	utf16utf8

Detailed Description

This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use.

Definition at line 34 of file markupfiltmgr.h.

Constructor & Destructor Documentation

SWORD_NAMESPACE_START MarkupFilterMgr::MarkupFilterMgr	(	char	markup = FMT_THML,
		char	encoding = ENC_UTF8
	)

Constructor of SWMarkupMgr.

Parameters

encoding	The desired encoding.
markup	The desired markup format.

Definition at line 73 of file markupfiltmgr.cpp.

        : EncodingFilterMgr(enc) {

    markup = mark;

    createFilters(markup);
}

MarkupFilterMgr::~MarkupFilterMgr

(

)

The destructor of SWMarkupMgr.

Definition at line 86 of file markupfiltmgr.cpp.

                                  {
    delete fromthml;
    delete fromgbf;
    delete fromplain;
    delete fromosis;
    delete fromtei;
}

Member Function Documentation

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

virtualinherited

Adds the encoding filters which are defined in "section" to the SWModule object "module".

Parameters

module	To this module the encoding filter(s) are added
section	We use this section to get a list of filters we should apply to the module

Reimplemented from SWFilterMgr.

Definition at line 106 of file encfiltmgr.cpp.

                                                                                  {
    if (targetenc)
        module->addEncodingFilter(targetenc);
}

void SWFilterMgr::addGlobalOptions ( SWModule *  module, ConfigEntMap &  section, ConfigEntMap::iterator  start, ConfigEntMap::iterator  end  )

virtualinherited

Definition at line 48 of file swfiltermgr.cpp.

                                                                                                                                  {
}

void SWFilterMgr::addLocalOptions ( SWModule *  module, ConfigEntMap &  section, ConfigEntMap::iterator  start, ConfigEntMap::iterator  end  )

virtualinherited

Definition at line 52 of file swfiltermgr.cpp.

                                                                                                                                 {
}

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

virtualinherited

Adds the raw filters which are defined in "section" to the SWModule object "module".

Parameters

module	To this module the raw filter(s) are added
section	We use this section to get a list of filters we should apply to the module

Reimplemented from SWFilterMgr.

Definition at line 89 of file encfiltmgr.cpp.

                                                                             {

    ConfigEntMap::iterator entry;

    SWBuf encoding = ((entry = section.find("Encoding")) != section.end()) ? (*entry).second : (SWBuf)"";
    if (!encoding.length() || !stricmp(encoding.c_str(), "Latin-1")) {
        module->addRawFilter(latin1utf8);
    }
    else if (!stricmp(encoding.c_str(), "SCSU")) {
        module->addRawFilter(scsuutf8);
    }
    else if (!stricmp(encoding.c_str(), "UTF-16")) {
        module->addRawFilter(utf16utf8);
    }
}

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

virtual

Adds the render filters which are defined in "section" to the SWModule object "module".

Parameters

module	To this module the render filter(s) are added
section	We use this section to get a list of filters we should apply to the module

Reimplemented from SWFilterMgr.

Definition at line 208 of file markupfiltmgr.cpp.

                                                                              {
    switch (module->getMarkup()) {
    case FMT_THML:
        if (fromthml)
            module->addRenderFilter(fromthml);
        break;
    case FMT_GBF:
        if (fromgbf)
            module->addRenderFilter(fromgbf);
        break;
    case FMT_PLAIN:
        if (fromplain)
            module->addRenderFilter(fromplain);
        break;
    case FMT_OSIS:
        if (fromosis)
            module->addRenderFilter(fromosis);
        break;
    case FMT_TEI:
        if (fromtei)
            module->addRenderFilter(fromtei);
        break;
    }
}

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

virtualinherited

Adds the strip filters which are defined in "section" to the SWModule object "module".

Parameters

module	To this module the strip filter(s) are added
section	We use this section to get a list of filters we should apply to the module

Definition at line 82 of file swfiltermgr.cpp.

                                                                           {
}

void MarkupFilterMgr::createFilters ( char  markup )

protected

Definition at line 234 of file markupfiltmgr.cpp.

                                               {

    switch (markup) {
    case FMT_PLAIN:
        fromplain = NULL;
        fromthml  = new ThMLPlain();
        fromgbf   = new GBFPlain();
        fromosis  = new OSISPlain();
        fromtei   = new TEIPlain();
        break;

    case FMT_THML:
        fromplain = NULL;
        fromthml  = NULL;
        fromgbf   = new GBFThML();
        fromosis  = NULL;
        fromtei   = NULL;
        break;

    case FMT_GBF:
        fromplain = NULL;
        fromthml  = new ThMLGBF();
        fromgbf   = NULL;
        fromosis  = NULL;
        fromtei   = NULL;
        break;

    case FMT_HTML:
        fromplain = NULL;
        fromthml  = new ThMLHTML();
        fromgbf   = new GBFHTML();
        fromosis  = NULL;
        fromtei   = NULL;
        break;

    case FMT_HTMLHREF:
        fromplain = NULL;
        fromthml  = new ThMLHTMLHREF();
        fromgbf   = new GBFHTMLHREF();
        fromosis  = new OSISHTMLHREF();
        fromtei   = new TEIHTMLHREF();
        break;

    case FMT_RTF:
        fromplain = NULL;
        fromthml  = new ThMLRTF();
        fromgbf   = new GBFRTF();
        fromosis  = new OSISRTF();
        fromtei   = new TEIRTF();
        break;

    case FMT_LATEX:
        fromplain = NULL;
        fromthml  = new ThMLLaTeX();
        fromgbf   = new GBFLaTeX();
        fromosis  = new OSISLaTeX();
        fromtei   = new TEILaTeX();
        break;

    case FMT_OSIS:
        fromplain = NULL;
        fromthml  = new ThMLOSIS();
        fromgbf   = new GBFOSIS();
        fromosis  = new OSISOSIS();
        fromtei   = NULL;
        break;

    case FMT_WEBIF:
        fromplain = NULL;
        fromthml  = new ThMLWEBIF();
        fromgbf   = new GBFWEBIF();
        fromosis  = new OSISWEBIF();
        fromtei   = new TEIXHTML();
        break;

    case FMT_TEI:
        fromplain = NULL;
        fromthml  = NULL;
        fromgbf   = NULL;
        fromosis  = NULL;
        fromtei   = NULL;
        break;

    case FMT_XHTML:
        fromplain = NULL;
        fromthml  = new ThMLXHTML();
        fromgbf   = new GBFXHTML();
        fromosis  = new OSISXHTML();
        fromtei   = new TEIXHTML();
        break;
    }

}

char EncodingFilterMgr::Encoding ( char  enc )

inlineinherited

Encoding sets/gets the encoding after initialization

DEPRECATED: use setEncoding / getEncoding

Returns

The current encoding format.

Definition at line 75 of file encfiltmgr.h.

{ if (enc != ENC_UNKNOWN) setEncoding(enc); return getEncoding(); }

char EncodingFilterMgr::getEncoding ( ) const

inlineinherited

getEncoding gets the encoding after initialization

Returns

The current encoding format.

Definition at line 81 of file encfiltmgr.h.

{ return encoding; }

char MarkupFilterMgr::getMarkup ( ) const

inline

getMarkup gets the markup after initialization

Returns

The current markup format.

Definition at line 76 of file markupfiltmgr.h.

{ return markup; }

SWMgr * SWFilterMgr::getParentMgr ( )

virtualinherited

Definition at line 43 of file swfiltermgr.cpp.

                                 {
    return parentMgr;
}

SWDEPRECATED char MarkupFilterMgr::Markup ( char  m = FMT_UNKNOWN )

inline

Markup sets/gets the markup after initialization

Deprecated:

Use setMarkup / getMarkup

Parameters

m	The new markup

Returns

The current (possibly changed) markup format.

Definition at line 70 of file markupfiltmgr.h.

{ if (m != FMT_UNKNOWN) setMarkup(m); return getMarkup(); }

void EncodingFilterMgr::setEncoding ( char  enc )

inherited

setEncoding sets the encoding after initialization

Parameters

enc	The new encoding or ENC_UNKNOWN if you just want to get the current markup.

Definition at line 119 of file encfiltmgr.cpp.

                                            {
    if (enc && enc != encoding) {
        encoding = enc;
        SWFilter *oldfilter = targetenc;

        switch (encoding) {
            case ENC_LATIN1: targetenc = new UTF8Latin1(); break;
            case ENC_UTF16:  targetenc = new UTF8UTF16();  break;
            case ENC_RTF:    targetenc = new UnicodeRTF(); break;
            case ENC_HTML:   targetenc = new UTF8HTML();   break;
#ifdef _ICU_
            case ENC_SCSU:   targetenc = new UTF8SCSU();   break;
#endif
            default: // i.e. case ENC_UTF8
                targetenc = NULL;
        }

        ModMap::const_iterator module;

        if (oldfilter != targetenc) {
            if (oldfilter) {
                if (!targetenc) {
                    for (module = getParentMgr()->Modules.begin(); module != getParentMgr()->Modules.end(); module++)
                        module->second->removeRenderFilter(oldfilter);
                    }
                else {
                    for (module = getParentMgr()->Modules.begin(); module != getParentMgr()->Modules.end(); module++)
                        module->second->replaceRenderFilter(oldfilter, targetenc);
                }
                delete oldfilter;
            }
            else if (targetenc) {
                for (module = getParentMgr()->Modules.begin(); module != getParentMgr()->Modules.end(); module++)
                    module->second->addRenderFilter(targetenc);
            }
        }
    }
}

void MarkupFilterMgr::setMarkup

(

char

m

)

setMarkup sets the markup after initialization

Parameters

m	The new markup

Definition at line 102 of file markupfiltmgr.cpp.

                                         {
    if (mark && mark != markup) {
        markup = mark;
        ModMap::const_iterator module;

        SWFilter *oldplain = fromplain;
        SWFilter *oldthml  = fromthml;
        SWFilter *oldgbf   = fromgbf;
        SWFilter *oldosis  = fromosis;
        SWFilter *oldtei   = fromtei;

        createFilters(markup);

        for (module = getParentMgr()->Modules.begin(); module != getParentMgr()->Modules.end(); ++module) {
            switch (module->second->getMarkup()) {
            case FMT_THML:
                if (oldthml != fromthml) {
                    if (oldthml) {
                        if (!fromthml) {
                            module->second->removeRenderFilter(oldthml);
                        }
                        else {
                            module->second->replaceRenderFilter(oldthml, fromthml);
                        }
                    }
                    else if (fromthml) {
                        module->second->addRenderFilter(fromthml);
                    }
                }
                break;

            case FMT_GBF:
                if (oldgbf != fromgbf) {
                    if (oldgbf) {
                        if (!fromgbf) {
                            module->second->removeRenderFilter(oldgbf);
                        }
                        else {
                            module->second->replaceRenderFilter(oldgbf, fromgbf);
                        }
                    }
                    else if (fromgbf) {
                        module->second->addRenderFilter(fromgbf);
                    }
                }
                break;

            case FMT_PLAIN:
                if (oldplain != fromplain) {
                    if (oldplain) {
                        if (!fromplain) {
                            module->second->removeRenderFilter(oldplain);
                        }
                        else {
                            module->second->replaceRenderFilter(oldplain, fromplain);
                        }
                    }
                    else if (fromplain) {
                        module->second->addRenderFilter(fromplain);
                    }
                }
                break;

            case FMT_OSIS:
                if (oldosis != fromosis) {
                    if (oldosis) {
                        if (!fromosis) {
                            module->second->removeRenderFilter(oldosis);
                        }
                        else {
                            module->second->replaceRenderFilter(oldosis, fromosis);
                        }
                    }
                    else if (fromosis) {
                        module->second->addRenderFilter(fromosis);
                    }
                }
                break;

            case FMT_TEI:
                if (oldtei != fromtei) {
                    if (oldtei) {
                        if (!fromtei) {
                            module->second->removeRenderFilter(oldtei);
                        }
                        else {
                            module->second->replaceRenderFilter(oldtei, fromtei);
                        }
                    }
                    else if (fromtei) {
                        module->second->addRenderFilter(fromtei);
                    }
                }
                break;
            }
        }

        delete oldthml;
        delete oldgbf;
        delete oldplain;
        delete oldosis;
        delete oldtei;
    }
}

void SWFilterMgr::setParentMgr ( SWMgr *  parentMgr )

virtualinherited

Definition at line 38 of file swfiltermgr.cpp.

                                               {
    this->parentMgr = parentMgr;
}

Member Data Documentation

char EncodingFilterMgr::encoding

protectedinherited

Definition at line 52 of file encfiltmgr.h.

SWFilter* MarkupFilterMgr::fromgbf

protected

Definition at line 38 of file markupfiltmgr.h.

SWFilter* MarkupFilterMgr::fromosis

protected

Definition at line 40 of file markupfiltmgr.h.

SWFilter* MarkupFilterMgr::fromplain

protected

Definition at line 39 of file markupfiltmgr.h.

SWFilter* MarkupFilterMgr::fromtei

protected

Definition at line 41 of file markupfiltmgr.h.

SWFilter* MarkupFilterMgr::fromthml

protected

Definition at line 37 of file markupfiltmgr.h.

SWFilter* EncodingFilterMgr::latin1utf8

protectedinherited

Definition at line 43 of file encfiltmgr.h.

char MarkupFilterMgr::markup

protected

current markup value

Definition at line 46 of file markupfiltmgr.h.

SWFilter* EncodingFilterMgr::scsuutf8

protectedinherited

Definition at line 44 of file encfiltmgr.h.

SWFilter* EncodingFilterMgr::targetenc

protectedinherited

Definition at line 46 of file encfiltmgr.h.

SWFilter* EncodingFilterMgr::utf16utf8

protectedinherited

Definition at line 45 of file encfiltmgr.h.

---

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

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