HitBorder.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.
// 
//  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 HitBorder_h
#define HitBorder_h

#include "../CommonLib/ddcMMap.h"

typedef ddcVecFile<CTokenNo> ddcBreakVector;

struct CPageNumber {
    CTokenNo m_StartTokenNo;
    DWORD m_PageNumber;

    CPageNumber(CTokenNo StartTokenNo = 0, DWORD PageNumber = 0)
        : m_StartTokenNo(StartTokenNo), m_PageNumber(PageNumber) {};

    inline bool operator<(const CPageNumber &X) const {
        return ((m_StartTokenNo < X.m_StartTokenNo)
                || (m_StartTokenNo == X.m_StartTokenNo && m_PageNumber < X.m_PageNumber));
    };
};


class CHitBorders {
public:
    struct CBreakCollection {
        string m_ShortName;
        string m_LongName;

        mutable FILE *m_FileForIndexing;

        ddcBreakVector m_BreakOffsets;

        CBreakCollection(const string &ShortName, const string &LongName);

        string GetBreakFileName(string Path) const;

        void ReadFromDisk(string Path, bool useMMap = false);

        bool ClearAll(string Path);

        void CloseFileForIndexing();

        void AppendBreaks(const ddcBreakVector &From, CTokenNo Offset = 0);

        void SaveToFile(const string &FileName);
    };

protected:
    vector<CBreakCollection> m_Breaks;

    map<string, int> m_ShortName2BreakCollection;

    map<string, int> m_LongName2BreakCollection;

    int m_FileBreakCollectionNo;
    string m_DefaultBreakName;

    ddcVecFile<CPageNumber> m_PageBreaks;


    string GetPageBreaksFileName(string Path) const;

    string GetShortNameByName(const string &BreakName) const;

    vector<DWORD> m_LastTextAreaBreaks;

protected:
    bool StartIndexing(string Path);

    bool RemoveHitBordersFileAndClear(string Path);

    void AddPageBreak(const CPageNumber &P);

    void SavePageBreaks(const string &ProjectPath);

    int RegisterBreak(string ShortName, string LongName);

    int EnsureRegisteredBreak(string ShortName, string LongName);

    int GetBreakCollectionIndexByName(string ShortName) const;

    void AddBreakByIndex(DWORD BreakCollectionNo, const CTokenNo &B);

public:
    const CBreakCollection *GetBreakCollectionByName(const string &Name) const;


    const vector<CBreakCollection> &GetBreaks(void) const { return m_Breaks; };

public:

    CHitBorders();

    string GetBorderIndicesString() const;

    string WithinBreakName(const vector<string> &Within) const;

    const ddcBreakVector *GetBreaksByName(const string &ShortName) const;

    CTokenNo GetCorpusEndTokenNo() const;

    const ddcBreakVector &GetFileBreaks() const;

    CTokenNo GetFileStartTokenNo(size_t FileNo) const;

    DWORD GetPageNumber(size_t No) const;

    bool IsRegisteredBreak(const string &ShortName) const;

    void RegisterBorderIndices(const char *IndicesStr);

    bool LoadHitBorders(string Path, bool useMMap = false);

    void ConvertHitsToPageBreaks(vector<CHit>::const_iterator hits_begin, vector<CHit>::const_iterator hits_end,
                                 const ddcBreakVector &Breaks, DwordVector &PageBreaks) const;

    ddcVecFile<CPageNumber>::const_iterator GetTokenPageBreak(CTokenNo tok) const;

    void AddBreakByName(const string &ShortName, const CTokenNo &B);

    void BordersEndIndexing(string Path);

    void StartTextAreaBorders();

    void EndTextAreaBorders(DWORD TextAreaEndTokenNo);

};

typedef struct CHitBorders::CBreakCollection CHBreakCollection;


#endif

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