// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+/** @ingroup group_funcmacro_string */
+//@{
+
/**
-Returns a negative value, 0, or positive value if @a p1 is less than, equal
-to or greater than @e p2. The comparison is case-sensitive.
-This function complements the standard C function @e stricmp() which performs
-case-insensitive comparison.
-*/
-int wxStrcmp(const char* p1, const char* p2);
+ @return @true if the pointer is either @NULL or points to an empty string,
+ @false otherwise.
+ @header{wx/wxcrt.h}
+*/
+bool wxIsEmpty(const char* p);
/**
-@b NB: This function is obsolete, use wxString instead.
-A macro defined as:
+ This is a safe version of standard function @e strlen(): it does exactly
+ the same thing (i.e. returns the length of the string) except that it
+ returns 0 if @a p is the @NULL pointer.
-@code
-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
-@endcode
+ @header{wx/wxcrt.h}
*/
-bool wxStringEq(const wxString& s1, const wxString& s2);
+size_t wxStrlen(const char* p);
/**
- @b NB: This function is obsolete, use wxString::Find instead.
- Returns @true if the substring @a s1 is found within @e s2,
- ignoring case if @a exact is @false. If @a subString is @false,
- no substring matching is done.
+ This function complements the standard C function @e stricmp() which
+ performs case-insensitive comparison.
+
+ @return A negative value, 0, or positive value if @a p1 is less than,
+ equal to or greater than @a p2. The comparison is case-sensitive.
+
+ @header{wx/wxcrt.h}
*/
-bool wxStringMatch(const wxString& s1, const wxString& s2,
- bool subString = true,
- bool exact = false);
+int wxStrcmp(const char* p1, const char* p2);
/**
- This function replaces the dangerous standard function @c sprintf() and is
- like @c snprintf() available on some platforms. The only difference with
- sprintf() is that an additional argument - buffer size - is taken and the
- buffer is never overflowed.
- Returns the number of characters copied to the buffer or -1 if there is not
- enough space.
+ This function complements the standard C function @e strcmp() which performs
+ case-sensitive comparison.
+
+ @return A negative value, 0, or positive value if @a p1 is less than,
+ equal to or greater than @e p2. The comparison is case-insensitive.
- @see wxVsnprintf(), wxString::Printf
+ @header{wx/wxcrt.h}
*/
-int wxSnprintf(wxChar* buf, size_t len, const wxChar* format,
- ...);
+int wxStricmp(const char* p1, const char* p2);
/**
- This is a convenience function wrapping
- wxStringTokenizer which simply returns all tokens
- found in the given @a str in an array.
- Please see
- wxStringTokenizer::wxStringTokenizer
- for the description of the other parameters.
+ @deprecated Use wxString instead.
+
+ This macro is defined as:
+
+ @code
+ #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
+ @endcode
+
+ @header{wx/wxcrt.h}
*/
-wxArrayString wxStringTokenize(const wxString& str,
- const wxString& delims = wxDEFAULT_DELIMITERS,
- wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
+bool wxStringEq(const wxString& s1, const wxString& s2);
/**
- This is a safe version of standard function @e strlen(): it does exactly the
- same thing (i.e. returns the length of the string) except that it returns 0 if
- @a p is the @NULL pointer.
+ @deprecated Use wxString::Find() instead.
+
+ Returns @true if the substring @a s1 is found within @a s2, ignoring case
+ if @a exact is @false. If @a subString is @false, no substring matching is
+ done.
+
+ @header{wx/wxcrt.h}
*/
-size_t wxStrlen(const char* p);
+bool wxStringMatch(const wxString& s1, const wxString& s2,
+ bool subString = true, bool exact = false);
/**
- The same as wxSnprintf() but takes a @c va_list
- argument instead of arbitrary number of parameters.
- Note that if @c wxUSE_PRINTF_POS_PARAMS is set to 1, then this function supports
- positional arguments (see wxString::Printf for more information).
- However other functions of the same family (wxPrintf, wxSprintf, wxFprintf,
- wxVfprintf,
- wxVfprintf, wxVprintf, wxVsprintf) currently do not to support positional
- parameters
- even when @c wxUSE_PRINTF_POS_PARAMS is 1.
-
- @see wxSnprintf(), wxString::PrintfV
+ This is a convenience function wrapping wxStringTokenizer which simply
+ returns all tokens found in the given @a string in an array.
+
+ Please see wxStringTokenizer::wxStringTokenizer() for a description of the
+ other parameters.
+
+ @header{wx/wxcrt.h}
*/
-int wxVsnprintf(wxChar* buf, size_t len, const wxChar* format,
- va_list argPtr);
+wxArrayString wxStringTokenize(const wxString& string,
+ const wxString& delims = wxDEFAULT_DELIMITERS,
+ wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
/**
- Returns @true if the pointer is either @NULL or points to an empty
- string, @false otherwise.
+ This function replaces the dangerous standard function @e sprintf() and is
+ like @e snprintf() available on some platforms. The only difference with
+ @e sprintf() is that an additional argument - buffer size - is taken and
+ the buffer is never overflowed.
+
+ Returns the number of characters copied to the buffer or -1 if there is not
+ enough space.
+
+ @see wxVsnprintf(), wxString::Printf()
+
+ @header{wx/wxcrt.h}
*/
-bool wxIsEmpty(const char* p);
+int wxSnprintf(wxChar* buf, size_t len, const wxChar* format, ...);
/**
- Returns a negative value, 0, or positive value if @a p1 is less than, equal
- to or greater than @e p2. The comparison is case-insensitive.
- This function complements the standard C function @e strcmp() which performs
- case-sensitive comparison.
+ The same as wxSnprintf() but takes a @c va_list argument instead of an
+ arbitrary number of parameters.
+
+ @note If @c wxUSE_PRINTF_POS_PARAMS is set to 1, then this function
+ supports positional arguments (see wxString::Printf() for more
+ information). However other functions of the same family (wxPrintf(),
+ wxSprintf(), wxFprintf(), wxVfprintf(), wxVfprintf(), wxVprintf(),
+ wxVsprintf()) currently do not to support positional parameters even
+ when @c wxUSE_PRINTF_POS_PARAMS is 1.
+
+ @see wxSnprintf(), wxString::PrintfV()
+
+ @header{wx/wxcrt.h}
*/
-int wxStricmp(const char* p1, const char* p2);
+int wxVsnprintf(wxChar* buf, size_t len,
+ const wxChar* format, va_list argPtr);
+
+//@}
projects / wxWidgets.git / blobdiff