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