Src/MergeDoc.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 //    WinMerge:  an interactive diff/merge utility
   3 //    Copyright (C) 1997  Dean P. Grimm
   4 //    SPDX-License-Identifier: GPL-2.0-or-later
   5 /////////////////////////////////////////////////////////////////////////////
   6 /**
   7  * @file  MergeDoc.h
   8  *
   9  * @brief Declaration of CMergeDoc class
  10  */
  11 #pragma once
  12
  13 #include "DiffTextBuffer.h"
  14 #include <vector>
  15 #include <map>
  16 #include <memory>
  17 #include <optional>
  18 #include "DiffWrapper.h"
  19 #include "DiffList.h"
  20 #include "TempFile.h"
  21 #include "PathContext.h"
  22 #include "IMergeDoc.h"
  23
  24 /**
  25  * @brief Additional action codes for WinMerge.
  26  * @note Reserve first 100 for CrystalEditor
  27  */
  28 enum
  29 {
  30         CE_ACTION_MERGE = 100, /**< Merging action */
  31 };
  32
  33 /**
  34  * @brief Return statuses of file rescan
  35  */
  36 enum
  37 {
  38         RESCAN_OK = 0, /**< Rescan succeeded */
  39         RESCAN_SUPPRESSED, /**< Rescan not done - suppressed */
  40         RESCAN_FILE_ERR, /**< Error reading file */
  41         RESCAN_TEMP_ERR, /**< Error saving to temp file */
  42 };
  43
  44 /**
  45  * @brief File saving statuses
  46  */
  47 enum
  48 {
  49         SAVE_DONE = 0, /**< Saving succeeded */
  50         SAVE_FAILED, /**< Saving failed */
  51         SAVE_PACK_FAILED, /**< Plugin failed to pack file */
  52         SAVE_NO_FILENAME, /**< File has no filename */
  53         SAVE_CANCELLED, /**< Saving was cancelled */
  54 };
  55
  56 /**
  57  * @brief Types for buffer. Buffer's type defines behavior
  58  * of buffer when saving etc.
  59  *
  60  * Difference between BUFFERTYPE::NORMAL and BUFFERTYPE::NORMAL_NAMED is
  61  * that _NAMED has description text given and which is shown
  62  * instead of filename.
  63  *
  64  * BUFFERTYPE::UNNAMED is created empty buffer (scratchpad), it has
  65  * no filename, and default description is given for it. After
  66  * this buffer is saved it becomes _SAVED. It is not equal to
  67  * NORMAL_NAMED, since scratchpads don't have plugins etc.
  68  */
  69 enum class BUFFERTYPE
  70 {
  71         NORMAL = 0, /**< Normal, file loaded from disk */
  72         NORMAL_NAMED, /**< Normal, description given */
  73         UNNAMED, /**< Empty, created buffer */
  74         UNNAMED_SAVED, /**< Empty buffer saved with filename */
  75 };
  76
  77 struct WordDiff {
  78         std::array<int, 3> begin; // 0-based, eg, begin[0] is from str1
  79         std::array<int, 3> end; // 0-based, eg, end[1] is from str2
  80         std::array<int, 3> beginline;
  81         std::array<int, 3> endline;
  82         int op;
  83
  84         WordDiff(int s1=0, int e1=0, int bl1=0, int el1=0, int s2=0, int e2=0, int bl2=0, int el2=0, int s3=0, int e3=0, int bl3=0, int el3=0, int op=0)
  85                 : begin{s1, s2, s3}
  86                 , beginline{bl1, bl2, bl3}
  87                 , endline{el1, el2, el3}
  88                 , op(op)
  89         {
  90                 if (s1>e1) e1=s1;
  91                 if (s2>e2) e2=s2;
  92                 if (s3>e3) e3=s3;
  93                 end[0] = e1;
  94                 end[1] = e2;
  95                 end[2] = e3;
  96         }
  97         WordDiff(const WordDiff & src)
  98                 : begin{src.begin}
  99                 , end{src.end}
 100                 , beginline{src.beginline}
 101                 , endline{src.endline}
 102                 , op(src.op)
 103         {
 104         }
 105 };
 106
 107 struct CurrentWordDiff
 108 {
 109         int nDiff;
 110         size_t nWordDiff;
 111         int nPane;
 112         CPoint ptStart;
 113         CPoint ptEnd;
 114 };
 115
 116 struct DiffFileInfo;
 117 class CMergeEditView;
 118 class PackingInfo;
 119 class PrediffingInfo;
 120 class CMergeEditFrame;
 121 class CDirDoc;
 122 class CEncodingErrorBar;
 123 class CLocationView;
 124
 125 /**
 126  * @brief Document class for merging two files
 127  */
 128 class CMergeDoc : public CDocument, public IMergeDoc
 129 {
 130 public:
 131 // Attributes
 132 public:
 133         static int m_nBuffersTemp;
 134
 135 // Begin declaration of CMergeDoc
 136
 137         std::unique_ptr<CDiffTextBuffer> m_ptBuf[3]; /**< Left/Middle/Right side text buffer */
 138         int m_nBuffers;
 139         int m_nGroups;
 140
 141 protected: // create from serialization only
 142         CMergeDoc();
 143         DECLARE_DYNCREATE(CMergeDoc)
 144
 145         // Operations
 146 public:
 147         std::unique_ptr<DiffFileInfo> m_pSaveFileInfo[3];
 148         std::unique_ptr<DiffFileInfo> m_pRescanFileInfo[3];
 149         DiffList m_diffList;
 150         UINT m_nTrivialDiffs; /**< Amount of trivial (ignored) diffs */
 151         PathContext m_filePaths; /**< Filepaths for this document */
 152         /// String of concatenated filenames as text to apply plugins filter to
 153         String m_strBothFilenames;
 154
 155         CMergeEditView * GetActiveMergeView();
 156         CMergeEditView * GetActiveMergeGroupView(int nBuffer);
 157         void UpdateHeaderPath(int pane);
 158         void UpdateHeaderActivity(int pane, bool bActivate);
 159         void RefreshOptions();
 160         void UpdateResources();
 161         bool OpenDocs(int nFiles, const FileLocation fileloc[],
 162                 const bool bRO[], const String strDesc[]);
 163         int LoadFile(CString sFileName, int nBuffer, bool & readOnly, const FileTextEncoding & encoding);
 164         void MoveOnLoad(int nPane = -1, int nLinIndex = -1);
 165         void ChangeFile(int nBuffer, const String& path, int nLineIndex = -1);
 166         void RescanIfNeeded(float timeOutInSecond);
 167         int Rescan(bool &bBinary, IDENTLEVEL &identical, bool bForced = false);
 168         void CheckFileChanged(void) override;
 169         int ShowMessageBox(const String& sText, unsigned nType = MB_OK, unsigned nIDHelp = 0);
 170         void ShowRescanError(int nRescanResult, IDENTLEVEL identical);
 171         bool Undo();
 172         void CopyAllList(int srcPane, int dstPane);
 173         void CopyMultipleList(int srcPane, int dstPane, int firstDiff, int lastDiff, int firstWordDiff = -1, int lastWordDiff = -1);
 174         void CopyMultiplePartialList(int srcPane, int dstPane, int firstDiff, int lastDiff, int firstLineDiff = -1, int lastLineDiff = -1);
 175         void DoAutoMerge(int dstPane);
 176         bool SanityCheckDiff(DIFFRANGE dr) const;
 177         bool WordListCopy(int srcPane, int dstPane, int nDiff, int nFirstWordDiff, int nLastWordDiff, const std::vector<int> *pWordDiffIndice, bool bGroupWithPrevious = false, bool bUpdateView = true);
 178         bool PartialListCopy(int srcPane, int dstPane, int nDiff, int firstLine, int lastLine = -1, bool bGroupWithPrevious = false, bool bUpdateView = true);
 179         bool ListCopy(int srcPane, int dstPane, int nDiff = -1, bool bGroupWithPrevious = false, bool bUpdateView = true);
 180         bool TrySaveAs(String& strPath, int &nLastErrorCode, String & sError,
 181                 int nBuffer, PackingInfo * pInfoTempUnpacker);
 182         bool DoSave(LPCTSTR szPath, bool &bSaveSuccess, int nBuffer);
 183         bool DoSaveAs(LPCTSTR szPath, bool &bSaveSuccess, int nBuffer);
 184         int RightLineInMovedBlock(int pane, int line);
 185         int LeftLineInMovedBlock(int pane, int line);
 186         void SetEditedAfterRescan(int nBuffer);
 187         bool IsEditedAfterRescan(int nBuffer = -1) const;
 188
 189         void SetUnpacker(const PackingInfo * infoUnpacker);
 190         void SetPrediffer(const PrediffingInfo * infoPrediffer);
 191         void GetPrediffer(PrediffingInfo * infoPrediffer);
 192         void AddMergeViews(CMergeEditView * pView[3]);
 193         void RemoveMergeViews(int nGroup);
 194         void SetLocationView(CLocationView *pLocationView) { m_pLocationView = pLocationView; }
 195
 196         CDirDoc * GetDirDoc() const override { return m_pDirDoc; }
 197         void SetDirDoc(CDirDoc * pDirDoc) override;
 198         void DirDocClosing(CDirDoc * pDirDoc) override;
 199         bool CloseNow() override;
 200         void SwapFiles(int nFromIndex, int nToIndex);
 201
 202         CMergeEditView * GetView(int group, int buffer) const { return m_pView[group][buffer]; }
 203         CLocationView * GetLocationView() { return m_pLocationView; }
 204         std::vector<CMergeEditView *> GetViewList(int nGroup = -1, int nBuffer = -1) const {
 205                 std::vector<CMergeEditView *> list;
 206                 if (nGroup != -1)
 207                         for (int nBuffer2 = 0; nBuffer2 < m_nBuffers; ++nBuffer2)
 208                                 list.push_back(m_pView[nGroup][nBuffer2]);
 209                 else if (nBuffer != -1)
 210                         for (int nGroup2 = 0; nGroup2 < m_nGroups; ++nGroup2)
 211                                 list.push_back(m_pView[nGroup2][nBuffer]);
 212                 else
 213                 {
 214                         for (int nGroup3 = 0; nGroup3 < m_nGroups; nGroup3++)
 215                                 for (int nBuffer3 = 0; nBuffer3 < m_nBuffers; ++nBuffer3)
 216                                         list.push_back(m_pView[nGroup3][nBuffer3]);
 217                 }
 218                 return list;
 219         }
 220         template <typename Function>
 221         void ForEachView(int nBuffer, Function func) {
 222                 for (int nGroup = 0; nGroup < m_nGroups; nGroup++)
 223                         func(m_pView[nGroup][nBuffer]);
 224         }
 225         template <typename Function>
 226         void ForEachView(Function func) {
 227                 for (int nBuffer = 0; nBuffer < m_nBuffers; ++nBuffer)
 228                 {
 229                         for (int nGroup = 0; nGroup < m_nGroups; nGroup++)
 230                                 func(m_pView[nGroup][nBuffer]);
 231                 }
 232         }
 233         template <typename Function>
 234         void ForEachActiveGroupView(Function func) {
 235                 int nGroup = GetActiveMergeView()->m_nThisGroup;
 236                 for (int nBuffer = 0; nBuffer < m_nBuffers; ++nBuffer)
 237                         func(m_pView[nGroup][nBuffer]);
 238         }
 239         CMergeEditFrame * GetParentFrame();
 240
 241         void AddSyncPoint();
 242         bool DeleteSyncPoint(int pane, int nLine, bool bRescan = true);
 243         void ClearSyncPoints();
 244         bool HasSyncPoints();
 245         std::vector<std::vector<int> > GetSyncPointList();
 246         String GetDescription(int pane) const { return m_strDesc[pane]; }
 247
 248         // Overrides
 249         // ClassWizard generated virtual function overrides
 250         //{{AFX_VIRTUAL(CMergeDoc)
 251         public:
 252         virtual BOOL OnNewDocument();
 253         virtual void Serialize(CArchive& ar);
 254         virtual BOOL SaveModified();
 255         virtual void DeleteContents ();
 256         virtual void SetTitle(LPCTSTR lpszTitle);
 257         //}}AFX_VIRTUAL
 258
 259 // Implementation in MergeDocLineDiffs.cpp
 260 public:
 261         typedef enum { BYTEDIFF, WORDDIFF } DIFFLEVEL;
 262         void Showlinediff(CMergeEditView *pView, bool bReversed = false);
 263         void AddToSubstitutionFilters(CMergeEditView* pView, bool bReversed = false);
 264         std::vector<WordDiff> GetWordDiffArrayInDiffBlock(int nDiff);
 265         std::vector<WordDiff> GetWordDiffArray(int nLineIndex);
 266         void ClearWordDiffCache(int nDiff = -1);
 267 private:
 268         void Computelinediff(CMergeEditView *pView, CRect rc[], bool bReversed);
 269         std::map<int, std::vector<WordDiff> > m_cacheWordDiffs;
 270 // End MergeDocLineDiffs.cpp
 271
 272 // Implementation in MergeDocEncoding.cpp
 273 public:
 274         bool DoFileEncodingDialog();
 275 // End MergeDocEncoding.cpp
 276
 277 // Implementation
 278 public:
 279         FileChange IsFileChangedOnDisk(LPCTSTR szPath, DiffFileInfo &dfi,
 280                 bool bSave, int nBuffer);
 281         bool PromptAndSaveIfNeeded(bool bAllowCancel);
 282         std::vector<int> undoTgt;
 283         std::vector<int>::iterator curUndo;
 284         void FlushAndRescan(bool bForced = false);
 285         void SetCurrentDiff(int nDiff);
 286         int GetCurrentDiff() const { return m_nCurDiff; }
 287         const CurrentWordDiff& GetCurrentWordDiff() const { return m_CurWordDiff; }
 288         bool EqualCurrentWordDiff(int nBuffer, const CPoint& ptStart, const CPoint& ptEnd) const
 289         {
 290                 return (m_CurWordDiff.nPane == nBuffer && m_CurWordDiff.ptStart == ptStart && m_CurWordDiff.ptEnd == ptEnd);
 291         }
 292         virtual ~CMergeDoc();
 293         void SetDetectMovedBlocks(bool bDetectMovedBlocks);
 294         bool IsMixedEOL(int nBuffer) const;
 295         bool OpenWithUnpackerDialog();
 296         bool GenerateReport(const String& sFileName) const override;
 297         void SetAutoMerged(bool bAutoMerged) { m_bAutoMerged = bAutoMerged; }
 298         bool GetAutoMerged() const { return m_bAutoMerged; };
 299         bool IsModified() const
 300         {
 301                 for (int nBuffer = 0; nBuffer < m_nBuffers; ++nBuffer)
 302                         if (m_ptBuf[nBuffer]->IsModified())
 303                                 return true;
 304                 return false;
 305         }
 306         bool CanUndo() const
 307         {
 308                 for (int nBuffer = 0; nBuffer < m_nBuffers; ++nBuffer)
 309                         if (m_ptBuf[nBuffer]->CanUndo())
 310                                 return true;
 311                 return false;
 312         }
 313         std::optional<bool> GetEnableTableEditing() const { return m_bEnableTableEditing; }
 314         void SetEnableTableEditing(std::optional<bool> bEnableTableEditing) { m_bEnableTableEditing = bEnableTableEditing; }
 315         bool GetAutomaticRescan() const { return m_bAutomaticRescan; }
 316
 317 // implementation methods
 318 private:
 319         bool GetBreakType() const;
 320         bool GetByteColoringOption() const;
 321         bool IsValidCodepageForMergeEditor(unsigned cp) const;
 322         void SanityCheckCodepage(FileLocation & fileinfo);
 323         DWORD LoadOneFile(int index, String filename, bool readOnly, const String& strDesc, const FileTextEncoding & encoding);
 324         void SetTableProperties();
 325
 326 // Implementation data
 327 protected:
 328         int m_nCurDiff; /**< Selected diff, 0-based index, -1 if no diff selected */
 329         CurrentWordDiff m_CurWordDiff;
 330         CMergeEditView * m_pView[3][3]; /**< Pointer to left/middle/right view */
 331         CLocationView * m_pLocationView; /**< Pointer to locationview */
 332         CDirDoc * m_pDirDoc;
 333         bool m_bEnableRescan; /**< Automatic rescan enabled/disabled */
 334         COleDateTime m_LastRescan; /**< Time of last rescan (for delaying) */
 335         CDiffWrapper m_diffWrapper;
 336         /// information about the file packer/unpacker
 337         std::unique_ptr<PackingInfo> m_pInfoUnpacker;
 338         String m_strDesc[3]; /**< Left/Middle/Right side description text */
 339         BUFFERTYPE m_nBufferType[3];
 340         bool m_bEditAfterRescan[3]; /**< Left/middle/right doc edited after rescanning */
 341         TempFile m_tempFiles[3]; /**< Temp files for compared files */
 342         int m_nDiffContext;
 343         bool m_bInvertDiffContext;
 344         bool m_bMixedEol; /**< Does this document have mixed EOL style? */
 345         std::unique_ptr<CEncodingErrorBar> m_pEncodingErrorBar;
 346         bool m_bHasSyncPoints;
 347         bool m_bAutoMerged;
 348         std::optional<bool> m_bEnableTableEditing;
 349         /**
 350          * Are automatic rescans enabled?
 351          * If automatic rescans are enabled then we rescan files after edit
 352          * events, unless timer suppresses rescan. We suppress rescans within
 353          * certain time from previous rescan.
 354          */
 355         bool m_bAutomaticRescan;
 356 // friend access
 357         friend class RescanSuppress;
 358
 359
 360 // Generated message map functions
 361 protected:
 362         //{{AFX_MSG(CMergeDoc)
 363         afx_msg void OnFileSave();
 364         afx_msg void OnFileSaveLeft();
 365         afx_msg void OnFileSaveMiddle();
 366         afx_msg void OnFileSaveRight();
 367         afx_msg void OnFileSaveAsLeft();
 368         afx_msg void OnUpdateFileSaveAsMiddle(CCmdUI* pCmdUI);
 369         afx_msg void OnFileSaveAsMiddle();
 370         afx_msg void OnFileSaveAsRight();
 371         afx_msg void OnUpdateStatusNum(CCmdUI* pCmdUI);
 372         afx_msg void OnUpdatePluginName(CCmdUI* pCmdUI);
 373         afx_msg void OnFileReload();
 374         afx_msg void OnFileEncoding();
 375         afx_msg void OnDiffContext(UINT nID);
 376         afx_msg void OnUpdateDiffContext(CCmdUI* pCmdUI);
 377         afx_msg void OnToolsGenerateReport();
 378         afx_msg void OnToolsGeneratePatch();
 379         afx_msg void OnCtxtOpenWithUnpacker();
 380         afx_msg void OnBnClickedFileEncoding();
 381         afx_msg void OnBnClickedPlugin();
 382         afx_msg void OnBnClickedHexView();
 383         afx_msg void OnOK();
 384         afx_msg void OnFileRecompareAsText();
 385         afx_msg void OnFileRecompareAsTable();
 386         afx_msg void OnFileRecompareAsXML();
 387         afx_msg void OnUpdateFileRecompareAsText(CCmdUI* pCmdUI);
 388         afx_msg void OnUpdateFileRecompareAsTable(CCmdUI* pCmdUI);
 389         afx_msg void OnUpdateFileRecompareAsXML(CCmdUI* pCmdUI);
 390         afx_msg void OnFileRecompareAs(UINT nID);
 391         afx_msg void OnUpdateSwapContext(CCmdUI* pCmdUI);
 392         //}}AFX_MSG
 393         DECLARE_MESSAGE_MAP()
 394 private:
 395         void PrimeTextBuffers();
 396         void HideLines();
 397         void AdjustDiffBlocks();
 398         void AdjustDiffBlock(DiffMap & diffmap, const DIFFRANGE & diffrange, int lo0, int hi0, int lo1, int hi1);
 399         int GetMatchCost(const String &Line0, const String &Line1);
 400         void FlagTrivialLines();
 401         void FlagMovedLines();
 402         String GetFileExt(LPCTSTR sFileName, LPCTSTR sDescription) const;
 403         void DoFileSave(int pane);
 404 };
 405
 406 /**
 407  * @brief return true if there are synchronization points
 408  */
 409 inline bool CMergeDoc::HasSyncPoints()
 410 {
 411         return m_bHasSyncPoints;
 412 }
 413