1 /////////////////////////////////////////////////////////////////////////////
2 // WinMerge: an interactive diff/merge utility
3 // Copyright (C) 1997 Dean P. Grimm
5 // This program is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation; either version 2 of the License, or
8 // (at your option) any later version.
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 /////////////////////////////////////////////////////////////////////////////
23 * @brief Declaration of class CDirView
27 /////////////////////////////////////////////////////////////////////////////
32 #include "OptionsDiffColors.h"
33 #include "SortHeaderCtrl.h"
34 #include "UnicodeString.h"
35 #include "DirItemIterator.h"
36 #include "DirActions.h"
38 class FileActionScript;
42 typedef enum { eMain, eContext } eMenuType;
49 class DirCompProgressBar;
52 class CLoadSaveCodepageDlg;
53 class CShellContextMenu;
55 class DirViewColItems;
56 class DirItemEnumerator;
60 * @brief Position value for special items (..) in directory compare view.
62 const uintptr_t SPECIAL_ITEM_POS = (uintptr_t) - 1L;
64 /** Default column width in directory compare */
65 const UINT DefColumnWidth = 150;
68 * @brief Directory compare results view.
70 * Directory compare view is list-view based, so it shows one result (for
71 * folder or file, commonly called as 'item') in one line. User can select
72 * visible columns, re-order columns, sort by column etc.
74 * Actual data is stored in CDiffContext in CDirDoc. Dircompare items and
75 * CDiffContext items are linked by storing POSITION of CDiffContext item
76 * as CDirView listitem key.
78 class CDirView : public CListView
80 friend struct FileCmpReport;
81 friend DirItemEnumerator;
83 CDirView(); // protected constructor used by dynamic creation
84 DECLARE_DYNCREATE(CDirView)
88 CDirDoc* GetDocument(); // non-debug version is inline
89 // const version, for const methods to be able to call
90 const CDirDoc * GetDocument() const { return const_cast<CDirView *>(this)->GetDocument(); }
91 const CDiffContext& GetDiffContext() const;
92 CDiffContext& GetDiffContext();
96 CDirFrame * GetParentFrame();
98 void StartCompare(CompareStats *pCompareStats);
100 void RedisplayChildren(uintptr_t diffpos, int level, UINT &index, int &alldiffs, const DirViewFilterSettings& dirfilter);
101 void UpdateResources();
102 void LoadColumnHeaderItems();
103 uintptr_t GetItemKey(int idx) const;
104 int GetItemIndex(uintptr_t key);
105 // for populating list
106 void DeleteItem(int sel);
107 void DeleteAllDisplayItems();
108 void SetFont(const LOGFONT & lf);
110 void SortColumnsAppropriately();
112 UINT GetSelectedCount() const;
113 int GetFirstSelectedInd();
114 void AddParentFolderItem(bool bEnable);
115 void RefreshOptions();
117 LRESULT HandleMenuMessage(UINT message, WPARAM wParam, LPARAM lParam);
119 // Implementation types
122 // Implementation in DirActions.cpp
124 void GetItemFileNames(int sel, String& strLeft, String& strRight) const;
125 void GetItemFileNames(int sel, PathContext * paths) const;
126 void FormatEncodingDialogDisplays(CLoadSaveCodepageDlg * dlg);
127 bool IsItemLeftOnly(int code);
128 bool IsItemRightOnly(int code);
129 DirActions MakeDirActions(DirActions::method_type func) const;
130 DirActions MakeDirActions(DirActions::method_type2 func) const;
131 Counts Count(DirActions::method_type2 func) const;
132 void DoDirAction(DirActions::method_type func, const String& status_message);
133 void DoDirActionTo(SIDE_TYPE stype, DirActions::method_type func, const String& status_message);
134 void DoOpen(SIDE_TYPE stype);
135 void DoOpenWith(SIDE_TYPE stype);
136 void DoOpenWithEditor(SIDE_TYPE stype);
137 void DoUpdateOpen(SELECTIONTYPE selectionType, CCmdUI* pCmdUI);
138 void ConfirmAndPerformActions(FileActionScript & actions);
139 void PerformActionList(FileActionScript & actions);
140 void UpdateAfterFileScript(FileActionScript & actionList);
141 void DoFileEncodingDialog();
143 // End DirActions.cpp
144 void ReflectGetdispinfo(NMLVDISPINFO *);
146 // Implementation in DirViewColHandler.cpp
148 void UpdateColumnNames();
149 void SetColAlignments();
150 // class CompareState is used to pass parameters to the PFNLVCOMPARE callback function.
154 const DirViewColItems *const pColItems;
155 const CDiffContext *const pCtxt;
157 const bool bSortAscending;
158 const bool bTreeMode;
160 CompareState(const CDiffContext *pCtxt, const DirViewColItems *pColItems, int sortCol, bool bSortAscending, bool bTreeMode);
161 static int CALLBACK CompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort);
163 void UpdateDiffItemStatus(UINT nIdx);
166 void NameColumn(const char* idname, int subitem);
167 int AddNewItem(int i, uintptr_t diffpos, int iImage, int iIndent);
168 // End DirViewCols.cpp
173 // ClassWizard generated virtual function overrides
174 //{{AFX_VIRTUAL(CDirView)
176 virtual void OnInitialUpdate();
178 virtual BOOL PreTranslateMessage(MSG* pMsg);
179 virtual BOOL OnNotify(WPARAM wParam, LPARAM lParam, LRESULT* pResult);
180 virtual BOOL OnChildNotify(UINT, WPARAM, LPARAM, LRESULT*);
181 virtual LRESULT WindowProc(UINT message, WPARAM wParam, LPARAM lParam);
187 int GetFocusedItem();
188 int GetFirstDifferentItem();
189 int GetLastDifferentItem();
190 int AddSpecialItems();
191 void GetCurrentColRegKeys(std::vector<String>& colKeys);
192 void OpenSpecialItems(uintptr_t pos1, uintptr_t pos2, uintptr_t pos3);
194 // Implementation data
196 CString GenerateReport();
197 CSortHeaderCtrl m_ctlSortHeader;
198 CImageList m_imageList;
199 CImageList m_imageState;
201 std::unique_ptr<IListCtrl> m_pIList;
202 bool m_bEscCloses; /**< Cached value for option for ESC closing window */
203 bool m_bExpandSubdirs;
204 CFont m_font; /**< User-selected font */
205 UINT m_nHiddenItems; /**< Count of items we have hidden */
206 bool m_bTreeMode; /**< TRUE if tree mode is on*/
207 std::unique_ptr<DirCompProgressBar> m_pCmpProgressBar;
208 clock_t m_compareStart; /**< Starting process time of the compare */
209 bool m_bUserCancelEdit; /**< TRUE if the user cancels rename */
210 String m_lastCopyFolder; /**< Last Copy To -target folder. */
214 bool m_bNeedSearchFirstDiffItem;
215 bool m_bNeedSearchLastDiffItem;
216 COLORSETTINGS m_cachedColors; /**< Cached color settings */
218 std::unique_ptr<CShellContextMenu> m_pShellContextMenuLeft; /**< Shell context menu for group of left files */
219 std::unique_ptr<CShellContextMenu> m_pShellContextMenuMiddle; /**< Shell context menu for group of middle files */
220 std::unique_ptr<CShellContextMenu> m_pShellContextMenuRight; /**< Shell context menu for group of right files */
221 HMENU m_hCurrentMenu; /**< Current shell context menu (either left or right) */
222 std::unique_ptr<DirViewTreeState> m_pSavedTreeState;
223 std::unique_ptr<DirViewColItems> m_pColItems;
225 // Generated message map functions
226 afx_msg void OnColumnClick(NMHDR* pNMHDR, LRESULT* pResult);
227 afx_msg void OnContextMenu(CWnd*, CPoint point);
228 //{{AFX_MSG(CDirView)
229 afx_msg void OnLButtonDblClk(UINT nFlags, CPoint point);
230 template<SIDE_TYPE srctype, SIDE_TYPE dsttype>
231 afx_msg void OnDirCopy();
232 template<SIDE_TYPE srctype, SIDE_TYPE dsttype>
233 afx_msg void OnCtxtDirCopy();
234 template<SIDE_TYPE srctype, SIDE_TYPE dsttype>
235 afx_msg void OnUpdateDirCopy(CCmdUI* pCmdUI);
236 template<SIDE_TYPE srctype, SIDE_TYPE dsttype>
237 afx_msg void OnUpdateCtxtDirCopy(CCmdUI* pCmdUI);
238 template<SIDE_TYPE stype>
239 afx_msg void OnCtxtDirDel();
240 template<SIDE_TYPE stype>
241 afx_msg void OnUpdateCtxtDirDel(CCmdUI* pCmdUI);
242 afx_msg void OnCtxtDirDelBoth();
243 afx_msg void OnUpdateCtxtDirDelBoth(CCmdUI* pCmdUI);
244 template<SIDE_TYPE stype>
245 afx_msg void OnCtxtDirOpen();
246 template<SIDE_TYPE stype>
247 afx_msg void OnUpdateCtxtDirOpen(CCmdUI* pCmdUI);
248 template<SIDE_TYPE stype>
249 afx_msg void OnCtxtDirOpenWith();
250 template<SIDE_TYPE stype>
251 afx_msg void OnUpdateCtxtDirOpenWith(CCmdUI* pCmdUI);
252 template<SIDE_TYPE stype>
253 afx_msg void OnCtxtDirOpenWithEditor();
254 template<SIDE_TYPE stype>
255 afx_msg void OnUpdateCtxtDirOpenWithEditor(CCmdUI* pCmdUI);
256 template<SIDE_TYPE stype>
257 afx_msg void OnCtxtDirCopyTo();
258 template<SIDE_TYPE stype>
259 afx_msg void OnUpdateCtxtDirCopyTo(CCmdUI* pCmdUI);
260 afx_msg void OnDestroy();
261 afx_msg void OnChar(UINT nChar, UINT nRepCnt, UINT nFlags);
262 afx_msg void OnClick(NMHDR* pNMHDR, LRESULT* pResult);
263 afx_msg void OnFirstdiff();
264 afx_msg void OnUpdateFirstdiff(CCmdUI* pCmdUI);
265 afx_msg void OnLastdiff();
266 afx_msg void OnUpdateLastdiff(CCmdUI* pCmdUI);
267 afx_msg void OnNextdiff();
268 afx_msg void OnUpdateNextdiff(CCmdUI* pCmdUI);
269 afx_msg void OnPrevdiff();
270 afx_msg void OnUpdatePrevdiff(CCmdUI* pCmdUI);
271 afx_msg void OnCurdiff();
272 afx_msg void OnUpdateCurdiff(CCmdUI* pCmdUI);
273 afx_msg void OnUpdateSave(CCmdUI* pCmdUI);
274 afx_msg LRESULT OnUpdateUIMessage(WPARAM wParam, LPARAM lParam);
275 afx_msg void OnRefresh();
276 afx_msg void OnUpdateRefresh(CCmdUI* pCmdUI);
277 afx_msg void OnTimer(UINT_PTR nIDEvent);
278 afx_msg void OnEditColumns();
279 template<SIDE_TYPE stype>
280 afx_msg void OnReadOnly();
281 template<SIDE_TYPE stype>
282 afx_msg void OnUpdateReadOnly(CCmdUI* pCmdUI);
283 afx_msg void OnUpdateStatusLeftRO(CCmdUI* pCmdUI);
284 afx_msg void OnUpdateStatusMiddleRO(CCmdUI* pCmdUI);
285 afx_msg void OnUpdateStatusRightRO(CCmdUI* pCmdUI);
286 afx_msg void OnCustomizeColumns();
287 afx_msg void OnCtxtOpenWithUnpacker();
288 afx_msg void OnUpdateCtxtOpenWithUnpacker(CCmdUI* pCmdUI);
289 afx_msg void OnToolsGenerateReport();
290 afx_msg void OnCtxtDirZipLeft();
291 afx_msg void OnCtxtDirZipRight();
292 afx_msg void OnCtxtDirZipBoth();
293 afx_msg void OnCtxtDirZipBothDiffsOnly();
294 template<SIDE_TYPE stype>
295 afx_msg void OnCtxtDirShellContextMenu();
296 afx_msg void OnUpdateCtxtDir(CCmdUI* pCmdUI);
297 afx_msg void OnSelectAll();
298 afx_msg void OnUpdateSelectAll(CCmdUI* pCmdUI);
299 afx_msg void OnPluginPredifferMode(UINT nID);
300 afx_msg void OnUpdatePluginPredifferMode(CCmdUI* pCmdUI);
301 template<SIDE_TYPE side>
302 afx_msg void OnCopyPathnames();
303 afx_msg void OnCopyBothPathnames();
304 afx_msg void OnCopyFilenames();
305 afx_msg void OnUpdateCopyFilenames(CCmdUI* pCmdUI);
306 template<SIDE_TYPE side>
307 afx_msg void OnCopyToClipboard();
308 afx_msg void OnCopyBothToClipboard();
309 afx_msg void OnItemRename();
310 afx_msg void OnUpdateItemRename(CCmdUI* pCmdUI);
311 afx_msg void OnHideFilenames();
312 afx_msg void OnSize(UINT nType, int cx, int cy);
313 template<SIDE_TYPE stype>
314 afx_msg void OnCtxtDirMoveTo();
315 template<SIDE_TYPE stype>
316 afx_msg void OnUpdateCtxtDirMoveTo(CCmdUI* pCmdUI);
317 afx_msg void OnUpdateHideFilenames(CCmdUI* pCmdUI);
318 afx_msg void OnDelete();
319 afx_msg void OnUpdateDelete(CCmdUI* pCmdUI);
320 afx_msg void OnMarkedRescan();
321 afx_msg void OnUpdateStatusNum(CCmdUI* pCmdUI);
322 afx_msg void OnViewShowHiddenItems();
323 afx_msg void OnUpdateViewShowHiddenItems(CCmdUI* pCmdUI);
324 afx_msg void OnViewTreeMode();
325 afx_msg void OnUpdateViewTreeMode(CCmdUI* pCmdUI);
326 afx_msg void OnViewExpandAllSubdirs();
327 afx_msg void OnUpdateViewExpandAllSubdirs(CCmdUI* pCmdUI);
328 afx_msg void OnViewCollapseAllSubdirs();
329 afx_msg void OnUpdateViewCollapseAllSubdirs(CCmdUI* pCmdUI);
330 afx_msg void OnMergeCompare();
331 template<SELECTIONTYPE seltype>
332 afx_msg void OnMergeCompare2();
333 afx_msg void OnMergeCompareXML();
334 afx_msg void OnMergeCompareHex();
335 afx_msg void OnUpdateMergeCompare(CCmdUI *pCmdUI);
336 template<SELECTIONTYPE seltype>
337 afx_msg void OnUpdateMergeCompare2(CCmdUI *pCmdUI);
338 afx_msg void OnViewCompareStatistics();
339 afx_msg void OnFileEncoding();
340 afx_msg void OnUpdateFileEncoding(CCmdUI* pCmdUI);
341 afx_msg void OnHelp();
342 afx_msg void OnEditCopy();
343 afx_msg void OnEditCut();
344 afx_msg void OnEditPaste();
345 afx_msg void OnEditUndo();
346 afx_msg void OnUpdateEditUndo(CCmdUI* pCmdUI);
347 afx_msg void OnItemChanged(NMHDR* pNMHDR, LRESULT* pResult);
348 afx_msg void OnBeginLabelEdit(NMHDR* pNMHDR, LRESULT* pResult);
349 afx_msg void OnEndLabelEdit(NMHDR* pNMHDR, LRESULT* pResult);
350 afx_msg void OnCustomDraw(NMHDR* pNMHDR, LRESULT* pResult);
351 afx_msg void OnSearch();
352 afx_msg void OnExpandFolder();
353 afx_msg void OnCollapseFolder();
354 afx_msg void OnBeginDrag(NMHDR* pNMHDR, LRESULT* pResult);
355 afx_msg void OnBnClickedComparisonStop();
357 DECLARE_MESSAGE_MAP()
358 BOOL OnHeaderBeginDrag(LPNMHEADER hdr, LRESULT* pResult);
359 BOOL OnHeaderEndDrag(LPNMHEADER hdr, LRESULT* pResult);
362 void OpenSelection(SELECTIONTYPE selectionType = SELECTIONTYPE_NORMAL, PackingInfo * infoUnpacker = NULL);
363 void OpenSelectionHex();
364 bool GetSelectedItems(int * sel1, int * sel2, int * sel3);
365 void OpenParentDirectory();
366 template<SIDE_TYPE srctype, SIDE_TYPE dsttype>
367 void DoUpdateDirCopy(CCmdUI* pCmdUI, eMenuType menuType);
368 const DIFFITEM & GetDiffItem(int sel) const;
369 DIFFITEM & GetDiffItem(int sel);
370 int GetSingleSelectedItem() const;
371 void MoveFocus(int currentInd, int i, int selCount);
373 void FixReordering();
374 void HeaderContextMenu(CPoint point, int i);
375 void ListContextMenu(CPoint point, int i);
376 bool ListShellContextMenu(SIDE_TYPE side);
377 void ShowShellContextMenu(SIDE_TYPE side);
378 CShellContextMenu* GetCorrespondingShellContextMenu(HMENU hMenu) const;
379 void ReloadColumns();
380 bool IsLabelEdit() const;
381 void CollapseSubdir(int sel);
382 void ExpandSubdir(int sel, bool bRecursive = false);
383 void GetColors(int nRow, int nCol, COLORREF& clrBk, COLORREF& clrText) const;
385 DirItemIterator Begin() const { return DirItemIterator(m_pIList.get()); }
386 DirItemIterator End() const { return DirItemIterator(); }
387 DirItemIterator RevBegin() const { return DirItemIterator(m_pIList.get(), -1, false, true); }
388 DirItemIterator RevEnd() const { return DirItemIterator(); }
389 DirItemIterator SelBegin() const { return DirItemIterator(m_pIList.get(), -1, true); }
390 DirItemIterator SelEnd() const { return DirItemIterator(); }
391 DirItemIterator SelRevBegin() const { return DirItemIterator(m_pIList.get(), -1, true, true); }
392 DirItemIterator SelRevEnd() const { return DirItemIterator(); }
395 #ifndef _DEBUG // debug version in DirView.cpp
396 inline CDirDoc* CDirView::GetDocument()
397 { return (CDirDoc*)m_pDocument; }
401 /////////////////////////////////////////////////////////////////////////////
403 //{{AFX_INSERT_LOCATION}}
404 // Microsoft Developer Studio will insert additional declarations immediately before the previous line.