string_func.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef STRING_FUNC_H
#define STRING_FUNC_H
 
#include <stdarg.h>
#include <iosfwd>
 
#include "core/bitmath_func.hpp"
#include "core/span_type.hpp"
#include "string_type.h"
 
char *strecat(char *dst, const char *src, const char *last) NOACCESS(3);
char *strecpy(char *dst, const char *src, const char *last) NOACCESS(3);
char *stredup(const char *src, const char *last = nullptr) NOACCESS(2);
 
int CDECL seprintf(char *str, const char *last, const char *format, ...) WARN_FORMAT(3, 4) NOACCESS(2);
int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap) WARN_FORMAT(3, 0) NOACCESS(2);
 
char *CDECL str_fmt(const char *str, ...) WARN_FORMAT(1, 2);
 
std::string FormatArrayAsHex(span<const byte> data);
 
void StrMakeValidInPlace(char *str, const char *last, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK) NOACCESS(2);
[[nodiscard]] std::string StrMakeValid(const std::string &str, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK);
void StrMakeValidInPlace(char *str, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK);
 
void str_fix_scc_encoded(char *str, const char *last) NOACCESS(2);
void str_strip_colours(char *str);
bool strtolower(char *str);
bool strtolower(std::string &str, std::string::size_type offs = 0);
 
bool StrValid(const char *str, const char *last) NOACCESS(2);
void StrTrimInPlace(std::string &str);
 
bool StrStartsWith(const std::string_view str, const std::string_view prefix);
bool StrEndsWith(const std::string_view str, const std::string_view suffix);
 
static inline bool StrEmpty(const char *s)
{
  return s == nullptr || s[0] == '\0';
}
 
static inline size_t ttd_strnlen(const char *str, size_t maxlen)
{
  const char *t;
  for (t = str; (size_t)(t - str) < maxlen && *t != '\0'; t++) {}
  return t - str;
}
 
char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16]);
 
bool IsValidChar(WChar key, CharSetFilter afilter);
 
size_t Utf8Decode(WChar *c, const char *s);
size_t Utf8Encode(char *buf, WChar c);
size_t Utf8Encode(std::ostreambuf_iterator<char> &buf, WChar c);
size_t Utf8TrimString(char *s, size_t maxlen);
 
 
static inline WChar Utf8Consume(const char **s)
{
  WChar c;
  *s += Utf8Decode(&c, *s);
  return c;
}
 
template <class Titr>
static inline WChar Utf8Consume(Titr &s)
{
  WChar c;
  s += Utf8Decode(&c, &*s);
  return c;
}
 
static inline int8 Utf8CharLen(WChar c)
{
  if (c < 0x80)       return 1;
  if (c < 0x800)      return 2;
  if (c < 0x10000)    return 3;
  if (c < 0x110000)   return 4;
 
  /* Invalid valid, we encode as a '?' */
  return 1;
}
 
 
static inline int8 Utf8EncodedCharLen(char c)
{
  if (GB(c, 3, 5) == 0x1E) return 4;
  if (GB(c, 4, 4) == 0x0E) return 3;
  if (GB(c, 5, 3) == 0x06) return 2;
  if (GB(c, 7, 1) == 0x00) return 1;
 
  /* Invalid UTF8 start encoding */
  return 0;
}
 
 
/* Check if the given character is part of a UTF8 sequence */
static inline bool IsUtf8Part(char c)
{
  return GB(c, 6, 2) == 2;
}
 
static inline char *Utf8PrevChar(char *s)
{
  char *ret = s;
  while (IsUtf8Part(*--ret)) {}
  return ret;
}
 
static inline const char *Utf8PrevChar(const char *s)
{
  const char *ret = s;
  while (IsUtf8Part(*--ret)) {}
  return ret;
}
 
size_t Utf8StringLength(const char *s);
size_t Utf8StringLength(const std::string &str);
 
static inline bool Utf16IsLeadSurrogate(uint c)
{
  return c >= 0xD800 && c <= 0xDBFF;
}
 
static inline bool Utf16IsTrailSurrogate(uint c)
{
  return c >= 0xDC00 && c <= 0xDFFF;
}
 
static inline WChar Utf16DecodeSurrogate(uint lead, uint trail)
{
  return 0x10000 + (((lead - 0xD800) << 10) | (trail - 0xDC00));
}
 
static inline WChar Utf16DecodeChar(const uint16 *c)
{
  if (Utf16IsLeadSurrogate(c[0])) {
    return Utf16DecodeSurrogate(c[0], c[1]);
  } else {
    return *c;
  }
}
 
static inline bool IsTextDirectionChar(WChar c)
{
  switch (c) {
    case CHAR_TD_LRM:
    case CHAR_TD_RLM:
    case CHAR_TD_LRE:
    case CHAR_TD_RLE:
    case CHAR_TD_LRO:
    case CHAR_TD_RLO:
    case CHAR_TD_PDF:
      return true;
 
    default:
      return false;
  }
}
 
static inline bool IsPrintable(WChar c)
{
  if (c < 0x20)   return false;
  if (c < 0xE000) return true;
  if (c < 0xE200) return false;
  return true;
}
 
static inline bool IsWhitespace(WChar c)
{
  return c == 0x0020 /* SPACE */ || c == 0x3000; /* IDEOGRAPHIC SPACE */
}
 
/* Needed for NetBSD version (so feature) testing */
#if defined(__NetBSD__) || defined(__FreeBSD__)
#include <sys/param.h>
#endif
 
/* strcasestr is available for _GNU_SOURCE, BSD and some Apple */
#if defined(_GNU_SOURCE) || (defined(__BSD_VISIBLE) && __BSD_VISIBLE) || (defined(__APPLE__) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))) || defined(_NETBSD_SOURCE)
# undef DEFINE_STRCASESTR
#else
# define DEFINE_STRCASESTR
char *strcasestr(const char *haystack, const char *needle);
#endif /* strcasestr is available */
 
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front = false);
 
#endif /* STRING_FUNC_H */