src/frontends/qt4/GuiSymbols.cpp

   1 /**
   2  * \file GuiSymbols.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Spitzmüller
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "GuiSymbols.h"
  14
  15 #include "GuiApplication.h"
  16 #include "GuiView.h"
  17 #include "qt_helpers.h"
  18
  19 #include "Buffer.h"
  20 #include "BufferParams.h"
  21 #include "BufferView.h"
  22 #include "Encoding.h"
  23 #include "FuncRequest.h"
  24
  25 #include "support/gettext.h"
  26
  27 #include <QChar>
  28 #include <QPixmap>
  29 #include <QListWidgetItem>
  30 #include <QString>
  31
  32 using namespace std;
  33
  34 namespace lyx {
  35 namespace frontend {
  36
  37
  38 namespace {
  39
  40 /// name of unicode block, start and end code point
  41 struct UnicodeBlocks {
  42         QString name;
  43         char_type start;
  44         char_type end;
  45 };
  46
  47
  48 /// all unicode blocks with start and end code point
  49 UnicodeBlocks unicode_blocks[] = {
  50         { N_("Basic Latin"), 0x0000, 0x007f },
  51         { N_("Latin-1 Supplement"), 0x0080, 0x00ff },
  52         { N_("Latin Extended-A"), 0x0100, 0x017f },
  53         { N_("Latin Extended-B"), 0x0180, 0x024f },
  54         { N_("IPA Extensions"), 0x0250, 0x02af },
  55         { N_("Spacing Modifier Letters"), 0x02b0, 0x02ff },
  56         { N_("Combining Diacritical Marks"), 0x0300, 0x036f },
  57         { N_("Greek"), 0x0370, 0x03ff },
  58         { N_("Cyrillic"), 0x0400, 0x04ff },
  59         { N_("Armenian"), 0x0530, 0x058f },
  60         { N_("Hebrew"), 0x0590, 0x05ff },
  61         { N_("Arabic"), 0x0600, 0x06ff },
  62         { N_("Devanagari"), 0x0900, 0x097f },
  63         { N_("Bengali"), 0x0980, 0x09ff },
  64         { N_("Gurmukhi"), 0x0a00, 0x0a7f },
  65         { N_("Gujarati"), 0x0a80, 0x0aff },
  66         { N_("Oriya"), 0x0b00, 0x0b7f },
  67         { N_("Tamil"), 0x0b80, 0x0bff },
  68         { N_("Telugu"), 0x0c00, 0x0c7f },
  69         { N_("Kannada"), 0x0c80, 0x0cff },
  70         { N_("Malayalam"), 0x0d00, 0x0d7f },
  71         { N_("Thai"), 0x0e00, 0x0e7f },
  72         { N_("Lao"), 0x0e80, 0x0eff },
  73         { N_("Tibetan"), 0x0f00, 0x0fbf },
  74         { N_("Georgian"), 0x10a0, 0x10ff },
  75         { N_("Hangul Jamo"), 0x1100, 0x11ff },
  76         { N_("Phonetic Extensions"), 0x1d00, 0x1d7f },
  77         { N_("Latin Extended Additional"), 0x1e00, 0x1eff },
  78         { N_("Greek Extended"), 0x1f00, 0x1fff },
  79         { N_("General Punctuation"), 0x2000, 0x206f },
  80         { N_("Superscripts and Subscripts"), 0x2070, 0x209f },
  81         { N_("Currency Symbols"), 0x20a0, 0x20cf },
  82         { N_("Combining Diacritical Marks for Symbols"), 0x20d0, 0x20ff },
  83         { N_("Letterlike Symbols"), 0x2100, 0x214f },
  84         { N_("Number Forms"), 0x2150, 0x218f },
  85         { N_("Arrows"), 0x2190, 0x21ff },
  86         { N_("Mathematical Operators"), 0x2200, 0x22ff },
  87         { N_("Miscellaneous Technical"), 0x2300, 0x23ff },
  88         { N_("Control Pictures"), 0x2400, 0x243f },
  89         { N_("Optical Character Recognition"), 0x2440, 0x245f },
  90         { N_("Enclosed Alphanumerics"), 0x2460, 0x24ff },
  91         { N_("Box Drawing"), 0x2500, 0x257f },
  92         { N_("Block Elements"), 0x2580, 0x259f },
  93         { N_("Geometric Shapes"), 0x25a0, 0x25ff },
  94         { N_("Miscellaneous Symbols"), 0x2600, 0x26ff },
  95         { N_("Dingbats"), 0x2700, 0x27bf },
  96         { N_("Miscellaneous Mathematical Symbols-A"), 0x27c0, 0x27ef },
  97         { N_("CJK Symbols and Punctuation"), 0x3000, 0x303f },
  98         { N_("Hiragana"), 0x3040, 0x309f },
  99         { N_("Katakana"), 0x30a0, 0x30ff },
 100         { N_("Bopomofo"), 0x3100, 0x312f },
 101         { N_("Hangul Compatibility Jamo"), 0x3130, 0x318f },
 102         { N_("Kanbun"), 0x3190, 0x319f },
 103         { N_("Enclosed CJK Letters and Months"), 0x3200, 0x32ff },
 104         { N_("CJK Compatibility"), 0x3300, 0x33ff },
 105         { N_("CJK Unified Ideographs"), 0x4e00, 0x9fa5 },
 106         { N_("Hangul Syllables"), 0xac00, 0xd7a3 },
 107         { N_("High Surrogates"), 0xd800, 0xdb7f },
 108         { N_("Private Use High Surrogates"), 0xdb80, 0xdbff },
 109         { N_("Low Surrogates"), 0xdc00, 0xdfff },
 110         { N_("Private Use Area"), 0xe000, 0xf8ff },
 111         { N_("CJK Compatibility Ideographs"), 0xf900, 0xfaff },
 112         { N_("Alphabetic Presentation Forms"), 0xfb00, 0xfb4f },
 113         { N_("Arabic Presentation Forms-A"), 0xfb50, 0xfdff },
 114         { N_("Combining Half Marks"), 0xfe20, 0xfe2f },
 115         { N_("CJK Compatibility Forms"), 0xfe30, 0xfe4f },
 116         { N_("Small Form Variants"), 0xfe50, 0xfe6f },
 117         { N_("Arabic Presentation Forms-B"), 0xfe70, 0xfeff },
 118         { N_("Halfwidth and Fullwidth Forms"), 0xff00, 0xffef },
 119         { N_("Specials"), 0xfff0, 0xffff },
 120         { N_("Linear B Syllabary"), 0x10000, 0x1007f },
 121         { N_("Linear B Ideograms"), 0x10080, 0x100ff },
 122         { N_("Aegean Numbers"), 0x10100, 0x1013f },
 123         { N_("Ancient Greek Numbers"), 0x10140, 0x1018f },
 124         { N_("Old Italic"), 0x10300, 0x1032f },
 125         { N_("Gothic"), 0x10330, 0x1034f },
 126         { N_("Ugaritic"), 0x10380, 0x1039f },
 127         { N_("Old Persian"), 0x103a0, 0x103df },
 128         { N_("Deseret"), 0x10400, 0x1044f },
 129         { N_("Shavian"), 0x10450, 0x1047f },
 130         { N_("Osmanya"), 0x10480, 0x104af },
 131         { N_("Cypriot Syllabary"), 0x10800, 0x1083f },
 132         { N_("Kharoshthi"), 0x10a00, 0x10a5f },
 133         { N_("Byzantine Musical Symbols"), 0x1d000, 0x1d0ff },
 134         { N_("Musical Symbols"), 0x1d100, 0x1d1ff },
 135         { N_("Ancient Greek Musical Notation"), 0x1d200, 0x1d24f },
 136         { N_("Tai Xuan Jing Symbols"), 0x1d300, 0x1d35f },
 137         { N_("Mathematical Alphanumeric Symbols"), 0x1d400, 0x1d7ff },
 138         { N_("CJK Unified Ideographs Extension B"), 0x20000, 0x2a6d6 },
 139         { N_("CJK Compatibility Ideographs Supplement"), 0x2f800, 0x2fa1f },
 140         { N_("Tags"), 0xe0000, 0xe007f },
 141         { N_("Variation Selectors Supplement"), 0xe0100, 0xe01ef },
 142         { N_("Supplementary Private Use Area-A"), 0xf0000, 0xe01ef },
 143         { N_("Supplementary Private Use Area-B"), 0x100000, 0x10ffff }
 144 };
 145
 146 const int no_blocks = sizeof(unicode_blocks) / sizeof(UnicodeBlocks);
 147
 148
 149 QString getBlock(char_type c)
 150 {
 151         // store an educated guess for the next search
 152         static int lastBlock = 0;
 153
 154         if (c < unicode_blocks[lastBlock].start
 155          || c > unicode_blocks[lastBlock].end)
 156         {
 157                 // guess was wrong. do a real search.
 158                 int i = 0;
 159                 while (c > unicode_blocks[i].end && i < no_blocks)
 160                         ++i;
 161                 if (unicode_blocks[i].name.isEmpty())
 162                         return QString();
 163                 lastBlock = i;
 164         }
 165         return unicode_blocks[lastBlock].name;
 166 }
 167
 168
 169 } // namespace anon
 170
 171
 172 /////////////////////////////////////////////////////////////////////
 173 //
 174 // GuiSymbols::Model
 175 //
 176 /////////////////////////////////////////////////////////////////////
 177
 178 class GuiSymbols::Model : public QAbstractItemModel
 179 {
 180 public:
 181         Model(GuiSymbols * parent)
 182                 : QAbstractItemModel(parent), parent_(parent)
 183         {}
 184
 185         QModelIndex index(int row, int column, QModelIndex const &) const
 186         {
 187                 return createIndex(row, column);
 188         }
 189
 190         QModelIndex parent(QModelIndex const &) const
 191         {
 192                 return QModelIndex();
 193         }
 194
 195         int rowCount(QModelIndex const &) const
 196         {
 197                 return symbols_.count();
 198         }
 199
 200         int columnCount(QModelIndex const &) const
 201         {
 202                 return 1;
 203         }
 204
 205         QVariant data(QModelIndex const & index, int role) const
 206         {
 207                 static QString const strCharacter = qt_("Character: ");
 208                 static QString const strCodePoint = qt_("Code Point: ");
 209
 210                 static char codeName[10];
 211
 212                 char_type c = symbols_.at(index.row());
 213
 214                 if (role == Qt::TextAlignmentRole)
 215                         return QVariant(Qt::AlignCenter);
 216
 217                 if (role == Qt::DisplayRole)
 218                         return toqstr(c);
 219
 220                 if (role == Qt::ToolTipRole) {
 221                         sprintf(codeName, "0x%04x", c);
 222                         return strCharacter + toqstr(c) + '\n'
 223                                 + strCodePoint + QLatin1String(codeName);
 224                 }
 225
 226                 //LYXERR0("role: " << role << " row: " << index.row());
 227                 return QVariant();
 228         }
 229
 230         void reset(QList<char_type> const & symbols)
 231         {
 232                 symbols_ = symbols;
 233                 QAbstractItemModel::reset();
 234         }
 235
 236 private:
 237         friend class GuiSymbols;
 238         GuiSymbols * parent_;
 239
 240         QList<char_type> symbols_;
 241 };
 242
 243
 244 /////////////////////////////////////////////////////////////////////
 245 //
 246 // GuiSymbols
 247 //
 248 /////////////////////////////////////////////////////////////////////
 249
 250 GuiSymbols::GuiSymbols(GuiView & lv)
 251         : DialogView(lv, "symbols", qt_("Symbols")), encoding_("ascii"),
 252                 model_(new Model(this))
 253 {
 254         setupUi(this);
 255
 256         setFocusProxy(symbolsLW);
 257
 258         symbolsLW->setViewMode(QListView::IconMode);
 259         symbolsLW->setUniformItemSizes(true);
 260         // increase the display size of the symbols a bit
 261         QFont font= symbolsLW->font();
 262         int size = font.pointSize() + 3;
 263         font.setPointSize(size);
 264         symbolsLW->setFont(font);
 265         symbolsLW->setModel(model_);
 266 }
 267
 268
 269 void GuiSymbols::updateView()
 270 {
 271         chosenLE->clear();
 272
 273         string new_encoding = bufferview()->cursor().getEncoding()->name();
 274         if (buffer().params().inputenc != "auto" &&
 275             buffer().params().inputenc != "default")
 276                 new_encoding = buffer().params().encoding().name();
 277         if (new_encoding == encoding_)
 278                 // everything up to date
 279                 return;
 280         if (!new_encoding.empty())
 281                 encoding_ = new_encoding;
 282         bool const utf8 = toqstr(encoding_).startsWith("utf8");
 283         if (utf8)
 284                 categoryFilterCB->setChecked(false);
 285         //categoryFilterCB->setEnabled(!utf8);
 286         updateSymbolList();
 287 }
 288
 289
 290 void GuiSymbols::enableView(bool enable)
 291 {
 292         chosenLE->setEnabled(enable);
 293         okPB->setEnabled(enable);
 294         applyPB->setEnabled(enable);
 295 }
 296
 297
 298 void GuiSymbols::on_applyPB_clicked()
 299 {
 300         dispatchParams();
 301 }
 302
 303
 304 void GuiSymbols::on_okPB_clicked()
 305 {
 306         dispatchParams();
 307         hide();
 308 }
 309
 310
 311 void GuiSymbols::on_closePB_clicked()
 312 {
 313         hide();
 314 }
 315
 316
 317 void GuiSymbols::on_symbolsLW_activated(QModelIndex const &)
 318 {
 319         on_okPB_clicked();
 320 }
 321
 322
 323 void GuiSymbols::on_chosenLE_textChanged(QString const & text)
 324 {
 325         bool const empty_sel = text.isEmpty();
 326         okPB->setEnabled(!empty_sel);
 327         applyPB->setEnabled(!empty_sel);
 328 }
 329
 330
 331 void GuiSymbols::on_chosenLE_returnPressed()
 332 {
 333         on_okPB_clicked();
 334 }
 335
 336
 337 void GuiSymbols::on_symbolsLW_clicked(QModelIndex const & index)
 338 {
 339         QString const text = model_->data(index, Qt::DisplayRole).toString();
 340         if (text.isEmpty())
 341                 return;
 342         if (chosenLE->isEnabled())
 343                 chosenLE->insert(text);
 344         if (categoryFilterCB->isChecked()) {
 345                 QString const category = getBlock(text.data()->unicode());
 346                 categoryCO->setCurrentIndex(categoryCO->findText(category));
 347         }
 348 }
 349
 350
 351 void GuiSymbols::on_categoryCO_activated(QString const & text)
 352 {
 353         if (!categoryFilterCB->isChecked())
 354                 updateSymbolList(false);
 355         else
 356                 scrollToItem(text);
 357 }
 358
 359
 360 void GuiSymbols::on_categoryFilterCB_toggled(bool on)
 361 {
 362         updateSymbolList(on);
 363         if (on)
 364                 scrollToItem(categoryCO->currentText());
 365 }
 366
 367
 368 void GuiSymbols::scrollToItem(QString const & category)
 369 {
 370         if (used_blocks.find(category) != used_blocks.end()) {
 371                 int row = used_blocks[category];
 372                 QModelIndex index = symbolsLW->model()->index(row, 0, QModelIndex());
 373                 symbolsLW->scrollTo(index, QAbstractItemView::PositionAtTop);
 374         }
 375 }
 376
 377 void GuiSymbols::updateSymbolList(bool update_combo)
 378 {
 379         QString category = categoryCO->currentText();
 380         bool const nocategory = category.isEmpty();
 381         char_type range_start = 0x0000;
 382         char_type range_end = 0x110000;
 383         QList<char_type> s;
 384         if (update_combo) {
 385                 used_blocks.clear();
 386                 categoryCO->clear();
 387         }
 388         bool const show_all = categoryFilterCB->isChecked();
 389
 390         if (symbols_.empty() || update_combo)
 391                 symbols_ = encodings.getFromLyXName(encoding_)->getSymbolsList();
 392
 393         if (!show_all) {
 394                 for (int i = 0 ; i < no_blocks; ++i)
 395                         if (unicode_blocks[i].name == category) {
 396                                 range_start = unicode_blocks[i].start;
 397                                 range_end = unicode_blocks[i].end;
 398                                 break;
 399                         }
 400         }
 401
 402         SymbolsList::const_iterator const end = symbols_.end();
 403         int numItem = 0;
 404         for (SymbolsList::const_iterator it = symbols_.begin(); it != end; ++it) {
 405                 char_type c = *it;
 406                 if (!update_combo && !show_all && (c <= range_start || c >= range_end))
 407                         continue;
 408 #if QT_VERSION >= 0x040300
 409                 QChar::Category const cat = QChar::category(uint(c));
 410 #else
 411                 QChar const qc = uint(c);
 412                 QChar::Category const cat = qc.category();
 413 #endif
 414                 // we do not want control or space characters
 415                 if (cat == QChar::Other_Control || cat == QChar::Separator_Space)
 416                         continue;
 417                 ++numItem;
 418                 if (show_all || c >= range_start && c <= range_end)
 419                         s.append(c);
 420                 if (update_combo) {
 421                         QString block = getBlock(c);
 422                         if (category.isEmpty())
 423                                 category = block;
 424                         if (used_blocks.find(block) == used_blocks.end())
 425                                 used_blocks[block] = numItem;
 426                 }
 427         }
 428         model_->reset(s);
 429
 430         if (update_combo) {
 431                 // update category combo
 432                 for (UsedBlocks::iterator it = used_blocks.begin();
 433                      it != used_blocks.end(); ++it) {
 434                         categoryCO->addItem(it->first);
 435                 }
 436         }
 437
 438         int old = categoryCO->findText(category);
 439         if (old != -1)
 440                 categoryCO->setCurrentIndex(old);
 441         // update again in case the combo has not yet been filled
 442         // on first cycle (at dialog initialization)
 443         if (nocategory && !category.isEmpty())
 444                 updateSymbolList();
 445 }
 446
 447
 448 void GuiSymbols::dispatchParams()
 449 {
 450         dispatch(FuncRequest(getLfun(), fromqstr(chosenLE->text())));
 451 }
 452
 453
 454 Dialog * createGuiSymbols(GuiView & lv)
 455 {
 456         return new GuiSymbols(lv);
 457 }
 458
 459
 460 } // namespace frontend
 461 } // namespace lyx
 462
 463 #include "GuiSymbols_moc.cpp"