API-Documentation for Sword 1.5.10

00001 /******************************************************************************
00002  *  zcom.h   - code for class 'zCom'- a module that reads compressed text
00003  *                              files: ot and nt using indexs ??.vss
00004  *
00005  * $Id: zcom.h 1864 2005-11-20 06:06:40Z scribe $
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 ZCOM_H
00024 #define ZCOM_H
00025 
00026 #include <swcom.h>
00027 
00028 #include <defs.h>
00029 
00030 SWORD_NAMESPACE_START
00031 
00032 class SWDLLEXPORT zCom : public zVerse, public SWCom {
00033 
00034         VerseKey *lastWriteKey;
00035         bool sameBlock(VerseKey * lastWriteKey, VerseKey * key);
00036         int blockType;
00037 
00038 
00039 public:
00040 
00041         zCom(const char *ipath, const char *iname = 0, const char *idesc = 0,
00042                         int blockType = CHAPTERBLOCKS, SWCompress * icomp = 0,
00043                         SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
00044                         SWTextDirection dir = DIRECTION_LTR,
00045                         SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0);
00046         virtual ~zCom();
00047         virtual SWBuf &getRawEntryBuf();
00048         virtual void increment(int steps = 1);
00049         virtual void decrement(int steps = 1) { increment(-steps); }
00050 
00051         // write interface ----------------------------
00052         virtual bool isWritable();
00053         static char createModule(const char *path, int blockBound) {
00054                 return zVerse::createModule(path, blockBound);
00055         }
00056         virtual void setEntry(const char *inbuf, long len = -1);        // Modify current module entry
00057         virtual void linkEntry(const SWKey * linkKey);  // Link current module entry to other module entry
00058         virtual void deleteEntry();     // Delete current module entry
00059         // end write interface ------------------------
00060 
00061         virtual void rawZFilter(SWBuf &buf, char direction = 0) { rawFilter(buf, (SWKey *)(long)direction); }// hack, use key as direction for enciphering
00062 
00063         // swcacher interface ----------------------
00064         virtual void flush() { flushCache(); }
00065         // end swcacher interface ----------------------
00066 
00067         SWMODULE_OPERATORS
00068 
00069 };
00070 
00071 SWORD_NAMESPACE_END
00072 
00073 #endif