src/frontends/qt4/GuiApplication.cpp

   1 /**
   2  * \file GuiApplication.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author unknown
   7  * \author John Levon
   8  * \author Abdelrazak Younes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "GuiApplication.h"
  16
  17 #include "ColorCache.h"
  18 #include "ColorSet.h"
  19 #include "GuiClipboard.h"
  20 #include "GuiKeySymbol.h"
  21 #include "GuiSelection.h"
  22 #include "GuiView.h"
  23 #include "Menus.h"
  24 #include "qt_helpers.h"
  25 #include "Toolbars.h"
  26
  27 #include "frontends/alert.h"
  28 #include "frontends/Application.h"
  29 #include "frontends/FontLoader.h"
  30 #include "frontends/FontMetrics.h"
  31
  32 #include "Buffer.h"
  33 #include "BufferList.h"
  34 #include "BufferParams.h"
  35 #include "BufferView.h"
  36 #include "CmdDef.h"
  37 #include "Color.h"
  38 #include "Converter.h"
  39 #include "CutAndPaste.h"
  40 #include "ErrorList.h"
  41 #include "Font.h"
  42 #include "FuncRequest.h"
  43 #include "FuncStatus.h"
  44 #include "GuiWorkArea.h"
  45 #include "Intl.h"
  46 #include "KeyMap.h"
  47 #include "Language.h"
  48 #include "LaTeXPackages.h"
  49 #include "Lexer.h"
  50 #include "LyX.h"
  51 #include "LyXAction.h"
  52 #include "LyXRC.h"
  53 #include "Paragraph.h"
  54 #include "Server.h"
  55 #include "Session.h"
  56 #include "SpellChecker.h"
  57 #include "Thesaurus.h"
  58 #include "version.h"
  59
  60 #include "insets/InsetText.h"
  61
  62 #include "support/convert.h"
  63 #include "support/debug.h"
  64 #include "support/ExceptionMessage.h"
  65 #include "support/FileName.h"
  66 #include "support/filetools.h"
  67 #include "support/ForkedCalls.h"
  68 #include "support/gettext.h"
  69 #include "support/lassert.h"
  70 #include "support/lstrings.h"
  71 #include "support/lyxalgo.h" // sorted
  72 #include "support/textutils.h"
  73 #include "support/Messages.h"
  74 #include "support/os.h"
  75 #include "support/Package.h"
  76 #include "support/TempFile.h"
  77
  78 #ifdef Q_OS_MAC
  79 #include "support/AppleScript.h"
  80 #include "support/linkback/LinkBackProxy.h"
  81 #endif
  82
  83 #include <queue>
  84
  85 #include <QFontDatabase>
  86 #include <QByteArray>
  87 #include <QClipboard>
  88 #include <QDateTime>
  89 #include <QDesktopWidget>
  90 #include <QDir>
  91 #include <QEvent>
  92 #include <QEventLoop>
  93 #include <QFileOpenEvent>
  94 #include <QFileInfo>
  95 #include <QHash>
  96 #include <QIcon>
  97 #include <QImageReader>
  98 #include <QKeyEvent>
  99 #include <QLocale>
 100 #include <QLibraryInfo>
 101 #include <QList>
 102 #include <QMenuBar>
 103 #include <QMimeData>
 104 #include <QObject>
 105 #include <QPixmap>
 106 #include <QPixmapCache>
 107 #include <QRegExp>
 108 #include <QSessionManager>
 109 #include <QSettings>
 110 #include <QShowEvent>
 111 #include <QSocketNotifier>
 112 #include <QSortFilterProxyModel>
 113 #include <QStandardItemModel>
 114 #include <QTextCodec>
 115 #include <QTimer>
 116 #include <QTranslator>
 117 #include <QThreadPool>
 118 #include <QWidget>
 119
 120 #ifdef Q_WS_X11
 121 #include <X11/Xatom.h>
 122 #include <X11/Xlib.h>
 123 #undef CursorShape
 124 #undef None
 125 #elif defined(QPA_XCB)
 126 #include <xcb/xcb.h>
 127 #endif
 128
 129 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
 130 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
 131 #if (QT_VERSION < 0x050000)
 132 #include <QWindowsMime>
 133 #define QWINDOWSMIME QWindowsMime
 134 #else
 135 #include <QWinMime>
 136 #define QWINDOWSMIME QWinMime
 137 #endif
 138 #ifdef Q_CC_GNU
 139 #include <wtypes.h>
 140 #endif
 141 #include <objidl.h>
 142 #endif
 143 #endif
 144
 145 #ifdef Q_OS_MAC
 146 #include <QMacPasteboardMime>
 147 #endif // Q_OS_MAC
 148
 149 #include "support/bind.h"
 150 #include <boost/crc.hpp>
 151
 152 #include <exception>
 153 #include <sstream>
 154 #include <vector>
 155
 156 using namespace std;
 157 using namespace lyx::support;
 158
 159
 160 static void initializeResources()
 161 {
 162         static bool initialized = false;
 163         if (!initialized) {
 164                 Q_INIT_RESOURCE(Resources);
 165                 initialized = true;
 166         }
 167 }
 168
 169
 170 namespace lyx {
 171
 172 frontend::Application * createApplication(int & argc, char * argv[])
 173 {
 174 #if !defined(Q_WS_X11) && !defined(QPA_XCB)
 175         // prune -geometry argument(s) by shifting
 176         // the following ones 2 places down.
 177         for (int i = 0 ; i < argc ; ++i) {
 178                 if (strcmp(argv[i], "-geometry") == 0) {
 179                         int const remove = (i+1) < argc ? 2 : 1;
 180                         argc -= remove;
 181                         for (int j = i; j < argc; ++j)
 182                                 argv[j] = argv[j + remove];
 183                         --i;
 184                 }
 185         }
 186 #endif
 187         frontend::GuiApplication * guiApp = new frontend::GuiApplication(argc, argv);
 188         // I'd rather do that in the constructor, but I do not think that
 189         // the palette is accessible there.
 190         guiApp->colorCache().setPalette(guiApp->palette());
 191         return guiApp;
 192 }
 193
 194
 195 void setLocale()
 196 {
 197         QLocale theLocale;
 198         string code;
 199         if (lyxrc.gui_language == "auto") {
 200                 theLocale = QLocale::system();
 201                 code = fromqstr(theLocale.name());
 202         } else {
 203                 Language const * l = languages.getLanguage(lyxrc.gui_language);
 204                 code = l ? l->code() : "C";
 205                 theLocale = QLocale(toqstr(code));
 206         }
 207         // Qt tries to outsmart us and transforms en_US to C.
 208         Messages::guiLanguage((code == "C") ? "en_US" : code);
 209         QLocale::setDefault(theLocale);
 210         setlocale(LC_NUMERIC, "C");
 211 }
 212
 213
 214 namespace frontend {
 215
 216
 217 /// Return the list of loadable formats.
 218 vector<string> loadableImageFormats()
 219 {
 220         vector<string> fmts;
 221
 222         QList<QByteArray> qt_formats = QImageReader::supportedImageFormats();
 223
 224         LYXERR(Debug::GRAPHICS,
 225                 "\nThe image loader can load the following directly:\n");
 226
 227         if (qt_formats.empty())
 228                 LYXERR(Debug::GRAPHICS, "\nQt4 Problem: No Format available!");
 229
 230         bool jpeg_found = false;
 231         bool jpg_found = false;
 232         for (QList<QByteArray>::const_iterator it = qt_formats.begin(); it != qt_formats.end(); ++it) {
 233
 234                 LYXERR(Debug::GRAPHICS, (const char *) *it << ", ");
 235
 236                 string ext = ascii_lowercase((const char *) *it);
 237                 // special case
 238                 if (ext == "jpeg") {
 239                         jpeg_found = true;
 240                         if (jpg_found)
 241                                 continue;
 242                         ext = "jpg";
 243                 }
 244                 else if (ext == "jpg") {
 245                         jpg_found = true;
 246                         if (jpeg_found)
 247                                 continue;
 248                 }
 249                 else if (lyxrc.use_converter_cache &&
 250                          (ext == "svg" || ext == "svgz") &&
 251                           theConverters().isReachable("svg", "png"))
 252                         // Qt only supports SVG 1.2 tiny. See #9778. We prefer displaying
 253                         // the SVG as in the output. However we require that the converter
 254                         // cache is enabled since this is expensive. We also require that
 255                         // an explicit svg->png converter is defined, since the default
 256                         // converter could produce bad quality as well. This assumes that
 257                         // png can always be loaded.
 258                         continue;
 259                 fmts.push_back(ext);
 260         }
 261
 262         return fmts;
 263 }
 264
 265
 266 ////////////////////////////////////////////////////////////////////////
 267 //
 268 // Icon loading support code
 269 //
 270 ////////////////////////////////////////////////////////////////////////
 271
 272 namespace {
 273
 274 struct ImgMap {
 275         QString key;
 276         QString value;
 277 };
 278
 279
 280 bool operator<(ImgMap const & lhs, ImgMap const & rhs)
 281 {
 282         return lhs.key < rhs.key;
 283 }
 284
 285
 286 class CompareKey {
 287 public:
 288         CompareKey(QString const & name) : name_(name) {}
 289         bool operator()(ImgMap const & other) const { return other.key == name_; }
 290 private:
 291         QString const name_;
 292 };
 293
 294
 295 // this must be sorted alphabetically
 296 // Upper case comes before lower case
 297 // Please don't change the formatting, this list is parsed by
 298 // development/tools/generate_symbols_images.py.
 299 ImgMap sorted_img_map[] = {
 300         { "Arrownot", "arrownot2"},
 301         { "Arrowvert", "arrowvert2"},
 302         { "Bowtie", "bowtie2" },
 303         { "Box", "box2" },
 304         { "Bumpeq", "bumpeq2" },
 305         { "CIRCLE", "circle3" },
 306         { "Cap", "cap2" },
 307         { "CheckedBox", "checkedbox2" },
 308         { "Circle", "circle2" },
 309         { "Colonapprox", "colonapprox2" },
 310         { "Coloneq", "coloneq2" },
 311         { "Coloneqq", "coloneqq2" },
 312         { "Colonsim", "colonsim2" },
 313         { "Cup", "cup2" },
 314         { "DOWNarrow", "downarrow3" },
 315         { "Delta", "delta2" },
 316         { "Diamond", "diamond2" },
 317         { "Doteq", "doteq2" },
 318         { "Downarrow", "downarrow2" },
 319         { "Eqcolon", "eqcolon2" },
 320         { "Eqqcolon", "eqqcolon2" },
 321         { "Gamma", "gamma2" },
 322         { "Join", "join2" },
 323         { "LEFTCIRCLE", "leftcircle3" },
 324         { "LEFTarrow", "leftarrow3" },
 325         { "LEFTcircle", "leftcircle4" },
 326         { "LHD", "lhd2" },
 327         { "Lambda", "lambda2" },
 328         { "Lbag", "lbag2"},
 329         { "Leftarrow", "leftarrow2" },
 330         { "Leftcircle", "leftcircle2" },
 331         { "Leftrightarrow", "leftrightarrow2" },
 332         { "Longarrownot", "longarrownot2"},
 333         { "Longleftarrow", "longleftarrow2" },
 334         { "Longleftrightarrow", "longleftrightarrow2" },
 335         { "Longmapsfrom", "longmapsfrom2"},
 336         { "Longmapsto", "longmapsto2"},
 337         { "Longrightarrow", "longrightarrow2" },
 338         { "Mapsfrom", "mapsfrom2"},
 339         { "Mapsfromchar", "mapsfromchar2"},
 340         { "Mapsto", "mapsto2"},
 341         { "Mapstochar", "mapstochar2"},
 342         { "Omega", "omega2" },
 343         { "Phi", "phi2" },
 344         { "Pi", "pi2" },
 345         { "Psi", "psi2" },
 346         { "RHD", "rhd2" },
 347         { "RIGHTCIRCLE", "rightcircle3" },
 348         { "RIGHTarrow", "rightarrow3" },
 349         { "RIGHTcircle", "rightcircle4" },
 350         { "Rbag", "rbag2"},
 351         { "Rightarrow", "rightarrow2" },
 352         { "Rightcircle", "rightcircle2" },
 353         { "Sigma", "sigma2" },
 354         { "Square", "square2" },
 355         { "Subset", "subset2" },
 356         { "Supset", "supset2" },
 357         { "Theta", "theta2" },
 358         { "Thorn", "thorn2" },
 359         { "UParrow", "uparrow3" },
 360         { "Uparrow", "uparrow2" },
 361         { "Updownarrow", "updownarrow2" },
 362         { "Upsilon", "upsilon2" },
 363         { "Vdash", "vdash3" },
 364         { "Vert", "vert2" },
 365         { "XBox", "xbox3" },
 366         { "Xbox", "xbox2" },
 367         { "Xi", "xi2" },
 368         { "lVert", "vert2" },
 369         { "lvert", "vert" },
 370         { "nLeftarrow", "nleftarrow2" },
 371         { "nLeftrightarrow", "nleftrightarrow2" },
 372         { "nRightarrow", "nrightarrow2" },
 373         { "nVDash", "nvdash3" },
 374         { "nVdash", "nvdash4" },
 375         { "nvDash", "nvdash2" },
 376         { "rVert", "vert2" },
 377         { "rvert", "vert" },
 378         { "textrm \\AA", "textrm_AA"},
 379         { "textrm \\O", "textrm_O"},
 380         { "vDash", "vdash2" },
 381         { "varDelta", "vardelta2" },
 382         { "varGamma", "vargamma2" },
 383         { "varLambda", "varlambda2" },
 384         { "varOmega", "varomega2" },
 385         { "varPhi", "varphi2" },
 386         { "varPi", "varpi2" },
 387         { "varPsi", "varpsi2" },
 388         { "varSigma", "varsigma2" },
 389         { "varTheta", "vartheta2" },
 390         { "varUpsilon", "varupsilon2" },
 391         { "varXi", "varxi2" }
 392 };
 393
 394
 395 size_t const nr_sorted_img_map = sizeof(sorted_img_map) / sizeof(ImgMap);
 396
 397 // This list specifies which system's theme icon is related to which lyx
 398 // command. It was based on:
 399 // http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
 400 // this must be sorted alphabetically
 401 // Upper case comes before lower case
 402 ImgMap sorted_theme_icon_map[] = {
 403         { "bookmark-goto 0", "go-jump" },
 404         { "buffer-new", "document-new" },
 405         { "buffer-write", "document-save" },
 406         { "buffer-write-as", "document-save-as" },
 407         { "buffer-zoom-in", "zoom-in" },
 408         { "buffer-zoom-out", "zoom-out" },
 409         { "copy", "edit-copy" },
 410         { "cut", "edit-cut" },
 411         { "depth-decrement", "format-indent-less" },
 412         { "depth-increment", "format-indent-more" },
 413         { "dialog-show spellchecker", "tools-check-spelling" },
 414         { "dialog-show-new-inset graphics", "insert-image" },
 415         { "dialog-toggle findreplaceadv", "edit-find-replace" },
 416         { "file-open", "document-open" },
 417         { "font-bold", "format-text-bold" },
 418         { "font-ital", "format-text-italic" },
 419         { "font-strikeout", "format-text-strikethrough" },
 420         { "font-underline", "format-text-underline" },
 421         { "lyx-quit", "application-exit" },
 422         { "paste", "edit-paste" },
 423         { "redo", "edit-redo" },
 424         { "undo", "edit-undo" },
 425         { "window-close", "window-close" },
 426         { "window-new", "window-new" }
 427 };
 428
 429 size_t const nr_sorted_theme_icon_map = sizeof(sorted_theme_icon_map) / sizeof(ImgMap);
 430
 431
 432 QString findImg(QString const & name)
 433 {
 434         ImgMap const * const begin = sorted_img_map;
 435         ImgMap const * const end = begin + nr_sorted_img_map;
 436         LATTEST(sorted(begin, end));
 437
 438         ImgMap const * const it = find_if(begin, end, CompareKey(name));
 439
 440         QString img_name;
 441         if (it != end) {
 442                 img_name = it->value;
 443         } else {
 444                 img_name = name;
 445                 img_name.replace('_', "underscore");
 446                 img_name.replace(' ', '_');
 447
 448                 // This way we can have "math-delim { }" on the toolbar.
 449                 img_name.replace('(', "lparen");
 450                 img_name.replace(')', "rparen");
 451                 img_name.replace('[', "lbracket");
 452                 img_name.replace(']', "rbracket");
 453                 img_name.replace('{', "lbrace");
 454                 img_name.replace('}', "rbrace");
 455                 img_name.replace('|', "bars");
 456                 img_name.replace(',', "thinspace");
 457                 img_name.replace(':', "mediumspace");
 458                 img_name.replace(';', "thickspace");
 459                 img_name.replace('!', "negthinspace");
 460         }
 461
 462         LYXERR(Debug::GUI, "findImg(" << name << ")\n"
 463                 << "Looking for math icon called \"" << img_name << '"');
 464         return img_name;
 465 }
 466
 467 } // namespace anon
 468
 469
 470 QString themeIconName(QString const & action)
 471 {
 472         ImgMap const * const begin = sorted_theme_icon_map;
 473         ImgMap const * const end = begin + nr_sorted_theme_icon_map;
 474         LASSERT(sorted(begin, end), /**/);
 475
 476         ImgMap const * const it = find_if(begin, end, CompareKey(action));
 477
 478         if (it != end)
 479                 return it->value;
 480         return QString();
 481 }
 482
 483
 484 QString iconName(FuncRequest const & f, bool unknown)
 485 {
 486         initializeResources();
 487         QString name1;
 488         QString name2;
 489         QString path;
 490         switch (f.action()) {
 491         case LFUN_MATH_INSERT:
 492                 if (!f.argument().empty()) {
 493                         path = "math/";
 494                         name1 = findImg(toqstr(f.argument()).mid(1));
 495                 }
 496                 break;
 497         case LFUN_MATH_DELIM:
 498         case LFUN_MATH_BIGDELIM:
 499                 path = "math/";
 500                 name1 = findImg(toqstr(f.argument()));
 501                 break;
 502         case LFUN_CALL:
 503                 path = "commands/";
 504                 name1 = toqstr(f.argument());
 505                 break;
 506         case LFUN_COMMAND_ALTERNATIVES: {
 507                 // use the first of the alternative commands
 508                 docstring firstcom;
 509                 docstring dummy = split(f.argument(), firstcom, ';');
 510                 name1 = toqstr(firstcom);
 511                 name1.replace(' ', '_');
 512                 break;
 513         }
 514         default:
 515                 name2 = toqstr(lyxaction.getActionName(f.action()));
 516                 name1 = name2;
 517
 518                 if (!f.argument().empty()) {
 519                         name1 = name2 + ' ' + toqstr(f.argument());
 520                         name1.replace(' ', '_');
 521                         name1.replace('\\', "backslash");
 522                 }
 523         }
 524
 525         QStringList imagedirs;
 526         imagedirs << "images/" << "images/ipa/";
 527         search_mode mode = theGuiApp()->imageSearchMode();
 528         for (int i = 0; i < imagedirs.size(); ++i) {
 529                 QString imagedir = imagedirs.at(i) + path;
 530                 FileName fname = imageLibFileSearch(imagedir, name1, "svgz,png", mode);
 531                 if (fname.exists())
 532                         return toqstr(fname.absFileName());
 533
 534                 fname = imageLibFileSearch(imagedir, name2, "svgz,png", mode);
 535                 if (fname.exists())
 536                         return toqstr(fname.absFileName());
 537         }
 538
 539         path = ":/images/" + path;
 540         QDir res(path);
 541         if (!res.exists()) {
 542                 LYXERR0("Directory " << path << " not found in resource!");
 543                 return QString();
 544         }
 545         if (res.exists(name1 + ".svgz"))
 546                 return path + name1 + ".svgz";
 547         else if (res.exists(name1 + ".png"))
 548                 return path + name1 + ".png";
 549
 550         if (res.exists(name2 + ".svgz"))
 551                 return path + name2 + ".svgz";
 552         else if (res.exists(name2 + ".png"))
 553                 return path + name2 + ".png";
 554
 555         LYXERR(Debug::GUI, "Cannot find icon with filename "
 556                            << "\"" << name1 << ".{svgz,png}\""
 557                            << " or filename "
 558                            << "\"" << name2 << ".{svgz,png}\""
 559                            << " for command \""
 560                            << lyxaction.getActionName(f.action())
 561                            << '(' << to_utf8(f.argument()) << ")\"");
 562
 563         if (unknown) {
 564                 QString imagedir = "images/";
 565                 FileName fname = imageLibFileSearch(imagedir, "unknown", "svgz,png", mode);
 566                 if (fname.exists())
 567                         return toqstr(fname.absFileName());
 568                 return QString(":/images/unknown.svgz");
 569         }
 570
 571         return QString();
 572 }
 573
 574
 575 bool getPixmap(QPixmap & pixmap, QString const & path)
 576 {
 577         return pixmap.load(path);
 578 }
 579
 580
 581 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext)
 582 {
 583         QString imagedir = path;
 584         FileName fname = imageLibFileSearch(imagedir, name, ext, theGuiApp()->imageSearchMode());
 585         QString fpath = toqstr(fname.absFileName());
 586         QPixmap pixmap = QPixmap();
 587
 588         if (getPixmap(pixmap, fpath)) {
 589                 return pixmap;
 590         }
 591
 592         QStringList exts = ext.split(",");
 593         fpath = ":/" + path + name + ".";
 594         for (int i = 0; i < exts.size(); ++i) {
 595                 if (getPixmap(pixmap, fpath + exts.at(i))) {
 596                         return pixmap;
 597                 }
 598         }
 599
 600         bool const list = ext.contains(",");
 601         LYXERR0("Cannot load pixmap \""
 602                 << path << name << "." << (list ? "{" : "") << ext
 603                 << (list ? "}" : "") << "\", please verify resource system!");
 604
 605         return QPixmap();
 606 }
 607
 608
 609 QIcon getIcon(FuncRequest const & f, bool unknown)
 610 {
 611 #if (QT_VERSION >= 0x040600)
 612         if (lyxrc.use_system_theme_icons) {
 613                 // use the icons from system theme that are available
 614                 QString action = toqstr(lyxaction.getActionName(f.action()));
 615                 if (!f.argument().empty())
 616                         action += " " + toqstr(f.argument());
 617                 QString const theme_icon = themeIconName(action);
 618                 if (QIcon::hasThemeIcon(theme_icon)) {
 619                         QIcon const thmicn = QIcon::fromTheme(theme_icon);
 620                         if (!thmicn.isNull())
 621                                 return thmicn;
 622                 }
 623         }
 624 #endif
 625
 626         QString icon = iconName(f, unknown);
 627         if (icon.isEmpty())
 628                 return QIcon();
 629
 630         //LYXERR(Debug::GUI, "Found icon: " << icon);
 631         QPixmap pixmap = QPixmap();
 632         if (!getPixmap(pixmap,icon)) {
 633                 LYXERR0("Cannot load icon " << icon << " please verify resource system!");
 634                 return QIcon();
 635         }
 636
 637         return QIcon(pixmap);
 638 }
 639
 640
 641 ////////////////////////////////////////////////////////////////////////
 642 //
 643 // LyX server support code.
 644 //
 645 ////////////////////////////////////////////////////////////////////////
 646
 647 class SocketNotifier : public QSocketNotifier
 648 {
 649 public:
 650         /// connect a connection notification from the LyXServerSocket
 651         SocketNotifier(QObject * parent, int fd, Application::SocketCallback func)
 652                 : QSocketNotifier(fd, QSocketNotifier::Read, parent), func_(func)
 653         {}
 654
 655 public:
 656         /// The callback function
 657         Application::SocketCallback func_;
 658 };
 659
 660
 661 ////////////////////////////////////////////////////////////////////////
 662 //
 663 // Mac specific stuff goes here...
 664 //
 665 ////////////////////////////////////////////////////////////////////////
 666
 667 class MenuTranslator : public QTranslator
 668 {
 669 public:
 670         MenuTranslator(QObject * parent)
 671                 : QTranslator(parent)
 672         {}
 673
 674 #if QT_VERSION >= 0x050000
 675         virtual QString translate(const char * /* context */,
 676                 const char *sourceText,
 677                 const char * /* disambiguation */ = 0, int /* n */ = -1) const
 678 #else
 679         QString translate(const char * /*context*/,
 680           const char * sourceText,
 681           const char * /*comment*/ = 0) const
 682 #endif
 683         {
 684                 string const s = sourceText;
 685                 if (s == N_("About %1") || s == N_("Preferences")
 686                                 || s == N_("Reconfigure") || s == N_("Quit %1"))
 687                         return qt_(s);
 688                 else
 689                         return QString();
 690         }
 691 };
 692
 693 #ifdef Q_OS_MAC
 694 // QMacPasteboardMimeGraphics can only be compiled on Mac.
 695
 696 class QMacPasteboardMimeGraphics : public QMacPasteboardMime
 697 {
 698 public:
 699         QMacPasteboardMimeGraphics()
 700                 : QMacPasteboardMime(MIME_QT_CONVERTOR|MIME_ALL)
 701         {}
 702
 703         QString convertorName() { return "Graphics"; }
 704
 705         QString flavorFor(QString const & mime)
 706         {
 707                 LYXERR(Debug::ACTION, "flavorFor " << mime);
 708                 if (mime == pdfMimeType())
 709                         return QLatin1String("com.adobe.pdf");
 710                 return QString();
 711         }
 712
 713         QString mimeFor(QString flav)
 714         {
 715                 LYXERR(Debug::ACTION, "mimeFor " << flav);
 716                 if (flav == QLatin1String("com.adobe.pdf"))
 717                         return pdfMimeType();
 718                 return QString();
 719         }
 720
 721         bool canConvert(QString const & mime, QString flav)
 722         {
 723                 return mimeFor(flav) == mime;
 724         }
 725
 726         QVariant convertToMime(QString const & /*mime*/, QList<QByteArray> data,
 727                 QString /*flav*/)
 728         {
 729                 if(data.count() > 1)
 730                         qWarning("QMacPasteboardMimeGraphics: Cannot handle multiple member data");
 731                 return data.first();
 732         }
 733
 734         QList<QByteArray> convertFromMime(QString const & /*mime*/,
 735                 QVariant data, QString /*flav*/)
 736         {
 737                 QList<QByteArray> ret;
 738                 ret.append(data.toByteArray());
 739                 return ret;
 740         }
 741 };
 742 #endif
 743
 744 ///////////////////////////////////////////////////////////////
 745 //
 746 // You can find more platform specific stuff at the end of this file...
 747 //
 748 ///////////////////////////////////////////////////////////////
 749
 750 ////////////////////////////////////////////////////////////////////////
 751 // Windows specific stuff goes here...
 752
 753 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
 754 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
 755 // QWindowsMimeMetafile can only be compiled on Windows.
 756
 757 static FORMATETC cfFromMime(QString const & mimetype)
 758 {
 759         FORMATETC formatetc;
 760         if (mimetype == emfMimeType()) {
 761                 formatetc.cfFormat = CF_ENHMETAFILE;
 762                 formatetc.tymed = TYMED_ENHMF;
 763         } else if (mimetype == wmfMimeType()) {
 764                 formatetc.cfFormat = CF_METAFILEPICT;
 765                 formatetc.tymed = TYMED_MFPICT;
 766         }
 767         formatetc.ptd = 0;
 768         formatetc.dwAspect = DVASPECT_CONTENT;
 769         formatetc.lindex = -1;
 770         return formatetc;
 771 }
 772
 773
 774 class QWindowsMimeMetafile : public QWINDOWSMIME {
 775 public:
 776         QWindowsMimeMetafile() {}
 777
 778         bool canConvertFromMime(FORMATETC const & /*formatetc*/,
 779                 QMimeData const * /*mimedata*/) const
 780         {
 781                 return false;
 782         }
 783
 784         bool canConvertToMime(QString const & mimetype,
 785                 IDataObject * pDataObj) const
 786         {
 787                 if (mimetype != emfMimeType() && mimetype != wmfMimeType())
 788                         return false;
 789                 FORMATETC formatetc = cfFromMime(mimetype);
 790                 return pDataObj->QueryGetData(&formatetc) == S_OK;
 791         }
 792
 793         bool convertFromMime(FORMATETC const & /*formatetc*/,
 794                 const QMimeData * /*mimedata*/, STGMEDIUM * /*pmedium*/) const
 795         {
 796                 return false;
 797         }
 798
 799         QVariant convertToMime(QString const & mimetype, IDataObject * pDataObj,
 800                 QVariant::Type /*preferredType*/) const
 801         {
 802                 QByteArray data;
 803                 if (!canConvertToMime(mimetype, pDataObj))
 804                         return data;
 805
 806                 FORMATETC formatetc = cfFromMime(mimetype);
 807                 STGMEDIUM s;
 808                 if (pDataObj->GetData(&formatetc, &s) != S_OK)
 809                         return data;
 810
 811                 int dataSize;
 812                 if (s.tymed == TYMED_ENHMF) {
 813                         dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, 0, 0);
 814                         data.resize(dataSize);
 815                         dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, dataSize,
 816                                 (LPBYTE)data.data());
 817                 } else if (s.tymed == TYMED_MFPICT) {
 818                         dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, 0, 0);
 819                         data.resize(dataSize);
 820                         dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, dataSize,
 821                                 (LPBYTE)data.data());
 822                 }
 823                 data.detach();
 824                 ReleaseStgMedium(&s);
 825
 826                 return data;
 827         }
 828
 829
 830         QVector<FORMATETC> formatsForMime(QString const & mimetype,
 831                 QMimeData const * /*mimedata*/) const
 832         {
 833                 QVector<FORMATETC> formats;
 834                 if (mimetype == emfMimeType() || mimetype == wmfMimeType())
 835                         formats += cfFromMime(mimetype);
 836                 return formats;
 837         }
 838
 839         QString mimeForFormat(FORMATETC const & formatetc) const
 840         {
 841                 switch (formatetc.cfFormat) {
 842                 case CF_ENHMETAFILE:
 843                         return emfMimeType();
 844                 case CF_METAFILEPICT:
 845                         return wmfMimeType();
 846                 }
 847                 return QString();
 848         }
 849 };
 850
 851 #endif
 852 #endif
 853
 854
 855 /// Allows to check whether ESC was pressed during a long operation
 856 class KeyChecker : public QObject {
 857 private:
 858         bool pressed_;
 859         bool started_;
 860 public:
 861         KeyChecker() : pressed_(false), started_(false) {}
 862
 863         void start() {
 864                 QCoreApplication::instance()->installEventFilter(this);
 865                 pressed_ = false;
 866                 started_ = true;
 867         }
 868         void stop() {
 869                 QCoreApplication::instance()->removeEventFilter(this);
 870                 started_ = false;
 871         }
 872         bool pressed() {
 873                 QCoreApplication::processEvents();
 874                 return pressed_;
 875         }
 876         bool started() const {
 877                 return started_;
 878         }
 879         bool eventFilter(QObject *obj, QEvent *event) {
 880                 LYXERR(Debug::ACTION, "Event Type: " << event->type());
 881                 switch (event->type()) {
 882                 case QEvent::Show:
 883                 case QEvent::Hide:
 884                 case QEvent::Resize:
 885                 case QEvent::UpdateRequest:
 886                 case QEvent::CursorChange:
 887                 case QEvent::ActionChanged:
 888                 case QEvent::EnabledChange:
 889                 case QEvent::SockAct:
 890                 case QEvent::Timer:
 891                 case QEvent::Paint:
 892                 case QEvent::ToolTipChange:
 893                 case QEvent::LayoutRequest:
 894                 case QEvent::MetaCall:
 895                         return QObject::eventFilter(obj, event);
 896                 default:
 897                         // FIXME Blocking all these events is a bad idea.
 898                         QKeyEvent *keyEvent = dynamic_cast<QKeyEvent*>(event);
 899                         if (keyEvent && keyEvent->key() == Qt::Key_Escape)
 900                                 pressed_ = true;
 901                         return true;
 902                 }
 903         }
 904 };
 905
 906
 907 ////////////////////////////////////////////////////////////////////////
 908 // GuiApplication::Private definition and implementation.
 909 ////////////////////////////////////////////////////////////////////////
 910
 911 struct GuiApplication::Private
 912 {
 913         Private(): language_model_(0), meta_fake_bit(NoModifier),
 914                 global_menubar_(0)
 915         {
 916         #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
 917         #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
 918                 /// WMF Mime handler for Windows clipboard.
 919                 wmf_mime_ = new QWindowsMimeMetafile;
 920         #endif
 921         #endif
 922                 initKeySequences(&theTopLevelKeymap());
 923         }
 924
 925         void initKeySequences(KeyMap * kb)
 926         {
 927                 keyseq = KeySequence(kb, kb);
 928                 cancel_meta_seq = KeySequence(kb, kb);
 929         }
 930
 931         ///
 932         QSortFilterProxyModel * language_model_;
 933         ///
 934         GuiClipboard clipboard_;
 935         ///
 936         GuiSelection selection_;
 937         ///
 938         FontLoader font_loader_;
 939         ///
 940         ColorCache color_cache_;
 941         ///
 942         QTranslator qt_trans_;
 943         ///
 944         QHash<int, SocketNotifier *> socket_notifiers_;
 945         ///
 946         Menus menus_;
 947         ///
 948         /// The global instance
 949         Toolbars toolbars_;
 950
 951         /// this timer is used for any regular events one wants to
 952         /// perform. at present it is used to check if forked processes
 953         /// are done.
 954         QTimer general_timer_;
 955
 956         /// delayed FuncRequests
 957         std::queue<FuncRequest> func_request_queue_;
 958
 959         ///
 960         KeySequence keyseq;
 961         ///
 962         KeySequence cancel_meta_seq;
 963         ///
 964         KeyModifier meta_fake_bit;
 965
 966         /// The result of last dispatch action
 967         DispatchResult dispatch_result_;
 968
 969         /// Multiple views container.
 970         /**
 971         * Warning: This must not be a smart pointer as the destruction of the
 972         * object is handled by Qt when the view is closed
 973         * \sa Qt::WA_DeleteOnClose attribute.
 974         */
 975         QHash<int, GuiView *> views_;
 976
 977         /// Only used on mac.
 978         QMenuBar * global_menubar_;
 979
 980 #ifdef Q_OS_MAC
 981         /// Linkback mime handler for MacOSX.
 982         QMacPasteboardMimeGraphics mac_pasteboard_mime_;
 983 #endif
 984
 985 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
 986 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
 987         /// WMF Mime handler for Windows clipboard.
 988         QWindowsMimeMetafile * wmf_mime_;
 989 #endif
 990 #endif
 991
 992         /// Allows to check whether ESC was pressed during a long operation
 993         KeyChecker key_checker_;
 994 };
 995
 996
 997 GuiApplication * guiApp;
 998
 999 GuiApplication::~GuiApplication()
1000 {
1001 #ifdef Q_OS_MAC
1002         closeAllLinkBackLinks();
1003 #endif
1004         delete d;
1005 }
1006
1007
1008 GuiApplication::GuiApplication(int & argc, char ** argv)
1009         : QApplication(argc, argv), current_view_(0),
1010           d(new GuiApplication::Private)
1011 {
1012         QString app_name = "LyX";
1013         QCoreApplication::setOrganizationName(app_name);
1014         QCoreApplication::setOrganizationDomain("lyx.org");
1015         QCoreApplication::setApplicationName(lyx_package);
1016
1017         qsrand(QDateTime::currentDateTime().toTime_t());
1018
1019         // Install translator for GUI elements.
1020         installTranslator(&d->qt_trans_);
1021
1022 #ifdef QPA_XCB
1023         // Enable reception of XCB events.
1024         installNativeEventFilter(this);
1025 #endif
1026
1027         // FIXME: quitOnLastWindowClosed is true by default. We should have a
1028         // lyxrc setting for this in order to let the application stay resident.
1029         // But then we need some kind of dock icon, at least on Windows.
1030         /*
1031         if (lyxrc.quit_on_last_window_closed)
1032                 setQuitOnLastWindowClosed(false);
1033         */
1034 #ifdef Q_OS_MAC
1035         // FIXME: Do we need a lyxrc setting for this on Mac? This behaviour
1036         // seems to be the default case for applications like LyX.
1037         setQuitOnLastWindowClosed(false);
1038         // This allows to translate the strings that appear in the LyX menu.
1039         /// A translator suitable for the entries in the LyX menu.
1040         /// Only needed with Qt/Mac.
1041         installTranslator(new MenuTranslator(this));
1042         ///
1043         setupApplescript();
1044 #endif
1045
1046 #if defined(Q_WS_X11) || defined(QPA_XCB)
1047         // doubleClickInterval() is 400 ms on X11 which is just too long.
1048         // On Windows and Mac OS X, the operating system's value is used.
1049         // On Microsoft Windows, calling this function sets the double
1050         // click interval for all applications. So we don't!
1051         QApplication::setDoubleClickInterval(300);
1052 #endif
1053
1054         connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
1055
1056         // needs to be done before reading lyxrc
1057         QWidget w;
1058         lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
1059
1060         guiApp = this;
1061
1062         // Set the cache to 5120 kilobytes which corresponds to screen size of
1063         // 1280 by 1024 pixels with a color depth of 32 bits.
1064         QPixmapCache::setCacheLimit(5120);
1065
1066         // Initialize RC Fonts
1067         if (lyxrc.roman_font_name.empty())
1068                 lyxrc.roman_font_name = fromqstr(romanFontName());
1069
1070         if (lyxrc.sans_font_name.empty())
1071                 lyxrc.sans_font_name = fromqstr(sansFontName());
1072
1073         if (lyxrc.typewriter_font_name.empty())
1074                 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
1075
1076         d->general_timer_.setInterval(500);
1077         connect(&d->general_timer_, SIGNAL(timeout()),
1078                 this, SLOT(handleRegularEvents()));
1079         d->general_timer_.start();
1080
1081         // maxThreadCount() defaults in general to 2 on single or dual-processor.
1082         // This is clearly not enough in a time where we use threads for
1083         // document preview and/or export. 20 should be OK.
1084         QThreadPool::globalInstance()->setMaxThreadCount(20);
1085 }
1086
1087
1088 GuiApplication * theGuiApp()
1089 {
1090         return dynamic_cast<GuiApplication *>(theApp());
1091 }
1092
1093
1094 double GuiApplication::pixelRatio() const
1095 {
1096 #if QT_VERSION >= 0x050000
1097         return devicePixelRatio();
1098 #else
1099         return 1.0;
1100 #endif
1101 }
1102
1103
1104 void GuiApplication::clearSession()
1105 {
1106         QSettings settings;
1107         settings.clear();
1108 }
1109
1110
1111 docstring Application::iconName(FuncRequest const & f, bool unknown)
1112 {
1113         return qstring_to_ucs4(lyx::frontend::iconName(f, unknown));
1114 }
1115
1116
1117 docstring Application::mathIcon(docstring const & c)
1118 {
1119         return qstring_to_ucs4(findImg(toqstr(c)));
1120 }
1121
1122
1123 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd) const
1124 {
1125         FuncStatus status;
1126
1127         BufferView * bv = 0;
1128         BufferView * doc_bv = 0;
1129
1130         if (cmd.action() == LFUN_NOACTION) {
1131                 status.message(from_utf8(N_("Nothing to do")));
1132                 status.setEnabled(false);
1133         }
1134
1135         else if (cmd.action() == LFUN_UNKNOWN_ACTION) {
1136                 status.setUnknown(true);
1137                 status.message(from_utf8(N_("Unknown action")));
1138                 status.setEnabled(false);
1139         }
1140
1141         // Does the GuiApplication know something?
1142         else if (getStatus(cmd, status)) { }
1143
1144         // If we do not have a GuiView, then other functions are disabled
1145         else if (!current_view_)
1146                 status.setEnabled(false);
1147
1148         // Does the GuiView know something?
1149         else if (current_view_->getStatus(cmd, status)) { }
1150
1151         // In LyX/Mac, when a dialog is open, the menus of the
1152         // application can still be accessed without giving focus to
1153         // the main window. In this case, we want to disable the menu
1154         // entries that are buffer or view-related.
1155         //FIXME: Abdel (09/02/10) This has very bad effect on Linux, don't know why...
1156         /*
1157         else if (cmd.origin() == FuncRequest::MENU && !current_view_->hasFocus())
1158                 status.setEnabled(false);
1159         */
1160
1161         // If we do not have a BufferView, then other functions are disabled
1162         else if (!(bv = current_view_->currentBufferView()))
1163                 status.setEnabled(false);
1164
1165         // Does the current BufferView know something?
1166         else if (bv->getStatus(cmd, status)) { }
1167
1168         // Does the current Buffer know something?
1169         else if (bv->buffer().getStatus(cmd, status)) { }
1170
1171         // If we do not have a document BufferView, different from the
1172         // current BufferView, then other functions are disabled
1173         else if (!(doc_bv = current_view_->documentBufferView()) || doc_bv == bv)
1174                 status.setEnabled(false);
1175
1176         // Does the document Buffer know something?
1177         else if (doc_bv->buffer().getStatus(cmd, status)) { }
1178
1179         else {
1180                 LYXERR(Debug::ACTION, "LFUN not handled in getStatus(): " << cmd);
1181                 status.message(from_utf8(N_("Command not handled")));
1182                 status.setEnabled(false);
1183         }
1184
1185         // the default error message if we disable the command
1186         if (!status.enabled() && status.message().empty())
1187                 status.message(from_utf8(N_("Command disabled")));
1188
1189         return status;
1190 }
1191
1192
1193 bool GuiApplication::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
1194 {
1195         // I would really like to avoid having this switch and rather try to
1196         // encode this in the function itself.
1197         // -- And I'd rather let an inset decide which LFUNs it is willing
1198         // to handle (Andre')
1199         bool enable = true;
1200         switch (cmd.action()) {
1201
1202         // This could be used for the no-GUI version. The GUI version is handled in
1203         // GuiView::getStatus(). See above.
1204         /*
1205         case LFUN_BUFFER_WRITE:
1206         case LFUN_BUFFER_WRITE_AS: {
1207                 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
1208                 enable = b && (b->isUnnamed() || !b->isClean());
1209                 break;
1210         }
1211         */
1212
1213         case LFUN_BOOKMARK_GOTO: {
1214                 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
1215                 enable = theSession().bookmarks().isValid(num);
1216                 break;
1217         }
1218
1219         case LFUN_BOOKMARK_CLEAR:
1220                 enable = theSession().bookmarks().hasValid();
1221                 break;
1222
1223         // this one is difficult to get right. As a half-baked
1224         // solution, we consider only the first action of the sequence
1225         case LFUN_COMMAND_SEQUENCE: {
1226                 // argument contains ';'-terminated commands
1227                 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
1228                 FuncRequest func(lyxaction.lookupFunc(firstcmd));
1229                 func.setOrigin(cmd.origin());
1230                 flag = getStatus(func);
1231                 break;
1232         }
1233
1234         // we want to check if at least one of these is enabled
1235         case LFUN_COMMAND_ALTERNATIVES: {
1236                 // argument contains ';'-terminated commands
1237                 string arg = to_utf8(cmd.argument());
1238                 while (!arg.empty()) {
1239                         string first;
1240                         arg = split(arg, first, ';');
1241                         FuncRequest func(lyxaction.lookupFunc(first));
1242                         func.setOrigin(cmd.origin());
1243                         flag = getStatus(func);
1244                         // if this one is enabled, the whole thing is
1245                         if (flag.enabled())
1246                                 break;
1247                 }
1248                 break;
1249         }
1250
1251         case LFUN_CALL: {
1252                 FuncRequest func;
1253                 string name = to_utf8(cmd.argument());
1254                 if (theTopLevelCmdDef().lock(name, func)) {
1255                         func.setOrigin(cmd.origin());
1256                         flag = getStatus(func);
1257                         theTopLevelCmdDef().release(name);
1258                 } else {
1259                         // catch recursion or unknown command
1260                         // definition. all operations until the
1261                         // recursion or unknown command definition
1262                         // occurs are performed, so set the state to
1263                         // enabled
1264                         enable = true;
1265                 }
1266                 break;
1267         }
1268
1269         case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1270         case LFUN_REPEAT:
1271         case LFUN_PREFERENCES_SAVE:
1272         case LFUN_BUFFER_SAVE_AS_DEFAULT:
1273         case LFUN_DEBUG_LEVEL_SET:
1274                 // these are handled in our dispatch()
1275                 break;
1276
1277         case LFUN_WINDOW_CLOSE:
1278                 enable = d->views_.size() > 0;
1279                 break;
1280
1281         case LFUN_BUFFER_NEW:
1282         case LFUN_BUFFER_NEW_TEMPLATE:
1283         case LFUN_FILE_OPEN:
1284         case LFUN_HELP_OPEN:
1285         case LFUN_SCREEN_FONT_UPDATE:
1286         case LFUN_SET_COLOR:
1287         case LFUN_WINDOW_NEW:
1288         case LFUN_LYX_QUIT:
1289         case LFUN_LYXRC_APPLY:
1290         case LFUN_COMMAND_PREFIX:
1291         case LFUN_CANCEL:
1292         case LFUN_META_PREFIX:
1293         case LFUN_RECONFIGURE:
1294         case LFUN_SERVER_GET_FILENAME:
1295         case LFUN_SERVER_NOTIFY:
1296                 enable = true;
1297                 break;
1298
1299         case LFUN_BUFFER_FORALL: {
1300                 if (theBufferList().empty()) {
1301                         flag.message(from_utf8(N_("Command not allowed without a buffer open")));
1302                         flag.setEnabled(false);
1303                         break;
1304                 }
1305
1306                 FuncRequest const cmdToPass = lyxaction.lookupFunc(cmd.getLongArg(0));
1307                 if (cmdToPass.action() == LFUN_UNKNOWN_ACTION) {
1308                         flag.message(from_utf8(N_("the <LFUN-COMMAND> argument of buffer-forall is not valid")));
1309                         flag.setEnabled(false);
1310                 }
1311                 break;
1312         }
1313
1314         case LFUN_DIALOG_SHOW: {
1315                 string const name = cmd.getArg(0);
1316                 return name == "aboutlyx"
1317                         || name == "prefs"
1318                         || name == "texinfo"
1319                         || name == "progress"
1320                         || name == "compare";
1321         }
1322
1323         default:
1324                 return false;
1325         }
1326
1327         if (!enable)
1328                 flag.setEnabled(false);
1329         return true;
1330 }
1331
1332 /// make a post-dispatch status message
1333 static docstring makeDispatchMessage(docstring const & msg,
1334                                      FuncRequest const & cmd)
1335 {
1336         const bool verbose = (cmd.origin() == FuncRequest::MENU
1337                               || cmd.origin() == FuncRequest::TOOLBAR
1338                               || cmd.origin() == FuncRequest::COMMANDBUFFER);
1339
1340         if (cmd.action() == LFUN_SELF_INSERT || !verbose) {
1341                 LYXERR(Debug::ACTION, "dispatch msg is " << msg);
1342                 return msg;
1343         }
1344
1345         docstring dispatch_msg = msg;
1346         if (!dispatch_msg.empty())
1347                 dispatch_msg += ' ';
1348
1349         docstring comname = from_utf8(lyxaction.getActionName(cmd.action()));
1350
1351         bool argsadded = false;
1352
1353         if (!cmd.argument().empty()) {
1354                 if (cmd.action() != LFUN_UNKNOWN_ACTION) {
1355                         comname += ' ' + cmd.argument();
1356                         argsadded = true;
1357                 }
1358         }
1359         docstring const shortcuts = theTopLevelKeymap().
1360                 printBindings(cmd, KeySequence::ForGui);
1361
1362         if (!shortcuts.empty())
1363                 comname += ": " + shortcuts;
1364         else if (!argsadded && !cmd.argument().empty())
1365                 comname += ' ' + cmd.argument();
1366
1367         if (!comname.empty()) {
1368                 comname = rtrim(comname);
1369                 dispatch_msg += '(' + rtrim(comname) + ')';
1370         }
1371         LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1372         return dispatch_msg;
1373 }
1374
1375
1376 DispatchResult const & GuiApplication::dispatch(FuncRequest const & cmd)
1377 {
1378         Buffer * buffer = 0;
1379         if (current_view_ && current_view_->currentBufferView()) {
1380                 current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1381                 buffer = &current_view_->currentBufferView()->buffer();
1382                 if (buffer)
1383                         buffer->undo().beginUndoGroup();
1384         }
1385
1386         DispatchResult dr;
1387         // redraw the screen at the end (first of the two drawing steps).
1388         // This is done unless explicitly requested otherwise
1389         dr.screenUpdate(Update::FitCursor);
1390         dispatch(cmd, dr);
1391         updateCurrentView(cmd, dr);
1392
1393         // the buffer may have been closed by one action
1394         if (theBufferList().isLoaded(buffer))
1395                 buffer->undo().endUndoGroup();
1396
1397         d->dispatch_result_ = dr;
1398         return d->dispatch_result_;
1399 }
1400
1401
1402 void GuiApplication::updateCurrentView(FuncRequest const & cmd, DispatchResult & dr)
1403 {
1404         if (!current_view_)
1405                 return;
1406
1407         BufferView * bv = current_view_->currentBufferView();
1408         if (bv) {
1409                 if (dr.needBufferUpdate()) {
1410                         bv->cursor().clearBufferUpdate();
1411                         bv->buffer().updateBuffer();
1412                 } else if (dr.needChangesUpdate()) {
1413                         // updateBuffer() already updates the change-tracking presence flag
1414                         bv->buffer().updateChangesPresent();
1415                 }
1416                 // BufferView::update() updates the ViewMetricsInfo and
1417                 // also initializes the position cache for all insets in
1418                 // (at least partially) visible top-level paragraphs.
1419                 // We will redraw the screen only if needed.
1420                 bv->processUpdateFlags(dr.screenUpdate());
1421
1422                 // Do we have a selection?
1423                 theSelection().haveSelection(bv->cursor().selection());
1424
1425                 // update gui
1426                 current_view_->restartCursor();
1427         }
1428         if (dr.needMessageUpdate()) {
1429                 // Some messages may already be translated, so we cannot use _()
1430                 current_view_->message(makeDispatchMessage(
1431                                 translateIfPossible(dr.message()), cmd));
1432         }
1433 }
1434
1435
1436 void GuiApplication::gotoBookmark(unsigned int idx, bool openFile,
1437         bool switchToBuffer)
1438 {
1439         if (!theSession().bookmarks().isValid(idx))
1440                 return;
1441         BookmarksSection::Bookmark const & bm =
1442                 theSession().bookmarks().bookmark(idx);
1443         LASSERT(!bm.filename.empty(), return);
1444         string const file = bm.filename.absFileName();
1445         // if the file is not opened, open it.
1446         if (!theBufferList().exists(bm.filename)) {
1447                 if (openFile)
1448                         dispatch(FuncRequest(LFUN_FILE_OPEN, file));
1449                 else
1450                         return;
1451         }
1452         // open may fail, so we need to test it again
1453         if (!theBufferList().exists(bm.filename))
1454                 return;
1455
1456         // bm can be changed when saving
1457         BookmarksSection::Bookmark tmp = bm;
1458
1459         // Special case idx == 0 used for back-from-back jump navigation
1460         if (idx == 0)
1461                 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
1462
1463         // if the current buffer is not that one, switch to it.
1464         BufferView * doc_bv = current_view_ ?
1465                 current_view_->documentBufferView() : 0;
1466         // FIXME It's possible that doc_bv is null!!
1467         // See coverity #102061
1468         Cursor const old = doc_bv->cursor();
1469         if (!doc_bv || doc_bv->buffer().fileName() != tmp.filename) {
1470                 if (switchToBuffer) {
1471                         dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
1472                         if (!current_view_)
1473                                 return;
1474                         doc_bv = current_view_->documentBufferView();
1475                 } else
1476                         return;
1477         }
1478
1479         // moveToPosition try paragraph id first and then paragraph (pit, pos).
1480         if (!doc_bv->moveToPosition(
1481                         tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
1482                 return;
1483
1484         Cursor & cur = doc_bv->cursor();
1485         if (cur != old)
1486                 notifyCursorLeavesOrEnters(old, cur);
1487
1488         // bm changed
1489         if (idx == 0)
1490                 return;
1491
1492         // Cursor jump succeeded!
1493         pit_type new_pit = cur.pit();
1494         pos_type new_pos = cur.pos();
1495         int new_id = cur.paragraph().id();
1496
1497         // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
1498         // see http://www.lyx.org/trac/ticket/3092
1499         if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
1500                 || bm.top_id != new_id) {
1501                 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
1502                         new_pit, new_pos, new_id);
1503         }
1504 }
1505
1506 // This function runs "configure" and then rereads lyx.defaults to
1507 // reconfigure the automatic settings.
1508 void GuiApplication::reconfigure(string const & option)
1509 {
1510         // emit message signal.
1511         if (current_view_)
1512                 current_view_->message(_("Running configure..."));
1513
1514         // Run configure in user lyx directory
1515         string const lock_file = package().getConfigureLockName();
1516         int fd = fileLock(lock_file.c_str());
1517         int const ret = package().reconfigureUserLyXDir(option);
1518         // emit message signal.
1519         if (current_view_)
1520                 current_view_->message(_("Reloading configuration..."));
1521         lyxrc.read(libFileSearch(QString(), "lyxrc.defaults"), false);
1522         // Re-read packages.lst
1523         LaTeXPackages::getAvailable();
1524         fileUnlock(fd, lock_file.c_str());
1525
1526         if (ret)
1527                 Alert::information(_("System reconfiguration failed"),
1528                            _("The system reconfiguration has failed.\n"
1529                                   "Default textclass is used but LyX may\n"
1530                                   "not be able to work properly.\n"
1531                                   "Please reconfigure again if needed."));
1532         else
1533                 Alert::information(_("System reconfigured"),
1534                            _("The system has been reconfigured.\n"
1535                              "You need to restart LyX to make use of any\n"
1536                              "updated document class specifications."));
1537 }
1538
1539 void GuiApplication::validateCurrentView()
1540 {
1541         if (!d->views_.empty() && !current_view_) {
1542                 // currently at least one view exists but no view has the focus.
1543                 // choose the last view to make it current.
1544                 // a view without any open document is preferred.
1545                 GuiView * candidate = 0;
1546                 QHash<int, GuiView *>::const_iterator it = d->views_.begin();
1547                 QHash<int, GuiView *>::const_iterator end = d->views_.end();
1548                 for (; it != end; ++it) {
1549                         candidate = *it;
1550                         if (!candidate->documentBufferView())
1551                                 break;
1552                 }
1553                 setCurrentView(candidate);
1554         }
1555 }
1556
1557 void GuiApplication::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1558 {
1559         string const argument = to_utf8(cmd.argument());
1560         FuncCode const action = cmd.action();
1561
1562         LYXERR(Debug::ACTION, "cmd: " << cmd);
1563
1564         // we have not done anything wrong yet.
1565         dr.setError(false);
1566
1567         FuncStatus const flag = getStatus(cmd);
1568         if (!flag.enabled()) {
1569                 // We cannot use this function here
1570                 LYXERR(Debug::ACTION, "action "
1571                        << lyxaction.getActionName(action)
1572                        << " [" << action << "] is disabled at this location");
1573                 dr.setMessage(flag.message());
1574                 dr.setError(true);
1575                 dr.dispatched(false);
1576                 dr.screenUpdate(Update::None);
1577                 dr.clearBufferUpdate();
1578                 return;
1579         };
1580
1581         if (cmd.origin() == FuncRequest::LYXSERVER) {
1582                 if (current_view_ && current_view_->currentBufferView())
1583                         current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1584                 // we will also need to redraw the screen at the end
1585                 dr.screenUpdate(Update::FitCursor);
1586         }
1587
1588         // Assumes that the action will be dispatched.
1589         dr.dispatched(true);
1590
1591         switch (cmd.action()) {
1592
1593         case LFUN_WINDOW_NEW:
1594                 createView(toqstr(cmd.argument()));
1595                 break;
1596
1597         case LFUN_WINDOW_CLOSE:
1598                 // update bookmark pit of the current buffer before window close
1599                 for (size_t i = 0; i < theSession().bookmarks().size(); ++i)
1600                         gotoBookmark(i+1, false, false);
1601                 // clear the last opened list, because
1602                 // maybe this will end the session
1603                 theSession().lastOpened().clear();
1604                 // check for valid current_view_
1605                 validateCurrentView();
1606                 if (current_view_)
1607                         current_view_->closeScheduled();
1608                 break;
1609
1610         case LFUN_LYX_QUIT:
1611                 // quitting is triggered by the gui code
1612                 // (leaving the event loop).
1613                 if (current_view_)
1614                         current_view_->message(from_utf8(N_("Exiting.")));
1615                 if (closeAllViews())
1616                         quit();
1617                 break;
1618
1619         case LFUN_SCREEN_FONT_UPDATE: {
1620                 // handle the screen font changes.
1621                 d->font_loader_.update();
1622                 // Backup current_view_
1623                 GuiView * view = current_view_;
1624                 // Set current_view_ to zero to forbid GuiWorkArea::redraw()
1625                 // to skip the refresh.
1626                 current_view_ = 0;
1627                 theBufferList().changed(false);
1628                 // Restore current_view_
1629                 current_view_ = view;
1630                 break;
1631         }
1632
1633         case LFUN_BUFFER_NEW:
1634                 validateCurrentView();
1635                 if (d->views_.empty()
1636                    || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1637                         createView(QString(), false); // keep hidden
1638                         current_view_->newDocument(to_utf8(cmd.argument()), false);
1639                         current_view_->show();
1640                         setActiveWindow(current_view_);
1641                 } else {
1642                         current_view_->newDocument(to_utf8(cmd.argument()), false);
1643                 }
1644                 break;
1645
1646         case LFUN_BUFFER_NEW_TEMPLATE:
1647                 validateCurrentView();
1648                 if (d->views_.empty()
1649                    || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1650                         createView();
1651                         current_view_->newDocument(to_utf8(cmd.argument()), true);
1652                         if (!current_view_->documentBufferView())
1653                                 current_view_->close();
1654                 } else {
1655                         current_view_->newDocument(to_utf8(cmd.argument()), true);
1656                 }
1657                 break;
1658
1659         case LFUN_FILE_OPEN: {
1660                 validateCurrentView();
1661                 // FIXME: create a new method shared with LFUN_HELP_OPEN.
1662                 string const fname = to_utf8(cmd.argument());
1663                 bool const is_open = FileName::isAbsolute(fname)
1664                         && theBufferList().getBuffer(FileName(fname));
1665                 if (d->views_.empty()
1666                     || (!lyxrc.open_buffers_in_tabs
1667                         && current_view_->documentBufferView() != 0
1668                         && !is_open)) {
1669                         // We want the ui session to be saved per document and not per
1670                         // window number. The filename crc is a good enough identifier.
1671                         boost::crc_32_type crc;
1672                         crc = for_each(fname.begin(), fname.end(), crc);
1673                         createView(crc.checksum());
1674                         // we know current_view_ is non-null, because createView sets it.
1675                         // coverity[FORWARD_NULL]
1676                         current_view_->openDocument(fname);
1677                         // FIXME but then why check current_view_ here?
1678                         if (current_view_ && !current_view_->documentBufferView())
1679                                 current_view_->close();
1680                 } else {
1681                         // we know !d->views.empty(), so this should be ok
1682                         // coverity[FORWARD_NULL]
1683                         current_view_->openDocument(fname);
1684                 }
1685                 break;
1686         }
1687
1688         case LFUN_HELP_OPEN: {
1689                 // FIXME: create a new method shared with LFUN_FILE_OPEN.
1690                 if (current_view_ == 0)
1691                         createView();
1692                 string const arg = to_utf8(cmd.argument());
1693                 if (arg.empty()) {
1694                         current_view_->message(_("Missing argument"));
1695                         break;
1696                 }
1697                 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
1698                 if (fname.empty())
1699                         fname = i18nLibFileSearch("examples", arg, "lyx");
1700
1701                 if (fname.empty()) {
1702                         lyxerr << "LyX: unable to find documentation file `"
1703                                << arg << "'. Bad installation?" << endl;
1704                         break;
1705                 }
1706                 current_view_->message(bformat(_("Opening help file %1$s..."),
1707                                                makeDisplayPath(fname.absFileName())));
1708                 Buffer * buf = current_view_->loadDocument(fname, false);
1709
1710 #ifndef DEVEL_VERSION
1711                 if (buf)
1712                         buf->setReadonly(true);
1713 #else
1714                 (void) buf;
1715 #endif
1716                 break;
1717         }
1718
1719         case LFUN_SET_COLOR: {
1720                 string lyx_name;
1721                 string const x11_name = split(to_utf8(cmd.argument()), lyx_name, ' ');
1722                 if (lyx_name.empty() || x11_name.empty()) {
1723                         if (current_view_)
1724                                 current_view_->message(
1725                                         _("Syntax: set-color <lyx_name> <x11_name>"));
1726                         break;
1727                 }
1728
1729 #if 0
1730                 // FIXME: The graphics cache no longer has a changeDisplay method.
1731                 string const graphicsbg = lcolor.getLyXName(Color_graphicsbg);
1732                 bool const graphicsbg_changed =
1733                                 lyx_name == graphicsbg && x11_name != graphicsbg;
1734                 if (graphicsbg_changed)
1735                         graphics::GCache::get().changeDisplay(true);
1736 #endif
1737
1738                 if (!lcolor.setColor(lyx_name, x11_name)) {
1739                         if (current_view_)
1740                                 current_view_->message(
1741                                         bformat(_("Set-color \"%1$s\" failed "
1742                                         "- color is undefined or "
1743                                         "may not be redefined"),
1744                                         from_utf8(lyx_name)));
1745                         break;
1746                 }
1747                 // Make sure we don't keep old colors in cache.
1748                 d->color_cache_.clear();
1749                 // Update the current view
1750                 lyx::dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
1751                 break;
1752         }
1753
1754         case LFUN_LYXRC_APPLY: {
1755                 // reset active key sequences, since the bindings
1756                 // are updated (bug 6064)
1757                 d->keyseq.reset();
1758                 LyXRC const lyxrc_orig = lyxrc;
1759
1760                 istringstream ss(to_utf8(cmd.argument()));
1761                 bool const success = lyxrc.read(ss);
1762
1763                 if (!success) {
1764                         lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1765                                         << "Unable to read lyxrc data"
1766                                         << endl;
1767                         break;
1768                 }
1769
1770                 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1771
1772                 // If the request comes from the minibuffer, then we can't reset
1773                 // the GUI, since that would destory the minibuffer itself and
1774                 // cause a crash, since we are currently in one of the methods of
1775                 // GuiCommandBuffer. See bug #8540.
1776                 if (cmd.origin() != FuncRequest::COMMANDBUFFER)
1777                         resetGui();
1778                 // else
1779                 //   FIXME Unfortunately, that leaves a bug here, since we cannot
1780                 //   reset the GUI in this case. If the changes to lyxrc affected the
1781                 //   UI, then, nothing would happen. This seems fairly unlikely, but
1782                 //   it definitely is a bug.
1783
1784                 break;
1785         }
1786
1787         case LFUN_COMMAND_PREFIX:
1788                 dispatch(FuncRequest(LFUN_MESSAGE, d->keyseq.printOptions(true)));
1789                 break;
1790
1791         case LFUN_CANCEL: {
1792                 d->keyseq.reset();
1793                 d->meta_fake_bit = NoModifier;
1794                 GuiView * gv = currentView();
1795                 if (gv && gv->currentBufferView())
1796                         // cancel any selection
1797                         processFuncRequest(FuncRequest(LFUN_MARK_OFF));
1798                 dr.setMessage(from_ascii(N_("Cancel")));
1799                 break;
1800         }
1801         case LFUN_META_PREFIX:
1802                 d->meta_fake_bit = AltModifier;
1803                 dr.setMessage(d->keyseq.print(KeySequence::ForGui));
1804                 break;
1805
1806         // --- Menus -----------------------------------------------
1807         case LFUN_RECONFIGURE:
1808                 // argument is any additional parameter to the configure.py command
1809                 reconfigure(to_utf8(cmd.argument()));
1810                 break;
1811
1812         // --- lyxserver commands ----------------------------
1813         case LFUN_SERVER_GET_FILENAME: {
1814                 if (current_view_ && current_view_->documentBufferView()) {
1815                         docstring const fname = from_utf8(
1816                                 current_view_->documentBufferView()->buffer().absFileName());
1817                         dr.setMessage(fname);
1818                         LYXERR(Debug::INFO, "FNAME[" << fname << ']');
1819                 } else {
1820                         dr.setMessage(docstring());
1821                         LYXERR(Debug::INFO, "No current file for LFUN_SERVER_GET_FILENAME");
1822                 }
1823                 break;
1824         }
1825
1826         case LFUN_SERVER_NOTIFY: {
1827                 docstring const dispatch_buffer = d->keyseq.print(KeySequence::Portable);
1828                 dr.setMessage(dispatch_buffer);
1829                 theServer().notifyClient(to_utf8(dispatch_buffer));
1830                 break;
1831         }
1832
1833         case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1834                 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1835                 break;
1836
1837         case LFUN_REPEAT: {
1838                 // repeat command
1839                 string countstr;
1840                 string rest = split(argument, countstr, ' ');
1841                 istringstream is(countstr);
1842                 int count = 0;
1843                 is >> count;
1844                 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1845                 for (int i = 0; i < count; ++i)
1846                         dispatch(lyxaction.lookupFunc(rest));
1847                 break;
1848         }
1849
1850         case LFUN_COMMAND_SEQUENCE: {
1851                 // argument contains ';'-terminated commands
1852                 string arg = argument;
1853                 // FIXME: this LFUN should also work without any view.
1854                 Buffer * buffer = (current_view_ && current_view_->documentBufferView())
1855                                   ? &(current_view_->documentBufferView()->buffer()) : 0;
1856                 if (buffer)
1857                         buffer->undo().beginUndoGroup();
1858                 while (!arg.empty()) {
1859                         string first;
1860                         arg = split(arg, first, ';');
1861                         FuncRequest func(lyxaction.lookupFunc(first));
1862                         func.setOrigin(cmd.origin());
1863                         dispatch(func);
1864                 }
1865                 // the buffer may have been closed by one action
1866                 if (theBufferList().isLoaded(buffer))
1867                         buffer->undo().endUndoGroup();
1868                 break;
1869         }
1870
1871         case LFUN_BUFFER_FORALL: {
1872                 FuncRequest const funcToRun = lyxaction.lookupFunc(cmd.getLongArg(0));
1873
1874                 map<Buffer *, GuiView *> views_lVisible;
1875                 map<GuiView *, Buffer *> activeBuffers;
1876
1877                 QList<GuiView *> allViews = d->views_.values();
1878
1879                 // this for does not modify any buffer. It just collects info on local
1880                 // visibility of buffers and on which buffer is active in each view.
1881                 Buffer * const last = theBufferList().last();
1882                 for(GuiView * view : allViews) {
1883                         // all of the buffers might be locally hidden. That is, there is no
1884                         // active buffer.
1885                         if (!view || !view->currentBufferView())
1886                                 activeBuffers[view] = 0;
1887                         else
1888                                 activeBuffers[view] = &view->currentBufferView()->buffer();
1889
1890                         // find out if each is locally visible or locally hidden.
1891                         // we don't use a for loop as the buffer list cycles.
1892                         Buffer * b = theBufferList().first();
1893                         while (true) {
1894                                 bool const locallyVisible = view && view->workArea(*b);
1895                                 if (locallyVisible) {
1896                                         bool const exists_ = (views_lVisible.find(b) != views_lVisible.end());
1897                                         // only need to overwrite/add if we don't already know a buffer is globally
1898                                         // visible or we do know but we would prefer to dispatch LFUN from the
1899                                         // current view because of cursor position issues.
1900                                         if (!exists_ || (exists_ && views_lVisible[b] != current_view_))
1901                                                 views_lVisible[b] = view;
1902                                 }
1903                                 if (b == last)
1904                                         break;
1905                                 b = theBufferList().next(b);
1906                         }
1907                 }
1908
1909                 GuiView * const homeView = currentView();
1910                 Buffer * b = theBufferList().first();
1911                 Buffer * nextBuf = 0;
1912                 int numProcessed = 0;
1913                 while (true) {
1914                         if (b != last)
1915                                 nextBuf = theBufferList().next(b); // get next now bc LFUN might close current.
1916
1917                         bool const visible = (views_lVisible.find(b) != views_lVisible.end());
1918                         if (visible) {
1919                                 // first change to a view where b is locally visible, preferably current_view_.
1920                                 GuiView * const vLv = views_lVisible[b];
1921                                 vLv->setBuffer(b);
1922                                 lyx::dispatch(funcToRun);
1923                                 numProcessed++;
1924                         }
1925                         if (b == last)
1926                                 break;
1927                         b = nextBuf;
1928                 }
1929
1930                 // put things back to how they were (if possible).
1931                 for (GuiView * view : allViews) {
1932                         Buffer * originalBuf = activeBuffers[view];
1933                         // there might not have been an active buffer in this view or it might have been closed by the LFUN.
1934                         if (theBufferList().isLoaded(originalBuf))
1935                                 view->setBuffer(originalBuf);
1936                 }
1937                 homeView->setFocus();
1938
1939                 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d buffer(s)"), from_utf8(cmd.getLongArg(0)), numProcessed));
1940                 break;
1941         }
1942
1943         case LFUN_COMMAND_ALTERNATIVES: {
1944                 // argument contains ';'-terminated commands
1945                 string arg = argument;
1946                 while (!arg.empty()) {
1947                         string first;
1948                         arg = split(arg, first, ';');
1949                         FuncRequest func(lyxaction.lookupFunc(first));
1950                         func.setOrigin(cmd.origin());
1951                         FuncStatus const stat = getStatus(func);
1952                         if (stat.enabled()) {
1953                                 dispatch(func);
1954                                 break;
1955                         }
1956                 }
1957                 break;
1958         }
1959
1960         case LFUN_CALL: {
1961                 FuncRequest func;
1962                 if (theTopLevelCmdDef().lock(argument, func)) {
1963                         func.setOrigin(cmd.origin());
1964                         dispatch(func);
1965                         theTopLevelCmdDef().release(argument);
1966                 } else {
1967                         if (func.action() == LFUN_UNKNOWN_ACTION) {
1968                                 // unknown command definition
1969                                 lyxerr << "Warning: unknown command definition `"
1970                                                 << argument << "'"
1971                                                 << endl;
1972                         } else {
1973                                 // recursion detected
1974                                 lyxerr << "Warning: Recursion in the command definition `"
1975                                                 << argument << "' detected"
1976                                                 << endl;
1977                         }
1978                 }
1979                 break;
1980         }
1981
1982         case LFUN_PREFERENCES_SAVE:
1983                 lyxrc.write(support::makeAbsPath("preferences",
1984                         package().user_support().absFileName()), false);
1985                 break;
1986
1987         case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1988                 string const fname = addName(addPath(package().user_support().absFileName(),
1989                         "templates/"), "defaults.lyx");
1990                 Buffer defaults(fname);
1991
1992                 istringstream ss(argument);
1993                 Lexer lex;
1994                 lex.setStream(ss);
1995
1996                 // See #9236
1997                 // We need to make sure that, after we recreat the DocumentClass,
1998                 // which we do in readHeader, we apply it to the document itself.
1999                 DocumentClassConstPtr olddc = defaults.params().documentClassPtr();
2000                 int const unknown_tokens = defaults.readHeader(lex);
2001                 DocumentClassConstPtr newdc = defaults.params().documentClassPtr();
2002                 ErrorList el;
2003                 InsetText & theinset = static_cast<InsetText &>(defaults.inset());
2004                 cap::switchBetweenClasses(olddc, newdc, theinset, el);
2005
2006                 if (unknown_tokens != 0) {
2007                         lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
2008                                << unknown_tokens << " unknown token"
2009                                << (unknown_tokens == 1 ? "" : "s")
2010                                << endl;
2011                 }
2012
2013                 if (defaults.writeFile(FileName(defaults.absFileName())))
2014                         dr.setMessage(bformat(_("Document defaults saved in %1$s"),
2015                                               makeDisplayPath(fname)));
2016                 else {
2017                         dr.setError(true);
2018                         dr.setMessage(from_ascii(N_("Unable to save document defaults")));
2019                 }
2020                 break;
2021         }
2022
2023         case LFUN_BOOKMARK_GOTO:
2024                 // go to bookmark, open unopened file and switch to buffer if necessary
2025                 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
2026                 dr.screenUpdate(Update::Force | Update::FitCursor);
2027                 break;
2028
2029         case LFUN_BOOKMARK_CLEAR:
2030                 theSession().bookmarks().clear();
2031                 break;
2032
2033         case LFUN_DEBUG_LEVEL_SET:
2034                 lyxerr.setLevel(Debug::value(to_utf8(cmd.argument())));
2035                 break;
2036
2037         case LFUN_DIALOG_SHOW: {
2038                 string const name = cmd.getArg(0);
2039
2040                 if ( name == "aboutlyx"
2041                         || name == "prefs"
2042                         || name == "texinfo"
2043                         || name == "progress"
2044                         || name == "compare")
2045                 {
2046                         // work around: on Mac OS the application
2047                         // is not terminated when closing the last view.
2048                         // Create a new one to be able to dispatch the
2049                         // LFUN_DIALOG_SHOW to this view.
2050                         if (current_view_ == 0)
2051                                 createView();
2052                 }
2053                 // fall through
2054         }
2055
2056         default:
2057                 // The LFUN must be for one of GuiView, BufferView, Buffer or Cursor;
2058                 // let's try that:
2059                 if (current_view_)
2060                         current_view_->dispatch(cmd, dr);
2061                 break;
2062         }
2063
2064         if (cmd.origin() == FuncRequest::LYXSERVER)
2065                 updateCurrentView(cmd, dr);
2066 }
2067
2068
2069 docstring GuiApplication::viewStatusMessage()
2070 {
2071         // When meta-fake key is pressed, show the key sequence so far + "M-".
2072         if (d->meta_fake_bit != NoModifier)
2073                 return d->keyseq.print(KeySequence::ForGui) + "M-";
2074
2075         // Else, when a non-complete key sequence is pressed,
2076         // show the available options.
2077         if (d->keyseq.length() > 0 && !d->keyseq.deleted())
2078                 return d->keyseq.printOptions(true);
2079
2080         return docstring();
2081 }
2082
2083
2084 void GuiApplication::handleKeyFunc(FuncCode action)
2085 {
2086         char_type c = 0;
2087
2088         if (d->keyseq.length())
2089                 c = 0;
2090         GuiView * gv = currentView();
2091         LASSERT(gv && gv->currentBufferView(), return);
2092         BufferView * bv = gv->currentBufferView();
2093         bv->getIntl().getTransManager().deadkey(
2094                 c, get_accent(action).accent, bv->cursor().innerText(),
2095                 bv->cursor());
2096         // Need to clear, in case the minibuffer calls these
2097         // actions
2098         d->keyseq.clear();
2099         // copied verbatim from do_accent_char
2100         bv->cursor().resetAnchor();
2101 }
2102
2103
2104 void GuiApplication::processKeySym(KeySymbol const & keysym, KeyModifier state)
2105 {
2106         LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
2107
2108         // Do nothing if we have nothing (JMarc)
2109         if (!keysym.isOK()) {
2110                 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
2111                 if (current_view_)
2112                         current_view_->restartCursor();
2113                 return;
2114         }
2115
2116         if (keysym.isModifier()) {
2117                 if (current_view_)
2118                         current_view_->restartCursor();
2119                 return;
2120         }
2121
2122         char_type encoded_last_key = keysym.getUCSEncoded();
2123
2124         // Do a one-deep top-level lookup for
2125         // cancel and meta-fake keys. RVDK_PATCH_5
2126         d->cancel_meta_seq.reset();
2127
2128         FuncRequest func = d->cancel_meta_seq.addkey(keysym, state);
2129         LYXERR(Debug::KEY, "action first set to [" << func.action() << ']');
2130
2131         // When not cancel or meta-fake, do the normal lookup.
2132         // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
2133         // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
2134         if ((func.action() != LFUN_CANCEL) && (func.action() != LFUN_META_PREFIX)) {
2135                 // remove Caps Lock and Mod2 as a modifiers
2136                 func = d->keyseq.addkey(keysym, (state | d->meta_fake_bit));
2137                 LYXERR(Debug::KEY, "action now set to [" << func.action() << ']');
2138         }
2139
2140         // Dont remove this unless you know what you are doing.
2141         d->meta_fake_bit = NoModifier;
2142
2143         // Can this happen now ?
2144         if (func.action() == LFUN_NOACTION)
2145                 func = FuncRequest(LFUN_COMMAND_PREFIX);
2146
2147         LYXERR(Debug::KEY, " Key [action=" << func.action() << "]["
2148                 << d->keyseq.print(KeySequence::Portable) << ']');
2149
2150         // already here we know if it any point in going further
2151         // why not return already here if action == -1 and
2152         // num_bytes == 0? (Lgb)
2153
2154         if (d->keyseq.length() > 1 && current_view_)
2155                 current_view_->message(d->keyseq.print(KeySequence::ForGui));
2156
2157
2158         // Maybe user can only reach the key via holding down shift.
2159         // Let's see. But only if shift is the only modifier
2160         if (func.action() == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
2161                 LYXERR(Debug::KEY, "Trying without shift");
2162                 func = d->keyseq.addkey(keysym, NoModifier);
2163                 LYXERR(Debug::KEY, "Action now " << func.action());
2164         }
2165
2166         if (func.action() == LFUN_UNKNOWN_ACTION) {
2167                 // We didn't match any of the key sequences.
2168                 // See if it's normal insertable text not already
2169                 // covered by a binding
2170                 if (keysym.isText() && d->keyseq.length() == 1) {
2171                         // Non-printable characters (such as ASCII control characters)
2172                         // must not be inserted (#5704)
2173                         if (!isPrintable(encoded_last_key)) {
2174                                 LYXERR(Debug::KEY, "Non-printable character! Omitting.");
2175                                 if (current_view_)
2176                                         current_view_->restartCursor();
2177                                 return;
2178                         }
2179                         // The following modifier check is not needed on Mac.
2180                         // The keysym is either not text or it is different
2181                         // from the non-modifier keysym. See #9875 for the
2182                         // broken alt-modifier effect of having this code active.
2183 #if !defined(Q_OS_MAC)
2184                         // If a non-Shift Modifier is used we have a non-bound key sequence
2185                         // (such as Alt+j = j). This should be omitted (#5575).
2186                         // On Windows, AltModifier and ControlModifier are both
2187                         // set when AltGr is pressed. Therefore, in order to not
2188                         // break AltGr-bound symbols (see #5575 for details),
2189                         // unbound Ctrl+Alt key sequences are allowed.
2190                         if ((state & AltModifier || state & ControlModifier || state & MetaModifier)
2191 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2192                             && !(state & AltModifier && state & ControlModifier)
2193 #endif
2194                             )
2195                         {
2196                                 if (current_view_) {
2197                                         current_view_->message(_("Unknown function."));
2198                                         current_view_->restartCursor();
2199                                 }
2200                                 return;
2201                         }
2202 #endif
2203                         // Since all checks above were passed, we now really have text that
2204                         // is to be inserted (e.g., AltGr-bound symbols). Thus change the
2205                         // func to LFUN_SELF_INSERT and thus cause the text to be inserted
2206                         // below.
2207                         LYXERR(Debug::KEY, "isText() is true, inserting.");
2208                         func = FuncRequest(LFUN_SELF_INSERT, FuncRequest::KEYBOARD);
2209                 } else {
2210                         LYXERR(Debug::KEY, "Unknown Action and not isText() -- giving up");
2211                         if (current_view_) {
2212                                 current_view_->message(_("Unknown function."));
2213                                 current_view_->restartCursor();
2214                         }
2215                         return;
2216                 }
2217         }
2218
2219         if (func.action() == LFUN_SELF_INSERT) {
2220                 if (encoded_last_key != 0) {
2221                         docstring const arg(1, encoded_last_key);
2222                         processFuncRequest(FuncRequest(LFUN_SELF_INSERT, arg,
2223                                              FuncRequest::KEYBOARD));
2224                         LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
2225                 }
2226         } else
2227                 processFuncRequest(func);
2228 }
2229
2230
2231 void GuiApplication::processFuncRequest(FuncRequest const & func)
2232 {
2233         lyx::dispatch(func);
2234 }
2235
2236
2237 void GuiApplication::processFuncRequestAsync(FuncRequest const & func)
2238 {
2239         addToFuncRequestQueue(func);
2240         processFuncRequestQueueAsync();
2241 }
2242
2243
2244 void GuiApplication::processFuncRequestQueue()
2245 {
2246         while (!d->func_request_queue_.empty()) {
2247                 processFuncRequest(d->func_request_queue_.front());
2248                 d->func_request_queue_.pop();
2249         }
2250 }
2251
2252
2253 void GuiApplication::processFuncRequestQueueAsync()
2254 {
2255         QTimer::singleShot(0, this, SLOT(slotProcessFuncRequestQueue()));
2256 }
2257
2258
2259 void GuiApplication::addToFuncRequestQueue(FuncRequest const & func)
2260 {
2261         d->func_request_queue_.push(func);
2262 }
2263
2264
2265 void GuiApplication::resetGui()
2266 {
2267         // Set the language defined by the user.
2268         setGuiLanguage();
2269
2270         // Read menus
2271         if (!readUIFile(toqstr(lyxrc.ui_file)))
2272                 // Gives some error box here.
2273                 return;
2274
2275         if (d->global_menubar_)
2276                 d->menus_.fillMenuBar(d->global_menubar_, 0, false);
2277
2278         QHash<int, GuiView *>::iterator it;
2279         for (it = d->views_.begin(); it != d->views_.end(); ++it) {
2280                 GuiView * gv = *it;
2281                 setCurrentView(gv);
2282                 gv->setLayoutDirection(layoutDirection());
2283                 gv->resetDialogs();
2284         }
2285
2286         processFuncRequest(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
2287 }
2288
2289
2290 void GuiApplication::createView(int view_id)
2291 {
2292         createView(QString(), true, view_id);
2293 }
2294
2295
2296 void GuiApplication::createView(QString const & geometry_arg, bool autoShow,
2297         int view_id)
2298 {
2299         // release the keyboard which might have been grabed by the global
2300         // menubar on Mac to catch shortcuts even without any GuiView.
2301         if (d->global_menubar_)
2302                 d->global_menubar_->releaseKeyboard();
2303
2304         // create new view
2305         int id = view_id;
2306         while (d->views_.find(id) != d->views_.end())
2307                 id++;
2308
2309         LYXERR(Debug::GUI, "About to create new window with ID " << id);
2310         GuiView * view = new GuiView(id);
2311         // register view
2312         d->views_[id] = view;
2313
2314         if (autoShow) {
2315                 view->show();
2316                 setActiveWindow(view);
2317         }
2318
2319         if (!geometry_arg.isEmpty()) {
2320 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2321                 int x, y;
2322                 int w, h;
2323                 QChar sx, sy;
2324                 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)){0,1}(?:([+-][0-9]*)){0,1}" );
2325                 re.indexIn(geometry_arg);
2326                 w = re.cap(1).toInt();
2327                 h = re.cap(2).toInt();
2328                 x = re.cap(3).toInt();
2329                 y = re.cap(4).toInt();
2330                 sx = re.cap(3).isEmpty() ? '+' : re.cap(3).at(0);
2331                 sy = re.cap(4).isEmpty() ? '+' : re.cap(4).at(0);
2332                 // Set initial geometry such that we can get the frame size.
2333                 view->setGeometry(x, y, w, h);
2334                 int framewidth = view->geometry().x() - view->x();
2335                 int titleheight = view->geometry().y() - view->y();
2336                 // Negative displacements must be interpreted as distances
2337                 // from the right or bottom screen borders.
2338                 if (sx == '-' || sy == '-') {
2339                         QRect rec = QApplication::desktop()->screenGeometry();
2340                         if (sx == '-')
2341                                 x += rec.width() - w - framewidth;
2342                         if (sy == '-')
2343                                 y += rec.height() - h - titleheight;
2344                         view->setGeometry(x, y, w, h);
2345                 }
2346                 // Make sure that the left and top frame borders are visible.
2347                 if (view->x() < 0 || view->y() < 0) {
2348                         if (view->x() < 0)
2349                                 x = framewidth;
2350                         if (view->y() < 0)
2351                                 y = titleheight;
2352                         view->setGeometry(x, y, w, h);
2353                 }
2354 #endif
2355         }
2356         view->setFocus();
2357 }
2358
2359
2360 Clipboard & GuiApplication::clipboard()
2361 {
2362         return d->clipboard_;
2363 }
2364
2365
2366 Selection & GuiApplication::selection()
2367 {
2368         return d->selection_;
2369 }
2370
2371
2372 FontLoader & GuiApplication::fontLoader()
2373 {
2374         return d->font_loader_;
2375 }
2376
2377
2378 Toolbars const & GuiApplication::toolbars() const
2379 {
2380         return d->toolbars_;
2381 }
2382
2383
2384 Toolbars & GuiApplication::toolbars()
2385 {
2386         return d->toolbars_;
2387 }
2388
2389
2390 Menus const & GuiApplication::menus() const
2391 {
2392         return d->menus_;
2393 }
2394
2395
2396 Menus & GuiApplication::menus()
2397 {
2398         return d->menus_;
2399 }
2400
2401
2402 QList<int> GuiApplication::viewIds() const
2403 {
2404         return d->views_.keys();
2405 }
2406
2407
2408 ColorCache & GuiApplication::colorCache()
2409 {
2410         return d->color_cache_;
2411 }
2412
2413
2414 int GuiApplication::exec()
2415 {
2416         // asynchronously handle batch commands. This event will be in
2417         // the event queue in front of other asynchronous events. Hence,
2418         // we can assume in the latter that the gui is setup already.
2419         QTimer::singleShot(0, this, SLOT(execBatchCommands()));
2420
2421         return QApplication::exec();
2422 }
2423
2424
2425 void GuiApplication::exit(int status)
2426 {
2427         QApplication::exit(status);
2428 }
2429
2430
2431 void GuiApplication::setGuiLanguage()
2432 {
2433         setLocale();
2434         QLocale theLocale;
2435         // install translation file for Qt built-in dialogs
2436         QString const language_name = QString("qt_") + theLocale.name();
2437         // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
2438         // Short-named translator can be loaded from a long name, but not the
2439         // opposite. Therefore, long name should be used without truncation.
2440         // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
2441         if (!d->qt_trans_.load(language_name,
2442                         QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
2443                 LYXERR(Debug::LOCALE, "Could not find Qt translations for locale "
2444                         << language_name);
2445         } else {
2446                 LYXERR(Debug::LOCALE, "Successfully installed Qt translations for locale "
2447                         << language_name);
2448         }
2449
2450         switch (theLocale.language()) {
2451         case QLocale::Arabic :
2452         case QLocale::Hebrew :
2453         case QLocale::Persian :
2454         case QLocale::Urdu :
2455                 setLayoutDirection(Qt::RightToLeft);
2456                 break;
2457         default:
2458                 setLayoutDirection(Qt::LeftToRight);
2459         }
2460 }
2461
2462
2463 void GuiApplication::execBatchCommands()
2464 {
2465         setGuiLanguage();
2466
2467         // Read menus
2468         if (!readUIFile(toqstr(lyxrc.ui_file)))
2469                 // Gives some error box here.
2470                 return;
2471
2472 #ifdef Q_OS_MAC
2473 #if QT_VERSION > 0x040600
2474         setAttribute(Qt::AA_MacDontSwapCtrlAndMeta,lyxrc.mac_dontswap_ctrl_meta);
2475 #endif
2476 #if QT_VERSION > 0x050100
2477         setAttribute(Qt::AA_UseHighDpiPixmaps,true);
2478 #endif
2479         // Create the global default menubar which is shown for the dialogs
2480         // and if no GuiView is visible.
2481         // This must be done after the session was recovered to know the "last files".
2482         d->global_menubar_ = new QMenuBar(0);
2483         d->menus_.fillMenuBar(d->global_menubar_, 0, true);
2484 #endif
2485
2486         lyx::execBatchCommands();
2487 }
2488
2489
2490 QAbstractItemModel * GuiApplication::languageModel()
2491 {
2492         if (d->language_model_)
2493                 return d->language_model_;
2494
2495         QStandardItemModel * lang_model = new QStandardItemModel(this);
2496         lang_model->insertColumns(0, 3);
2497         QIcon speller(getPixmap("images/", "dialog-show_spellchecker", "svgz,png"));
2498         QIcon saurus(getPixmap("images/", "thesaurus-entry", "svgz,png"));
2499         Languages::const_iterator it = lyx::languages.begin();
2500         Languages::const_iterator end = lyx::languages.end();
2501         for (; it != end; ++it) {
2502                 int current_row = lang_model->rowCount();
2503                 lang_model->insertRows(current_row, 1);
2504                 QModelIndex pl_item = lang_model->index(current_row, 0);
2505                 QModelIndex sp_item = lang_model->index(current_row, 1);
2506                 QModelIndex th_item = lang_model->index(current_row, 2);
2507                 lang_model->setData(pl_item, qt_(it->second.display()), Qt::DisplayRole);
2508                 lang_model->setData(pl_item, toqstr(it->second.lang()), Qt::UserRole);
2509                 lang_model->setData(sp_item, qt_(it->second.display()), Qt::DisplayRole);
2510                 lang_model->setData(sp_item, toqstr(it->second.lang()), Qt::UserRole);
2511                 if (theSpellChecker() && theSpellChecker()->hasDictionary(&it->second))
2512                         lang_model->setData(sp_item, speller, Qt::DecorationRole);
2513                 lang_model->setData(th_item, qt_(it->second.display()), Qt::DisplayRole);
2514                 lang_model->setData(th_item, toqstr(it->second.lang()), Qt::UserRole);
2515                 if (thesaurus.thesaurusInstalled(from_ascii(it->second.code())))
2516                         lang_model->setData(th_item, saurus, Qt::DecorationRole);
2517         }
2518         d->language_model_ = new QSortFilterProxyModel(this);
2519         d->language_model_->setSourceModel(lang_model);
2520         d->language_model_->setSortLocaleAware(true);
2521         return d->language_model_;
2522 }
2523
2524
2525 void GuiApplication::restoreGuiSession()
2526 {
2527         if (!lyxrc.load_session)
2528                 return;
2529
2530         Session & session = theSession();
2531         LastOpenedSection::LastOpened const & lastopened =
2532                 session.lastOpened().getfiles();
2533
2534         validateCurrentView();
2535
2536         FileName active_file;
2537         // do not add to the lastfile list since these files are restored from
2538         // last session, and should be already there (regular files), or should
2539         // not be added at all (help files).
2540         for (size_t i = 0; i < lastopened.size(); ++i) {
2541                 FileName const & file_name = lastopened[i].file_name;
2542                 if (d->views_.empty() || (!lyxrc.open_buffers_in_tabs
2543                           && current_view_->documentBufferView() != 0)) {
2544                         boost::crc_32_type crc;
2545                         string const & fname = file_name.absFileName();
2546                         crc = for_each(fname.begin(), fname.end(), crc);
2547                         createView(crc.checksum());
2548                 }
2549                 current_view_->loadDocument(file_name, false);
2550
2551                 if (lastopened[i].active)
2552                         active_file = file_name;
2553         }
2554
2555         // Restore last active buffer
2556         Buffer * buffer = theBufferList().getBuffer(active_file);
2557         if (buffer && current_view_)
2558                 current_view_->setBuffer(buffer);
2559
2560         // clear this list to save a few bytes of RAM
2561         session.lastOpened().clear();
2562 }
2563
2564
2565 QString const GuiApplication::romanFontName()
2566 {
2567         QFont font;
2568         font.setStyleHint(QFont::Serif);
2569         font.setFamily("serif");
2570
2571         return QFontInfo(font).family();
2572 }
2573
2574
2575 QString const GuiApplication::sansFontName()
2576 {
2577         QFont font;
2578         font.setStyleHint(QFont::SansSerif);
2579         font.setFamily("sans");
2580
2581         return QFontInfo(font).family();
2582 }
2583
2584
2585 QString const GuiApplication::typewriterFontName()
2586 {
2587         return QFontInfo(typewriterSystemFont()).family();
2588 }
2589
2590
2591 namespace {
2592         // We cannot use QFont::fixedPitch() because it doesn't
2593         // return the fact but only if it is requested.
2594         static bool isFixedPitch(const QFont & font) {
2595                 const QFontInfo fi(font);
2596                 return fi.fixedPitch();
2597         }
2598 }
2599
2600
2601 QFont const GuiApplication::typewriterSystemFont()
2602 {
2603 #if QT_VERSION >= 0x050200
2604         QFont font = QFontDatabase::systemFont(QFontDatabase::FixedFont);
2605 #else
2606         QFont font("monospace");
2607 #endif
2608         if (!isFixedPitch(font)) {
2609                 // try to enforce a real monospaced font
2610                 font.setStyleHint(QFont::Monospace);
2611                 if (!isFixedPitch(font)) {
2612                         font.setStyleHint(QFont::TypeWriter);
2613                         if (!isFixedPitch(font)) font.setFamily("courier");
2614                 }
2615         }
2616 #ifdef Q_OS_MAC
2617         // On a Mac the result is too small and it's not practical to
2618         // rely on Qtconfig utility to change the system settings of Qt.
2619         font.setPointSize(12);
2620 #endif
2621         return font;
2622 }
2623
2624
2625 void GuiApplication::handleRegularEvents()
2626 {
2627         ForkedCallsController::handleCompletedProcesses();
2628 }
2629
2630
2631 bool GuiApplication::event(QEvent * e)
2632 {
2633         switch(e->type()) {
2634         case QEvent::FileOpen: {
2635                 // Open a file; this happens only on Mac OS X for now.
2636                 //
2637                 // We do this asynchronously because on startup the batch
2638                 // commands are not executed here yet and the gui is not ready
2639                 // therefore.
2640                 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
2641                 FuncRequest const fr(LFUN_FILE_OPEN, qstring_to_ucs4(foe->file()));
2642                 processFuncRequestAsync(fr);
2643                 e->accept();
2644                 return true;
2645         }
2646         default:
2647                 return QApplication::event(e);
2648         }
2649 }
2650
2651
2652 bool GuiApplication::notify(QObject * receiver, QEvent * event)
2653 {
2654         try {
2655                 return QApplication::notify(receiver, event);
2656         }
2657         catch (ExceptionMessage const & e) {
2658                 switch(e.type_) {
2659                 case ErrorException:
2660                         emergencyCleanup();
2661                         setQuitOnLastWindowClosed(false);
2662                         closeAllViews();
2663                         Alert::error(e.title_, e.details_);
2664 #ifndef NDEBUG
2665                         // Properly crash in debug mode in order to get a useful backtrace.
2666                         abort();
2667 #endif
2668                         // In release mode, try to exit gracefully.
2669                         this->exit(1);
2670
2671                 case BufferException: {
2672                         if (!current_view_ || !current_view_->documentBufferView())
2673                                 return false;
2674                         Buffer * buf = &current_view_->documentBufferView()->buffer();
2675                         docstring details = e.details_ + '\n';
2676                         details += buf->emergencyWrite();
2677                         theBufferList().release(buf);
2678                         details += "\n" + _("The current document was closed.");
2679                         Alert::error(e.title_, details);
2680                         return false;
2681                 }
2682                 case WarningException:
2683                         Alert::warning(e.title_, e.details_);
2684                         return false;
2685                 }
2686         }
2687         catch (exception const & e) {
2688                 docstring s = _("LyX has caught an exception, it will now "
2689                         "attempt to save all unsaved documents and exit."
2690                         "\n\nException: ");
2691                 s += from_ascii(e.what());
2692                 Alert::error(_("Software exception Detected"), s);
2693                 lyx_exit(1);
2694         }
2695         catch (...) {
2696                 docstring s = _("LyX has caught some really weird exception, it will "
2697                         "now attempt to save all unsaved documents and exit.");
2698                 Alert::error(_("Software exception Detected"), s);
2699                 lyx_exit(1);
2700         }
2701
2702         return false;
2703 }
2704
2705
2706 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
2707 {
2708         QColor const & qcol = d->color_cache_.get(col);
2709         if (!qcol.isValid()) {
2710                 rgbcol.r = 0;
2711                 rgbcol.g = 0;
2712                 rgbcol.b = 0;
2713                 return false;
2714         }
2715         rgbcol.r = qcol.red();
2716         rgbcol.g = qcol.green();
2717         rgbcol.b = qcol.blue();
2718         return true;
2719 }
2720
2721
2722 bool Application::getRgbColorUncached(ColorCode col, RGBColor & rgbcol)
2723 {
2724         QColor const qcol(lcolor.getX11Name(col).c_str());
2725         if (!qcol.isValid()) {
2726                 rgbcol.r = 0;
2727                 rgbcol.g = 0;
2728                 rgbcol.b = 0;
2729                 return false;
2730         }
2731         rgbcol.r = qcol.red();
2732         rgbcol.g = qcol.green();
2733         rgbcol.b = qcol.blue();
2734         return true;
2735 }
2736
2737
2738 string const GuiApplication::hexName(ColorCode col)
2739 {
2740         return ltrim(fromqstr(d->color_cache_.get(col).name()), "#");
2741 }
2742
2743
2744 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
2745 {
2746         SocketNotifier * sn = new SocketNotifier(this, fd, func);
2747         d->socket_notifiers_[fd] = sn;
2748         connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
2749 }
2750
2751
2752 void GuiApplication::socketDataReceived(int fd)
2753 {
2754         d->socket_notifiers_[fd]->func_();
2755 }
2756
2757
2758 void GuiApplication::unregisterSocketCallback(int fd)
2759 {
2760         d->socket_notifiers_.take(fd)->setEnabled(false);
2761 }
2762
2763
2764 void GuiApplication::commitData(QSessionManager & sm)
2765 {
2766         /** The implementation is required to avoid an application exit
2767          ** when session state save is triggered by session manager.
2768          ** The default implementation sends a close event to all
2769          ** visible top level widgets when session managment allows
2770          ** interaction.
2771          ** We are changing that to check the state of each buffer in all
2772          ** views and ask the users what to do if buffers are dirty.
2773          ** Furthermore, we save the session state.
2774          ** We do NOT close the views here since the user still can cancel
2775          ** the logout process (see #9277); also, this would hide LyX from
2776          ** an OSes own session handling (application restoration).
2777          **/
2778         #ifdef QT_NO_SESSIONMANAGER
2779                 #ifndef _MSC_VER
2780                         #warning Qt is compiled without session manager
2781                 #else
2782                         #pragma message("warning: Qt is compiled without session manager")
2783                 #endif
2784                 (void) sm;
2785         #else
2786                 if (sm.allowsInteraction() && !prepareAllViewsForLogout())
2787                         sm.cancel();
2788                 else
2789                         sm.release();
2790         #endif
2791 }
2792
2793
2794 void GuiApplication::unregisterView(GuiView * gv)
2795 {
2796         if(d->views_.contains(gv->id()) && d->views_.value(gv->id()) == gv) {
2797                 d->views_.remove(gv->id());
2798                 if (current_view_ == gv)
2799                         current_view_ = 0;
2800         }
2801 }
2802
2803
2804 bool GuiApplication::closeAllViews()
2805 {
2806         if (d->views_.empty())
2807                 return true;
2808
2809         // When a view/window was closed before without quitting LyX, there
2810         // are already entries in the lastOpened list.
2811         theSession().lastOpened().clear();
2812
2813         QList<GuiView *> const views = d->views_.values();
2814         for (GuiView * view : views) {
2815                 if (!view->closeScheduled())
2816                         return false;
2817         }
2818
2819         d->views_.clear();
2820         return true;
2821 }
2822
2823
2824 bool GuiApplication::prepareAllViewsForLogout()
2825 {
2826         if (d->views_.empty())
2827                 return true;
2828
2829         QList<GuiView *> const views = d->views_.values();
2830         for (GuiView * view : views) {
2831                 if (!view->prepareAllBuffersForLogout())
2832                         return false;
2833         }
2834
2835         return true;
2836 }
2837
2838
2839 GuiView & GuiApplication::view(int id) const
2840 {
2841         LAPPERR(d->views_.contains(id));
2842         return *d->views_.value(id);
2843 }
2844
2845
2846 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
2847 {
2848         QList<GuiView *> const views = d->views_.values();
2849         for (GuiView * view : views)
2850                 view->hideDialog(name, inset);
2851 }
2852
2853
2854 Buffer const * GuiApplication::updateInset(Inset const * inset) const
2855 {
2856         Buffer const * buffer_ = 0;
2857         QHash<int, GuiView *>::const_iterator end = d->views_.end();
2858         for (QHash<int, GuiView *>::iterator it = d->views_.begin(); it != end; ++it) {
2859                 if (Buffer const * ptr = (*it)->updateInset(inset))
2860                         buffer_ = ptr;
2861         }
2862         return buffer_;
2863 }
2864
2865
2866 bool GuiApplication::searchMenu(FuncRequest const & func,
2867         docstring_list & names) const
2868 {
2869         return d->menus_.searchMenu(func, names);
2870 }
2871
2872
2873 // Ensure that a file is read only once (prevents include loops)
2874 static QStringList uifiles;
2875 // store which ui files define Toolbars
2876 static QStringList toolbar_uifiles;
2877
2878
2879 GuiApplication::ReturnValues GuiApplication::readUIFile(FileName ui_path)
2880 {
2881         enum {
2882                 ui_menuset = 1,
2883                 ui_toolbars,
2884                 ui_toolbarset,
2885                 ui_include,
2886                 ui_format,
2887                 ui_last
2888         };
2889
2890         LexerKeyword uitags[] = {
2891                 { "format", ui_format },
2892                 { "include", ui_include },
2893                 { "menuset", ui_menuset },
2894                 { "toolbars", ui_toolbars },
2895                 { "toolbarset", ui_toolbarset }
2896         };
2897
2898         Lexer lex(uitags);
2899         lex.setFile(ui_path);
2900         if (!lex.isOK()) {
2901                 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
2902                                          << endl;
2903         }
2904
2905         if (lyxerr.debugging(Debug::PARSER))
2906                 lex.printTable(lyxerr);
2907
2908         bool error = false;
2909         // format before introduction of format tag
2910         unsigned int format = 0;
2911         while (lex.isOK()) {
2912                 int const status = lex.lex();
2913
2914                 // we have to do this check here, outside the switch,
2915                 // because otherwise we would start reading include files,
2916                 // e.g., if the first tag we hit was an include tag.
2917                 if (status == ui_format)
2918                         if (lex.next()) {
2919                                 format = lex.getInteger();
2920                                 continue;
2921                         }
2922
2923                 // this will trigger unless the first tag we hit is a format
2924                 // tag, with the right format.
2925                 if (format != LFUN_FORMAT)
2926                         return FormatMismatch;
2927
2928                 switch (status) {
2929                 case Lexer::LEX_FEOF:
2930                         continue;
2931
2932                 case ui_include: {
2933                         lex.next(true);
2934                         QString const file = toqstr(lex.getString());
2935                         bool const success = readUIFile(file, true);
2936                         if (!success) {
2937                                 LYXERR0("Failed to read inlcuded file: " << fromqstr(file));
2938                                 return ReadError;
2939                         }
2940                         break;
2941                 }
2942
2943                 case ui_menuset:
2944                         d->menus_.read(lex);
2945                         break;
2946
2947                 case ui_toolbarset:
2948                         d->toolbars_.readToolbars(lex);
2949                         break;
2950
2951                 case ui_toolbars:
2952                         d->toolbars_.readToolbarSettings(lex);
2953                         toolbar_uifiles.push_back(toqstr(ui_path.absFileName()));
2954                         break;
2955
2956                 default:
2957                         if (!rtrim(lex.getString()).empty())
2958                                 lex.printError("LyX::ReadUIFile: "
2959                                                "Unknown menu tag: `$$Token'");
2960                         else
2961                                 LYXERR0("Error with status: " << status);
2962                         error = true;
2963                         break;
2964                 }
2965
2966         }
2967         return (error ? ReadError : ReadOK);
2968 }
2969
2970
2971 bool GuiApplication::readUIFile(QString const & name, bool include)
2972 {
2973         LYXERR(Debug::INIT, "About to read " << name << "...");
2974
2975         FileName ui_path;
2976         if (include) {
2977                 ui_path = libFileSearch("ui", name, "inc");
2978                 if (ui_path.empty())
2979                         ui_path = libFileSearch("ui", changeExtension(name, "inc"));
2980         } else {
2981                 ui_path = libFileSearch("ui", name, "ui");
2982         }
2983
2984         if (ui_path.empty()) {
2985                 static const QString defaultUIFile = "default";
2986                 LYXERR(Debug::INIT, "Could not find " << name);
2987                 if (include) {
2988                         Alert::warning(_("Could not find UI definition file"),
2989                                 bformat(_("Error while reading the included file\n%1$s\n"
2990                                         "Please check your installation."), qstring_to_ucs4(name)));
2991                         return false;
2992                 }
2993                 if (name == defaultUIFile) {
2994                         LYXERR(Debug::INIT, "Could not find default UI file!!");
2995                         Alert::warning(_("Could not find default UI file"),
2996                                 _("LyX could not find the default UI file!\n"
2997                                   "Please check your installation."));
2998                         return false;
2999                 }
3000                 Alert::warning(_("Could not find UI definition file"),
3001                 bformat(_("Error while reading the configuration file\n%1$s\n"
3002                         "Falling back to default.\n"
3003                         "Please look under Tools>Preferences>User Interface and\n"
3004                         "check which User Interface file you are using."), qstring_to_ucs4(name)));
3005                 return readUIFile(defaultUIFile, false);
3006         }
3007
3008         QString const uifile = toqstr(ui_path.absFileName());
3009         if (uifiles.contains(uifile)) {
3010                 if (!include) {
3011                         // We are reading again the top uifile so reset the safeguard:
3012                         uifiles.clear();
3013                         d->menus_.reset();
3014                         d->toolbars_.reset();
3015                 } else {
3016                         LYXERR(Debug::INIT, "UI file '" << name << "' has been read already. "
3017                                 << "Is this an include loop?");
3018                         return false;
3019                 }
3020         }
3021         uifiles.push_back(uifile);
3022
3023         LYXERR(Debug::INIT, "Found " << name << " in " << ui_path);
3024
3025         ReturnValues retval = readUIFile(ui_path);
3026
3027         if (retval == FormatMismatch) {
3028                 LYXERR(Debug::FILES, "Converting ui file to format " << LFUN_FORMAT);
3029                 TempFile tmp("convertXXXXXX.ui");
3030                 FileName const tempfile = tmp.name();
3031                 bool const success = prefs2prefs(ui_path, tempfile, true);
3032                 if (!success) {
3033                         LYXERR0("Unable to convert " << ui_path.absFileName() <<
3034                                 " to format " << LFUN_FORMAT << ".");
3035                 } else {
3036                         retval = readUIFile(tempfile);
3037                 }
3038         }
3039
3040         if (retval != ReadOK) {
3041                 LYXERR0("Unable to read UI file: " << ui_path.absFileName());
3042                 return false;
3043         }
3044
3045         if (include)
3046                 return true;
3047
3048         QSettings settings;
3049         settings.beginGroup("ui_files");
3050         bool touched = false;
3051         for (int i = 0; i != uifiles.size(); ++i) {
3052                 QFileInfo fi(uifiles[i]);
3053                 QDateTime const date_value = fi.lastModified();
3054                 QString const name_key = QString::number(i);
3055                 // if an ui file which defines Toolbars has changed,
3056                 // we have to reset the settings
3057                 if (toolbar_uifiles.contains(uifiles[i])
3058                  && (!settings.contains(name_key)
3059                  || settings.value(name_key).toString() != uifiles[i]
3060                  || settings.value(name_key + "/date").toDateTime() != date_value)) {
3061                         touched = true;
3062                         settings.setValue(name_key, uifiles[i]);
3063                         settings.setValue(name_key + "/date", date_value);
3064                 }
3065         }
3066         settings.endGroup();
3067         if (touched)
3068                 settings.remove("views");
3069
3070         return true;
3071 }
3072
3073
3074 void GuiApplication::onLastWindowClosed()
3075 {
3076         if (d->global_menubar_)
3077                 d->global_menubar_->grabKeyboard();
3078 }
3079
3080
3081 void GuiApplication::startLongOperation() {
3082         d->key_checker_.start();
3083 }
3084
3085
3086 bool GuiApplication::longOperationCancelled() {
3087         return d->key_checker_.pressed();
3088 }
3089
3090
3091 void GuiApplication::stopLongOperation() {
3092         d->key_checker_.stop();
3093 }
3094
3095
3096 bool GuiApplication::longOperationStarted() {
3097         return d->key_checker_.started();
3098 }
3099
3100
3101 ////////////////////////////////////////////////////////////////////////
3102 //
3103 // X11 specific stuff goes here...
3104
3105 #ifdef Q_WS_X11
3106 bool GuiApplication::x11EventFilter(XEvent * xev)
3107 {
3108         if (!current_view_)
3109                 return false;
3110
3111         switch (xev->type) {
3112         case SelectionRequest: {
3113                 if (xev->xselectionrequest.selection != XA_PRIMARY)
3114                         break;
3115                 LYXERR(Debug::SELECTION, "X requested selection.");
3116                 BufferView * bv = current_view_->currentBufferView();
3117                 if (bv) {
3118                         docstring const sel = bv->requestSelection();
3119                         if (!sel.empty())
3120                                 d->selection_.put(sel);
3121                 }
3122                 break;
3123         }
3124         case SelectionClear: {
3125                 if (xev->xselectionclear.selection != XA_PRIMARY)
3126                         break;
3127                 LYXERR(Debug::SELECTION, "Lost selection.");
3128                 BufferView * bv = current_view_->currentBufferView();
3129                 if (bv)
3130                         bv->clearSelection();
3131                 break;
3132         }
3133         }
3134         return false;
3135 }
3136 #elif defined(QPA_XCB)
3137 bool GuiApplication::nativeEventFilter(const QByteArray & eventType,
3138                                        void * message, long *)
3139 {
3140         if (!current_view_ || eventType != "xcb_generic_event_t")
3141                 return false;
3142
3143         xcb_generic_event_t * ev = static_cast<xcb_generic_event_t *>(message);
3144
3145         switch (ev->response_type) {
3146         case XCB_SELECTION_REQUEST: {
3147                 xcb_selection_request_event_t * srev =
3148                         reinterpret_cast<xcb_selection_request_event_t *>(ev);
3149                 if (srev->selection != XCB_ATOM_PRIMARY)
3150                         break;
3151                 LYXERR(Debug::SELECTION, "X requested selection.");
3152                 BufferView * bv = current_view_->currentBufferView();
3153                 if (bv) {
3154                         docstring const sel = bv->requestSelection();
3155                         if (!sel.empty())
3156                                 d->selection_.put(sel);
3157                 }
3158                 break;
3159         }
3160         case XCB_SELECTION_CLEAR: {
3161                 xcb_selection_clear_event_t * scev =
3162                         reinterpret_cast<xcb_selection_clear_event_t *>(ev);
3163                 if (scev->selection != XCB_ATOM_PRIMARY)
3164                         break;
3165                 LYXERR(Debug::SELECTION, "Lost selection.");
3166                 BufferView * bv = current_view_->currentBufferView();
3167                 if (bv)
3168                         bv->clearSelection();
3169                 break;
3170         }
3171         }
3172         return false;
3173 }
3174 #endif
3175
3176 } // namespace frontend
3177
3178
3179 void hideDialogs(std::string const & name, Inset * inset)
3180 {
3181         if (theApp())
3182                 frontend::guiApp->hideDialogs(name, inset);
3183 }
3184
3185
3186 ////////////////////////////////////////////////////////////////////
3187 //
3188 // Font stuff
3189 //
3190 ////////////////////////////////////////////////////////////////////
3191
3192 frontend::FontLoader & theFontLoader()
3193 {
3194         LAPPERR(frontend::guiApp);
3195         return frontend::guiApp->fontLoader();
3196 }
3197
3198
3199 frontend::FontMetrics const & theFontMetrics(Font const & f)
3200 {
3201         return theFontMetrics(f.fontInfo());
3202 }
3203
3204
3205 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
3206 {
3207         LAPPERR(frontend::guiApp);
3208         return frontend::guiApp->fontLoader().metrics(f);
3209 }
3210
3211
3212 ////////////////////////////////////////////////////////////////////
3213 //
3214 // Misc stuff
3215 //
3216 ////////////////////////////////////////////////////////////////////
3217
3218 frontend::Clipboard & theClipboard()
3219 {
3220         LAPPERR(frontend::guiApp);
3221         return frontend::guiApp->clipboard();
3222 }
3223
3224
3225 frontend::Selection & theSelection()
3226 {
3227         LAPPERR(frontend::guiApp);
3228         return frontend::guiApp->selection();
3229 }
3230
3231
3232 } // namespace lyx
3233
3234 #include "moc_GuiApplication.cpp"