/*********
*
* This file is part of BibleTime's source code, http://www.bibletime.info/.
*
* Copyright 1999-2008 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License version 2.0.
*
**********/

#ifndef BTSEARCHRESULTAREA_H
#define BTSEARCHRESULTAREA_H


#include "backend/managers/cswordbackend.h"
#include "backend/cswordmodulesearch.h"

#include <QSplitter>
#include <QList>
#include <QStringList>
#include <QWidget>

//forward declarations
class CReadDisplay;
class CSwordModuleInfo;
namespace Search {
class CModuleResultView;
class CSearchResultView;
}

class QHBoxLayout;
class QTreeWidget;
class QFrame;

namespace Search {

/**
* This class is used to keep track of the text strongs results.
* It only keeps track of one instance of a strongs text result.
*
*    The functions of the class are:
*       - Store an instance of a strongs text result.
*       - Each strongs text result will contain a list of verses (keyNames).
*       - The number of verses (keyNames) is returned by keyCount().
*       - The text for the strongs text result is returned by keyText().
*       - The list of verses (keyNames) is returned by getKeyList() [as QStringList].
*
*   To add a new verse to a strongs text result use addKeyName.
*/
class StrongsResult {
    public:
        StrongsResult();
        StrongsResult(const QString& text, const QString &keyName);

        QString keyText() const;
        int keyCount() const;
        void addKeyName(const QString& keyName);
        QStringList* getKeyList();

        /* ????
        bool operator==(const StrongsResult &l, const StrongsResult &r)
        	{ return (l.keyText() == r.keyText()); }

        bool operator<(const StrongsResult &l, const StrongsResult &r)
        	{ return (l->keyText() < r->keyText()); }

        bool operator>(const StrongsResult &l, const StrongsResult &r)
        	{ return (l->keyText() > r->keyText()); }
        */
    private:
        QString text;
        QStringList keyNameList;
};

typedef QList<StrongsResult> StrongsResultList;

/**
* This class is used to keep track of the text strongs results.
* It keeps track of all instances of all strongs text results.
* This class makes use of the above class StrongsResult.
*
*    The functions of the class are:
*       - Store an instance of a strongs text result.
*       - Each strongs text result will contain a list of verses (keyNames).
*       - The number of verses (keyNames) is returned by keyCount().
*       - The text for the strongs text result is returned by keyText().
*       - The list of verses (keyNames) is returned by getKeyList() [as QStringList].
*
*   To add a new verse to a strongs text result use addKeyName.
*/
class StrongsResultClass {
    public:
        StrongsResultClass(CSwordModuleInfo* module, const QString& strongsNumber)
                : srModule(module), lemmaText(strongsNumber) {
            initStrongsResults();
        }

        QString keyText(int index) const {
            return srList[index].keyText();
        }
        int keyCount(int index) const {
            return srList[index].keyCount();
        }
        QStringList* getKeyList(int index) {
            return srList[index].getKeyList();
        }
        int Count() const {
            return srList.count();
        }

    private:
        void initStrongsResults(void);
        QString getStrongsNumberText(const QString& verseContent, int *startIndex);

        StrongsResultList srList;
        CSwordModuleInfo* srModule;
        QString lemmaText;
};


/** The page of the search dialog which contains the search result part.
  * @author The BibleTime team
  */
class BtSearchResultArea : public QWidget {
        Q_OBJECT
    public:
        BtSearchResultArea(QWidget *parent = 0);
        ~BtSearchResultArea();
        /**
        * Sets the modules which contain the result of each.
        */
        void setSearchResult(QList<CSwordModuleInfo*> modules);

        QSize sizeHint() const {
            return baseSize();
        }
        QSize minimumSizeHint() const {
            return minimumSize();
        }

    public slots:
        /**
        * Resets the current list of modules and the displayed list of found entries.
        */
        void reset();

    protected:
        /**
        * Initializes the view of this widget.
        */
        void initView();
        /**
        * Initializes the signal slot conections of the child widgets
        */
        void initConnections();
        /**
        * This function breakes the queryString into clucene tokens
        */
        QStringList QueryParser(const QString& queryString);
        /**
        * This function highlights the searched text in the content using the search type given by search flags
        */
        QString highlightSearchedText(const QString& content, const QString& searchedText);

        /**
        * Load the settings from the resource file
        */
        void loadDialogSettings();
        /**
        * Save the settings to the resource file
        */
        void saveDialogSettings();

    protected slots:
        /**
        * Update the preview of the selected key.
        */
        void updatePreview(const QString& key);
        /**
         * Clear the preview of the selected key.
         */
        void clearPreview();
        /**
        * Shows a dialog with the search analysis of the current search.
        */
        void showAnalysis();

    private:

        CModuleResultView* m_moduleListBox;
        CSearchResultView* m_resultListBox;

        QFrame *m_displayFrame;
        CReadDisplay* m_previewDisplay;

        QList<CSwordModuleInfo*> m_modules;

        QSplitter *mainSplitter;
        QSplitter *resultListSplitter;
};

} //namespace Search

#endif