listkey.h

Go to the documentation of this file.

/******************************************************************************
 *
 * listkey.h -  class ListKey: a container Key which facilitates a list of
 *      SWKey objects.  This is useful for search results or returning
 *      the result of parsing freetext verse ranges.  The usefulness
 *      of having this container of keys itself be an SWKey is that it
 *      can be used natively by an SWModule to iterate the results.
 *
 * $Id: listkey.h 3822 2020-11-03 18:54:47Z scribe $
 *
 * Copyright 1997-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 SWLSTKEY_H
#define SWLSTKEY_H

#include <swkey.h>

#include <defs.h>

SWORD_NAMESPACE_START

class SWDLLEXPORT ListKey : public SWKey {

    void init();

protected:
    int arraypos;
    int arraymax;
    int arraycnt;
    SWKey **array;

public:

    ListKey(const char *ikey = 0);
    ListKey(ListKey const &k);

    virtual ~ListKey();

    virtual SWKey *clone() const;
    
    virtual void clear();

    SWDEPRECATED virtual void ClearList() { clear(); }


    virtual int getCount() const;
    SWDEPRECATED virtual int Count() { return getCount(); }
    
    virtual void remove();
    SWDEPRECATED virtual void Remove() { remove(); }

    
    virtual char setToElement(int ielement, SW_POSITION pos = TOP);
    SWDEPRECATED virtual char SetToElement(int ielement, SW_POSITION pos = TOP) { return setToElement(ielement, pos); }


    
    virtual SWKey *getElement(int pos = -1);
    virtual const SWKey *getElement(int pos = -1) const;
    
    SWDEPRECATED virtual SWKey *GetElement(int pos = -1) { return getElement(pos); }

    ListKey & operator <<(const SWKey &ikey) { add(ikey); return *this; }
    virtual void add(const SWKey &ikey);

    virtual void copyFrom(const ListKey & ikey);
    virtual void copyFrom(const SWKey & ikey) { SWKey::copyFrom(ikey); }

    virtual void setPosition(SW_POSITION pos);
    
    virtual void decrement(int step = 1);
    
    virtual void increment(int step = 1);

    virtual void nextElement() { setToElement(arraypos + 1); }

    virtual bool isTraversable() const { return true; }
    virtual long getIndex() const { return arraypos; }
    virtual const char *getRangeText() const;
    virtual const char *getOSISRefRangeText() const;
    virtual const char *getShortRangeText() const;
    virtual const char *getShortText() const;

    virtual void setIndex(long index) { setToElement((int)index); }
    virtual const char *getText() const;
    virtual void setText(const char *ikey);
    virtual void sort();

    SWKEY_OPERATORS
    ListKey & operator =(const ListKey &key) { copyFrom(key); return *this; }
};

SWORD_NAMESPACE_END
#endif