osishtmlhref.h

Go to the documentation of this file.

/******************************************************************************
 *
 * osishtmlhref.h - class OSISHTMLHREF: a RenderFilter to render HTMLHREF
 *          from modules marked up in OSIS
 *
 * $Id: osishtmlhref.h 3786 2020-08-30 11:35:14Z scribe $
 *
 * Copyright 2003-2013 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 OSISHTMLHREF_H
#define OSISHTMLHREF_H

#include <swbasicfilter.h>

SWORD_NAMESPACE_START

class SWDLLEXPORT OSISHTMLHREF : public SWBasicFilter {
private:
    bool morphFirst;
    bool renderNoteNumbers;
protected:
    // used by derived classes so we have it in the header
    class TagStacks;
    class SWDLLEXPORT MyUserData : public BasicFilterUserData {
    public:
        bool osisQToTick;
        bool inBold;    // TODO: obsolete. left for binary compat for 1.6.x
        bool inXRefNote;
        bool isBiblicalText;
        int suspendLevel;
        SWBuf wordsOfChristStart;
        SWBuf wordsOfChristEnd;
        TagStacks *tagStacks;   // TODO: modified to wrap all TagStacks necessary for this filter until 1.7.x
//      TagStack *hiStack;  // TODO: commented out for binary compat for 1.6.x   wrapped in tagStacks until 1.7.x
        SWBuf lastTransChange;
        SWBuf w;
        SWBuf fn;
        SWBuf version;
        MyUserData(const SWModule *module, const SWKey *key);
        ~MyUserData();
    };
    virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
        return new MyUserData(module, key);
    }
    virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
public:
    OSISHTMLHREF();
    void setMorphFirst(bool val = true) { morphFirst = val; }
    void setRenderNoteNumbers(bool val = true) { renderNoteNumbers = val; }
};

SWORD_NAMESPACE_END
#endif