LocalizedText.h

Go to the documentation of this file.

/*
 * Copyright 2010-2014 OpenXcom Developers.
 *
 * This file is part of OpenXcom.
 *
 * OpenXcom 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * OpenXcom 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 OpenXcom.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef OPENXCOM_LOCALIZEDTEXT_H
#define OPENXCOM_LOCALIZEDTEXT_H

#include <string>
#include <sstream>


#ifndef OX_REQUIRED_RESULT
#  if defined(__GNUC_) && !defined(__INTEL_COMPILER) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1))
#    define OX_REQUIRED_RESULT __attribute__ ((warn_unused_result))
#  else
#    define OX_REQUIRED_RESULT
#  endif
#endif
namespace OpenXcom
{

class LocalizedText
{
public:
    LocalizedText(const std::wstring &);
    LocalizedText() : _text(L""), _nextArg(1) { /* Empty by design. */ }
    operator std::wstring const& () const OX_REQUIRED_RESULT;
    std::string asUTF8() const OX_REQUIRED_RESULT;
    const wchar_t *c_str() const OX_REQUIRED_RESULT { return _text.c_str(); }

    // Argument substitution.
    LocalizedText arg(std::wstring const &) const OX_REQUIRED_RESULT;
    LocalizedText &arg(std::wstring const &) OX_REQUIRED_RESULT;
    template <typename T> LocalizedText arg(T) const OX_REQUIRED_RESULT;
    template <typename T> LocalizedText &arg(T) OX_REQUIRED_RESULT;
private:
    std::wstring _text; 
    unsigned _nextArg; 
    LocalizedText(const std::wstring &, unsigned);
};

inline LocalizedText::LocalizedText(const std::wstring &text)
  : _text(text), _nextArg(0)
{
    // Empty by design.
}

inline LocalizedText::LocalizedText(const std::wstring &text, unsigned replaced)
  : _text(text), _nextArg(replaced + 1)
{
    // Empty by design.
}

inline LocalizedText::operator std::wstring const& () const
{
    return _text;
}

template <typename T>
LocalizedText LocalizedText::arg(T val) const
{
    std::wostringstream os;
    os << '{' << _nextArg << '}';
    std::wstring marker(os.str());
    size_t pos = _text.find(marker);
    if (std::string::npos == pos)
        return *this;
    std::wstring ntext(_text);
    os.str(L"");
    os << val;
    std::wstring tval(os.str());
    for (/*empty*/ ; std::wstring::npos != pos; pos = ntext.find(marker, pos + tval.length()))
    {
        ntext.replace(pos, marker.length(), tval);
    }
    return LocalizedText(ntext, _nextArg);
}

template <typename T>
LocalizedText &LocalizedText::arg(T val)
{
    std::wostringstream os;
    os << '{' << _nextArg << '}';
    std::wstring marker(os.str());
    size_t pos = _text.find(marker);
    if (std::string::npos != pos)
    {
        os.str(L"");
        os << val;
        std::wstring tval(os.str());
        for (/*empty*/ ; std::wstring::npos != pos; pos = _text.find(marker, pos + tval.length()))
        {
            _text.replace(pos, marker.length(), tval);
        }
        ++_nextArg;
    }
    return *this;
}

inline std::wostream &operator<<(std::wostream &os, const LocalizedText &txt)
{
    os << static_cast<std::wstring const &>(txt);
    return os;
}
}

#endif