src/Utils/CommonAppUtils.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2013, 2015-2020, 2023 - TortoiseGit
   4 // Copyright (C) 2003-2008,2010 - TortoiseSVN
   5
   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.
  10
  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.
  15
  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.
  19 //
  20 #pragma once
  21
  22 /**
  23  * \ingroup TortoiseProc
  24  * An utility class with static functions.
  25  */
  26 class CCommonAppUtils
  27 {
  28 public:
  29         struct LaunchApplicationFlags
  30         {
  31 private:
  32                 bool bWaitForStartup = false;
  33                 bool bWaitForExit = false;
  34                 HANDLE hWaitHandle = nullptr;
  35                 bool bUAC = false;
  36                 CString* psCWD = nullptr;
  37                 UINT uiIDErrMessageFormat = 0;
  38                 DWORD* pdwExitCode = nullptr;
  39
  40                 friend class CCommonAppUtils;
  41
  42 public:
  43                 LaunchApplicationFlags() {}
  44                 LaunchApplicationFlags& UseSpecificErrorMessage(UINT idErrMessageFormat)
  45                 {
  46                         uiIDErrMessageFormat = idErrMessageFormat;
  47                         return *this;
  48                 }
  49                 LaunchApplicationFlags& WaitForStartup(bool b = true)
  50                 {
  51                         bWaitForStartup = b;
  52                         return *this;
  53                 }
  54                 LaunchApplicationFlags& WaitForExit(bool b = true, HANDLE h = nullptr, DWORD* pExitCode = nullptr)
  55                 {
  56                         ASSERT(!h || b);
  57                         bWaitForExit = b;
  58                         hWaitHandle = h;
  59                         pdwExitCode = pExitCode;
  60                         return *this;
  61                 }
  62                 LaunchApplicationFlags& UAC(bool b = true)
  63                 {
  64                         bUAC = b;
  65                         return *this;
  66                 }
  67                 LaunchApplicationFlags& UseCWD(CString* pCwd)
  68                 {
  69                         psCWD = pCwd;
  70                         return *this;
  71                 }
  72         };
  73
  74         /**
  75         * Launch an external application (usually the diff viewer)
  76         */
  77         static bool LaunchApplication(const CString& sCommandLine, const LaunchApplicationFlags& flags);
  78
  79         static bool RunTortoiseGitProc(const CString& sCommandLine, bool uac = false, bool includeGroupingUUID = true);
  80
  81         static bool IsAdminLogin();
  82
  83         static bool SetListCtrlBackgroundImage(HWND hListCtrl, UINT nID);
  84         static bool SetListCtrlBackgroundImage(HWND hListCtrl, UINT nID, int width, int height);
  85
  86         static bool FileOpenSave(CString& path, int* filterindex, UINT title, UINT filterId, bool bOpen, HWND hwndOwner = nullptr, LPCWSTR defaultExt = nullptr, bool handleAsFile = false);
  87
  88         // Wrapper for LoadImage(IMAGE_ICON)
  89         static HICON LoadIconEx(UINT resourceId, UINT cx, UINT cy);
  90
  91         /**
  92          * Apply the @a effects or color (depending on @a mask)
  93          * for all char ranges given in @a positions to the
  94          * @a window text.
  95          */
  96         static void SetCharFormat(CWnd* window, DWORD mask, DWORD effects, const std::vector<CHARRANGE>& positions);
  97         static void SetCharFormat(CWnd* window, DWORD mask, DWORD effects);
  98
  99         /**
 100          * Returns font name which is used for log messages, etc.
 101          */
 102         static CString GetLogFontName();
 103
 104         /**
 105          * Returns font size which is used for log messages, etc.
 106          */
 107         static DWORD GetLogFontSize();
 108
 109         /**
 110          * Create a font which can is used for log messages, etc
 111          */
 112         static void CreateFontForLogs(HWND hWnd, CFont& fontToCreate);
 113
 114         CCommonAppUtils() = delete;
 115 };