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         qsrand(QDateTime::currentDateTime().toTime_t());
1060
1061         // Install LyX translator for missing Qt translations
1062         installTranslator(&d->gui_trans_);
1063         // Install Qt native translator for GUI elements.
1064         installTranslator(&d->qt_trans_);
1065
1066 #ifdef QPA_XCB
1067         // Enable reception of XCB events.
1068         installNativeEventFilter(this);
1069 #endif
1070
1071         // FIXME: quitOnLastWindowClosed is true by default. We should have a
1072         // lyxrc setting for this in order to let the application stay resident.
1073         // But then we need some kind of dock icon, at least on Windows.
1074         /*
1075         if (lyxrc.quit_on_last_window_closed)
1076                 setQuitOnLastWindowClosed(false);
1077         */
1078 #ifdef Q_OS_MAC
1079         // FIXME: Do we need a lyxrc setting for this on Mac? This behaviour
1080         // seems to be the default case for applications like LyX.
1081         setQuitOnLastWindowClosed(false);
1082         ///
1083         setupApplescript();
1084         appleCleanupEditMenu();
1085         appleCleanupViewMenu();
1086 #endif
1087
1088 #if defined(Q_WS_X11) || defined(QPA_XCB)
1089         // doubleClickInterval() is 400 ms on X11 which is just too long.
1090         // On Windows and Mac OS X, the operating system's value is used.
1091         // On Microsoft Windows, calling this function sets the double
1092         // click interval for all applications. So we don't!
1093         QApplication::setDoubleClickInterval(300);
1094 #endif
1095
1096         connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
1097
1098         // needs to be done before reading lyxrc
1099         QWidget w;
1100         lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
1101
1102         guiApp = this;
1103
1104         // Initialize RC Fonts
1105         if (lyxrc.roman_font_name.empty())
1106                 lyxrc.roman_font_name = fromqstr(romanFontName());
1107
1108         if (lyxrc.sans_font_name.empty())
1109                 lyxrc.sans_font_name = fromqstr(sansFontName());
1110
1111         if (lyxrc.typewriter_font_name.empty())
1112                 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
1113
1114 #if (QT_VERSION >= 0x050000)
1115         // Qt4 does this in event(), see below.
1116         // Track change of keyboard
1117         connect(inputMethod(), SIGNAL(localeChanged()), this, SLOT(onLocaleChanged()));
1118 #endif
1119
1120         d->general_timer_.setInterval(500);
1121         connect(&d->general_timer_, SIGNAL(timeout()),
1122                 this, SLOT(handleRegularEvents()));
1123         d->general_timer_.start();
1124
1125         // maxThreadCount() defaults in general to 2 on single or dual-processor.
1126         // This is clearly not enough in a time where we use threads for
1127         // document preview and/or export. 20 should be OK.
1128         QThreadPool::globalInstance()->setMaxThreadCount(20);
1129
1130         // make sure tooltips are formatted
1131         installEventFilter(new ToolTipFormatter(this));
1132 }
1133
1134
1135 GuiApplication * theGuiApp()
1136 {
1137         return dynamic_cast<GuiApplication *>(theApp());
1138 }
1139
1140
1141 #if QT_VERSION < 0x050000
1142 // Emulate platformName() for Qt4
1143
1144 // FIXME: when ditching this method, remove all tests
1145 //     platformName() == "qt4x11"
1146 // in the code
1147 QString GuiApplication::platformName() const
1148 {
1149 # if defined(Q_WS_X11)
1150         // Note that this one does not really exist
1151         return "qt4x11";
1152 # elif defined(Q_OS_MAC)
1153         return "cocoa";
1154 # elif defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
1155         return "windows";
1156 # else
1157         LYXERR0("Unknown platform!");
1158         return "unknown";
1159 # endif
1160 }
1161 #endif
1162
1163
1164 double GuiApplication::pixelRatio() const
1165 {
1166 #if QT_VERSION >= 0x050000
1167         return qt_scale_factor * devicePixelRatio();
1168 #else
1169         return 1.0;
1170 #endif
1171 }
1172
1173
1174 void GuiApplication::clearSession()
1175 {
1176         QSettings settings;
1177         settings.clear();
1178 }
1179
1180
1181 docstring Application::iconName(FuncRequest const & f, bool unknown)
1182 {
1183         return qstring_to_ucs4(lyx::frontend::iconInfo(f, unknown, false).filepath);
1184 }
1185
1186
1187 docstring Application::mathIcon(docstring const & c)
1188 {
1189         return qstring_to_ucs4(findImg(toqstr(c)));
1190 }
1191
1192
1193 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd) const
1194 {
1195         FuncStatus status;
1196
1197         BufferView * bv = nullptr;
1198         BufferView * doc_bv = nullptr;
1199
1200         if (cmd.action() == LFUN_NOACTION) {
1201                 status.message(from_utf8(N_("Nothing to do")));
1202                 status.setEnabled(false);
1203         }
1204
1205         else if (cmd.action() == LFUN_UNKNOWN_ACTION) {
1206                 status.setUnknown(true);
1207                 status.message(from_utf8(N_("Unknown action")));
1208                 status.setEnabled(false);
1209         }
1210
1211         // Does the GuiApplication know something?
1212         else if (getStatus(cmd, status)) { }
1213
1214         // If we do not have a GuiView, then other functions are disabled
1215         else if (!current_view_)
1216                 status.setEnabled(false);
1217
1218         // Does the GuiView know something?
1219         else if (current_view_->getStatus(cmd, status)) { }
1220
1221         // In LyX/Mac, when a dialog is open, the menus of the
1222         // application can still be accessed without giving focus to
1223         // the main window. In this case, we want to disable the menu
1224         // entries that are buffer or view-related.
1225         //FIXME: Abdel (09/02/10) This has very bad effect on Linux, don't know why...
1226         /*
1227         else if (cmd.origin() == FuncRequest::MENU && !current_view_->hasFocus())
1228                 status.setEnabled(false);
1229         */
1230
1231         // If we do not have a BufferView, then other functions are disabled
1232         else if (!(bv = current_view_->currentBufferView()))
1233                 status.setEnabled(false);
1234
1235         // Does the current BufferView know something?
1236         else if (bv->getStatus(cmd, status)) { }
1237
1238         // Does the current Buffer know something?
1239         else if (bv->buffer().getStatus(cmd, status)) { }
1240
1241         // If we do not have a document BufferView, different from the
1242         // current BufferView, then other functions are disabled
1243         else if (!(doc_bv = current_view_->documentBufferView()) || doc_bv == bv)
1244                 status.setEnabled(false);
1245
1246         // Does the document Buffer know something?
1247         else if (doc_bv->buffer().getStatus(cmd, status)) { }
1248
1249         else {
1250                 LYXERR(Debug::ACTION, "LFUN not handled in getStatus(): " << cmd);
1251                 status.message(from_utf8(N_("Command not handled")));
1252                 status.setEnabled(false);
1253         }
1254
1255         // the default error message if we disable the command
1256         if (!status.enabled() && status.message().empty())
1257                 status.message(from_utf8(N_("Command disabled")));
1258
1259         return status;
1260 }
1261
1262
1263 bool GuiApplication::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
1264 {
1265         // I would really like to avoid having this switch and rather try to
1266         // encode this in the function itself.
1267         // -- And I'd rather let an inset decide which LFUNs it is willing
1268         // to handle (Andre')
1269         bool enable = true;
1270         switch (cmd.action()) {
1271
1272         // This could be used for the no-GUI version. The GUI version is handled in
1273         // GuiView::getStatus(). See above.
1274         /*
1275         case LFUN_BUFFER_WRITE:
1276         case LFUN_BUFFER_WRITE_AS:
1277         case LFUN_BUFFER_WRITE_AS_TEMPLATE: {
1278                 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
1279                 enable = b && (b->isUnnamed() || !b->isClean());
1280                 break;
1281         }
1282         */
1283
1284         case LFUN_BOOKMARK_GOTO: {
1285                 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
1286                 enable = theSession().bookmarks().isValid(num);
1287                 break;
1288         }
1289
1290         case LFUN_BOOKMARK_CLEAR:
1291                 enable = theSession().bookmarks().hasValid();
1292                 break;
1293
1294         // this one is difficult to get right. As a half-baked
1295         // solution, we consider only the first action of the sequence
1296         case LFUN_COMMAND_SEQUENCE: {
1297                 // argument contains ';'-terminated commands
1298                 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
1299                 FuncRequest func(lyxaction.lookupFunc(firstcmd));
1300                 func.setOrigin(cmd.origin());
1301                 flag = getStatus(func);
1302                 break;
1303         }
1304
1305         // we want to check if at least one of these is enabled
1306         case LFUN_COMMAND_ALTERNATIVES: {
1307                 // argument contains ';'-terminated commands
1308                 string arg = to_utf8(cmd.argument());
1309                 while (!arg.empty()) {
1310                         string first;
1311                         arg = split(arg, first, ';');
1312                         FuncRequest func(lyxaction.lookupFunc(first));
1313                         func.setOrigin(cmd.origin());
1314                         flag = getStatus(func);
1315                         // if this one is enabled, the whole thing is
1316                         if (flag.enabled())
1317                                 break;
1318                 }
1319                 break;
1320         }
1321
1322         case LFUN_CALL: {
1323                 FuncRequest func;
1324                 string name = to_utf8(cmd.argument());
1325                 if (theTopLevelCmdDef().lock(name, func)) {
1326                         func.setOrigin(cmd.origin());
1327                         flag = getStatus(func);
1328                         theTopLevelCmdDef().release(name);
1329                 } else {
1330                         // catch recursion or unknown command
1331                         // definition. all operations until the
1332                         // recursion or unknown command definition
1333                         // occurs are performed, so set the state to
1334                         // enabled
1335                         enable = true;
1336                 }
1337                 break;
1338         }
1339
1340         case LFUN_IF_RELATIVES: {
1341                 string const lfun = to_utf8(cmd.argument());
1342                 BufferView const * bv =
1343                         current_view_ ? current_view_->currentBufferView() : nullptr;
1344                 if (!bv || (bv->buffer().parent() == nullptr && !bv->buffer().hasChildren())) {
1345                         enable = false;
1346                         break;
1347                 }
1348                 FuncRequest func(lyxaction.lookupFunc(lfun));
1349                 func.setOrigin(cmd.origin());
1350                 flag = getStatus(func);
1351                 break;
1352         }
1353
1354         case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1355         case LFUN_REPEAT:
1356         case LFUN_PREFERENCES_SAVE:
1357         case LFUN_BUFFER_SAVE_AS_DEFAULT:
1358         case LFUN_DEBUG_LEVEL_SET:
1359                 // these are handled in our dispatch()
1360                 break;
1361
1362         case LFUN_WINDOW_CLOSE:
1363                 enable = !d->views_.empty();
1364                 break;
1365
1366         case LFUN_BUFFER_NEW:
1367         case LFUN_BUFFER_NEW_TEMPLATE:
1368         case LFUN_FILE_OPEN:
1369         case LFUN_HELP_OPEN:
1370         case LFUN_SCREEN_FONT_UPDATE:
1371         case LFUN_SET_COLOR:
1372         case LFUN_WINDOW_NEW:
1373         case LFUN_LYX_QUIT:
1374         case LFUN_LYXRC_APPLY:
1375         case LFUN_COMMAND_PREFIX:
1376         case LFUN_CANCEL:
1377         case LFUN_META_PREFIX:
1378         case LFUN_RECONFIGURE:
1379         case LFUN_SERVER_GET_FILENAME:
1380         case LFUN_SERVER_NOTIFY:
1381                 enable = true;
1382                 break;
1383
1384         case LFUN_BUFFER_FORALL: {
1385                 if (theBufferList().empty()) {
1386                         flag.message(from_utf8(N_("Command not allowed without a buffer open")));
1387                         flag.setEnabled(false);
1388                         break;
1389                 }
1390
1391                 FuncRequest const cmdToPass = lyxaction.lookupFunc(cmd.getLongArg(0));
1392                 if (cmdToPass.action() == LFUN_UNKNOWN_ACTION) {
1393                         flag.message(from_utf8(N_("the <LFUN-COMMAND> argument of buffer-forall is not valid")));
1394                         flag.setEnabled(false);
1395                 }
1396                 break;
1397         }
1398
1399         case LFUN_DIALOG_SHOW: {
1400                 string const name = cmd.getArg(0);
1401                 return name == "aboutlyx"
1402                         || name == "lyxfiles"
1403                         || name == "prefs"
1404                         || name == "texinfo"
1405                         || name == "progress"
1406                         || name == "compare";
1407         }
1408
1409         default:
1410                 return false;
1411         }
1412
1413         if (!enable)
1414                 flag.setEnabled(false);
1415         return true;
1416 }
1417
1418 /// make a post-dispatch status message
1419 static docstring makeDispatchMessage(docstring const & msg,
1420                                      FuncRequest const & cmd)
1421 {
1422         const bool be_verbose = (cmd.origin() == FuncRequest::MENU
1423                               || cmd.origin() == FuncRequest::TOOLBAR
1424                               || cmd.origin() == FuncRequest::COMMANDBUFFER);
1425
1426         if (cmd.action() == LFUN_SELF_INSERT || !be_verbose) {
1427                 LYXERR(Debug::ACTION, "dispatch msg is `" << msg << "'");
1428                 return msg;
1429         }
1430
1431         docstring dispatch_msg = msg;
1432         if (!dispatch_msg.empty())
1433                 dispatch_msg += ' ';
1434
1435         docstring comname = from_utf8(lyxaction.getActionName(cmd.action()));
1436
1437         bool argsadded = false;
1438
1439         if (!cmd.argument().empty()) {
1440                 if (cmd.action() != LFUN_UNKNOWN_ACTION) {
1441                         comname += ' ' + cmd.argument();
1442                         argsadded = true;
1443                 }
1444         }
1445         docstring const shortcuts = theTopLevelKeymap().
1446                 printBindings(cmd, KeySequence::ForGui);
1447
1448         if (!shortcuts.empty())
1449                 comname += ": " + shortcuts;
1450         else if (!argsadded && !cmd.argument().empty())
1451                 comname += ' ' + cmd.argument();
1452
1453         if (!comname.empty()) {
1454                 comname = rtrim(comname);
1455                 dispatch_msg += '(' + rtrim(comname) + ')';
1456         }
1457         LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1458         return dispatch_msg;
1459 }
1460
1461
1462 DispatchResult const & GuiApplication::dispatch(FuncRequest const & cmd)
1463 {
1464         DispatchResult dr;
1465
1466         Buffer * buffer = nullptr;
1467         if (cmd.view_origin() && current_view_ != cmd.view_origin()) {
1468                 //setCurrentView(cmd.view_origin); //does not work
1469                 dr.setError(true);
1470                 dr.setMessage(_("Wrong focus!"));
1471                 d->dispatch_result_ = dr;
1472                 return d->dispatch_result_;
1473         }
1474         if (current_view_ && current_view_->currentBufferView()) {
1475                 current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1476                 buffer = &current_view_->currentBufferView()->buffer();
1477         }
1478
1479         dr.screenUpdate(Update::FitCursor);
1480         {
1481                 // This handles undo groups automagically
1482                 UndoGroupHelper ugh(buffer);
1483                 dispatch(cmd, dr);
1484                 // redraw the screen at the end (first of the two drawing steps).
1485                 // This is done unless explicitly requested otherwise.
1486                 // This code is kept inside the undo group because updateBuffer
1487                 // can create undo actions (see #11292)
1488                 updateCurrentView(cmd, dr);
1489         }
1490
1491         d->dispatch_result_ = dr;
1492         return d->dispatch_result_;
1493 }
1494
1495
1496 void GuiApplication::updateCurrentView(FuncRequest const & cmd, DispatchResult & dr)
1497 {
1498         if (!current_view_)
1499                 return;
1500
1501         BufferView * bv = current_view_->currentBufferView();
1502         if (bv) {
1503                 if (dr.needBufferUpdate()) {
1504                         bv->cursor().clearBufferUpdate();
1505                         bv->buffer().updateBuffer();
1506                 }
1507                 // BufferView::update() updates the ViewMetricsInfo and
1508                 // also initializes the position cache for all insets in
1509                 // (at least partially) visible top-level paragraphs.
1510                 // We will redraw the screen only if needed.
1511                 bv->processUpdateFlags(dr.screenUpdate());
1512
1513                 // Do we have a selection?
1514                 theSelection().haveSelection(bv->cursor().selection());
1515
1516                 // update gui
1517                 current_view_->restartCaret();
1518         }
1519         if (dr.needMessageUpdate()) {
1520                 // Some messages may already be translated, so we cannot use _()
1521                 current_view_->message(makeDispatchMessage(
1522                                 translateIfPossible(dr.message()), cmd));
1523         }
1524 }
1525
1526
1527 void GuiApplication::gotoBookmark(unsigned int idx, bool openFile,
1528         bool switchToBuffer)
1529 {
1530         if (!theSession().bookmarks().isValid(idx))
1531                 return;
1532         BookmarksSection::Bookmark const & bm =
1533                 theSession().bookmarks().bookmark(idx);
1534         LASSERT(!bm.filename.empty(), return);
1535         string const file = bm.filename.absFileName();
1536         // if the file is not opened, open it.
1537         if (!theBufferList().exists(bm.filename)) {
1538                 if (openFile)
1539                         dispatch(FuncRequest(LFUN_FILE_OPEN, file));
1540                 else
1541                         return;
1542         }
1543         // open may fail, so we need to test it again
1544         if (!theBufferList().exists(bm.filename))
1545                 return;
1546
1547         // bm can be changed when saving
1548         BookmarksSection::Bookmark tmp = bm;
1549
1550         // Special case idx == 0 used for back-from-back jump navigation
1551         if (idx == 0)
1552                 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
1553
1554         // if the current buffer is not that one, switch to it.
1555         BufferView * doc_bv = current_view_ ?
1556                 current_view_->documentBufferView() : nullptr;
1557         Cursor const * old = doc_bv ? &doc_bv->cursor() : nullptr;
1558         if (!doc_bv || doc_bv->buffer().fileName() != tmp.filename) {
1559                 if (switchToBuffer) {
1560                         dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
1561                         if (!current_view_)
1562                                 return;
1563                         doc_bv = current_view_->documentBufferView();
1564                 } else
1565                         return;
1566         }
1567
1568         // moveToPosition try paragraph id first and then paragraph (pit, pos).
1569         if (!doc_bv || !doc_bv->moveToPosition(
1570                         tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
1571                 return;
1572
1573         Cursor & cur = doc_bv->cursor();
1574         if (old && cur != *old)
1575                 notifyCursorLeavesOrEnters(*old, cur);
1576
1577         // bm changed
1578         if (idx == 0)
1579                 return;
1580
1581         // Cursor jump succeeded!
1582         pit_type new_pit = cur.pit();
1583         pos_type new_pos = cur.pos();
1584         int new_id = cur.paragraph().id();
1585
1586         // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
1587         // see http://www.lyx.org/trac/ticket/3092
1588         if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
1589                 || bm.top_id != new_id) {
1590                 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
1591                         new_pit, new_pos, new_id);
1592         }
1593 }
1594
1595 // This function runs "configure" and then rereads lyx.defaults to
1596 // reconfigure the automatic settings.
1597 void GuiApplication::reconfigure(string const & option)
1598 {
1599         // emit message signal.
1600         if (current_view_)
1601                 current_view_->message(_("Running configure..."));
1602
1603         // Run configure in user lyx directory
1604         string const lock_file = package().getConfigureLockName();
1605         int fd = fileLock(lock_file.c_str());
1606         int const ret = package().reconfigureUserLyXDir(option);
1607         // emit message signal.
1608         if (current_view_)
1609                 current_view_->message(_("Reloading configuration..."));
1610         lyxrc.read(libFileSearch(QString(), "lyxrc.defaults"), false);
1611         // Re-read packages.lst
1612         LaTeXPackages::getAvailable();
1613         fileUnlock(fd, lock_file.c_str());
1614
1615         if (ret)
1616                 Alert::information(_("System reconfiguration failed"),
1617                            _("The system reconfiguration has failed.\n"
1618                                   "Default textclass is used but LyX may\n"
1619                                   "not be able to work properly.\n"
1620                                   "Please reconfigure again if needed."));
1621         else
1622                 Alert::information(_("System reconfigured"),
1623                            _("The system has been reconfigured.\n"
1624                              "You need to restart LyX to make use of any\n"
1625                              "updated document class specifications."));
1626 }
1627
1628 void GuiApplication::validateCurrentView()
1629 {
1630         if (!d->views_.empty() && !current_view_) {
1631                 // currently at least one view exists but no view has the focus.
1632                 // choose the last view to make it current.
1633                 // a view without any open document is preferred.
1634                 GuiView * candidate = nullptr;
1635                 QHash<int, GuiView *>::const_iterator it = d->views_.begin();
1636                 QHash<int, GuiView *>::const_iterator end = d->views_.end();
1637                 for (; it != end; ++it) {
1638                         candidate = *it;
1639                         if (!candidate->documentBufferView())
1640                                 break;
1641                 }
1642                 setCurrentView(candidate);
1643         }
1644 }
1645
1646 void GuiApplication::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1647 {
1648         string const argument = to_utf8(cmd.argument());
1649         FuncCode const action = cmd.action();
1650
1651         LYXERR(Debug::ACTION, "cmd: " << cmd);
1652
1653         // we have not done anything wrong yet.
1654         dr.setError(false);
1655
1656         FuncStatus const flag = getStatus(cmd);
1657         if (!flag.enabled()) {
1658                 // We cannot use this function here
1659                 LYXERR(Debug::ACTION, "action "
1660                        << lyxaction.getActionName(action)
1661                        << " [" << action << "] is disabled at this location");
1662                 dr.setMessage(flag.message());
1663                 dr.setError(true);
1664                 dr.dispatched(false);
1665                 dr.screenUpdate(Update::None);
1666                 dr.clearBufferUpdate();
1667                 return;
1668         };
1669
1670         if (cmd.origin() == FuncRequest::LYXSERVER) {
1671                 if (current_view_ && current_view_->currentBufferView())
1672                         current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1673                 // we will also need to redraw the screen at the end
1674                 dr.screenUpdate(Update::FitCursor);
1675         }
1676
1677         // Assumes that the action will be dispatched.
1678         dr.dispatched(true);
1679
1680         switch (cmd.action()) {
1681
1682         case LFUN_WINDOW_NEW:
1683                 createView(toqstr(cmd.argument()));
1684                 break;
1685
1686         case LFUN_WINDOW_CLOSE:
1687                 // FIXME: this is done also in GuiView::closeBuffer()!
1688                 // update bookmark pit of the current buffer before window close
1689                 for (size_t i = 1; i < theSession().bookmarks().size(); ++i)
1690                         gotoBookmark(i, false, false);
1691                 // clear the last opened list, because
1692                 // maybe this will end the session
1693                 theSession().lastOpened().clear();
1694                 // check for valid current_view_
1695                 validateCurrentView();
1696                 if (current_view_)
1697                         current_view_->closeScheduled();
1698                 break;
1699
1700         case LFUN_LYX_QUIT:
1701                 // quitting is triggered by the gui code
1702                 // (leaving the event loop).
1703                 if (current_view_)
1704                         current_view_->message(from_utf8(N_("Exiting.")));
1705                 if (closeAllViews())
1706                         quit();
1707                 break;
1708
1709         case LFUN_SCREEN_FONT_UPDATE: {
1710                 // handle the screen font changes.
1711                 /* FIXME: this only updates the current document, whereas all
1712                  * documents should see their metrics updated.
1713                  */
1714                 d->font_loader_.update();
1715                 dr.screenUpdate(Update::Force | Update::FitCursor);
1716                 break;
1717         }
1718
1719         case LFUN_BUFFER_NEW:
1720                 validateCurrentView();
1721                 if (!current_view_
1722                    || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != nullptr)) {
1723                         createView(QString(), false); // keep hidden
1724                         current_view_->newDocument(to_utf8(cmd.argument()));
1725                         current_view_->show();
1726                         setActiveWindow(current_view_);
1727                 } else {
1728                         current_view_->newDocument(to_utf8(cmd.argument()));
1729                 }
1730                 break;
1731
1732         case LFUN_BUFFER_NEW_TEMPLATE: {
1733                 string const file = (cmd.getArg(0) == "newfile") ? string() : cmd.getArg(0);
1734                 string const temp = cmd.getArg(1);
1735                 validateCurrentView();
1736                 if (!current_view_
1737                    || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != nullptr)) {
1738                         createView();
1739                         current_view_->newDocument(file, temp, true);
1740                         if (!current_view_->documentBufferView())
1741                                 current_view_->close();
1742                 } else {
1743                         current_view_->newDocument(file, temp, true);
1744                 }
1745                 break;
1746         }
1747
1748         case LFUN_FILE_OPEN: {
1749                 // FIXME: normally the code below is not needed, since getStatus makes sure that
1750                 //   current_view_ is not null.
1751                 validateCurrentView();
1752                 // FIXME: create a new method shared with LFUN_HELP_OPEN.
1753                 string const fname = to_utf8(cmd.argument());
1754                 bool const is_open = FileName::isAbsolute(fname)
1755                         && theBufferList().getBuffer(FileName(fname));
1756                 if (!current_view_
1757                     || (!lyxrc.open_buffers_in_tabs
1758                         && current_view_->documentBufferView() != nullptr
1759                         && !is_open)) {
1760                         // We want the ui session to be saved per document and not per
1761                         // window number. The filename crc is a good enough identifier.
1762                         createView(support::checksum(fname));
1763                         current_view_->openDocument(fname);
1764                         if (!current_view_->documentBufferView())
1765                                 current_view_->close();
1766                         else if (cmd.origin() == FuncRequest::LYXSERVER) {
1767                                 current_view_->raise();
1768                                 current_view_->activateWindow();
1769                                 current_view_->showNormal();
1770                         }
1771                 } else {
1772                         current_view_->openDocument(fname);
1773                         if (cmd.origin() == FuncRequest::LYXSERVER) {
1774                                 current_view_->raise();
1775                                 current_view_->activateWindow();
1776                                 current_view_->showNormal();
1777                         }
1778                 }
1779                 break;
1780         }
1781
1782         case LFUN_HELP_OPEN: {
1783                 // FIXME: create a new method shared with LFUN_FILE_OPEN.
1784                 if (current_view_ == nullptr)
1785                         createView();
1786                 string const arg = to_utf8(cmd.argument());
1787                 if (arg.empty()) {
1788                         current_view_->message(_("Missing argument"));
1789                         break;
1790                 }
1791                 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
1792                 if (fname.empty())
1793                         fname = i18nLibFileSearch("examples", arg, "lyx");
1794
1795                 if (fname.empty()) {
1796                         lyxerr << "LyX: unable to find documentation file `"
1797                                << arg << "'. Bad installation?" << endl;
1798                         break;
1799                 }
1800                 current_view_->message(bformat(_("Opening help file %1$s..."),
1801                                                makeDisplayPath(fname.absFileName())));
1802                 Buffer * buf = current_view_->loadDocument(fname, false);
1803                 if (buf)
1804                         buf->setReadonly(!current_view_->develMode());
1805                 break;
1806         }
1807
1808         case LFUN_SET_COLOR: {
1809                 string const lyx_name = cmd.getArg(0);
1810                 string x11_name = cmd.getArg(1);
1811                 string x11_darkname = cmd.getArg(2);
1812                 if (lyx_name.empty() || x11_name.empty()) {
1813                         if (current_view_)
1814                                 current_view_->message(
1815                                         _("Syntax: set-color <lyx_name> <x11_name> <x11_darkname>"));
1816                         break;
1817                 }
1818
1819 #if 0
1820                 // FIXME: The graphics cache no longer has a changeDisplay method.
1821                 string const graphicsbg = lcolor.getLyXName(Color_graphicsbg);
1822                 bool const graphicsbg_changed =
1823                                 lyx_name == graphicsbg && x11_name != graphicsbg;
1824                 if (graphicsbg_changed)
1825                         graphics::GCache::get().changeDisplay(true);
1826 #endif
1827
1828                 if (x11_darkname.empty() && colorCache().isDarkMode()) {
1829                         x11_darkname = x11_name;
1830                         x11_name.clear();
1831                 }
1832                 if (!lcolor.setColor(lyx_name, x11_name, x11_darkname)) {
1833                         if (current_view_)
1834                                 current_view_->message(
1835                                         bformat(_("Set-color \"%1$s\" failed "
1836                                         "- color is undefined or "
1837                                         "may not be redefined"),
1838                                         from_utf8(lyx_name)));
1839                         break;
1840                 }
1841                 // Make sure we don't keep old colors in cache.
1842                 d->color_cache_.clear();
1843                 // Update the current view
1844                 lyx::dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
1845                 break;
1846         }
1847
1848         case LFUN_LYXRC_APPLY: {
1849                 // reset active key sequences, since the bindings
1850                 // are updated (bug 6064)
1851                 d->keyseq.reset();
1852                 LyXRC const lyxrc_orig = lyxrc;
1853
1854                 istringstream ss(to_utf8(cmd.argument()));
1855                 bool const success = lyxrc.read(ss);
1856
1857                 if (!success) {
1858                         lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1859                                         << "Unable to read lyxrc data"
1860                                         << endl;
1861                         break;
1862                 }
1863
1864                 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1865
1866                 // If the request comes from the minibuffer, then we can't reset
1867                 // the GUI, since that would destroy the minibuffer itself and
1868                 // cause a crash, since we are currently in one of the methods of
1869                 // GuiCommandBuffer. See bug #8540.
1870                 if (cmd.origin() != FuncRequest::COMMANDBUFFER)
1871                         resetGui();
1872                 // else
1873                 //   FIXME Unfortunately, that leaves a bug here, since we cannot
1874                 //   reset the GUI in this case. If the changes to lyxrc affected the
1875                 //   UI, then, nothing would happen. This seems fairly unlikely, but
1876                 //   it definitely is a bug.
1877
1878                 dr.forceBufferUpdate();
1879                 break;
1880         }
1881
1882         case LFUN_COMMAND_PREFIX:
1883                 dispatch(FuncRequest(LFUN_MESSAGE, d->keyseq.printOptions(true)));
1884                 break;
1885
1886         case LFUN_CANCEL: {
1887                 d->keyseq.reset();
1888                 d->meta_fake_bit = NoModifier;
1889                 GuiView * gv = currentView();
1890                 if (gv && gv->currentBufferView())
1891                         // cancel any selection
1892                         processFuncRequest(FuncRequest(LFUN_MARK_OFF));
1893                 dr.setMessage(from_ascii(N_("Cancel")));
1894                 break;
1895         }
1896         case LFUN_META_PREFIX:
1897                 d->meta_fake_bit = AltModifier;
1898                 dr.setMessage(d->keyseq.print(KeySequence::ForGui));
1899                 break;
1900
1901         // --- Menus -----------------------------------------------
1902         case LFUN_RECONFIGURE:
1903                 // argument is any additional parameter to the configure.py command
1904                 reconfigure(to_utf8(cmd.argument()));
1905                 break;
1906
1907         // --- lyxserver commands ----------------------------
1908         case LFUN_SERVER_GET_FILENAME: {
1909                 if (current_view_ && current_view_->documentBufferView()) {
1910                         docstring const fname = from_utf8(
1911                                 current_view_->documentBufferView()->buffer().absFileName());
1912                         dr.setMessage(fname);
1913                         LYXERR(Debug::INFO, "FNAME[" << fname << ']');
1914                 } else {
1915                         dr.setMessage(docstring());
1916                         LYXERR(Debug::INFO, "No current file for LFUN_SERVER_GET_FILENAME");
1917                 }
1918                 break;
1919         }
1920
1921         case LFUN_SERVER_NOTIFY: {
1922                 docstring const dispatch_buffer = d->keyseq.print(KeySequence::Portable);
1923                 dr.setMessage(dispatch_buffer);
1924                 theServer().notifyClient(to_utf8(dispatch_buffer));
1925                 break;
1926         }
1927
1928         case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1929                 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1930                 break;
1931
1932         case LFUN_REPEAT: {
1933                 // repeat command
1934                 string countstr;
1935                 string rest = split(argument, countstr, ' ');
1936                 int const count = convert<int>(countstr);
1937                 // an arbitrary number to limit number of iterations
1938                 int const max_iter = 10000;
1939                 if (count > max_iter) {
1940                         dr.setMessage(bformat(_("Cannot iterate more than %1$d times"), max_iter));
1941                         dr.setError(true);
1942                 } else {
1943                         for (int i = 0; i < count; ++i) {
1944                                 FuncRequest lfun = lyxaction.lookupFunc(rest);
1945                                 lfun.allowAsync(false);
1946                                 dispatch(lfun);
1947                         }
1948                 }
1949                 break;
1950         }
1951
1952         case LFUN_COMMAND_SEQUENCE: {
1953                 // argument contains ';'-terminated commands
1954                 string arg = argument;
1955                 // FIXME: this LFUN should also work without any view.
1956                 Buffer * buffer = (current_view_ && current_view_->documentBufferView())
1957                                   ? &(current_view_->documentBufferView()->buffer()) : nullptr;
1958                 // This handles undo groups automagically
1959                 UndoGroupHelper ugh(buffer);
1960                 while (!arg.empty()) {
1961                         string first;
1962                         arg = split(arg, first, ';');
1963                         FuncRequest func(lyxaction.lookupFunc(first));
1964                         func.allowAsync(false);
1965                         func.setOrigin(cmd.origin());
1966                         dispatch(func);
1967                 }
1968                 break;
1969         }
1970
1971         case LFUN_BUFFER_FORALL: {
1972                 FuncRequest funcToRun = lyxaction.lookupFunc(cmd.getLongArg(0));
1973                 funcToRun.allowAsync(false);
1974
1975                 map<Buffer *, GuiView *> views_lVisible;
1976                 map<GuiView *, Buffer *> activeBuffers;
1977
1978                 QList<GuiView *> allViews = d->views_.values();
1979
1980                 // this for does not modify any buffer. It just collects info on local
1981                 // visibility of buffers and on which buffer is active in each view.
1982                 Buffer * const last = theBufferList().last();
1983                 for(GuiView * view : allViews) {
1984                         // all of the buffers might be locally hidden. That is, there is no
1985                         // active buffer.
1986                         if (!view || !view->currentBufferView())
1987                                 activeBuffers[view] = nullptr;
1988                         else
1989                                 activeBuffers[view] = &view->currentBufferView()->buffer();
1990
1991                         // find out if each is locally visible or locally hidden.
1992                         // we don't use a for loop as the buffer list cycles.
1993                         Buffer * b = theBufferList().first();
1994                         while (true) {
1995                                 bool const locallyVisible = view && view->workArea(*b);
1996                                 if (locallyVisible) {
1997                                         bool const exists_ = (views_lVisible.find(b) != views_lVisible.end());
1998                                         // only need to overwrite/add if we don't already know a buffer is globally
1999                                         // visible or we do know but we would prefer to dispatch LFUN from the
2000                                         // current view because of cursor position issues.
2001                                         if (!exists_ || (exists_ && views_lVisible[b] != current_view_))
2002                                                 views_lVisible[b] = view;
2003                                 }
2004                                 if (b == last)
2005                                         break;
2006                                 b = theBufferList().next(b);
2007                         }
2008                 }
2009
2010                 GuiView * const homeView = currentView();
2011                 Buffer * b = theBufferList().first();
2012                 Buffer * nextBuf = nullptr;
2013                 int numProcessed = 0;
2014                 while (true) {
2015                         if (b != last)
2016                                 nextBuf = theBufferList().next(b); // get next now bc LFUN might close current.
2017
2018                         bool const visible = (views_lVisible.find(b) != views_lVisible.end());
2019                         if (visible) {
2020                                 // first change to a view where b is locally visible, preferably current_view_.
2021                                 GuiView * const vLv = views_lVisible[b];
2022                                 vLv->setBuffer(b);
2023                                 lyx::dispatch(funcToRun);
2024                                 numProcessed++;
2025                         }
2026                         if (b == last)
2027                                 break;
2028                         b = nextBuf;
2029                 }
2030
2031                 // put things back to how they were (if possible).
2032                 for (GuiView * view : allViews) {
2033                         Buffer * originalBuf = activeBuffers[view];
2034                         // there might not have been an active buffer in this view or it might have been closed by the LFUN.
2035                         if (theBufferList().isLoaded(originalBuf))
2036                                 view->setBuffer(originalBuf);
2037                 }
2038                 homeView->setFocus();
2039
2040                 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d buffer(s)"), from_utf8(cmd.getLongArg(0)), numProcessed));
2041                 break;
2042         }
2043
2044         case LFUN_COMMAND_ALTERNATIVES: {
2045                 // argument contains ';'-terminated commands
2046                 string arg = argument;
2047                 while (!arg.empty()) {
2048                         string first;
2049                         arg = split(arg, first, ';');
2050                         FuncRequest func(lyxaction.lookupFunc(first));
2051                         func.setOrigin(cmd.origin());
2052                         FuncStatus const stat = getStatus(func);
2053                         if (stat.enabled()) {
2054                                 dispatch(func);
2055                                 break;
2056                         }
2057                 }
2058                 break;
2059         }
2060
2061         case LFUN_CALL: {
2062                 FuncRequest func;
2063                 if (theTopLevelCmdDef().lock(argument, func)) {
2064                         func.setOrigin(cmd.origin());
2065                         dispatch(func);
2066                         theTopLevelCmdDef().release(argument);
2067                 } else {
2068                         if (func.action() == LFUN_UNKNOWN_ACTION) {
2069                                 // unknown command definition
2070                                 lyxerr << "Warning: unknown command definition `"
2071                                                 << argument << "'"
2072                                                 << endl;
2073                         } else {
2074                                 // recursion detected
2075                                 lyxerr << "Warning: Recursion in the command definition `"
2076                                                 << argument << "' detected"
2077                                                 << endl;
2078                         }
2079                 }
2080                 break;
2081         }
2082
2083         case LFUN_IF_RELATIVES: {
2084                 string const lfun = to_utf8(cmd.argument());
2085                 FuncRequest func(lyxaction.lookupFunc(lfun));
2086                 func.setOrigin(cmd.origin());
2087                 FuncStatus const stat = getStatus(func);
2088                 if (stat.enabled()) {
2089                         dispatch(func);
2090                         break;
2091                 }
2092                 break;
2093         }
2094
2095         case LFUN_PREFERENCES_SAVE:
2096                 lyxrc.write(support::makeAbsPath("preferences",
2097                         package().user_support().absFileName()), false);
2098                 break;
2099
2100         case LFUN_BUFFER_SAVE_AS_DEFAULT: {
2101                 string const fname = addName(addPath(package().user_support().absFileName(),
2102                         "templates/"), "defaults.lyx");
2103                 Buffer defaults(fname);
2104
2105                 istringstream ss(argument);
2106                 Lexer lex;
2107                 lex.setStream(ss);
2108
2109                 // See #9236
2110                 // We need to make sure that, after we recreat the DocumentClass,
2111                 // which we do in readHeader, we apply it to the document itself.
2112                 DocumentClassConstPtr olddc = defaults.params().documentClassPtr();
2113                 int const unknown_tokens = defaults.readHeader(lex);
2114                 DocumentClassConstPtr newdc = defaults.params().documentClassPtr();
2115                 ErrorList el;
2116                 InsetText & theinset = static_cast<InsetText &>(defaults.inset());
2117                 cap::switchBetweenClasses(olddc, newdc, theinset, el);
2118
2119                 if (unknown_tokens != 0) {
2120                         lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
2121                                << unknown_tokens << " unknown token"
2122                                << (unknown_tokens == 1 ? "" : "s")
2123                                << endl;
2124                 }
2125
2126                 if (defaults.writeFile(FileName(defaults.absFileName())))
2127                         dr.setMessage(bformat(_("Document defaults saved in %1$s"),
2128                                               makeDisplayPath(fname)));
2129                 else {
2130                         dr.setError(true);
2131                         dr.setMessage(from_ascii(N_("Unable to save document defaults")));
2132                 }
2133                 break;
2134         }
2135
2136         case LFUN_BOOKMARK_GOTO:
2137                 // go to bookmark, open unopened file and switch to buffer if necessary
2138                 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
2139                 dr.screenUpdate(Update::Force | Update::FitCursor);
2140                 break;
2141
2142         case LFUN_BOOKMARK_CLEAR:
2143                 theSession().bookmarks().clear();
2144                 break;
2145
2146         case LFUN_DEBUG_LEVEL_SET:
2147                 lyxerr.setLevel(Debug::value(to_utf8(cmd.argument())));
2148                 break;
2149
2150         case LFUN_DIALOG_SHOW: {
2151                 string const name = cmd.getArg(0);
2152
2153                 if ( name == "aboutlyx"
2154                         || name == "prefs"
2155                         || name == "texinfo"
2156                         || name == "progress"
2157                         || name == "compare")
2158                 {
2159                         // work around: on Mac OS the application
2160                         // is not terminated when closing the last view.
2161                         // Create a new one to be able to dispatch the
2162                         // LFUN_DIALOG_SHOW to this view.
2163                         if (current_view_ == nullptr)
2164                                 createView();
2165                 }
2166         }
2167         // fall through
2168         default:
2169                 // The LFUN must be for one of GuiView, BufferView, Buffer or Cursor;
2170                 // let's try that:
2171                 if (current_view_)
2172                         current_view_->dispatch(cmd, dr);
2173                 break;
2174         }
2175
2176         if (cmd.origin() == FuncRequest::LYXSERVER)
2177                 updateCurrentView(cmd, dr);
2178 }
2179
2180
2181 docstring GuiApplication::viewStatusMessage()
2182 {
2183         // When meta-fake key is pressed, show the key sequence so far + "M-".
2184         if (d->meta_fake_bit != NoModifier)
2185                 return d->keyseq.print(KeySequence::ForGui) + "M-";
2186
2187         // Else, when a non-complete key sequence is pressed,
2188         // show the available options.
2189         if (d->keyseq.length() > 0 && !d->keyseq.deleted())
2190                 return d->keyseq.printOptions(true);
2191
2192         return docstring();
2193 }
2194
2195
2196 string GuiApplication::inputLanguageCode() const
2197 {
2198 #if (QT_VERSION < 0x050000)
2199         QLocale loc = keyboardInputLocale();
2200 #else
2201         QLocale loc = inputMethod()->locale();
2202 #endif
2203         //LYXERR0("input lang = " << fromqstr(loc.name()));
2204         return loc.name() == "C" ? "en_US" : fromqstr(loc.name());
2205 }
2206
2207
2208 void GuiApplication::onLocaleChanged()
2209 {
2210         //LYXERR0("Change language to " << inputLanguage()->lang());
2211         if (currentView() && currentView()->currentBufferView())
2212                 currentView()->currentBufferView()->cursor().setLanguageFromInput();
2213 }
2214
2215
2216 void GuiApplication::handleKeyFunc(FuncCode action)
2217 {
2218         char_type c = 0;
2219
2220         if (d->keyseq.length())
2221                 c = 0;
2222         GuiView * gv = currentView();
2223         LASSERT(gv && gv->currentBufferView(), return);
2224         BufferView * bv = gv->currentBufferView();
2225         bv->getIntl().getTransManager().deadkey(
2226                 c, get_accent(action).accent, bv->cursor().innerText(),
2227                 bv->cursor());
2228         // Need to clear, in case the minibuffer calls these
2229         // actions
2230         d->keyseq.clear();
2231         // copied verbatim from do_accent_char
2232         bv->cursor().resetAnchor();
2233 }
2234
2235
2236 //Keep this in sync with GuiApplication::processKeySym below
2237 bool GuiApplication::queryKeySym(KeySymbol const & keysym,
2238                                  KeyModifier state) const
2239 {
2240         // Do nothing if we have nothing
2241         if (!keysym.isOK() || keysym.isModifier())
2242                 return false;
2243         // Do a one-deep top-level lookup for cancel and meta-fake keys.
2244         KeySequence seq;
2245         FuncRequest func = seq.addkey(keysym, state);
2246         // When not cancel or meta-fake, do the normal lookup.
2247         if ((func.action() != LFUN_CANCEL) && (func.action() != LFUN_META_PREFIX)) {
2248                 seq = d->keyseq;
2249                 func = seq.addkey(keysym, (state | d->meta_fake_bit));
2250         }
2251         // Maybe user can only reach the key via holding down shift.
2252         // Let's see. But only if shift is the only modifier
2253         if (func.action() == LFUN_UNKNOWN_ACTION && state == ShiftModifier)
2254                 // If addkey looked up a command and did not find further commands then
2255                 // seq has been reset at this point
2256                 func = seq.addkey(keysym, NoModifier);
2257
2258         LYXERR(Debug::KEY, " Key (queried) [action=" << func.action() << "]["
2259                << seq.print(KeySequence::Portable) << ']');
2260         return func.action() != LFUN_UNKNOWN_ACTION;
2261 }
2262
2263
2264 //Keep this in sync with GuiApplication::queryKeySym above
2265 void GuiApplication::processKeySym(KeySymbol const & keysym, KeyModifier state)
2266 {
2267         LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
2268
2269         // Do nothing if we have nothing (JMarc)
2270         if (!keysym.isOK() || keysym.isModifier()) {
2271                 if (!keysym.isOK())
2272                         LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
2273                 if (current_view_)
2274                         current_view_->restartCaret();
2275                 return;
2276         }
2277
2278         char_type encoded_last_key = keysym.getUCSEncoded();
2279
2280         // Do a one-deep top-level lookup for
2281         // cancel and meta-fake keys. RVDK_PATCH_5
2282         d->cancel_meta_seq.reset();
2283
2284         FuncRequest func = d->cancel_meta_seq.addkey(keysym, state);
2285         LYXERR(Debug::KEY, "action first set to [" << func.action() << ']');
2286
2287         // When not cancel or meta-fake, do the normal lookup.
2288         // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
2289         // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
2290         if ((func.action() != LFUN_CANCEL) && (func.action() != LFUN_META_PREFIX)) {
2291                 // remove Caps Lock and Mod2 as a modifiers
2292                 func = d->keyseq.addkey(keysym, (state | d->meta_fake_bit));
2293                 LYXERR(Debug::KEY, "action now set to [" << func.action() << ']');
2294         }
2295
2296         // Don't remove this unless you know what you are doing.
2297         d->meta_fake_bit = NoModifier;
2298
2299         // Can this happen now ?
2300         if (func.action() == LFUN_NOACTION)
2301                 func = FuncRequest(LFUN_COMMAND_PREFIX);
2302
2303         LYXERR(Debug::KEY, " Key [action=" << func.action() << "]["
2304                 << d->keyseq.print(KeySequence::Portable) << ']');
2305
2306         // already here we know if it any point in going further
2307         // why not return already here if action == -1 and
2308         // num_bytes == 0? (Lgb)
2309
2310         if (d->keyseq.length() > 1 && current_view_)
2311                 current_view_->message(d->keyseq.print(KeySequence::ForGui));
2312
2313
2314         // Maybe user can only reach the key via holding down shift.
2315         // Let's see. But only if shift is the only modifier
2316         if (func.action() == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
2317                 LYXERR(Debug::KEY, "Trying without shift");
2318                 // If addkey looked up a command and did not find further commands then
2319                 // seq has been reset at this point
2320                 func = d->keyseq.addkey(keysym, NoModifier);
2321                 LYXERR(Debug::KEY, "Action now " << func.action());
2322         }
2323
2324         if (func.action() == LFUN_UNKNOWN_ACTION) {
2325                 // We didn't match any of the key sequences.
2326                 // See if it's normal insertable text not already
2327                 // covered by a binding
2328                 if (keysym.isText() && d->keyseq.length() == 1) {
2329                         // Non-printable characters (such as ASCII control characters)
2330                         // must not be inserted (#5704)
2331                         if (!isPrintable(encoded_last_key)) {
2332                                 LYXERR(Debug::KEY, "Non-printable character! Omitting.");
2333                                 if (current_view_)
2334                                         current_view_->restartCaret();
2335                                 return;
2336                         }
2337                         // The following modifier check is not needed on Mac.
2338                         // The keysym is either not text or it is different
2339                         // from the non-modifier keysym. See #9875 for the
2340                         // broken alt-modifier effect of having this code active.
2341 #if !defined(Q_OS_MAC)
2342                         // If a non-Shift Modifier is used we have a non-bound key sequence
2343                         // (such as Alt+j = j). This should be omitted (#5575).
2344                         // On Windows, AltModifier and ControlModifier are both
2345                         // set when AltGr is pressed. Therefore, in order to not
2346                         // break AltGr-bound symbols (see #5575 for details),
2347                         // unbound Ctrl+Alt key sequences are allowed.
2348                         if ((state & AltModifier || state & ControlModifier || state & MetaModifier)
2349 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2350                             && !(state & AltModifier && state & ControlModifier)
2351 #endif
2352                             )
2353                         {
2354                                 if (current_view_) {
2355                                         current_view_->message(_("Unknown function."));
2356                                         current_view_->restartCaret();
2357                                 }
2358                                 return;
2359                         }
2360 #endif
2361                         // Since all checks above were passed, we now really have text that
2362                         // is to be inserted (e.g., AltGr-bound symbols). Thus change the
2363                         // func to LFUN_SELF_INSERT and thus cause the text to be inserted
2364                         // below.
2365                         LYXERR(Debug::KEY, "isText() is true, inserting.");
2366                         func = FuncRequest(LFUN_SELF_INSERT, FuncRequest::KEYBOARD);
2367                 } else {
2368                         LYXERR(Debug::KEY, "Unknown Action and not isText() -- giving up");
2369                         if (current_view_) {
2370                                 current_view_->message(_("Unknown function."));
2371                                 current_view_->restartCaret();
2372                         }
2373                         return;
2374                 }
2375         }
2376
2377         if (func.action() == LFUN_SELF_INSERT) {
2378                 if (encoded_last_key != 0) {
2379                         docstring const arg(1, encoded_last_key);
2380                         processFuncRequest(FuncRequest(LFUN_SELF_INSERT, arg,
2381                                              FuncRequest::KEYBOARD));
2382                         LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
2383                 }
2384         } else
2385                 processFuncRequest(func);
2386 }
2387
2388
2389 void GuiApplication::processFuncRequest(FuncRequest const & func)
2390 {
2391         lyx::dispatch(func);
2392 }
2393
2394
2395 void GuiApplication::processFuncRequestAsync(FuncRequest const & func)
2396 {
2397         addToFuncRequestQueue(func);
2398         processFuncRequestQueueAsync();
2399 }
2400
2401
2402 void GuiApplication::processFuncRequestQueue()
2403 {
2404         while (!d->func_request_queue_.empty()) {
2405                 // take the item from the stack _before_ processing the
2406                 // request in order to avoid race conditions from nested
2407                 // or parallel requests (see #10406)
2408                 FuncRequest const fr(d->func_request_queue_.front());
2409                 d->func_request_queue_.pop();
2410                 processFuncRequest(fr);
2411         }
2412 }
2413
2414
2415 void GuiApplication::processFuncRequestQueueAsync()
2416 {
2417         QTimer::singleShot(0, this, SLOT(slotProcessFuncRequestQueue()));
2418 }
2419
2420
2421 void GuiApplication::addToFuncRequestQueue(FuncRequest const & func)
2422 {
2423         d->func_request_queue_.push(func);
2424 }
2425
2426
2427 void GuiApplication::resetGui()
2428 {
2429         // Set the language defined by the user.
2430         setGuiLanguage();
2431
2432         // Read menus
2433         if (!readUIFile(toqstr(lyxrc.ui_file)))
2434                 // Gives some error box here.
2435                 return;
2436
2437         if (d->global_menubar_)
2438                 d->menus_.fillMenuBar(d->global_menubar_, nullptr, false);
2439
2440         QHash<int, GuiView *>::iterator it;
2441         for (it = d->views_.begin(); it != d->views_.end(); ++it) {
2442                 GuiView * gv = *it;
2443                 setCurrentView(gv);
2444                 gv->setLayoutDirection(layoutDirection());
2445                 gv->resetDialogs();
2446         }
2447
2448         processFuncRequest(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
2449 }
2450
2451
2452 bool GuiApplication::rtlContext() const
2453 {
2454         if (current_view_ && current_view_->currentBufferView()) {
2455                 BufferView const * bv = current_view_->currentBufferView();
2456                 return bv->cursor().innerParagraph().isRTL(bv->buffer().params());
2457         } else
2458                 return layoutDirection() == Qt::RightToLeft;
2459 }
2460
2461
2462 void GuiApplication::createView(int view_id)
2463 {
2464         createView(QString(), true, view_id);
2465 }
2466
2467
2468 void GuiApplication::createView(QString const & geometry_arg, bool autoShow,
2469         int view_id)
2470 {
2471         // release the keyboard which might have been grabbed by the global
2472         // menubar on Mac to catch shortcuts even without any GuiView.
2473         if (d->global_menubar_)
2474                 d->global_menubar_->releaseKeyboard();
2475
2476         // create new view
2477         int id = view_id;
2478         while (d->views_.find(id) != d->views_.end())
2479                 id++;
2480
2481         LYXERR(Debug::GUI, "About to create new window with ID " << id);
2482         GuiView * view = new GuiView(id);
2483         // `view' is the new current_view_. Tell coverity that is is not 0.
2484         LATTEST(current_view_);
2485         // register view
2486         d->views_[id] = view;
2487
2488         if (autoShow) {
2489                 view->show();
2490                 setActiveWindow(view);
2491         }
2492
2493         if (!geometry_arg.isEmpty()) {
2494 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2495                 int x, y;
2496                 int w, h;
2497                 QChar sx, sy;
2498                 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)){0,1}(?:([+-][0-9]*)){0,1}" );
2499                 re.indexIn(geometry_arg);
2500                 w = re.cap(1).toInt();
2501                 h = re.cap(2).toInt();
2502                 x = re.cap(3).toInt();
2503                 y = re.cap(4).toInt();
2504                 sx = re.cap(3).isEmpty() ? '+' : re.cap(3).at(0);
2505                 sy = re.cap(4).isEmpty() ? '+' : re.cap(4).at(0);
2506                 // Set initial geometry such that we can get the frame size.
2507                 view->setGeometry(x, y, w, h);
2508                 int framewidth = view->geometry().x() - view->x();
2509                 int titleheight = view->geometry().y() - view->y();
2510                 // Negative displacements must be interpreted as distances
2511                 // from the right or bottom screen borders.
2512                 if (sx == '-' || sy == '-') {
2513                         QRect rec = QApplication::desktop()->screenGeometry();
2514                         if (sx == '-')
2515                                 x += rec.width() - w - framewidth;
2516                         if (sy == '-')
2517                                 y += rec.height() - h - titleheight;
2518                         view->setGeometry(x, y, w, h);
2519                 }
2520                 // Make sure that the left and top frame borders are visible.
2521                 if (view->x() < 0 || view->y() < 0) {
2522                         if (view->x() < 0)
2523                                 x = framewidth;
2524                         if (view->y() < 0)
2525                                 y = titleheight;
2526                         view->setGeometry(x, y, w, h);
2527                 }
2528 #endif
2529         }
2530         view->setFocus();
2531 }
2532
2533
2534 bool GuiApplication::unhide(Buffer * buf)
2535 {
2536         if (!currentView())
2537                 return false;
2538         currentView()->setBuffer(buf, false);
2539         return true;
2540 }
2541
2542
2543 Clipboard & GuiApplication::clipboard()
2544 {
2545         return d->clipboard_;
2546 }
2547
2548
2549 Selection & GuiApplication::selection()
2550 {
2551         return d->selection_;
2552 }
2553
2554
2555 FontLoader & GuiApplication::fontLoader()
2556 {
2557         return d->font_loader_;
2558 }
2559
2560
2561 Toolbars const & GuiApplication::toolbars() const
2562 {
2563         return d->toolbars_;
2564 }
2565
2566
2567 Toolbars & GuiApplication::toolbars()
2568 {
2569         return d->toolbars_;
2570 }
2571
2572
2573 Menus const & GuiApplication::menus() const
2574 {
2575         return d->menus_;
2576 }
2577
2578
2579 Menus & GuiApplication::menus()
2580 {
2581         return d->menus_;
2582 }
2583
2584
2585 QList<int> GuiApplication::viewIds() const
2586 {
2587         return d->views_.keys();
2588 }
2589
2590
2591 ColorCache & GuiApplication::colorCache()
2592 {
2593         return d->color_cache_;
2594 }
2595
2596
2597 int GuiApplication::exec()
2598 {
2599         // asynchronously handle batch commands. This event will be in
2600         // the event queue in front of other asynchronous events. Hence,
2601         // we can assume in the latter that the gui is setup already.
2602         QTimer::singleShot(0, this, SLOT(execBatchCommands()));
2603
2604         return QApplication::exec();
2605 }
2606
2607
2608 void GuiApplication::exit(int status)
2609 {
2610         QApplication::exit(status);
2611 }
2612
2613
2614 void GuiApplication::setGuiLanguage()
2615 {
2616         setLocale();
2617         QLocale theLocale;
2618         // install translation file for Qt built-in dialogs
2619         QString const language_name = QString("qt_") + theLocale.name();
2620         // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
2621         // Short-named translator can be loaded from a long name, but not the
2622         // opposite. Therefore, long name should be used without truncation.
2623         // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
2624         if (!d->qt_trans_.load(language_name,
2625                         QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
2626                 LYXERR(Debug::LOCALE, "Could not find Qt translations for locale "
2627                         << language_name);
2628         } else {
2629                 LYXERR(Debug::LOCALE, "Successfully installed Qt translations for locale "
2630                         << language_name);
2631         }
2632
2633         switch (theLocale.language()) {
2634         case QLocale::Arabic :
2635         case QLocale::Hebrew :
2636         case QLocale::Persian :
2637         case QLocale::Urdu :
2638                 setLayoutDirection(Qt::RightToLeft);
2639                 break;
2640         default:
2641                 setLayoutDirection(Qt::LeftToRight);
2642         }
2643 }
2644
2645
2646 void GuiApplication::execBatchCommands()
2647 {
2648         setGuiLanguage();
2649
2650         // Read menus
2651         if (!readUIFile(toqstr(lyxrc.ui_file)))
2652                 // Gives some error box here.
2653                 return;
2654
2655 #ifdef Q_OS_MAC
2656 #if QT_VERSION > 0x040600
2657         setAttribute(Qt::AA_MacDontSwapCtrlAndMeta,lyxrc.mac_dontswap_ctrl_meta);
2658 #endif
2659 #if QT_VERSION > 0x050100
2660         setAttribute(Qt::AA_UseHighDpiPixmaps,true);
2661 #endif
2662         // Create the global default menubar which is shown for the dialogs
2663         // and if no GuiView is visible.
2664         // This must be done after the session was recovered to know the "last files".
2665         d->global_menubar_ = new QMenuBar(0);
2666         d->menus_.fillMenuBar(d->global_menubar_, 0, true);
2667 #endif
2668
2669         lyx::execBatchCommands();
2670 }
2671
2672
2673 QAbstractItemModel * GuiApplication::languageModel()
2674 {
2675         if (d->language_model_)
2676                 return d->language_model_;
2677
2678         QStandardItemModel * lang_model = new QStandardItemModel(this);
2679         lang_model->insertColumns(0, 3);
2680         QIcon speller(getPixmap("images/", "dialog-show_spellchecker", "svgz,png"));
2681         QIcon saurus(getPixmap("images/", "thesaurus-entry", "svgz,png"));
2682         Languages::const_iterator it = lyx::languages.begin();
2683         Languages::const_iterator end = lyx::languages.end();
2684         for (; it != end; ++it) {
2685                 int current_row = lang_model->rowCount();
2686                 lang_model->insertRows(current_row, 1);
2687                 QModelIndex pl_item = lang_model->index(current_row, 0);
2688                 QModelIndex sp_item = lang_model->index(current_row, 1);
2689                 QModelIndex th_item = lang_model->index(current_row, 2);
2690                 lang_model->setData(pl_item, qt_(it->second.display()), Qt::DisplayRole);
2691                 lang_model->setData(pl_item, toqstr(it->second.lang()), Qt::UserRole);
2692                 lang_model->setData(sp_item, qt_(it->second.display()), Qt::DisplayRole);
2693                 lang_model->setData(sp_item, toqstr(it->second.lang()), Qt::UserRole);
2694                 if (theSpellChecker() && theSpellChecker()->hasDictionary(&it->second))
2695                         lang_model->setData(sp_item, speller, Qt::DecorationRole);
2696                 lang_model->setData(th_item, qt_(it->second.display()), Qt::DisplayRole);
2697                 lang_model->setData(th_item, toqstr(it->second.lang()), Qt::UserRole);
2698                 if (thesaurus.thesaurusInstalled(from_ascii(it->second.code())))
2699                         lang_model->setData(th_item, saurus, Qt::DecorationRole);
2700         }
2701         d->language_model_ = new QSortFilterProxyModel(this);
2702         d->language_model_->setSourceModel(lang_model);
2703         d->language_model_->setSortLocaleAware(true);
2704         return d->language_model_;
2705 }
2706
2707
2708 void GuiApplication::restoreGuiSession()
2709 {
2710         if (!lyxrc.load_session)
2711                 return;
2712
2713         Session & session = theSession();
2714         LastOpenedSection::LastOpened const & lastopened =
2715                 session.lastOpened().getfiles();
2716
2717         validateCurrentView();
2718
2719         FileName active_file;
2720         // do not add to the lastfile list since these files are restored from
2721         // last session, and should be already there (regular files), or should
2722         // not be added at all (help files).
2723         for (auto const & last : lastopened) {
2724                 FileName const & file_name = last.file_name;
2725                 if (!current_view_ || (!lyxrc.open_buffers_in_tabs
2726                           && current_view_->documentBufferView() != nullptr)) {
2727                         string const & fname = file_name.absFileName();
2728                         createView(support::checksum(fname));
2729                 }
2730                 current_view_->loadDocument(file_name, false);
2731
2732                 if (last.active)
2733                         active_file = file_name;
2734         }
2735
2736         // Restore last active buffer
2737         Buffer * buffer = theBufferList().getBuffer(active_file);
2738         if (buffer && current_view_)
2739                 current_view_->setBuffer(buffer);
2740
2741         // clear this list to save a few bytes of RAM
2742         session.lastOpened().clear();
2743 }
2744
2745
2746 QString const GuiApplication::romanFontName()
2747 {
2748         QFont font;
2749         font.setStyleHint(QFont::Serif);
2750         font.setFamily("serif");
2751
2752         return QFontInfo(font).family();
2753 }
2754
2755
2756 QString const GuiApplication::sansFontName()
2757 {
2758         QFont font;
2759         font.setStyleHint(QFont::SansSerif);
2760         font.setFamily("sans");
2761
2762         return QFontInfo(font).family();
2763 }
2764
2765
2766 QString const GuiApplication::typewriterFontName()
2767 {
2768         return QFontInfo(typewriterSystemFont()).family();
2769 }
2770
2771
2772 namespace {
2773         // We cannot use QFont::fixedPitch() because it doesn't
2774         // return the fact but only if it is requested.
2775         static bool isFixedPitch(const QFont & font) {
2776                 const QFontInfo fi(font);
2777                 return fi.fixedPitch();
2778         }
2779 } // namespace
2780
2781
2782 QFont const GuiApplication::typewriterSystemFont()
2783 {
2784 #if QT_VERSION >= 0x050200
2785         QFont font = QFontDatabase::systemFont(QFontDatabase::FixedFont);
2786 #else
2787         QFont font("monospace");
2788 #endif
2789         if (!isFixedPitch(font)) {
2790                 // try to enforce a real monospaced font
2791                 font.setStyleHint(QFont::Monospace);
2792                 if (!isFixedPitch(font)) {
2793                         font.setStyleHint(QFont::TypeWriter);
2794                         if (!isFixedPitch(font)) font.setFamily("courier");
2795                 }
2796         }
2797 #ifdef Q_OS_MAC
2798         // On a Mac the result is too small and it's not practical to
2799         // rely on Qtconfig utility to change the system settings of Qt.
2800         font.setPointSize(12);
2801 #endif
2802         return font;
2803 }
2804
2805
2806 void GuiApplication::handleRegularEvents()
2807 {
2808         ForkedCallsController::handleCompletedProcesses();
2809 }
2810
2811
2812 bool GuiApplication::event(QEvent * e)
2813 {
2814         switch(e->type()) {
2815         case QEvent::FileOpen: {
2816                 // Open a file; this happens only on Mac OS X for now.
2817                 //
2818                 // We do this asynchronously because on startup the batch
2819                 // commands are not executed here yet and the gui is not ready
2820                 // therefore.
2821                 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
2822                 FuncRequest const fr(LFUN_FILE_OPEN, qstring_to_ucs4(foe->file()));
2823                 processFuncRequestAsync(fr);
2824                 e->accept();
2825                 return true;
2826         }
2827 #if (QT_VERSION < 0x050000)
2828         // Qt5 uses a signal for that, see above.
2829         case QEvent::KeyboardLayoutChange:
2830                 //LYXERR0("keyboard change");
2831                 if (currentView() && currentView()->currentBufferView())
2832                         currentView()->currentBufferView()->cursor().setLanguageFromInput();
2833                 e->accept();
2834                 return true;
2835 #endif
2836         default:
2837                 return QApplication::event(e);
2838         }
2839 }
2840
2841
2842 bool GuiApplication::notify(QObject * receiver, QEvent * event)
2843 {
2844         try {
2845                 return QApplication::notify(receiver, event);
2846         }
2847         catch (ExceptionMessage const & e) {
2848                 switch(e.type_) {
2849                 case ErrorException:
2850                         emergencyCleanup();
2851                         setQuitOnLastWindowClosed(false);
2852                         closeAllViews();
2853                         Alert::error(e.title_, e.details_);
2854 #ifndef NDEBUG
2855                         // Properly crash in debug mode in order to get a useful backtrace.
2856                         abort();
2857 #endif
2858                         // In release mode, try to exit gracefully.
2859                         this->exit(1);
2860                         // FIXME: GCC 7 thinks we can fall through here. Can we?
2861                         // fall through
2862                 case BufferException: {
2863                         if (!current_view_ || !current_view_->documentBufferView())
2864                                 return false;
2865                         Buffer * buf = &current_view_->documentBufferView()->buffer();
2866                         docstring details = e.details_ + '\n';
2867                         details += buf->emergencyWrite();
2868                         theBufferList().release(buf);
2869                         details += "\n" + _("The current document was closed.");
2870                         Alert::error(e.title_, details);
2871                         return false;
2872                 }
2873                 case WarningException:
2874                         Alert::warning(e.title_, e.details_);
2875                         return false;
2876                 }
2877         }
2878         catch (exception const & e) {
2879                 docstring s = _("LyX has caught an exception, it will now "
2880                         "attempt to save all unsaved documents and exit."
2881                         "\n\nException: ");
2882                 s += from_ascii(e.what());
2883                 Alert::error(_("Software exception Detected"), s);
2884                 lyx_exit(1);
2885         }
2886         catch (...) {
2887                 docstring s = _("LyX has caught some really weird exception, it will "
2888                         "now attempt to save all unsaved documents and exit.");
2889                 Alert::error(_("Software exception Detected"), s);
2890                 lyx_exit(1);
2891         }
2892
2893         return false;
2894 }
2895
2896
2897 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
2898 {
2899         QColor const & qcol = d->color_cache_.get(col);
2900         if (!qcol.isValid()) {
2901                 rgbcol.r = 0;
2902                 rgbcol.g = 0;
2903                 rgbcol.b = 0;
2904                 return false;
2905         }
2906         rgbcol.r = qcol.red();
2907         rgbcol.g = qcol.green();
2908         rgbcol.b = qcol.blue();
2909         return true;
2910 }
2911
2912
2913 bool Application::getRgbColorUncached(ColorCode col, RGBColor & rgbcol)
2914 {
2915         QColor const qcol(lcolor.getX11HexName(col).c_str());
2916         if (!qcol.isValid()) {
2917                 rgbcol.r = 0;
2918                 rgbcol.g = 0;
2919                 rgbcol.b = 0;
2920                 return false;
2921         }
2922         rgbcol.r = qcol.red();
2923         rgbcol.g = qcol.green();
2924         rgbcol.b = qcol.blue();
2925         return true;
2926 }
2927
2928
2929 string const GuiApplication::hexName(ColorCode col)
2930 {
2931         return ltrim(fromqstr(d->color_cache_.get(col).name()), "#");
2932 }
2933
2934
2935 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
2936 {
2937         SocketNotifier * sn = new SocketNotifier(this, fd, func);
2938         d->socket_notifiers_[fd] = sn;
2939         connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
2940 }
2941
2942
2943 void GuiApplication::socketDataReceived(int fd)
2944 {
2945         d->socket_notifiers_[fd]->func_();
2946 }
2947
2948
2949 void GuiApplication::unregisterSocketCallback(int fd)
2950 {
2951         d->socket_notifiers_.take(fd)->setEnabled(false);
2952 }
2953
2954
2955 void GuiApplication::commitData(QSessionManager & sm)
2956 {
2957         /** The implementation is required to avoid an application exit
2958          ** when session state save is triggered by session manager.
2959          ** The default implementation sends a close event to all
2960          ** visible top level widgets when session management allows
2961          ** interaction.
2962          ** We are changing that to check the state of each buffer in all
2963          ** views and ask the users what to do if buffers are dirty.
2964          ** Furthermore, we save the session state.
2965          ** We do NOT close the views here since the user still can cancel
2966          ** the logout process (see #9277); also, this would hide LyX from
2967          ** an OSes own session handling (application restoration).
2968          **/
2969         #ifdef QT_NO_SESSIONMANAGER
2970                 #ifndef _MSC_VER
2971                         #warning Qt is compiled without session manager
2972                 #else
2973                         #pragma message("warning: Qt is compiled without session manager")
2974                 #endif
2975                 (void) sm;
2976         #else
2977                 if (sm.allowsInteraction() && !prepareAllViewsForLogout())
2978                         sm.cancel();
2979                 else
2980                         sm.release();
2981         #endif
2982 }
2983
2984
2985 void GuiApplication::unregisterView(GuiView * gv)
2986 {
2987         if(d->views_.contains(gv->id()) && d->views_.value(gv->id()) == gv) {
2988                 d->views_.remove(gv->id());
2989                 if (current_view_ == gv)
2990                         current_view_ = nullptr;
2991         }
2992 }
2993
2994
2995 bool GuiApplication::closeAllViews()
2996 {
2997         if (d->views_.empty())
2998                 return true;
2999
3000         // When a view/window was closed before without quitting LyX, there
3001         // are already entries in the lastOpened list.
3002         theSession().lastOpened().clear();
3003
3004         QList<GuiView *> const views = d->views_.values();
3005         for (GuiView * view : views) {
3006                 if (!view->closeScheduled())
3007                         return false;
3008         }
3009
3010         d->views_.clear();
3011         return true;
3012 }
3013
3014
3015 bool GuiApplication::prepareAllViewsForLogout()
3016 {
3017         if (d->views_.empty())
3018                 return true;
3019
3020         QList<GuiView *> const views = d->views_.values();
3021         for (GuiView * view : views) {
3022                 if (!view->prepareAllBuffersForLogout())
3023                         return false;
3024         }
3025
3026         return true;
3027 }
3028
3029
3030 GuiView & GuiApplication::view(int id) const
3031 {
3032         LAPPERR(d->views_.contains(id));
3033         return *d->views_.value(id);
3034 }
3035
3036
3037 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
3038 {
3039         QList<GuiView *> const views = d->views_.values();
3040         for (GuiView * view : views)
3041                 view->hideDialog(name, inset);
3042 }
3043
3044
3045 Buffer const * GuiApplication::updateInset(Inset const * inset) const
3046 {
3047         Buffer const * buf = nullptr;
3048         QHash<int, GuiView *>::const_iterator end = d->views_.end();
3049         for (QHash<int, GuiView *>::iterator it = d->views_.begin(); it != end; ++it) {
3050                 if (Buffer const * ptr = (*it)->updateInset(inset))
3051                         buf = ptr;
3052         }
3053         return buf;
3054 }
3055
3056
3057 bool GuiApplication::searchMenu(FuncRequest const & func,
3058         docstring_list & names) const
3059 {
3060         BufferView * bv = nullptr;
3061         if (current_view_)
3062                 bv = current_view_->currentBufferView();
3063         return d->menus_.searchMenu(func, names, bv);
3064 }
3065
3066
3067 bool GuiApplication::hasBufferView() const
3068 {
3069         return (current_view_ && current_view_->currentBufferView());
3070 }
3071
3072
3073 // Ensure that a file is read only once (prevents include loops)
3074 static QStringList uifiles;
3075 // store which ui files define Toolbars
3076 static QStringList toolbar_uifiles;
3077
3078
3079 GuiApplication::ReturnValues GuiApplication::readUIFile(FileName const & ui_path)
3080 {
3081         enum {
3082                 ui_menuset = 1,
3083                 ui_toolbars,
3084                 ui_toolbarset,
3085                 ui_include,
3086                 ui_format,
3087                 ui_last
3088         };
3089
3090         LexerKeyword uitags[] = {
3091                 { "format", ui_format },
3092                 { "include", ui_include },
3093                 { "menuset", ui_menuset },
3094                 { "toolbars", ui_toolbars },
3095                 { "toolbarset", ui_toolbarset }
3096         };
3097
3098         Lexer lex(uitags);
3099         lex.setFile(ui_path);
3100         if (!lex.isOK()) {
3101                 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
3102                                          << endl;
3103         }
3104
3105         if (lyxerr.debugging(Debug::PARSER))
3106                 lex.printTable(lyxerr);
3107
3108         bool error = false;
3109         // format before introduction of format tag
3110         unsigned int format = 0;
3111         while (lex.isOK()) {
3112                 int const status = lex.lex();
3113
3114                 // we have to do this check here, outside the switch,
3115                 // because otherwise we would start reading include files,
3116                 // e.g., if the first tag we hit was an include tag.
3117                 if (status == ui_format)
3118                         if (lex.next()) {
3119                                 format = lex.getInteger();
3120                                 continue;
3121                         }
3122
3123                 // this will trigger unless the first tag we hit is a format
3124                 // tag, with the right format.
3125                 if (format != LFUN_FORMAT)
3126                         return FormatMismatch;
3127
3128                 switch (status) {
3129                 case Lexer::LEX_FEOF:
3130                         continue;
3131
3132                 case ui_include: {
3133                         lex.next(true);
3134                         QString const file = toqstr(lex.getString());
3135                         bool const success = readUIFile(file, true);
3136                         if (!success) {
3137                                 LYXERR0("Failed to read included file: " << fromqstr(file));
3138                                 return ReadError;
3139                         }
3140                         break;
3141                 }
3142
3143                 case ui_menuset:
3144                         d->menus_.read(lex);
3145                         break;
3146
3147                 case ui_toolbarset:
3148                         d->toolbars_.readToolbars(lex);
3149                         break;
3150
3151                 case ui_toolbars:
3152                         d->toolbars_.readToolbarSettings(lex);
3153                         toolbar_uifiles.push_back(toqstr(ui_path.absFileName()));
3154                         break;
3155
3156                 default:
3157                         if (!rtrim(lex.getString()).empty())
3158                                 lex.printError("LyX::ReadUIFile: "
3159                                                "Unknown menu tag: `$$Token'");
3160                         else
3161                                 LYXERR0("Error with status: " << status);
3162                         error = true;
3163                         break;
3164                 }
3165
3166         }
3167         return (error ? ReadError : ReadOK);
3168 }
3169
3170
3171 bool GuiApplication::readUIFile(QString const & name, bool include)
3172 {
3173         LYXERR(Debug::INIT, "About to read " << name << "...");
3174
3175         FileName ui_path;
3176         if (include) {
3177                 ui_path = libFileSearch("ui", name, "inc");
3178                 if (ui_path.empty())
3179                         ui_path = libFileSearch("ui", changeExtension(name, "inc"));
3180         } else {
3181                 ui_path = libFileSearch("ui", name, "ui");
3182         }
3183
3184         if (ui_path.empty()) {
3185                 static const QString defaultUIFile = "default";
3186                 LYXERR(Debug::INIT, "Could not find " << name);
3187                 if (include) {
3188                         Alert::warning(_("Could not find UI definition file"),
3189                                 bformat(_("Error while reading the included file\n%1$s\n"
3190                                         "Please check your installation."), qstring_to_ucs4(name)));
3191                         return false;
3192                 }
3193                 if (name == defaultUIFile) {
3194                         LYXERR(Debug::INIT, "Could not find default UI file!!");
3195                         Alert::warning(_("Could not find default UI file"),
3196                                 _("LyX could not find the default UI file!\n"
3197                                   "Please check your installation."));
3198                         return false;
3199                 }
3200                 Alert::warning(_("Could not find UI definition file"),
3201                 bformat(_("Error while reading the configuration file\n%1$s\n"
3202                         "Falling back to default.\n"
3203                         "Please look under Tools>Preferences>User Interface and\n"
3204                         "check which User Interface file you are using."), qstring_to_ucs4(name)));
3205                 return readUIFile(defaultUIFile, false);
3206         }
3207
3208         QString const uifile = toqstr(ui_path.absFileName());
3209         if (uifiles.contains(uifile)) {
3210                 if (!include) {
3211                         // We are reading again the top uifile so reset the safeguard:
3212                         uifiles.clear();
3213                         d->menus_.reset();
3214                         d->toolbars_.reset();
3215                 } else {
3216                         LYXERR(Debug::INIT, "UI file '" << name << "' has been read already. "
3217                                 << "Is this an include loop?");
3218                         return false;
3219                 }
3220         }
3221         uifiles.push_back(uifile);
3222
3223         LYXERR(Debug::INIT, "Found " << name << " in " << ui_path);
3224
3225         ReturnValues retval = readUIFile(ui_path);
3226
3227         if (retval == FormatMismatch) {
3228                 LYXERR(Debug::FILES, "Converting ui file to format " << LFUN_FORMAT);
3229                 TempFile tmp("convertXXXXXX.ui");
3230                 FileName const tempfile = tmp.name();
3231                 bool const success = prefs2prefs(ui_path, tempfile, true);
3232                 if (!success) {
3233                         LYXERR0("Unable to convert " << ui_path.absFileName() <<
3234                                 " to format " << LFUN_FORMAT << ".");
3235                 } else {
3236                         retval = readUIFile(tempfile);
3237                 }
3238         }
3239
3240         if (retval != ReadOK) {
3241                 LYXERR0("Unable to read UI file: " << ui_path.absFileName());
3242                 return false;
3243         }
3244
3245         if (include)
3246                 return true;
3247
3248         QSettings settings;
3249         settings.beginGroup("ui_files");
3250         bool touched = false;
3251         for (int i = 0; i != uifiles.size(); ++i) {
3252                 QFileInfo fi(uifiles[i]);
3253                 QDateTime const date_value = fi.lastModified();
3254                 QString const name_key = QString::number(i);
3255                 // if an ui file which defines Toolbars has changed,
3256                 // we have to reset the settings
3257                 if (toolbar_uifiles.contains(uifiles[i])
3258                  && (!settings.contains(name_key)
3259                  || settings.value(name_key).toString() != uifiles[i]
3260                  || settings.value(name_key + "/date").toDateTime() != date_value)) {
3261                         touched = true;
3262                         settings.setValue(name_key, uifiles[i]);
3263                         settings.setValue(name_key + "/date", date_value);
3264                 }
3265         }
3266         settings.endGroup();
3267         if (touched)
3268                 settings.remove("views");
3269
3270         return true;
3271 }
3272
3273
3274 void GuiApplication::onLastWindowClosed()
3275 {
3276         if (d->global_menubar_)
3277                 d->global_menubar_->grabKeyboard();
3278 }
3279
3280
3281 void GuiApplication::startLongOperation() {
3282         d->key_checker_.start();
3283 }
3284
3285
3286 bool GuiApplication::longOperationCancelled() {
3287         return d->key_checker_.pressed();
3288 }
3289
3290
3291 void GuiApplication::stopLongOperation() {
3292         d->key_checker_.stop();
3293 }
3294
3295
3296 bool GuiApplication::longOperationStarted() {
3297         return d->key_checker_.started();
3298 }
3299
3300
3301 ////////////////////////////////////////////////////////////////////////
3302 //
3303 // X11 specific stuff goes here...
3304
3305 #ifdef Q_WS_X11
3306 bool GuiApplication::x11EventFilter(XEvent * xev)
3307 {
3308         if (!current_view_)
3309                 return false;
3310
3311         switch (xev->type) {
3312         case SelectionRequest: {
3313                 if (xev->xselectionrequest.selection != XA_PRIMARY)
3314                         break;
3315                 LYXERR(Debug::SELECTION, "X requested selection.");
3316                 BufferView * bv = current_view_->currentBufferView();
3317                 if (bv) {
3318                         docstring const sel = bv->requestSelection();
3319                         if (!sel.empty()) {
3320                                 d->selection_.put(sel);
3321                                 // Refresh the selection request timestamp.
3322                                 // We have to do this by ourselves as Qt seems
3323                                 // not doing that, maybe because of our
3324                                 // "persistent selection" implementation
3325                                 // (see comments in GuiSelection.cpp).
3326                                 XSelectionEvent nev;
3327                                 nev.type = SelectionNotify;
3328                                 nev.display = xev->xselectionrequest.display;
3329                                 nev.requestor = xev->xselectionrequest.requestor;
3330                                 nev.selection = xev->xselectionrequest.selection;
3331                                 nev.target = xev->xselectionrequest.target;
3332                                 nev.property = 0L; // None
3333                                 nev.time = CurrentTime;
3334                                 XSendEvent(QX11Info::display(),
3335                                         nev.requestor, False, 0,
3336                                         reinterpret_cast<XEvent *>(&nev));
3337                                 return true;
3338                         }
3339                 }
3340                 break;
3341         }
3342         case SelectionClear: {
3343                 if (xev->xselectionclear.selection != XA_PRIMARY)
3344                         break;
3345                 LYXERR(Debug::SELECTION, "Lost selection.");
3346                 BufferView * bv = current_view_->currentBufferView();
3347                 if (bv)
3348                         bv->clearSelection();
3349                 break;
3350         }
3351         }
3352         return false;
3353 }
3354 #elif defined(QPA_XCB)
3355 bool GuiApplication::nativeEventFilter(const QByteArray & eventType,
3356                                        void * message, long *)
3357 {
3358         if (!current_view_ || eventType != "xcb_generic_event_t")
3359                 return false;
3360
3361         xcb_generic_event_t * ev = static_cast<xcb_generic_event_t *>(message);
3362
3363         switch (ev->response_type) {
3364         case XCB_SELECTION_REQUEST: {
3365                 xcb_selection_request_event_t * srev =
3366                         reinterpret_cast<xcb_selection_request_event_t *>(ev);
3367                 if (srev->selection != XCB_ATOM_PRIMARY)
3368                         break;
3369                 LYXERR(Debug::SELECTION, "X requested selection.");
3370                 BufferView * bv = current_view_->currentBufferView();
3371                 if (bv) {
3372                         docstring const sel = bv->requestSelection();
3373                         if (!sel.empty()) {
3374                                 d->selection_.put(sel);
3375 #ifdef HAVE_QT5_X11_EXTRAS
3376                                 // Refresh the selection request timestamp.
3377                                 // We have to do this by ourselves as Qt seems
3378                                 // not doing that, maybe because of our
3379                                 // "persistent selection" implementation
3380                                 // (see comments in GuiSelection.cpp).
3381                                 // It is expected that every X11 event is
3382                                 // 32 bytes long, even if not all 32 bytes are
3383                                 // needed. See:
3384                                 // https://www.x.org/releases/current/doc/man/man3/xcb_send_event.3.xhtml
3385                                 struct alignas(32) padded_event
3386                                         : xcb_selection_notify_event_t {};
3387                                 padded_event nev = {};
3388                                 nev.response_type = XCB_SELECTION_NOTIFY;
3389                                 nev.requestor = srev->requestor;
3390                                 nev.selection = srev->selection;
3391                                 nev.target = srev->target;
3392                                 nev.property = XCB_NONE;
3393                                 nev.time = XCB_CURRENT_TIME;
3394                                 xcb_connection_t * con = QX11Info::connection();
3395                                 xcb_send_event(con, 0, srev->requestor,
3396                                         XCB_EVENT_MASK_NO_EVENT,
3397                                         reinterpret_cast<char const *>(&nev));
3398                                 xcb_flush(con);
3399 #endif
3400                                 return true;
3401                         }
3402                 }
3403                 break;
3404         }
3405         case XCB_SELECTION_CLEAR: {
3406                 xcb_selection_clear_event_t * scev =
3407                         reinterpret_cast<xcb_selection_clear_event_t *>(ev);
3408                 if (scev->selection != XCB_ATOM_PRIMARY)
3409                         break;
3410                 LYXERR(Debug::SELECTION, "Lost selection.");
3411                 BufferView * bv = current_view_->currentBufferView();
3412                 if (bv)
3413                         bv->clearSelection();
3414                 break;
3415         }
3416         }
3417         return false;
3418 }
3419 #endif
3420
3421 } // namespace frontend
3422
3423
3424 void hideDialogs(std::string const & name, Inset * inset)
3425 {
3426         if (theApp())
3427                 frontend::guiApp->hideDialogs(name, inset);
3428 }
3429
3430
3431 ////////////////////////////////////////////////////////////////////
3432 //
3433 // Font stuff
3434 //
3435 ////////////////////////////////////////////////////////////////////
3436
3437 frontend::FontLoader & theFontLoader()
3438 {
3439         LAPPERR(frontend::guiApp);
3440         return frontend::guiApp->fontLoader();
3441 }
3442
3443
3444 frontend::FontMetrics const & theFontMetrics(Font const & f)
3445 {
3446         return theFontMetrics(f.fontInfo());
3447 }
3448
3449
3450 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
3451 {
3452         LAPPERR(frontend::guiApp);
3453         return frontend::guiApp->fontLoader().metrics(f);
3454 }
3455
3456
3457 ////////////////////////////////////////////////////////////////////
3458 //
3459 // Misc stuff
3460 //
3461 ////////////////////////////////////////////////////////////////////
3462
3463 frontend::Clipboard & theClipboard()
3464 {
3465         LAPPERR(frontend::guiApp);
3466         return frontend::guiApp->clipboard();
3467 }
3468
3469
3470 frontend::Selection & theSelection()
3471 {
3472         LAPPERR(frontend::guiApp);
3473         return frontend::guiApp->selection();
3474 }
3475
3476
3477 } // namespace lyx
3478
3479 #include "moc_GuiApplication.cpp"