src/Utils/PathUtils.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2016-2017 - TortoiseGit
   4 // Copyright (C) 2003-2008, 2013-2014 - 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 #if defined(_MFC_VER)
  23 // CSTRING is always available in an MFC build
  24 #define CSTRING_AVAILABLE
  25 #endif
  26
  27 /**
  28  * \ingroup Utils
  29  * helper class to handle path strings.
  30  */
  31 class CPathUtils
  32 {
  33 public:
  34         CPathUtils() = delete;
  35         static BOOL                     MakeSureDirectoryPathExists(LPCTSTR path);
  36         static void                     ConvertToBackslash(LPTSTR dest, LPCTSTR src, size_t len);
  37         /**
  38          * Replaces escaped sequences with the corresponding characters in a string.
  39          */
  40         static void Unescape(char * psz);
  41
  42         /**
  43          * Replaces non-URI chars with the corresponding escape sequences.
  44          */
  45         static CStringA PathEscape(const CStringA& path);
  46
  47
  48 #ifdef CSTRING_AVAILABLE
  49         /**
  50          * returns the filename of a full path
  51          */
  52         static CString GetFileNameFromPath(CString sPath);
  53
  54         /**
  55          * returns the file extension from a full path
  56          */
  57         static CString GetFileExtFromPath(const CString& sPath);
  58
  59         /**
  60          * Returns the long pathname of a path which may be in 8.3 format.
  61          */
  62         static CString GetLongPathname(const CString& path);
  63
  64         /**
  65          * Copies a file or a folder from \a srcPath to \a destpath, creating
  66          * intermediate folders if necessary. If \a force is TRUE, then files
  67          * are overwritten if they already exist.
  68          * Folders are just created at the new location, no files in them get
  69          * copied.
  70          */
  71         static BOOL FileCopy(CString srcPath, CString destPath, BOOL force = TRUE);
  72
  73         /**
  74          * parses a string for a path or url. If no path or url is found,
  75          * an empty string is returned.
  76          * \remark if more than one path or url is inside the string, only
  77          * the first one is returned.
  78          */
  79         static CString ParsePathInString(const CString& Str);
  80
  81         /**
  82          * Returns the path to the installation folder, in our case the TortoiseSVN/bin folder.
  83          * \remark the path returned has a trailing backslash
  84          */
  85         static CString GetAppDirectory(HMODULE hMod = nullptr);
  86
  87         /**
  88          * Returns the path to the installation parent folder, in our case the TortoiseSVN folder.
  89          * \remark the path returned has a trailing backslash
  90          */
  91         static CString GetAppParentDirectory(HMODULE hMod = nullptr);
  92
  93         static CString GetDocumentsDirectory();
  94         static CString GetProgramsDirectory();
  95
  96         /**
  97          * Returns the path to the application data folder, in our case the %APPDATA%TortoiseSVN folder.
  98          * \remark the path returned has a trailing backslash
  99          */
 100         static CString GetAppDataDirectory();
 101         static CString GetLocalAppDataDirectory();
 102
 103         /**
 104          * Replaces escaped sequences with the corresponding characters in a string.
 105          */
 106         static CStringA PathUnescape(const CStringA& path);
 107         static CStringW PathUnescape(const CStringW& path);
 108
 109         /**
 110         * Escapes regexp-specific chars.
 111         */
 112         static CString PathPatternEscape(const CString& path);
 113         /**
 114          * Unescapes regexp-specific chars.
 115          */
 116         static CString PathPatternUnEscape(const CString& path);
 117
 118         /**
 119          * Returns the version string from the VERSION resource of a dll or exe.
 120          * \param p_strFilename path to the dll or exe
 121          * \return the version string
 122          */
 123         static CString GetVersionFromFile(const CString & p_strFilename);
 124
 125         static CString GetCopyrightForSelf();
 126 #endif
 127 };