---

swkey.h

/******************************************************************************
 *  swkey.h     - code for base class 'swkey'.  swkey is the basis for all
 *                              types of keys for indexing into modules (e.g. verse, word,
 *                              place, etc.)
 *
 * $Id: swkey_8h-source.html,v 1.1 2003/02/28 21:22:00 mgruner Exp $
 *
 * 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 SWKEY_H
#define SWKEY_H

#include <swobject.h>

#include <defs.h>

SWORD_NAMESPACE_START

#define KEYERR_OUTOFBOUNDS 1

#define SWKEY_OPERATORS \
  SWKey & operator =(const char *ikey) { setText(ikey); return *this; } \
  SWKey & operator =(const SWKey &ikey) { copyFrom(ikey); return *this; } \
  SWKey & operator =(SW_POSITION pos) { setPosition(pos); return *this; } \
  operator const char *() const { return getText(); } \
  bool operator ==(const SWKey & ikey) { return equals(ikey); } \
  bool operator !=(const SWKey & ikey) { return !equals(ikey); } \
  virtual bool operator >(const SWKey & ikey) { return (compare(ikey) > 0); } \
  virtual bool operator <(const SWKey & ikey) { return (compare(ikey) < 0); } \
  virtual bool operator >=(const SWKey & ikey) { return (compare(ikey) > -1); }  \
  virtual bool operator <=(const SWKey & ikey) { return (compare(ikey) < 1); } \
  SWKey & operator -=(int steps) { decrement(steps); return *this; } \
  SWKey & operator +=(int steps) { increment(steps); return *this; } \
  SWKey & operator++(int) { return *this += 1; } \
  SWKey & operator--(int) { return *this -= 1; }


// For use with = operator to position key.

class SW_POSITION {
        char pos;
public:
        SW_POSITION(char ipos) { pos = ipos; }
        operator char() { return pos; }
};

#define POS_TOP ((char)1)
#define POS_BOTTOM ((char)2)

#define TOP SW_POSITION(POS_TOP)
#define BOTTOM SW_POSITION(POS_BOTTOM)

class SWDLLEXPORT SWKey : public SWObject {
        long index;
        static SWClass classdef;
        void init();

protected:
        char *keytext;
        mutable char *rangeText;
        mutable bool boundSet;
        char persist;
        char error;

public:

        // misc pointer for whatever
        void *userData;

        SWKey(const char *ikey = 0);

        SWKey(SWKey const &k);

        virtual ~SWKey();

        virtual SWKey *clone() const;

        char Persist() const;

        char Persist(signed char ipersist);

        virtual char Error();

        virtual void setText(const char *ikey);

        virtual void copyFrom(const SWKey &ikey);

        virtual const char *getText() const;
        virtual const char *getShortText() const { return getText(); }
        virtual const char *getRangeText() const;
        virtual bool isBoundSet() const { return boundSet; }

        virtual int compare(const SWKey & ikey);

        virtual bool equals(const SWKey &ikey) { return !compare(ikey); }

        virtual void setPosition(SW_POSITION);

        virtual void decrement(int steps = 1);

        virtual void increment(int steps = 1);

        virtual char Traversable() { return 0; }

        virtual long Index() const { return index; }
        virtual long Index(long iindex) { index = iindex; return index; }

        SWKEY_OPERATORS

        };

SWORD_NAMESPACE_END
#endif

---