src/Utils/StringUtils.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2010 - TortoiseSVN
   4 // Copyright (C) 2015-2016 - TortoiseGit
   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 #ifdef UNICODE
  23 #define wcswildcmp wcswildcmp
  24 #else
  25 #define wcswildcmp strwildcmp
  26 #endif
  27
  28 /**
  29  * \ingroup Utils
  30  * Performs a wild card compare of two strings.
  31  * \param wild the wild card string
  32  * \param string the string to compare the wild card to
  33  * \return TRUE if the wild card matches the string, 0 otherwise
  34  * \par example
  35  * \code
  36  * if (strwildcmp("bl?hblah.*", "bliblah.jpeg"))
  37  *  printf("success\n");
  38  * else
  39  *  printf("not found\n");
  40  * if (strwildcmp("bl?hblah.*", "blabblah.jpeg"))
  41  *  printf("success\n");
  42  * else
  43  *  printf("not found\n");
  44  * \endcode
  45  * The output of the above code would be:
  46  * \code
  47  * success
  48  * not found
  49  * \endcode
  50  */
  51 int strwildcmp(const char * wild, const char * string);
  52 int wcswildcmp(const wchar_t * wild, const wchar_t * string);
  53
  54
  55 /**
  56  * \ingroup Utils
  57  * string helper functions
  58  */
  59 class CStringUtils
  60 {
  61 public:
  62         CStringUtils() = delete;
  63 #ifdef _MFC_VER
  64
  65         /**
  66          * Removes all '&' chars from a string.
  67          */
  68         static void RemoveAccelerators(CString& text);
  69
  70         /**
  71          * Returns the accellerator used in the string or \0
  72          */
  73         static TCHAR GetAccellerator(const CString& text);
  74
  75         /**
  76          * Writes an ASCII CString to the clipboard in CF_TEXT format
  77          */
  78         static bool WriteAsciiStringToClipboard(const CStringA& sClipdata, LCID lcid, HWND hOwningWnd = nullptr);
  79         /**
  80          * Writes a String to the clipboard in both CF_UNICODETEXT and CF_TEXT format
  81          */
  82         static bool WriteAsciiStringToClipboard(const CStringW& sClipdata, HWND hOwningWnd = nullptr);
  83
  84         /**
  85         * Writes an ASCII CString to the clipboard in TGIT_UNIFIEDDIFF format, which is basically the patch file
  86         * as a ASCII string.
  87         */
  88         static bool WriteDiffToClipboard(const CStringA& sClipdata, HWND hOwningWnd = nullptr);
  89
  90         /**
  91          * Reads the string \text from the file \path in utf8 encoding.
  92          */
  93         static bool ReadStringFromTextFile(const CString& path, CString& text);
  94
  95 #endif
  96 #if defined(CSTRING_AVAILABLE) || defined(_MFC_VER)
  97         static BOOL WildCardMatch(const CString& wildcard, const CString& string);
  98         static CString LinesWrap(const CString& longstring, int limit = 80, bool bCompactPaths = false);
  99         static CString WordWrap(const CString& longstring, int limit, bool bCompactPaths, bool bForceWrap, int tabSize);
 100         /**
 101          * Find and return the number n of starting characters equal between
 102          * \ref lhs and \ref rhs. (max n: lhs.Left(n) == rhs.Left(n))
 103          */
 104         static int GetMatchingLength (const CString& lhs, const CString& rhs);
 105
 106         /**
 107          * Optimizing wrapper around CompareNoCase.
 108          */
 109         static int FastCompareNoCase (const CStringW& lhs, const CStringW& rhs);
 110
 111         static void ParseEmailAddress(CString mailaddress, CString& parsedAddress, CString* parsedName = nullptr);
 112
 113         static bool IsPlainReadableASCII(const CString& text);
 114
 115         static bool StartsWith(const wchar_t* heystack, const CString& needle);
 116         static bool StartsWithI(const wchar_t* heystack, const CString& needle);
 117         static bool WriteStringToTextFile(LPCTSTR path, LPCTSTR text, bool bUTF8 = true);
 118         static bool EndsWith(const CString& heystack, const wchar_t* needle);
 119         static bool EndsWith(const CString& heystack, const wchar_t needle);
 120         static bool EndsWithI(const CString& heystack, const wchar_t* needle);
 121 #endif
 122         static bool StartsWith(const wchar_t* heystack, const wchar_t* needle);
 123         static bool StartsWith(const char* heystack, const char* needle);
 124
 125         /**
 126          * Writes the string \text to the file \path, either in utf16 or utf8 encoding,
 127          * depending on the \c bUTF8 param.
 128          */
 129         static bool WriteStringToTextFile(const std::wstring& path, const std::wstring& text, bool bUTF8 = true);
 130
 131         /**
 132          * Replace all pipe (|) character in the string with a nullptr character. Used
 133          * for passing into Win32 functions that require such representation
 134          */
 135         static void PipesToNulls(TCHAR* buffer, size_t length);
 136         static void PipesToNulls(TCHAR* buffer);
 137 };
 138