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 = 0x00400000L, /**< 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         bool InternalInsertGhostLine (CCrystalTextView * pSource, int nLine);
  63         bool InternalDeleteGhostLine (CCrystalTextView * pSource, int nLine, int nCount);
  64 public :
  65         // Construction/destruction code
  66         CGhostTextBuffer ();
  67
  68         /**
  69         This should work in base code as ghost lines are real empty lines
  70         but maybe it doesn't (if there is an assert to check there is an EOL,
  71         or if it adds the default EOL)
  72         */
  73         virtual void GetTextWithoutEmptys (int nStartLine, int nStartChar,
  74                         int nEndLine, int nEndChar, CString &text,
  75                         CRLFSTYLE nCrlfStyle =CRLF_STYLE_AUTOMATIC,
  76                         bool bExcludeInvisibleLines = true);
  77
  78
  79         // Text modification functions
  80         virtual bool InsertText (CCrystalTextView * pSource, int nLine, int nPos,
  81                 LPCTSTR pszText, int cchText, int &nEndLine, int &nEndChar,
  82                 int nAction = CE_ACTION_UNKNOWN, bool bHistory =true);
  83         virtual bool DeleteText2 (CCrystalTextView * pSource, int nStartLine,
  84                 int nStartPos, int nEndLine, int nEndPos,
  85                 int nAction = CE_ACTION_UNKNOWN, bool bHistory =true);
  86         bool InsertGhostLine (CCrystalTextView * pSource, int nLine);
  87
  88         virtual void AddUndoRecord (bool bInsert, const CPoint & ptStartPos, const CPoint & ptEndPos,
  89                                     LPCTSTR pszText, int cchText, int nActionType = CE_ACTION_UNKNOWN, CDWordArray *paSavedRevisionNumbers = NULL);
  90         virtual UndoRecord GetUndoRecord(int nUndoPos) const;
  91
  92         virtual CDWordArray *CopyRevisionNumbers(int nStartLine, int nEndLine) const;
  93         virtual void RestoreRevisionNumbers(int nStartLine, CDWordArray *paSavedRevisionNumbers);
  94
  95 public:
  96         //@{
  97         /**
  98          * @name Real/apparent line number conversion functions.
  99          * These functions convert line numbers between file line numbers
 100          * (real line numbers) and screen line numbers (apparent line numbers).
 101          *
 102          * This mapping is needed to handle ghost lines (ones with no text or
 103          * EOL chars) which WinMerge uses for left-only or right-only lines.
 104         */
 105         int ApparentLastRealLine() const;
 106         int ComputeRealLine(int nApparentLine) const;
 107         int ComputeApparentLine(int nRealLine) const;
 108         /** richer position information   yApparent = apparent(yReal) - yGhost */
 109         int ComputeRealLineAndGhostAdjustment(int nApparentLine, int& decToReal) const;
 110         /** richer position information   yApparent = apparent(yReal) - yGhost */
 111         int ComputeApparentLine(int nRealLine, int decToReal) const;
 112         //@}
 113
 114         /** for loading file */
 115         void FinishLoading();
 116         /** for saving file */
 117         void RemoveAllGhostLines();
 118
 119
 120 private:
 121         void RecomputeRealityMapping();
 122         /** For debugging purpose */
 123         void checkFlagsFromReality(bool bFlag) const;
 124
 125 protected:
 126         virtual void OnNotifyLineHasBeenEdited(int nLine);
 127
 128
 129 protected:
 130         // Overrides
 131         // ClassWizard generated virtual function overrides
 132         //{{AFX_VIRTUAL(CCrystalTextBuffer)
 133         //}}AFX_VIRTUAL
 134
 135         // Generated message map functions
 136         //{{AFX_MSG(CCrystalTextBuffer)
 137         //}}AFX_MSG
 138
 139         DECLARE_MESSAGE_MAP ()
 140 };