git.sesse.net Git - kdenlive/blob - src/unicodedialog.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Simon Andreas Eugster (simon.eu@gmail.com)      *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #include "unicodedialog.h"
  11
  12 /// CONSTANTS
  13
  14 const int MAX_LENGTH_HEX = 4;
  15 const uint MAX_UNICODE_V1 = 65535;
  16
  17
  18 /// CONSTRUCTORS/DECONSTRUCTORS
  19
  20 UnicodeDialog::UnicodeDialog(InputMethod inputMeth) :
  21         inputMethod(inputMeth),
  22         m_lastCursorPos(0)
  23 {
  24     setupUi(this);
  25     readChoices();
  26     showLastUnicode();
  27     connect(unicodeNumber, SIGNAL(textChanged(QString)), this, SLOT(slotTextChanged(QString)));
  28     connect(unicodeNumber, SIGNAL(returnPressed()), this, SLOT(slotReturnPressed()));
  29     connect(arrowUp, SIGNAL(clicked()), this, SLOT(slotPrevUnicode()));
  30     connect(arrowDown, SIGNAL(clicked()), this, SLOT(slotNextUnicode()));
  31
  32     switch (inputMethod) {
  33     case InputHex:
  34         unicodeNumber->setMaxLength(MAX_LENGTH_HEX);
  35         break;
  36
  37     case InputDec:
  38         break;
  39     }
  40
  41     arrowUp->setShortcut(Qt::Key_Up);
  42     arrowDown->setShortcut(Qt::Key_Down);
  43
  44     arrowUp->setToolTip(i18n("Previous Unicode character (Arrow Up)"));
  45     arrowDown->setToolTip(i18n("Next Unicode character (Arrow Down)"));
  46     unicodeNumber->setToolTip(i18n("Enter your Unicode number here. Allowed characters: [0-9] and [a-f]."));
  47     unicodeNumber->selectAll(); // Selection will be reset by setToolTip and similar, so set it here
  48
  49 }
  50
  51 UnicodeDialog::~UnicodeDialog()
  52 {
  53 }
  54
  55
  56 /// PUBLIC SLOTS
  57
  58 int UnicodeDialog::exec()
  59 {
  60     unicodeNumber->setFocus();
  61     return QDialog::exec();
  62 }
  63
  64
  65 /// METHODS
  66
  67 void UnicodeDialog::showLastUnicode()
  68 {
  69     unicodeNumber->setText(m_lastUnicodeNumber);
  70     unicodeNumber->selectAll();
  71     slotTextChanged(m_lastUnicodeNumber);
  72 }
  73
  74 bool UnicodeDialog::controlCharacter(QString text)
  75 {
  76     bool isControlCharacter = false;
  77     QString t = text.toLower();
  78
  79     switch (inputMethod) {
  80     case InputHex:
  81         if (t == ""
  82                 || (t.length() == 1 && !(t == "9" || t == "a" || t == "d"))
  83                 || (t.length() == 2 && t.at(0) == QChar('1'))) {
  84             isControlCharacter = true;
  85         }
  86         break;
  87
  88     case InputDec:
  89         bool ok;
  90         isControlCharacter = controlCharacter(text.toUInt(&ok, 16));
  91         break;
  92     }
  93
  94     return isControlCharacter;
  95 }
  96
  97 bool UnicodeDialog::controlCharacter(uint value)
  98 {
  99     bool isControlCharacter = false;
 100
 101     if (value < 32 && !(value == 9 || value == 10 || value == 13)) {
 102         isControlCharacter = true;
 103     }
 104     return isControlCharacter;
 105
 106 }
 107
 108 QString UnicodeDialog::trimmedUnicodeNumber(QString text)
 109 {
 110     while (text.length() > 0 && text.at(0) == QChar('0')) {
 111         text = text.remove(0, 1);
 112     }
 113     return text;
 114 }
 115
 116 QString UnicodeDialog::unicodeInfo(QString unicode)
 117 {
 118     QString infoText(i18n("<small>(no character selected)</small>"));
 119     if (unicode.length() == 0) return infoText;
 120
 121     QString u = trimmedUnicodeNumber(unicode).toLower();
 122
 123     if (controlCharacter(u)) {
 124         infoText = i18n("Control character. Cannot be inserted/printed. See <a href=\"http://en.wikipedia.org/wiki/Control_character\">Wikipedia:Control_character</a>");
 125     } else if (u == "a") {
 126         infoText = i18n("Line Feed (newline character, \\\\n)");
 127     } else if (u == "20") {
 128         infoText = i18n("Standard space character. (Other space characters: U+00a0, U+2000&#x2013;200b, U+202f)");
 129     } else if (u == "a0") {
 130         infoText = i18n("No-break space. &amp;nbsp; in HTML. See U+2009 and U+0020.");
 131     } else if (u == "ab" || u == "bb" || u == "2039" || u == "203a") {
 132         infoText = i18n("<p><strong>&laquo;</strong> (u+00ab, <code>&amp;lfquo;</code> in HTML) and <strong>&raquo;</strong> (u+00bb, <code>&amp;rfquo;</code> in HTML) are called Guillemets or angle quotes. Usage in different countries: France (with non-breaking Space 0x00a0), Switzerland, Germany, Finland and Sweden.</p><p><strong>&lsaquo;</strong> and <strong>&rsaquo;</strong> (U+2039/203a, <code>&amp;lsaquo;/&amp;rsaquo;</code>) are their single quote equivalents.</p><p>See <a href=\"http://en.wikipedia.org/wiki/Guillemets\">Wikipedia:Guillemets</a></p>");
 133     } else if (u == "2002") {
 134         infoText = i18n("En Space (width of an n)");
 135     } else if (u == "2003") {
 136         infoText = i18n("Em Space (width of an m)");
 137     } else if (u == "2004") {
 138         infoText = i18n("Three-Per-Em Space. Width: 1/3 of one <em>em</em>");
 139     } else if (u == "2005") {
 140         infoText = i18n("Four-Per-Em Space. Width: 1/4 of one <em>em</em>");
 141     } else if (u == "2006") {
 142         infoText = i18n("Six-Per-Em Space. Width: 1/6 of one <em>em</em>");
 143     } else if (u == "2007") {
 144         infoText = i18n("Figure space (non-breaking). Width of a digit if digits have fixed width in this font.");
 145     } else if (u == "2008") {
 146         infoText = i18n("Punctuation Space. Width the same as between a punctuation character and the next character.");
 147     } else if (u == "2009") {
 148         infoText = i18n("Thin space, in HTML also &amp;thinsp;. See U+202f and <a href=\"http://en.wikipedia.org/wiki/Space_(punctuation)\">Wikipedia:Space_(punctuation)</a>");
 149     } else if (u == "200a") {
 150         infoText = i18n("Hair Space. Thinner than U+2009.");
 151     } else if (u == "2019") {
 152         infoText = i18n("Punctuation Apostrophe. Should be used instead of U+0027. See <a href=\"http://en.wikipedia.org/wiki/Apostrophe\">Wikipedia:Apostrophe</a>");
 153     } else if (u == "2013") {
 154         infoText = i18n("<p>An en Dash (dash of the width of an n).</p><p>Usage examples: In English language for value ranges (1878&#x2013;1903), for relationships/connections (Zurich&#x2013;Dublin). In the German language it is also used (with spaces!) for showing thoughts: &ldquo;Es war &#x2013; wie immer in den Ferien &#x2013; ein regnerischer Tag.</p> <p>See <a href=\"http://en.wikipedia.org/wiki/Dash\">Wikipedia:Dash</a></p>");
 155     } else if (u == "2014") {
 156         infoText = i18n("<p>An em Dash (dash of the widht of an m).</p><p>Usage examples: In English language to mark&#x2014;like here&#x2014;thoughts. Traditionally without spaces. </p><p>See <a href=\"http://en.wikipedia.org/wiki/Dash\">Wikipedia:Dash</a></p>");
 157     } else if (u == "202f") {
 158         infoText = i18n("<p>Narrow no-break space. Has the same width as U+2009.</p><p>Usage: For units (spaces are marked with U+2423, &#x2423;): 230&#x2423;V, &#x2212;21&#x2423;&deg;C, 50&#x2423;lb, <em>but</em> 90&deg; (no space). In German for abbreviations (like: i.&#x202f;d.&#x202f;R. instead of i.&#xa0;d.&#xa0;R. with U+00a0).</p><p>See <a href=\"http://de.wikipedia.org/wiki/Schmales_Leerzeichen\">Wikipedia:de:Schmales_Leerzeichen</a></p>");
 159     } else if (u == "2026") {
 160         infoText = i18n("Ellipsis: If text has been left o&#x2026; See <a href=\"http://en.wikipedia.org/wiki/Ellipsis\">Wikipedia:Ellipsis</a>");
 161     } else if (u == "2212") {
 162         infoText = i18n("Minus sign. For numbers: &#x2212;42");
 163     } else if (u == "2423") {
 164         infoText = i18n("Open box; stands for a space.");
 165     } else if (u == "2669") {
 166         infoText = i18n("Quarter note (Am.) or crochet (Brit.). See <a href=\"http://en.wikipedia.org/wiki/Quarter_note\">Wikipedia:Quarter_note</a>");
 167     } else if (u == "266a") {
 168         infoText = i18n("Eighth note (Am.) or quaver (Brit.). Half as long as a quarter note (U+2669). See <a href=\"http://en.wikipedia.org/wiki/Eighth_note\">Wikipedia:Eighth_note</a>");
 169     } else if (u == "266b") {
 170         infoText = i18n("Sixteenth note (Am.) or semiquaver (Brit.). Half as long as an eighth note (U+266a). See <a href=\"http://en.wikipedia.org/wiki/Sixteenth_note\">Wikipedia:Sixteenth_note</a>");
 171     } else if (u == "266c") {
 172         infoText = i18n("Thirty-second note (Am.) or demisemiquaver (Brit.). Half as long as a sixteenth note (U+266b). See <a href=\"http://en.wikipedia.org/wiki/Quarter_note\">Wikipedia:Thirty-second_note</a>");
 173     } else {
 174         infoText = i18n("<small>No additional information available for this character.</small>");
 175     }
 176
 177     return infoText;
 178 }
 179
 180 QString UnicodeDialog::validateText(QString text)
 181 {
 182     QRegExp regex("([0-9]|[a-f])", Qt::CaseInsensitive, QRegExp::RegExp2);
 183     QString newText = "";
 184     int pos = 0;
 185
 186     switch (inputMethod) {
 187     case InputHex:
 188         // Remove all characters we don't want
 189         while ((pos = regex.indexIn(text, pos)) != -1) {
 190             newText += regex.cap(1);
 191             pos++;
 192         }
 193         break;
 194
 195     case InputDec:
 196         // TODO
 197         break;
 198     }
 199
 200     return newText;
 201 }
 202
 203 void UnicodeDialog::updateOverviewChars(uint unicode)
 204 {
 205     QString left = "";
 206     QString right = "";
 207     uint i;
 208
 209     for (i = 1; i <= 4; i++) {
 210         if (unicode > i && !controlCharacter(unicode - i)) {
 211             left = " " + left;
 212             left = QChar(unicode - i) + left;
 213         }
 214     }
 215
 216     for (i = 1; i <= 8; i++) {
 217         if (unicode + i <= MAX_UNICODE_V1 && !controlCharacter(unicode + i)) {
 218             right += QChar(unicode + i);
 219             right += " ";
 220         }
 221     }
 222
 223     leftChars->setText(left);
 224     rightChars->setText(right);
 225
 226 }
 227
 228 void UnicodeDialog::clearOverviewChars()
 229 {
 230     leftChars->setText("");
 231     rightChars->setText("");
 232 }
 233
 234 QString UnicodeDialog::nextUnicode(QString text, Direction direction)
 235 {
 236     uint value = 0;
 237     QString newText = "";
 238     bool ok;
 239
 240     switch (inputMethod) {
 241     case InputHex:
 242         value = text.toUInt(&ok, 16);
 243         switch (direction) {
 244         case Backward:
 245             value--;
 246             break;
 247         default:
 248             value++;
 249             break;
 250         }
 251         // Wrapping
 252         if (value == (uint) - 1) value = MAX_UNICODE_V1;
 253         if (value > MAX_UNICODE_V1) value = 0;
 254
 255         newText.setNum(value, 16);
 256         break;
 257
 258     case InputDec:
 259         break;
 260     }
 261
 262     return newText;
 263 }
 264
 265 void UnicodeDialog::readChoices()
 266 {
 267     // Get a pointer to a shared configuration instance, then get the TitleWidget group.
 268     KSharedConfigPtr config = KGlobal::config();
 269     KConfigGroup titleConfig(config, "TitleWidget");
 270
 271     // Default is 2013 because there is also (perhaps interesting) information.
 272     m_lastUnicodeNumber = titleConfig.readEntry("unicode_number", QString("2013"));
 273 }
 274
 275 void UnicodeDialog::writeChoices()
 276 {
 277     // Get a pointer to a shared configuration instance, then get the TitleWidget group.
 278     KSharedConfigPtr config = KGlobal::config();
 279     KConfigGroup titleConfig(config, "TitleWidget");
 280
 281     titleConfig.writeEntry("unicode_number", m_lastUnicodeNumber);
 282 }
 283
 284
 285 /// SLOTS
 286
 287 /**
 288  * \brief Validates the entered Unicode number and displays its Unicode character.
 289  */
 290 void UnicodeDialog::slotTextChanged(QString text)
 291 {
 292     unicodeNumber->blockSignals(true);
 293
 294     QString newText = validateText(text);
 295     if (newText.length() == 0) {
 296         unicodeChar->setText("");
 297         unicodeNumber->setText("");
 298         clearOverviewChars();
 299         m_lastCursorPos = 0;
 300         m_lastUnicodeNumber = "";
 301         labelInfoText->setText(unicodeInfo(""));
 302
 303     } else {
 304
 305         int cursorPos = unicodeNumber->cursorPosition();
 306
 307         unicodeNumber->setText(newText);
 308         unicodeNumber->setCursorPosition(cursorPos);
 309
 310         // Get the decimal number as uint to create the QChar from
 311         bool ok;
 312         uint value = 0;
 313         switch (inputMethod) {
 314         case InputHex:
 315             value = newText.toUInt(&ok, 16);
 316             break;
 317         case InputDec:
 318             value = newText.toUInt(&ok, 10);
 319             break;
 320         }
 321         updateOverviewChars(value);
 322
 323         if (!ok) {
 324             // Impossible! validateText never fails!
 325         }
 326
 327         // If an invalid character has been entered:
 328         // Reset the cursor position because the entered char has been deleted.
 329         if (text != newText && newText == m_lastUnicodeNumber) {
 330             unicodeNumber->setCursorPosition(m_lastCursorPos);
 331         }
 332
 333         m_lastCursorPos = unicodeNumber->cursorPosition();
 334         m_lastUnicodeNumber = newText;
 335
 336         labelInfoText->setText(unicodeInfo(newText));
 337         unicodeChar->setText(QChar(value));
 338     }
 339
 340     unicodeNumber->blockSignals(false);
 341 }
 342
 343 /**
 344  * When return pressed, we return the selected unicode character
 345  * if it was not a control character.
 346  */
 347 void UnicodeDialog::slotReturnPressed()
 348 {
 349     QString text = trimmedUnicodeNumber(unicodeNumber->text());
 350     if (!controlCharacter(text)) {
 351         emit charSelected(unicodeChar->text());
 352         writeChoices();
 353     }
 354     emit accept();
 355 }
 356
 357 void UnicodeDialog::slotNextUnicode()
 358 {
 359     QString text = unicodeNumber->text();
 360     unicodeNumber->setText(nextUnicode(text, Forward));
 361 }
 362
 363 void UnicodeDialog::slotPrevUnicode()
 364 {
 365     QString text = unicodeNumber->text();
 366     unicodeNumber->setText(nextUnicode(text, Backward));
 367 }
 368
 369 #include "unicodedialog.moc"