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 #pragma once
  21
  22 #include <string>
  23 #include <vector>
  24 #include <SColor.h>
  25
  26 class EnrichedString {
  27 public:
  28         EnrichedString();
  29         EnrichedString(const std::wstring &s,
  30                 const irr::video::SColor &color = irr::video::SColor(255, 255, 255, 255));
  31         EnrichedString(const wchar_t *str,
  32                 const irr::video::SColor &color = irr::video::SColor(255, 255, 255, 255));
  33         EnrichedString(const std::wstring &string,
  34                 const std::vector<irr::video::SColor> &colors);
  35         void clear();
  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
  55         void setDefaultColor(const irr::video::SColor &color);
  56         void updateDefaultColor();
  57         inline const irr::video::SColor &getDefaultColor() const
  58         {
  59                 return m_default_color;
  60         }
  61
  62         inline bool operator==(const EnrichedString &other) const
  63         {
  64                 return (m_string == other.m_string && m_colors == other.m_colors);
  65         }
  66         inline bool operator!=(const EnrichedString &other) const
  67         {
  68                 return !(*this == other);
  69         }
  70         inline bool empty() const
  71         {
  72                 return m_string.empty();
  73         }
  74         inline size_t size() const
  75         {
  76                 return m_string.size();
  77         }
  78
  79         inline bool hasBackground() const
  80         {
  81                 return m_has_background;
  82         }
  83         inline irr::video::SColor getBackground() const
  84         {
  85                 return m_background;
  86         }
  87         inline void setBackground(const irr::video::SColor &color)
  88         {
  89                 m_background = color;
  90                 m_has_background = true;
  91         }
  92
  93 private:
  94         std::wstring m_string;
  95         std::vector<irr::video::SColor> m_colors;
  96         bool m_has_background;
  97         irr::video::SColor m_default_color;
  98         irr::video::SColor m_background;
  99         // This variable defines the length of the default-colored text.
 100         // Change this to a std::vector if an "end coloring" tag is wanted.
 101         size_t m_default_length = 0;
 102 };