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 #include <vector>
  15 #include <string>
  16
  17 /** A non-breaking space. */
  18 #define NBSP u8"\u00a0"
  19
  20 /** A left-to-right marker, marks the next character as left-to-right. */
  21 #define LRM u8"\u200e"
  22
  23 /**
  24  * Valid filter types for IsValidChar.
  25  */
  26 enum CharSetFilter {
  27         CS_ALPHANUMERAL,      ///< Both numeric and alphabetic and spaces and stuff
  28         CS_NUMERAL,           ///< Only numeric ones
  29         CS_NUMERAL_SPACE,     ///< Only numbers and spaces
  30         CS_ALPHA,             ///< Only alphabetic values
  31         CS_HEXADECIMAL,       ///< Only hexadecimal characters
  32 };
  33
  34 /** Type for wide characters, i.e. non-UTF8 encoded unicode characters. */
  35 typedef char32_t WChar;
  36
  37 /* The following are directional formatting codes used to get the LTR and RTL strings right:
  38  * http://www.unicode.org/unicode/reports/tr9/#Directional_Formatting_Codes */
  39 static const WChar CHAR_TD_LRM = 0x200E; ///< The next character acts like a left-to-right character.
  40 static const WChar CHAR_TD_RLM = 0x200F; ///< The next character acts like a right-to-left character.
  41 static const WChar CHAR_TD_LRE = 0x202A; ///< The following text is embedded left-to-right.
  42 static const WChar CHAR_TD_RLE = 0x202B; ///< The following text is embedded right-to-left.
  43 static const WChar CHAR_TD_LRO = 0x202D; ///< Force the following characters to be treated as left-to-right characters.
  44 static const WChar CHAR_TD_RLO = 0x202E; ///< Force the following characters to be treated as right-to-left characters.
  45 static const WChar CHAR_TD_PDF = 0x202C; ///< Restore the text-direction state to before the last LRE, RLE, LRO or RLO.
  46
  47 /** Settings for the string validation. */
  48 enum StringValidationSettings {
  49         SVS_NONE                       = 0,      ///< Allow nothing and replace nothing.
  50         SVS_REPLACE_WITH_QUESTION_MARK = 1 << 0, ///< Replace the unknown/bad bits with question marks.
  51         SVS_ALLOW_NEWLINE              = 1 << 1, ///< Allow newlines.
  52         SVS_ALLOW_CONTROL_CODE         = 1 << 2, ///< Allow the special control codes.
  53 };
  54 DECLARE_ENUM_AS_BIT_SET(StringValidationSettings)
  55
  56
  57 /** Type for a list of strings. */
  58 typedef std::vector<std::string> StringList;
  59
  60 #endif /* STRING_TYPE_H */