The Sword Project: swbasicfilter.h Source File

swbasicfilter.h

/******************************************************************************
 *  swbasicfilter.h     - definition of class SWBasicFilter.  An SWFilter
 *                              impl that provides some basic methods that
 *                              many filter will need and can use as a starting
 *                              point. 
 *
 * $Id: swbasicfilter.h 1984 2006-10-08 05:06:52Z 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 SWBASICFILTER_H
#define SWBASICFILTER_H

#include <swfilter.h>
#include <swbuf.h>

SWORD_NAMESPACE_START


// not a protected inner class because MSVC++ sucks and can't handle it
class SWDLLEXPORT BasicFilterUserData {
public:
        BasicFilterUserData(const SWModule *module, const SWKey *key) { this->module = module; this->key = key; suspendTextPassThru = false; supressAdjacentWhitespace = false; }
        virtual ~BasicFilterUserData() {}
        const SWModule *module;
        const SWKey *key;
        SWBuf lastTextNode;
        SWBuf lastSuspendSegment;
        bool suspendTextPassThru;
        bool supressAdjacentWhitespace;
};

class SWDLLEXPORT SWBasicFilter : public SWFilter {

class Private;

        char *tokenStart;
        char *tokenEnd;
        char *escStart;
        char *escEnd;
        char escStartLen;
        char escEndLen;
        char tokenStartLen;
        char tokenEndLen;
        bool escStringCaseSensitive;
        bool tokenCaseSensitive;
        bool passThruUnknownToken;
        bool passThruUnknownEsc;
        bool passThruNumericEsc;
        char processStages;


        Private *p;
public:

        SWBasicFilter();
        virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0);
        virtual ~SWBasicFilter();

protected:

        virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
                return new BasicFilterUserData(module, key);
        }

        // STAGEs
        static const char INITIALIZE;   // flag for indicating processing before char loop
        static const char PRECHAR;      // flag for indicating processing at top in char loop
        static const char POSTCHAR;     // flag for indicating processing at bottom in char loop
        static const char FINALIZE;     // flag for indicating processing after char loop


        void setEscapeStart(const char *escStart);

        void setEscapeEnd(const char *escEnd);

        void setTokenStart(const char *tokenStart);

        void setTokenEnd(const char *tokenEnd);

        void setPassThruUnknownToken(bool val);

        void setPassThruUnknownEscapeString(bool val);

        void setPassThruNumericEscapeString(bool val);

        void setEscapeStringCaseSensitive(bool val);

        void addAllowedEscapeString(const char *findString);

        void removeAllowedEscapeString(const char *findString);

        void addEscapeStringSubstitute(const char *findString, const char *replaceString);

        void removeEscapeStringSubstitute(const char *findString);

        bool substituteEscapeString(SWBuf &buf, const char *escString);

        bool passAllowedEscapeString(SWBuf &buf, const char *escString);

        void appendEscapeString(SWBuf &buf, const char *escString);

        void setTokenCaseSensitive(bool val);

        void addTokenSubstitute(const char *findString, const char *replaceString);

        void removeTokenSubstitute(const char *findString);

        bool substituteToken(SWBuf &buf, const char *token);

        virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);

        virtual bool processStage(char /*stage*/, SWBuf &/*text*/, char *&/*from*/, BasicFilterUserData * /*userData*/) { return false; }
        virtual void setStageProcessing(char stages) { processStages = stages; }        // see STATICs up above

        virtual bool handleEscapeString(SWBuf &buf, const char *escString, BasicFilterUserData *userData);

        virtual bool handleNumericEscapeString(SWBuf &buf, const char *escString);


};

SWORD_NAMESPACE_END
#endif

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