src/frontends/qt4/GuiDelimiter.cpp

   1 /**
   2  * \file GuiDelimiter.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "GuiDelimiter.h"
  14
  15 #include "GuiApplication.h"
  16 #include "GuiFontLoader.h"
  17 #include "GuiView.h"
  18 #include "qt_helpers.h"
  19
  20 #include "FontEnums.h"
  21 #include "FontInfo.h"
  22 #include "FuncRequest.h"
  23
  24 #include "support/debug.h"
  25 #include "support/docstring.h"
  26 #include "support/gettext.h"
  27
  28 #include <QPixmap>
  29 #include <QCheckBox>
  30 #include <QListWidgetItem>
  31 #include <QScrollBar>
  32
  33 #include <map>
  34 #include <string>
  35
  36 using namespace std;
  37
  38 namespace lyx {
  39 namespace frontend {
  40
  41 namespace {
  42
  43 static char const *  latex_delimiters[] = {
  44         "(", ")", "{", "}", "[", "]",
  45         "lceil", "rceil", "lfloor", "rfloor", "langle", "rangle",
  46         "llbracket", "rrbracket",
  47         "uparrow", "updownarrow", "Uparrow", "Updownarrow", "downarrow", "Downarrow",
  48         "|", "Vert", "/", "backslash", ""
  49 };
  50
  51
  52 static int const nr_latex_delimiters =
  53         sizeof(latex_delimiters) / sizeof(char const *);
  54
  55 static QString const bigleft[]  = {"", "bigl", "Bigl", "biggl", "Biggl"};
  56
  57 static QString const bigright[] = {"", "bigr", "Bigr", "biggr", "Biggr"};
  58
  59 static char const * const biggui[] = {
  60         N_("big[[delimiter size]]"),
  61         N_("Big[[delimiter size]]"),
  62         N_("bigg[[delimiter size]]"),
  63         N_("Bigg[[delimiter size]]"),
  64         ""
  65 };
  66
  67
  68 // FIXME: It might be better to fix the big delim LFUN to not require
  69 // additional '\' prefix.
  70 static QString fix_name(QString const & str, bool big)
  71 {
  72         if (str.isEmpty())
  73                 return ".";
  74         if (!big || str == "(" || str == ")" || str == "[" || str == "]"
  75             || str == "|" || str == "/")
  76                 return str;
  77
  78         return "\\" + str;
  79 }
  80
  81 struct MathSymbol {
  82         MathSymbol(char_type uc = '?', unsigned char fc = 0,
  83                 FontFamily ff = SYMBOL_FAMILY)
  84                 : unicode(uc), fontcode(fc), fontfamily(ff)
  85         {}
  86         char_type unicode;
  87         unsigned char fontcode;
  88         FontFamily fontfamily;
  89 };
  90
  91 /// TeX-name / Math-symbol map.
  92 static map<std::string, MathSymbol> math_symbols_;
  93 /// Math-symbol / TeX-name map.
  94 /// This one is for fast search, it contains the same data as
  95 /// \c math_symbols_.
  96 static map<char_type, string> tex_names_;
  97
  98 void initMathSymbols()
  99 {
 100         // FIXME: Ideally, those unicode codepoints would be defined
 101         // in "lib/symbols". Unfortunately, some of those are already
 102         // defined with non-unicode ids for use within mathed.
 103         // FIXME 2: We should fill-in this map with the parsed "symbols"
 104         // file done in MathFactory.cpp.
 105         math_symbols_["("] = MathSymbol('(', 40, CMR_FAMILY);
 106         math_symbols_[")"] = MathSymbol(')', 41, CMR_FAMILY);
 107         math_symbols_["{"] = MathSymbol('{', 102, CMSY_FAMILY);
 108         math_symbols_["}"] = MathSymbol('}', 103, CMSY_FAMILY);
 109         math_symbols_["["] = MathSymbol('[', 91, CMR_FAMILY);
 110         math_symbols_["]"] = MathSymbol(']', 93, CMR_FAMILY);
 111         math_symbols_["|"] = MathSymbol('|', 106, CMSY_FAMILY);
 112         math_symbols_["/"] = MathSymbol('/', 47, CMR_FAMILY);
 113         math_symbols_["backslash"] = MathSymbol('\\', 110, CMSY_FAMILY);
 114         math_symbols_["lceil"] = MathSymbol(0x2308, 100, CMSY_FAMILY);
 115         math_symbols_["rceil"] = MathSymbol(0x2309, 101, CMSY_FAMILY);
 116         math_symbols_["lfloor"] = MathSymbol(0x230A, 98, CMSY_FAMILY);
 117         math_symbols_["rfloor"] = MathSymbol(0x230B, 99, CMSY_FAMILY);
 118         math_symbols_["langle"] = MathSymbol(0x2329, 104, CMSY_FAMILY);
 119         math_symbols_["rangle"] = MathSymbol(0x232A, 105, CMSY_FAMILY);
 120         math_symbols_["llbracket"] = MathSymbol(0x27e6, 74, STMARY_FAMILY);
 121         math_symbols_["rrbracket"] = MathSymbol(0x27e7, 75, STMARY_FAMILY);
 122         math_symbols_["uparrow"] = MathSymbol(0x2191, 34, CMSY_FAMILY);
 123         math_symbols_["Uparrow"] = MathSymbol(0x21D1, 42, CMSY_FAMILY);
 124         math_symbols_["updownarrow"] = MathSymbol(0x2195, 108, CMSY_FAMILY);
 125         math_symbols_["Updownarrow"] = MathSymbol(0x21D5, 109, CMSY_FAMILY);
 126         math_symbols_["downarrow"] = MathSymbol(0x2193, 35, CMSY_FAMILY);
 127         math_symbols_["Downarrow"] = MathSymbol(0x21D3, 43, CMSY_FAMILY);
 128         math_symbols_["downdownarrows"] = MathSymbol(0x21CA, 184, MSA_FAMILY);
 129         math_symbols_["downharpoonleft"] = MathSymbol(0x21C3, 188, MSA_FAMILY);
 130         math_symbols_["downharpoonright"] = MathSymbol(0x21C2, 186, MSA_FAMILY);
 131         math_symbols_["vert"] = MathSymbol(0x007C, 106, CMSY_FAMILY);
 132         math_symbols_["Vert"] = MathSymbol(0x2016, 107, CMSY_FAMILY);
 133
 134         map<string, MathSymbol>::const_iterator it = math_symbols_.begin();
 135         map<string, MathSymbol>::const_iterator end = math_symbols_.end();
 136         for (; it != end; ++it)
 137                 tex_names_[it->second.unicode] = it->first;
 138 }
 139
 140 /// \return the math unicode symbol associated to a TeX name.
 141 MathSymbol const & mathSymbol(string tex_name)
 142 {
 143         map<string, MathSymbol>::const_iterator it =
 144                 math_symbols_.find(tex_name);
 145
 146         static MathSymbol const unknown_symbol;
 147         if (it == math_symbols_.end())
 148                 return unknown_symbol;
 149
 150         return it->second;
 151 }
 152
 153 /// \return the TeX name associated to a math unicode symbol.
 154 string const & texName(char_type math_symbol)
 155 {
 156         map<char_type, string>::const_iterator it =
 157                 tex_names_.find(math_symbol);
 158
 159         static string const empty_string;
 160         if (it == tex_names_.end())
 161                 return empty_string;
 162
 163         return it->second;
 164 }
 165
 166 } // anon namespace
 167
 168
 169 GuiDelimiter::GuiDelimiter(GuiView & lv)
 170         : GuiDialog(lv, "mathdelimiter", qt_("Math Delimiter"))
 171 {
 172         setupUi(this);
 173
 174         connect(closePB, SIGNAL(clicked()), this, SLOT(accept()));
 175
 176         setFocusProxy(leftLW);
 177
 178         leftLW->setViewMode(QListView::IconMode);
 179         rightLW->setViewMode(QListView::IconMode);
 180
 181         leftLW->setDragDropMode(QAbstractItemView::NoDragDrop);
 182         rightLW->setDragDropMode(QAbstractItemView::NoDragDrop);
 183
 184         initMathSymbols();
 185
 186         FontInfo lyxfont;
 187         lyxfont.setFamily(CMR_FAMILY);
 188         QFontMetrics fm(frontend::getFont(lyxfont));
 189         QSize item_size(fm.maxWidth(), fm.height() + 8);
 190
 191         typedef map<char_type, QListWidgetItem *> ListItems;
 192         ListItems list_items;
 193         // The last element is the empty one.
 194         int const end = nr_latex_delimiters - 1;
 195         for (int i = 0; i < end; ++i) {
 196                 string const delim = latex_delimiters[i];
 197                 MathSymbol const & ms = mathSymbol(delim);
 198                 QString symbol(ms.fontcode?
 199                         QChar(ms.fontcode) : toqstr(docstring(1, ms.unicode)));
 200                 QListWidgetItem * lwi = new QListWidgetItem(symbol);
 201                 lyxfont.setFamily(ms.fontfamily);
 202                 QFont font = frontend::getFont(lyxfont);
 203                 lwi->setFont(font);
 204                 lwi->setToolTip(toqstr(delim));
 205                 lwi->setSizeHint(item_size);
 206                 switch (ms.fontfamily) {
 207                 case CMSY_FAMILY:
 208                 case STMARY_FAMILY:
 209                         // Hack to work around the broken metrics of these fonts
 210                         // FIXME: Better fix the fonts or use fonts that are not broken
 211                         lwi->setTextAlignment(Qt::AlignTop | Qt::AlignHCenter);
 212                         break;
 213                 default:
 214                         lwi->setTextAlignment(Qt::AlignCenter);
 215                 }
 216                 list_items[ms.unicode] = lwi;
 217                 leftLW->addItem(lwi);
 218         }
 219
 220         for (int i = 0; i != leftLW->count(); ++i) {
 221                 MathSymbol const & ms = mathSymbol(
 222                         fromqstr(leftLW->item(i)->toolTip()));
 223                 rightLW->addItem(list_items[doMatch(ms.unicode)]->clone());
 224         }
 225
 226         // The last element is the empty one.
 227         QListWidgetItem * lwi = new QListWidgetItem(qt_("(None)"));
 228         QListWidgetItem * rwi = new QListWidgetItem(qt_("(None)"));
 229         leftLW->addItem(lwi);
 230         rightLW->addItem(rwi);
 231
 232         sizeCO->addItem(qt_("Variable"));
 233
 234         for (int i = 0; *biggui[i]; ++i)
 235                 sizeCO->addItem(qt_(biggui[i]));
 236
 237         on_leftLW_currentRowChanged(0);
 238         // synchronise the scroll bars
 239         on_matchCB_stateChanged(matchCB->checkState());
 240         bc().setPolicy(ButtonPolicy::IgnorantPolicy);
 241 }
 242
 243
 244 char_type GuiDelimiter::doMatch(char_type const symbol)
 245 {
 246         string const & str = texName(symbol);
 247         string match;
 248         if (str == "(") match = ")";
 249         else if (str == ")") match = "(";
 250         else if (str == "[") match = "]";
 251         else if (str == "]") match = "[";
 252         else if (str == "{") match = "}";
 253         else if (str == "}") match = "{";
 254         else if (str == "l") match = "r";
 255         else if (str == "rceil") match = "lceil";
 256         else if (str == "lceil") match = "rceil";
 257         else if (str == "rfloor") match = "lfloor";
 258         else if (str == "lfloor") match = "rfloor";
 259         else if (str == "rangle") match = "langle";
 260         else if (str == "langle") match = "rangle";
 261         else if (str == "llbracket") match = "rrbracket";
 262         else if (str == "rrbracket") match = "llbracket";
 263         else if (str == "backslash") match = "/";
 264         else if (str == "/") match = "backslash";
 265         else return symbol;
 266
 267         return mathSymbol(match).unicode;
 268 }
 269
 270
 271 void GuiDelimiter::updateTeXCode(int size)
 272 {
 273         bool const bigsize = size != 0;
 274
 275         QString left_str = fix_name(leftLW->currentItem()->toolTip(), bigsize);
 276         QString right_str = fix_name(rightLW->currentItem()->toolTip(), bigsize);
 277
 278         if (!bigsize)
 279                 tex_code_ = left_str + ' ' + right_str;
 280         else {
 281                 tex_code_ = bigleft[size] + ' '
 282                         + left_str + ' '
 283                         + bigright[size] + ' '
 284                         + right_str;
 285         }
 286
 287         // Generate TeX-code for GUI display.
 288         // FIXME: Instead of reconstructing the TeX code it would be nice to
 289         // FIXME: retrieve the LateX code directly from mathed.
 290         // In all cases, we want the '\' prefix if needed, so we pass 'true'
 291         // to fix_name.
 292         left_str = fix_name(leftLW->currentItem()->toolTip(), true);
 293         right_str = fix_name(rightLW->currentItem()->toolTip(), true);
 294         QString code_str;
 295         if (!bigsize)
 296                 code_str = "\\left" + left_str + " \\right" + right_str;
 297         else {
 298                 // There should be nothing in the TeX-code when the delimiter is "None".
 299                 if (left_str != ".")
 300                         code_str = "\\" + bigleft[size] + left_str + ' ';
 301                 if (right_str != ".")
 302                         code_str += "\\" + bigright[size] + right_str;
 303         }
 304
 305         texCodeL->setText(qt_("TeX Code: ") + code_str);
 306 }
 307
 308
 309 void GuiDelimiter::on_insertPB_clicked()
 310 {
 311         if (sizeCO->currentIndex() == 0)
 312                 dispatch(FuncRequest(LFUN_MATH_DELIM, fromqstr(tex_code_)));
 313         else {
 314                 QString command = '"' + tex_code_ + '"';
 315                 command.replace(' ', "\" \"");
 316                 dispatch(FuncRequest(LFUN_MATH_BIGDELIM, fromqstr(command)));
 317         }
 318  }
 319
 320
 321 void GuiDelimiter::on_sizeCO_activated(int index)
 322 {
 323         updateTeXCode(index);
 324 }
 325
 326
 327 void GuiDelimiter::on_leftLW_itemActivated(QListWidgetItem *)
 328 {
 329         // do not auto-apply if !matchCB->isChecked()
 330         if (!matchCB->isChecked())
 331                 return;
 332         on_insertPB_clicked();
 333         accept();
 334 }
 335
 336
 337 void GuiDelimiter::on_rightLW_itemActivated(QListWidgetItem *)
 338 {
 339         // do not auto-apply if !matchCB->isChecked()
 340         if (!matchCB->isChecked())
 341                 return;
 342         on_insertPB_clicked();
 343         accept();
 344 }
 345
 346
 347 void GuiDelimiter::on_leftLW_currentRowChanged(int item)
 348 {
 349         if (matchCB->isChecked())
 350                 rightLW->setCurrentRow(item);
 351
 352         updateTeXCode(sizeCO->currentIndex());
 353 }
 354
 355
 356 void GuiDelimiter::on_rightLW_currentRowChanged(int item)
 357 {
 358         if (matchCB->isChecked())
 359                 leftLW->setCurrentRow(item);
 360
 361         updateTeXCode(sizeCO->currentIndex());
 362 }
 363
 364
 365 void GuiDelimiter::on_matchCB_stateChanged(int state)
 366 {
 367         // Synchronise the vertical scroll bars when checked
 368         QScrollBar * ls = leftLW->verticalScrollBar();
 369         QScrollBar * rs = rightLW->verticalScrollBar();
 370
 371         if (state == Qt::Checked) {
 372                 on_leftLW_currentRowChanged(leftLW->currentRow());
 373
 374                 connect(ls, SIGNAL(valueChanged(int)), rs, SLOT(setValue(int)),
 375                         Qt::UniqueConnection);
 376                 connect(rs, SIGNAL(valueChanged(int)), ls, SLOT(setValue(int)),
 377                         Qt::UniqueConnection);
 378                 rs->setValue(ls->value());
 379         } else {
 380                 ls->disconnect(rs);
 381                 rs->disconnect(ls);
 382         }
 383
 384         updateTeXCode(sizeCO->currentIndex());
 385 }
 386
 387
 388 Dialog * createGuiDelimiter(GuiView & lv) { return new GuiDelimiter(lv); }
 389
 390
 391 } // namespace frontend
 392 } // namespace lyx
 393
 394 #include "moc_GuiDelimiter.cpp"