#include "rcldb.h"

#include "rcldb.h"

#include "refcntr.h"

#include "refcntr.h"

#include "smallut.h"

#include "smallut.h"

#include "cstr.h"

#include "cstr.h"

class RclConfig;

class RclConfig;

namespace Rcl {

namespace Rcl {

/** Search clause types */

/** Search clause types */

enum SClType {

enum SClType {

    SCLT_AND, 

    SCLT_AND, 

    SCLT_OR, SCLT_EXCL, SCLT_FILENAME, SCLT_PHRASE, SCLT_NEAR,

    SCLT_OR, SCLT_EXCL, SCLT_FILENAME, SCLT_PHRASE, SCLT_NEAR,

};

};

class SearchDataClause;

class SearchDataClause;

/** 

/** 

  Data structure representing a Recoll user query, for translation

  into a Xapian query tree. This could probably better called a 'question'.

  This is a list of search clauses combined through either OR or AND.

  Clauses either reflect user entry in a query field: some text, a

  clause type (AND/OR/NEAR etc.), possibly a distance, or points to

  another SearchData representing a subquery.

  The content of each clause when added may not be fully parsed yet

  (may come directly from a gui field). It will be parsed and may be

  translated to several queries in the Xapian sense, for exemple

  several terms and phrases as would result from 

  ["this is a phrase"  term1 term2] . 

  This is why the clauses also have an AND/OR/... type. 

  A phrase clause could be added either explicitly or using double quotes:

  {SCLT_PHRASE, [this is a phrase]} or as {SCLT_XXX, ["this is a phrase"]}

*/

class SearchData {

class SearchData {

public:

public:

    SearchData(SClType tp) 

    SearchData(SClType tp) 

    : m_tp(tp), m_topdirexcl(false), m_topdirweight(1.0), 

    {

    {

    if (m_tp != SCLT_OR && m_tp != SCLT_AND) 

    if (m_tp != SCLT_OR && m_tp != SCLT_AND) 

        m_tp = SCLT_OR;

        m_tp = SCLT_OR;

    }

    }

    ~SearchData() {erase();}

    ~SearchData() {erase();}

     *     (proportion of docs where they occur)    

     *     (proportion of docs where they occur)    

     */

     */

    bool maybeAddAutoPhrase(Rcl::Db &db, double threshold);

    bool maybeAddAutoPhrase(Rcl::Db &db, double threshold);

    /** Set/get top subdirectory for filtering results */

    /** Set/get top subdirectory for filtering results */

    void setTopdir(const string& t, bool excl = false, float w = 1.0) 

    {

    {

    m_topdir = t;

    m_topdir = t;

    m_topdirexcl = excl;

    m_topdirexcl = excl;

    m_topdirweight = w;

    m_topdirweight = w;

    }

    }

    /** Set date span for filtering results */

    /** Set date span for filtering results */

    void setDateSpan(DateInterval *dip) {m_dates = *dip; m_haveDates = true;}

    void setDateSpan(DateInterval *dip) {m_dates = *dip; m_haveDates = true;}

    /** Add file type for filtering results */

    /** Add file type for filtering results */

    void addFiletype(const string& ft) {m_filetypes.push_back(ft);}

    /** Add file type to not wanted list */

    /** Add file type to not wanted list */

    void remFiletype(const string& ft) {m_nfiletypes.push_back(ft);}

    void setStemlang(const string& lang = "english") {m_stemlang = lang;}

    /** Retrieve error description */

    /** Retrieve error description */

    string getReason() {return m_reason;}

     */

     */

    /** 

    /** 

     * Get/set the description field which is retrieved from xapian after

     * Get/set the description field which is retrieved from xapian after

     * initializing the query. It is stored here for usage in the GUI.

     * initializing the query. It is stored here for usage in the GUI.

     */

     */

    string getDescription() {return m_description;}

    void setDescription(const string& d) {m_description = d;}

private:

private:

    vector<SearchDataClause*> m_query;

    bool                      m_topdirexcl; // Invert meaning

    bool                      m_topdirexcl; // Invert meaning

    float                     m_topdirweight; // affect weight instead of filter

    float                     m_topdirweight; // affect weight instead of filter

    bool                      m_haveDates;

    bool                      m_haveDates;

    DateInterval              m_dates; // Restrict to date interval

    DateInterval              m_dates; // Restrict to date interval

    size_t                    m_maxSize;

    size_t                    m_maxSize;

    size_t                    m_minSize;

    size_t                    m_minSize;

    // Printable expanded version of the complete query, retrieved/set

    // Printable expanded version of the complete query, retrieved/set

    // from rcldb after the Xapian::setQuery() call

    // from rcldb after the Xapian::setQuery() call

    string m_description; 

    string m_reason;

    bool   m_haveWildCards;

    bool   m_haveWildCards;

    string m_stemlang;

    bool expandFileTypes(RclConfig *cfg, vector<string>& exptps);

    /* Copyconst and assignment private and forbidden */

    /* Copyconst and assignment private and forbidden */

    SearchData(const SearchData &) {}

    SearchData(const SearchData &) {}

    SearchData& operator=(const SearchData&) {return *this;};

    SearchData& operator=(const SearchData&) {return *this;};

};

};

public:

public:

    enum Modifier {SDCM_NONE=0, SDCM_NOSTEMMING=1, SDCM_ANCHORSTART=2,

    enum Modifier {SDCM_NONE=0, SDCM_NOSTEMMING=1, SDCM_ANCHORSTART=2,

           SDCM_ANCHOREND=4};

           SDCM_ANCHOREND=4};

    SearchDataClause(SClType tp) 

    SearchDataClause(SClType tp) 

    {}

    {}

    virtual ~SearchDataClause() {}

    virtual ~SearchDataClause() {}

    virtual bool toNativeQuery(Rcl::Db &db, void *, const string&) = 0;

    bool isFileName() const {return m_tp == SCLT_FILENAME ? true: false;}

    bool isFileName() const {return m_tp == SCLT_FILENAME ? true: false;}

    virtual string getReason() const {return m_reason;}

    SClType getTp() 

    void setParent(SearchData *p) 

    virtual void setModifiers(Modifier mod) 

    virtual int getModifiers() 

    virtual void addModifier(Modifier mod) 

    int imod = getModifiers();

    int imod = getModifiers();

    imod |= mod;

    imod |= mod;

    setModifiers(Modifier(imod));

    setModifiers(Modifier(imod));

    }

    }

    virtual void setWeight(float w) 

    friend class SearchData;

    friend class SearchData;

protected:

protected:

    string      m_reason;

    SClType     m_tp;

    SClType     m_tp;

    SearchData *m_parentSearch;

    SearchData *m_parentSearch;

    bool        m_haveWildCards;

    bool        m_haveWildCards;

    Modifier    m_modifiers;

    Modifier    m_modifiers;

    float       m_weight;

    float       m_weight;

private:

private:

    SearchDataClause(const SearchDataClause&) 

    SearchDataClause& operator=(const SearchDataClause&) 

    return *this;

    return *this;

    }

    }

};

};

/**

/**

 * "Simple" data clause with user-entered query text. This can include 

 * "Simple" data clause with user-entered query text. This can include 

 * multiple phrases and words, but no specified distance.

 * multiple phrases and words, but no specified distance.

 */

 */

class SearchDataClauseSimple : public SearchDataClause {

class SearchDataClauseSimple : public SearchDataClause {

public:

public:

    SearchDataClauseSimple(SClType tp, const string& txt, 

               const string& fld = string())

    : SearchDataClause(tp), m_text(txt), m_field(fld)

    virtual ~SearchDataClauseSimple() 

    /** Translate to Xapian query */

    /** Translate to Xapian query */

protected:

protected:

    string  m_text;  // Raw user entry text.

    string  m_field; // Field specification if any

};

};

/** 

/** 

 * Filename search clause. This is special because term expansion is only

 * Filename search clause. This is special because term expansion is only

 * performed against the unsplit file name terms. 

 * performed against the unsplit file name terms. 

 * field, especially for file names, because this makes searches for

 * field, especially for file names, because this makes searches for

 * "*xx" much faster (no need to scan the whole main index).

 * "*xx" much faster (no need to scan the whole main index).

 */

 */

class SearchDataClauseFilename : public SearchDataClauseSimple {

class SearchDataClauseFilename : public SearchDataClauseSimple {

public:

public:

    SearchDataClauseFilename(const string& txt)

    : SearchDataClauseSimple(SCLT_FILENAME, txt) 

    // File name searches don't count when looking for wild cards.

    // File name searches don't count when looking for wild cards.

    m_haveWildCards = false;

    m_haveWildCards = false;

    }

    }

    virtual ~SearchDataClauseFilename() 

};

};

/** 

/** 

 * A clause coming from a NEAR or PHRASE entry field. There is only one 

 * A clause coming from a NEAR or PHRASE entry field. There is only one 

 * string group, and a specified distance, which applies to it.

 */

 */

class SearchDataClauseDist : public SearchDataClauseSimple {

class SearchDataClauseDist : public SearchDataClauseSimple {

public:

public:

    SearchDataClauseDist(SClType tp, const string& txt, int slack, 

             const string& fld = string())

    virtual ~SearchDataClauseDist() 

};

};

/** Subquery */

/** Subquery */

class SearchDataClauseSub : public SearchDataClause {

class SearchDataClauseSub : public SearchDataClause {

public:

public:

    // We take charge of the SearchData * and will delete it.

    // We take charge of the SearchData * and will delete it.

    SearchDataClauseSub(SClType tp, RefCntr<SearchData> sub) 

    SearchDataClauseSub(SClType tp, RefCntr<SearchData> sub) 

    : SearchDataClause(tp), m_sub(sub) 

    virtual ~SearchDataClauseSub() 

protected:

protected:

    RefCntr<SearchData> m_sub;

    RefCntr<SearchData> m_sub;

};

};

} // Namespace Rcl

} // Namespace Rcl

#endif /* _SEARCHDATA_H_INCLUDED_ */

#endif /* _SEARCHDATA_H_INCLUDED_ */