Src/GhostTextBuffer.h

   1 /**
   2  * @file  GhostTextBuffer.h
   3  *
   4  * @brief Declaration of CGhostTextBuffer (subclasses CCrystalTextBuffer to handle ghost lines)
   5  */
   6 #pragma once
   7
   8 #include <vector>
   9 #include "ccrystaltextbuffer.h"
  10
  11
  12 /////////////////////////////////////////////////////////////////////////////
  13
  14 /**
  15  * We use the current ccrystalEditor flags
  16  *
  17  * This flag must be cleared and set in GhostTextBuffer.cpp
  18  * and MergeDoc.cpp (Rescan) only.
  19  *
  20  * GetLineColors (in MergeEditView) reads it to choose the line color.
  21  */
  22 enum GHOST_LINEFLAGS
  23 {
  24         LF_GHOST = 0x00400000UL, /**< Ghost line. */
  25 };
  26
  27 /////////////////////////////////////////////////////////////////////////////
  28 // CCrystalTextBuffer command target
  29
  30 /**
  31  * @brief A class handling ghost lines.
  32  * Features offered with this class :
  33  * <ul>
  34  *  <li> apparent/real line conversion
  35  *  <li> insertText/deleteText working with ghost lines
  36  *  <li> AddUndoRecord/Undo/Redo working with ghost lines
  37  *  <li> insertGhostLine function
  38  * </ul>
  39  */
  40 class EDITPADC_CLASS CGhostTextBuffer : public CCrystalTextBuffer
  41 {
  42 public:
  43         DECLARE_DYNCREATE (CGhostTextBuffer)
  44
  45 private:
  46         /**
  47          * @brief A struct mapping real lines and apparent (screen) lines.
  48          * This struct maps lines between real lines and apparent (screen) lines.
  49          * The mapping records for each text block an apparent line and matching
  50          * real line.
  51          */
  52         struct RealityBlock
  53         {
  54                 int nStartReal; /**< Start line of real block. */
  55                 int nStartApparent; /**< Start line of apparent block. */
  56                 int nCount; /**< Lines in the block. */
  57         };
  58         std::vector<RealityBlock> m_RealityBlocks; /**< Mapping of real and apparent lines. */
  59
  60         // Operations
  61 private:
  62 #if 0
  63         bool InternalInsertGhostLine (CCrystalTextView * pSource, int nLine);
  64 #endif
  65         bool InternalDeleteGhostLine (CCrystalTextView * pSource, int nLine, int nCount);
  66 public :
  67         // Construction/destruction code
  68         CGhostTextBuffer ();
  69
  70         /**
  71         This should work in base code as ghost lines are real empty lines
  72         but maybe it doesn't (if there is an assert to check there is an EOL,
  73         or if it adds the default EOL)
  74         */
  75         virtual void GetTextWithoutEmptys (int nStartLine, int nStartChar,
  76                         int nEndLine, int nEndChar, CString &text,
  77                         CRLFSTYLE nCrlfStyle =CRLF_STYLE_AUTOMATIC,
  78                         bool bExcludeInvisibleLines = true) const override;
  79
  80
  81         // Text modification functions
  82         virtual bool InsertText (CCrystalTextView * pSource, int nLine, int nPos,
  83                 LPCTSTR pszText, size_t cchText, int &nEndLine, int &nEndChar,
  84                 int nAction = CE_ACTION_UNKNOWN, bool bHistory =true) override;
  85         virtual bool DeleteText2 (CCrystalTextView * pSource, int nStartLine,
  86                 int nStartPos, int nEndLine, int nEndPos,
  87                 int nAction = CE_ACTION_UNKNOWN, bool bHistory =true) override;
  88 #if 0
  89         bool InsertGhostLine (CCrystalTextView * pSource, int nLine);
  90 #endif
  91
  92         virtual void AddUndoRecord (bool bInsert, const CPoint & ptStartPos, const CPoint & ptEndPos,
  93                                     LPCTSTR pszText, size_t cchText, int nActionType = CE_ACTION_UNKNOWN, CDWordArray *paSavedRevisionNumbers = nullptr) override;
  94         virtual UndoRecord GetUndoRecord(int nUndoPos) const override;
  95         virtual bool UndoInsert(CCrystalTextView * pSource, CPoint & ptCursorPos,
  96                                                         const CPoint apparent_ptStartPos, CPoint const apparent_ptEndPos, const UndoRecord & ur) override;
  97
  98         virtual CDWordArray *CopyRevisionNumbers(int nStartLine, int nEndLine) const override;
  99         virtual void RestoreRevisionNumbers(int nStartLine, CDWordArray *paSavedRevisionNumbers) override;
 100
 101 public:
 102         //@{
 103         /**
 104          * @name Real/apparent line number conversion functions.
 105          * These functions convert line numbers between file line numbers
 106          * (real line numbers) and screen line numbers (apparent line numbers).
 107          *
 108          * This mapping is needed to handle ghost lines (ones with no text or
 109          * EOL chars) which WinMerge uses for left-only or right-only lines.
 110         */
 111         int ApparentLastRealLine() const;
 112         int ComputeRealLine(int nApparentLine) const;
 113         int ComputeApparentLine(int nRealLine) const;
 114         /** richer position information   yApparent = apparent(yReal) - yGhost */
 115         int ComputeRealLineAndGhostAdjustment(int nApparentLine, int& decToReal) const;
 116         /** richer position information   yApparent = apparent(yReal) - yGhost */
 117         int ComputeApparentLine(int nRealLine, int decToReal) const;
 118         //@}
 119
 120         /** for loading file */
 121         void FinishLoading();
 122         /** for saving file */
 123         void RemoveAllGhostLines();
 124
 125
 126 private:
 127         void RecomputeRealityMapping();
 128         /** For debugging purpose */
 129         void checkFlagsFromReality() const;
 130
 131 protected:
 132         virtual void OnNotifyLineHasBeenEdited(int nLine);
 133
 134
 135 protected:
 136         // Overrides
 137         // ClassWizard generated virtual function overrides
 138         //{{AFX_VIRTUAL(CCrystalTextBuffer)
 139         //}}AFX_VIRTUAL
 140
 141         // Generated message map functions
 142         //{{AFX_MSG(CCrystalTextBuffer)
 143         //}}AFX_MSG
 144
 145         DECLARE_MESSAGE_MAP ()
 146 };