2 * \file GuiApplication.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * \author Abdelrazak Younes
10 * Full author contact details are available in file CREDITS.
15 #include "GuiApplication.h"
17 #include "ColorCache.h"
19 #include "GuiClipboard.h"
20 #include "GuiKeySymbol.h"
21 #include "GuiSelection.h"
24 #include "qt_helpers.h"
27 #include "frontends/alert.h"
28 #include "frontends/Application.h"
29 #include "frontends/FontLoader.h"
30 #include "frontends/FontMetrics.h"
33 #include "BufferList.h"
34 #include "BufferParams.h"
35 #include "BufferView.h"
38 #include "Converter.h"
39 #include "CutAndPaste.h"
40 #include "ErrorList.h"
42 #include "FuncRequest.h"
43 #include "FuncStatus.h"
44 #include "GuiWorkArea.h"
48 #include "LaTeXPackages.h"
51 #include "LyXAction.h"
53 #include "Paragraph.h"
56 #include "SpellChecker.h"
57 #include "Thesaurus.h"
60 #include "insets/InsetText.h"
62 #include "support/convert.h"
63 #include "support/debug.h"
64 #include "support/ExceptionMessage.h"
65 #include "support/FileName.h"
66 #include "support/filetools.h"
67 #include "support/ForkedCalls.h"
68 #include "support/gettext.h"
69 #include "support/lassert.h"
70 #include "support/lstrings.h"
71 #include "support/lyxalgo.h" // sorted
72 #include "support/textutils.h"
73 #include "support/Messages.h"
74 #include "support/os.h"
75 #include "support/Package.h"
76 #include "support/TempFile.h"
79 #include "support/AppleScript.h"
80 #include "support/linkback/LinkBackProxy.h"
85 #include <QFontDatabase>
89 #include <QDesktopWidget>
93 #include <QFileOpenEvent>
97 #include <QImageReader>
100 #include <QLibraryInfo>
106 #include <QPixmapCache>
108 #include <QSessionManager>
110 #include <QShowEvent>
111 #include <QSocketNotifier>
112 #include <QSortFilterProxyModel>
113 #include <QStandardItemModel>
114 #include <QTextCodec>
116 #include <QTranslator>
117 #include <QThreadPool>
121 #include <X11/Xatom.h>
122 #include <X11/Xlib.h>
125 #elif defined(QPA_XCB)
129 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
130 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
131 #if (QT_VERSION < 0x050000)
132 #include <QWindowsMime>
133 #define QWINDOWSMIME QWindowsMime
136 #define QWINDOWSMIME QWinMime
146 #include <QMacPasteboardMime>
149 #include "support/bind.h"
150 #include <boost/crc.hpp>
157 using namespace lyx::support;
160 static void initializeResources()
162 static bool initialized = false;
164 Q_INIT_RESOURCE(Resources);
172 frontend::Application * createApplication(int & argc, char * argv[])
174 #if !defined(Q_WS_X11) && !defined(QPA_XCB)
175 // prune -geometry argument(s) by shifting
176 // the following ones 2 places down.
177 for (int i = 0 ; i < argc ; ++i) {
178 if (strcmp(argv[i], "-geometry") == 0) {
179 int const remove = (i+1) < argc ? 2 : 1;
181 for (int j = i; j < argc; ++j)
182 argv[j] = argv[j + remove];
187 frontend::GuiApplication * guiApp = new frontend::GuiApplication(argc, argv);
188 // I'd rather do that in the constructor, but I do not think that
189 // the palette is accessible there.
190 guiApp->colorCache().setPalette(guiApp->palette());
199 if (lyxrc.gui_language == "auto") {
200 theLocale = QLocale::system();
201 code = fromqstr(theLocale.name());
203 Language const * l = languages.getLanguage(lyxrc.gui_language);
204 code = l ? l->code() : "C";
205 theLocale = QLocale(toqstr(code));
207 // Qt tries to outsmart us and transforms en_US to C.
208 Messages::guiLanguage((code == "C") ? "en_US" : code);
209 QLocale::setDefault(theLocale);
210 setlocale(LC_NUMERIC, "C");
217 /// Return the list of loadable formats.
218 vector<string> loadableImageFormats()
222 QList<QByteArray> qt_formats = QImageReader::supportedImageFormats();
224 LYXERR(Debug::GRAPHICS,
225 "\nThe image loader can load the following directly:\n");
227 if (qt_formats.empty())
228 LYXERR(Debug::GRAPHICS, "\nQt4 Problem: No Format available!");
230 bool jpeg_found = false;
231 bool jpg_found = false;
232 for (QList<QByteArray>::const_iterator it = qt_formats.begin(); it != qt_formats.end(); ++it) {
234 LYXERR(Debug::GRAPHICS, (const char *) *it << ", ");
236 string ext = ascii_lowercase((const char *) *it);
244 else if (ext == "jpg") {
249 else if (lyxrc.use_converter_cache &&
250 (ext == "svg" || ext == "svgz") &&
251 theConverters().isReachable("svg", "png"))
252 // Qt only supports SVG 1.2 tiny. See #9778. We prefer displaying
253 // the SVG as in the output. However we require that the converter
254 // cache is enabled since this is expensive. We also require that
255 // an explicit svg->png converter is defined, since the default
256 // converter could produce bad quality as well. This assumes that
257 // png can always be loaded.
266 ////////////////////////////////////////////////////////////////////////
268 // Icon loading support code
270 ////////////////////////////////////////////////////////////////////////
280 bool operator<(ImgMap const & lhs, ImgMap const & rhs)
282 return lhs.key < rhs.key;
288 CompareKey(QString const & name) : name_(name) {}
289 bool operator()(ImgMap const & other) const { return other.key == name_; }
295 // this must be sorted alphabetically
296 // Upper case comes before lower case
297 // Please don't change the formatting, this list is parsed by
298 // development/tools/generate_symbols_images.py.
299 ImgMap sorted_img_map[] = {
300 { "Arrownot", "arrownot2"},
301 { "Arrowvert", "arrowvert2"},
302 { "Bowtie", "bowtie2" },
304 { "Bumpeq", "bumpeq2" },
305 { "CIRCLE", "circle3" },
307 { "CheckedBox", "checkedbox2" },
308 { "Circle", "circle2" },
309 { "Colonapprox", "colonapprox2" },
310 { "Coloneq", "coloneq2" },
311 { "Coloneqq", "coloneqq2" },
312 { "Colonsim", "colonsim2" },
314 { "DOWNarrow", "downarrow3" },
315 { "Delta", "delta2" },
316 { "Diamond", "diamond2" },
317 { "Doteq", "doteq2" },
318 { "Downarrow", "downarrow2" },
319 { "Eqcolon", "eqcolon2" },
320 { "Eqqcolon", "eqqcolon2" },
321 { "Gamma", "gamma2" },
323 { "LEFTCIRCLE", "leftcircle3" },
324 { "LEFTarrow", "leftarrow3" },
325 { "LEFTcircle", "leftcircle4" },
327 { "Lambda", "lambda2" },
329 { "Leftarrow", "leftarrow2" },
330 { "Leftcircle", "leftcircle2" },
331 { "Leftrightarrow", "leftrightarrow2" },
332 { "Longarrownot", "longarrownot2"},
333 { "Longleftarrow", "longleftarrow2" },
334 { "Longleftrightarrow", "longleftrightarrow2" },
335 { "Longmapsfrom", "longmapsfrom2"},
336 { "Longmapsto", "longmapsto2"},
337 { "Longrightarrow", "longrightarrow2" },
338 { "Mapsfrom", "mapsfrom2"},
339 { "Mapsfromchar", "mapsfromchar2"},
340 { "Mapsto", "mapsto2"},
341 { "Mapstochar", "mapstochar2"},
342 { "Omega", "omega2" },
347 { "RIGHTCIRCLE", "rightcircle3" },
348 { "RIGHTarrow", "rightarrow3" },
349 { "RIGHTcircle", "rightcircle4" },
351 { "Rightarrow", "rightarrow2" },
352 { "Rightcircle", "rightcircle2" },
353 { "Sigma", "sigma2" },
354 { "Square", "square2" },
355 { "Subset", "subset2" },
356 { "Supset", "supset2" },
357 { "Theta", "theta2" },
358 { "Thorn", "thorn2" },
359 { "UParrow", "uparrow3" },
360 { "Uparrow", "uparrow2" },
361 { "Updownarrow", "updownarrow2" },
362 { "Upsilon", "upsilon2" },
363 { "Vdash", "vdash3" },
368 { "lVert", "vert2" },
370 { "nLeftarrow", "nleftarrow2" },
371 { "nLeftrightarrow", "nleftrightarrow2" },
372 { "nRightarrow", "nrightarrow2" },
373 { "nVDash", "nvdash3" },
374 { "nVdash", "nvdash4" },
375 { "nvDash", "nvdash2" },
376 { "rVert", "vert2" },
378 { "textrm \\AA", "textrm_AA"},
379 { "textrm \\O", "textrm_O"},
380 { "vDash", "vdash2" },
381 { "varDelta", "vardelta2" },
382 { "varGamma", "vargamma2" },
383 { "varLambda", "varlambda2" },
384 { "varOmega", "varomega2" },
385 { "varPhi", "varphi2" },
386 { "varPi", "varpi2" },
387 { "varPsi", "varpsi2" },
388 { "varSigma", "varsigma2" },
389 { "varTheta", "vartheta2" },
390 { "varUpsilon", "varupsilon2" },
391 { "varXi", "varxi2" }
395 size_t const nr_sorted_img_map = sizeof(sorted_img_map) / sizeof(ImgMap);
397 // This list specifies which system's theme icon is related to which lyx
398 // command. It was based on:
399 // http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
400 // this must be sorted alphabetically
401 // Upper case comes before lower case
402 ImgMap sorted_theme_icon_map[] = {
403 { "bookmark-goto 0", "go-jump" },
404 { "buffer-new", "document-new" },
405 { "buffer-write", "document-save" },
406 { "buffer-write-as", "document-save-as" },
407 { "buffer-zoom-in", "zoom-in" },
408 { "buffer-zoom-out", "zoom-out" },
409 { "copy", "edit-copy" },
410 { "cut", "edit-cut" },
411 { "depth-decrement", "format-indent-less" },
412 { "depth-increment", "format-indent-more" },
413 { "dialog-show spellchecker", "tools-check-spelling" },
414 { "dialog-show-new-inset graphics", "insert-image" },
415 { "dialog-toggle findreplaceadv", "edit-find-replace" },
416 { "file-open", "document-open" },
417 { "font-bold", "format-text-bold" },
418 { "font-ital", "format-text-italic" },
419 { "font-strikeout", "format-text-strikethrough" },
420 { "font-underline", "format-text-underline" },
421 { "lyx-quit", "application-exit" },
422 { "paste", "edit-paste" },
423 { "redo", "edit-redo" },
424 { "undo", "edit-undo" },
425 { "window-close", "window-close" },
426 { "window-new", "window-new" }
429 size_t const nr_sorted_theme_icon_map = sizeof(sorted_theme_icon_map) / sizeof(ImgMap);
432 QString findImg(QString const & name)
434 ImgMap const * const begin = sorted_img_map;
435 ImgMap const * const end = begin + nr_sorted_img_map;
436 LATTEST(sorted(begin, end));
438 ImgMap const * const it = find_if(begin, end, CompareKey(name));
442 img_name = it->value;
445 img_name.replace('_', "underscore");
446 img_name.replace(' ', '_');
448 // This way we can have "math-delim { }" on the toolbar.
449 img_name.replace('(', "lparen");
450 img_name.replace(')', "rparen");
451 img_name.replace('[', "lbracket");
452 img_name.replace(']', "rbracket");
453 img_name.replace('{', "lbrace");
454 img_name.replace('}', "rbrace");
455 img_name.replace('|', "bars");
456 img_name.replace(',', "thinspace");
457 img_name.replace(':', "mediumspace");
458 img_name.replace(';', "thickspace");
459 img_name.replace('!', "negthinspace");
462 LYXERR(Debug::GUI, "findImg(" << name << ")\n"
463 << "Looking for math icon called \"" << img_name << '"');
470 QString themeIconName(QString const & action)
472 ImgMap const * const begin = sorted_theme_icon_map;
473 ImgMap const * const end = begin + nr_sorted_theme_icon_map;
474 LASSERT(sorted(begin, end), /**/);
476 ImgMap const * const it = find_if(begin, end, CompareKey(action));
484 QString iconName(FuncRequest const & f, bool unknown)
486 initializeResources();
490 switch (f.action()) {
491 case LFUN_MATH_INSERT:
492 if (!f.argument().empty()) {
494 name1 = findImg(toqstr(f.argument()).mid(1));
497 case LFUN_MATH_DELIM:
498 case LFUN_MATH_BIGDELIM:
500 name1 = findImg(toqstr(f.argument()));
504 name1 = toqstr(f.argument());
506 case LFUN_COMMAND_ALTERNATIVES: {
507 // use the first of the alternative commands
509 docstring dummy = split(f.argument(), firstcom, ';');
510 name1 = toqstr(firstcom);
511 name1.replace(' ', '_');
515 name2 = toqstr(lyxaction.getActionName(f.action()));
518 if (!f.argument().empty()) {
519 name1 = name2 + ' ' + toqstr(f.argument());
520 name1.replace(' ', '_');
521 name1.replace('\\', "backslash");
525 QStringList imagedirs;
526 imagedirs << "images/" << "images/ipa/";
527 search_mode mode = theGuiApp()->imageSearchMode();
528 for (int i = 0; i < imagedirs.size(); ++i) {
529 QString imagedir = imagedirs.at(i) + path;
530 FileName fname = imageLibFileSearch(imagedir, name1, "svgz,png", mode);
532 return toqstr(fname.absFileName());
534 fname = imageLibFileSearch(imagedir, name2, "svgz,png", mode);
536 return toqstr(fname.absFileName());
539 path = ":/images/" + path;
542 LYXERR0("Directory " << path << " not found in resource!");
545 if (res.exists(name1 + ".svgz"))
546 return path + name1 + ".svgz";
547 else if (res.exists(name1 + ".png"))
548 return path + name1 + ".png";
550 if (res.exists(name2 + ".svgz"))
551 return path + name2 + ".svgz";
552 else if (res.exists(name2 + ".png"))
553 return path + name2 + ".png";
555 LYXERR(Debug::GUI, "Cannot find icon with filename "
556 << "\"" << name1 << ".{svgz,png}\""
558 << "\"" << name2 << ".{svgz,png}\""
560 << lyxaction.getActionName(f.action())
561 << '(' << to_utf8(f.argument()) << ")\"");
564 QString imagedir = "images/";
565 FileName fname = imageLibFileSearch(imagedir, "unknown", "svgz,png", mode);
567 return toqstr(fname.absFileName());
568 return QString(":/images/unknown.svgz");
575 bool getPixmap(QPixmap & pixmap, QString const & path)
577 return pixmap.load(path);
581 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext)
583 QString imagedir = path;
584 FileName fname = imageLibFileSearch(imagedir, name, ext, theGuiApp()->imageSearchMode());
585 QString fpath = toqstr(fname.absFileName());
586 QPixmap pixmap = QPixmap();
588 if (getPixmap(pixmap, fpath)) {
592 QStringList exts = ext.split(",");
593 fpath = ":/" + path + name + ".";
594 for (int i = 0; i < exts.size(); ++i) {
595 if (getPixmap(pixmap, fpath + exts.at(i))) {
600 bool const list = ext.contains(",");
601 LYXERR0("Cannot load pixmap \""
602 << path << name << "." << (list ? "{" : "") << ext
603 << (list ? "}" : "") << "\", please verify resource system!");
609 QIcon getIcon(FuncRequest const & f, bool unknown)
611 #if (QT_VERSION >= 0x040600)
612 if (lyxrc.use_system_theme_icons) {
613 // use the icons from system theme that are available
614 QString action = toqstr(lyxaction.getActionName(f.action()));
615 if (!f.argument().empty())
616 action += " " + toqstr(f.argument());
617 QString const theme_icon = themeIconName(action);
618 if (QIcon::hasThemeIcon(theme_icon)) {
619 QIcon const thmicn = QIcon::fromTheme(theme_icon);
620 if (!thmicn.isNull())
626 QString icon = iconName(f, unknown);
630 //LYXERR(Debug::GUI, "Found icon: " << icon);
631 QPixmap pixmap = QPixmap();
632 if (!getPixmap(pixmap,icon)) {
633 LYXERR0("Cannot load icon " << icon << " please verify resource system!");
637 return QIcon(pixmap);
641 ////////////////////////////////////////////////////////////////////////
643 // LyX server support code.
645 ////////////////////////////////////////////////////////////////////////
647 class SocketNotifier : public QSocketNotifier
650 /// connect a connection notification from the LyXServerSocket
651 SocketNotifier(QObject * parent, int fd, Application::SocketCallback func)
652 : QSocketNotifier(fd, QSocketNotifier::Read, parent), func_(func)
656 /// The callback function
657 Application::SocketCallback func_;
661 ////////////////////////////////////////////////////////////////////////
663 // Mac specific stuff goes here...
665 ////////////////////////////////////////////////////////////////////////
667 class MenuTranslator : public QTranslator
670 MenuTranslator(QObject * parent)
671 : QTranslator(parent)
674 #if QT_VERSION >= 0x050000
675 virtual QString translate(const char * /* context */,
676 const char *sourceText,
677 const char * /* disambiguation */ = 0, int /* n */ = -1) const
679 QString translate(const char * /*context*/,
680 const char * sourceText,
681 const char * /*comment*/ = 0) const
684 string const s = sourceText;
685 if (s == N_("About %1") || s == N_("Preferences")
686 || s == N_("Reconfigure") || s == N_("Quit %1"))
694 // QMacPasteboardMimeGraphics can only be compiled on Mac.
696 class QMacPasteboardMimeGraphics : public QMacPasteboardMime
699 QMacPasteboardMimeGraphics()
700 : QMacPasteboardMime(MIME_QT_CONVERTOR|MIME_ALL)
703 QString convertorName() { return "Graphics"; }
705 QString flavorFor(QString const & mime)
707 LYXERR(Debug::ACTION, "flavorFor " << mime);
708 if (mime == pdfMimeType())
709 return QLatin1String("com.adobe.pdf");
713 QString mimeFor(QString flav)
715 LYXERR(Debug::ACTION, "mimeFor " << flav);
716 if (flav == QLatin1String("com.adobe.pdf"))
717 return pdfMimeType();
721 bool canConvert(QString const & mime, QString flav)
723 return mimeFor(flav) == mime;
726 QVariant convertToMime(QString const & /*mime*/, QList<QByteArray> data,
730 qWarning("QMacPasteboardMimeGraphics: Cannot handle multiple member data");
734 QList<QByteArray> convertFromMime(QString const & /*mime*/,
735 QVariant data, QString /*flav*/)
737 QList<QByteArray> ret;
738 ret.append(data.toByteArray());
744 ///////////////////////////////////////////////////////////////
746 // You can find more platform specific stuff at the end of this file...
748 ///////////////////////////////////////////////////////////////
750 ////////////////////////////////////////////////////////////////////////
751 // Windows specific stuff goes here...
753 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
754 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
755 // QWindowsMimeMetafile can only be compiled on Windows.
757 static FORMATETC cfFromMime(QString const & mimetype)
760 if (mimetype == emfMimeType()) {
761 formatetc.cfFormat = CF_ENHMETAFILE;
762 formatetc.tymed = TYMED_ENHMF;
763 } else if (mimetype == wmfMimeType()) {
764 formatetc.cfFormat = CF_METAFILEPICT;
765 formatetc.tymed = TYMED_MFPICT;
768 formatetc.dwAspect = DVASPECT_CONTENT;
769 formatetc.lindex = -1;
774 class QWindowsMimeMetafile : public QWINDOWSMIME {
776 QWindowsMimeMetafile() {}
778 bool canConvertFromMime(FORMATETC const & /*formatetc*/,
779 QMimeData const * /*mimedata*/) const
784 bool canConvertToMime(QString const & mimetype,
785 IDataObject * pDataObj) const
787 if (mimetype != emfMimeType() && mimetype != wmfMimeType())
789 FORMATETC formatetc = cfFromMime(mimetype);
790 return pDataObj->QueryGetData(&formatetc) == S_OK;
793 bool convertFromMime(FORMATETC const & /*formatetc*/,
794 const QMimeData * /*mimedata*/, STGMEDIUM * /*pmedium*/) const
799 QVariant convertToMime(QString const & mimetype, IDataObject * pDataObj,
800 QVariant::Type /*preferredType*/) const
803 if (!canConvertToMime(mimetype, pDataObj))
806 FORMATETC formatetc = cfFromMime(mimetype);
808 if (pDataObj->GetData(&formatetc, &s) != S_OK)
812 if (s.tymed == TYMED_ENHMF) {
813 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, 0, 0);
814 data.resize(dataSize);
815 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, dataSize,
816 (LPBYTE)data.data());
817 } else if (s.tymed == TYMED_MFPICT) {
818 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, 0, 0);
819 data.resize(dataSize);
820 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, dataSize,
821 (LPBYTE)data.data());
824 ReleaseStgMedium(&s);
830 QVector<FORMATETC> formatsForMime(QString const & mimetype,
831 QMimeData const * /*mimedata*/) const
833 QVector<FORMATETC> formats;
834 if (mimetype == emfMimeType() || mimetype == wmfMimeType())
835 formats += cfFromMime(mimetype);
839 QString mimeForFormat(FORMATETC const & formatetc) const
841 switch (formatetc.cfFormat) {
843 return emfMimeType();
844 case CF_METAFILEPICT:
845 return wmfMimeType();
855 /// Allows to check whether ESC was pressed during a long operation
856 class KeyChecker : public QObject {
861 KeyChecker() : pressed_(false), started_(false) {}
864 QCoreApplication::instance()->installEventFilter(this);
869 QCoreApplication::instance()->removeEventFilter(this);
873 QCoreApplication::processEvents();
876 bool started() const {
879 bool eventFilter(QObject *obj, QEvent *event) {
880 LYXERR(Debug::ACTION, "Event Type: " << event->type());
881 switch (event->type()) {
885 case QEvent::UpdateRequest:
886 case QEvent::CursorChange:
887 case QEvent::ActionChanged:
888 case QEvent::EnabledChange:
889 case QEvent::SockAct:
892 case QEvent::ToolTipChange:
893 case QEvent::LayoutRequest:
894 case QEvent::MetaCall:
895 return QObject::eventFilter(obj, event);
897 // FIXME Blocking all these events is a bad idea.
898 QKeyEvent *keyEvent = dynamic_cast<QKeyEvent*>(event);
899 if (keyEvent && keyEvent->key() == Qt::Key_Escape)
907 ////////////////////////////////////////////////////////////////////////
908 // GuiApplication::Private definition and implementation.
909 ////////////////////////////////////////////////////////////////////////
911 struct GuiApplication::Private
913 Private(): language_model_(0), meta_fake_bit(NoModifier),
916 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
917 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
918 /// WMF Mime handler for Windows clipboard.
919 wmf_mime_ = new QWindowsMimeMetafile;
922 initKeySequences(&theTopLevelKeymap());
925 void initKeySequences(KeyMap * kb)
927 keyseq = KeySequence(kb, kb);
928 cancel_meta_seq = KeySequence(kb, kb);
932 QSortFilterProxyModel * language_model_;
934 GuiClipboard clipboard_;
936 GuiSelection selection_;
938 FontLoader font_loader_;
940 ColorCache color_cache_;
942 QTranslator qt_trans_;
944 QHash<int, SocketNotifier *> socket_notifiers_;
948 /// The global instance
951 /// this timer is used for any regular events one wants to
952 /// perform. at present it is used to check if forked processes
954 QTimer general_timer_;
956 /// delayed FuncRequests
957 std::queue<FuncRequest> func_request_queue_;
962 KeySequence cancel_meta_seq;
964 KeyModifier meta_fake_bit;
966 /// The result of last dispatch action
967 DispatchResult dispatch_result_;
969 /// Multiple views container.
971 * Warning: This must not be a smart pointer as the destruction of the
972 * object is handled by Qt when the view is closed
973 * \sa Qt::WA_DeleteOnClose attribute.
975 QHash<int, GuiView *> views_;
977 /// Only used on mac.
978 QMenuBar * global_menubar_;
981 /// Linkback mime handler for MacOSX.
982 QMacPasteboardMimeGraphics mac_pasteboard_mime_;
985 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
986 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
987 /// WMF Mime handler for Windows clipboard.
988 QWindowsMimeMetafile * wmf_mime_;
992 /// Allows to check whether ESC was pressed during a long operation
993 KeyChecker key_checker_;
997 GuiApplication * guiApp;
999 GuiApplication::~GuiApplication()
1002 closeAllLinkBackLinks();
1008 GuiApplication::GuiApplication(int & argc, char ** argv)
1009 : QApplication(argc, argv), current_view_(0),
1010 d(new GuiApplication::Private)
1012 QString app_name = "LyX";
1013 QCoreApplication::setOrganizationName(app_name);
1014 QCoreApplication::setOrganizationDomain("lyx.org");
1015 QCoreApplication::setApplicationName(lyx_package);
1017 qsrand(QDateTime::currentDateTime().toTime_t());
1019 // Install translator for GUI elements.
1020 installTranslator(&d->qt_trans_);
1023 // Enable reception of XCB events.
1024 installNativeEventFilter(this);
1027 // FIXME: quitOnLastWindowClosed is true by default. We should have a
1028 // lyxrc setting for this in order to let the application stay resident.
1029 // But then we need some kind of dock icon, at least on Windows.
1031 if (lyxrc.quit_on_last_window_closed)
1032 setQuitOnLastWindowClosed(false);
1035 // FIXME: Do we need a lyxrc setting for this on Mac? This behaviour
1036 // seems to be the default case for applications like LyX.
1037 setQuitOnLastWindowClosed(false);
1038 // This allows to translate the strings that appear in the LyX menu.
1039 /// A translator suitable for the entries in the LyX menu.
1040 /// Only needed with Qt/Mac.
1041 installTranslator(new MenuTranslator(this));
1046 #if defined(Q_WS_X11) || defined(QPA_XCB)
1047 // doubleClickInterval() is 400 ms on X11 which is just too long.
1048 // On Windows and Mac OS X, the operating system's value is used.
1049 // On Microsoft Windows, calling this function sets the double
1050 // click interval for all applications. So we don't!
1051 QApplication::setDoubleClickInterval(300);
1054 connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
1056 // needs to be done before reading lyxrc
1058 lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
1062 // Set the cache to 5120 kilobytes which corresponds to screen size of
1063 // 1280 by 1024 pixels with a color depth of 32 bits.
1064 QPixmapCache::setCacheLimit(5120);
1066 // Initialize RC Fonts
1067 if (lyxrc.roman_font_name.empty())
1068 lyxrc.roman_font_name = fromqstr(romanFontName());
1070 if (lyxrc.sans_font_name.empty())
1071 lyxrc.sans_font_name = fromqstr(sansFontName());
1073 if (lyxrc.typewriter_font_name.empty())
1074 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
1076 d->general_timer_.setInterval(500);
1077 connect(&d->general_timer_, SIGNAL(timeout()),
1078 this, SLOT(handleRegularEvents()));
1079 d->general_timer_.start();
1081 // maxThreadCount() defaults in general to 2 on single or dual-processor.
1082 // This is clearly not enough in a time where we use threads for
1083 // document preview and/or export. 20 should be OK.
1084 QThreadPool::globalInstance()->setMaxThreadCount(20);
1088 GuiApplication * theGuiApp()
1090 return dynamic_cast<GuiApplication *>(theApp());
1094 double GuiApplication::pixelRatio() const
1096 #if QT_VERSION >= 0x050000
1097 return devicePixelRatio();
1104 void GuiApplication::clearSession()
1111 docstring Application::iconName(FuncRequest const & f, bool unknown)
1113 return qstring_to_ucs4(lyx::frontend::iconName(f, unknown));
1117 docstring Application::mathIcon(docstring const & c)
1119 return qstring_to_ucs4(findImg(toqstr(c)));
1123 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd) const
1127 BufferView * bv = 0;
1128 BufferView * doc_bv = 0;
1130 if (cmd.action() == LFUN_NOACTION) {
1131 status.message(from_utf8(N_("Nothing to do")));
1132 status.setEnabled(false);
1135 else if (cmd.action() == LFUN_UNKNOWN_ACTION) {
1136 status.setUnknown(true);
1137 status.message(from_utf8(N_("Unknown action")));
1138 status.setEnabled(false);
1141 // Does the GuiApplication know something?
1142 else if (getStatus(cmd, status)) { }
1144 // If we do not have a GuiView, then other functions are disabled
1145 else if (!current_view_)
1146 status.setEnabled(false);
1148 // Does the GuiView know something?
1149 else if (current_view_->getStatus(cmd, status)) { }
1151 // In LyX/Mac, when a dialog is open, the menus of the
1152 // application can still be accessed without giving focus to
1153 // the main window. In this case, we want to disable the menu
1154 // entries that are buffer or view-related.
1155 //FIXME: Abdel (09/02/10) This has very bad effect on Linux, don't know why...
1157 else if (cmd.origin() == FuncRequest::MENU && !current_view_->hasFocus())
1158 status.setEnabled(false);
1161 // If we do not have a BufferView, then other functions are disabled
1162 else if (!(bv = current_view_->currentBufferView()))
1163 status.setEnabled(false);
1165 // Does the current BufferView know something?
1166 else if (bv->getStatus(cmd, status)) { }
1168 // Does the current Buffer know something?
1169 else if (bv->buffer().getStatus(cmd, status)) { }
1171 // If we do not have a document BufferView, different from the
1172 // current BufferView, then other functions are disabled
1173 else if (!(doc_bv = current_view_->documentBufferView()) || doc_bv == bv)
1174 status.setEnabled(false);
1176 // Does the document Buffer know something?
1177 else if (doc_bv->buffer().getStatus(cmd, status)) { }
1180 LYXERR(Debug::ACTION, "LFUN not handled in getStatus(): " << cmd);
1181 status.message(from_utf8(N_("Command not handled")));
1182 status.setEnabled(false);
1185 // the default error message if we disable the command
1186 if (!status.enabled() && status.message().empty())
1187 status.message(from_utf8(N_("Command disabled")));
1193 bool GuiApplication::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
1195 // I would really like to avoid having this switch and rather try to
1196 // encode this in the function itself.
1197 // -- And I'd rather let an inset decide which LFUNs it is willing
1198 // to handle (Andre')
1200 switch (cmd.action()) {
1202 // This could be used for the no-GUI version. The GUI version is handled in
1203 // GuiView::getStatus(). See above.
1205 case LFUN_BUFFER_WRITE:
1206 case LFUN_BUFFER_WRITE_AS: {
1207 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
1208 enable = b && (b->isUnnamed() || !b->isClean());
1213 case LFUN_BOOKMARK_GOTO: {
1214 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
1215 enable = theSession().bookmarks().isValid(num);
1219 case LFUN_BOOKMARK_CLEAR:
1220 enable = theSession().bookmarks().hasValid();
1223 // this one is difficult to get right. As a half-baked
1224 // solution, we consider only the first action of the sequence
1225 case LFUN_COMMAND_SEQUENCE: {
1226 // argument contains ';'-terminated commands
1227 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
1228 FuncRequest func(lyxaction.lookupFunc(firstcmd));
1229 func.setOrigin(cmd.origin());
1230 flag = getStatus(func);
1234 // we want to check if at least one of these is enabled
1235 case LFUN_COMMAND_ALTERNATIVES: {
1236 // argument contains ';'-terminated commands
1237 string arg = to_utf8(cmd.argument());
1238 while (!arg.empty()) {
1240 arg = split(arg, first, ';');
1241 FuncRequest func(lyxaction.lookupFunc(first));
1242 func.setOrigin(cmd.origin());
1243 flag = getStatus(func);
1244 // if this one is enabled, the whole thing is
1253 string name = to_utf8(cmd.argument());
1254 if (theTopLevelCmdDef().lock(name, func)) {
1255 func.setOrigin(cmd.origin());
1256 flag = getStatus(func);
1257 theTopLevelCmdDef().release(name);
1259 // catch recursion or unknown command
1260 // definition. all operations until the
1261 // recursion or unknown command definition
1262 // occurs are performed, so set the state to
1269 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1271 case LFUN_PREFERENCES_SAVE:
1272 case LFUN_BUFFER_SAVE_AS_DEFAULT:
1273 case LFUN_DEBUG_LEVEL_SET:
1274 // these are handled in our dispatch()
1277 case LFUN_WINDOW_CLOSE:
1278 enable = d->views_.size() > 0;
1281 case LFUN_BUFFER_NEW:
1282 case LFUN_BUFFER_NEW_TEMPLATE:
1283 case LFUN_FILE_OPEN:
1284 case LFUN_HELP_OPEN:
1285 case LFUN_SCREEN_FONT_UPDATE:
1286 case LFUN_SET_COLOR:
1287 case LFUN_WINDOW_NEW:
1289 case LFUN_LYXRC_APPLY:
1290 case LFUN_COMMAND_PREFIX:
1292 case LFUN_META_PREFIX:
1293 case LFUN_RECONFIGURE:
1294 case LFUN_SERVER_GET_FILENAME:
1295 case LFUN_SERVER_NOTIFY:
1299 case LFUN_BUFFER_FORALL: {
1300 if (theBufferList().empty()) {
1301 flag.message(from_utf8(N_("Command not allowed without a buffer open")));
1302 flag.setEnabled(false);
1306 FuncRequest const cmdToPass = lyxaction.lookupFunc(cmd.getLongArg(0));
1307 if (cmdToPass.action() == LFUN_UNKNOWN_ACTION) {
1308 flag.message(from_utf8(N_("the <LFUN-COMMAND> argument of buffer-forall is not valid")));
1309 flag.setEnabled(false);
1314 case LFUN_DIALOG_SHOW: {
1315 string const name = cmd.getArg(0);
1316 return name == "aboutlyx"
1318 || name == "texinfo"
1319 || name == "progress"
1320 || name == "compare";
1328 flag.setEnabled(false);
1332 /// make a post-dispatch status message
1333 static docstring makeDispatchMessage(docstring const & msg,
1334 FuncRequest const & cmd)
1336 const bool verbose = (cmd.origin() == FuncRequest::MENU
1337 || cmd.origin() == FuncRequest::TOOLBAR
1338 || cmd.origin() == FuncRequest::COMMANDBUFFER);
1340 if (cmd.action() == LFUN_SELF_INSERT || !verbose) {
1341 LYXERR(Debug::ACTION, "dispatch msg is " << msg);
1345 docstring dispatch_msg = msg;
1346 if (!dispatch_msg.empty())
1347 dispatch_msg += ' ';
1349 docstring comname = from_utf8(lyxaction.getActionName(cmd.action()));
1351 bool argsadded = false;
1353 if (!cmd.argument().empty()) {
1354 if (cmd.action() != LFUN_UNKNOWN_ACTION) {
1355 comname += ' ' + cmd.argument();
1359 docstring const shortcuts = theTopLevelKeymap().
1360 printBindings(cmd, KeySequence::ForGui);
1362 if (!shortcuts.empty())
1363 comname += ": " + shortcuts;
1364 else if (!argsadded && !cmd.argument().empty())
1365 comname += ' ' + cmd.argument();
1367 if (!comname.empty()) {
1368 comname = rtrim(comname);
1369 dispatch_msg += '(' + rtrim(comname) + ')';
1371 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1372 return dispatch_msg;
1376 DispatchResult const & GuiApplication::dispatch(FuncRequest const & cmd)
1378 Buffer * buffer = 0;
1379 if (current_view_ && current_view_->currentBufferView()) {
1380 current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1381 buffer = ¤t_view_->currentBufferView()->buffer();
1383 buffer->undo().beginUndoGroup();
1387 // redraw the screen at the end (first of the two drawing steps).
1388 // This is done unless explicitly requested otherwise
1389 dr.screenUpdate(Update::FitCursor);
1391 updateCurrentView(cmd, dr);
1393 // the buffer may have been closed by one action
1394 if (theBufferList().isLoaded(buffer))
1395 buffer->undo().endUndoGroup();
1397 d->dispatch_result_ = dr;
1398 return d->dispatch_result_;
1402 void GuiApplication::updateCurrentView(FuncRequest const & cmd, DispatchResult & dr)
1407 BufferView * bv = current_view_->currentBufferView();
1409 if (dr.needBufferUpdate()) {
1410 bv->cursor().clearBufferUpdate();
1411 bv->buffer().updateBuffer();
1412 } else if (dr.needChangesUpdate()) {
1413 // updateBuffer() already updates the change-tracking presence flag
1414 bv->buffer().updateChangesPresent();
1416 // BufferView::update() updates the ViewMetricsInfo and
1417 // also initializes the position cache for all insets in
1418 // (at least partially) visible top-level paragraphs.
1419 // We will redraw the screen only if needed.
1420 bv->processUpdateFlags(dr.screenUpdate());
1422 // Do we have a selection?
1423 theSelection().haveSelection(bv->cursor().selection());
1426 current_view_->restartCursor();
1428 if (dr.needMessageUpdate()) {
1429 // Some messages may already be translated, so we cannot use _()
1430 current_view_->message(makeDispatchMessage(
1431 translateIfPossible(dr.message()), cmd));
1436 void GuiApplication::gotoBookmark(unsigned int idx, bool openFile,
1437 bool switchToBuffer)
1439 if (!theSession().bookmarks().isValid(idx))
1441 BookmarksSection::Bookmark const & bm =
1442 theSession().bookmarks().bookmark(idx);
1443 LASSERT(!bm.filename.empty(), return);
1444 string const file = bm.filename.absFileName();
1445 // if the file is not opened, open it.
1446 if (!theBufferList().exists(bm.filename)) {
1448 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
1452 // open may fail, so we need to test it again
1453 if (!theBufferList().exists(bm.filename))
1456 // bm can be changed when saving
1457 BookmarksSection::Bookmark tmp = bm;
1459 // Special case idx == 0 used for back-from-back jump navigation
1461 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
1463 // if the current buffer is not that one, switch to it.
1464 BufferView * doc_bv = current_view_ ?
1465 current_view_->documentBufferView() : 0;
1466 // FIXME It's possible that doc_bv is null!!
1467 // See coverity #102061
1468 Cursor const old = doc_bv->cursor();
1469 if (!doc_bv || doc_bv->buffer().fileName() != tmp.filename) {
1470 if (switchToBuffer) {
1471 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
1474 doc_bv = current_view_->documentBufferView();
1479 // moveToPosition try paragraph id first and then paragraph (pit, pos).
1480 if (!doc_bv->moveToPosition(
1481 tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
1484 Cursor & cur = doc_bv->cursor();
1486 notifyCursorLeavesOrEnters(old, cur);
1492 // Cursor jump succeeded!
1493 pit_type new_pit = cur.pit();
1494 pos_type new_pos = cur.pos();
1495 int new_id = cur.paragraph().id();
1497 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
1498 // see http://www.lyx.org/trac/ticket/3092
1499 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
1500 || bm.top_id != new_id) {
1501 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
1502 new_pit, new_pos, new_id);
1506 // This function runs "configure" and then rereads lyx.defaults to
1507 // reconfigure the automatic settings.
1508 void GuiApplication::reconfigure(string const & option)
1510 // emit message signal.
1512 current_view_->message(_("Running configure..."));
1514 // Run configure in user lyx directory
1515 string const lock_file = package().getConfigureLockName();
1516 int fd = fileLock(lock_file.c_str());
1517 int const ret = package().reconfigureUserLyXDir(option);
1518 // emit message signal.
1520 current_view_->message(_("Reloading configuration..."));
1521 lyxrc.read(libFileSearch(QString(), "lyxrc.defaults"), false);
1522 // Re-read packages.lst
1523 LaTeXPackages::getAvailable();
1524 fileUnlock(fd, lock_file.c_str());
1527 Alert::information(_("System reconfiguration failed"),
1528 _("The system reconfiguration has failed.\n"
1529 "Default textclass is used but LyX may\n"
1530 "not be able to work properly.\n"
1531 "Please reconfigure again if needed."));
1533 Alert::information(_("System reconfigured"),
1534 _("The system has been reconfigured.\n"
1535 "You need to restart LyX to make use of any\n"
1536 "updated document class specifications."));
1539 void GuiApplication::validateCurrentView()
1541 if (!d->views_.empty() && !current_view_) {
1542 // currently at least one view exists but no view has the focus.
1543 // choose the last view to make it current.
1544 // a view without any open document is preferred.
1545 GuiView * candidate = 0;
1546 QHash<int, GuiView *>::const_iterator it = d->views_.begin();
1547 QHash<int, GuiView *>::const_iterator end = d->views_.end();
1548 for (; it != end; ++it) {
1550 if (!candidate->documentBufferView())
1553 setCurrentView(candidate);
1557 void GuiApplication::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1559 string const argument = to_utf8(cmd.argument());
1560 FuncCode const action = cmd.action();
1562 LYXERR(Debug::ACTION, "cmd: " << cmd);
1564 // we have not done anything wrong yet.
1567 FuncStatus const flag = getStatus(cmd);
1568 if (!flag.enabled()) {
1569 // We cannot use this function here
1570 LYXERR(Debug::ACTION, "action "
1571 << lyxaction.getActionName(action)
1572 << " [" << action << "] is disabled at this location");
1573 dr.setMessage(flag.message());
1575 dr.dispatched(false);
1576 dr.screenUpdate(Update::None);
1577 dr.clearBufferUpdate();
1581 if (cmd.origin() == FuncRequest::LYXSERVER) {
1582 if (current_view_ && current_view_->currentBufferView())
1583 current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1584 // we will also need to redraw the screen at the end
1585 dr.screenUpdate(Update::FitCursor);
1588 // Assumes that the action will be dispatched.
1589 dr.dispatched(true);
1591 switch (cmd.action()) {
1593 case LFUN_WINDOW_NEW:
1594 createView(toqstr(cmd.argument()));
1597 case LFUN_WINDOW_CLOSE:
1598 // update bookmark pit of the current buffer before window close
1599 for (size_t i = 0; i < theSession().bookmarks().size(); ++i)
1600 gotoBookmark(i+1, false, false);
1601 // clear the last opened list, because
1602 // maybe this will end the session
1603 theSession().lastOpened().clear();
1604 // check for valid current_view_
1605 validateCurrentView();
1607 current_view_->closeScheduled();
1611 // quitting is triggered by the gui code
1612 // (leaving the event loop).
1614 current_view_->message(from_utf8(N_("Exiting.")));
1615 if (closeAllViews())
1619 case LFUN_SCREEN_FONT_UPDATE: {
1620 // handle the screen font changes.
1621 d->font_loader_.update();
1622 // Backup current_view_
1623 GuiView * view = current_view_;
1624 // Set current_view_ to zero to forbid GuiWorkArea::redraw()
1625 // to skip the refresh.
1627 theBufferList().changed(false);
1628 // Restore current_view_
1629 current_view_ = view;
1633 case LFUN_BUFFER_NEW:
1634 validateCurrentView();
1635 if (d->views_.empty()
1636 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1637 createView(QString(), false); // keep hidden
1638 current_view_->newDocument(to_utf8(cmd.argument()), false);
1639 current_view_->show();
1640 setActiveWindow(current_view_);
1642 current_view_->newDocument(to_utf8(cmd.argument()), false);
1646 case LFUN_BUFFER_NEW_TEMPLATE:
1647 validateCurrentView();
1648 if (d->views_.empty()
1649 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1651 current_view_->newDocument(to_utf8(cmd.argument()), true);
1652 if (!current_view_->documentBufferView())
1653 current_view_->close();
1655 current_view_->newDocument(to_utf8(cmd.argument()), true);
1659 case LFUN_FILE_OPEN: {
1660 validateCurrentView();
1661 // FIXME: create a new method shared with LFUN_HELP_OPEN.
1662 string const fname = to_utf8(cmd.argument());
1663 bool const is_open = FileName::isAbsolute(fname)
1664 && theBufferList().getBuffer(FileName(fname));
1665 if (d->views_.empty()
1666 || (!lyxrc.open_buffers_in_tabs
1667 && current_view_->documentBufferView() != 0
1669 // We want the ui session to be saved per document and not per
1670 // window number. The filename crc is a good enough identifier.
1671 boost::crc_32_type crc;
1672 crc = for_each(fname.begin(), fname.end(), crc);
1673 createView(crc.checksum());
1674 // we know current_view_ is non-null, because createView sets it.
1675 // coverity[FORWARD_NULL]
1676 current_view_->openDocument(fname);
1677 // FIXME but then why check current_view_ here?
1678 if (current_view_ && !current_view_->documentBufferView())
1679 current_view_->close();
1681 // we know !d->views.empty(), so this should be ok
1682 // coverity[FORWARD_NULL]
1683 current_view_->openDocument(fname);
1688 case LFUN_HELP_OPEN: {
1689 // FIXME: create a new method shared with LFUN_FILE_OPEN.
1690 if (current_view_ == 0)
1692 string const arg = to_utf8(cmd.argument());
1694 current_view_->message(_("Missing argument"));
1697 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
1699 fname = i18nLibFileSearch("examples", arg, "lyx");
1701 if (fname.empty()) {
1702 lyxerr << "LyX: unable to find documentation file `"
1703 << arg << "'. Bad installation?" << endl;
1706 current_view_->message(bformat(_("Opening help file %1$s..."),
1707 makeDisplayPath(fname.absFileName())));
1708 Buffer * buf = current_view_->loadDocument(fname, false);
1710 #ifndef DEVEL_VERSION
1712 buf->setReadonly(true);
1719 case LFUN_SET_COLOR: {
1721 string const x11_name = split(to_utf8(cmd.argument()), lyx_name, ' ');
1722 if (lyx_name.empty() || x11_name.empty()) {
1724 current_view_->message(
1725 _("Syntax: set-color <lyx_name> <x11_name>"));
1730 // FIXME: The graphics cache no longer has a changeDisplay method.
1731 string const graphicsbg = lcolor.getLyXName(Color_graphicsbg);
1732 bool const graphicsbg_changed =
1733 lyx_name == graphicsbg && x11_name != graphicsbg;
1734 if (graphicsbg_changed)
1735 graphics::GCache::get().changeDisplay(true);
1738 if (!lcolor.setColor(lyx_name, x11_name)) {
1740 current_view_->message(
1741 bformat(_("Set-color \"%1$s\" failed "
1742 "- color is undefined or "
1743 "may not be redefined"),
1744 from_utf8(lyx_name)));
1747 // Make sure we don't keep old colors in cache.
1748 d->color_cache_.clear();
1749 // Update the current view
1750 lyx::dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
1754 case LFUN_LYXRC_APPLY: {
1755 // reset active key sequences, since the bindings
1756 // are updated (bug 6064)
1758 LyXRC const lyxrc_orig = lyxrc;
1760 istringstream ss(to_utf8(cmd.argument()));
1761 bool const success = lyxrc.read(ss);
1764 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1765 << "Unable to read lyxrc data"
1770 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1772 // If the request comes from the minibuffer, then we can't reset
1773 // the GUI, since that would destory the minibuffer itself and
1774 // cause a crash, since we are currently in one of the methods of
1775 // GuiCommandBuffer. See bug #8540.
1776 if (cmd.origin() != FuncRequest::COMMANDBUFFER)
1779 // FIXME Unfortunately, that leaves a bug here, since we cannot
1780 // reset the GUI in this case. If the changes to lyxrc affected the
1781 // UI, then, nothing would happen. This seems fairly unlikely, but
1782 // it definitely is a bug.
1787 case LFUN_COMMAND_PREFIX:
1788 dispatch(FuncRequest(LFUN_MESSAGE, d->keyseq.printOptions(true)));
1793 d->meta_fake_bit = NoModifier;
1794 GuiView * gv = currentView();
1795 if (gv && gv->currentBufferView())
1796 // cancel any selection
1797 processFuncRequest(FuncRequest(LFUN_MARK_OFF));
1798 dr.setMessage(from_ascii(N_("Cancel")));
1801 case LFUN_META_PREFIX:
1802 d->meta_fake_bit = AltModifier;
1803 dr.setMessage(d->keyseq.print(KeySequence::ForGui));
1806 // --- Menus -----------------------------------------------
1807 case LFUN_RECONFIGURE:
1808 // argument is any additional parameter to the configure.py command
1809 reconfigure(to_utf8(cmd.argument()));
1812 // --- lyxserver commands ----------------------------
1813 case LFUN_SERVER_GET_FILENAME: {
1814 if (current_view_ && current_view_->documentBufferView()) {
1815 docstring const fname = from_utf8(
1816 current_view_->documentBufferView()->buffer().absFileName());
1817 dr.setMessage(fname);
1818 LYXERR(Debug::INFO, "FNAME[" << fname << ']');
1820 dr.setMessage(docstring());
1821 LYXERR(Debug::INFO, "No current file for LFUN_SERVER_GET_FILENAME");
1826 case LFUN_SERVER_NOTIFY: {
1827 docstring const dispatch_buffer = d->keyseq.print(KeySequence::Portable);
1828 dr.setMessage(dispatch_buffer);
1829 theServer().notifyClient(to_utf8(dispatch_buffer));
1833 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1834 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1840 string rest = split(argument, countstr, ' ');
1841 istringstream is(countstr);
1844 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1845 for (int i = 0; i < count; ++i)
1846 dispatch(lyxaction.lookupFunc(rest));
1850 case LFUN_COMMAND_SEQUENCE: {
1851 // argument contains ';'-terminated commands
1852 string arg = argument;
1853 // FIXME: this LFUN should also work without any view.
1854 Buffer * buffer = (current_view_ && current_view_->documentBufferView())
1855 ? &(current_view_->documentBufferView()->buffer()) : 0;
1857 buffer->undo().beginUndoGroup();
1858 while (!arg.empty()) {
1860 arg = split(arg, first, ';');
1861 FuncRequest func(lyxaction.lookupFunc(first));
1862 func.setOrigin(cmd.origin());
1865 // the buffer may have been closed by one action
1866 if (theBufferList().isLoaded(buffer))
1867 buffer->undo().endUndoGroup();
1871 case LFUN_BUFFER_FORALL: {
1872 FuncRequest const funcToRun = lyxaction.lookupFunc(cmd.getLongArg(0));
1874 map<Buffer *, GuiView *> views_lVisible;
1875 map<GuiView *, Buffer *> activeBuffers;
1877 QList<GuiView *> allViews = d->views_.values();
1879 // this for does not modify any buffer. It just collects info on local
1880 // visibility of buffers and on which buffer is active in each view.
1881 Buffer * const last = theBufferList().last();
1882 for(GuiView * view : allViews) {
1883 // all of the buffers might be locally hidden. That is, there is no
1885 if (!view || !view->currentBufferView())
1886 activeBuffers[view] = 0;
1888 activeBuffers[view] = &view->currentBufferView()->buffer();
1890 // find out if each is locally visible or locally hidden.
1891 // we don't use a for loop as the buffer list cycles.
1892 Buffer * b = theBufferList().first();
1894 bool const locallyVisible = view && view->workArea(*b);
1895 if (locallyVisible) {
1896 bool const exists_ = (views_lVisible.find(b) != views_lVisible.end());
1897 // only need to overwrite/add if we don't already know a buffer is globally
1898 // visible or we do know but we would prefer to dispatch LFUN from the
1899 // current view because of cursor position issues.
1900 if (!exists_ || (exists_ && views_lVisible[b] != current_view_))
1901 views_lVisible[b] = view;
1905 b = theBufferList().next(b);
1909 GuiView * const homeView = currentView();
1910 Buffer * b = theBufferList().first();
1911 Buffer * nextBuf = 0;
1912 int numProcessed = 0;
1915 nextBuf = theBufferList().next(b); // get next now bc LFUN might close current.
1917 bool const visible = (views_lVisible.find(b) != views_lVisible.end());
1919 // first change to a view where b is locally visible, preferably current_view_.
1920 GuiView * const vLv = views_lVisible[b];
1922 lyx::dispatch(funcToRun);
1930 // put things back to how they were (if possible).
1931 for (GuiView * view : allViews) {
1932 Buffer * originalBuf = activeBuffers[view];
1933 // there might not have been an active buffer in this view or it might have been closed by the LFUN.
1934 if (theBufferList().isLoaded(originalBuf))
1935 view->setBuffer(originalBuf);
1937 homeView->setFocus();
1939 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d buffer(s)"), from_utf8(cmd.getLongArg(0)), numProcessed));
1943 case LFUN_COMMAND_ALTERNATIVES: {
1944 // argument contains ';'-terminated commands
1945 string arg = argument;
1946 while (!arg.empty()) {
1948 arg = split(arg, first, ';');
1949 FuncRequest func(lyxaction.lookupFunc(first));
1950 func.setOrigin(cmd.origin());
1951 FuncStatus const stat = getStatus(func);
1952 if (stat.enabled()) {
1962 if (theTopLevelCmdDef().lock(argument, func)) {
1963 func.setOrigin(cmd.origin());
1965 theTopLevelCmdDef().release(argument);
1967 if (func.action() == LFUN_UNKNOWN_ACTION) {
1968 // unknown command definition
1969 lyxerr << "Warning: unknown command definition `"
1973 // recursion detected
1974 lyxerr << "Warning: Recursion in the command definition `"
1975 << argument << "' detected"
1982 case LFUN_PREFERENCES_SAVE:
1983 lyxrc.write(support::makeAbsPath("preferences",
1984 package().user_support().absFileName()), false);
1987 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1988 string const fname = addName(addPath(package().user_support().absFileName(),
1989 "templates/"), "defaults.lyx");
1990 Buffer defaults(fname);
1992 istringstream ss(argument);
1997 // We need to make sure that, after we recreat the DocumentClass,
1998 // which we do in readHeader, we apply it to the document itself.
1999 DocumentClassConstPtr olddc = defaults.params().documentClassPtr();
2000 int const unknown_tokens = defaults.readHeader(lex);
2001 DocumentClassConstPtr newdc = defaults.params().documentClassPtr();
2003 InsetText & theinset = static_cast<InsetText &>(defaults.inset());
2004 cap::switchBetweenClasses(olddc, newdc, theinset, el);
2006 if (unknown_tokens != 0) {
2007 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
2008 << unknown_tokens << " unknown token"
2009 << (unknown_tokens == 1 ? "" : "s")
2013 if (defaults.writeFile(FileName(defaults.absFileName())))
2014 dr.setMessage(bformat(_("Document defaults saved in %1$s"),
2015 makeDisplayPath(fname)));
2018 dr.setMessage(from_ascii(N_("Unable to save document defaults")));
2023 case LFUN_BOOKMARK_GOTO:
2024 // go to bookmark, open unopened file and switch to buffer if necessary
2025 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
2026 dr.screenUpdate(Update::Force | Update::FitCursor);
2029 case LFUN_BOOKMARK_CLEAR:
2030 theSession().bookmarks().clear();
2033 case LFUN_DEBUG_LEVEL_SET:
2034 lyxerr.setLevel(Debug::value(to_utf8(cmd.argument())));
2037 case LFUN_DIALOG_SHOW: {
2038 string const name = cmd.getArg(0);
2040 if ( name == "aboutlyx"
2042 || name == "texinfo"
2043 || name == "progress"
2044 || name == "compare")
2046 // work around: on Mac OS the application
2047 // is not terminated when closing the last view.
2048 // Create a new one to be able to dispatch the
2049 // LFUN_DIALOG_SHOW to this view.
2050 if (current_view_ == 0)
2057 // The LFUN must be for one of GuiView, BufferView, Buffer or Cursor;
2060 current_view_->dispatch(cmd, dr);
2064 if (cmd.origin() == FuncRequest::LYXSERVER)
2065 updateCurrentView(cmd, dr);
2069 docstring GuiApplication::viewStatusMessage()
2071 // When meta-fake key is pressed, show the key sequence so far + "M-".
2072 if (d->meta_fake_bit != NoModifier)
2073 return d->keyseq.print(KeySequence::ForGui) + "M-";
2075 // Else, when a non-complete key sequence is pressed,
2076 // show the available options.
2077 if (d->keyseq.length() > 0 && !d->keyseq.deleted())
2078 return d->keyseq.printOptions(true);
2084 void GuiApplication::handleKeyFunc(FuncCode action)
2088 if (d->keyseq.length())
2090 GuiView * gv = currentView();
2091 LASSERT(gv && gv->currentBufferView(), return);
2092 BufferView * bv = gv->currentBufferView();
2093 bv->getIntl().getTransManager().deadkey(
2094 c, get_accent(action).accent, bv->cursor().innerText(),
2096 // Need to clear, in case the minibuffer calls these
2099 // copied verbatim from do_accent_char
2100 bv->cursor().resetAnchor();
2104 void GuiApplication::processKeySym(KeySymbol const & keysym, KeyModifier state)
2106 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
2108 // Do nothing if we have nothing (JMarc)
2109 if (!keysym.isOK()) {
2110 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
2112 current_view_->restartCursor();
2116 if (keysym.isModifier()) {
2118 current_view_->restartCursor();
2122 char_type encoded_last_key = keysym.getUCSEncoded();
2124 // Do a one-deep top-level lookup for
2125 // cancel and meta-fake keys. RVDK_PATCH_5
2126 d->cancel_meta_seq.reset();
2128 FuncRequest func = d->cancel_meta_seq.addkey(keysym, state);
2129 LYXERR(Debug::KEY, "action first set to [" << func.action() << ']');
2131 // When not cancel or meta-fake, do the normal lookup.
2132 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
2133 // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
2134 if ((func.action() != LFUN_CANCEL) && (func.action() != LFUN_META_PREFIX)) {
2135 // remove Caps Lock and Mod2 as a modifiers
2136 func = d->keyseq.addkey(keysym, (state | d->meta_fake_bit));
2137 LYXERR(Debug::KEY, "action now set to [" << func.action() << ']');
2140 // Dont remove this unless you know what you are doing.
2141 d->meta_fake_bit = NoModifier;
2143 // Can this happen now ?
2144 if (func.action() == LFUN_NOACTION)
2145 func = FuncRequest(LFUN_COMMAND_PREFIX);
2147 LYXERR(Debug::KEY, " Key [action=" << func.action() << "]["
2148 << d->keyseq.print(KeySequence::Portable) << ']');
2150 // already here we know if it any point in going further
2151 // why not return already here if action == -1 and
2152 // num_bytes == 0? (Lgb)
2154 if (d->keyseq.length() > 1 && current_view_)
2155 current_view_->message(d->keyseq.print(KeySequence::ForGui));
2158 // Maybe user can only reach the key via holding down shift.
2159 // Let's see. But only if shift is the only modifier
2160 if (func.action() == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
2161 LYXERR(Debug::KEY, "Trying without shift");
2162 func = d->keyseq.addkey(keysym, NoModifier);
2163 LYXERR(Debug::KEY, "Action now " << func.action());
2166 if (func.action() == LFUN_UNKNOWN_ACTION) {
2167 // We didn't match any of the key sequences.
2168 // See if it's normal insertable text not already
2169 // covered by a binding
2170 if (keysym.isText() && d->keyseq.length() == 1) {
2171 // Non-printable characters (such as ASCII control characters)
2172 // must not be inserted (#5704)
2173 if (!isPrintable(encoded_last_key)) {
2174 LYXERR(Debug::KEY, "Non-printable character! Omitting.");
2176 current_view_->restartCursor();
2179 // The following modifier check is not needed on Mac.
2180 // The keysym is either not text or it is different
2181 // from the non-modifier keysym. See #9875 for the
2182 // broken alt-modifier effect of having this code active.
2183 #if !defined(Q_OS_MAC)
2184 // If a non-Shift Modifier is used we have a non-bound key sequence
2185 // (such as Alt+j = j). This should be omitted (#5575).
2186 // On Windows, AltModifier and ControlModifier are both
2187 // set when AltGr is pressed. Therefore, in order to not
2188 // break AltGr-bound symbols (see #5575 for details),
2189 // unbound Ctrl+Alt key sequences are allowed.
2190 if ((state & AltModifier || state & ControlModifier || state & MetaModifier)
2191 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2192 && !(state & AltModifier && state & ControlModifier)
2196 if (current_view_) {
2197 current_view_->message(_("Unknown function."));
2198 current_view_->restartCursor();
2203 // Since all checks above were passed, we now really have text that
2204 // is to be inserted (e.g., AltGr-bound symbols). Thus change the
2205 // func to LFUN_SELF_INSERT and thus cause the text to be inserted
2207 LYXERR(Debug::KEY, "isText() is true, inserting.");
2208 func = FuncRequest(LFUN_SELF_INSERT, FuncRequest::KEYBOARD);
2210 LYXERR(Debug::KEY, "Unknown Action and not isText() -- giving up");
2211 if (current_view_) {
2212 current_view_->message(_("Unknown function."));
2213 current_view_->restartCursor();
2219 if (func.action() == LFUN_SELF_INSERT) {
2220 if (encoded_last_key != 0) {
2221 docstring const arg(1, encoded_last_key);
2222 processFuncRequest(FuncRequest(LFUN_SELF_INSERT, arg,
2223 FuncRequest::KEYBOARD));
2224 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
2227 processFuncRequest(func);
2231 void GuiApplication::processFuncRequest(FuncRequest const & func)
2233 lyx::dispatch(func);
2237 void GuiApplication::processFuncRequestAsync(FuncRequest const & func)
2239 addToFuncRequestQueue(func);
2240 processFuncRequestQueueAsync();
2244 void GuiApplication::processFuncRequestQueue()
2246 while (!d->func_request_queue_.empty()) {
2247 processFuncRequest(d->func_request_queue_.front());
2248 d->func_request_queue_.pop();
2253 void GuiApplication::processFuncRequestQueueAsync()
2255 QTimer::singleShot(0, this, SLOT(slotProcessFuncRequestQueue()));
2259 void GuiApplication::addToFuncRequestQueue(FuncRequest const & func)
2261 d->func_request_queue_.push(func);
2265 void GuiApplication::resetGui()
2267 // Set the language defined by the user.
2271 if (!readUIFile(toqstr(lyxrc.ui_file)))
2272 // Gives some error box here.
2275 if (d->global_menubar_)
2276 d->menus_.fillMenuBar(d->global_menubar_, 0, false);
2278 QHash<int, GuiView *>::iterator it;
2279 for (it = d->views_.begin(); it != d->views_.end(); ++it) {
2282 gv->setLayoutDirection(layoutDirection());
2286 processFuncRequest(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
2290 void GuiApplication::createView(int view_id)
2292 createView(QString(), true, view_id);
2296 void GuiApplication::createView(QString const & geometry_arg, bool autoShow,
2299 // release the keyboard which might have been grabed by the global
2300 // menubar on Mac to catch shortcuts even without any GuiView.
2301 if (d->global_menubar_)
2302 d->global_menubar_->releaseKeyboard();
2306 while (d->views_.find(id) != d->views_.end())
2309 LYXERR(Debug::GUI, "About to create new window with ID " << id);
2310 GuiView * view = new GuiView(id);
2312 d->views_[id] = view;
2316 setActiveWindow(view);
2319 if (!geometry_arg.isEmpty()) {
2320 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2324 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)){0,1}(?:([+-][0-9]*)){0,1}" );
2325 re.indexIn(geometry_arg);
2326 w = re.cap(1).toInt();
2327 h = re.cap(2).toInt();
2328 x = re.cap(3).toInt();
2329 y = re.cap(4).toInt();
2330 sx = re.cap(3).isEmpty() ? '+' : re.cap(3).at(0);
2331 sy = re.cap(4).isEmpty() ? '+' : re.cap(4).at(0);
2332 // Set initial geometry such that we can get the frame size.
2333 view->setGeometry(x, y, w, h);
2334 int framewidth = view->geometry().x() - view->x();
2335 int titleheight = view->geometry().y() - view->y();
2336 // Negative displacements must be interpreted as distances
2337 // from the right or bottom screen borders.
2338 if (sx == '-' || sy == '-') {
2339 QRect rec = QApplication::desktop()->screenGeometry();
2341 x += rec.width() - w - framewidth;
2343 y += rec.height() - h - titleheight;
2344 view->setGeometry(x, y, w, h);
2346 // Make sure that the left and top frame borders are visible.
2347 if (view->x() < 0 || view->y() < 0) {
2352 view->setGeometry(x, y, w, h);
2360 Clipboard & GuiApplication::clipboard()
2362 return d->clipboard_;
2366 Selection & GuiApplication::selection()
2368 return d->selection_;
2372 FontLoader & GuiApplication::fontLoader()
2374 return d->font_loader_;
2378 Toolbars const & GuiApplication::toolbars() const
2380 return d->toolbars_;
2384 Toolbars & GuiApplication::toolbars()
2386 return d->toolbars_;
2390 Menus const & GuiApplication::menus() const
2396 Menus & GuiApplication::menus()
2402 QList<int> GuiApplication::viewIds() const
2404 return d->views_.keys();
2408 ColorCache & GuiApplication::colorCache()
2410 return d->color_cache_;
2414 int GuiApplication::exec()
2416 // asynchronously handle batch commands. This event will be in
2417 // the event queue in front of other asynchronous events. Hence,
2418 // we can assume in the latter that the gui is setup already.
2419 QTimer::singleShot(0, this, SLOT(execBatchCommands()));
2421 return QApplication::exec();
2425 void GuiApplication::exit(int status)
2427 QApplication::exit(status);
2431 void GuiApplication::setGuiLanguage()
2435 // install translation file for Qt built-in dialogs
2436 QString const language_name = QString("qt_") + theLocale.name();
2437 // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
2438 // Short-named translator can be loaded from a long name, but not the
2439 // opposite. Therefore, long name should be used without truncation.
2440 // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
2441 if (!d->qt_trans_.load(language_name,
2442 QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
2443 LYXERR(Debug::LOCALE, "Could not find Qt translations for locale "
2446 LYXERR(Debug::LOCALE, "Successfully installed Qt translations for locale "
2450 switch (theLocale.language()) {
2451 case QLocale::Arabic :
2452 case QLocale::Hebrew :
2453 case QLocale::Persian :
2454 case QLocale::Urdu :
2455 setLayoutDirection(Qt::RightToLeft);
2458 setLayoutDirection(Qt::LeftToRight);
2463 void GuiApplication::execBatchCommands()
2468 if (!readUIFile(toqstr(lyxrc.ui_file)))
2469 // Gives some error box here.
2473 #if QT_VERSION > 0x040600
2474 setAttribute(Qt::AA_MacDontSwapCtrlAndMeta,lyxrc.mac_dontswap_ctrl_meta);
2476 #if QT_VERSION > 0x050100
2477 setAttribute(Qt::AA_UseHighDpiPixmaps,true);
2479 // Create the global default menubar which is shown for the dialogs
2480 // and if no GuiView is visible.
2481 // This must be done after the session was recovered to know the "last files".
2482 d->global_menubar_ = new QMenuBar(0);
2483 d->menus_.fillMenuBar(d->global_menubar_, 0, true);
2486 lyx::execBatchCommands();
2490 QAbstractItemModel * GuiApplication::languageModel()
2492 if (d->language_model_)
2493 return d->language_model_;
2495 QStandardItemModel * lang_model = new QStandardItemModel(this);
2496 lang_model->insertColumns(0, 3);
2497 QIcon speller(getPixmap("images/", "dialog-show_spellchecker", "svgz,png"));
2498 QIcon saurus(getPixmap("images/", "thesaurus-entry", "svgz,png"));
2499 Languages::const_iterator it = lyx::languages.begin();
2500 Languages::const_iterator end = lyx::languages.end();
2501 for (; it != end; ++it) {
2502 int current_row = lang_model->rowCount();
2503 lang_model->insertRows(current_row, 1);
2504 QModelIndex pl_item = lang_model->index(current_row, 0);
2505 QModelIndex sp_item = lang_model->index(current_row, 1);
2506 QModelIndex th_item = lang_model->index(current_row, 2);
2507 lang_model->setData(pl_item, qt_(it->second.display()), Qt::DisplayRole);
2508 lang_model->setData(pl_item, toqstr(it->second.lang()), Qt::UserRole);
2509 lang_model->setData(sp_item, qt_(it->second.display()), Qt::DisplayRole);
2510 lang_model->setData(sp_item, toqstr(it->second.lang()), Qt::UserRole);
2511 if (theSpellChecker() && theSpellChecker()->hasDictionary(&it->second))
2512 lang_model->setData(sp_item, speller, Qt::DecorationRole);
2513 lang_model->setData(th_item, qt_(it->second.display()), Qt::DisplayRole);
2514 lang_model->setData(th_item, toqstr(it->second.lang()), Qt::UserRole);
2515 if (thesaurus.thesaurusInstalled(from_ascii(it->second.code())))
2516 lang_model->setData(th_item, saurus, Qt::DecorationRole);
2518 d->language_model_ = new QSortFilterProxyModel(this);
2519 d->language_model_->setSourceModel(lang_model);
2520 d->language_model_->setSortLocaleAware(true);
2521 return d->language_model_;
2525 void GuiApplication::restoreGuiSession()
2527 if (!lyxrc.load_session)
2530 Session & session = theSession();
2531 LastOpenedSection::LastOpened const & lastopened =
2532 session.lastOpened().getfiles();
2534 validateCurrentView();
2536 FileName active_file;
2537 // do not add to the lastfile list since these files are restored from
2538 // last session, and should be already there (regular files), or should
2539 // not be added at all (help files).
2540 for (size_t i = 0; i < lastopened.size(); ++i) {
2541 FileName const & file_name = lastopened[i].file_name;
2542 if (d->views_.empty() || (!lyxrc.open_buffers_in_tabs
2543 && current_view_->documentBufferView() != 0)) {
2544 boost::crc_32_type crc;
2545 string const & fname = file_name.absFileName();
2546 crc = for_each(fname.begin(), fname.end(), crc);
2547 createView(crc.checksum());
2549 current_view_->loadDocument(file_name, false);
2551 if (lastopened[i].active)
2552 active_file = file_name;
2555 // Restore last active buffer
2556 Buffer * buffer = theBufferList().getBuffer(active_file);
2557 if (buffer && current_view_)
2558 current_view_->setBuffer(buffer);
2560 // clear this list to save a few bytes of RAM
2561 session.lastOpened().clear();
2565 QString const GuiApplication::romanFontName()
2568 font.setStyleHint(QFont::Serif);
2569 font.setFamily("serif");
2571 return QFontInfo(font).family();
2575 QString const GuiApplication::sansFontName()
2578 font.setStyleHint(QFont::SansSerif);
2579 font.setFamily("sans");
2581 return QFontInfo(font).family();
2585 QString const GuiApplication::typewriterFontName()
2587 return QFontInfo(typewriterSystemFont()).family();
2592 // We cannot use QFont::fixedPitch() because it doesn't
2593 // return the fact but only if it is requested.
2594 static bool isFixedPitch(const QFont & font) {
2595 const QFontInfo fi(font);
2596 return fi.fixedPitch();
2601 QFont const GuiApplication::typewriterSystemFont()
2603 #if QT_VERSION >= 0x050200
2604 QFont font = QFontDatabase::systemFont(QFontDatabase::FixedFont);
2606 QFont font("monospace");
2608 if (!isFixedPitch(font)) {
2609 // try to enforce a real monospaced font
2610 font.setStyleHint(QFont::Monospace);
2611 if (!isFixedPitch(font)) {
2612 font.setStyleHint(QFont::TypeWriter);
2613 if (!isFixedPitch(font)) font.setFamily("courier");
2617 // On a Mac the result is too small and it's not practical to
2618 // rely on Qtconfig utility to change the system settings of Qt.
2619 font.setPointSize(12);
2625 void GuiApplication::handleRegularEvents()
2627 ForkedCallsController::handleCompletedProcesses();
2631 bool GuiApplication::event(QEvent * e)
2634 case QEvent::FileOpen: {
2635 // Open a file; this happens only on Mac OS X for now.
2637 // We do this asynchronously because on startup the batch
2638 // commands are not executed here yet and the gui is not ready
2640 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
2641 FuncRequest const fr(LFUN_FILE_OPEN, qstring_to_ucs4(foe->file()));
2642 processFuncRequestAsync(fr);
2647 return QApplication::event(e);
2652 bool GuiApplication::notify(QObject * receiver, QEvent * event)
2655 return QApplication::notify(receiver, event);
2657 catch (ExceptionMessage const & e) {
2659 case ErrorException:
2661 setQuitOnLastWindowClosed(false);
2663 Alert::error(e.title_, e.details_);
2665 // Properly crash in debug mode in order to get a useful backtrace.
2668 // In release mode, try to exit gracefully.
2671 case BufferException: {
2672 if (!current_view_ || !current_view_->documentBufferView())
2674 Buffer * buf = ¤t_view_->documentBufferView()->buffer();
2675 docstring details = e.details_ + '\n';
2676 details += buf->emergencyWrite();
2677 theBufferList().release(buf);
2678 details += "\n" + _("The current document was closed.");
2679 Alert::error(e.title_, details);
2682 case WarningException:
2683 Alert::warning(e.title_, e.details_);
2687 catch (exception const & e) {
2688 docstring s = _("LyX has caught an exception, it will now "
2689 "attempt to save all unsaved documents and exit."
2691 s += from_ascii(e.what());
2692 Alert::error(_("Software exception Detected"), s);
2696 docstring s = _("LyX has caught some really weird exception, it will "
2697 "now attempt to save all unsaved documents and exit.");
2698 Alert::error(_("Software exception Detected"), s);
2706 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
2708 QColor const & qcol = d->color_cache_.get(col);
2709 if (!qcol.isValid()) {
2715 rgbcol.r = qcol.red();
2716 rgbcol.g = qcol.green();
2717 rgbcol.b = qcol.blue();
2722 bool Application::getRgbColorUncached(ColorCode col, RGBColor & rgbcol)
2724 QColor const qcol(lcolor.getX11Name(col).c_str());
2725 if (!qcol.isValid()) {
2731 rgbcol.r = qcol.red();
2732 rgbcol.g = qcol.green();
2733 rgbcol.b = qcol.blue();
2738 string const GuiApplication::hexName(ColorCode col)
2740 return ltrim(fromqstr(d->color_cache_.get(col).name()), "#");
2744 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
2746 SocketNotifier * sn = new SocketNotifier(this, fd, func);
2747 d->socket_notifiers_[fd] = sn;
2748 connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
2752 void GuiApplication::socketDataReceived(int fd)
2754 d->socket_notifiers_[fd]->func_();
2758 void GuiApplication::unregisterSocketCallback(int fd)
2760 d->socket_notifiers_.take(fd)->setEnabled(false);
2764 void GuiApplication::commitData(QSessionManager & sm)
2766 /** The implementation is required to avoid an application exit
2767 ** when session state save is triggered by session manager.
2768 ** The default implementation sends a close event to all
2769 ** visible top level widgets when session managment allows
2771 ** We are changing that to check the state of each buffer in all
2772 ** views and ask the users what to do if buffers are dirty.
2773 ** Furthermore, we save the session state.
2774 ** We do NOT close the views here since the user still can cancel
2775 ** the logout process (see #9277); also, this would hide LyX from
2776 ** an OSes own session handling (application restoration).
2778 #ifdef QT_NO_SESSIONMANAGER
2780 #warning Qt is compiled without session manager
2782 #pragma message("warning: Qt is compiled without session manager")
2786 if (sm.allowsInteraction() && !prepareAllViewsForLogout())
2794 void GuiApplication::unregisterView(GuiView * gv)
2796 if(d->views_.contains(gv->id()) && d->views_.value(gv->id()) == gv) {
2797 d->views_.remove(gv->id());
2798 if (current_view_ == gv)
2804 bool GuiApplication::closeAllViews()
2806 if (d->views_.empty())
2809 // When a view/window was closed before without quitting LyX, there
2810 // are already entries in the lastOpened list.
2811 theSession().lastOpened().clear();
2813 QList<GuiView *> const views = d->views_.values();
2814 for (GuiView * view : views) {
2815 if (!view->closeScheduled())
2824 bool GuiApplication::prepareAllViewsForLogout()
2826 if (d->views_.empty())
2829 QList<GuiView *> const views = d->views_.values();
2830 for (GuiView * view : views) {
2831 if (!view->prepareAllBuffersForLogout())
2839 GuiView & GuiApplication::view(int id) const
2841 LAPPERR(d->views_.contains(id));
2842 return *d->views_.value(id);
2846 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
2848 QList<GuiView *> const views = d->views_.values();
2849 for (GuiView * view : views)
2850 view->hideDialog(name, inset);
2854 Buffer const * GuiApplication::updateInset(Inset const * inset) const
2856 Buffer const * buffer_ = 0;
2857 QHash<int, GuiView *>::const_iterator end = d->views_.end();
2858 for (QHash<int, GuiView *>::iterator it = d->views_.begin(); it != end; ++it) {
2859 if (Buffer const * ptr = (*it)->updateInset(inset))
2866 bool GuiApplication::searchMenu(FuncRequest const & func,
2867 docstring_list & names) const
2869 return d->menus_.searchMenu(func, names);
2873 // Ensure that a file is read only once (prevents include loops)
2874 static QStringList uifiles;
2875 // store which ui files define Toolbars
2876 static QStringList toolbar_uifiles;
2879 GuiApplication::ReturnValues GuiApplication::readUIFile(FileName ui_path)
2890 LexerKeyword uitags[] = {
2891 { "format", ui_format },
2892 { "include", ui_include },
2893 { "menuset", ui_menuset },
2894 { "toolbars", ui_toolbars },
2895 { "toolbarset", ui_toolbarset }
2899 lex.setFile(ui_path);
2901 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
2905 if (lyxerr.debugging(Debug::PARSER))
2906 lex.printTable(lyxerr);
2909 // format before introduction of format tag
2910 unsigned int format = 0;
2911 while (lex.isOK()) {
2912 int const status = lex.lex();
2914 // we have to do this check here, outside the switch,
2915 // because otherwise we would start reading include files,
2916 // e.g., if the first tag we hit was an include tag.
2917 if (status == ui_format)
2919 format = lex.getInteger();
2923 // this will trigger unless the first tag we hit is a format
2924 // tag, with the right format.
2925 if (format != LFUN_FORMAT)
2926 return FormatMismatch;
2929 case Lexer::LEX_FEOF:
2934 QString const file = toqstr(lex.getString());
2935 bool const success = readUIFile(file, true);
2937 LYXERR0("Failed to read inlcuded file: " << fromqstr(file));
2944 d->menus_.read(lex);
2948 d->toolbars_.readToolbars(lex);
2952 d->toolbars_.readToolbarSettings(lex);
2953 toolbar_uifiles.push_back(toqstr(ui_path.absFileName()));
2957 if (!rtrim(lex.getString()).empty())
2958 lex.printError("LyX::ReadUIFile: "
2959 "Unknown menu tag: `$$Token'");
2961 LYXERR0("Error with status: " << status);
2967 return (error ? ReadError : ReadOK);
2971 bool GuiApplication::readUIFile(QString const & name, bool include)
2973 LYXERR(Debug::INIT, "About to read " << name << "...");
2977 ui_path = libFileSearch("ui", name, "inc");
2978 if (ui_path.empty())
2979 ui_path = libFileSearch("ui", changeExtension(name, "inc"));
2981 ui_path = libFileSearch("ui", name, "ui");
2984 if (ui_path.empty()) {
2985 static const QString defaultUIFile = "default";
2986 LYXERR(Debug::INIT, "Could not find " << name);
2988 Alert::warning(_("Could not find UI definition file"),
2989 bformat(_("Error while reading the included file\n%1$s\n"
2990 "Please check your installation."), qstring_to_ucs4(name)));
2993 if (name == defaultUIFile) {
2994 LYXERR(Debug::INIT, "Could not find default UI file!!");
2995 Alert::warning(_("Could not find default UI file"),
2996 _("LyX could not find the default UI file!\n"
2997 "Please check your installation."));
3000 Alert::warning(_("Could not find UI definition file"),
3001 bformat(_("Error while reading the configuration file\n%1$s\n"
3002 "Falling back to default.\n"
3003 "Please look under Tools>Preferences>User Interface and\n"
3004 "check which User Interface file you are using."), qstring_to_ucs4(name)));
3005 return readUIFile(defaultUIFile, false);
3008 QString const uifile = toqstr(ui_path.absFileName());
3009 if (uifiles.contains(uifile)) {
3011 // We are reading again the top uifile so reset the safeguard:
3014 d->toolbars_.reset();
3016 LYXERR(Debug::INIT, "UI file '" << name << "' has been read already. "
3017 << "Is this an include loop?");
3021 uifiles.push_back(uifile);
3023 LYXERR(Debug::INIT, "Found " << name << " in " << ui_path);
3025 ReturnValues retval = readUIFile(ui_path);
3027 if (retval == FormatMismatch) {
3028 LYXERR(Debug::FILES, "Converting ui file to format " << LFUN_FORMAT);
3029 TempFile tmp("convertXXXXXX.ui");
3030 FileName const tempfile = tmp.name();
3031 bool const success = prefs2prefs(ui_path, tempfile, true);
3033 LYXERR0("Unable to convert " << ui_path.absFileName() <<
3034 " to format " << LFUN_FORMAT << ".");
3036 retval = readUIFile(tempfile);
3040 if (retval != ReadOK) {
3041 LYXERR0("Unable to read UI file: " << ui_path.absFileName());
3049 settings.beginGroup("ui_files");
3050 bool touched = false;
3051 for (int i = 0; i != uifiles.size(); ++i) {
3052 QFileInfo fi(uifiles[i]);
3053 QDateTime const date_value = fi.lastModified();
3054 QString const name_key = QString::number(i);
3055 // if an ui file which defines Toolbars has changed,
3056 // we have to reset the settings
3057 if (toolbar_uifiles.contains(uifiles[i])
3058 && (!settings.contains(name_key)
3059 || settings.value(name_key).toString() != uifiles[i]
3060 || settings.value(name_key + "/date").toDateTime() != date_value)) {
3062 settings.setValue(name_key, uifiles[i]);
3063 settings.setValue(name_key + "/date", date_value);
3066 settings.endGroup();
3068 settings.remove("views");
3074 void GuiApplication::onLastWindowClosed()
3076 if (d->global_menubar_)
3077 d->global_menubar_->grabKeyboard();
3081 void GuiApplication::startLongOperation() {
3082 d->key_checker_.start();
3086 bool GuiApplication::longOperationCancelled() {
3087 return d->key_checker_.pressed();
3091 void GuiApplication::stopLongOperation() {
3092 d->key_checker_.stop();
3096 bool GuiApplication::longOperationStarted() {
3097 return d->key_checker_.started();
3101 ////////////////////////////////////////////////////////////////////////
3103 // X11 specific stuff goes here...
3106 bool GuiApplication::x11EventFilter(XEvent * xev)
3111 switch (xev->type) {
3112 case SelectionRequest: {
3113 if (xev->xselectionrequest.selection != XA_PRIMARY)
3115 LYXERR(Debug::SELECTION, "X requested selection.");
3116 BufferView * bv = current_view_->currentBufferView();
3118 docstring const sel = bv->requestSelection();
3120 d->selection_.put(sel);
3124 case SelectionClear: {
3125 if (xev->xselectionclear.selection != XA_PRIMARY)
3127 LYXERR(Debug::SELECTION, "Lost selection.");
3128 BufferView * bv = current_view_->currentBufferView();
3130 bv->clearSelection();
3136 #elif defined(QPA_XCB)
3137 bool GuiApplication::nativeEventFilter(const QByteArray & eventType,
3138 void * message, long *)
3140 if (!current_view_ || eventType != "xcb_generic_event_t")
3143 xcb_generic_event_t * ev = static_cast<xcb_generic_event_t *>(message);
3145 switch (ev->response_type) {
3146 case XCB_SELECTION_REQUEST: {
3147 xcb_selection_request_event_t * srev =
3148 reinterpret_cast<xcb_selection_request_event_t *>(ev);
3149 if (srev->selection != XCB_ATOM_PRIMARY)
3151 LYXERR(Debug::SELECTION, "X requested selection.");
3152 BufferView * bv = current_view_->currentBufferView();
3154 docstring const sel = bv->requestSelection();
3156 d->selection_.put(sel);
3160 case XCB_SELECTION_CLEAR: {
3161 xcb_selection_clear_event_t * scev =
3162 reinterpret_cast<xcb_selection_clear_event_t *>(ev);
3163 if (scev->selection != XCB_ATOM_PRIMARY)
3165 LYXERR(Debug::SELECTION, "Lost selection.");
3166 BufferView * bv = current_view_->currentBufferView();
3168 bv->clearSelection();
3176 } // namespace frontend
3179 void hideDialogs(std::string const & name, Inset * inset)
3182 frontend::guiApp->hideDialogs(name, inset);
3186 ////////////////////////////////////////////////////////////////////
3190 ////////////////////////////////////////////////////////////////////
3192 frontend::FontLoader & theFontLoader()
3194 LAPPERR(frontend::guiApp);
3195 return frontend::guiApp->fontLoader();
3199 frontend::FontMetrics const & theFontMetrics(Font const & f)
3201 return theFontMetrics(f.fontInfo());
3205 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
3207 LAPPERR(frontend::guiApp);
3208 return frontend::guiApp->fontLoader().metrics(f);
3212 ////////////////////////////////////////////////////////////////////
3216 ////////////////////////////////////////////////////////////////////
3218 frontend::Clipboard & theClipboard()
3220 LAPPERR(frontend::guiApp);
3221 return frontend::guiApp->clipboard();
3225 frontend::Selection & theSelection()
3227 LAPPERR(frontend::guiApp);
3228 return frontend::guiApp->selection();
3234 #include "moc_GuiApplication.cpp"