src/Utils/PathUtils.h

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