xpcom/glue/nsCRTGlue.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsCRTGlue_h__
   8 #define nsCRTGlue_h__
   9
  10 #include "nscore.h"
  11
  12 /**
  13  * Scan a string for the first character that is *not* in a set of
  14  * delimiters.  If the string is only delimiter characters, the end of the
  15  * string is returned.
  16  *
  17  * @param aDelims The set of delimiters (null-terminated)
  18  * @param aStr    The string to search (null-terminated)
  19  */
  20 const char* NS_strspnp(const char* aDelims, const char* aStr);
  21
  22 /**
  23  * Tokenize a string. This function is similar to the strtok function in the
  24  * C standard library, but it does not use static variables to maintain state
  25  * and is therefore thread and reentrancy-safe.
  26  *
  27  * Any leading delimiters in str are skipped. Then the string is scanned
  28  * until an additional delimiter or end-of-string is found. The final
  29  * delimiter is set to '\0'.
  30  *
  31  * @param aDelims The set of delimiters.
  32  * @param aStr    The string to search. This is an in-out parameter; it is
  33  *                reset to the end of the found token + 1, or to the
  34  *                end-of-string if there are no more tokens.
  35  * @return        The token. If no token is found (the string is only
  36  *                delimiter characters), nullptr is returned.
  37  */
  38 char* NS_strtok(const char* aDelims, char** aStr);
  39
  40 /**
  41  * "strlen" for char16_t strings
  42  */
  43 uint32_t NS_strlen(const char16_t* aString);
  44
  45 /**
  46  * "strcmp" for char16_t strings
  47  */
  48 int NS_strcmp(const char16_t* aStrA, const char16_t* aStrB);
  49
  50 /**
  51  * "strdup" for char16_t strings, uses the NS_Alloc allocator.
  52  */
  53 char16_t* NS_strdup(const char16_t* aString);
  54
  55 /**
  56  * "strdup", but using the NS_Alloc allocator.
  57  */
  58 char* NS_strdup(const char* aString);
  59
  60 /**
  61  * strndup for char16_t strings... this function will ensure that the
  62  * new string is null-terminated. Uses the NS_Alloc allocator.
  63  */
  64 char16_t* NS_strndup(const char16_t* aString, uint32_t aLen);
  65
  66 // The following case-conversion methods only deal in the ascii repertoire
  67 // A-Z and a-z
  68
  69 // semi-private data declarations... don't use these directly.
  70 class nsLowerUpperUtils
  71 {
  72 public:
  73   static const unsigned char kLower2Upper[256];
  74   static const unsigned char kUpper2Lower[256];
  75 };
  76
  77 inline char
  78 NS_ToUpper(char aChar)
  79 {
  80   return (char)nsLowerUpperUtils::kLower2Upper[(unsigned char)aChar];
  81 }
  82
  83 inline char
  84 NS_ToLower(char aChar)
  85 {
  86   return (char)nsLowerUpperUtils::kUpper2Lower[(unsigned char)aChar];
  87 }
  88
  89 bool NS_IsUpper(char aChar);
  90 bool NS_IsLower(char aChar);
  91
  92 bool NS_IsAscii(char16_t aChar);
  93 bool NS_IsAscii(const char16_t* aString);
  94 bool NS_IsAsciiAlpha(char16_t aChar);
  95 bool NS_IsAsciiDigit(char16_t aChar);
  96 bool NS_IsAsciiWhitespace(char16_t aChar);
  97 bool NS_IsAscii(const char* aString);
  98 bool NS_IsAscii(const char* aString, uint32_t aLength);
  99
 100 #ifndef XPCOM_GLUE_AVOID_NSPR
 101 void NS_MakeRandomString(char* aBuf, int32_t aBufLen);
 102 #endif
 103
 104 #define FF '\f'
 105 #define TAB '\t'
 106
 107 #define CRSTR "\015"
 108 #define LFSTR "\012"
 109 #define CRLF "\015\012"     /* A CR LF equivalent string */
 110
 111 // We use the most restrictive filesystem as our default set of illegal filename
 112 // characters. This is currently Windows.
 113 #define OS_FILE_ILLEGAL_CHARACTERS "/:*?\"<>|"
 114 // We also provide a list of all known file path separators for all filesystems.
 115 // This can be used in replacement of FILE_PATH_SEPARATOR when you need to
 116 // identify or replace all known path separators.
 117 #define KNOWN_PATH_SEPARATORS "\\/"
 118
 119 #if defined(XP_MACOSX)
 120   #define FILE_PATH_SEPARATOR        "/"
 121 #elif defined(XP_WIN)
 122   #define FILE_PATH_SEPARATOR        "\\"
 123 #elif defined(XP_UNIX)
 124   #define FILE_PATH_SEPARATOR        "/"
 125 #else
 126   #error need_to_define_your_file_path_separator_and_maybe_illegal_characters
 127 #endif
 128
 129 // Not all these control characters are illegal in all OSs, but we don't really
 130 // want them appearing in filenames
 131 #define CONTROL_CHARACTERS     "\001\002\003\004\005\006\007" \
 132                            "\010\011\012\013\014\015\016\017" \
 133                            "\020\021\022\023\024\025\026\027" \
 134                            "\030\031\032\033\034\035\036\037"
 135
 136 #define FILE_ILLEGAL_CHARACTERS CONTROL_CHARACTERS OS_FILE_ILLEGAL_CHARACTERS
 137
 138 #endif // nsCRTGlue_h__