Concordance.h

Go to the documentation of this file.

//-*- Mode: C++ -*-

//  DDC originally by Alexey Sokirko
//  Changes and modifications 2011-2019 by Bryan Jurish
//
//  This file is part of DDC.
// 
//  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 Concordance_h
#define Concordance_h


#include "ConcCommon.h"
#include "ConcXml.h"
#include "StringIndexator.h"
#include "HitBorder.h"
#include "TermExpander.h"
#include "../CommonLib/ddcCorpusList.h"


struct CHighlightTags {
    bool m_bWasReadFromString;
    string m_FirstOpener;
    string m_FirstCloser;
    string m_RestOpener;
    string m_RestCloser;

    CHighlightTags();

    bool ReadFromString(const string &s);

    string ToString() const;
};


class CSourceFileHolder {
protected:
    vector<string> m_SourceFiles;
    bool m_bModifiedListOfFiles;

public:
    CSourceFileHolder();

    bool SaveSourceFileList(string FileName);

    void DeleteSourceFile(long ItemNo);

    void AddSourceFile(const char *FileName);

    void DeleteAllSourceFiles();

    size_t GetSourceFilesCount() const;

    string GetSourceFile(size_t FileNo) const;

    void AddSourceFilesFrom(const CSourceFileHolder &X);

    void ReadSourceFileList(string FileName);

    int FoundNotExistedFile() const;


    bool IsModified() const;

};


class CDwdsThesaurus;

/* CIndexDumpFormat : enum for index-dump formats */
typedef enum CIndexDumpFormatE {
    idfUnknown,
    idfJson,
    idfTabs,
    idfTabsStream
} CIndexDumpFormat;

/* CMaskedFileSet : type for CConcIndexator::m_MaskedFiles */
typedef set<CFileNo> CMaskedFileSet;

class CConcordance : public CStringIndexator, public CHitBorders, public CSourceFileHolder {


    vector<BYTE> m_PcreCharacterTables;

    bool m_bDwdsCorpusInterface;
    bool m_bGutenbergInterface;
    bool m_bNoContextOperator;
    bool m_bOutputBibliographyOfHits;

    string m_InternetPathPrefix;
    string m_LocalPathPrefix;
    string m_CommonFilePrefix;




    string GetBiblIndexFileName() const;

    string GetBiblFileName() const;



    bool HasEqualOptions(const CConcordance &X) const;

    const char *GetIndexTypeStr() const;

    bool ReadIndexTypeFromStr(const string &s);

    void DumpFileIndexTabs(DWORD FileNo, FILE *f) const;

protected:
    enum DDCIndexTypeEnum {
        DWDS_Index,
        MorphXML_Index,
        Free_Index,
        TabFormat_Index

    };
    DDCIndexTypeEnum m_IndexType;
    bool m_bIndexPunctuation;
    bool m_bUseParagraphTagToDivide;
    bool m_bEmptyLineIsSentenceDelim;
    bool m_bUseIndention;
    DWORD m_UserMaxTokenCountInOnePeriod;
    DWORD m_UserMaxInputLoadIndexSize;
    bool m_bUseDwdsThesaurus;

    void AssertHasPath() const;

    void LoadOptionsFromString(string Options);

    void InitDefaultOptions();
    string SaveOptionsToString() const;

public:
    MorphLanguageEnum m_Language;
    bool m_bIndexMorphPatterns;
    bool m_bIndexChunks;
    bool m_bCaseSensitive;
    bool m_bShowNumberOfRelevantDocuments;
    bool m_bQueryOnlyFiles;
    bool m_bArchiveIndex;
    bool m_bResumeOnIndexErrors;

    ddcCorpusList<> m_CorpusFiles;

    CMaskedFileSet m_MaskedFiles;

    CConcXml m_BiblIndex;

    CHighlightTags m_HtmlHighlighting;

    CHighlightTags m_TextHighlighting;

    CHighlightTags m_TableHighlighting;

    bool m_bDisableDefaultQueryLexicalExpansion;
    int m_LeftKwicContextSize;
    int m_RightKwicContextSize;
    int m_NumberOfKwicLinesInSnippets;
    double m_TfIdfRank;
    double m_NearRank;
    double m_PositionRank;
    string m_InterpDelimiter;
    string m_TokenDelimiter;

    bool m_Utf8;

    bool m_bAllowUnsafeQueries;

    bool m_bAllowCountByTokenAttributes;

    bool m_bLemmaQueryUsesMorphPattern;

    vector<size_t> m_IndicesToShow;

    time_t m_Timestamp;

    size_t m_MaxCachedHitsCount;

    size_t m_MaxQueryCacheSize;

    TxDispatcher m_Txd;

    map<string, string> m_OpDefaultIndexNames;

    map<string, pair<bool, string> > m_ServerInfo;

    CConcordance();

    ~CConcordance();

    void RegisterIndicesToShow(const string &IndexListStr);

    string GetIndicesToShowStr(bool Positional = false) const;

    /*
    //const vector<BYTE>& GetRegExpTables() const { if (m_Utf8) return NULL; return m_PcreCharacterTables; };
    const BYTE* GetRegexTables() const { if (m_Utf8) return NULL; return m_PcreCharacterTables.data(); };

    const pcrecpp::RE_Options GetRegexOptions() const { if (m_Utf8) return pcrecpp::UTF8(); return pcrecpp::RE_Options(); }
    */
    RML_RE::Options GetRegexOptions() const {
        if (m_Utf8)
            return RML_RE::Options(pcrecpp::UTF8(), NULL);
        else
            return RML_RE::Options(pcrecpp::RE_Options(), m_PcreCharacterTables.data());
    };

    bool IsDwdsCorpusInterface() const { return m_bDwdsCorpusInterface; };

    bool IsGutenbergInterface() const { return m_bGutenbergInterface; };

    bool HasContextOperator() const { return !m_bNoContextOperator; };

    bool UseDwdsThesaurus() const { return m_bUseDwdsThesaurus; };

    bool OutputBibliographyOfHits() const { return m_bOutputBibliographyOfHits; };

    bool IndexPunctuation() const { return m_bIndexPunctuation; };

    string GetHtmlReference(size_t posFile) const;

    string GetShortFilename(size_t posFile) const;

    string GetFileNameForCorpusFileNames() const;

    string GetFileNameForMaskedFiles() const;

    string GetFileNameForMaskedFileIds() const;

    vector<string> GetTokenFields(const COutputToken &tok);

    inline size_t GetCorpusFilesCount() const { return m_CorpusFiles.size(); };

    inline string GetCorpusFile(CFileNo FileNo) const { return m_CorpusFiles[FileNo]; };

    inline size_t GetMaskedFilesCount() const { return m_MaskedFiles.size(); };

    void LoadSourceFilesAndOptions(string FileName, bool reallyReadSourceFiles = true);

    void LoadCorpusFiles();

    string GetCommonFilePrefix() const;

    void LoadMaskedFiles();

    void LoadOptionsFromFile(const string &OptFile);

    void LoadProject(string FileName, bool includeSourceFiles = true);

    time_t UpdateTimestamp(const char *filename);

    void DumpBibliography(FILE *f = stdout) const;

    string DumpFileBibliography(DWORD FileNo) const;

    void DumpFileIndexJson(DWORD FileNo, FILE *f = stdout) const;


    void DumpIndex(string dirname, CIndexDumpFormat fmt = idfJson) const;

    void DumpIndexToSingleTabFile(FILE *outfp) const;

    bool SaveOptions(string FileName) const;

    bool GetAllOccurrences(vector<CTokenNo> &occurrences, size_t searchPeriodNo) const;

    bool GetOccurrencesByPosition(const string &BreakName, int anchor, vector<CTokenNo> &occurrences,
                                  size_t searchPeriodNo) const;
    bool UseTabFormatForLoading () const {return m_IndexType == TabFormat_Index;}
};


#endif 

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