src/TortoiseProc/AppUtils.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2014 - TortoiseGit
   4 // Copyright (C) 2003-2008 - 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 #include "GitRev.h"
  22 #include "CommonAppUtils.h"
  23
  24 class CTGitPath;
  25 struct git_cred;
  26 struct git_transfer_progress;
  27 class CIgnoreFile;
  28
  29 /**
  30  * \ingroup TortoiseProc
  31  * An utility class with static functions.
  32  */
  33 class CAppUtils : public CCommonAppUtils
  34 {
  35 public:
  36         /**
  37         * Flags for StartExtDiff function.
  38         */
  39         struct DiffFlags
  40         {
  41                 bool bWait;
  42                 bool bBlame;
  43                 bool bReadOnly;
  44                 bool bAlternativeTool; // If true, invert selection of TortoiseGitMerge vs. external diff tool
  45
  46                 DiffFlags(): bWait(false), bBlame(false), bReadOnly(false), bAlternativeTool(false)     {}
  47                 DiffFlags& Wait(bool b = true) { bWait = b; return *this; }
  48                 DiffFlags& Blame(bool b = true) { bBlame = b; return *this; }
  49                 DiffFlags& ReadOnly(bool b = true) { bReadOnly = b; return *this; }
  50                 DiffFlags& AlternativeTool(bool b = true) { bAlternativeTool = b; return *this; }
  51         };
  52
  53         CAppUtils(void);
  54         ~CAppUtils(void);
  55
  56         /**
  57          * Launches the external merge program if there is one.
  58          * \return TRUE if the program could be started
  59          */
  60         static BOOL StartExtMerge(
  61                 const CTGitPath& basefile, const CTGitPath& theirfile, const CTGitPath& yourfile, const CTGitPath& mergedfile,
  62                 const CString& basename = CString(), const CString& theirname = CString(), const CString& yourname = CString(),
  63                 const CString& mergedname = CString(), bool bReadOnly = false, HWND resolveMsgHwnd = nullptr);
  64
  65         /**
  66          * Starts the external patch program (currently always TortoiseGitMerge)
  67          */
  68         static BOOL StartExtPatch(const CTGitPath& patchfile, const CTGitPath& dir,
  69                         const CString& sOriginalDescription = CString(), const CString& sPatchedDescription = CString(),
  70                         BOOL bReversed = FALSE, BOOL bWait = FALSE);
  71
  72         /**
  73          * Starts the external unified diff viewer (the app associated with *.diff or *.patch files).
  74          * If no app is associated with those file types, the default text editor is used.
  75          */
  76         static BOOL StartUnifiedDiffViewer(const CString& patchfile, const CString& title, BOOL bWait = FALSE);
  77
  78         /**
  79          * Sets up all the default diff and merge scripts.
  80          * \param force if true, overwrite all existing entries
  81          * \param either "Diff", "Merge" or an empty string
  82          */
  83         static bool SetupDiffScripts(bool force, const CString& type);
  84
  85         /**
  86          * Starts the external diff application
  87          */
  88         static bool StartExtDiff(
  89                 const CString& file1, const CString& file2,
  90                 const CString& sName1, const CString& sName2,
  91                 const CString& originalFile1, const CString& originalFile2,
  92                 const git_revnum_t& hash1, const git_revnum_t& hash2, const DiffFlags& flags, int jumpToLine = 0);
  93
  94         /**
  95          * Launches the standard text viewer/editor application which is associated
  96          * with txt files.
  97          * \return TRUE if the program could be started.
  98          */
  99         static BOOL StartTextViewer(CString file);
 100
 101         /**
 102          * Checks if the given file has a size of less than four, which means
 103          * an 'empty' file or just newlines, i.e. an empty diff.
 104          */
 105         static BOOL CheckForEmptyDiff(const CTGitPath& sDiffPath);
 106
 107         /**
 108          * Create a font which can is used for log messages, etc
 109          */
 110         static void CreateFontForLogs(CFont& fontToCreate);
 111
 112         /**
 113         * Launch the external blame viewer
 114         */
 115         static bool LaunchTortoiseBlame(
 116                 const CString& sBlameFile, CString Rev, const CString& sParams = CString());
 117
 118         /**
 119         * Launch alternative editor
 120         */
 121         static bool LaunchAlternativeEditor(const CString& filename, bool uac = false);
 122
 123         /**
 124         * Sets the title of a dialog
 125         */
 126         static void SetWindowTitle(HWND hWnd, const CString& urlorpath, const CString& dialogname);
 127
 128         /**
 129          * Formats text in a rich edit control (version 2).
 130          * text in between * chars is formatted bold
 131          * text in between ^ chars is formatted italic
 132          * text in between _ chars is underlined
 133          */
 134         static bool FormatTextInRichEditControl(CWnd * pWnd);
 135         static bool FindStyleChars(const CString& sText, TCHAR stylechar, int& start, int& end);
 136
 137         /**
 138          * Replacement for GitDiff::ShowUnifiedDiff(), but started as a separate process.
 139          */
 140         static bool StartShowUnifiedDiff(HWND hWnd, const CTGitPath& url1,  const git_revnum_t& rev1,
 141                                                                                                 const CTGitPath & url2, const git_revnum_t& rev2,
 142
 143                                                                                                 //const GitRev& peg = GitRev(), const GitRev& headpeg = GitRev(),
 144                                                                                                 bool bAlternateDiff = false,
 145                                                                                                 bool bIgnoreAncestry = false,
 146                                                                                                 bool blame  = false,
 147                                                                                                 bool bMerge = false,
 148                                                                                                 bool bCompact = false);
 149
 150         static bool Export(CString *BashHash = nullptr, const CTGitPath *orgPath = nullptr);
 151         static bool CreateBranchTag(bool IsTag=TRUE,CString *CommitHash=NULL, bool switch_new_brach=false);
 152         static bool Switch(CString initialRefName = CString());
 153         static bool PerformSwitch(CString ref, bool bForce = false, CString sNewBranch = CString(), bool bBranchOverride = false, BOOL bTrack = 2, bool bMerge = false);
 154
 155         static bool IgnoreFile(CTGitPathList &filelist,bool IsMask);
 156         static bool GitReset(CString *CommitHash,int type=1);
 157         static bool ConflictEdit(CTGitPath& file, bool bAlternativeTool = false, bool revertTheirMy = false, HWND resolveMsgHwnd = nullptr);
 158
 159         static CString GetMergeTempFile(CString str,CTGitPath &merge);
 160         static bool     StashSave(const CString& msg = CString());
 161         static bool StashApply(CString ref, bool showChanges = true);
 162         static bool     StashPop(bool showChanges = true);
 163
 164         static bool IsSSHPutty();
 165
 166         static bool LaunchRemoteSetting();
 167
 168         static bool LaunchPAgent(const CString* keyfile = nullptr, const CString* pRemote = nullptr);
 169
 170         static CString GetClipboardLink(const CString &skipGitPrefix = _T(""), int paramsCount = 0);
 171         static CString ChooseRepository(CString *path);
 172
 173         static bool SendPatchMail(CTGitPathList &pathlist, bool bIsMainWnd = false);
 174         static bool SendPatchMail(CString &cmd,CString &formatpatchoutput, bool bIsMainWnd = false);
 175
 176         static int  SaveCommitUnicodeFile(CString &filename, CString &mesage);
 177
 178         static int  GetLogOutputEncode(CGit *pGit=&g_Git);
 179
 180         static bool Pull(bool showPush = false);
 181         static bool Fetch(CString remoteName = _T(""), bool allowRebase = false, bool allRemotes = false);
 182         static bool Push(CString selectLocalBranch = CString());
 183         static bool RequestPull(CString endrevision = _T(""), CString repositoryUrl = _T(""), bool bIsMainWnd = false);
 184
 185         static bool CreateMultipleDirectory(const CString &dir);
 186
 187         static void RemoveTrailSlash(CString &path);
 188
 189         static bool CheckUserData();
 190
 191         static BOOL Commit(CString bugid,BOOL bWholeProject,CString &sLogMsg,
 192                                         CTGitPathList &pathList,
 193                                         CTGitPathList &selectedList,
 194                                         bool bSelectFilesForCommit);
 195
 196         static BOOL SVNDCommit();
 197         static BOOL Merge(CString *commit =NULL);
 198         static BOOL MergeAbort();
 199         static void RemoveTempMergeFile(CTGitPath &path);
 200         static void EditNote(GitRev *hash);
 201         static int GetMsysgitVersion();
 202         static void MarkWindowAsUnpinnable(HWND hWnd);
 203
 204         static bool BisectStart(CString lastGood, CString firstBad, bool bIsMainWnd = false);
 205
 206         static int      Git2GetUserPassword(git_cred **out, const char *url, const char *username_from_url, unsigned int allowed_types, void *payload);
 207
 208         static void ExploreTo(HWND hwnd, CString path);
 209
 210 private:
 211         static CString PickDiffTool(const CTGitPath& file1, const CTGitPath& file2);
 212
 213         static bool OpenIgnoreFile(CIgnoreFile &file, const CString& filename);
 214
 215         static void DescribeConflictFile(bool mode, bool base,CString &descript);
 216 };