Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   Related Pages  

ztext.h

00001 /******************************************************************************
00002  *  ztext.h   - code for class 'zText'- a module that reads compressed text
00003  *                              files: ot and nt using indexs ??.vss
00004  *
00005  * $Id: ztext_8h-source.html,v 1.1 2003/02/28 21:22:27 mgruner Exp $
00006  *
00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
00008  *      CrossWire Bible Society
00009  *      P. O. Box 2528
00010  *      Tempe, AZ  85280-2528
00011  *
00012  * This program is free software; you can redistribute it and/or modify it
00013  * under the terms of the GNU General Public License as published by the
00014  * Free Software Foundation version 2.
00015  *
00016  * This program is distributed in the hope that it will be useful, but
00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019  * General Public License for more details.
00020  *
00021  */
00022 
00023 #ifndef ZTEXT_H
00024 #define ZTEXT_H
00025 
00026 #include <zverse.h>
00027 #include <swtext.h>
00028 //#include <swcomprs.h>
00029 
00030 #include <defs.h>
00031 
00032 SWORD_NAMESPACE_START
00033 
00034 /*** SWModule implementation for compressed modules
00035 * This class handles compressed modules.
00036 * It should not be used in frontends, unless you are doing very special things.
00037 */
00038 class SWDLLEXPORT zText:public zVerse, public SWText {
00039 
00040      VerseKey *lastWriteKey;
00041      bool sameBlock(VerseKey * lastWriteKey, VerseKey * key);
00042         int blockType;
00043         VerseKey &getVerseKey();
00044 
00045 
00046 public:
00047     
00048         zText(const char *ipath, const char *iname = 0, const char *idesc = 0,
00049                         int blockType = CHAPTERBLOCKS, SWCompress * icomp = 0,
00050                         SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
00051                         SWTextDirection dir = DIRECTION_LTR,
00052                         SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0);
00053 
00054         virtual ~zText();
00055         virtual SWBuf &getRawEntryBuf();
00056 
00057         virtual void increment(int steps = 1);
00058         virtual void decrement(int steps = 1) { increment(-steps); }
00059 
00060   // write interface ----------------------------
00061         virtual bool isWritable() { return ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); }
00062         static char createModule(const char *path, int blockBound) {
00063                 return zVerse::createModule(path, blockBound);
00064         }
00065 
00066      virtual void setEntry(const char *inbuf, long len = -1);   // Modify current module entry
00067      virtual void linkEntry(const SWKey *linkKey);      // Link current module entry to other module entry
00068      virtual void deleteEntry();        // Delete current module entry
00069   // end write interface ------------------------
00070   
00071         virtual void rawZFilter(SWBuf &buf, char direction = 0) { rawFilter(buf, (SWKey *)(long)direction); }// hack, use key as direction for enciphering
00072 
00073         // swcacher interface ----------------------
00074         virtual void flush() { flushCache(); }
00075         // end swcacher interface ----------------------
00076 
00077         SWMODULE_OPERATORS
00078 
00079 };
00080 
00081 SWORD_NAMESPACE_END
00082 #endif

Generated on Fri Feb 28 22:01:39 2003 for The Sword Project by doxygen1.3-rc3