src/frontends/qt4/GuiApplication.cpp

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