src/string_type.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file string_type.h Types for strings. */
   9
  10 #ifndef STRING_TYPE_H
  11 #define STRING_TYPE_H
  12
  13 #include "core/enum_type.hpp"
  14
  15 /** A non-breaking space. */
  16 #define NBSP "\u00a0"
  17
  18 /** A left-to-right marker, marks the next character as left-to-right. */
  19 #define LRM "\u200e"
  20
  21 /**
  22  * Valid filter types for IsValidChar.
  23  */
  24 enum CharSetFilter {
  25         CS_ALPHANUMERAL,      ///< Both numeric and alphabetic and spaces and stuff
  26         CS_NUMERAL,           ///< Only numeric ones
  27         CS_NUMERAL_SPACE,     ///< Only numbers and spaces
  28         CS_NUMERAL_SIGNED,    ///< Only numbers and '-' for negative values
  29         CS_ALPHA,             ///< Only alphabetic values
  30         CS_HEXADECIMAL,       ///< Only hexadecimal characters
  31 };
  32
  33 /* The following are directional formatting codes used to get the LTR and RTL strings right:
  34  * http://www.unicode.org/unicode/reports/tr9/#Directional_Formatting_Codes */
  35 static const char32_t CHAR_TD_LRM = 0x200E; ///< The next character acts like a left-to-right character.
  36 static const char32_t CHAR_TD_RLM = 0x200F; ///< The next character acts like a right-to-left character.
  37 static const char32_t CHAR_TD_LRE = 0x202A; ///< The following text is embedded left-to-right.
  38 static const char32_t CHAR_TD_RLE = 0x202B; ///< The following text is embedded right-to-left.
  39 static const char32_t CHAR_TD_LRO = 0x202D; ///< Force the following characters to be treated as left-to-right characters.
  40 static const char32_t CHAR_TD_RLO = 0x202E; ///< Force the following characters to be treated as right-to-left characters.
  41 static const char32_t CHAR_TD_PDF = 0x202C; ///< Restore the text-direction state to before the last LRE, RLE, LRO or RLO.
  42
  43 /** Settings for the string validation. */
  44 enum StringValidationSettings {
  45         SVS_NONE                       = 0,      ///< Allow nothing and replace nothing.
  46         SVS_REPLACE_WITH_QUESTION_MARK = 1 << 0, ///< Replace the unknown/bad bits with question marks.
  47         SVS_ALLOW_NEWLINE              = 1 << 1, ///< Allow newlines; replaces '\r\n' with '\n' during processing.
  48         SVS_ALLOW_CONTROL_CODE         = 1 << 2, ///< Allow the special control codes.
  49         /**
  50          * Replace tabs ('\t'), carriage returns ('\r') and newlines ('\n') with spaces.
  51          * When #SVS_ALLOW_NEWLINE is set, a '\n' or '\r\n' combination are not replaced with a space. A lone '\r' is replaced with a space.
  52          * When #SVS_REPLACE_WITH_QUESTION_MARK is set, this replacement runs first.
  53          */
  54         SVS_REPLACE_TAB_CR_NL_WITH_SPACE = 1 << 3,
  55 };
  56 DECLARE_ENUM_AS_BIT_SET(StringValidationSettings)
  57
  58
  59 /** Type for a list of strings. */
  60 typedef std::vector<std::string> StringList;
  61
  62 #endif /* STRING_TYPE_H */