src/util/enriched_string.h

   1 /*
   2 Copyright (C) 2013 xyz, Ilya Zhuravlev <whatever@xyz.is>
   3 Copyright (C) 2016 Nore, Nathanaël Courant <nore@mesecons.net>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef ENRICHEDSTRING_HEADER
  21 #define ENRICHEDSTRING_HEADER
  22
  23 #include <string>
  24 #include <vector>
  25 #include <SColor.h>
  26
  27 class EnrichedString {
  28 public:
  29         EnrichedString();
  30         EnrichedString(const std::wstring &s,
  31                 const irr::video::SColor &color = irr::video::SColor(255, 255, 255, 255));
  32         EnrichedString(const wchar_t *str,
  33                 const irr::video::SColor &color = irr::video::SColor(255, 255, 255, 255));
  34         EnrichedString(const std::wstring &string,
  35                 const std::vector<irr::video::SColor> &colors);
  36         void operator=(const wchar_t *str);
  37         void addAtEnd(const std::wstring &s, const irr::video::SColor &color);
  38
  39         // Adds the character source[i] at the end.
  40         // An EnrichedString should always be able to be copied
  41         // to the end of an existing EnrichedString that way.
  42         void addChar(const EnrichedString &source, size_t i);
  43
  44         // Adds a single character at the end, without specifying its
  45         // color. The color used will be the one from the last character.
  46         void addCharNoColor(wchar_t c);
  47
  48         EnrichedString substr(size_t pos = 0, size_t len = std::string::npos) const;
  49         EnrichedString operator+(const EnrichedString &other) const;
  50         void operator+=(const EnrichedString &other);
  51         const wchar_t *c_str() const;
  52         const std::vector<irr::video::SColor> &getColors() const;
  53         const std::wstring &getString() const;
  54         inline bool operator==(const EnrichedString &other) const
  55         {
  56                 return (m_string == other.m_string && m_colors == other.m_colors);
  57         }
  58         inline bool operator!=(const EnrichedString &other) const
  59         {
  60                 return !(*this == other);
  61         }
  62         inline void clear()
  63         {
  64                 m_string.clear();
  65                 m_colors.clear();
  66                 m_has_background = false;
  67         }
  68         inline bool empty() const
  69         {
  70                 return m_string.empty();
  71         }
  72         inline size_t size() const
  73         {
  74                 return m_string.size();
  75         }
  76         inline bool hasBackground() const
  77         {
  78                 return m_has_background;
  79         }
  80         inline irr::video::SColor getBackground() const
  81         {
  82                 return m_background;
  83         }
  84 private:
  85         std::wstring m_string;
  86         std::vector<irr::video::SColor> m_colors;
  87         bool m_has_background;
  88         irr::video::SColor m_background;
  89 };
  90
  91 #endif