ConcSession.h

Go to the documentation of this file.

//*-*- Mode: C++ -*- */
//
//  DDC originally by Alexey Sokirko
//  Changes and modifications 2011-2018 by Bryan Jurish
//
//  This file is part of DDC (formerly ConcHolder.h)
// 
//  DDC is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
// 
//  DDC 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 Lesser General Public License for more details.
// 
//  You should have received a copy of the GNU Lesser General Public License
//  along with DDC.  If not, see <http://www.gnu.org/licenses/>.
//
#ifndef DDC_CONC_SESSION_H
#define DDC_CONC_SESSION_H

#include "ConcIndexatorInvoker.h"
#include "QueryResult.h"
#include "NavHint.h"
#include "../CommonLib/ddcRandom.h"

//==============================================================================
// Typedefs & Forward Declarations

typedef bool (*SaveTriggerType) (const string&,DWORD LParam);

class  CConcSessionContext; //-- forward decl
class  CQueryCompiler;      //-- forward decl
class  CQuery;              //-- forward decl

//==============================================================================
// Classes & Structs 

//----------------------------------------------------------------------
class CConcSession : public ConcIndexatorInvoker, public CQueryResult
{
public:
    //------------------------------------------------------

    CConcSessionContext*            m_pSessionContext;

    bool                            m_bSessionMaster;

    size_t                          m_WorkerId;

    CQueryCompiler*                 m_pQueryCompiler;

    DDCRandom *m_pRandom;

    time_t                          m_QueryEndTime;

    const ddcBreakVector*   m_pBreaks;

    DDCFormatTypeEnum               m_ResultFormat;

public:
    //------------------------------------------------------

    unsigned int m_RandomSeed;

    mutable CShortOccurCacheMap             m_ShortOccurCaches;

    string                                  m_QueryResultStr;

    string                                  m_ErrorStr;

    CConcordance*                           m_pConcordance;

    size_t                                  m_ResultOffset;

    size_t                                  m_ResultLimit;

    string                                  m_ResultMinKey;

    string                                  m_RequestPath;

    size_t                                  m_CurrentSearchPeriodNo;

    string                                  m_AdditionalHitDelimiter;


        
    //------------------------------------------------------

    void    AddFileReference(const long FileNo);
    void    ShowBibliographyForTextOrHtml(const CHit& Hit, DWORD PageNumber);
    bool    ShowBibliographyForTable(DWORD PageNumber, const CHit& Hit, const vector<COutputToken>& Tokens);
    bool    GenerateOneHitString(DWORD PageNumber, const CHit& Hit, const vector<COutputToken>& Tokens);
    bool    GenerateOneHitStringJson(DWORD PageNumber, const CHit& Hit, const vector<COutputToken>& Tokens);
    bool    GetContext(int  StartBreakNo, int  EndBreakNo, const DWORD CurrFileNo, const bool bConvertASCIIToHtmlSymbols, string& Result) const;
    bool    GetContextJson(int  StartBreakNo, int  EndBreakNo, const DWORD CurrFileNo, string& js) const;

    DDCErrorEnum GetAllHits(const string &Query, size_t Start, size_t Limit);

    DDCErrorEnum    GetAllHits(CQuery *QueryRoot, size_t Start, size_t Limit);

    bool IsUniversalCountQuery(CQuery *QueryRoot) const;

    bool    TryToGetFromCache(const string &Query,  DWORD& EndHitNo);

    void    SaveToCache(const string& Query,  vector<size_t>::const_iterator start, vector<size_t>::const_iterator end);

    void    SetHitType();

    bool    GetFileSnippets(const int HitNo, vector<COutputToken>& Tokens)  const;
    bool    SaveOccurrences(const vector<DWORD>& ChunkLengths,  int ContextSize, const vector<CTokenNo>& Occurrences,  const vector<CHit>& Hits, SaveTriggerType SaveTrigger,DWORD LParam); 
    bool    GetTokensFromStorageByBreak(size_t IndexNo, size_t BreakNo, vector<COutputToken>& Tokens) const;
    void InitFileReferences(vector<CHit>&   Hits) const;

    void    InitSortKeyForHits(const CQuery *pQuery, const CDDCFilterWithBounds& Filter, vector<size_t>& PeriodHitsIndex);
    void    InitSortByRank(const CQuery *pQuery) const;
    void    InitSortBySize(const CQuery *pQuery) const;
    void    InitSortByRandom(const CQuery *pQuery) const;
    void    InitSortByContext(const CQuery *pQuery, const CDDCFilterWithBounds& Filter) const;

    void SortKeyLB(CHitSortKey &key, const CDDCFilterWithBounds& Filter);

public:
    //------------------------------------------------------


    CConcSession(CConcSessionContext *SessionContext=NULL);

    ~CConcSession();

    //------------------------------------------------------


    CConcSession* WorkerClone(size_t WorkerId);

    void WorkerCloneFree();

    int LockSessionContext();

    int UnlockSessionContext();

    void ClearQueryCache();

    size_t CacheSize(void) const;

    //------------------------------------------------------

        
    const ddcBreakVector& GetBreaks() const;

    DDCFormatTypeEnum       GetResultFormat() const { return m_ResultFormat; };

    string                  GetResultFormatStr() const;

    void                    SetResultFormat(string ResultTypeStr);

    DDCErrorEnum            GetOccurrences(const string &Query, int ContextSize, SaveTriggerType SaveTrigger,DWORD LParam);
                


    DDCErrorEnum    SimpleQuery(const string &Query, DWORD& EndHitNo, DWORD& HitsCount);

    DDCErrorEnum    GetHits(const string &QueryStr, DWORD& EndHitNo);

    DDCErrorEnum    GetHits(CQuery *QueryRoot,  DWORD& EndHitNo);

    DDCErrorEnum    GetHits(CQuery *QueryRoot,  DWORD& EndHitNo, const string &QueryStr);

    DDCErrorEnum    GenerateHitStrings(const int StartHitNo, bool UseAdditionalHitDelimiter=true);

    DDCErrorEnum    GenerateCountStrings(const int StartHitNo, bool UseAdditionalHitDelimiter=true);

    size_t GetOffsetHint(const size_t StartHitNo) const;

    string GetSortKeyHint(const size_t StartHitNo) const;

    string GetHitIds()  const;

    string GetCountIds()  const;

    HitSortOrderEnum HitSortOrder() const;

    void SetTimeOut(int TimeOut);

    void ClearQuery();

    int GetTextArea() const;

    void ClearQueryResults();

    static DDCFormatTypeEnum GetResultFormatByString(const string& ResultTypeStr );

    static void DecorateQueryResults(const string& ResultTypeStr, string& QueryResultString);

    bool HasRankOrderOperator() const;

    bool HasMatchIdOperator() const;

    int GetBreakStarterLength() const;

    string BuildJsonContextString (const vector<COutputToken>& Tokens, bool doHighlight=true) const;

    string CanonicalQueryString(const string &Query);

    string JsonQueryString(const string &Query);

    void SetRandomSeed(unsigned int seed1=0) const;

    inline TxDispatcher* GetTxDispatcher() const
    { return &(m_pConcordance->m_Txd); };
};



#endif

/*--- emacs style variables ---
 * Local Variables:
 *  mode: C++
 *  c-file-style: "ellemtel"
 *  c-basic-offset: 4
 *  tab-width: 8
 *  indent-tabs-mode: nil
 * End:
 */