versetreekey.h

Go to the documentation of this file.

/******************************************************************************
 *
 * versetreekey.h - class VerseTreeKey: a specialized VerseKey which
 *          obtains its versification system from a module with
 *          a tree structure
 *
 * $Id: versetreekey.h 3808 2020-10-02 13:23:34Z scribe $
 *
 * Copyright 2006-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 VERSETREEKEY_H
#define VERSETREEKEY_H

#include <versekey.h>
#include <treekey.h>
#include <swmacs.h>
#include <listkey.h>

#include <defs.h>

SWORD_NAMESPACE_START

class SWDLLEXPORT VerseTreeKey : public VerseKey, public TreeKey::PositionChangeListener {

private:
    TreeKey *treeKey;
//  vector<struct sbook> books;

    void init(TreeKey *treeKey);
    void syncVerseToTree() const;
    long lastGoodOffset;

protected:
    virtual int getBookFromAbbrev(const char *abbr) const;

public:

    VerseTreeKey(TreeKey *treeKey, const char *ikey = 0);
    
    VerseTreeKey(TreeKey *treeKey, const SWKey *ikey);
    
    VerseTreeKey(TreeKey *treeKey, const char *min, const char *max);
    
    VerseTreeKey(const VerseTreeKey &k);
    

    virtual ~VerseTreeKey();

    virtual SWKey *clone() const;
    
    virtual bool isTraversable() const { return true; }

    virtual TreeKey *getTreeKey();
    virtual const TreeKey *getTreeKey() const;

    // TreeKey::PositionChangeListener interface
    virtual void positionChanged();
    mutable bool internalPosChange;

    virtual void decrement(int steps = 1);
    virtual void increment(int steps = 1);
    
    virtual void Normalize(char autocheck = 0);

    virtual void setPosition(SW_POSITION newpos);
    virtual long newIndex() const;
    // OPERATORS --------------------------------------------------------------------


    SWKEY_OPERATORS

    virtual SWKey & operator = (const VerseKey & ikey) { copyFrom(ikey); return *this; }
//  virtual void copyFrom(const VerseTreeKey &ikey);
};

SWORD_NAMESPACE_END

#endif //VERSETREEKEY_H