src/frontends/qt4/GuiApplication.cpp

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