1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
|
/*
* Copyright (c) 2014 Dmitry Kazakov <dimula73@gmail.com>
* Copyright (c) 2014 Alexander Potashev <aspotashev@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KUNDO2MAGICSTRING_H
#define KUNDO2MAGICSTRING_H
#include <QString>
#include <QDebug>
#include <klocale.h>
#include "kundo2_export.h"
/**
* \class KUndo2MagicString is a special wrapper for a string that is
* going to passed to a KUndo2Command and be later shown in the undo
* history and undo action in menu. The strings like that must have
* (qtundo-format) context to let translators know that they are
* allowed to use magic split in them.
*
* Magic split is used in some languages to split the message in the
* undo history docker (which is either verb or <a
* href="http://en.wikipedia.org/wiki/Nominative_case">noun in
* nominative</a>) and the message in undo/redo actions (which is
* usually a <a href="http://en.wikipedia.org/wiki/Accusative_case">noun
* in accusative</a>). When the translator needs it he, splits two
* translations with '\n' symbol and the magic string will recognize
* it.
*
* \note KUndo2MagicString will never support concatenation operators,
* because in many languages you cannot combine words without
* knowing the proper case.
*/
class KUNDO2_EXPORT KUndo2MagicString
{
public:
/**
* Construct an empty string. Note that you cannot create a
* non-empy string without special functions, all the calls to which
* are processed by xgettext.
*/
KUndo2MagicString();
/**
* Fetch the main translated string. That is the one that goes to
* undo history and resembles the action name in verb/nominative
*/
QString toString() const;
/**
* Fetch the secondary string which will go to the undo/redo
* action. This is usually a noun in accusative. If the
* translator didn't provide a secondary string, toString() and
* toSecondaryString() return the same values.
*/
QString toSecondaryString() const;
/**
* \return true if the contained string is empty
*/
bool isEmpty() const;
bool operator==(const KUndo2MagicString &rhs) const;
bool operator!=(const KUndo2MagicString &rhs) const;
private:
/**
* Construction of a magic string is allowed only with the means
* of speacial macros which resemble their kde-wide counterparts
*/
explicit KUndo2MagicString(const QString &text);
friend KUndo2MagicString kundo2_noi18n(const QString &text);
template <typename A1>
friend KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1);
template <typename A1, typename A2>
friend KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1, const A2 &a2);
template <typename A1, typename A2, typename A3>
friend KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3);
template <typename A1, typename A2, typename A3, typename A4>
friend KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4);
friend KUndo2MagicString kundo2_i18n(const char *text);
template <typename A1>
friend KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1);
template <typename A1, typename A2>
friend KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1, const A2 &a2);
template <typename A1, typename A2, typename A3>
friend KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3);
template <typename A1, typename A2, typename A3, typename A4>
friend KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4);
friend KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text);
template <typename A1>
friend KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text, const A1 &a1);
template <typename A1, typename A2>
friend KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text, const A1 &a1, const A2 &a2);
template <typename A1, typename A2, typename A3>
friend KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text, const A1 &a1, const A2 &a2, const A3 &a3);
template <typename A1>
friend KUndo2MagicString kundo2_i18np(const char *sing, const char *plur, const A1 &a1);
template <typename A1, typename A2>
friend KUndo2MagicString kundo2_i18np(const char *sing, const char *plur, const A1 &a1, const A2 &a2);
template <typename A1, typename A2, typename A3>
friend KUndo2MagicString kundo2_i18np(const char *sing, const char *plur, const A1 &a1, const A2 &a2, const A3 &a3);
template <typename A1>
friend KUndo2MagicString kundo2_i18ncp(const char *ctxt, const char *sing, const char *plur, const A1 &a1);
template <typename A1, typename A2>
friend KUndo2MagicString kundo2_i18ncp(const char *ctxt, const char *sing, const char *plur, const A1 &a1, const A2 &a2);
template <typename A1, typename A2, typename A3>
friend KUndo2MagicString kundo2_i18ncp(const char *ctxt, const char *sing, const char *plur, const A1 &a1, const A2 &a2, const A3 &a3);
private:
QString m_text;
};
inline QDebug operator<<(QDebug dbg, const KUndo2MagicString &v)
{
if (v.toString() != v.toSecondaryString()) {
dbg.nospace() << v.toString() << "(" << v.toSecondaryString() << ")";
} else {
dbg.nospace() << v.toString();
}
return dbg.space();
}
/**
* This is a special wrapper to a string which tells explicitly
* that we don't need a translation for a given string. It is used
* either in testing or internal commands, which don't go to the
* stack directly.
*/
inline KUndo2MagicString kundo2_noi18n(const QString &text)
{
return KUndo2MagicString(text);
}
template <typename A1>
inline KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1)
{
return KUndo2MagicString(QString(text).arg(a1));
}
template <typename A1, typename A2>
inline KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1, const A2 &a2)
{
return KUndo2MagicString(QString(text).arg(a1).arg(a2));
}
template <typename A1, typename A2, typename A3>
inline KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3)
{
return KUndo2MagicString(QString(text).arg(a1).arg(a2).arg(a3));
}
template <typename A1, typename A2, typename A3, typename A4>
inline KUndo2MagicString kundo2_noi18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4)
{
return KUndo2MagicString(QString(text).arg(a1).arg(a2).arg(a3).arg(a4));
}
/**
* Same as ki18n, but is supposed to work with strings going to
* undo stack
*/
inline KUndo2MagicString kundo2_i18n(const char *text)
{
return KUndo2MagicString(i18nc("(qtundo-format)", text));
}
template <typename A1>
inline KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1)
{
return KUndo2MagicString(i18nc("(qtundo-format)", text, a1));
}
template <typename A1, typename A2>
inline KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1, const A2 &a2)
{
return KUndo2MagicString(i18nc("(qtundo-format)", text, a1, a2));
}
template <typename A1, typename A2, typename A3>
inline KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3)
{
return KUndo2MagicString(i18nc("(qtundo-format)", text, a1, a2, a3));
}
template <typename A1, typename A2, typename A3, typename A4>
inline KUndo2MagicString kundo2_i18n(const char *text, const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4)
{
return KUndo2MagicString(i18nc("(qtundo-format)", text, a1, a2, a3, a4));
}
inline QString prependContext(const char *ctxt)
{
return QString("(qtundo-format) %1").arg(ctxt);
}
/**
* Same as ki18nc, but is supposed to work with strings going to
* undo stack
*/
inline KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text)
{
return KUndo2MagicString(i18nc(prependContext(ctxt).toLatin1().data(), text));
}
template <typename A1>
inline KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text, const A1 &a1)
{
return KUndo2MagicString(i18nc(prependContext(ctxt).toLatin1().data(), text, a1));
}
template <typename A1, typename A2>
inline KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text, const A1 &a1, const A2 &a2)
{
return KUndo2MagicString(i18nc(prependContext(ctxt).toLatin1().data(), text, a1, a2));
}
template <typename A1, typename A2, typename A3>
inline KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text, const A1 &a1, const A2 &a2, const A3 &a3)
{
return KUndo2MagicString(i18nc(prependContext(ctxt).toLatin1().data(), text, a1, a2, a3));
}
template <typename A1, typename A2, typename A3, typename A4>
inline KUndo2MagicString kundo2_i18nc(const char *ctxt, const char *text, const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4)
{
return KUndo2MagicString(i18nc(prependContext(ctxt).toLatin1().data(), text, a1, a2, a3, a4));
}
/**
* Same as ki18np, but is supposed to work with strings going to
* undo stack
*/
template <typename A1>
inline KUndo2MagicString kundo2_i18np(const char *sing, const char *plur, const A1 &a1)
{
return KUndo2MagicString(i18ncp("(qtundo-format)", sing, plur, a1));
}
template <typename A1, typename A2>
inline KUndo2MagicString kundo2_i18np(const char *sing, const char *plur, const A1 &a1, const A2 &a2)
{
return i18ncp("(qtundo-format)", sing, plur, a1, a2);
}
template <typename A1, typename A2, typename A3>
inline KUndo2MagicString kundo2_i18np(const char *sing, const char *plur, const A1 &a1, const A2 &a2, const A3 &a3)
{
return i18ncp("(qtundo-format)", sing, plur, a1, a2, a3);
}
template <typename A1, typename A2, typename A3, typename A4>
inline KUndo2MagicString kundo2_i18np(const char *sing, const char *plur, const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4)
{
return i18ncp("(qtundo-format)", sing, plur, a1, a2, a3, a4);
}
/**
* Same as ki18ncp, but is supposed to work with strings going to
* undo stack
*/
template <typename A1>
inline KUndo2MagicString kundo2_i18ncp(const char *ctxt, const char *sing, const char *plur, const A1 &a1)
{
return KUndo2MagicString(i18ncp(prependContext(ctxt).toLatin1().data(), sing, plur, a1));
}
template <typename A1, typename A2>
inline KUndo2MagicString kundo2_i18ncp(const char *ctxt, const char *sing, const char *plur, const A1 &a1, const A2 &a2)
{
return i18ncp(prependContext(ctxt).toLatin1().data(), sing, plur, a1, a2);
}
template <typename A1, typename A2, typename A3>
inline KUndo2MagicString kundo2_i18ncp(const char *ctxt, const char *sing, const char *plur, const A1 &a1, const A2 &a2, const A3 &a3)
{
return i18ncp(prependContext(ctxt).toLatin1().data(), sing, plur, a1, a2, a3);
}
template <typename A1, typename A2, typename A3, typename A4>
inline KUndo2MagicString kundo2_i18ncp(const char *ctxt, const char *sing, const char *plur, const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4)
{
return i18ncp(prependContext(ctxt).toLatin1().data(), sing, plur, a1, a2, a3, a4);
}
#endif /* KUNDO2MAGICSTRING_H */
|