/*
 * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
 *
 * 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; either version 3 of the License, or
 * any later version.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */

#ifndef KIWIX_SEARCHER_H
#define KIWIX_SEARCHER_H

#include <stdio.h>
#include <stdlib.h>
#include <string>
#include <algorithm>
#include <vector>
#include <locale>
#include <cctype>
#include <vector>
#include "common/pathTools.h"
#include "common/stringTools.h"
#include <unicode/putil.h>
#include "kiwix_config.h"

using namespace std;

class Result
{
  public:
    virtual ~Result() {};
    virtual std::string get_url() = 0;
    virtual std::string get_title() = 0;
    virtual int get_score() = 0;
    virtual std::string get_snippet() = 0;
    virtual int get_wordCount() = 0;
    virtual int get_size() = 0;
};

namespace kiwix {

  class Searcher {

  public:
    Searcher();
    virtual ~Searcher();

    void search(std::string &search, unsigned int resultStart,
		unsigned int resultEnd, const bool verbose=false);
    virtual Result* getNextResult() = 0;
    virtual void restart_search() = 0;
    unsigned int getEstimatedResultCount();
    bool setProtocolPrefix(const std::string prefix);
    bool setSearchProtocolPrefix(const std::string prefix);
    void reset();
    void setContentHumanReadableId(const string &contentHumanReadableId);

#ifdef ENABLE_CTPP2
    string getHtml();
#endif
    
  protected:
    std::string beautifyInteger(const unsigned int number);
    virtual void closeIndex() = 0;
    virtual void searchInIndex(string &search, const unsigned int resultStart,
			       const unsigned int resultEnd, const bool verbose=false) = 0;

    std::string searchPattern;
    std::string protocolPrefix;
    std::string searchProtocolPrefix;
    std::string template_ct2;
    unsigned int resultCountPerPage;
    unsigned int estimatedResultCount;
    unsigned int resultStart;
    unsigned int resultEnd;
    std::string contentHumanReadableId;
  };

}

#endif