2 * String manipulation functions
4 * Copyright 1998 Eric Kohl
5 * 1998 Juergen Schmied <j.schmied@metronet.de>
6 * 2000 Eric Kohl for CodeWeavers
7 * Copyright 2002 Jon Griffiths
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26 #include "wine/port.h"
30 #include <stdlib.h> /* atoi */
39 #include "wine/unicode.h"
41 #include "wine/debug.h"
43 WINE_DEFAULT_DEBUG_CHANNEL(commctrl);
45 /*************************************************************************
46 * COMCTL32_ChrCmpHelperA
48 * Internal helper for ChrCmpA/COMCTL32_ChrCmpIA.
51 * Both this function and its Unicode counterpart are very inefficient. To
52 * fix this, CompareString must be completely implemented and optimised
53 * first. Then the core character test can be taken out of that function and
54 * placed here, so that it need never be called at all. Until then, do not
55 * attempt to optimise this code unless you are willing to test that it
56 * still performs correctly.
58 static BOOL COMCTL32_ChrCmpHelperA(WORD ch1, WORD ch2, DWORD dwFlags)
60 char str1[3], str2[3];
62 str1[0] = LOBYTE(ch1);
63 if (IsDBCSLeadByte(str1[0]))
65 str1[1] = HIBYTE(ch1);
71 str2[0] = LOBYTE(ch2);
72 if (IsDBCSLeadByte(str2[0]))
74 str2[1] = HIBYTE(ch2);
80 return CompareStringA(GetThreadLocale(), dwFlags, str1, -1, str2, -1) - 2;
83 /*************************************************************************
84 * COMCTL32_ChrCmpA (internal)
86 * Internal helper function.
88 static BOOL COMCTL32_ChrCmpA(WORD ch1, WORD ch2)
90 return COMCTL32_ChrCmpHelperA(ch1, ch2, 0);
93 /*************************************************************************
94 * COMCTL32_ChrCmpIA (internal)
96 * Compare two characters, ignoring case.
99 * ch1 [I] First character to compare
100 * ch2 [I] Second character to compare
103 * FALSE, if the characters are equal.
104 * Non-zero otherwise.
106 static BOOL COMCTL32_ChrCmpIA(WORD ch1, WORD ch2)
108 TRACE("(%d,%d)\n", ch1, ch2);
110 return COMCTL32_ChrCmpHelperA(ch1, ch2, NORM_IGNORECASE);
113 /*************************************************************************
116 * Internal helper function.
118 static inline BOOL COMCTL32_ChrCmpIW(WCHAR ch1, WCHAR ch2)
120 return CompareStringW(GetThreadLocale(), NORM_IGNORECASE, &ch1, 1, &ch2, 1) - 2;
123 /**************************************************************************
124 * Str_GetPtrA [COMCTL32.233]
126 * Copies a string into a destination buffer.
129 * lpSrc [I] Source string
130 * lpDest [O] Destination buffer
131 * nMaxLen [I] Size of buffer in characters
134 * The number of characters copied.
136 INT WINAPI Str_GetPtrA (LPCSTR lpSrc, LPSTR lpDest, INT nMaxLen)
140 TRACE("(%p %p %d)\n", lpSrc, lpDest, nMaxLen);
142 if ((!lpDest || nMaxLen == 0) && lpSrc)
143 return (strlen(lpSrc) + 1);
153 len = strlen(lpSrc) + 1;
157 RtlMoveMemory (lpDest, lpSrc, len - 1);
158 lpDest[len - 1] = '\0';
163 /**************************************************************************
164 * Str_SetPtrA [COMCTL32.234]
166 * Makes a copy of a string, allocating memory if necessary.
169 * lppDest [O] Pointer to destination string
170 * lpSrc [I] Source string
177 * Set lpSrc to NULL to free the memory allocated by a previous call
180 BOOL WINAPI Str_SetPtrA (LPSTR *lppDest, LPCSTR lpSrc)
182 TRACE("(%p %p)\n", lppDest, lpSrc);
185 LPSTR ptr = ReAlloc (*lppDest, strlen (lpSrc) + 1);
199 /**************************************************************************
200 * Str_GetPtrW [COMCTL32.235]
204 INT WINAPI Str_GetPtrW (LPCWSTR lpSrc, LPWSTR lpDest, INT nMaxLen)
208 TRACE("(%p %p %d)\n", lpSrc, lpDest, nMaxLen);
210 if (!lpDest && lpSrc)
211 return strlenW (lpSrc);
221 len = strlenW (lpSrc);
225 RtlMoveMemory (lpDest, lpSrc, len*sizeof(WCHAR));
231 /**************************************************************************
232 * Str_SetPtrW [COMCTL32.236]
236 BOOL WINAPI Str_SetPtrW (LPWSTR *lppDest, LPCWSTR lpSrc)
238 TRACE("(%p %p)\n", lppDest, lpSrc);
241 INT len = strlenW (lpSrc) + 1;
242 LPWSTR ptr = ReAlloc (*lppDest, len * sizeof(WCHAR));
245 strcpyW (ptr, lpSrc);
256 /**************************************************************************
257 * StrChrA [COMCTL32.350]
259 * Find a given character in a string.
262 * lpszStr [I] String to search in.
263 * ch [I] Character to search for.
266 * Success: A pointer to the first occurrence of ch in lpszStr, or NULL if
268 * Failure: NULL, if any arguments are invalid.
270 LPSTR WINAPI StrChrA(LPCSTR lpszStr, WORD ch)
272 TRACE("(%s,%i)\n", debugstr_a(lpszStr), ch);
278 if (!COMCTL32_ChrCmpA(*lpszStr, ch))
279 return (LPSTR)lpszStr;
280 lpszStr = CharNextA(lpszStr);
286 /**************************************************************************
287 * StrCmpNIA [COMCTL32.353]
289 * Compare two strings, up to a maximum length, ignoring case.
292 * lpszStr [I] First string to compare
293 * lpszComp [I] Second string to compare
294 * iLen [I] Maximum number of chars to compare.
297 * An integer less than, equal to or greater than 0, indicating that
298 * lpszStr is less than, the same, or greater than lpszComp.
300 INT WINAPI StrCmpNIA(LPCSTR lpszStr, LPCSTR lpszComp, INT iLen)
304 TRACE("(%s,%s,%i)\n", debugstr_a(lpszStr), debugstr_a(lpszComp), iLen);
306 iRet = CompareStringA(GetThreadLocale(), NORM_IGNORECASE, lpszStr, iLen, lpszComp, iLen);
307 return iRet == CSTR_LESS_THAN ? -1 : iRet == CSTR_GREATER_THAN ? 1 : 0;
310 /*************************************************************************
311 * StrCmpNIW [COMCTL32.361]
315 INT WINAPI StrCmpNIW(LPCWSTR lpszStr, LPCWSTR lpszComp, INT iLen)
319 TRACE("(%s,%s,%i)\n", debugstr_w(lpszStr), debugstr_w(lpszComp), iLen);
321 iRet = CompareStringW(GetThreadLocale(), NORM_IGNORECASE, lpszStr, iLen, lpszComp, iLen);
322 return iRet == CSTR_LESS_THAN ? -1 : iRet == CSTR_GREATER_THAN ? 1 : 0;
325 /*************************************************************************
326 * COMCTL32_StrStrHelperA
328 * Internal implementation of StrStrA/StrStrIA
330 static LPSTR COMCTL32_StrStrHelperA(LPCSTR lpszStr, LPCSTR lpszSearch,
331 INT (WINAPI *pStrCmpFn)(LPCSTR,LPCSTR,INT))
335 if (!lpszStr || !lpszSearch || !*lpszSearch)
338 iLen = strlen(lpszSearch);
342 if (!pStrCmpFn(lpszStr, lpszSearch, iLen))
343 return (LPSTR)lpszStr;
344 lpszStr = CharNextA(lpszStr);
349 /**************************************************************************
350 * StrStrIA [COMCTL32.355]
352 * Find a substring within a string, ignoring case.
355 * lpszStr [I] String to search in
356 * lpszSearch [I] String to look for
359 * The start of lpszSearch within lpszStr, or NULL if not found.
361 LPSTR WINAPI StrStrIA(LPCSTR lpszStr, LPCSTR lpszSearch)
363 TRACE("(%s,%s)\n", debugstr_a(lpszStr), debugstr_a(lpszSearch));
365 return COMCTL32_StrStrHelperA(lpszStr, lpszSearch, StrCmpNIA);
368 /**************************************************************************
369 * StrToIntA [COMCTL32.357]
371 * Read a signed integer from a string.
374 * lpszStr [I] String to read integer from
377 * The signed integer value represented by the string, or 0 if no integer is
380 INT WINAPI StrToIntA (LPCSTR lpszStr)
382 return atoi(lpszStr);
385 /**************************************************************************
386 * StrStrIW [COMCTL32.363]
390 LPWSTR WINAPI StrStrIW(LPCWSTR lpszStr, LPCWSTR lpszSearch)
394 TRACE("(%s,%s)\n", debugstr_w(lpszStr), debugstr_w(lpszSearch));
396 if (!lpszStr || !lpszSearch || !*lpszSearch)
399 iLen = strlenW(lpszSearch);
403 if (!StrCmpNIW(lpszStr, lpszSearch, iLen))
404 return (LPWSTR)lpszStr;
410 /**************************************************************************
411 * StrToIntW [COMCTL32.365]
415 INT WINAPI StrToIntW (LPCWSTR lpString)
417 return atoiW(lpString);
420 /*************************************************************************
421 * COMCTL32_StrSpnHelperA (internal)
423 * Internal implementation of StrSpnA/StrCSpnA/StrCSpnIA
425 static int COMCTL32_StrSpnHelperA(LPCSTR lpszStr, LPCSTR lpszMatch,
426 LPSTR (WINAPI *pStrChrFn)(LPCSTR,WORD),
429 LPCSTR lpszRead = lpszStr;
430 if (lpszStr && *lpszStr && lpszMatch)
434 LPCSTR lpszTest = pStrChrFn(lpszMatch, *lpszRead);
436 if (!bInvert && !lpszTest)
438 if (bInvert && lpszTest)
440 lpszRead = CharNextA(lpszRead);
443 return lpszRead - lpszStr;
446 /**************************************************************************
447 * StrCSpnA [COMCTL32.356]
449 * Find the length of the start of a string that does not contain certain
453 * lpszStr [I] String to search
454 * lpszMatch [I] Characters that cannot be in the substring
457 * The length of the part of lpszStr containing only chars not in lpszMatch,
458 * or 0 if any parameter is invalid.
460 int WINAPI StrCSpnA(LPCSTR lpszStr, LPCSTR lpszMatch)
462 TRACE("(%s,%s)\n",debugstr_a(lpszStr), debugstr_a(lpszMatch));
464 return COMCTL32_StrSpnHelperA(lpszStr, lpszMatch, StrChrA, TRUE);
467 /**************************************************************************
468 * StrChrW [COMCTL32.358]
472 LPWSTR WINAPI StrChrW(LPCWSTR lpszStr, WCHAR ch)
474 LPWSTR lpszRet = NULL;
476 TRACE("(%s,%i)\n", debugstr_w(lpszStr), ch);
479 lpszRet = strchrW(lpszStr, ch);
483 /**************************************************************************
484 * StrCmpNA [COMCTL32.352]
486 * Compare two strings, up to a maximum length.
489 * lpszStr [I] First string to compare
490 * lpszComp [I] Second string to compare
491 * iLen [I] Maximum number of chars to compare.
494 * An integer less than, equal to or greater than 0, indicating that
495 * lpszStr is less than, the same, or greater than lpszComp.
497 INT WINAPI StrCmpNA(LPCSTR lpszStr, LPCSTR lpszComp, INT iLen)
501 TRACE("(%s,%s,%i)\n", debugstr_a(lpszStr), debugstr_a(lpszComp), iLen);
503 iRet = CompareStringA(GetThreadLocale(), 0, lpszStr, iLen, lpszComp, iLen);
504 return iRet == CSTR_LESS_THAN ? -1 : iRet == CSTR_GREATER_THAN ? 1 : 0;
507 /**************************************************************************
508 * StrCmpNW [COMCTL32.360]
512 INT WINAPI StrCmpNW(LPCWSTR lpszStr, LPCWSTR lpszComp, INT iLen)
516 TRACE("(%s,%s,%i)\n", debugstr_w(lpszStr), debugstr_w(lpszComp), iLen);
518 iRet = CompareStringW(GetThreadLocale(), 0, lpszStr, iLen, lpszComp, iLen);
519 return iRet == CSTR_LESS_THAN ? -1 : iRet == CSTR_GREATER_THAN ? 1 : 0;
522 /**************************************************************************
523 * StrRChrA [COMCTL32.351]
525 * Find the last occurrence of a character in string.
528 * lpszStr [I] String to search in
529 * lpszEnd [I] Place to end search, or NULL to search until the end of lpszStr
530 * ch [I] Character to search for.
533 * Success: A pointer to the last occurrence of ch in lpszStr before lpszEnd,
534 * or NULL if not found.
535 * Failure: NULL, if any arguments are invalid.
537 LPSTR WINAPI StrRChrA(LPCSTR lpszStr, LPCSTR lpszEnd, WORD ch)
539 LPCSTR lpszRet = NULL;
541 TRACE("(%s,%s,%x)\n", debugstr_a(lpszStr), debugstr_a(lpszEnd), ch);
548 lpszEnd = lpszStr + lstrlenA(lpszStr);
550 while (*lpszStr && lpszStr <= lpszEnd)
552 ch2 = IsDBCSLeadByte(*lpszStr)? *lpszStr << 8 | lpszStr[1] : *lpszStr;
554 if (!COMCTL32_ChrCmpA(ch, ch2))
556 lpszStr = CharNextA(lpszStr);
559 return (LPSTR)lpszRet;
563 /**************************************************************************
564 * StrRChrW [COMCTL32.359]
568 LPWSTR WINAPI StrRChrW(LPCWSTR str, LPCWSTR end, WORD ch)
572 if (!str) return NULL;
573 if (!end) end = str + strlenW(str);
576 if (*str == ch) ret = (WCHAR *)str;
582 /**************************************************************************
583 * StrStrA [COMCTL32.354]
585 * Find a substring within a string.
588 * lpszStr [I] String to search in
589 * lpszSearch [I] String to look for
592 * The start of lpszSearch within lpszStr, or NULL if not found.
594 LPSTR WINAPI StrStrA(LPCSTR lpszStr, LPCSTR lpszSearch)
596 TRACE("(%s,%s)\n", debugstr_a(lpszStr), debugstr_a(lpszSearch));
598 return COMCTL32_StrStrHelperA(lpszStr, lpszSearch, StrCmpNA);
601 /**************************************************************************
602 * StrStrW [COMCTL32.362]
606 LPWSTR WINAPI StrStrW(LPCWSTR lpszStr, LPCWSTR lpszSearch)
608 if (!lpszStr || !lpszSearch) return NULL;
609 return strstrW( lpszStr, lpszSearch );
612 /*************************************************************************
613 * StrChrIA [COMCTL32.366]
615 * Find a given character in a string, ignoring case.
618 * lpszStr [I] String to search in.
619 * ch [I] Character to search for.
622 * Success: A pointer to the first occurrence of ch in lpszStr, or NULL if
624 * Failure: NULL, if any arguments are invalid.
626 LPSTR WINAPI StrChrIA(LPCSTR lpszStr, WORD ch)
628 TRACE("(%s,%i)\n", debugstr_a(lpszStr), ch);
634 if (!COMCTL32_ChrCmpIA(*lpszStr, ch))
635 return (LPSTR)lpszStr;
636 lpszStr = CharNextA(lpszStr);
642 /*************************************************************************
643 * StrChrIW [COMCTL32.367]
647 LPWSTR WINAPI StrChrIW(LPCWSTR lpszStr, WCHAR ch)
649 TRACE("(%s,%i)\n", debugstr_w(lpszStr), ch);
656 if (toupperW(*lpszStr) == ch)
657 return (LPWSTR)lpszStr;
662 return (LPWSTR)lpszStr;
665 /*************************************************************************
666 * StrRStrIA [COMCTL32.372]
668 * Find the last occurrence of a substring within a string.
671 * lpszStr [I] String to search in
672 * lpszEnd [I] End of lpszStr
673 * lpszSearch [I] String to look for
676 * The last occurrence lpszSearch within lpszStr, or NULL if not found.
678 LPSTR WINAPI StrRStrIA(LPCSTR lpszStr, LPCSTR lpszEnd, LPCSTR lpszSearch)
680 LPSTR lpszRet = NULL;
684 TRACE("(%s,%s)\n", debugstr_a(lpszStr), debugstr_a(lpszSearch));
686 if (!lpszStr || !lpszSearch || !*lpszSearch)
690 lpszEnd = lpszStr + lstrlenA(lpszStr);
692 if (IsDBCSLeadByte(*lpszSearch))
693 ch1 = *lpszSearch << 8 | lpszSearch[1];
696 iLen = lstrlenA(lpszSearch);
698 while (lpszStr <= lpszEnd && *lpszStr)
700 ch2 = IsDBCSLeadByte(*lpszStr)? *lpszStr << 8 | lpszStr[1] : *lpszStr;
701 if (!COMCTL32_ChrCmpIA(ch1, ch2))
703 if (!StrCmpNIA(lpszStr, lpszSearch, iLen))
704 lpszRet = (LPSTR)lpszStr;
706 lpszStr = CharNextA(lpszStr);
711 /*************************************************************************
712 * StrRStrIW [COMCTL32.373]
716 LPWSTR WINAPI StrRStrIW(LPCWSTR lpszStr, LPCWSTR lpszEnd, LPCWSTR lpszSearch)
718 LPWSTR lpszRet = NULL;
721 TRACE("(%s,%s)\n", debugstr_w(lpszStr), debugstr_w(lpszSearch));
723 if (!lpszStr || !lpszSearch || !*lpszSearch)
727 lpszEnd = lpszStr + strlenW(lpszStr);
729 iLen = strlenW(lpszSearch);
731 while (lpszStr <= lpszEnd && *lpszStr)
733 if (!COMCTL32_ChrCmpIW(*lpszSearch, *lpszStr))
735 if (!StrCmpNIW(lpszStr, lpszSearch, iLen))
736 lpszRet = (LPWSTR)lpszStr;
743 /*************************************************************************
744 * StrCSpnIA [COMCTL32.374]
746 * Find the length of the start of a string that does not contain certain
747 * characters, ignoring case.
750 * lpszStr [I] String to search
751 * lpszMatch [I] Characters that cannot be in the substring
754 * The length of the part of lpszStr containing only chars not in lpszMatch,
755 * or 0 if any parameter is invalid.
757 int WINAPI StrCSpnIA(LPCSTR lpszStr, LPCSTR lpszMatch)
759 TRACE("(%s,%s)\n",debugstr_a(lpszStr), debugstr_a(lpszMatch));
761 return COMCTL32_StrSpnHelperA(lpszStr, lpszMatch, StrChrIA, TRUE);
764 /*************************************************************************
765 * StrCSpnIW [COMCTL32.375]
769 int WINAPI StrCSpnIW(LPCWSTR lpszStr, LPCWSTR lpszMatch)
771 LPCWSTR lpszRead = lpszStr;
773 TRACE("(%s,%s)\n",debugstr_w(lpszStr), debugstr_w(lpszMatch));
775 if (lpszStr && *lpszStr && lpszMatch)
779 if (StrChrIW(lpszMatch, *lpszRead)) break;
783 return lpszRead - lpszStr;
786 /**************************************************************************
787 * StrRChrIA [COMCTL32.368]
789 * Find the last occurrence of a character in string, ignoring case.
792 * lpszStr [I] String to search in
793 * lpszEnd [I] Place to end search, or NULL to search until the end of lpszStr
794 * ch [I] Character to search for.
797 * Success: A pointer to the last occurrence of ch in lpszStr before lpszEnd,
798 * or NULL if not found.
799 * Failure: NULL, if any arguments are invalid.
801 LPSTR WINAPI StrRChrIA(LPCSTR lpszStr, LPCSTR lpszEnd, WORD ch)
803 LPCSTR lpszRet = NULL;
805 TRACE("(%s,%s,%x)\n", debugstr_a(lpszStr), debugstr_a(lpszEnd), ch);
812 lpszEnd = lpszStr + lstrlenA(lpszStr);
814 while (*lpszStr && lpszStr <= lpszEnd)
816 ch2 = IsDBCSLeadByte(*lpszStr)? *lpszStr << 8 | lpszStr[1] : *lpszStr;
820 lpszStr = CharNextA(lpszStr);
823 return (LPSTR)lpszRet;
826 /**************************************************************************
827 * StrRChrIW [COMCTL32.369]
831 LPWSTR WINAPI StrRChrIW(LPCWSTR str, LPCWSTR end, WORD ch)
835 if (!str) return NULL;
836 if (!end) end = str + strlenW(str);
839 if (!COMCTL32_ChrCmpIW(*str, ch)) ret = (WCHAR *)str;
845 /*************************************************************************
846 * StrCSpnW [COMCTL32.364]
850 int WINAPI StrCSpnW(LPCWSTR lpszStr, LPCWSTR lpszMatch)
852 if (!lpszStr || !lpszMatch) return 0;
853 return strcspnW( lpszStr, lpszMatch );
856 /*************************************************************************
857 * IntlStrEqWorkerA [COMCTL32.376]
859 * Compare two strings.
862 * bCase [I] Whether to compare case sensitively
863 * lpszStr [I] First string to compare
864 * lpszComp [I] Second string to compare
865 * iLen [I] Length to compare
868 * TRUE If the strings are equal.
871 BOOL WINAPI IntlStrEqWorkerA(BOOL bCase, LPCSTR lpszStr, LPCSTR lpszComp,
874 DWORD dwFlags = LOCALE_USE_CP_ACP;
877 TRACE("(%d,%s,%s,%d)\n", bCase,
878 debugstr_a(lpszStr), debugstr_a(lpszComp), iLen);
880 /* FIXME: These flags are undocumented and unknown by our CompareString.
881 * We need defines for them.
883 dwFlags |= bCase ? 0x10000000 : 0x10000001;
885 iRet = CompareStringA(GetThreadLocale(),
886 dwFlags, lpszStr, iLen, lpszComp, iLen);
889 iRet = CompareStringA(2048, dwFlags, lpszStr, iLen, lpszComp, iLen);
891 return iRet == 2 ? TRUE : FALSE;
894 /*************************************************************************
895 * IntlStrEqWorkerW [COMCTL32.377]
897 * See IntlStrEqWorkerA.
899 BOOL WINAPI IntlStrEqWorkerW(BOOL bCase, LPCWSTR lpszStr, LPCWSTR lpszComp,
905 TRACE("(%d,%s,%s,%d)\n", bCase,
906 debugstr_w(lpszStr),debugstr_w(lpszComp), iLen);
908 /* FIXME: These flags are undocumented and unknown by our CompareString.
909 * We need defines for them.
911 dwFlags = bCase ? 0x10000000 : 0x10000001;
913 iRet = CompareStringW(GetThreadLocale(),
914 dwFlags, lpszStr, iLen, lpszComp, iLen);
917 iRet = CompareStringW(2048, dwFlags, lpszStr, iLen, lpszComp, iLen);
919 return iRet == 2 ? TRUE : FALSE;