src/TortoiseProc/ProgressDlg.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2017 - TortoiseGit
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  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.
  14
  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 Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 #include "StandAloneDlg.h"
  22 #include "Git.h"
  23 #include "MenuButton.h"
  24 #include "GestureEnabledControl.h"
  25
  26 #define MSG_PROGRESSDLG_UPDATE_UI       (WM_USER+121)
  27
  28 // CProgressDlg dialog
  29 #define MSG_PROGRESSDLG_START 0
  30 #define MSG_PROGRESSDLG_RUN   50
  31 #define MSG_PROGRESSDLG_END   110
  32 #define MSG_PROGRESSDLG_FAILED 111
  33
  34 typedef enum {
  35         AUTOCLOSE_NO,
  36         AUTOCLOSE_IF_NO_OPTIONS,
  37         AUTOCLOSE_IF_NO_ERRORS,
  38 } GitProgressAutoClose;
  39
  40 typedef std::function<void()> PostCmdAction;
  41
  42 class PostCmd
  43 {
  44 public:
  45         PostCmd(UINT icon, UINT msgId, PostCmdAction action)
  46         : icon(icon)
  47         , action(action)
  48         {
  49                 label.LoadString(msgId);
  50         }
  51
  52         PostCmd(UINT msgId, PostCmdAction action)
  53         : PostCmd(0, msgId, action)
  54         {
  55         }
  56
  57         PostCmd(UINT icon, CString label, PostCmdAction action)
  58         : icon(icon)
  59         , action(action)
  60         , label(label)
  61         {
  62         }
  63
  64         PostCmd(CString label, PostCmdAction action)
  65         : PostCmd(0, label, action)
  66         {
  67         }
  68
  69         UINT                    icon;
  70         CString                 label;
  71         PostCmdAction   action;
  72 };
  73
  74 typedef std::vector<PostCmd> PostCmdList;
  75 typedef std::function<void(DWORD status, PostCmdList&)> PostCmdCallback;
  76 typedef std::function<void(DWORD& exitCode, CString& extraMsg)> PostExecCallback;
  77
  78 class CProgressDlg : public CResizableStandAloneDialog
  79 {
  80         DECLARE_DYNAMIC(CProgressDlg)
  81 public:
  82         CProgressDlg(CWnd* pParent = nullptr); // standard constructor
  83         virtual ~CProgressDlg();
  84
  85 private:
  86         virtual BOOL OnInitDialog() override;
  87
  88         // Dialog Data
  89         enum { IDD = IDD_GITPROGRESS };
  90
  91 public:
  92         CString                                 m_GitCmd;
  93         PostCmdCallback                 m_PostCmdCallback;
  94         std::vector<CString>    m_GitCmdList;
  95         PostExecCallback                m_PostExecCallback; // After executing command line, this callback can modify exit code / display extra message
  96         STRING_VECTOR                   m_GitDirList;
  97         CString                                 m_PreText;              // optional text to show in log window before running command
  98         CString                                 m_PreFailText;  // optional fail text to show in log window
  99         bool                                    m_bShowCommand; // whether to display the command in the log window (default true)
 100         CString                                 m_LogFile;
 101         bool                                    m_bBufferAll;   // Buffer All to improve speed when there are many file add at commit
 102         GitProgressAutoClose    m_AutoClose;
 103         CGit *                                  m_Git;
 104
 105         DWORD                                   m_GitStatus;
 106         CString                                 m_LogText;
 107
 108         CString                                 GetLogText() const { CString text; m_Log.GetWindowText(text); return text; }
 109
 110 private:
 111         PostCmdList                             m_PostCmdList;
 112         void                                    WriteLog() const;
 113         CMenuButton                             m_ctrlPostCmd;
 114
 115         CProgressCtrl                   m_Progress;
 116
 117         CGestureEnabledControlTmpl<CRichEditCtrl> m_Log;
 118         CAnimateCtrl                    m_Animate;
 119         CStatic                                 m_CurrentWork;
 120         CWinThread*                             m_pThread;
 121
 122         volatile bool                   m_bAbort;
 123         bool                                    m_bDone;
 124         ULONGLONG                               m_startTick;
 125
 126         virtual void                    DoDataExchange(CDataExchange* pDX) override;    // DDX/DDV support
 127         static UINT                             ProgressThreadEntry(LPVOID pVoid);
 128         UINT                                    ProgressThread();
 129
 130         CStringA                                m_LogTextA;
 131
 132         void                                    ParserCmdOutput(char ch);
 133         void                                    RemoveLastLine(CString &str);
 134         static const int                s_iProgressLinesLimit;
 135
 136         LRESULT                                 OnProgressUpdateUI(WPARAM wParam,LPARAM lParam);
 137
 138         afx_msg LRESULT                 OnTaskbarBtnCreated(WPARAM wParam, LPARAM lParam);
 139         CComPtr<ITaskbarList3>  m_pTaskbarList;
 140
 141         void                                    OnCancel();
 142         afx_msg void                    OnClose();
 143
 144         afx_msg void                    OnEnscrollLog();
 145         afx_msg void                    OnEnLinkLog(NMHDR* pNMHDR, LRESULT* pResult);
 146
 147         CGitGuardedByteArray    m_Databuf;
 148         virtual CString Convert2UnionCode(char *buff, int size=-1)
 149         {
 150                 CString str;
 151                 CGit::StringAppend(&str, (BYTE*)buff, CP_UTF8, size);
 152                 return str;
 153         }
 154
 155                 int                                             m_BufStart;
 156
 157         DECLARE_MESSAGE_MAP()
 158
 159         //Share with Sync Dailog
 160         static int ParsePercentage(CString &log, int pos);
 161
 162         static void     ClearESC(CString &str);
 163
 164 public:
 165         static void     ParserCmdOutput(CRichEditCtrl &log,CProgressCtrl &progressctrl,HWND m_hWnd,CComPtr<ITaskbarList3> m_pTaskbarList,
 166                                                                         CStringA& oneline, char ch, CWnd* CurrentWork = nullptr);
 167
 168         /**
 169          *@param dirlist if empty, the current directory of param git is used; otherwise each entry in param cmdlist uses the corresponding entry in param dirlist
 170          */
 171         static UINT     RunCmdList(CWnd* pWnd, STRING_VECTOR& cmdlist, STRING_VECTOR& dirlist, bool bShowCommand, CString* pfilename, volatile bool* bAbort, CGitGuardedByteArray* pdata, CGit* git = &g_Git);
 172
 173         static void KillProcessTree(DWORD dwProcessId, unsigned int depth = 0);
 174
 175         static void InsertColorText(CRichEditCtrl &edit,CString text,COLORREF rgb);
 176
 177 private:
 178         afx_msg void OnBnClickedOk();
 179         afx_msg void OnBnClickedButton1();
 180
 181         virtual BOOL PreTranslateMessage(MSG* pMsg) override;
 182
 183         typedef struct {
 184                 int id;
 185                 int cnt;
 186                 int wmid;
 187         } ACCELLERATOR;
 188         std::map<TCHAR, ACCELLERATOR>   m_accellerators;
 189         HACCEL                                                  m_hAccel;
 190         virtual LRESULT DefWindowProc(UINT message, WPARAM wParam, LPARAM lParam) override;
 191 };
 192
 193 class CCommitProgressDlg:public CProgressDlg
 194 {
 195 public:
 196         CCommitProgressDlg(CWnd* pParent = nullptr) : CProgressDlg(pParent)
 197         {
 198         }
 199
 200         virtual CString Convert2UnionCode(char* buff, int size = -1) override;
 201 };