Update documentation
[TortoiseGit.git] / src / TortoiseGitBlame / TortoiseGitBlameView.h
blobaab07fa58b23c31a279ecf0566251c257745ea1a
1 // TortoiseGit - a Windows shell extension for easy version control
3 // Copyright (C) 2008-2013, 2015-2016 - TortoiseGit
4 // Copyright (C) 2003-2008, 2014 - TortoiseSVN
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License
8 // as published by the Free Software Foundation; either version 2
9 // of the License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software Foundation,
18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 // TortoiseGitBlameView.h : interface of the CTortoiseGitBlameView class
26 #pragma once
28 #include "Scintilla.h"
29 #include "SciLexer.h"
30 #include "registry.h"
31 #include "SciEdit.h"
33 #include "GitBlameLogList.h"
34 #include "TortoiseGitBlameData.h"
35 #include "Tooltip.h"
37 const COLORREF black = RGB(0,0,0);
38 const COLORREF white = RGB(0xff,0xff,0xff);
39 const COLORREF red = RGB(0xFF, 0, 0);
40 const COLORREF offWhite = RGB(0xFF, 0xFB, 0xF0);
41 const COLORREF darkGreen = RGB(0, 0x80, 0);
42 const COLORREF darkBlue = RGB(0, 0, 0x80);
43 const COLORREF lightBlue = RGB(0xA6, 0xCA, 0xF0);
44 const int blockSize = 128 * 1024;
46 #define BLAMESPACE 5
47 #define HEADER_HEIGHT 18
48 #define LOCATOR_WIDTH 10
50 #define MAX_LOG_LENGTH 2000
53 #ifndef GET_X_LPARAM
54 #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
55 #endif
56 #ifndef GET_Y_LPARAM
57 #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
58 #endif
60 class CSciEditBlame: public CSciEdit
62 DECLARE_DYNAMIC(CSciEditBlame)
63 public:
64 afx_msg void OnKeyDown(UINT nChar, UINT nRepCnt, UINT nFlags)
66 switch (nChar)
68 case (VK_ESCAPE):
70 if ((Call(SCI_AUTOCACTIVE)==0)&&(Call(SCI_CALLTIPACTIVE)==0))
72 ::SendMessage(::AfxGetApp()->GetMainWnd()->m_hWnd, WM_CLOSE, 0, 0);
73 return;
76 break;
78 CWnd::OnKeyDown(nChar, nRepCnt, nFlags);
82 class CTortoiseGitBlameView : public CView
84 enum
86 // needs to start with 1, since 0 is the return value if *nothing* is clicked on in the context menu
87 ID_BLAMEPREVIOUS = 1,
88 ID_COMPAREWITHPREVIOUS,
89 ID_SHOWLOG,
90 ID_COPYHASHTOCLIPBOARD,
91 ID_COPYLOGTOCLIPBOARD
94 protected: // create from serialization only
95 CTortoiseGitBlameView();
96 DECLARE_DYNCREATE(CTortoiseGitBlameView)
98 // Attributes
99 public:
100 CTortoiseGitBlameDoc* GetDocument() const;
101 int GetEncode(unsigned char * buffer, int size, int *bomoffset);
102 // Operations
103 public:
105 // Overrides
106 public:
107 virtual void OnDraw(CDC* pDC); // overridden to draw this view
108 virtual BOOL PreCreateWindow(CREATESTRUCT& cs);
109 protected:
110 virtual BOOL OnPreparePrinting(CPrintInfo* pInfo);
111 virtual void OnBeginPrinting(CDC* pDC, CPrintInfo* pInfo);
112 virtual void OnEndPrinting(CDC* pDC, CPrintInfo* pInfo);
114 // Implementation
115 public:
116 virtual ~CTortoiseGitBlameView();
117 #ifdef _DEBUG
118 virtual void AssertValid() const;
119 virtual void Dump(CDumpContext& dc) const;
120 #endif
122 protected:
124 // Generated message map functions
125 protected:
126 BOOL PreTranslateMessage(MSG* pMsg);
127 afx_msg void OnSysColorChange();
128 afx_msg void OnChangeEncode(UINT nID);
129 afx_msg void OnEditFind();
130 afx_msg void OnEditGoto();
131 afx_msg void OnFindNext();
132 afx_msg void OnFindPrev();
133 afx_msg void OnFilePrintPreview();
134 afx_msg void OnRButtonUp(UINT nFlags, CPoint point);
135 afx_msg int OnCreate(LPCREATESTRUCT lpcs);
136 afx_msg void OnSize(UINT nType, int cx, int cy);
137 afx_msg void OnSciPainted(NMHDR*, LRESULT*);
138 afx_msg void OnLButtonDown(UINT nFlags,CPoint point);
139 afx_msg void OnRButtonDown(UINT nFlags,CPoint point){OnLButtonDown(nFlags,point);CView::OnRButtonDown(nFlags,point);};
140 afx_msg void OnSciGetBkColor(NMHDR*, LRESULT*);
141 afx_msg void OnMouseHover(UINT nFlags, CPoint point);
142 afx_msg void OnMouseMove(UINT nFlags, CPoint point);
143 afx_msg LRESULT OnFindDialogMessage(WPARAM wParam, LPARAM lParam);
144 afx_msg void OnViewNext();
145 afx_msg void OnViewPrev();
146 afx_msg void OnViewToggleAuthor();
147 afx_msg void OnUpdateViewToggleAuthor(CCmdUI *pCmdUI);
148 afx_msg void OnViewToggleDate();
149 afx_msg void OnUpdateViewToggleDate(CCmdUI *pCmdUI);
150 afx_msg void OnViewToggleShowFilename();
151 afx_msg void OnUpdateViewToggleShowFilename(CCmdUI *pCmdUI);
152 afx_msg void OnViewToggleShowOriginalLineNumber();
153 afx_msg void OnUpdateViewToggleShowOriginalLineNumber(CCmdUI *pCmdUI);
154 afx_msg void OnViewDetectMovedOrCopiedLinesToggleDisabled();
155 afx_msg void OnUpdateViewDetectMovedOrCopiedLinesToggleDisabled(CCmdUI *pCmdUI);
156 afx_msg void OnViewDetectMovedOrCopiedLinesToggleWithinFile();
157 afx_msg void OnUpdateViewDetectMovedOrCopiedLinesToggleWithinFile(CCmdUI *pCmdUI);
158 afx_msg void OnViewDetectMovedOrCopiedLinesToggleFromModifiedFiles();
159 afx_msg void OnUpdateViewDetectMovedOrCopiedLinesToggleFromModifiedFiles(CCmdUI *pCmdUI);
160 afx_msg void OnViewDetectMovedOrCopiedLinesToggleFromExistingFilesAtFileCreation();
161 afx_msg void OnUpdateViewDetectMovedOrCopiedLinesToggleFromExistingFilesAtFileCreation(CCmdUI *pCmdUI);
162 afx_msg void OnViewDetectMovedOrCopiedLinesToggleFromExistingFiles();
163 afx_msg void OnUpdateViewDetectMovedOrCopiedLinesToggleFromExistingFiles(CCmdUI *pCmdUI);
164 afx_msg void OnViewToggleIgnoreWhitespace();
165 afx_msg void OnUpdateViewToggleIgnoreWhitespace(CCmdUI *pCmdUI);
166 afx_msg void OnViewToggleShowCompleteLog();
167 afx_msg void OnUpdateViewToggleShowCompleteLog(CCmdUI *pCmdUI);
168 afx_msg void OnViewToggleOnlyFirstParent();
169 afx_msg void OnUpdateViewToggleOnlyFirstParent(CCmdUI* pCmdUI);
170 afx_msg void OnViewToggleFollowRenames();
171 afx_msg void OnUpdateViewToggleFollowRenames(CCmdUI *pCmdUI);
172 afx_msg void OnViewToggleColorByAge();
173 afx_msg void OnUpdateViewToggleColorByAge(CCmdUI *pCmdUI);
174 afx_msg void OnViewToggleLexer();
175 afx_msg void OnUpdateViewToggleLexer(CCmdUI *pCmdUI);
176 afx_msg void OnUpdateViewCopyToClipboard(CCmdUI *pCmdUI);
177 void OnViewDetectMovedOrCopiedLines(DWORD dwDetectMovedOrCopiedLines);
178 void ContextMenuAction(int cmd, GitRev* pRev, GIT_REV_LIST& parentHash, const std::vector<CString>& parentFilename);
179 void ReloadDocument();
181 DECLARE_MESSAGE_MAP()
183 static UINT m_FindDialogMessage;
184 public:
185 void ParseBlame();
186 void MapLineToLogIndex();
187 void UpdateInfo(int encode = 0);
188 CString ResolveCommitFile(int line);
189 CString ResolveCommitFile(const CString& path);
190 void FocusOn(GitRevLoglist* pRev);
192 CSciEditBlame m_TextView;
193 CToolTips m_ToolTip;
195 HINSTANCE hInstance;
196 HINSTANCE hResource;
197 HWND currentDialog;
198 HWND wMain;
199 HWND wBlame;
200 HWND wHeader;
201 HWND wLocator;
202 HWND hwndTT;
204 BOOL bIgnoreEOL;
205 BOOL bIgnoreSpaces;
206 BOOL bIgnoreAllSpaces;
208 BOOL m_bShowAuthor;
209 BOOL m_bShowDate;
210 BOOL m_bShowFilename;
211 BOOL m_bShowOriginalLineNumber;
212 DWORD m_dwDetectMovedOrCopiedLines;
213 BOOL m_bIgnoreWhitespace;
214 BOOL m_bShowCompleteLog;
215 BOOL m_bOnlyFirstParent;
216 BOOL m_bFollowRenames;
217 BOOL m_bBlameOuputContainsOtherFilenames;
219 LRESULT SendEditor(UINT Msg, WPARAM wParam=0, LPARAM lParam=0);
221 void SetAStyle(int style, COLORREF fore, COLORREF back = ::GetSysColor(COLOR_WINDOW), int size = -1, const char* face = nullptr);
223 void InitialiseEditor();
224 LONG GetBlameWidth();
225 void DrawBlame(HDC hDC);
226 void DrawLocatorBar(HDC hDC);
227 void CopyToClipboard();
228 bool DoSearch(CTortoiseGitBlameData::SearchDirection direction);
229 bool GotoLine(int line);
230 bool ScrollToLine(long line);
231 void GotoLineDlg();
232 static INT_PTR CALLBACK GotoDlgProc(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam);
234 void SetSelectedLine(int line) { m_SelectedLine = line;};
236 int m_MouseLine;
237 CGitHash m_SelectedHash;
238 CGitHash m_selecteddate;
239 bool m_colorage;
240 bool m_bLexer;
242 CTortoiseGitBlameData m_data;
243 std::vector<int> m_lineToLogIndex;
245 CLogDataVector * GetLogData();
247 BOOL m_bShowLine;
249 protected:
250 void CreateFont();
251 void SetupLexer(CString filename);
252 void SetupCppLexer();
253 COLORREF GetLineColor(int line);
254 COLORREF InterColor(COLORREF c1, COLORREF c2, int Slider);
255 CFont m_font;
256 CFont m_italicfont;
257 LONG m_blamewidth;
258 LONG m_revwidth;
259 LONG m_datewidth;
260 LONG m_authorwidth;
261 LONG m_filenameWidth;
262 LONG m_originalLineNumberWidth;
263 LONG m_linewidth;
264 int m_SelectedLine; ///< zero-based
266 COLORREF m_mouserevcolor;
267 COLORREF m_mouseauthorcolor;
268 COLORREF m_selectedrevcolor;
269 COLORREF m_selectedauthorcolor;
270 COLORREF m_windowcolor;
271 COLORREF m_textcolor;
272 COLORREF m_texthighlightcolor;
274 CRegStdDWORD m_regOldLinesColor;
275 CRegStdDWORD m_regNewLinesColor;
277 CGitBlameLogList * GetLogList();
279 CFindReplaceDialog *m_pFindDialog;
281 #ifdef USE_TEMPFILENAME
282 char *m_Buffer;
283 #endif
285 DWORD m_DateFormat; // DATE_SHORTDATE or DATE_LONGDATE
286 bool m_bRelativeTimes; // Show relative times
288 CString m_sRev;
289 CString m_sFileName;
290 CString m_sAuthor;
291 CString m_sDate;
292 CString m_sMessage;
294 CString m_sFindText;
295 bool m_bMatchCase;
298 #ifndef _DEBUG // debug version in TortoiseGitBlameView.cpp
299 inline CTortoiseGitBlameDoc* CTortoiseGitBlameView::GetDocument() const
300 { return reinterpret_cast<CTortoiseGitBlameDoc*>(m_pDocument); }
301 #endif