src/TortoiseProc/AppUtils.h

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