The Sword Project: ztext.h Source File

ztext.h

/******************************************************************************
 *  ztext.h   - code for class 'zText'- a module that reads compressed text
 *                              files: ot and nt using indexs ??.vss
 *
 * $Id: ztext.h 1864 2005-11-20 06:06:40Z 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 ZTEXT_H
#define ZTEXT_H

#include <zverse.h>
#include <swtext.h>

#include <defs.h>

namespace lucene { namespace index {
class IndexReader;
}}

namespace lucene { namespace search {
class IndexSearcher;
}}

SWORD_NAMESPACE_START

/*** SWModule implementation for compressed modules
* This class handles compressed modules.
* It should not be used in frontends, unless you are doing very special things.
*/
class SWDLLEXPORT zText:public zVerse, public SWText {

        VerseKey *lastWriteKey;
        bool sameBlock(VerseKey * lastWriteKey, VerseKey * key);
        int blockType;


public:
    
        zText(const char *ipath, const char *iname = 0, const char *idesc = 0,
                        int blockType = CHAPTERBLOCKS, SWCompress * icomp = 0,
                        SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
                        SWTextDirection dir = DIRECTION_LTR,
                        SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0);

        virtual ~zText();
        virtual SWBuf &getRawEntryBuf();

        virtual void increment(int steps = 1);
        virtual void decrement(int steps = 1) { increment(-steps); }

  // write interface ----------------------------
        virtual bool isWritable();
        static char createModule(const char *path, int blockBound) {
                return zVerse::createModule(path, blockBound);
        }

     virtual void setEntry(const char *inbuf, long len = -1);   // Modify current module entry
     virtual void linkEntry(const SWKey *linkKey);      // Link current module entry to other module entry
        virtual void deleteEntry();     // Delete current module entry
  // end write interface ------------------------
  
        virtual void rawZFilter(SWBuf &buf, char direction = 0) { rawFilter(buf, (SWKey *)(long)direction); }// hack, use key as direction for enciphering

        // swcacher interface ----------------------
        virtual void flush() { flushCache(); }
        // end swcacher interface ----------------------

        SWMODULE_OPERATORS

};

SWORD_NAMESPACE_END
#endif

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