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