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 "CutAndPaste.h"
39 #include "ErrorList.h"
41 #include "FuncRequest.h"
42 #include "FuncStatus.h"
43 #include "GuiWorkArea.h"
47 #include "LaTeXPackages.h"
50 #include "LyXAction.h"
52 #include "Paragraph.h"
55 #include "SpellChecker.h"
56 #include "Thesaurus.h"
59 #include "insets/InsetText.h"
61 #include "support/convert.h"
62 #include "support/debug.h"
63 #include "support/ExceptionMessage.h"
64 #include "support/FileName.h"
65 #include "support/filetools.h"
66 #include "support/foreach.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"
88 #include <QDesktopWidget>
92 #include <QFileOpenEvent>
96 #include <QImageReader>
99 #include <QLibraryInfo>
105 #include <QPixmapCache>
107 #include <QSessionManager>
109 #include <QShowEvent>
110 #include <QSocketNotifier>
111 #include <QSortFilterProxyModel>
112 #include <QStandardItemModel>
113 #include <QTextCodec>
115 #include <QTranslator>
116 #include <QThreadPool>
120 #include <X11/Xatom.h>
121 #include <X11/Xlib.h>
124 #elif defined(QPA_XCB)
128 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
129 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
130 #if (QT_VERSION < 0x050000)
131 #include <QWindowsMime>
132 #define QWINDOWSMIME QWindowsMime
135 #define QWINDOWSMIME QWinMime
145 #include <QMacPasteboardMime>
148 #include "support/bind.h"
149 #include <boost/crc.hpp>
156 using namespace lyx::support;
159 static void initializeResources()
161 static bool initialized = false;
163 Q_INIT_RESOURCE(Resources);
171 frontend::Application * createApplication(int & argc, char * argv[])
173 #if !defined(Q_WS_X11) && !defined(QPA_XCB)
174 // prune -geometry argument(s) by shifting
175 // the following ones 2 places down.
176 for (int i = 0 ; i < argc ; ++i) {
177 if (strcmp(argv[i], "-geometry") == 0) {
178 int const remove = (i+1) < argc ? 2 : 1;
180 for (int j = i; j < argc; ++j)
181 argv[j] = argv[j + remove];
186 frontend::GuiApplication * guiApp = new frontend::GuiApplication(argc, argv);
187 // I'd rather do that in the constructor, but I do not think that
188 // the palette is accessible there.
189 guiApp->colorCache().setPalette(guiApp->palette());
198 if (lyxrc.gui_language == "auto") {
199 theLocale = QLocale::system();
200 code = fromqstr(theLocale.name());
202 Language const * l = languages.getLanguage(lyxrc.gui_language);
203 code = l ? l->code() : "C";
204 theLocale = QLocale(toqstr(code));
206 // Qt tries to outsmart us and transforms en_US to C.
207 Messages::guiLanguage((code == "C") ? "en_US" : code);
208 QLocale::setDefault(theLocale);
209 setlocale(LC_NUMERIC, "C");
216 /// Return the list of loadable formats.
217 vector<string> loadableImageFormats()
221 QList<QByteArray> qt_formats = QImageReader::supportedImageFormats();
223 LYXERR(Debug::GRAPHICS,
224 "\nThe image loader can load the following directly:\n");
226 if (qt_formats.empty())
227 LYXERR(Debug::GRAPHICS, "\nQt4 Problem: No Format available!");
229 for (QList<QByteArray>::const_iterator it = qt_formats.begin(); it != qt_formats.end(); ++it) {
231 LYXERR(Debug::GRAPHICS, (const char *) *it << ", ");
233 string ext = ascii_lowercase((const char *) *it);
244 ////////////////////////////////////////////////////////////////////////
246 // Icon loading support code
248 ////////////////////////////////////////////////////////////////////////
258 bool operator<(PngMap const & lhs, PngMap const & rhs)
260 return lhs.key < rhs.key;
266 CompareKey(QString const & name) : name_(name) {}
267 bool operator()(PngMap const & other) const { return other.key == name_; }
273 // this must be sorted alphabetically
274 // Upper case comes before lower case
275 // Please don't change the formatting, this list is parsed by
276 // development/tools/generate_symbols_images.py.
277 PngMap sorted_png_map[] = {
278 { "Arrownot", "arrownot2"},
279 { "Arrowvert", "arrowvert2"},
280 { "Bowtie", "bowtie2" },
282 { "Bumpeq", "bumpeq2" },
283 { "CIRCLE", "circle3" },
285 { "CheckedBox", "checkedbox2" },
286 { "Circle", "circle2" },
287 { "Colonapprox", "colonapprox2" },
288 { "Coloneq", "coloneq2" },
289 { "Coloneqq", "coloneqq2" },
290 { "Colonsim", "colonsim2" },
292 { "DOWNarrow", "downarrow3" },
293 { "Delta", "delta2" },
294 { "Diamond", "diamond2" },
295 { "Doteq", "doteq2" },
296 { "Downarrow", "downarrow2" },
297 { "Eqcolon", "eqcolon2" },
298 { "Eqqcolon", "eqqcolon2" },
299 { "Gamma", "gamma2" },
301 { "LEFTCIRCLE", "leftcircle3" },
302 { "LEFTarrow", "leftarrow3" },
303 { "LEFTcircle", "leftcircle4" },
305 { "Lambda", "lambda2" },
307 { "Leftarrow", "leftarrow2" },
308 { "Leftcircle", "leftcircle2" },
309 { "Leftrightarrow", "leftrightarrow2" },
310 { "Longarrownot", "longarrownot2"},
311 { "Longleftarrow", "longleftarrow2" },
312 { "Longleftrightarrow", "longleftrightarrow2" },
313 { "Longmapsfrom", "longmapsfrom2"},
314 { "Longmapsto", "longmapsto2"},
315 { "Longrightarrow", "longrightarrow2" },
316 { "Mapsfrom", "mapsfrom2"},
317 { "Mapsfromchar", "mapsfromchar2"},
318 { "Mapsto", "mapsto2"},
319 { "Mapstochar", "mapstochar2"},
320 { "Omega", "omega2" },
325 { "RIGHTCIRCLE", "rightcircle3" },
326 { "RIGHTarrow", "rightarrow3" },
327 { "RIGHTcircle", "rightcircle4" },
329 { "Rightarrow", "rightarrow2" },
330 { "Rightcircle", "rightcircle2" },
331 { "Sigma", "sigma2" },
332 { "Square", "square2" },
333 { "Subset", "subset2" },
334 { "Supset", "supset2" },
335 { "Theta", "theta2" },
336 { "Thorn", "thorn2" },
337 { "UParrow", "uparrow3" },
338 { "Uparrow", "uparrow2" },
339 { "Updownarrow", "updownarrow2" },
340 { "Upsilon", "upsilon2" },
341 { "Vdash", "vdash3" },
346 { "lVert", "vert2" },
348 { "nLeftarrow", "nleftarrow2" },
349 { "nLeftrightarrow", "nleftrightarrow2" },
350 { "nRightarrow", "nrightarrow2" },
351 { "nVDash", "nvdash3" },
352 { "nVdash", "nvdash4" },
353 { "nvDash", "nvdash2" },
354 { "rVert", "vert2" },
356 { "textrm \\AA", "textrm_AA"},
357 { "textrm \\O", "textrm_O"},
358 { "vDash", "vdash2" },
359 { "varDelta", "vardelta2" },
360 { "varGamma", "vargamma2" },
361 { "varLambda", "varlambda2" },
362 { "varOmega", "varomega2" },
363 { "varPhi", "varphi2" },
364 { "varPi", "varpi2" },
365 { "varPsi", "varpsi2" },
366 { "varSigma", "varsigma2" },
367 { "varTheta", "vartheta2" },
368 { "varUpsilon", "varupsilon2" },
369 { "varXi", "varxi2" }
373 size_t const nr_sorted_png_map = sizeof(sorted_png_map) / sizeof(PngMap);
375 // This list specifies which system's theme icon is related to which lyx
376 // command. It was based on:
377 // http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
378 // this must be sorted alphabetically
379 // Upper case comes before lower case
380 PngMap sorted_theme_icon_map[] = {
381 { "bookmark-goto 0", "go-jump" },
382 { "buffer-new", "document-new" },
383 { "buffer-print", "document-print" },
384 { "buffer-write", "document-save" },
385 { "buffer-write-as", "document-save-as" },
386 { "buffer-zoom-in", "zoom-in" },
387 { "buffer-zoom-out", "zoom-out" },
388 { "copy", "edit-copy" },
389 { "cut", "edit-cut" },
390 { "depth-decrement", "format-indent-less" },
391 { "depth-increment", "format-indent-more" },
392 { "dialog-show print", "document-print" },
393 { "dialog-show spellchecker", "tools-check-spelling" },
394 { "dialog-show-new-inset graphics", "insert-image" },
395 { "dialog-toggle findreplaceadv", "edit-find-replace" },
396 { "file-open", "document-open" },
397 { "font-bold", "format-text-bold" },
398 { "font-ital", "format-text-italic" },
399 { "font-strikeout", "format-text-strikethrough" },
400 { "font-underline", "format-text-underline" },
401 { "lyx-quit", "application-exit" },
402 { "paste", "edit-paste" },
403 { "redo", "edit-redo" },
404 { "undo", "edit-undo" },
405 { "window-close", "window-close" },
406 { "window-new", "window-new" }
409 size_t const nr_sorted_theme_icon_map = sizeof(sorted_theme_icon_map) / sizeof(PngMap);
412 QString findPng(QString const & name)
414 PngMap const * const begin = sorted_png_map;
415 PngMap const * const end = begin + nr_sorted_png_map;
416 LATTEST(sorted(begin, end));
418 PngMap const * const it = find_if(begin, end, CompareKey(name));
422 png_name = it->value;
425 png_name.replace('_', "underscore");
426 png_name.replace(' ', '_');
428 // This way we can have "math-delim { }" on the toolbar.
429 png_name.replace('(', "lparen");
430 png_name.replace(')', "rparen");
431 png_name.replace('[', "lbracket");
432 png_name.replace(']', "rbracket");
433 png_name.replace('{', "lbrace");
434 png_name.replace('}', "rbrace");
435 png_name.replace('|', "bars");
436 png_name.replace(',', "thinspace");
437 png_name.replace(':', "mediumspace");
438 png_name.replace(';', "thickspace");
439 png_name.replace('!', "negthinspace");
442 LYXERR(Debug::GUI, "findPng(" << name << ")\n"
443 << "Looking for math PNG called \"" << png_name << '"');
450 QString themeIconName(QString const & action)
452 PngMap const * const begin = sorted_theme_icon_map;
453 PngMap const * const end = begin + nr_sorted_theme_icon_map;
454 LASSERT(sorted(begin, end), /**/);
456 PngMap const * const it = find_if(begin, end, CompareKey(action));
464 QString iconName(FuncRequest const & f, bool unknown)
466 initializeResources();
470 switch (f.action()) {
471 case LFUN_MATH_INSERT:
472 if (!f.argument().empty()) {
474 name1 = findPng(toqstr(f.argument()).mid(1));
477 case LFUN_MATH_DELIM:
478 case LFUN_MATH_BIGDELIM:
480 name1 = findPng(toqstr(f.argument()));
484 name1 = toqstr(f.argument());
486 case LFUN_COMMAND_ALTERNATIVES: {
487 // use the first of the alternative commands
489 docstring dummy = split(f.argument(), firstcom, ';');
490 name1 = toqstr(firstcom);
491 // FIXME: we should rename the icons to tabular-xxx instead of
492 // "tabular-feature-xxx"
493 name1.replace("inset-modify tabular", "tabular-feature");
494 name1.replace(' ', '_');
497 case LFUN_INSET_MODIFY: {
498 // FIXME: we should rename the icons to tabular-xxx instead of
499 // "tabular-feature-xxx" and generalize this naming to all
500 // insets, not to tabular using ones.
502 string const command = split(to_utf8(f.argument()), inset_name, ' ');
503 if (insetCode(inset_name) == TABULAR_CODE) {
504 name1 = "tabular-feature "+ toqstr(command);
505 name1.replace(' ', '_');
510 name2 = toqstr(lyxaction.getActionName(f.action()));
513 if (!f.argument().empty()) {
514 name1 = name2 + ' ' + toqstr(f.argument());
515 name1.replace(' ', '_');
516 name1.replace('\\', "backslash");
520 QStringList imagedirs;
521 imagedirs << "images/" << "images/ipa/";
522 search_mode mode = theGuiApp()->imageSearchMode();
523 for (int i = 0; i < imagedirs.size(); ++i) {
524 QString imagedir = imagedirs.at(i) + path;
525 FileName fname = imageLibFileSearch(imagedir, name1, "svgz,png", mode);
527 return toqstr(fname.absFileName());
529 fname = imageLibFileSearch(imagedir, name2, "svgz,png", mode);
531 return toqstr(fname.absFileName());
534 path = ":/images/" + path;
537 LYXERR0("Directory " << path << " not found in resource!");
540 if (res.exists(name1 + ".svgz"))
541 return path + name1 + ".svgz";
542 else if (res.exists(name1 + ".png"))
543 return path + name1 + ".png";
545 if (res.exists(name2 + ".svgz"))
546 return path + name2 + ".svgz";
547 else if (res.exists(name2 + ".png"))
548 return path + name2 + ".png";
550 LYXERR(Debug::GUI, "Cannot find icon with filename "
551 << "\"" << name1 << ".{svgz,png}\""
553 << "\"" << name2 << ".{svgz,png}\""
555 << lyxaction.getActionName(f.action())
556 << '(' << to_utf8(f.argument()) << ")\"");
559 QString imagedir = "images/";
560 FileName fname = imageLibFileSearch(imagedir, "unknown", "svgz,png", mode);
562 return toqstr(fname.absFileName());
563 return QString(":/images/unknown.png");
570 bool getPixmap(QPixmap & pixmap, QString const & path)
572 if (pixmap.load(path)) {
573 #if QT_VERSION >= 0x050000
574 if (path.endsWith(".svgz") || path.endsWith(".svg") ) {
575 GuiApplication const * guiApp = theGuiApp();
577 pixmap.setDevicePixelRatio(guiApp->pixelRatio());
587 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext)
589 QString imagedir = path;
590 FileName fname = imageLibFileSearch(imagedir, name, ext, theGuiApp()->imageSearchMode());
591 QString fpath = toqstr(fname.absFileName());
592 QPixmap pixmap = QPixmap();
594 if (getPixmap(pixmap, fpath)) {
598 QStringList exts = ext.split(",");
599 fpath = ":/" + path + name + ".";
600 for (int i = 0; i < exts.size(); ++i) {
601 if (getPixmap(pixmap, fpath + exts.at(i))) {
606 bool const list = ext.contains(",");
607 LYXERR0("Cannot load pixmap \""
608 << path << name << "." << (list ? "{" : "") << ext
609 << (list ? "}" : "") << "\", please verify resource system!");
615 QIcon getIcon(FuncRequest const & f, bool unknown)
617 #if (QT_VERSION >= 0x040600)
618 if (lyxrc.use_system_theme_icons) {
619 QString action = toqstr(lyxaction.getActionName(f.action()));
620 if (!f.argument().empty())
621 action += " " + toqstr(f.argument());
622 QString const theme_icon = themeIconName(action);
623 if (QIcon::hasThemeIcon(theme_icon))
624 return QIcon::fromTheme(theme_icon);
628 QString icon = iconName(f, unknown);
632 //LYXERR(Debug::GUI, "Found icon: " << icon);
633 QPixmap pixmap = QPixmap();
634 if (!getPixmap(pixmap,icon)) {
635 LYXERR0("Cannot load icon " << icon << " please verify resource system!");
639 return QIcon(pixmap);
643 ////////////////////////////////////////////////////////////////////////
645 // LyX server support code.
647 ////////////////////////////////////////////////////////////////////////
649 class SocketNotifier : public QSocketNotifier
652 /// connect a connection notification from the LyXServerSocket
653 SocketNotifier(QObject * parent, int fd, Application::SocketCallback func)
654 : QSocketNotifier(fd, QSocketNotifier::Read, parent), func_(func)
658 /// The callback function
659 Application::SocketCallback func_;
663 ////////////////////////////////////////////////////////////////////////
665 // Mac specific stuff goes here...
667 ////////////////////////////////////////////////////////////////////////
669 class MenuTranslator : public QTranslator
672 MenuTranslator(QObject * parent)
673 : QTranslator(parent)
676 #if QT_VERSION >= 0x050000
677 virtual QString translate(const char * /* context */,
678 const char *sourceText,
679 const char * /* disambiguation */ = 0, int /* n */ = -1) const
681 QString translate(const char * /*context*/,
682 const char * sourceText,
683 const char * /*comment*/ = 0) const
686 string const s = sourceText;
687 if (s == N_("About %1") || s == N_("Preferences")
688 || s == N_("Reconfigure") || s == N_("Quit %1"))
696 // QMacPasteboardMimeGraphics can only be compiled on Mac.
698 class QMacPasteboardMimeGraphics : public QMacPasteboardMime
701 QMacPasteboardMimeGraphics()
702 : QMacPasteboardMime(MIME_QT_CONVERTOR|MIME_ALL)
705 QString convertorName() { return "Graphics"; }
707 QString flavorFor(QString const & mime)
709 LYXERR(Debug::ACTION, "flavorFor " << mime);
710 if (mime == pdfMimeType())
711 return QLatin1String("com.adobe.pdf");
715 QString mimeFor(QString flav)
717 LYXERR(Debug::ACTION, "mimeFor " << flav);
718 if (flav == QLatin1String("com.adobe.pdf"))
719 return pdfMimeType();
723 bool canConvert(QString const & mime, QString flav)
725 return mimeFor(flav) == mime;
728 QVariant convertToMime(QString const & /*mime*/, QList<QByteArray> data,
732 qWarning("QMacPasteboardMimeGraphics: Cannot handle multiple member data");
736 QList<QByteArray> convertFromMime(QString const & /*mime*/,
737 QVariant data, QString /*flav*/)
739 QList<QByteArray> ret;
740 ret.append(data.toByteArray());
746 ///////////////////////////////////////////////////////////////
748 // You can find more platform specific stuff at the end of this file...
750 ///////////////////////////////////////////////////////////////
752 ////////////////////////////////////////////////////////////////////////
753 // Windows specific stuff goes here...
755 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
756 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
757 // QWindowsMimeMetafile can only be compiled on Windows.
759 static FORMATETC cfFromMime(QString const & mimetype)
762 if (mimetype == emfMimeType()) {
763 formatetc.cfFormat = CF_ENHMETAFILE;
764 formatetc.tymed = TYMED_ENHMF;
765 } else if (mimetype == wmfMimeType()) {
766 formatetc.cfFormat = CF_METAFILEPICT;
767 formatetc.tymed = TYMED_MFPICT;
770 formatetc.dwAspect = DVASPECT_CONTENT;
771 formatetc.lindex = -1;
776 class QWindowsMimeMetafile : public QWINDOWSMIME {
778 QWindowsMimeMetafile() {}
780 bool canConvertFromMime(FORMATETC const & formatetc,
781 QMimeData const * mimedata) const
786 bool canConvertToMime(QString const & mimetype,
787 IDataObject * pDataObj) const
789 if (mimetype != emfMimeType() && mimetype != wmfMimeType())
791 FORMATETC formatetc = cfFromMime(mimetype);
792 return pDataObj->QueryGetData(&formatetc) == S_OK;
795 bool convertFromMime(FORMATETC const & formatetc,
796 const QMimeData * mimedata, STGMEDIUM * pmedium) const
801 QVariant convertToMime(QString const & mimetype, IDataObject * pDataObj,
802 QVariant::Type preferredType) const
805 if (!canConvertToMime(mimetype, pDataObj))
808 FORMATETC formatetc = cfFromMime(mimetype);
810 if (pDataObj->GetData(&formatetc, &s) != S_OK)
814 if (s.tymed == TYMED_ENHMF) {
815 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, 0, 0);
816 data.resize(dataSize);
817 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, dataSize,
818 (LPBYTE)data.data());
819 } else if (s.tymed == TYMED_MFPICT) {
820 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, 0, 0);
821 data.resize(dataSize);
822 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, dataSize,
823 (LPBYTE)data.data());
826 ReleaseStgMedium(&s);
832 QVector<FORMATETC> formatsForMime(QString const & mimetype,
833 QMimeData const * mimedata) const
835 QVector<FORMATETC> formats;
836 if (mimetype == emfMimeType() || mimetype == wmfMimeType())
837 formats += cfFromMime(mimetype);
841 QString mimeForFormat(FORMATETC const & formatetc) const
843 switch (formatetc.cfFormat) {
845 return emfMimeType();
846 case CF_METAFILEPICT:
847 return wmfMimeType();
857 /// Allows to check whether ESC was pressed during a long operation
858 class KeyChecker : public QObject {
863 KeyChecker() : pressed_(false), started_(false) {}
866 QCoreApplication::instance()->installEventFilter(this);
871 QCoreApplication::instance()->removeEventFilter(this);
875 QCoreApplication::processEvents();
878 bool started() const {
881 bool eventFilter(QObject *obj, QEvent *event) {
882 LYXERR(Debug::ACTION, "Event Type: " << event->type());
883 switch (event->type()) {
887 case QEvent::UpdateRequest:
888 case QEvent::CursorChange:
889 case QEvent::ActionChanged:
890 case QEvent::EnabledChange:
891 case QEvent::SockAct:
894 case QEvent::ToolTipChange:
895 case QEvent::LayoutRequest:
896 case QEvent::MetaCall:
897 return QObject::eventFilter(obj, event);
899 // FIXME Blocking all these events is a bad idea.
900 QKeyEvent *keyEvent = dynamic_cast<QKeyEvent*>(event);
901 if (keyEvent && keyEvent->key() == Qt::Key_Escape)
909 ////////////////////////////////////////////////////////////////////////
910 // GuiApplication::Private definition and implementation.
911 ////////////////////////////////////////////////////////////////////////
913 struct GuiApplication::Private
915 Private(): language_model_(0), meta_fake_bit(NoModifier),
918 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
919 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
920 /// WMF Mime handler for Windows clipboard.
921 wmf_mime_ = new QWindowsMimeMetafile;
924 initKeySequences(&theTopLevelKeymap());
927 void initKeySequences(KeyMap * kb)
929 keyseq = KeySequence(kb, kb);
930 cancel_meta_seq = KeySequence(kb, kb);
934 QSortFilterProxyModel * language_model_;
936 GuiClipboard clipboard_;
938 GuiSelection selection_;
940 FontLoader font_loader_;
942 ColorCache color_cache_;
944 QTranslator qt_trans_;
946 QHash<int, SocketNotifier *> socket_notifiers_;
950 /// The global instance
953 /// this timer is used for any regular events one wants to
954 /// perform. at present it is used to check if forked processes
956 QTimer general_timer_;
958 /// delayed FuncRequests
959 std::queue<FuncRequest> func_request_queue_;
964 KeySequence cancel_meta_seq;
966 KeyModifier meta_fake_bit;
968 /// Multiple views container.
970 * Warning: This must not be a smart pointer as the destruction of the
971 * object is handled by Qt when the view is closed
972 * \sa Qt::WA_DeleteOnClose attribute.
974 QHash<int, GuiView *> views_;
976 /// Only used on mac.
977 QMenuBar * global_menubar_;
980 /// Linkback mime handler for MacOSX.
981 QMacPasteboardMimeGraphics mac_pasteboard_mime_;
984 #if (QT_VERSION < 0x050000) || (QT_VERSION >= 0x050400)
985 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
986 /// WMF Mime handler for Windows clipboard.
987 QWindowsMimeMetafile * wmf_mime_;
991 /// Allows to check whether ESC was pressed during a long operation
992 KeyChecker key_checker_;
996 GuiApplication * guiApp;
998 GuiApplication::~GuiApplication()
1001 closeAllLinkBackLinks();
1007 GuiApplication::GuiApplication(int & argc, char ** argv)
1008 : QApplication(argc, argv), current_view_(0),
1009 d(new GuiApplication::Private)
1011 QString app_name = "LyX";
1012 QCoreApplication::setOrganizationName(app_name);
1013 QCoreApplication::setOrganizationDomain("lyx.org");
1014 QCoreApplication::setApplicationName(lyx_package);
1016 qsrand(QDateTime::currentDateTime().toTime_t());
1018 // Install translator for GUI elements.
1019 installTranslator(&d->qt_trans_);
1022 // Enable reception of XCB events.
1023 installNativeEventFilter(this);
1026 // FIXME: quitOnLastWindowClosed is true by default. We should have a
1027 // lyxrc setting for this in order to let the application stay resident.
1028 // But then we need some kind of dock icon, at least on Windows.
1030 if (lyxrc.quit_on_last_window_closed)
1031 setQuitOnLastWindowClosed(false);
1034 // FIXME: Do we need a lyxrc setting for this on Mac? This behaviour
1035 // seems to be the default case for applications like LyX.
1036 setQuitOnLastWindowClosed(false);
1037 // This allows to translate the strings that appear in the LyX menu.
1038 /// A translator suitable for the entries in the LyX menu.
1039 /// Only needed with Qt/Mac.
1040 installTranslator(new MenuTranslator(this));
1045 #if defined(Q_WS_X11) || defined(QPA_XCB)
1046 // doubleClickInterval() is 400 ms on X11 which is just too long.
1047 // On Windows and Mac OS X, the operating system's value is used.
1048 // On Microsoft Windows, calling this function sets the double
1049 // click interval for all applications. So we don't!
1050 QApplication::setDoubleClickInterval(300);
1053 connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
1055 // needs to be done before reading lyxrc
1057 lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
1061 // Set the cache to 5120 kilobytes which corresponds to screen size of
1062 // 1280 by 1024 pixels with a color depth of 32 bits.
1063 QPixmapCache::setCacheLimit(5120);
1065 // Initialize RC Fonts
1066 if (lyxrc.roman_font_name.empty())
1067 lyxrc.roman_font_name = fromqstr(romanFontName());
1069 if (lyxrc.sans_font_name.empty())
1070 lyxrc.sans_font_name = fromqstr(sansFontName());
1072 if (lyxrc.typewriter_font_name.empty())
1073 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
1075 d->general_timer_.setInterval(500);
1076 connect(&d->general_timer_, SIGNAL(timeout()),
1077 this, SLOT(handleRegularEvents()));
1078 d->general_timer_.start();
1080 // maxThreadCount() defaults in general to 2 on single or dual-processor.
1081 // This is clearly not enough in a time where we use threads for
1082 // document preview and/or export. 20 should be OK.
1083 QThreadPool::globalInstance()->setMaxThreadCount(20);
1087 GuiApplication * theGuiApp()
1089 return dynamic_cast<GuiApplication *>(theApp());
1093 double GuiApplication::pixelRatio() const
1095 #if QT_VERSION >= 0x050000
1096 return devicePixelRatio();
1103 void GuiApplication::clearSession()
1110 docstring Application::iconName(FuncRequest const & f, bool unknown)
1112 return qstring_to_ucs4(lyx::frontend::iconName(f, unknown));
1116 docstring Application::mathIcon(docstring const & c)
1118 return qstring_to_ucs4(findPng(toqstr(c)));
1122 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd) const
1126 BufferView * bv = 0;
1127 BufferView * doc_bv = 0;
1129 if (cmd.action() == LFUN_NOACTION) {
1130 status.message(from_utf8(N_("Nothing to do")));
1131 status.setEnabled(false);
1134 else if (cmd.action() == LFUN_UNKNOWN_ACTION) {
1135 status.setUnknown(true);
1136 status.message(from_utf8(N_("Unknown action")));
1137 status.setEnabled(false);
1140 // Does the GuiApplication know something?
1141 else if (getStatus(cmd, status)) { }
1143 // If we do not have a GuiView, then other functions are disabled
1144 else if (!current_view_)
1145 status.setEnabled(false);
1147 // Does the GuiView know something?
1148 else if (current_view_->getStatus(cmd, status)) { }
1150 // In LyX/Mac, when a dialog is open, the menus of the
1151 // application can still be accessed without giving focus to
1152 // the main window. In this case, we want to disable the menu
1153 // entries that are buffer or view-related.
1154 //FIXME: Abdel (09/02/10) This has very bad effect on Linux, don't know why...
1156 else if (cmd.origin() == FuncRequest::MENU && !current_view_->hasFocus())
1157 status.setEnabled(false);
1160 // If we do not have a BufferView, then other functions are disabled
1161 else if (!(bv = current_view_->currentBufferView()))
1162 status.setEnabled(false);
1164 // Does the current BufferView know something?
1165 else if (bv->getStatus(cmd, status)) { }
1167 // Does the current Buffer know something?
1168 else if (bv->buffer().getStatus(cmd, status)) { }
1170 // If we do not have a document BufferView, different from the
1171 // current BufferView, then other functions are disabled
1172 else if (!(doc_bv = current_view_->documentBufferView()) || doc_bv == bv)
1173 status.setEnabled(false);
1175 // Does the document Buffer know something?
1176 else if (doc_bv->buffer().getStatus(cmd, status)) { }
1179 LYXERR(Debug::ACTION, "LFUN not handled in getStatus(): " << cmd);
1180 status.message(from_utf8(N_("Command not handled")));
1181 status.setEnabled(false);
1184 // the default error message if we disable the command
1185 if (!status.enabled() && status.message().empty())
1186 status.message(from_utf8(N_("Command disabled")));
1192 bool GuiApplication::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
1194 // I would really like to avoid having this switch and rather try to
1195 // encode this in the function itself.
1196 // -- And I'd rather let an inset decide which LFUNs it is willing
1197 // to handle (Andre')
1199 switch (cmd.action()) {
1201 // This could be used for the no-GUI version. The GUI version is handled in
1202 // GuiView::getStatus(). See above.
1204 case LFUN_BUFFER_WRITE:
1205 case LFUN_BUFFER_WRITE_AS: {
1206 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
1207 enable = b && (b->isUnnamed() || !b->isClean());
1212 case LFUN_BOOKMARK_GOTO: {
1213 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
1214 enable = theSession().bookmarks().isValid(num);
1218 case LFUN_BOOKMARK_CLEAR:
1219 enable = theSession().bookmarks().hasValid();
1222 // this one is difficult to get right. As a half-baked
1223 // solution, we consider only the first action of the sequence
1224 case LFUN_COMMAND_SEQUENCE: {
1225 // argument contains ';'-terminated commands
1226 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
1227 FuncRequest func(lyxaction.lookupFunc(firstcmd));
1228 func.setOrigin(cmd.origin());
1229 flag = getStatus(func);
1233 // we want to check if at least one of these is enabled
1234 case LFUN_COMMAND_ALTERNATIVES: {
1235 // argument contains ';'-terminated commands
1236 string arg = to_utf8(cmd.argument());
1237 while (!arg.empty()) {
1239 arg = split(arg, first, ';');
1240 FuncRequest func(lyxaction.lookupFunc(first));
1241 func.setOrigin(cmd.origin());
1242 flag = getStatus(func);
1243 // if this one is enabled, the whole thing is
1252 string name = to_utf8(cmd.argument());
1253 if (theTopLevelCmdDef().lock(name, func)) {
1254 func.setOrigin(cmd.origin());
1255 flag = getStatus(func);
1256 theTopLevelCmdDef().release(name);
1258 // catch recursion or unknown command
1259 // definition. all operations until the
1260 // recursion or unknown command definition
1261 // occurs are performed, so set the state to
1268 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1270 case LFUN_PREFERENCES_SAVE:
1271 case LFUN_BUFFER_SAVE_AS_DEFAULT:
1272 case LFUN_DEBUG_LEVEL_SET:
1273 // these are handled in our dispatch()
1276 case LFUN_WINDOW_CLOSE:
1277 enable = d->views_.size() > 0;
1280 case LFUN_BUFFER_NEW:
1281 case LFUN_BUFFER_NEW_TEMPLATE:
1282 case LFUN_FILE_OPEN:
1283 case LFUN_HELP_OPEN:
1284 case LFUN_SCREEN_FONT_UPDATE:
1285 case LFUN_SET_COLOR:
1286 case LFUN_WINDOW_NEW:
1288 case LFUN_LYXRC_APPLY:
1289 case LFUN_COMMAND_PREFIX:
1291 case LFUN_META_PREFIX:
1292 case LFUN_RECONFIGURE:
1293 case LFUN_SERVER_GET_FILENAME:
1294 case LFUN_SERVER_NOTIFY:
1298 case LFUN_BUFFER_FORALL: {
1299 if (theBufferList().empty()) {
1300 flag.message(from_utf8(N_("Command not allowed without a buffer open")));
1301 flag.setEnabled(false);
1305 FuncRequest const cmdToPass = lyxaction.lookupFunc(cmd.getLongArg(0));
1306 if (cmdToPass.action() == LFUN_UNKNOWN_ACTION) {
1307 flag.message(from_utf8(N_("the <LFUN-COMMAND> argument of buffer-forall is not valid")));
1308 flag.setEnabled(false);
1313 case LFUN_DIALOG_SHOW: {
1314 string const name = cmd.getArg(0);
1315 return name == "aboutlyx"
1317 || name == "texinfo"
1318 || name == "progress"
1319 || name == "compare";
1327 flag.setEnabled(false);
1331 /// make a post-dispatch status message
1332 static docstring makeDispatchMessage(docstring const & msg,
1333 FuncRequest const & cmd)
1335 const bool verbose = (cmd.origin() == FuncRequest::MENU
1336 || cmd.origin() == FuncRequest::TOOLBAR
1337 || cmd.origin() == FuncRequest::COMMANDBUFFER);
1339 if (cmd.action() == LFUN_SELF_INSERT || !verbose) {
1340 LYXERR(Debug::ACTION, "dispatch msg is " << msg);
1344 docstring dispatch_msg = msg;
1345 if (!dispatch_msg.empty())
1346 dispatch_msg += ' ';
1348 docstring comname = from_utf8(lyxaction.getActionName(cmd.action()));
1350 bool argsadded = false;
1352 if (!cmd.argument().empty()) {
1353 if (cmd.action() != LFUN_UNKNOWN_ACTION) {
1354 comname += ' ' + cmd.argument();
1358 docstring const shortcuts = theTopLevelKeymap().
1359 printBindings(cmd, KeySequence::ForGui);
1361 if (!shortcuts.empty())
1362 comname += ": " + shortcuts;
1363 else if (!argsadded && !cmd.argument().empty())
1364 comname += ' ' + cmd.argument();
1366 if (!comname.empty()) {
1367 comname = rtrim(comname);
1368 dispatch_msg += '(' + rtrim(comname) + ')';
1370 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1371 return dispatch_msg;
1375 void GuiApplication::dispatch(FuncRequest const & cmd)
1377 Buffer * buffer = 0;
1378 if (current_view_ && current_view_->currentBufferView()) {
1379 current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1380 buffer = ¤t_view_->currentBufferView()->buffer();
1382 buffer->undo().beginUndoGroup();
1386 // redraw the screen at the end (first of the two drawing steps).
1387 // This is done unless explicitly requested otherwise
1388 dr.screenUpdate(Update::FitCursor);
1390 updateCurrentView(cmd, dr);
1392 // the buffer may have been closed by one action
1393 if (theBufferList().isLoaded(buffer))
1394 buffer->undo().endUndoGroup();
1398 void GuiApplication::updateCurrentView(FuncRequest const & cmd, DispatchResult & dr)
1403 BufferView * bv = current_view_->currentBufferView();
1405 if (dr.needBufferUpdate()) {
1406 bv->cursor().clearBufferUpdate();
1407 bv->buffer().updateBuffer();
1409 // BufferView::update() updates the ViewMetricsInfo and
1410 // also initializes the position cache for all insets in
1411 // (at least partially) visible top-level paragraphs.
1412 // We will redraw the screen only if needed.
1413 bv->processUpdateFlags(dr.screenUpdate());
1415 // Do we have a selection?
1416 theSelection().haveSelection(bv->cursor().selection());
1419 current_view_->restartCursor();
1421 if (dr.needMessageUpdate()) {
1422 // Some messages may already be translated, so we cannot use _()
1423 current_view_->message(makeDispatchMessage(
1424 translateIfPossible(dr.message()), cmd));
1429 void GuiApplication::gotoBookmark(unsigned int idx, bool openFile,
1430 bool switchToBuffer)
1432 if (!theSession().bookmarks().isValid(idx))
1434 BookmarksSection::Bookmark const & bm =
1435 theSession().bookmarks().bookmark(idx);
1436 LASSERT(!bm.filename.empty(), return);
1437 string const file = bm.filename.absFileName();
1438 // if the file is not opened, open it.
1439 if (!theBufferList().exists(bm.filename)) {
1441 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
1445 // open may fail, so we need to test it again
1446 if (!theBufferList().exists(bm.filename))
1449 // bm can be changed when saving
1450 BookmarksSection::Bookmark tmp = bm;
1452 // Special case idx == 0 used for back-from-back jump navigation
1454 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
1456 // if the current buffer is not that one, switch to it.
1457 BufferView * doc_bv = current_view_ ?
1458 current_view_->documentBufferView() : 0;
1459 Cursor const old = doc_bv->cursor();
1460 if (!doc_bv || doc_bv->buffer().fileName() != tmp.filename) {
1461 if (switchToBuffer) {
1462 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
1465 doc_bv = current_view_->documentBufferView();
1470 // moveToPosition try paragraph id first and then paragraph (pit, pos).
1471 if (!doc_bv->moveToPosition(
1472 tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
1475 Cursor & cur = doc_bv->cursor();
1477 notifyCursorLeavesOrEnters(old, cur);
1483 // Cursor jump succeeded!
1484 pit_type new_pit = cur.pit();
1485 pos_type new_pos = cur.pos();
1486 int new_id = cur.paragraph().id();
1488 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
1489 // see http://www.lyx.org/trac/ticket/3092
1490 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
1491 || bm.top_id != new_id) {
1492 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
1493 new_pit, new_pos, new_id);
1497 // This function runs "configure" and then rereads lyx.defaults to
1498 // reconfigure the automatic settings.
1499 void GuiApplication::reconfigure(string const & option)
1501 // emit message signal.
1503 current_view_->message(_("Running configure..."));
1505 // Run configure in user lyx directory
1506 string const lock_file = package().getConfigureLockName();
1507 int fd = fileLock(lock_file.c_str());
1508 int const ret = package().reconfigureUserLyXDir(option);
1509 // emit message signal.
1511 current_view_->message(_("Reloading configuration..."));
1512 lyxrc.read(libFileSearch(QString(), "lyxrc.defaults"), false);
1513 // Re-read packages.lst
1514 LaTeXPackages::getAvailable();
1515 fileUnlock(fd, lock_file.c_str());
1518 Alert::information(_("System reconfiguration failed"),
1519 _("The system reconfiguration has failed.\n"
1520 "Default textclass is used but LyX may\n"
1521 "not be able to work properly.\n"
1522 "Please reconfigure again if needed."));
1524 Alert::information(_("System reconfigured"),
1525 _("The system has been reconfigured.\n"
1526 "You need to restart LyX to make use of any\n"
1527 "updated document class specifications."));
1530 void GuiApplication::validateCurrentView()
1532 if (!d->views_.empty() && !current_view_) {
1533 // currently at least one view exists but no view has the focus.
1534 // choose the last view to make it current.
1535 // a view without any open document is preferred.
1536 GuiView * candidate = 0;
1537 QHash<int, GuiView *>::const_iterator it = d->views_.begin();
1538 QHash<int, GuiView *>::const_iterator end = d->views_.end();
1539 for (; it != end; ++it) {
1541 if (!candidate->documentBufferView())
1544 setCurrentView(candidate);
1548 void GuiApplication::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1550 string const argument = to_utf8(cmd.argument());
1551 FuncCode const action = cmd.action();
1553 LYXERR(Debug::ACTION, "cmd: " << cmd);
1555 // we have not done anything wrong yet.
1558 FuncStatus const flag = getStatus(cmd);
1559 if (!flag.enabled()) {
1560 // We cannot use this function here
1561 LYXERR(Debug::ACTION, "action "
1562 << lyxaction.getActionName(action)
1563 << " [" << action << "] is disabled at this location");
1564 dr.setMessage(flag.message());
1566 dr.dispatched(false);
1567 dr.screenUpdate(Update::None);
1568 dr.clearBufferUpdate();
1572 if (cmd.origin() == FuncRequest::LYXSERVER) {
1573 if (current_view_ && current_view_->currentBufferView())
1574 current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1575 // we will also need to redraw the screen at the end
1576 dr.screenUpdate(Update::FitCursor);
1579 // Assumes that the action will be dispatched.
1580 dr.dispatched(true);
1582 switch (cmd.action()) {
1584 case LFUN_WINDOW_NEW:
1585 createView(toqstr(cmd.argument()));
1588 case LFUN_WINDOW_CLOSE:
1589 // update bookmark pit of the current buffer before window close
1590 for (size_t i = 0; i < theSession().bookmarks().size(); ++i)
1591 gotoBookmark(i+1, false, false);
1592 // clear the last opened list, because
1593 // maybe this will end the session
1594 theSession().lastOpened().clear();
1595 // check for valid current_view_
1596 validateCurrentView();
1598 current_view_->closeScheduled();
1602 // quitting is triggered by the gui code
1603 // (leaving the event loop).
1605 current_view_->message(from_utf8(N_("Exiting.")));
1606 if (closeAllViews())
1610 case LFUN_SCREEN_FONT_UPDATE: {
1611 // handle the screen font changes.
1612 d->font_loader_.update();
1613 // Backup current_view_
1614 GuiView * view = current_view_;
1615 // Set current_view_ to zero to forbid GuiWorkArea::redraw()
1616 // to skip the refresh.
1618 theBufferList().changed(false);
1619 // Restore current_view_
1620 current_view_ = view;
1624 case LFUN_BUFFER_NEW:
1625 validateCurrentView();
1626 if (d->views_.empty()
1627 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1628 createView(QString(), false); // keep hidden
1629 current_view_->newDocument(to_utf8(cmd.argument()), false);
1630 current_view_->show();
1631 setActiveWindow(current_view_);
1633 current_view_->newDocument(to_utf8(cmd.argument()), false);
1637 case LFUN_BUFFER_NEW_TEMPLATE:
1638 validateCurrentView();
1639 if (d->views_.empty()
1640 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1642 current_view_->newDocument(to_utf8(cmd.argument()), true);
1643 if (!current_view_->documentBufferView())
1644 current_view_->close();
1646 current_view_->newDocument(to_utf8(cmd.argument()), true);
1650 case LFUN_FILE_OPEN: {
1651 validateCurrentView();
1652 // FIXME: create a new method shared with LFUN_HELP_OPEN.
1653 string const fname = to_utf8(cmd.argument());
1654 bool const is_open = FileName::isAbsolute(fname)
1655 && theBufferList().getBuffer(FileName(fname));
1656 if (d->views_.empty()
1657 || (!lyxrc.open_buffers_in_tabs
1658 && current_view_->documentBufferView() != 0
1660 // We want the ui session to be saved per document and not per
1661 // window number. The filename crc is a good enough identifier.
1662 boost::crc_32_type crc;
1663 crc = for_each(fname.begin(), fname.end(), crc);
1664 createView(crc.checksum());
1665 current_view_->openDocument(fname);
1666 if (current_view_ && !current_view_->documentBufferView())
1667 current_view_->close();
1669 current_view_->openDocument(fname);
1673 case LFUN_HELP_OPEN: {
1674 // FIXME: create a new method shared with LFUN_FILE_OPEN.
1675 if (current_view_ == 0)
1677 string const arg = to_utf8(cmd.argument());
1679 current_view_->message(_("Missing argument"));
1682 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
1684 fname = i18nLibFileSearch("examples", arg, "lyx");
1686 if (fname.empty()) {
1687 lyxerr << "LyX: unable to find documentation file `"
1688 << arg << "'. Bad installation?" << endl;
1691 current_view_->message(bformat(_("Opening help file %1$s..."),
1692 makeDisplayPath(fname.absFileName())));
1693 Buffer * buf = current_view_->loadDocument(fname, false);
1695 #ifndef DEVEL_VERSION
1697 buf->setReadonly(true);
1704 case LFUN_SET_COLOR: {
1706 string const x11_name = split(to_utf8(cmd.argument()), lyx_name, ' ');
1707 if (lyx_name.empty() || x11_name.empty()) {
1709 current_view_->message(
1710 _("Syntax: set-color <lyx_name> <x11_name>"));
1715 // FIXME: The graphics cache no longer has a changeDisplay method.
1716 string const graphicsbg = lcolor.getLyXName(Color_graphicsbg);
1717 bool const graphicsbg_changed =
1718 lyx_name == graphicsbg && x11_name != graphicsbg;
1719 if (graphicsbg_changed)
1720 graphics::GCache::get().changeDisplay(true);
1723 if (!lcolor.setColor(lyx_name, x11_name)) {
1725 current_view_->message(
1726 bformat(_("Set-color \"%1$s\" failed "
1727 "- color is undefined or "
1728 "may not be redefined"),
1729 from_utf8(lyx_name)));
1732 // Make sure we don't keep old colors in cache.
1733 d->color_cache_.clear();
1737 case LFUN_LYXRC_APPLY: {
1738 // reset active key sequences, since the bindings
1739 // are updated (bug 6064)
1741 LyXRC const lyxrc_orig = lyxrc;
1743 istringstream ss(to_utf8(cmd.argument()));
1744 bool const success = lyxrc.read(ss);
1747 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1748 << "Unable to read lyxrc data"
1753 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1755 // If the request comes from the minibuffer, then we can't reset
1756 // the GUI, since that would destory the minibuffer itself and
1757 // cause a crash, since we are currently in one of the methods of
1758 // GuiCommandBuffer. See bug #8540.
1759 if (cmd.origin() != FuncRequest::COMMANDBUFFER)
1762 // FIXME Unfortunately, that leaves a bug here, since we cannot
1763 // reset the GUI in this case. If the changes to lyxrc affected the
1764 // UI, then, nothing would happen. This seems fairly unlikely, but
1765 // it definitely is a bug.
1770 case LFUN_COMMAND_PREFIX:
1771 dispatch(FuncRequest(LFUN_MESSAGE, d->keyseq.printOptions(true)));
1776 d->meta_fake_bit = NoModifier;
1777 GuiView * gv = currentView();
1778 if (gv && gv->currentBufferView())
1779 // cancel any selection
1780 processFuncRequest(FuncRequest(LFUN_MARK_OFF));
1781 dr.setMessage(from_ascii(N_("Cancel")));
1784 case LFUN_META_PREFIX:
1785 d->meta_fake_bit = AltModifier;
1786 dr.setMessage(d->keyseq.print(KeySequence::ForGui));
1789 // --- Menus -----------------------------------------------
1790 case LFUN_RECONFIGURE:
1791 // argument is any additional parameter to the configure.py command
1792 reconfigure(to_utf8(cmd.argument()));
1795 // --- lyxserver commands ----------------------------
1796 case LFUN_SERVER_GET_FILENAME: {
1797 if (current_view_ && current_view_->documentBufferView()) {
1798 docstring const fname = from_utf8(
1799 current_view_->documentBufferView()->buffer().absFileName());
1800 dr.setMessage(fname);
1801 LYXERR(Debug::INFO, "FNAME[" << fname << ']');
1803 dr.setMessage(docstring());
1804 LYXERR(Debug::INFO, "No current file for LFUN_SERVER_GET_FILENAME");
1809 case LFUN_SERVER_NOTIFY: {
1810 docstring const dispatch_buffer = d->keyseq.print(KeySequence::Portable);
1811 dr.setMessage(dispatch_buffer);
1812 theServer().notifyClient(to_utf8(dispatch_buffer));
1816 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1817 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1823 string rest = split(argument, countstr, ' ');
1824 istringstream is(countstr);
1827 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1828 for (int i = 0; i < count; ++i)
1829 dispatch(lyxaction.lookupFunc(rest));
1833 case LFUN_COMMAND_SEQUENCE: {
1834 // argument contains ';'-terminated commands
1835 string arg = argument;
1836 // FIXME: this LFUN should also work without any view.
1837 Buffer * buffer = (current_view_ && current_view_->documentBufferView())
1838 ? &(current_view_->documentBufferView()->buffer()) : 0;
1840 buffer->undo().beginUndoGroup();
1841 while (!arg.empty()) {
1843 arg = split(arg, first, ';');
1844 FuncRequest func(lyxaction.lookupFunc(first));
1845 func.setOrigin(cmd.origin());
1848 // the buffer may have been closed by one action
1849 if (theBufferList().isLoaded(buffer))
1850 buffer->undo().endUndoGroup();
1854 case LFUN_BUFFER_FORALL: {
1855 FuncRequest const funcToRun = lyxaction.lookupFunc(cmd.getLongArg(0));
1857 map<Buffer *, GuiView *> views_lVisible;
1858 map<GuiView *, Buffer *> activeBuffers;
1860 QList<GuiView *> allViews = d->views_.values();
1862 // this foreach does not modify any buffer. It just collects info on local visibility of buffers
1863 // and on which buffer is active in each view.
1864 Buffer * const last = theBufferList().last();
1865 foreach (GuiView * view, allViews) {
1866 // all of the buffers might be locally hidden. That is, there is no active buffer.
1867 if (!view || !view->currentBufferView())
1868 activeBuffers[view] = 0;
1870 activeBuffers[view] = &view->currentBufferView()->buffer();
1872 // find out if each is locally visible or locally hidden.
1873 // we don't use a for loop as the buffer list cycles.
1874 Buffer * b = theBufferList().first();
1876 bool const locallyVisible = view && view->workArea(*b);
1877 if (locallyVisible) {
1878 bool const exists_ = (views_lVisible.find(b) != views_lVisible.end());
1879 // only need to overwrite/add if we don't already know a buffer is globally
1880 // visible or we do know but we would prefer to dispatch LFUN from the
1881 // current view because of cursor position issues.
1882 if (!exists_ || (exists_ && views_lVisible[b] != current_view_))
1883 views_lVisible[b] = view;
1887 b = theBufferList().next(b);
1891 GuiView * const homeView = currentView();
1892 Buffer * b = theBufferList().first();
1893 Buffer * nextBuf = 0;
1894 int numProcessed = 0;
1897 nextBuf = theBufferList().next(b); // get next now bc LFUN might close current.
1899 bool const visible = (views_lVisible.find(b) != views_lVisible.end());
1901 // first change to a view where b is locally visible, preferably current_view_.
1902 GuiView * const vLv = views_lVisible[b];
1904 lyx::dispatch(funcToRun);
1912 // put things back to how they were (if possible).
1913 foreach (GuiView * view, allViews) {
1914 Buffer * originalBuf = activeBuffers[view];
1915 // there might not have been an active buffer in this view or it might have been closed by the LFUN.
1916 if (theBufferList().isLoaded(originalBuf))
1917 view->setBuffer(originalBuf);
1919 homeView->setFocus();
1921 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d buffer(s)"), from_utf8(cmd.getLongArg(0)), numProcessed));
1925 case LFUN_COMMAND_ALTERNATIVES: {
1926 // argument contains ';'-terminated commands
1927 string arg = argument;
1928 while (!arg.empty()) {
1930 arg = split(arg, first, ';');
1931 FuncRequest func(lyxaction.lookupFunc(first));
1932 func.setOrigin(cmd.origin());
1933 FuncStatus const stat = getStatus(func);
1934 if (stat.enabled()) {
1944 if (theTopLevelCmdDef().lock(argument, func)) {
1945 func.setOrigin(cmd.origin());
1947 theTopLevelCmdDef().release(argument);
1949 if (func.action() == LFUN_UNKNOWN_ACTION) {
1950 // unknown command definition
1951 lyxerr << "Warning: unknown command definition `"
1955 // recursion detected
1956 lyxerr << "Warning: Recursion in the command definition `"
1957 << argument << "' detected"
1964 case LFUN_PREFERENCES_SAVE:
1965 lyxrc.write(support::makeAbsPath("preferences",
1966 package().user_support().absFileName()), false);
1969 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1970 string const fname = addName(addPath(package().user_support().absFileName(),
1971 "templates/"), "defaults.lyx");
1972 Buffer defaults(fname);
1974 istringstream ss(argument);
1979 // We need to make sure that, after we recreat the DocumentClass,
1980 // which we do in readHeader, we apply it to the document itself.
1981 DocumentClassConstPtr olddc = defaults.params().documentClassPtr();
1982 int const unknown_tokens = defaults.readHeader(lex);
1983 DocumentClassConstPtr newdc = defaults.params().documentClassPtr();
1985 InsetText & theinset = static_cast<InsetText &>(defaults.inset());
1986 cap::switchBetweenClasses(olddc, newdc, theinset, el);
1988 if (unknown_tokens != 0) {
1989 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1990 << unknown_tokens << " unknown token"
1991 << (unknown_tokens == 1 ? "" : "s")
1995 if (defaults.writeFile(FileName(defaults.absFileName())))
1996 dr.setMessage(bformat(_("Document defaults saved in %1$s"),
1997 makeDisplayPath(fname)));
2000 dr.setMessage(from_ascii(N_("Unable to save document defaults")));
2005 case LFUN_BOOKMARK_GOTO:
2006 // go to bookmark, open unopened file and switch to buffer if necessary
2007 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
2008 dr.screenUpdate(Update::Force | Update::FitCursor);
2011 case LFUN_BOOKMARK_CLEAR:
2012 theSession().bookmarks().clear();
2015 case LFUN_DEBUG_LEVEL_SET:
2016 lyxerr.setLevel(Debug::value(to_utf8(cmd.argument())));
2019 case LFUN_DIALOG_SHOW: {
2020 string const name = cmd.getArg(0);
2022 if ( name == "aboutlyx"
2024 || name == "texinfo"
2025 || name == "progress"
2026 || name == "compare")
2028 // work around: on Mac OS the application
2029 // is not terminated when closing the last view.
2030 // Create a new one to be able to dispatch the
2031 // LFUN_DIALOG_SHOW to this view.
2032 if (current_view_ == 0)
2038 // The LFUN must be for one of GuiView, BufferView, Buffer or Cursor;
2041 current_view_->dispatch(cmd, dr);
2045 if (cmd.origin() == FuncRequest::LYXSERVER)
2046 updateCurrentView(cmd, dr);
2050 docstring GuiApplication::viewStatusMessage()
2052 // When meta-fake key is pressed, show the key sequence so far + "M-".
2053 if (d->meta_fake_bit != NoModifier)
2054 return d->keyseq.print(KeySequence::ForGui) + "M-";
2056 // Else, when a non-complete key sequence is pressed,
2057 // show the available options.
2058 if (d->keyseq.length() > 0 && !d->keyseq.deleted())
2059 return d->keyseq.printOptions(true);
2065 void GuiApplication::handleKeyFunc(FuncCode action)
2069 if (d->keyseq.length())
2071 GuiView * gv = currentView();
2072 LASSERT(gv && gv->currentBufferView(), return);
2073 BufferView * bv = gv->currentBufferView();
2074 bv->getIntl().getTransManager().deadkey(
2075 c, get_accent(action).accent, bv->cursor().innerText(),
2077 // Need to clear, in case the minibuffer calls these
2080 // copied verbatim from do_accent_char
2081 bv->cursor().resetAnchor();
2085 void GuiApplication::processKeySym(KeySymbol const & keysym, KeyModifier state)
2087 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
2089 // Do nothing if we have nothing (JMarc)
2090 if (!keysym.isOK()) {
2091 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
2093 current_view_->restartCursor();
2097 if (keysym.isModifier()) {
2099 current_view_->restartCursor();
2103 char_type encoded_last_key = keysym.getUCSEncoded();
2105 // Do a one-deep top-level lookup for
2106 // cancel and meta-fake keys. RVDK_PATCH_5
2107 d->cancel_meta_seq.reset();
2109 FuncRequest func = d->cancel_meta_seq.addkey(keysym, state);
2110 LYXERR(Debug::KEY, "action first set to [" << func.action() << ']');
2112 // When not cancel or meta-fake, do the normal lookup.
2113 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
2114 // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
2115 if ((func.action() != LFUN_CANCEL) && (func.action() != LFUN_META_PREFIX)) {
2116 // remove Caps Lock and Mod2 as a modifiers
2117 func = d->keyseq.addkey(keysym, (state | d->meta_fake_bit));
2118 LYXERR(Debug::KEY, "action now set to [" << func.action() << ']');
2121 // Dont remove this unless you know what you are doing.
2122 d->meta_fake_bit = NoModifier;
2124 // Can this happen now ?
2125 if (func.action() == LFUN_NOACTION)
2126 func = FuncRequest(LFUN_COMMAND_PREFIX);
2128 LYXERR(Debug::KEY, " Key [action=" << func.action() << "]["
2129 << d->keyseq.print(KeySequence::Portable) << ']');
2131 // already here we know if it any point in going further
2132 // why not return already here if action == -1 and
2133 // num_bytes == 0? (Lgb)
2135 if (d->keyseq.length() > 1 && current_view_)
2136 current_view_->message(d->keyseq.print(KeySequence::ForGui));
2139 // Maybe user can only reach the key via holding down shift.
2140 // Let's see. But only if shift is the only modifier
2141 if (func.action() == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
2142 LYXERR(Debug::KEY, "Trying without shift");
2143 func = d->keyseq.addkey(keysym, NoModifier);
2144 LYXERR(Debug::KEY, "Action now " << func.action());
2147 if (func.action() == LFUN_UNKNOWN_ACTION) {
2148 // We didn't match any of the key sequences.
2149 // See if it's normal insertable text not already
2150 // covered by a binding
2151 if (keysym.isText() && d->keyseq.length() == 1) {
2152 // Non-printable characters (such as ASCII control characters)
2153 // must not be inserted (#5704)
2154 if (!isPrintable(encoded_last_key)) {
2155 LYXERR(Debug::KEY, "Non-printable character! Omitting.");
2156 current_view_->restartCursor();
2159 // If a non-Shift Modifier is used we have a non-bound key sequence
2160 // (such as Alt+j = j). This should be omitted (#5575).
2161 // On Windows, AltModifier and ControlModifier are both
2162 // set when AltGr is pressed. Therefore, in order to not
2163 // break AltGr-bound symbols (see #5575 for details),
2164 // unbound Ctrl+Alt key sequences are allowed.
2165 if ((state & AltModifier || state & ControlModifier || state & MetaModifier)
2166 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2167 && !(state & AltModifier && state & ControlModifier)
2170 current_view_->message(_("Unknown function."));
2171 current_view_->restartCursor();
2174 // Since all checks above were passed, we now really have text that
2175 // is to be inserted (e.g., AltGr-bound symbols). Thus change the
2176 // func to LFUN_SELF_INSERT and thus cause the text to be inserted
2178 LYXERR(Debug::KEY, "isText() is true, inserting.");
2179 func = FuncRequest(LFUN_SELF_INSERT, FuncRequest::KEYBOARD);
2181 LYXERR(Debug::KEY, "Unknown Action and not isText() -- giving up");
2182 if (current_view_) {
2183 current_view_->message(_("Unknown function."));
2184 current_view_->restartCursor();
2190 if (func.action() == LFUN_SELF_INSERT) {
2191 if (encoded_last_key != 0) {
2192 docstring const arg(1, encoded_last_key);
2193 processFuncRequest(FuncRequest(LFUN_SELF_INSERT, arg,
2194 FuncRequest::KEYBOARD));
2195 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
2198 processFuncRequest(func);
2202 void GuiApplication::processFuncRequest(FuncRequest const & func)
2204 lyx::dispatch(func);
2208 void GuiApplication::processFuncRequestAsync(FuncRequest const & func)
2210 addToFuncRequestQueue(func);
2211 processFuncRequestQueueAsync();
2215 void GuiApplication::processFuncRequestQueue()
2217 while (!d->func_request_queue_.empty()) {
2218 processFuncRequest(d->func_request_queue_.front());
2219 d->func_request_queue_.pop();
2224 void GuiApplication::processFuncRequestQueueAsync()
2226 QTimer::singleShot(0, this, SLOT(slotProcessFuncRequestQueue()));
2230 void GuiApplication::addToFuncRequestQueue(FuncRequest const & func)
2232 d->func_request_queue_.push(func);
2236 void GuiApplication::resetGui()
2238 // Set the language defined by the user.
2242 if (!readUIFile(toqstr(lyxrc.ui_file)))
2243 // Gives some error box here.
2246 if (d->global_menubar_)
2247 d->menus_.fillMenuBar(d->global_menubar_, 0, false);
2249 QHash<int, GuiView *>::iterator it;
2250 for (it = d->views_.begin(); it != d->views_.end(); ++it) {
2253 gv->setLayoutDirection(layoutDirection());
2257 processFuncRequest(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
2261 void GuiApplication::createView(int view_id)
2263 createView(QString(), true, view_id);
2267 void GuiApplication::createView(QString const & geometry_arg, bool autoShow,
2270 // release the keyboard which might have been grabed by the global
2271 // menubar on Mac to catch shortcuts even without any GuiView.
2272 if (d->global_menubar_)
2273 d->global_menubar_->releaseKeyboard();
2277 while (d->views_.find(id) != d->views_.end())
2280 LYXERR(Debug::GUI, "About to create new window with ID " << id);
2281 GuiView * view = new GuiView(id);
2283 d->views_[id] = view;
2287 setActiveWindow(view);
2290 if (!geometry_arg.isEmpty()) {
2291 #if defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
2295 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)){0,1}(?:([+-][0-9]*)){0,1}" );
2296 re.indexIn(geometry_arg);
2297 w = re.cap(1).toInt();
2298 h = re.cap(2).toInt();
2299 x = re.cap(3).toInt();
2300 y = re.cap(4).toInt();
2301 sx = re.cap(3).isEmpty() ? '+' : re.cap(3).at(0);
2302 sy = re.cap(4).isEmpty() ? '+' : re.cap(4).at(0);
2303 // Set initial geometry such that we can get the frame size.
2304 view->setGeometry(x, y, w, h);
2305 int framewidth = view->geometry().x() - view->x();
2306 int titleheight = view->geometry().y() - view->y();
2307 // Negative displacements must be interpreted as distances
2308 // from the right or bottom screen borders.
2309 if (sx == '-' || sy == '-') {
2310 QRect rec = QApplication::desktop()->screenGeometry();
2312 x += rec.width() - w - framewidth;
2314 y += rec.height() - h - titleheight;
2315 view->setGeometry(x, y, w, h);
2317 // Make sure that the left and top frame borders are visible.
2318 if (view->x() < 0 || view->y() < 0) {
2323 view->setGeometry(x, y, w, h);
2331 Clipboard & GuiApplication::clipboard()
2333 return d->clipboard_;
2337 Selection & GuiApplication::selection()
2339 return d->selection_;
2343 FontLoader & GuiApplication::fontLoader()
2345 return d->font_loader_;
2349 Toolbars const & GuiApplication::toolbars() const
2351 return d->toolbars_;
2355 Toolbars & GuiApplication::toolbars()
2357 return d->toolbars_;
2361 Menus const & GuiApplication::menus() const
2367 Menus & GuiApplication::menus()
2373 QList<int> GuiApplication::viewIds() const
2375 return d->views_.keys();
2379 ColorCache & GuiApplication::colorCache()
2381 return d->color_cache_;
2385 int GuiApplication::exec()
2387 // asynchronously handle batch commands. This event will be in
2388 // the event queue in front of other asynchronous events. Hence,
2389 // we can assume in the latter that the gui is setup already.
2390 QTimer::singleShot(0, this, SLOT(execBatchCommands()));
2392 return QApplication::exec();
2396 void GuiApplication::exit(int status)
2398 QApplication::exit(status);
2402 void GuiApplication::setGuiLanguage()
2406 // install translation file for Qt built-in dialogs
2407 QString const language_name = QString("qt_") + theLocale.name();
2408 // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
2409 // Short-named translator can be loaded from a long name, but not the
2410 // opposite. Therefore, long name should be used without truncation.
2411 // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
2412 if (!d->qt_trans_.load(language_name,
2413 QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
2414 LYXERR(Debug::LOCALE, "Could not find Qt translations for locale "
2417 LYXERR(Debug::LOCALE, "Successfully installed Qt translations for locale "
2421 switch (theLocale.language()) {
2422 case QLocale::Arabic :
2423 case QLocale::Hebrew :
2424 case QLocale::Persian :
2425 case QLocale::Urdu :
2426 setLayoutDirection(Qt::RightToLeft);
2429 setLayoutDirection(Qt::LeftToRight);
2434 void GuiApplication::execBatchCommands()
2439 if (!readUIFile(toqstr(lyxrc.ui_file)))
2440 // Gives some error box here.
2444 #if QT_VERSION > 0x040600
2445 setAttribute(Qt::AA_MacDontSwapCtrlAndMeta,lyxrc.mac_dontswap_ctrl_meta);
2447 #if QT_VERSION > 0x050100
2448 setAttribute(Qt::AA_UseHighDpiPixmaps,true);
2450 // Create the global default menubar which is shown for the dialogs
2451 // and if no GuiView is visible.
2452 // This must be done after the session was recovered to know the "last files".
2453 d->global_menubar_ = new QMenuBar(0);
2454 d->menus_.fillMenuBar(d->global_menubar_, 0, true);
2457 lyx::execBatchCommands();
2461 QAbstractItemModel * GuiApplication::languageModel()
2463 if (d->language_model_)
2464 return d->language_model_;
2466 QStandardItemModel * lang_model = new QStandardItemModel(this);
2467 lang_model->insertColumns(0, 3);
2469 QIcon speller(getPixmap("images/", "dialog-show_spellchecker", "svgz,png"));
2470 QIcon saurus(getPixmap("images/", "thesaurus-entry", "svgz,png"));
2471 Languages::const_iterator it = lyx::languages.begin();
2472 Languages::const_iterator end = lyx::languages.end();
2473 for (; it != end; ++it) {
2474 current_row = lang_model->rowCount();
2475 lang_model->insertRows(current_row, 1);
2476 QModelIndex pl_item = lang_model->index(current_row, 0);
2477 QModelIndex sp_item = lang_model->index(current_row, 1);
2478 QModelIndex th_item = lang_model->index(current_row, 2);
2479 lang_model->setData(pl_item, qt_(it->second.display()), Qt::DisplayRole);
2480 lang_model->setData(pl_item, toqstr(it->second.lang()), Qt::UserRole);
2481 lang_model->setData(sp_item, qt_(it->second.display()), Qt::DisplayRole);
2482 lang_model->setData(sp_item, toqstr(it->second.lang()), Qt::UserRole);
2483 if (theSpellChecker() && theSpellChecker()->hasDictionary(&it->second))
2484 lang_model->setData(sp_item, speller, Qt::DecorationRole);
2485 lang_model->setData(th_item, qt_(it->second.display()), Qt::DisplayRole);
2486 lang_model->setData(th_item, toqstr(it->second.lang()), Qt::UserRole);
2487 if (thesaurus.thesaurusInstalled(from_ascii(it->second.code())))
2488 lang_model->setData(th_item, saurus, Qt::DecorationRole);
2490 d->language_model_ = new QSortFilterProxyModel(this);
2491 d->language_model_->setSourceModel(lang_model);
2492 d->language_model_->setSortLocaleAware(true);
2493 return d->language_model_;
2497 void GuiApplication::restoreGuiSession()
2499 if (!lyxrc.load_session)
2502 Session & session = theSession();
2503 LastOpenedSection::LastOpened const & lastopened =
2504 session.lastOpened().getfiles();
2506 validateCurrentView();
2508 FileName active_file;
2509 // do not add to the lastfile list since these files are restored from
2510 // last session, and should be already there (regular files), or should
2511 // not be added at all (help files).
2512 for (size_t i = 0; i < lastopened.size(); ++i) {
2513 FileName const & file_name = lastopened[i].file_name;
2514 if (d->views_.empty() || (!lyxrc.open_buffers_in_tabs
2515 && current_view_->documentBufferView() != 0)) {
2516 boost::crc_32_type crc;
2517 string const & fname = file_name.absFileName();
2518 crc = for_each(fname.begin(), fname.end(), crc);
2519 createView(crc.checksum());
2521 current_view_->loadDocument(file_name, false);
2523 if (lastopened[i].active)
2524 active_file = file_name;
2527 // Restore last active buffer
2528 Buffer * buffer = theBufferList().getBuffer(active_file);
2529 if (buffer && current_view_)
2530 current_view_->setBuffer(buffer);
2532 // clear this list to save a few bytes of RAM
2533 session.lastOpened().clear();
2537 QString const GuiApplication::romanFontName()
2540 font.setStyleHint(QFont::Serif);
2541 font.setFamily("serif");
2543 return QFontInfo(font).family();
2547 QString const GuiApplication::sansFontName()
2550 font.setStyleHint(QFont::SansSerif);
2551 font.setFamily("sans");
2553 return QFontInfo(font).family();
2557 QString const GuiApplication::typewriterFontName()
2560 font.setStyleHint(QFont::TypeWriter);
2561 font.setFamily("monospace");
2563 return QFontInfo(font).family();
2567 void GuiApplication::handleRegularEvents()
2569 ForkedCallsController::handleCompletedProcesses();
2573 bool GuiApplication::event(QEvent * e)
2576 case QEvent::FileOpen: {
2577 // Open a file; this happens only on Mac OS X for now.
2579 // We do this asynchronously because on startup the batch
2580 // commands are not executed here yet and the gui is not ready
2582 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
2583 FuncRequest const fr(LFUN_FILE_OPEN, qstring_to_ucs4(foe->file()));
2584 processFuncRequestAsync(fr);
2589 return QApplication::event(e);
2594 bool GuiApplication::notify(QObject * receiver, QEvent * event)
2597 return QApplication::notify(receiver, event);
2599 catch (ExceptionMessage const & e) {
2601 case ErrorException:
2603 setQuitOnLastWindowClosed(false);
2605 Alert::error(e.title_, e.details_);
2607 // Properly crash in debug mode in order to get a useful backtrace.
2610 // In release mode, try to exit gracefully.
2613 case BufferException: {
2614 if (!current_view_ || !current_view_->documentBufferView())
2616 Buffer * buf = ¤t_view_->documentBufferView()->buffer();
2617 docstring details = e.details_ + '\n';
2618 details += buf->emergencyWrite();
2619 theBufferList().release(buf);
2620 details += "\n" + _("The current document was closed.");
2621 Alert::error(e.title_, details);
2624 case WarningException:
2625 Alert::warning(e.title_, e.details_);
2629 catch (exception const & e) {
2630 docstring s = _("LyX has caught an exception, it will now "
2631 "attempt to save all unsaved documents and exit."
2633 s += from_ascii(e.what());
2634 Alert::error(_("Software exception Detected"), s);
2638 docstring s = _("LyX has caught some really weird exception, it will "
2639 "now attempt to save all unsaved documents and exit.");
2640 Alert::error(_("Software exception Detected"), s);
2648 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
2650 QColor const & qcol = d->color_cache_.get(col);
2651 if (!qcol.isValid()) {
2657 rgbcol.r = qcol.red();
2658 rgbcol.g = qcol.green();
2659 rgbcol.b = qcol.blue();
2664 bool Application::getRgbColorUncached(ColorCode col, RGBColor & rgbcol)
2666 QColor const qcol(lcolor.getX11Name(col).c_str());
2667 if (!qcol.isValid()) {
2673 rgbcol.r = qcol.red();
2674 rgbcol.g = qcol.green();
2675 rgbcol.b = qcol.blue();
2680 string const GuiApplication::hexName(ColorCode col)
2682 return ltrim(fromqstr(d->color_cache_.get(col).name()), "#");
2686 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
2688 SocketNotifier * sn = new SocketNotifier(this, fd, func);
2689 d->socket_notifiers_[fd] = sn;
2690 connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
2694 void GuiApplication::socketDataReceived(int fd)
2696 d->socket_notifiers_[fd]->func_();
2700 void GuiApplication::unregisterSocketCallback(int fd)
2702 d->socket_notifiers_.take(fd)->setEnabled(false);
2706 void GuiApplication::commitData(QSessionManager & sm)
2708 /** The implementation is required to avoid an application exit
2709 ** when session state save is triggered by session manager.
2710 ** The default implementation sends a close event to all
2711 ** visible top level widgets when session managment allows
2713 ** We are changing that to check the state of each buffer in all
2714 ** views and ask the users what to do if buffers are dirty.
2715 ** Furthermore, we save the session state.
2716 ** We do NOT close the views here since the user still can cancel
2717 ** the logout process (see #9277); also, this would hide LyX from
2718 ** an OSes own session handling (application restoration).
2720 #ifdef QT_NO_SESSIONMANAGER
2722 #warning Qt is compiled without session manager
2724 #pragma message("warning: Qt is compiled without session manager")
2728 if (sm.allowsInteraction() && !prepareAllViewsForLogout())
2736 void GuiApplication::unregisterView(GuiView * gv)
2738 if(d->views_.contains(gv->id()) && d->views_.value(gv->id()) == gv) {
2739 d->views_.remove(gv->id());
2740 if (current_view_ == gv)
2746 bool GuiApplication::closeAllViews()
2748 if (d->views_.empty())
2751 // When a view/window was closed before without quitting LyX, there
2752 // are already entries in the lastOpened list.
2753 theSession().lastOpened().clear();
2755 QList<GuiView *> const views = d->views_.values();
2756 foreach (GuiView * view, views) {
2757 if (!view->closeScheduled())
2766 bool GuiApplication::prepareAllViewsForLogout()
2768 if (d->views_.empty())
2771 QList<GuiView *> const views = d->views_.values();
2772 foreach (GuiView * view, views) {
2773 if (!view->prepareAllBuffersForLogout())
2781 GuiView & GuiApplication::view(int id) const
2783 LAPPERR(d->views_.contains(id));
2784 return *d->views_.value(id);
2788 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
2790 QList<GuiView *> const views = d->views_.values();
2791 foreach (GuiView * view, views)
2792 view->hideDialog(name, inset);
2796 Buffer const * GuiApplication::updateInset(Inset const * inset) const
2798 Buffer const * buffer_ = 0;
2799 QHash<int, GuiView *>::const_iterator end = d->views_.end();
2800 for (QHash<int, GuiView *>::iterator it = d->views_.begin(); it != end; ++it) {
2801 if (Buffer const * ptr = (*it)->updateInset(inset))
2808 bool GuiApplication::searchMenu(FuncRequest const & func,
2809 docstring_list & names) const
2811 return d->menus_.searchMenu(func, names);
2815 // Ensure that a file is read only once (prevents include loops)
2816 static QStringList uifiles;
2817 // store which ui files define Toolbars
2818 static QStringList toolbar_uifiles;
2821 GuiApplication::ReturnValues GuiApplication::readUIFile(FileName ui_path)
2832 LexerKeyword uitags[] = {
2833 { "format", ui_format },
2834 { "include", ui_include },
2835 { "menuset", ui_menuset },
2836 { "toolbars", ui_toolbars },
2837 { "toolbarset", ui_toolbarset }
2841 lex.setFile(ui_path);
2843 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
2847 if (lyxerr.debugging(Debug::PARSER))
2848 lex.printTable(lyxerr);
2851 // format before introduction of format tag
2852 unsigned int format = 0;
2853 while (lex.isOK()) {
2854 int const status = lex.lex();
2856 // we have to do this check here, outside the switch,
2857 // because otherwise we would start reading include files,
2858 // e.g., if the first tag we hit was an include tag.
2859 if (status == ui_format)
2861 format = lex.getInteger();
2865 // this will trigger unless the first tag we hit is a format
2866 // tag, with the right format.
2867 if (format != LFUN_FORMAT)
2868 return FormatMismatch;
2871 case Lexer::LEX_FEOF:
2876 QString const file = toqstr(lex.getString());
2877 bool const success = readUIFile(file, true);
2879 LYXERR0("Failed to read inlcuded file: " << fromqstr(file));
2886 d->menus_.read(lex);
2890 d->toolbars_.readToolbars(lex);
2894 d->toolbars_.readToolbarSettings(lex);
2895 toolbar_uifiles.push_back(toqstr(ui_path.absFileName()));
2899 if (!rtrim(lex.getString()).empty())
2900 lex.printError("LyX::ReadUIFile: "
2901 "Unknown menu tag: `$$Token'");
2903 LYXERR0("Error with status: " << status);
2909 return (error ? ReadError : ReadOK);
2913 bool GuiApplication::readUIFile(QString const & name, bool include)
2915 LYXERR(Debug::INIT, "About to read " << name << "...");
2919 ui_path = libFileSearch("ui", name, "inc");
2920 if (ui_path.empty())
2921 ui_path = libFileSearch("ui", changeExtension(name, "inc"));
2923 ui_path = libFileSearch("ui", name, "ui");
2926 if (ui_path.empty()) {
2927 static const QString defaultUIFile = "default";
2928 LYXERR(Debug::INIT, "Could not find " << name);
2930 Alert::warning(_("Could not find UI definition file"),
2931 bformat(_("Error while reading the included file\n%1$s\n"
2932 "Please check your installation."), qstring_to_ucs4(name)));
2935 if (name == defaultUIFile) {
2936 LYXERR(Debug::INIT, "Could not find default UI file!!");
2937 Alert::warning(_("Could not find default UI file"),
2938 _("LyX could not find the default UI file!\n"
2939 "Please check your installation."));
2942 Alert::warning(_("Could not find UI definition file"),
2943 bformat(_("Error while reading the configuration file\n%1$s\n"
2944 "Falling back to default.\n"
2945 "Please look under Tools>Preferences>User Interface and\n"
2946 "check which User Interface file you are using."), qstring_to_ucs4(name)));
2947 return readUIFile(defaultUIFile, false);
2950 QString const uifile = toqstr(ui_path.absFileName());
2951 if (uifiles.contains(uifile)) {
2953 // We are reading again the top uifile so reset the safeguard:
2956 d->toolbars_.reset();
2958 LYXERR(Debug::INIT, "UI file '" << name << "' has been read already. "
2959 << "Is this an include loop?");
2963 uifiles.push_back(uifile);
2965 LYXERR(Debug::INIT, "Found " << name << " in " << ui_path);
2967 ReturnValues retval = readUIFile(ui_path);
2969 if (retval == FormatMismatch) {
2970 LYXERR(Debug::FILES, "Converting ui file to format " << LFUN_FORMAT);
2971 TempFile tmp("convertXXXXXX.ui");
2972 FileName const tempfile = tmp.name();
2973 bool const success = prefs2prefs(ui_path, tempfile, true);
2975 LYXERR0("Unable to convert " << ui_path.absFileName() <<
2976 " to format " << LFUN_FORMAT << ".");
2978 retval = readUIFile(tempfile);
2982 if (retval != ReadOK) {
2983 LYXERR0("Unable to read UI file: " << ui_path.absFileName());
2991 settings.beginGroup("ui_files");
2992 bool touched = false;
2993 for (int i = 0; i != uifiles.size(); ++i) {
2994 QFileInfo fi(uifiles[i]);
2995 QDateTime const date_value = fi.lastModified();
2996 QString const name_key = QString::number(i);
2997 // if an ui file which defines Toolbars has changed,
2998 // we have to reset the settings
2999 if (toolbar_uifiles.contains(uifiles[i])
3000 && (!settings.contains(name_key)
3001 || settings.value(name_key).toString() != uifiles[i]
3002 || settings.value(name_key + "/date").toDateTime() != date_value)) {
3004 settings.setValue(name_key, uifiles[i]);
3005 settings.setValue(name_key + "/date", date_value);
3008 settings.endGroup();
3010 settings.remove("views");
3016 void GuiApplication::onLastWindowClosed()
3018 if (d->global_menubar_)
3019 d->global_menubar_->grabKeyboard();
3023 void GuiApplication::startLongOperation() {
3024 d->key_checker_.start();
3028 bool GuiApplication::longOperationCancelled() {
3029 return d->key_checker_.pressed();
3033 void GuiApplication::stopLongOperation() {
3034 d->key_checker_.stop();
3038 bool GuiApplication::longOperationStarted() {
3039 return d->key_checker_.started();
3043 ////////////////////////////////////////////////////////////////////////
3045 // X11 specific stuff goes here...
3048 bool GuiApplication::x11EventFilter(XEvent * xev)
3053 switch (xev->type) {
3054 case SelectionRequest: {
3055 if (xev->xselectionrequest.selection != XA_PRIMARY)
3057 LYXERR(Debug::SELECTION, "X requested selection.");
3058 BufferView * bv = current_view_->currentBufferView();
3060 docstring const sel = bv->requestSelection();
3062 d->selection_.put(sel);
3066 case SelectionClear: {
3067 if (xev->xselectionclear.selection != XA_PRIMARY)
3069 LYXERR(Debug::SELECTION, "Lost selection.");
3070 BufferView * bv = current_view_->currentBufferView();
3072 bv->clearSelection();
3078 #elif defined(QPA_XCB)
3079 bool GuiApplication::nativeEventFilter(const QByteArray & eventType,
3080 void * message, long *) Q_DECL_OVERRIDE
3082 if (!current_view_ || eventType != "xcb_generic_event_t")
3085 xcb_generic_event_t * ev = static_cast<xcb_generic_event_t *>(message);
3087 switch (ev->response_type) {
3088 case XCB_SELECTION_REQUEST: {
3089 xcb_selection_request_event_t * srev =
3090 reinterpret_cast<xcb_selection_request_event_t *>(ev);
3091 if (srev->selection != XCB_ATOM_PRIMARY)
3093 LYXERR(Debug::SELECTION, "X requested selection.");
3094 BufferView * bv = current_view_->currentBufferView();
3096 docstring const sel = bv->requestSelection();
3098 d->selection_.put(sel);
3102 case XCB_SELECTION_CLEAR: {
3103 xcb_selection_clear_event_t * scev =
3104 reinterpret_cast<xcb_selection_clear_event_t *>(ev);
3105 if (scev->selection != XCB_ATOM_PRIMARY)
3107 LYXERR(Debug::SELECTION, "Lost selection.");
3108 BufferView * bv = current_view_->currentBufferView();
3110 bv->clearSelection();
3118 } // namespace frontend
3121 void hideDialogs(std::string const & name, Inset * inset)
3124 frontend::guiApp->hideDialogs(name, inset);
3128 ////////////////////////////////////////////////////////////////////
3132 ////////////////////////////////////////////////////////////////////
3134 frontend::FontLoader & theFontLoader()
3136 LAPPERR(frontend::guiApp);
3137 return frontend::guiApp->fontLoader();
3141 frontend::FontMetrics const & theFontMetrics(Font const & f)
3143 return theFontMetrics(f.fontInfo());
3147 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
3149 LAPPERR(frontend::guiApp);
3150 return frontend::guiApp->fontLoader().metrics(f);
3154 ////////////////////////////////////////////////////////////////////
3158 ////////////////////////////////////////////////////////////////////
3160 frontend::Clipboard & theClipboard()
3162 LAPPERR(frontend::guiApp);
3163 return frontend::guiApp->clipboard();
3167 frontend::Selection & theSelection()
3169 LAPPERR(frontend::guiApp);
3170 return frontend::guiApp->selection();
3176 #include "moc_GuiApplication.cpp"