// ============================================================ //
//                                                              //
//   File      : db_query_local.h                               //
//   Purpose   : internal query defs                            //
//                                                              //
//   Institute of Microbiology (Technical University Munich)    //
//   http://www.arb-home.de/                                    //
//                                                              //
// ============================================================ //

#ifndef DB_QUERY_LOCAL_H
#define DB_QUERY_LOCAL_H

#ifndef ARBDBT_H
#include <arbdbt.h>
#endif
#ifndef DB_QUERY_H
#include "db_query.h"
#endif

#define dbq_assert(cond) arb_assert(cond)

class Itemfield_Selection;
class QueryExpr;

namespace QUERY {

    enum QUERY_MODES {
        QUERY_GENERATE,
        QUERY_ENLARGE,
        QUERY_REDUCE
    };

    enum QUERY_TYPES {
        QUERY_MARKED,
        QUERY_MATCH,
        QUERY_DONT_MATCH
    };

#define QUERY_EXPRESSIONS 3 // no of search-lines in search tool

#define QUERY_SORT_CRITERIA_BITS 7              // number of "real" sort criteria
#define QUERY_SORT_CRITERIA_MASK ((1<<QUERY_SORT_CRITERIA_BITS)-1)

    enum QUERY_RESULT_ORDER {
        QUERY_SORT_NONE = 0,

        // "real" criteria (do not change values, will break existing macro-code):
        QUERY_SORT_BY_1STFIELD_CONTENT     = 1,     // by content of first selected search field
        QUERY_SORT_BY_ID                   = 2,     // by item id (not by parent)
        QUERY_SORT_BY_NESTED_PID           = 4,     // by nested parent id
        QUERY_SORT_BY_MARKED               = 8,     // marked items first
        QUERY_SORT_BY_HIT_DESCRIPTION      = 16,    // by hit description
        QUERY_SORT_REVERSE                 = 32,    // revert following (may occur multiple times)
        QUERY_SORT_NUM_BY_1STFIELD_CONTENT = 64,    // by content of first selected search field (numerically)

    };

    class DbQuery : virtual Noncopyable {
        AwarName awar_tree_name;

    public:
        AW_window *aws;
        GBDATA    *gb_main;                                   // the main database (in merge tool: source db in left query; dest db in right query)
        GBDATA    *gb_ref;                                    // second reference database (only used by merge tool; dest db in left query; source db in right query)
        bool       expect_hit_in_ref_list;                    // merge-tool: when searching dups in fields: match only if hit exists in other DBs hitlist (true for target-DB-query)

        char *awar_keys[QUERY_EXPRESSIONS];
        char *awar_queries[QUERY_EXPRESSIONS];
        char *awar_not[QUERY_EXPRESSIONS];                       // not flags for queries
        char *awar_operator[QUERY_EXPRESSIONS];                  // not flags for queries

        char *species_name;

        char *awar_writekey;
        char *awar_writelossy;

        char *awar_protectkey;
        char *awar_setprotection;
        char *awar_setvalue;

        char *awar_parskey;
        char *awar_parsvalue;
        char *awar_parspredefined;
        char *awar_acceptConvError;
        char *awar_acceptIdMod;

        char *awar_ere;
        char *awar_where;
        char *awar_by;
        char *awar_use_tag;
        char *awar_double_pars;
        char *awar_deftag;
        char *awar_tag;
        char *awar_count;
        char *awar_sort;

        unsigned long sort_mask;                              // contains several cascading sort criteria (QUERY_SORT_CRITERIA_BITS each)

        AW_selection_list *hitlist;

        ItemSelector&  selector;
        int            select_bit;                            // one of 1 2 4 8 .. 128 (one for each query box)
        GB_HASH       *hit_description;                       // key = char* (hit item name), value = char* (description of hit - allocated!)

        DbQuery(ItemSelector& selector_)
            : selector(selector_)
        {
            dbq_assert(&selector);
        }
        ~DbQuery();

        bool is_queried(GBDATA *gb_item) const {
            return GB_user_flag(gb_item, select_bit);
        }

        const char *get_tree_name() const;
        void set_tree_awar_name(const char *tree_awar_name) { // @@@ intermediate - should be set by ctor
            awar_tree_name = tree_awar_name;
        }

        SmartPtr<QueryExpr> buildQueryExpr();
    };

};
#else
#error db_query_local.h included twice
#endif // DB_QUERY_LOCAL_H