string_func.h

Go to the documentation of this file.
00001 /* $Id: string_func.h 25560 2013-07-04 21:20:05Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00026 #ifndef STRING_FUNC_H
00027 #define STRING_FUNC_H
00028 
00029 #include "core/bitmath_func.hpp"
00030 #include "string_type.h"
00031 
00032 void ttd_strlcat(char *dst, const char *src, size_t size);
00033 void ttd_strlcpy(char *dst, const char *src, size_t size);
00034 
00035 char *strecat(char *dst, const char *src, const char *last);
00036 char *strecpy(char *dst, const char *src, const char *last);
00037 
00038 int CDECL seprintf(char *str, const char *last, const char *format, ...) WARN_FORMAT(3, 4);
00039 
00040 char *CDECL str_fmt(const char *str, ...) WARN_FORMAT(1, 2);
00041 
00042 void str_validate(char *str, const char *last, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK);
00043 void ValidateString(const char *str);
00044 
00045 void str_fix_scc_encoded(char *str, const char *last);
00046 void str_strip_colours(char *str);
00047 bool strtolower(char *str);
00048 
00049 bool StrValid(const char *str, const char *last);
00050 
00058 static inline bool StrEmpty(const char *s)
00059 {
00060   return s == NULL || s[0] == '\0';
00061 }
00062 
00070 static inline size_t ttd_strnlen(const char *str, size_t maxlen)
00071 {
00072   const char *t;
00073   for (t = str; (size_t)(t - str) < maxlen && *t != '\0'; t++) {}
00074   return t - str;
00075 }
00076 
00077 char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16]);
00078 
00079 bool IsValidChar(WChar key, CharSetFilter afilter);
00080 
00081 size_t Utf8Decode(WChar *c, const char *s);
00082 size_t Utf8Encode(char *buf, WChar c);
00083 size_t Utf8TrimString(char *s, size_t maxlen);
00084 
00085 
00086 static inline WChar Utf8Consume(const char **s)
00087 {
00088   WChar c;
00089   *s += Utf8Decode(&c, *s);
00090   return c;
00091 }
00092 
00093 
00099 static inline int8 Utf8CharLen(WChar c)
00100 {
00101   if (c < 0x80)       return 1;
00102   if (c < 0x800)      return 2;
00103   if (c < 0x10000)    return 3;
00104   if (c < 0x110000)   return 4;
00105 
00106   /* Invalid valid, we encode as a '?' */
00107   return 1;
00108 }
00109 
00110 
00118 static inline int8 Utf8EncodedCharLen(char c)
00119 {
00120   if (GB(c, 3, 5) == 0x1E) return 4;
00121   if (GB(c, 4, 4) == 0x0E) return 3;
00122   if (GB(c, 5, 3) == 0x06) return 2;
00123   if (GB(c, 7, 1) == 0x00) return 1;
00124 
00125   /* Invalid UTF8 start encoding */
00126   return 0;
00127 }
00128 
00129 
00130 /* Check if the given character is part of a UTF8 sequence */
00131 static inline bool IsUtf8Part(char c)
00132 {
00133   return GB(c, 6, 2) == 2;
00134 }
00135 
00143 static inline char *Utf8PrevChar(char *s)
00144 {
00145   char *ret = s;
00146   while (IsUtf8Part(*--ret)) {}
00147   return ret;
00148 }
00149 
00150 size_t Utf8StringLength(const char *s);
00151 
00158 static inline bool IsTextDirectionChar(WChar c)
00159 {
00160   switch (c) {
00161     case CHAR_TD_LRM:
00162     case CHAR_TD_RLM:
00163     case CHAR_TD_LRE:
00164     case CHAR_TD_RLE:
00165     case CHAR_TD_LRO:
00166     case CHAR_TD_RLO:
00167     case CHAR_TD_PDF:
00168       return true;
00169 
00170     default:
00171       return false;
00172   }
00173 }
00174 
00175 static inline bool IsPrintable(WChar c)
00176 {
00177   if (c < 0x20)   return false;
00178   if (c < 0xE000) return true;
00179   if (c < 0xE200) return false;
00180   return true;
00181 }
00182 
00190 static inline bool IsWhitespace(WChar c)
00191 {
00192   return c == 0x0020 /* SPACE */ || c == 0x3000; /* IDEOGRAPHIC SPACE */
00193 }
00194 
00195 /* Needed for NetBSD version (so feature) testing */
00196 #if defined(__NetBSD__) || defined(__FreeBSD__)
00197 #include <sys/param.h>
00198 #endif
00199 
00200 /* strndup is a GNU extension */
00201 #if defined(_GNU_SOURCE) || (defined(__NetBSD_Version__) && 400000000 <= __NetBSD_Version__) || (defined(__FreeBSD_version) && 701101 <= __FreeBSD_version) || (defined(__DARWIN_C_LEVEL) && __DARWIN_C_LEVEL >= 200809L)
00202 # undef DEFINE_STRNDUP
00203 #else
00204 # define DEFINE_STRNDUP
00205 char *strndup(const char *s, size_t len);
00206 #endif /* strndup is available */
00207 
00208 /* strcasestr is available for _GNU_SOURCE, BSD and some Apple */
00209 #if defined(_GNU_SOURCE) || (defined(__BSD_VISIBLE) && __BSD_VISIBLE) || (defined(__APPLE__) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))) || defined(_NETBSD_SOURCE)
00210 # undef DEFINE_STRCASESTR
00211 #else
00212 # define DEFINE_STRCASESTR
00213 char *strcasestr(const char *haystack, const char *needle);
00214 #endif /* strcasestr is available */
00215 
00216 int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front = false);
00217 
00218 #endif /* STRING_FUNC_H */