osisheadings.cpp

Go to the documentation of this file.

/******************************************************************************
 *
 *  osisheadings.cpp -  SWFilter descendant to hide or show headings
 *          in an OSIS module
 *
 * $Id: osisheadings.cpp 3646 2019-06-10 03:46:13Z 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.
 *
 */

#include <stdlib.h>
#include <stdio.h>
#include <osisheadings.h>
#include <swmodule.h>
#include <utilxml.h>
#include <utilstr.h>


SWORD_NAMESPACE_START

namespace {

    static const char oName[] = "Headings";
    static const char oTip[]  = "Toggles Headings On and Off if they exist";

    static const StringList *oValues() {
        static const SWBuf choices[3] = {"Off", "On", ""};
        static const StringList oVals(&choices[0], &choices[2]);
        return &oVals;
    }


    class MyUserData : public BasicFilterUserData {
    public:
        SWBuf currentHeadingName;
        XMLTag currentHeadingTag;
        const char *sID;
        SWBuf heading;
        int depth;
        int headerNum;
        bool canonical;

        MyUserData(const SWModule *module, const SWKey *key) : BasicFilterUserData(module, key) {
            clear();
        }
        void clear() {
            currentHeadingName = "";
            currentHeadingTag = "";
            sID = 0;
            heading = "";
            depth = 0;
            headerNum = 0;
            canonical=false;
        }
    };
}


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


OSISHeadings::OSISHeadings() : SWOptionFilter(oName, oTip, oValues()) {
    setPassThruUnknownToken(true);
}


bool OSISHeadings::handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData) {

    MyUserData *u = (MyUserData *)userData;
    XMLTag tag(token);
    SWBuf name = tag.getName();

    // we only care about titles and divs or if we're already in a heading
    //
    // are we currently in a heading?
    if (u->currentHeadingName.size()) {
        u->heading.append(u->lastTextNode);
        if (SWBuf("true") == tag.getAttribute("canonical")) u->canonical = true;
        if (name == u->currentHeadingName) {
            if (tag.isEndTag(u->sID)) {
                if (!u->depth-- || u->sID) {
                    // see comment below about preverse div changed and needing to preserve the <title> container tag for old school pre-verse titles
                    // we've just finished a heading.  It's all stored up in u->heading
                    bool preverse = (SWBuf("x-preverse") == u->currentHeadingTag.getAttribute("subType") || SWBuf("x-preverse") == u->currentHeadingTag.getAttribute("subtype"));

                    // do we want to put anything in EntryAttributes?
                    if (u->module->isProcessEntryAttributes() && (option || u->canonical || !preverse)) {
                        SWBuf hn; hn.appendFormatted("%i", u->headerNum++);
                        // leave the actual <title...> wrapper in if we're part of an old school preverse title
                        // because now frontend have to deal with preverse as a div which may or may not include <title> elements
                        // and they can't simply wrap all preverse material in <h1>, like they probably did previously
                        SWBuf heading;
                        if (u->currentHeadingName == "title") {
                            XMLTag wrapper = u->currentHeadingTag;
                            if (SWBuf("x-preverse") == wrapper.getAttribute("subType")) wrapper.setAttribute("subType", 0);
                            else if (SWBuf("x-preverse") == wrapper.getAttribute("subtype")) wrapper.setAttribute("subtype", 0);
                            heading = wrapper;
                            heading += u->heading;
                            heading += tag;
                        }
                        else heading = u->heading;
                        u->module->getEntryAttributes()["Heading"][(preverse)?"Preverse":"Interverse"][hn] = heading;

                        StringList attributes = u->currentHeadingTag.getAttributeNames();
                        for (StringList::const_iterator it = attributes.begin(); it != attributes.end(); it++) {
                            u->module->getEntryAttributes()["Heading"][hn][it->c_str()] = u->currentHeadingTag.getAttribute(it->c_str());
                        }
                        // if any title in the heading was canonical, then set canonical=true.
                        // TODO: split composite headings with both canonical and non-canonical headings
                        // into two heading attributes with proper canonical value on each
                        if (u->canonical) u->module->getEntryAttributes()["Heading"][hn]["canonical"] = "true";
                    }

                    // do we want the heading in the body?
                    // if we're not processing entryAttributes, then it's not going anyplace else
                    if ((!preverse || !u->module->isProcessEntryAttributes())  && (option || u->canonical)) {
                        buf.append(u->currentHeadingTag);
                        buf.append(u->heading);
                        buf.append(tag);
                    }
                    u->suspendTextPassThru = false;
                    u->clear();
                }
            }
            else u->depth++;
        }
        u->heading.append(tag);
        return true;
    }

    // are we a title or a preverse div?
    else if (   name == "title"
        || (name == "div"
            && ( SWBuf("x-preverse") == tag.getAttribute("subType")
              || SWBuf("x-preverse") == tag.getAttribute("subtype")))) {

        u->currentHeadingName = name;
        u->currentHeadingTag = tag;
        u->heading = "";
        u->sID = u->currentHeadingTag.getAttribute("sID");
        u->depth = 0;
        u->suspendTextPassThru = true;
        u->canonical = (SWBuf("true") == tag.getAttribute("canonical"));

        return true;
    }

    return false;
}



SWORD_NAMESPACE_END