BiblIndex.h

Go to the documentation of this file.

//
// Created by sokirko on 12.10.19.
//

#ifndef PROJECT_BIBLINDEX_H
#define PROJECT_BIBLINDEX_H

#include "BiblExpander.h"
#include "ConcCommon.h"
#include "MorphXmlToken.h"
#include "Bibliography.h"
#include "FreeBiblIndex.h"

typedef ddcVecFile<DWORD> ddcDateVector;


const int UnknownTextAreaNo = -1;


class CBiblIndex {
    //--------------------------------------------------------------
    class CTextArea {
    public:
        string m_TextAreaName;
        string m_Xpath;
    };
private:
    bool m_bMemoryMap;
    ddcFileOrMMap m_BiblBodyFile;
    RML_RE::Options m_RegexOpts;
    vector<CTextArea> m_TextAreas;

    string ReadFromFile(file_off_t start, size_t nbytes) const;
protected:


    //--------------------------------------------------------------
    typedef map<string, CFreeBiblIndex *> FreeBiblStringMap;
    typedef map<string, string> FreeBiblAliasMap;
    typedef map<string, CBiblExpander *> BiblExpanderMap;

protected:
    FreeBiblStringMap m_FreeBiblIndices;
    FreeBiblAliasMap m_FreeBiblAlias;
    BiblExpanderMap m_BiblExpanders;
    map<string, size_t> m_FreeBiblNameToPosition; // map from name to CBibliography::m_BiblAttribs positions

    ddcVecFile<file_off_t> m_EndOffsetsInBiblFile;
    ddcDateVector m_Dates;
    string m_Path;
    string m_OrigXPath;
    string m_ScanXPath;
    string m_DateXPath;
    string m_StartPageXPath;
public:
    string m_DefaultAttrName;


public:
    CBiblIndex();

    void FreeBiblIndices();

    void FreeBiblExpanders();

    bool RegisterFreeBiblAttributes(string fields, string &ErrorStr);

    bool RegisterTextAreas(string fields, string &ErrorStr);

    string GetFreeBibiAttributesDescr() const;

    string GetTextAreasDescr() const;

    void SetPath(string ProjectFileName);

    void LoadBibl(string Path, size_t FileBreaksSize, bool useMMap = false);

    CBibliography GetFullBibliographyOfHit(size_t FileNo) const;

    string GetBiblIndexFileName() const;

    string GetBiblFileName() const;

    string GetBiblDateIndexFileName() const;

    int GetTextAreaByName(const string &Name) const;

    CFreeBiblIndex *GetFreeBiblIndex(const string &FreeBiblAttribNameOrAlias) const;

    CBiblExpander *GetBiblExpander(const string &ExpanderName) const;

    bool GetFilterBounds(CDDCFilterWithBounds &Filter, const string &LoValue, const string &HiValue) const;

    bool GetFilterValue(CDDCFilterWithBounds &Filter, const string &Value) const;

    bool GetFilterValues(CDDCFilterWithBounds &Filter, const string &Regex) const;

    bool GetFilterValues(CDDCFilterWithBounds &Filter, const set<string> &Values) const;

    void GetTextAreaElements(const TiXmlDocument &doc, vector<TiXmlElement *> &Result) const;

    size_t GetTextAreasCount() const;

    //int ProcessTextAreaNoInQueryStr(string& Query) const;

    int WithinTextArea(const vector<string> &Within) const;

    void InitNoSort(vector<CHit> &Hits) const;

    void InitSortByDate(vector<CHit> &Hits) const;

    void InitSortByBiblIntegerField(string FreeBiblAttribNameOrAlias, vector<CHit> &Hits) const;

    bool IsRegisteredBiblField(const string &FreeBiblAttribNameOrAlias) const;

    CFreeBiblIndexTypeId GetBiblFieldTypeId(const string &FreeBiblAttribName) const;

    string FreeBiblMapToJson(bool useUtf) const;
    string FreeBiblAliasMapToJson() const;
    string BiblExpanderMapToJson() const;


    const ddcDateVector &GetDates() const { return m_Dates; };

    bool HasFreeBiblIndex(const string &name) const {return GetFreeBiblIndex(name) != 0;};

    bool HasBiblExpander(const string &ExpanderName) const {return GetBiblExpander(ExpanderName) != 0;};

    const CFreeBiblIndexInterface* GetFreeBiblIndexConst(const string &name) const {
        return GetFreeBiblIndex(name);
    };
    void SetRegexOptions(const RML_RE::Options &opts);

    string GetVisibleFreeHeaderBiblAttributes(size_t FileNo, string Delim) const;

    string GetFreeHeaderBiblAttributesWithNames(size_t FileNo, char Delim) const;

    string
    GetFreeHeaderBiblAttributesJson(size_t FileNo, bool assume_utf8 = true, bool include_invisible = false) const;

    string
    GetFreeHeaderBiblAttributesTabsDump(size_t FileNo, bool assume_utf8 = true, bool include_invisible = false) const;

    bool FileMatches(DWORD FileNo, const vector<CDDCFilterWithBounds> &Filters) const;

    CBiblExpander *AddBiblExpander(const string &spec);

};


#endif //PROJECT_BIBLINDEX_H

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