swsearchable.h

Go to the documentation of this file.

/******************************************************************************
 *
 * swsearchable.h - class SWSearchable: used to provide an
 *          interface for objects that can be searched.
 *
 * $Id: swsearchable.h 3786 2020-08-30 11:35:14Z scribe $
 *
 * Copyright 2003-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 SWSEARCHABLE_H
#define SWSEARCHABLE_H

#include <defs.h>

SWORD_NAMESPACE_START

class ListKey;
class SWKey;

class SWDLLEXPORT SWSearchable {

public:
    SWSearchable();
    virtual ~SWSearchable();

    static void nullPercent(char percent, void *userData);

    // search interface -------------------------------------------------

    virtual ListKey &search(const char *istr, int searchType = 0, int flags = 0,
            SWKey * scope = 0,
            bool * justCheckIfSupported = 0,
            void (*percent) (char, void *) = &nullPercent,
            void *percentUserData = 0) = 0;

    virtual signed char createSearchFramework(
            void (*percent) (char, void *) = &nullPercent,
            void *percentUserData = 0); // special search framework

    virtual void deleteSearchFramework();
    
    virtual bool hasSearchFramework() { return false; }

    virtual bool isSearchOptimallySupported(const char *istr, int searchType, int flags, SWKey *scope);
};

SWORD_NAMESPACE_END
#endif