---

HistoryList.h

Go to the documentation of this file.

#ifndef HistoryListH
#define HistoryListH

/*******************************************************************************
Copyright 2000,2001,2002 Petr Kulhanek

    This file is part of Core plugin.

    Core plugin is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    Core plugin 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Core plugin; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*******************************************************************************/
/*******************************************************************************
** PROJEKT:             HiPoLy - HIgh POrtability LibrarY
** SOUBOR:              HistoryList
** ÚÈEL:                slouží k záznamu zmìn
** VERZE:               2.0
** JAZYK:               C++ Builder
** CÍLOVÝ POÈÍTAÈ:      IBM PC
** PROGRAMÁTOR:         Petr Kulhánek
** HISTORIE ÚPRAV:
VERZE   DATUM       POZNÁMKA
1.0     ??.??.????  vznik tøídy pro záznam zmìn
1.1     2000-09-23  drobné upravy kódu
                2000-11-02      zavedení lokalizace on-the-fly
2.0     2001-04-05  zavedená obecná èást, èást související s projektem NEMESIS
                    byla pøenesena do Core.dll
*******************************************************************************/

/* HLAVIÈKOVÉ SOUBORY *********************************************************/

#include "CoreMainHeader.h"
#include "SmallString.h"
#include "SimpleList.h"

/* KONEC HLAVIÈKOVÝCH SOUBORù *************************************************/


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

/*
ZÁKLADNÍ FILOZOFIE PRÁCE s HISTORY_LISTEM

Každá zmìna je charakterizovaná tøídou, která obsahuje data, pomocí nichž lze
zmìnu rekonstruovat. Každá tato tøída se odvozuje buï od CHistoryRecord nebo
od CElementsRecord.
CHistoryRecord -    se použije jako bázová tøída v pøípadì, že zmìna je malá a
                    jednoduše popsatelná. napø. zmìna jména, øádu vazby aj.
    Tato tøída je ve verzi 1.1 zrušena a vše pøebírá CElementData

CElementsRecord -   se použije u složitých zmìn nebo složenin zmìn.
                    napø.: pøi strukturních zmìnách (mazání atomu, vložení
                    struktury), popø. pokud chceme, aby sbirka zmìn (napø. zmìna
                    jména nìkolika objektù) byla zaznamenána jako jedna
                    registrovaná zmìna.
POZOR: Pro identifikaci objektu používejte vždy hodnotu vrácenou funkci GetIndex(),
pouze toto èíslo jednoznaène identifikuje objekt. (objekty se mohou bìhem zmìn
vytváøet nebo odstraòovat).

Každá z tìchto tøíd má dvì èisté virtuální funkce:
Forward()   - provede zmìnu objektu ve smìru provedené zmìny (tedy REDO), pokud
              však vzniká nebo zaniká objekt má bez ohledu na charakter zmìny
              význam konstrukce objektu
Backward()  - provede zmìnu objektu ve smìru opaèném vùèi provedené zmìnì (tedy
              UNDO), pokud však vzniká nebo zaniká objekt má bez ohledu na
              charakter zmìny význam destrukce objektu
V pøípadì konstrukce a destrukce objektu reálný smìr zmìny, je urèen hodnotou
Create - TRUE - ve smìru Forward(konstrukce)
       - FALSE - ve smìru Backward(destrukce)
POZOR: bìhem konstrukce a destrukce se musí zachovat UIndex objektu (hodnota
vrácená funkci GetIndex()

Záznam zmìn je inkrementální a proto je nutné, aby se zajistila úplná zpìtnost
obnovy dat.

*/

/* DEFINICE TØÍD **************************************************************/


class NEMESIS_CORE_PACKAGE CElementData{
    public:
         __fastcall CElementData(bool forward_direction);
         virtual __fastcall ~CElementData(void);
    void __fastcall MakeChange(void);  // provede zmìnu ve správném smìru
    bool __fastcall IsInForwardDirection(void);
    
    private:
    virtual void __fastcall Forward(void)=0;   // vpøed
    virtual void __fastcall Backward(void)=0;  // vzad
    bool            ForwardDirection;      // konstrukce pøi dopøedném smìru?
    };

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


class NEMESIS_CORE_PACKAGE CElementsRecord : public CElementData{
    public:

 // konstruktor a destruktor ---------------------------------------------------
        __fastcall CElementsRecord(bool forward_direction,const CSmallString& change_tag);
        virtual __fastcall ~CElementsRecord(void);

 // registrace elementární zmìny -----------------------------------------------
    void __fastcall Register(CElementData* data);       // registruje elementarní data

 // vrací popis zmìny v daných smìrech -----------------------------------------
    CSmallString __fastcall GetUndoDescription(void);           // dlouhý popis - plnì popisuje zmìnu
    CSmallString __fastcall GetRedoDescription(void);

    CSmallString __fastcall GetShortUndoDescription(void); // krátký popis - výstižné vyjádøení zmìny
    CSmallString __fastcall GetShortRedoDescription(void);

    inline void  __fastcall SetChangeTag(const CSmallString& tag);

 // sekce soukromých dat -------------------------------------------------------
    private:
    CSmallString                                ChangeTag;              // jednoznaèný popisovaè formátovacího tagu

    CSimpleList<CElementData>   Elements;       // elementární data
    int                         NumOfCopies;    // poèet zrcadlených duplikátù
    CElementsRecord*            Original;

    void    __fastcall Destroy(void);   // odstraní objekt pokud NumOfCopies == 0
    // zjištìní popisu ---------------------------------------------------------

    virtual CSmallString __fastcall GetDescription(const CSmallString& format);
    virtual void __fastcall Forward(void);   // vpøed
    virtual void __fastcall Backward(void);  // vzad

    friend class CHistoryList;
    };

//------------------------------------------------------------------------------
// #############################################################################
//------------------------------------------------------------------------------

enum EChangeMessage{
    OTHER,
    HISTORY_UNDO,               // provedeno undo
    HISTORY_REDO,               // provedeno redo
    HISTORY_BUFFER_CHANGE,      // zmìnìn obsah bufferu bez zmìny struktury
    DATA_WERE_SAVED,            // data byla uložena
    };


typedef void __fastcall (__closure * _FChange)(EChangeMessage message);

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


class NEMESIS_CORE_PACKAGE CHistoryList{
    public:
    enum EUndoMode{
        Mode_1,
        Mode_2,
        };

 // metody - konstruktor a destruktor ------------------------------------------
    __fastcall CHistoryList(void);
    __fastcall ~CHistoryList(void);

 // metody - nastavení hloubky zmìn --------------------------------------------
    void __fastcall SetDepthOfBuffer(int depth);
    void __fastcall SetUndoMode(EUndoMode mode);
    void __fastcall RemoveAllRecords(void);

 // metody - uzamèení - nastavení úrovnì uzamèení ------------------------------
    void        __fastcall SetLockModeLevel(int level);
    int         __fastcall GetLockModeLevel(void) const;

 // metody - exekuce - provedení zmìn v daném smìru ----------------------------
    bool __fastcall Undo(int i=0);   // undo i - hloubka zmìny
    bool __fastcall Redo(int i=0);   // redo i - hloubka zmìny

 // metody - iterace popisu zmìn -----------------------------------------------
    bool __fastcall GetFirstUndoName(CSmallString& text,bool short_type=true); // zjištuje jména zmìn
    bool __fastcall GetNextUndoName(CSmallString& text,bool short_type=true);
    bool __fastcall GetFirstRedoName(CSmallString& text,bool short_type=true);
    bool __fastcall GetNextRedoName(CSmallString& text,bool short_type=true);

 // metody - popis aktivních zmìn ----------------------------------------------
    bool  __fastcall IsUndoActive(void);            // urèuje stav undo a redo bufferù
    bool  __fastcall IsRedoActive(void);

 // metody - exekuce záznamu zmìn ----------------------------------------------
    bool __fastcall BeginChange(int lockmodelevel);              // metody pro záznam zmìn
    void __fastcall RegisterChange(CElementsRecord *record);
    void __fastcall EndChange(void);

 // událost - zmìna seznamu zmìn
    __property _FChange OnChange = {read = ChangeFce,write = ChangeFce};

 // sekce soukromých dat -------------------------------------------------------
    private:
    CSimpleList<CElementsRecord>                Histories; // seznam zmìn
    CSimpleList<CElementsRecord>                RegHistories; // seznam zmìn v RegisterChange


    CSimpleIterator<CElementsRecord>    UndoIter;  // iterátor pro získání popisù zmìn
    CSimpleIterator<CElementsRecord>    RedoIter;  // iterátor pro získání popisù zmìn

    int         LockModeLevel;          // úroveò uzamèení
    EUndoMode   UndoMode;           // typ undo

    bool    RedoStatus;             // urèuje zda je povolen redo
    int         RedoIterCounter;        // pomocná promìnná pro získávání popisu pro redo
    int     NumOfRedo;              // poèet realizovatelných redo zmìn
    int     NumOfMaxChanges;        // maximální poèet zmìn

    _FChange    ChangeFce;

    void __fastcall     OnChangeStatus(EChangeMessage message);
    };

/* KONEC DEFINICE TØÍD ********************************************************/

inline void  __fastcall CElementsRecord::SetChangeTag(const CSmallString& tag)
{
 ChangeTag = tag;
}

#endif
 

---