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"
21 #include "GuiKeySymbol.h"
22 #include "GuiSelection.h"
25 #include "qt_helpers.h"
28 #include "frontends/alert.h"
29 #include "frontends/Application.h"
30 #include "frontends/FontLoader.h"
31 #include "frontends/FontMetrics.h"
34 #include "BufferList.h"
35 #include "BufferView.h"
39 #include "FuncRequest.h"
40 #include "FuncStatus.h"
44 #include "LaTeXFeatures.h"
47 #include "LyXAction.h"
49 #include "Paragraph.h"
52 #include "SpellChecker.h"
53 #include "Thesaurus.h"
56 #include "support/convert.h"
57 #include "support/debug.h"
58 #include "support/ExceptionMessage.h"
59 #include "support/FileName.h"
60 #include "support/filetools.h"
61 #include "support/foreach.h"
62 #include "support/ForkedCalls.h"
63 #include "support/gettext.h"
64 #include "support/lassert.h"
65 #include "support/lstrings.h"
66 #include "support/lyxalgo.h" // sorted
67 #include "support/Messages.h"
68 #include "support/os.h"
69 #include "support/Package.h"
70 #include "support/Path.h"
71 #include "support/Systemcall.h"
74 #include "support/linkback/LinkBackProxy.h"
84 #include <QFileOpenEvent>
88 #include <QImageReader>
90 #include <QLibraryInfo>
92 #include <QMacPasteboardMime>
97 #include <QPixmapCache>
99 #include <QSessionManager>
101 #include <QSocketNotifier>
102 #include <QSortFilterProxyModel>
103 #include <QStandardItemModel>
104 #include <QTextCodec>
106 #include <QTranslator>
107 #if QT_VERSION >= 0x040400
108 #include <QThreadPool>
113 #include <X11/Xatom.h>
114 #include <X11/Xlib.h>
120 #include <QWindowsMime>
127 #include "support/bind.h"
128 #include <boost/crc.hpp>
135 using namespace lyx::support;
138 static void initializeResources()
140 static bool initialized = false;
142 Q_INIT_RESOURCE(Resources);
150 frontend::Application * createApplication(int & argc, char * argv[])
153 // prune -geometry argument(s) by shifting
154 // the following ones 2 places down.
155 for (int i = 0 ; i < argc ; ++i) {
156 if (strcmp(argv[i], "-geometry") == 0) {
157 int const remove = (i+1) < argc ? 2 : 1;
159 for (int j = i; j < argc; ++j)
160 argv[j] = argv[j + remove];
165 frontend::GuiApplication * guiApp = new frontend::GuiApplication(argc, argv);
166 // I'd rather do that in the constructor, but I do not think that
167 // the palette is accessible there.
168 guiApp->colorCache().setPalette(guiApp->palette());
175 /// Return the list of loadable formats.
176 vector<string> loadableImageFormats()
180 QList<QByteArray> qt_formats = QImageReader::supportedImageFormats();
182 LYXERR(Debug::GRAPHICS,
183 "\nThe image loader can load the following directly:\n");
185 if (qt_formats.empty())
186 LYXERR(Debug::GRAPHICS, "\nQt4 Problem: No Format available!");
188 for (QList<QByteArray>::const_iterator it = qt_formats.begin(); it != qt_formats.end(); ++it) {
190 LYXERR(Debug::GRAPHICS, (const char *) *it << ", ");
192 string ext = ascii_lowercase((const char *) *it);
203 ////////////////////////////////////////////////////////////////////////
205 // Icon loading support code
207 ////////////////////////////////////////////////////////////////////////
217 bool operator<(PngMap const & lhs, PngMap const & rhs)
219 return lhs.key < rhs.key;
225 CompareKey(QString const & name) : name_(name) {}
226 bool operator()(PngMap const & other) const { return other.key == name_; }
232 // this must be sorted alphabetically
233 // Upper case comes before lower case
234 PngMap sorted_png_map[] = {
235 { "Bumpeq", "bumpeq2" },
238 { "Delta", "delta2" },
239 { "Diamond", "diamond2" },
240 { "Downarrow", "downarrow2" },
241 { "Gamma", "gamma2" },
242 { "Lambda", "lambda2" },
243 { "Leftarrow", "leftarrow2" },
244 { "Leftrightarrow", "leftrightarrow2" },
245 { "Longleftarrow", "longleftarrow2" },
246 { "Longleftrightarrow", "longleftrightarrow2" },
247 { "Longrightarrow", "longrightarrow2" },
248 { "Omega", "omega2" },
252 { "Rightarrow", "rightarrow2" },
253 { "Sigma", "sigma2" },
254 { "Subset", "subset2" },
255 { "Supset", "supset2" },
256 { "Theta", "theta2" },
257 { "Uparrow", "uparrow2" },
258 { "Updownarrow", "updownarrow2" },
259 { "Upsilon", "upsilon2" },
260 { "Vdash", "vdash3" },
263 { "nLeftarrow", "nleftarrow2" },
264 { "nLeftrightarrow", "nleftrightarrow2" },
265 { "nRightarrow", "nrightarrow2" },
266 { "nVDash", "nvdash3" },
267 { "nvDash", "nvdash2" },
268 { "textrm \\AA", "textrm_AA"},
269 { "textrm \\O", "textrm_O"},
270 { "vDash", "vdash2" }
273 size_t const nr_sorted_png_map = sizeof(sorted_png_map) / sizeof(PngMap);
276 QString findPng(QString const & name)
278 PngMap const * const begin = sorted_png_map;
279 PngMap const * const end = begin + nr_sorted_png_map;
280 LASSERT(sorted(begin, end), /**/);
282 PngMap const * const it = find_if(begin, end, CompareKey(name));
286 png_name = it->value;
289 png_name.replace('_', "underscore");
290 png_name.replace(' ', '_');
292 // This way we can have "math-delim { }" on the toolbar.
293 png_name.replace('(', "lparen");
294 png_name.replace(')', "rparen");
295 png_name.replace('[', "lbracket");
296 png_name.replace(']', "rbracket");
297 png_name.replace('{', "lbrace");
298 png_name.replace('}', "rbrace");
299 png_name.replace('|', "bars");
300 png_name.replace(',', "thinspace");
301 png_name.replace(':', "mediumspace");
302 png_name.replace(';', "thickspace");
303 png_name.replace('!', "negthinspace");
306 LYXERR(Debug::GUI, "findPng(" << name << ")\n"
307 << "Looking for math PNG called \"" << png_name << '"');
314 QString iconName(FuncRequest const & f, bool unknown)
316 initializeResources();
320 switch (f.action()) {
321 case LFUN_MATH_INSERT:
322 if (!f.argument().empty()) {
324 name1 = findPng(toqstr(f.argument()).mid(1));
327 case LFUN_MATH_DELIM:
328 case LFUN_MATH_BIGDELIM:
330 name1 = findPng(toqstr(f.argument()));
334 name1 = toqstr(f.argument());
336 case LFUN_COMMAND_ALTERNATIVES: {
337 // use the first of the alternative commands
339 docstring dummy = split(f.argument(), firstcom, ';');
340 name1 = toqstr(firstcom);
341 // FIXME: we should rename the icons to tabular-xxx instead of
342 // "tabular-feature-xxx"
343 name1.replace("inset-modify tabular", "tabular-feature");
344 name1.replace(' ', '_');
347 case LFUN_INSET_MODIFY: {
348 // FIXME: we should rename the icons to tabular-xxx instead of
349 // "tabular-feature-xxx" and generalize this naming to all
350 // insets, not to tabular using ones.
352 string const command = split(to_utf8(f.argument()), inset_name, ' ');
353 if (insetCode(inset_name) == TABULAR_CODE) {
354 name1 = "tabular-feature "+ toqstr(command);
355 name1.replace(' ', '_');
360 name2 = toqstr(lyxaction.getActionName(f.action()));
363 if (!f.argument().empty()) {
364 name1 = name2 + ' ' + toqstr(f.argument());
365 name1.replace(' ', '_');
366 name1.replace('\\', "backslash");
370 FileName fname = libFileSearch("images/" + path, name1, "png");
372 return toqstr(fname.absFileName());
374 fname = libFileSearch("images/" + path, name2, "png");
376 return toqstr(fname.absFileName());
378 path = ":/images/" + path;
381 LYXERR0("Directory " << path << " not found in resource!");
385 if (res.exists(name1))
389 if (res.exists(name2))
392 LYXERR(Debug::GUI, "Cannot find icon with filename "
393 << "\"" << name1 << "\""
395 << "\"" << name2 << "\""
397 << lyxaction.getActionName(f.action())
398 << '(' << to_utf8(f.argument()) << ")\"");
401 fname = libFileSearch(QString("images/"), "unknown", "png");
403 return toqstr(fname.absFileName());
404 return QString(":/images/unknown.png");
410 QPixmap getPixmap(QString const & path, QString const & name, QString const & ext)
413 FileName fname = libFileSearch(path, name, ext);
414 QString path1 = toqstr(fname.absFileName());
415 QString path2 = ":/" + path + name + "." + ext;
417 if (pixmap.load(path1)) {
420 else if (pixmap.load(path2)) {
424 LYXERR0("Cannot load pixmap \""
425 << path << name << '.' << ext
426 << "\", please verify resource system!");
431 QIcon getIcon(FuncRequest const & f, bool unknown)
433 QString icon = iconName(f, unknown);
437 //LYXERR(Debug::GUI, "Found icon: " << icon);
439 if (!pm.load(icon)) {
440 LYXERR0("Cannot load icon " << icon << " please verify resource system!");
448 ////////////////////////////////////////////////////////////////////////
450 // LyX server support code.
452 ////////////////////////////////////////////////////////////////////////
454 class SocketNotifier : public QSocketNotifier
457 /// connect a connection notification from the LyXServerSocket
458 SocketNotifier(QObject * parent, int fd, Application::SocketCallback func)
459 : QSocketNotifier(fd, QSocketNotifier::Read, parent), func_(func)
463 /// The callback function
464 Application::SocketCallback func_;
468 ////////////////////////////////////////////////////////////////////////
470 // Mac specific stuff goes here...
472 ////////////////////////////////////////////////////////////////////////
474 class MenuTranslator : public QTranslator
477 MenuTranslator(QObject * parent)
478 : QTranslator(parent)
481 QString translate(const char * /*context*/,
482 const char * sourceText,
483 const char * /*comment*/ = 0)
485 string const s = sourceText;
486 if (s == N_("About %1") || s == N_("Preferences")
487 || s == N_("Reconfigure") || s == N_("Quit %1"))
494 class GlobalMenuBar : public QMenuBar
498 GlobalMenuBar() : QMenuBar(0) {}
501 bool event(QEvent * e)
503 if (e->type() == QEvent::ShortcutOverride) {
504 // && activeWindow() == 0) {
505 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
507 setKeySymbol(&sym, ke);
508 guiApp->processKeySym(sym, q_key_state(ke->modifiers()));
517 // QMacPasteboardMimeGraphics can only be compiled on Mac.
519 class QMacPasteboardMimeGraphics : public QMacPasteboardMime
522 QMacPasteboardMimeGraphics()
523 : QMacPasteboardMime(MIME_QT_CONVERTOR|MIME_ALL)
526 QString convertorName() { return "Graphics"; }
528 QString flavorFor(QString const & mime)
530 LYXERR(Debug::ACTION, "flavorFor " << mime);
531 if (mime == pdfMimeType())
532 return QLatin1String("com.adobe.pdf");
536 QString mimeFor(QString flav)
538 LYXERR(Debug::ACTION, "mimeFor " << flav);
539 if (flav == QLatin1String("com.adobe.pdf"))
540 return pdfMimeType();
544 bool canConvert(QString const & mime, QString flav)
546 return mimeFor(flav) == mime;
549 QVariant convertToMime(QString const & /*mime*/, QList<QByteArray> data,
553 qWarning("QMacPasteboardMimeGraphics: Cannot handle multiple member data");
557 QList<QByteArray> convertFromMime(QString const & /*mime*/,
558 QVariant data, QString /*flav*/)
560 QList<QByteArray> ret;
561 ret.append(data.toByteArray());
567 ///////////////////////////////////////////////////////////////
569 // You can find more platform specific stuff at the end of this file...
571 ///////////////////////////////////////////////////////////////
573 ////////////////////////////////////////////////////////////////////////
574 // Windows specific stuff goes here...
577 // QWindowsMimeMetafile can only be compiled on Windows.
579 static FORMATETC cfFromMime(QString const & mimetype)
582 if (mimetype == emfMimeType()) {
583 formatetc.cfFormat = CF_ENHMETAFILE;
584 formatetc.tymed = TYMED_ENHMF;
585 } else if (mimetype == wmfMimeType()) {
586 formatetc.cfFormat = CF_METAFILEPICT;
587 formatetc.tymed = TYMED_MFPICT;
590 formatetc.dwAspect = DVASPECT_CONTENT;
591 formatetc.lindex = -1;
596 class QWindowsMimeMetafile : public QWindowsMime {
598 QWindowsMimeMetafile() {}
600 bool canConvertFromMime(FORMATETC const & formatetc,
601 QMimeData const * mimedata) const
606 bool canConvertToMime(QString const & mimetype,
607 IDataObject * pDataObj) const
609 if (mimetype != emfMimeType() && mimetype != wmfMimeType())
611 FORMATETC formatetc = cfFromMime(mimetype);
612 return pDataObj->QueryGetData(&formatetc) == S_OK;
615 bool convertFromMime(FORMATETC const & formatetc,
616 const QMimeData * mimedata, STGMEDIUM * pmedium) const
621 QVariant convertToMime(QString const & mimetype, IDataObject * pDataObj,
622 QVariant::Type preferredType) const
625 if (!canConvertToMime(mimetype, pDataObj))
628 FORMATETC formatetc = cfFromMime(mimetype);
630 if (pDataObj->GetData(&formatetc, &s) != S_OK)
634 if (s.tymed == TYMED_ENHMF) {
635 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, 0, 0);
636 data.resize(dataSize);
637 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, dataSize,
638 (LPBYTE)data.data());
639 } else if (s.tymed == TYMED_MFPICT) {
640 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, 0, 0);
641 data.resize(dataSize);
642 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, dataSize,
643 (LPBYTE)data.data());
646 ReleaseStgMedium(&s);
652 QVector<FORMATETC> formatsForMime(QString const & mimetype,
653 QMimeData const * mimedata) const
655 QVector<FORMATETC> formats;
656 if (mimetype == emfMimeType() || mimetype == wmfMimeType())
657 formats += cfFromMime(mimetype);
661 QString mimeForFormat(FORMATETC const & formatetc) const
663 switch (formatetc.cfFormat) {
665 return emfMimeType();
666 case CF_METAFILEPICT:
667 return wmfMimeType();
675 ////////////////////////////////////////////////////////////////////////
676 // GuiApplication::Private definition and implementation.
677 ////////////////////////////////////////////////////////////////////////
679 struct GuiApplication::Private
681 Private(): language_model_(0), meta_fake_bit(NoModifier),
685 /// WMF Mime handler for Windows clipboard.
686 wmf_mime_ = new QWindowsMimeMetafile();
688 initKeySequences(&theTopLevelKeymap());
691 void initKeySequences(KeyMap * kb)
693 keyseq = KeySequence(kb, kb);
694 cancel_meta_seq = KeySequence(kb, kb);
698 QSortFilterProxyModel * language_model_;
700 GuiClipboard clipboard_;
702 GuiSelection selection_;
704 FontLoader font_loader_;
706 ColorCache color_cache_;
708 QTranslator qt_trans_;
710 QHash<int, SocketNotifier *> socket_notifiers_;
714 /// The global instance
717 /// this timer is used for any regular events one wants to
718 /// perform. at present it is used to check if forked processes
720 QTimer general_timer_;
722 /// delayed FuncRequests
723 std::queue<FuncRequest> func_request_queue_;
728 KeySequence cancel_meta_seq;
730 KeyModifier meta_fake_bit;
732 /// Multiple views container.
734 * Warning: This must not be a smart pointer as the destruction of the
735 * object is handled by Qt when the view is closed
736 * \sa Qt::WA_DeleteOnClose attribute.
738 QHash<int, GuiView *> views_;
740 /// Only used on mac.
741 GlobalMenuBar * global_menubar_;
744 /// Linkback mime handler for MacOSX.
745 QMacPasteboardMimeGraphics mac_pasteboard_mime_;
749 /// WMF Mime handler for Windows clipboard.
750 QWindowsMimeMetafile * wmf_mime_;
755 GuiApplication * guiApp;
757 GuiApplication::~GuiApplication()
760 closeAllLinkBackLinks();
766 GuiApplication::GuiApplication(int & argc, char ** argv)
767 : QApplication(argc, argv), current_view_(0),
768 d(new GuiApplication::Private)
770 QString app_name = "LyX";
771 QCoreApplication::setOrganizationName(app_name);
772 QCoreApplication::setOrganizationDomain("lyx.org");
773 QCoreApplication::setApplicationName(lyx_package);
775 // Install translator for GUI elements.
776 installTranslator(&d->qt_trans_);
778 // FIXME: quitOnLastWindowClosed is true by default. We should have a
779 // lyxrc setting for this in order to let the application stay resident.
780 // But then we need some kind of dock icon, at least on Windows.
782 if (lyxrc.quit_on_last_window_closed)
783 setQuitOnLastWindowClosed(false);
786 // FIXME: Do we need a lyxrc setting for this on Mac? This behaviour
787 // seems to be the default case for applications like LyX.
788 setQuitOnLastWindowClosed(false);
789 // This allows to translate the strings that appear in the LyX menu.
790 /// A translator suitable for the entries in the LyX menu.
791 /// Only needed with Qt/Mac.
792 installTranslator(new MenuTranslator(this));
796 // doubleClickInterval() is 400 ms on X11 which is just too long.
797 // On Windows and Mac OS X, the operating system's value is used.
798 // On Microsoft Windows, calling this function sets the double
799 // click interval for all applications. So we don't!
800 QApplication::setDoubleClickInterval(300);
803 connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
805 // needs to be done before reading lyxrc
807 lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
811 // Set the cache to 5120 kilobytes which corresponds to screen size of
812 // 1280 by 1024 pixels with a color depth of 32 bits.
813 QPixmapCache::setCacheLimit(5120);
815 // Initialize RC Fonts
816 if (lyxrc.roman_font_name.empty())
817 lyxrc.roman_font_name = fromqstr(romanFontName());
819 if (lyxrc.sans_font_name.empty())
820 lyxrc.sans_font_name = fromqstr(sansFontName());
822 if (lyxrc.typewriter_font_name.empty())
823 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
825 d->general_timer_.setInterval(500);
826 connect(&d->general_timer_, SIGNAL(timeout()),
827 this, SLOT(handleRegularEvents()));
828 d->general_timer_.start();
830 #if QT_VERSION >= 0x040400
831 // maxThreadCount() defaults in general to 2 on single or dual-processor.
832 // This is clearly not enough in a time where we use threads for
833 // document preview and/or export. 20 should be OK.
834 QThreadPool::globalInstance()->setMaxThreadCount(20);
839 GuiApplication * theGuiApp()
841 return dynamic_cast<GuiApplication *>(theApp());
845 void GuiApplication::clearSession()
852 docstring GuiApplication::iconName(FuncRequest const & f, bool unknown)
854 return qstring_to_ucs4(lyx::frontend::iconName(f, unknown));
858 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd) const
863 BufferView * doc_bv = 0;
865 if (cmd.action() == LFUN_NOACTION) {
866 status.message(from_utf8(N_("Nothing to do")));
867 status.setEnabled(false);
870 else if (cmd.action() == LFUN_UNKNOWN_ACTION) {
871 status.setUnknown(true);
872 status.message(from_utf8(N_("Unknown action")));
873 status.setEnabled(false);
876 // Does the GuiApplication know something?
877 else if (getStatus(cmd, status)) { }
879 // If we do not have a GuiView, then other functions are disabled
880 else if (!current_view_)
881 status.setEnabled(false);
883 // Does the GuiView know something?
884 else if (current_view_->getStatus(cmd, status)) { }
886 // In LyX/Mac, when a dialog is open, the menus of the
887 // application can still be accessed without giving focus to
888 // the main window. In this case, we want to disable the menu
889 // entries that are buffer or view-related.
890 //FIXME: Abdel (09/02/10) This has very bad effect on Linux, don't know why...
892 else if (cmd.origin() == FuncRequest::MENU && !current_view_->hasFocus())
893 status.setEnabled(false);
896 // If we do not have a BufferView, then other functions are disabled
897 else if (!(bv = current_view_->currentBufferView()))
898 status.setEnabled(false);
900 // Does the current BufferView know something?
901 else if (bv->getStatus(cmd, status)) { }
903 // Does the current Buffer know something?
904 else if (bv->buffer().getStatus(cmd, status)) { }
906 // If we do not have a document BufferView, different from the
907 // current BufferView, then other functions are disabled
908 else if (!(doc_bv = current_view_->documentBufferView()) || doc_bv == bv)
909 status.setEnabled(false);
911 // Does the document Buffer know something?
912 else if (doc_bv->buffer().getStatus(cmd, status)) { }
915 LYXERR(Debug::ACTION, "LFUN not handled in getStatus(): " << cmd);
916 status.message(from_utf8(N_("Command not handled")));
917 status.setEnabled(false);
920 // the default error message if we disable the command
921 if (!status.enabled() && status.message().empty())
922 status.message(from_utf8(N_("Command disabled")));
928 bool GuiApplication::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
930 // I would really like to avoid having this switch and rather try to
931 // encode this in the function itself.
932 // -- And I'd rather let an inset decide which LFUNs it is willing
933 // to handle (Andre')
935 switch (cmd.action()) {
937 // This could be used for the no-GUI version. The GUI version is handled in
938 // GuiView::getStatus(). See above.
940 case LFUN_BUFFER_WRITE:
941 case LFUN_BUFFER_WRITE_AS: {
942 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
943 enable = b && (b->isUnnamed() || !b->isClean());
948 case LFUN_BOOKMARK_GOTO: {
949 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
950 enable = theSession().bookmarks().isValid(num);
954 case LFUN_BOOKMARK_CLEAR:
955 enable = theSession().bookmarks().hasValid();
958 // this one is difficult to get right. As a half-baked
959 // solution, we consider only the first action of the sequence
960 case LFUN_COMMAND_SEQUENCE: {
961 // argument contains ';'-terminated commands
962 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
963 FuncRequest func(lyxaction.lookupFunc(firstcmd));
964 func.setOrigin(cmd.origin());
965 flag = getStatus(func);
969 // we want to check if at least one of these is enabled
970 case LFUN_COMMAND_ALTERNATIVES: {
971 // argument contains ';'-terminated commands
972 string arg = to_utf8(cmd.argument());
973 while (!arg.empty()) {
975 arg = split(arg, first, ';');
976 FuncRequest func(lyxaction.lookupFunc(first));
977 func.setOrigin(cmd.origin());
978 flag = getStatus(func);
979 // if this one is enabled, the whole thing is
988 string name = to_utf8(cmd.argument());
989 if (theTopLevelCmdDef().lock(name, func)) {
990 func.setOrigin(cmd.origin());
991 flag = getStatus(func);
992 theTopLevelCmdDef().release(name);
994 // catch recursion or unknown command
995 // definition. all operations until the
996 // recursion or unknown command definition
997 // occurs are performed, so set the state to
1004 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1006 case LFUN_PREFERENCES_SAVE:
1007 case LFUN_BUFFER_SAVE_AS_DEFAULT:
1008 case LFUN_DEBUG_LEVEL_SET:
1009 // these are handled in our dispatch()
1012 case LFUN_WINDOW_CLOSE:
1013 enable = d->views_.size() > 0;
1016 case LFUN_BUFFER_NEW:
1017 case LFUN_BUFFER_NEW_TEMPLATE:
1018 case LFUN_FILE_OPEN:
1019 case LFUN_HELP_OPEN:
1020 case LFUN_SCREEN_FONT_UPDATE:
1021 case LFUN_SET_COLOR:
1022 case LFUN_WINDOW_NEW:
1024 case LFUN_LYXRC_APPLY:
1025 case LFUN_COMMAND_PREFIX:
1027 case LFUN_META_PREFIX:
1028 case LFUN_RECONFIGURE:
1029 case LFUN_SERVER_GET_FILENAME:
1030 case LFUN_SERVER_NOTIFY:
1039 flag.setEnabled(false);
1043 /// make a post-dispatch status message
1044 static docstring makeDispatchMessage(docstring const & msg,
1045 FuncRequest const & cmd)
1047 const bool verbose = (cmd.origin() == FuncRequest::MENU
1048 || cmd.origin() == FuncRequest::TOOLBAR
1049 || cmd.origin() == FuncRequest::COMMANDBUFFER);
1051 if (cmd.action() == LFUN_SELF_INSERT || !verbose) {
1052 LYXERR(Debug::ACTION, "dispatch msg is " << msg);
1056 docstring dispatch_msg = msg;
1057 if (!dispatch_msg.empty())
1058 dispatch_msg += ' ';
1060 docstring comname = from_utf8(lyxaction.getActionName(cmd.action()));
1062 bool argsadded = false;
1064 if (!cmd.argument().empty()) {
1065 if (cmd.action() != LFUN_UNKNOWN_ACTION) {
1066 comname += ' ' + cmd.argument();
1070 docstring const shortcuts = theTopLevelKeymap().
1071 printBindings(cmd, KeySequence::ForGui);
1073 if (!shortcuts.empty())
1074 comname += ": " + shortcuts;
1075 else if (!argsadded && !cmd.argument().empty())
1076 comname += ' ' + cmd.argument();
1078 if (!comname.empty()) {
1079 comname = rtrim(comname);
1080 dispatch_msg += '(' + rtrim(comname) + ')';
1082 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1083 return dispatch_msg;
1087 void GuiApplication::dispatch(FuncRequest const & cmd)
1089 if (current_view_ && current_view_->currentBufferView())
1090 current_view_->currentBufferView()->cursor().saveBeforeDispatchPosXY();
1093 // redraw the screen at the end (first of the two drawing steps).
1094 //This is done unless explicitly requested otherwise
1095 dr.update(Update::FitCursor);
1101 BufferView * bv = current_view_->currentBufferView();
1103 if (dr.needBufferUpdate()) {
1104 bv->cursor().clearBufferUpdate();
1105 bv->buffer().updateBuffer();
1107 // BufferView::update() updates the ViewMetricsInfo and
1108 // also initializes the position cache for all insets in
1109 // (at least partially) visible top-level paragraphs.
1110 // We will redraw the screen only if needed.
1111 bv->processUpdateFlags(dr.update());
1113 // Do we have a selection?
1114 theSelection().haveSelection(bv->cursor().selection());
1117 current_view_->restartCursor();
1119 // Some messages may already be translated, so we cannot use _()
1120 current_view_->message(makeDispatchMessage(
1121 translateIfPossible(dr.message()), cmd));
1125 void GuiApplication::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
1127 LASSERT(current_view_, /**/);
1128 if (!theSession().bookmarks().isValid(idx))
1130 BookmarksSection::Bookmark const & bm = theSession().bookmarks().bookmark(idx);
1131 LASSERT(!bm.filename.empty(), /**/);
1132 string const file = bm.filename.absFileName();
1133 // if the file is not opened, open it.
1134 if (!theBufferList().exists(bm.filename)) {
1136 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
1140 // open may fail, so we need to test it again
1141 if (!theBufferList().exists(bm.filename))
1144 // bm can be changed when saving
1145 BookmarksSection::Bookmark tmp = bm;
1147 // Special case idx == 0 used for back-from-back jump navigation
1149 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
1151 // if the current buffer is not that one, switch to it.
1152 if (!current_view_->documentBufferView()
1153 || current_view_->documentBufferView()->buffer().fileName() != tmp.filename) {
1154 if (!switchToBuffer)
1156 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
1159 // moveToPosition try paragraph id first and then paragraph (pit, pos).
1160 if (!current_view_->documentBufferView()->moveToPosition(
1161 tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
1168 // Cursor jump succeeded!
1169 Cursor const & cur = current_view_->documentBufferView()->cursor();
1170 pit_type new_pit = cur.pit();
1171 pos_type new_pos = cur.pos();
1172 int new_id = cur.paragraph().id();
1174 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
1175 // see http://www.lyx.org/trac/ticket/3092
1176 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
1177 || bm.top_id != new_id) {
1178 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
1179 new_pit, new_pos, new_id);
1183 // This function runs "configure" and then rereads lyx.defaults to
1184 // reconfigure the automatic settings.
1185 void GuiApplication::reconfigure(string const & option)
1187 // emit message signal.
1189 current_view_->message(_("Running configure..."));
1191 // Run configure in user lyx directory
1192 PathChanger p(package().user_support());
1193 string configure_command = package().configure_command();
1194 configure_command += option;
1196 int ret = one.startscript(Systemcall::Wait, configure_command);
1198 // emit message signal.
1200 current_view_->message(_("Reloading configuration..."));
1201 lyxrc.read(libFileSearch(QString(), "lyxrc.defaults"));
1202 // Re-read packages.lst
1203 LaTeXFeatures::getAvailable();
1206 Alert::information(_("System reconfiguration failed"),
1207 _("The system reconfiguration has failed.\n"
1208 "Default textclass is used but LyX may "
1209 "not be able to work properly.\n"
1210 "Please reconfigure again if needed."));
1212 Alert::information(_("System reconfigured"),
1213 _("The system has been reconfigured.\n"
1214 "You need to restart LyX to make use of any\n"
1215 "updated document class specifications."));
1219 void GuiApplication::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1221 string const argument = to_utf8(cmd.argument());
1222 FuncCode const action = cmd.action();
1224 LYXERR(Debug::ACTION, "cmd: " << cmd);
1226 // we have not done anything wrong yet.
1229 FuncStatus const flag = getStatus(cmd);
1230 if (!flag.enabled()) {
1231 // We cannot use this function here
1232 LYXERR(Debug::ACTION, "action "
1233 << lyxaction.getActionName(action)
1234 << " [" << action << "] is disabled at this location");
1236 current_view_->restartCursor();
1237 dr.setMessage(flag.message());
1239 dr.dispatched(false);
1240 dr.update(Update::None);
1241 dr.clearBufferUpdate();
1245 // Assumes that the action will be dispatched.
1246 dr.dispatched(true);
1248 switch (cmd.action()) {
1250 case LFUN_WINDOW_NEW:
1251 createView(toqstr(cmd.argument()));
1254 case LFUN_WINDOW_CLOSE:
1255 // update bookmark pit of the current buffer before window close
1256 for (size_t i = 0; i < theSession().bookmarks().size(); ++i)
1257 gotoBookmark(i+1, false, false);
1258 // clear the last opened list, because
1259 // maybe this will end the session
1260 theSession().lastOpened().clear();
1261 current_view_->closeScheduled();
1265 // quitting is triggered by the gui code
1266 // (leaving the event loop).
1268 current_view_->message(from_utf8(N_("Exiting.")));
1269 if (closeAllViews())
1273 case LFUN_SCREEN_FONT_UPDATE: {
1274 // handle the screen font changes.
1275 d->font_loader_.update();
1276 // Backup current_view_
1277 GuiView * view = current_view_;
1278 // Set current_view_ to zero to forbid GuiWorkArea::redraw()
1279 // to skip the refresh.
1281 theBufferList().changed(false);
1282 // Restore current_view_
1283 current_view_ = view;
1287 case LFUN_BUFFER_NEW:
1288 if (d->views_.empty()
1289 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1290 createView(QString(), false); // keep hidden
1291 current_view_->newDocument(to_utf8(cmd.argument()), false);
1292 current_view_->show();
1293 setActiveWindow(current_view_);
1295 current_view_->newDocument(to_utf8(cmd.argument()), false);
1299 case LFUN_BUFFER_NEW_TEMPLATE:
1300 if (d->views_.empty()
1301 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1303 current_view_->newDocument(to_utf8(cmd.argument()), true);
1304 if (!current_view_->documentBufferView())
1305 current_view_->close();
1307 current_view_->newDocument(to_utf8(cmd.argument()), true);
1311 case LFUN_FILE_OPEN:
1312 // FIXME: create a new method shared with LFUN_HELP_OPEN.
1313 if (d->views_.empty()
1314 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1315 string const fname = to_utf8(cmd.argument());
1316 // We want the ui session to be saved per document and not per
1317 // window number. The filename crc is a good enough identifier.
1318 boost::crc_32_type crc;
1319 crc = for_each(fname.begin(), fname.end(), crc);
1320 createView(crc.checksum());
1321 current_view_->openDocument(fname);
1322 if (current_view_ && !current_view_->documentBufferView())
1323 current_view_->close();
1325 current_view_->openDocument(to_utf8(cmd.argument()));
1328 case LFUN_HELP_OPEN: {
1329 // FIXME: create a new method shared with LFUN_FILE_OPEN.
1330 if (current_view_ == 0)
1332 string const arg = to_utf8(cmd.argument());
1334 current_view_->message(_("Missing argument"));
1337 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
1339 fname = i18nLibFileSearch("examples", arg, "lyx");
1341 if (fname.empty()) {
1342 lyxerr << "LyX: unable to find documentation file `"
1343 << arg << "'. Bad installation?" << endl;
1346 current_view_->message(bformat(_("Opening help file %1$s..."),
1347 makeDisplayPath(fname.absFileName())));
1348 Buffer * buf = current_view_->loadDocument(fname, false);
1350 current_view_->setBuffer(buf);
1351 #ifndef DEVEL_VERSION
1352 buf->setReadonly(true);
1354 buf->errors("Parse");
1359 case LFUN_SET_COLOR: {
1361 string const x11_name = split(to_utf8(cmd.argument()), lyx_name, ' ');
1362 if (lyx_name.empty() || x11_name.empty()) {
1363 current_view_->message(
1364 _("Syntax: set-color <lyx_name> <x11_name>"));
1368 string const graphicsbg = lcolor.getLyXName(Color_graphicsbg);
1369 bool const graphicsbg_changed =
1370 lyx_name == graphicsbg && x11_name != graphicsbg;
1371 if (graphicsbg_changed) {
1372 // FIXME: The graphics cache no longer has a changeDisplay method.
1374 graphics::GCache::get().changeDisplay(true);
1378 if (!lcolor.setColor(lyx_name, x11_name)) {
1379 current_view_->message(
1380 bformat(_("Set-color \"%1$s\" failed "
1381 "- color is undefined or "
1382 "may not be redefined"),
1383 from_utf8(lyx_name)));
1386 // Make sure we don't keep old colors in cache.
1387 d->color_cache_.clear();
1391 case LFUN_LYXRC_APPLY: {
1392 // reset active key sequences, since the bindings
1393 // are updated (bug 6064)
1395 LyXRC const lyxrc_orig = lyxrc;
1397 istringstream ss(to_utf8(cmd.argument()));
1398 bool const success = lyxrc.read(ss) == 0;
1401 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1402 << "Unable to read lyxrc data"
1407 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1414 case LFUN_COMMAND_PREFIX:
1415 dispatch(FuncRequest(LFUN_MESSAGE, d->keyseq.printOptions(true)));
1420 d->meta_fake_bit = NoModifier;
1421 GuiView * gv = currentView();
1422 if (gv && gv->currentBufferView())
1423 // cancel any selection
1424 lyx::dispatch(FuncRequest(LFUN_MARK_OFF));
1425 dr.setMessage(from_ascii(N_("Cancel")));
1428 case LFUN_META_PREFIX:
1429 d->meta_fake_bit = AltModifier;
1430 dr.setMessage(d->keyseq.print(KeySequence::ForGui));
1433 // --- Menus -----------------------------------------------
1434 case LFUN_RECONFIGURE:
1435 // argument is any additional parameter to the configure.py command
1436 reconfigure(to_utf8(cmd.argument()));
1439 // --- lyxserver commands ----------------------------
1440 case LFUN_SERVER_GET_FILENAME: {
1441 LASSERT(current_view_ && current_view_->documentBufferView(), return);
1442 docstring const fname = from_utf8(
1443 current_view_->documentBufferView()->buffer().absFileName());
1444 dr.setMessage(fname);
1445 LYXERR(Debug::INFO, "FNAME[" << fname << ']');
1448 case LFUN_SERVER_NOTIFY: {
1449 docstring const dispatch_buffer = d->keyseq.print(KeySequence::Portable);
1450 dr.setMessage(dispatch_buffer);
1451 theServer().notifyClient(to_utf8(dispatch_buffer));
1455 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1456 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1462 string rest = split(argument, countstr, ' ');
1463 istringstream is(countstr);
1466 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1467 for (int i = 0; i < count; ++i)
1468 dispatch(lyxaction.lookupFunc(rest));
1472 case LFUN_COMMAND_SEQUENCE: {
1473 // argument contains ';'-terminated commands
1474 string arg = argument;
1475 // FIXME: this LFUN should also work without any view.
1476 Buffer * buffer = (current_view_ && current_view_->documentBufferView())
1477 ? &(current_view_->documentBufferView()->buffer()) : 0;
1479 buffer->undo().beginUndoGroup();
1480 while (!arg.empty()) {
1482 arg = split(arg, first, ';');
1483 FuncRequest func(lyxaction.lookupFunc(first));
1484 func.setOrigin(cmd.origin());
1487 // the buffer may have been closed by one action
1488 if (theBufferList().isLoaded(buffer))
1489 buffer->undo().endUndoGroup();
1493 case LFUN_COMMAND_ALTERNATIVES: {
1494 // argument contains ';'-terminated commands
1495 string arg = argument;
1496 while (!arg.empty()) {
1498 arg = split(arg, first, ';');
1499 FuncRequest func(lyxaction.lookupFunc(first));
1500 func.setOrigin(cmd.origin());
1501 FuncStatus const stat = getStatus(func);
1502 if (stat.enabled()) {
1512 if (theTopLevelCmdDef().lock(argument, func)) {
1513 func.setOrigin(cmd.origin());
1515 theTopLevelCmdDef().release(argument);
1517 if (func.action() == LFUN_UNKNOWN_ACTION) {
1518 // unknown command definition
1519 lyxerr << "Warning: unknown command definition `"
1523 // recursion detected
1524 lyxerr << "Warning: Recursion in the command definition `"
1525 << argument << "' detected"
1532 case LFUN_PREFERENCES_SAVE:
1533 lyxrc.write(support::makeAbsPath("preferences",
1534 package().user_support().absFileName()), false);
1537 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1538 string const fname = addName(addPath(package().user_support().absFileName(),
1539 "templates/"), "defaults.lyx");
1540 Buffer defaults(fname);
1542 istringstream ss(argument);
1545 int const unknown_tokens = defaults.readHeader(lex);
1547 if (unknown_tokens != 0) {
1548 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1549 << unknown_tokens << " unknown token"
1550 << (unknown_tokens == 1 ? "" : "s")
1554 if (defaults.writeFile(FileName(defaults.absFileName())))
1555 dr.setMessage(bformat(_("Document defaults saved in %1$s"),
1556 makeDisplayPath(fname)));
1559 dr.setMessage(from_ascii(N_("Unable to save document defaults")));
1564 case LFUN_BOOKMARK_GOTO:
1565 // go to bookmark, open unopened file and switch to buffer if necessary
1566 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1567 dr.update(Update::Force | Update::FitCursor);
1570 case LFUN_BOOKMARK_CLEAR:
1571 theSession().bookmarks().clear();
1574 case LFUN_DEBUG_LEVEL_SET:
1575 lyxerr.setLevel(Debug::value(to_utf8(cmd.argument())));
1579 // Everything below is only for active window
1580 if (current_view_ == 0)
1583 // Let the current GuiView dispatch its own actions.
1584 current_view_->dispatch(cmd, dr);
1586 if (dr.dispatched())
1589 BufferView * bv = current_view_->currentBufferView();
1592 // Let the current BufferView dispatch its own actions.
1593 bv->dispatch(cmd, dr);
1594 if (dr.dispatched())
1597 BufferView * doc_bv = current_view_->documentBufferView();
1598 // Try with the document BufferView dispatch if any.
1600 doc_bv->dispatch(cmd, dr);
1601 if (dr.dispatched())
1605 // OK, so try the current Buffer itself...
1606 bv->buffer().dispatch(cmd, dr);
1607 if (dr.dispatched())
1610 // and with the document Buffer.
1612 doc_bv->buffer().dispatch(cmd, dr);
1613 if (dr.dispatched())
1617 // Let the current Cursor dispatch its own actions.
1618 Cursor old = bv->cursor();
1619 bv->cursor().dispatch(cmd);
1621 // notify insets we just left
1622 if (bv->cursor() != old) {
1624 bool badcursor = notifyCursorLeavesOrEnters(old, bv->cursor());
1626 bv->cursor().fixIfBroken();
1629 // update completion. We do it here and not in
1630 // processKeySym to avoid another redraw just for a
1631 // changed inline completion
1632 if (cmd.origin() == FuncRequest::KEYBOARD) {
1633 if (cmd.action() == LFUN_SELF_INSERT
1634 || (cmd.action() == LFUN_ERT_INSERT && bv->cursor().inMathed()))
1635 current_view_->updateCompletion(bv->cursor(), true, true);
1636 else if (cmd.action() == LFUN_CHAR_DELETE_BACKWARD)
1637 current_view_->updateCompletion(bv->cursor(), false, true);
1639 current_view_->updateCompletion(bv->cursor(), false, false);
1642 dr = bv->cursor().result();
1645 // if we executed a mutating lfun, mark the buffer as dirty
1646 Buffer * doc_buffer = (current_view_ && current_view_->documentBufferView())
1647 ? &(current_view_->documentBufferView()->buffer()) : 0;
1648 if (doc_buffer && theBufferList().isLoaded(doc_buffer)
1650 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1651 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1652 current_view_->currentBufferView()->buffer().markDirty();
1656 docstring GuiApplication::viewStatusMessage()
1658 // When meta-fake key is pressed, show the key sequence so far + "M-".
1659 if (d->meta_fake_bit != NoModifier)
1660 return d->keyseq.print(KeySequence::ForGui) + "M-";
1662 // Else, when a non-complete key sequence is pressed,
1663 // show the available options.
1664 if (d->keyseq.length() > 0 && !d->keyseq.deleted())
1665 return d->keyseq.printOptions(true);
1671 void GuiApplication::handleKeyFunc(FuncCode action)
1675 if (d->keyseq.length())
1677 GuiView * gv = currentView();
1678 LASSERT(gv && gv->currentBufferView(), return);
1679 BufferView * bv = gv->currentBufferView();
1680 bv->getIntl().getTransManager().deadkey(
1681 c, get_accent(action).accent, bv->cursor().innerText(),
1683 // Need to clear, in case the minibuffer calls these
1686 // copied verbatim from do_accent_char
1687 bv->cursor().resetAnchor();
1688 bv->processUpdateFlags(Update::FitCursor);
1692 void GuiApplication::processKeySym(KeySymbol const & keysym, KeyModifier state)
1694 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
1696 // Do nothing if we have nothing (JMarc)
1697 if (!keysym.isOK()) {
1698 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
1699 current_view_->restartCursor();
1703 if (keysym.isModifier()) {
1704 LYXERR(Debug::KEY, "isModifier true");
1706 current_view_->restartCursor();
1710 char_type encoded_last_key = keysym.getUCSEncoded();
1712 // Do a one-deep top-level lookup for
1713 // cancel and meta-fake keys. RVDK_PATCH_5
1714 d->cancel_meta_seq.reset();
1716 FuncRequest func = d->cancel_meta_seq.addkey(keysym, state);
1717 LYXERR(Debug::KEY, "action first set to [" << func.action() << ']');
1719 // When not cancel or meta-fake, do the normal lookup.
1720 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
1721 // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
1722 if ((func.action() != LFUN_CANCEL) && (func.action() != LFUN_META_PREFIX)) {
1723 // remove Caps Lock and Mod2 as a modifiers
1724 func = d->keyseq.addkey(keysym, (state | d->meta_fake_bit));
1725 LYXERR(Debug::KEY, "action now set to [" << func.action() << ']');
1728 // Dont remove this unless you know what you are doing.
1729 d->meta_fake_bit = NoModifier;
1731 // Can this happen now ?
1732 if (func.action() == LFUN_NOACTION)
1733 func = FuncRequest(LFUN_COMMAND_PREFIX);
1735 LYXERR(Debug::KEY, " Key [action=" << func.action() << "]["
1736 << d->keyseq.print(KeySequence::Portable) << ']');
1738 // already here we know if it any point in going further
1739 // why not return already here if action == -1 and
1740 // num_bytes == 0? (Lgb)
1742 if (d->keyseq.length() > 1)
1743 current_view_->message(d->keyseq.print(KeySequence::ForGui));
1746 // Maybe user can only reach the key via holding down shift.
1747 // Let's see. But only if shift is the only modifier
1748 if (func.action() == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
1749 LYXERR(Debug::KEY, "Trying without shift");
1750 func = d->keyseq.addkey(keysym, NoModifier);
1751 LYXERR(Debug::KEY, "Action now " << func.action());
1754 if (func.action() == LFUN_UNKNOWN_ACTION) {
1755 // Hmm, we didn't match any of the keysequences. See
1756 // if it's normal insertable text not already covered
1758 if (keysym.isText() && d->keyseq.length() == 1) {
1759 LYXERR(Debug::KEY, "isText() is true, inserting.");
1760 func = FuncRequest(LFUN_SELF_INSERT,
1761 FuncRequest::KEYBOARD);
1763 LYXERR(Debug::KEY, "Unknown, !isText() - giving up");
1764 current_view_->message(_("Unknown function."));
1765 current_view_->restartCursor();
1770 if (func.action() == LFUN_SELF_INSERT) {
1771 if (encoded_last_key != 0) {
1772 docstring const arg(1, encoded_last_key);
1773 lyx::dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
1774 FuncRequest::KEYBOARD));
1775 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
1778 lyx::dispatch(func);
1782 void GuiApplication::dispatchDelayed(FuncRequest const & func)
1784 d->func_request_queue_.push(func);
1785 QTimer::singleShot(0, this, SLOT(processFuncRequestQueue()));
1789 void GuiApplication::resetGui()
1791 // Set the language defined by the user.
1795 if (!readUIFile(toqstr(lyxrc.ui_file)))
1796 // Gives some error box here.
1799 if (d->global_menubar_)
1800 d->menus_.fillMenuBar(d->global_menubar_, 0, false);
1802 QHash<int, GuiView *>::iterator it;
1803 for (it = d->views_.begin(); it != d->views_.end(); ++it) {
1806 gv->setLayoutDirection(layoutDirection());
1810 lyx::dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
1814 void GuiApplication::createView(int view_id)
1816 createView(QString(), true, view_id);
1820 void GuiApplication::createView(QString const & geometry_arg, bool autoShow,
1823 // release the keyboard which might have been grabed by the global
1824 // menubar on Mac to catch shortcuts even without any GuiView.
1825 if (d->global_menubar_)
1826 d->global_menubar_->releaseKeyboard();
1830 while (d->views_.find(id) != d->views_.end())
1833 LYXERR(Debug::GUI, "About to create new window with ID " << id);
1834 GuiView * view = new GuiView(id);
1836 d->views_[id] = view;
1840 setActiveWindow(view);
1843 if (!geometry_arg.isEmpty()) {
1847 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)([+-][0-9]*)){0,1}" );
1848 re.indexIn(geometry_arg);
1849 w = re.cap(1).toInt();
1850 h = re.cap(2).toInt();
1851 x = re.cap(3).toInt();
1852 y = re.cap(4).toInt();
1853 view->setGeometry(x, y, w, h);
1860 Clipboard & GuiApplication::clipboard()
1862 return d->clipboard_;
1866 Selection & GuiApplication::selection()
1868 return d->selection_;
1872 FontLoader & GuiApplication::fontLoader()
1874 return d->font_loader_;
1878 Toolbars const & GuiApplication::toolbars() const
1880 return d->toolbars_;
1884 Toolbars & GuiApplication::toolbars()
1886 return d->toolbars_;
1890 Menus const & GuiApplication::menus() const
1896 Menus & GuiApplication::menus()
1902 QList<int> GuiApplication::viewIds() const
1904 return d->views_.keys();
1908 ColorCache & GuiApplication::colorCache()
1910 return d->color_cache_;
1914 int GuiApplication::exec()
1916 // asynchronously handle batch commands. This event will be in
1917 // the event queue in front of other asynchronous events. Hence,
1918 // we can assume in the latter that the gui is setup already.
1919 QTimer::singleShot(0, this, SLOT(execBatchCommands()));
1921 return QApplication::exec();
1925 void GuiApplication::exit(int status)
1927 QApplication::exit(status);
1931 void GuiApplication::setGuiLanguage()
1933 // Set the language defined by the user.
1936 QString const default_language = toqstr(Messages::defaultLanguage());
1937 LYXERR(Debug::LOCALE, "Trying to set default locale to: " << default_language);
1938 QLocale const default_locale(default_language);
1939 QLocale::setDefault(default_locale);
1941 // install translation file for Qt built-in dialogs
1942 QString const language_name = QString("qt_") + default_locale.name();
1944 // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
1945 // Short-named translator can be loaded from a long name, but not the
1946 // opposite. Therefore, long name should be used without truncation.
1947 // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
1948 if (!d->qt_trans_.load(language_name,
1949 QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
1950 LYXERR(Debug::LOCALE, "Could not find Qt translations for locale "
1953 LYXERR(Debug::LOCALE, "Successfully installed Qt translations for locale "
1957 switch (default_locale.language()) {
1958 case QLocale::Arabic :
1959 case QLocale::Hebrew :
1960 case QLocale::Persian :
1961 case QLocale::Urdu :
1962 setLayoutDirection(Qt::RightToLeft);
1965 setLayoutDirection(Qt::LeftToRight);
1970 void GuiApplication::processFuncRequestQueue()
1972 while (!d->func_request_queue_.empty()) {
1973 lyx::dispatch(d->func_request_queue_.back());
1974 d->func_request_queue_.pop();
1979 void GuiApplication::execBatchCommands()
1984 if (!readUIFile(toqstr(lyxrc.ui_file)))
1985 // Gives some error box here.
1989 #if QT_VERSION > 0x040600
1990 setAttribute(Qt::AA_MacDontSwapCtrlAndMeta,lyxrc.mac_dontswap_ctrl_meta);
1992 // Create the global default menubar which is shown for the dialogs
1993 // and if no GuiView is visible.
1994 // This must be done after the session was recovered to know the "last files".
1995 d->global_menubar_ = new GlobalMenuBar();
1996 d->menus_.fillMenuBar(d->global_menubar_, 0, true);
1999 lyx::execBatchCommands();
2003 QAbstractItemModel * GuiApplication::languageModel()
2005 if (d->language_model_)
2006 return d->language_model_;
2008 QStandardItemModel * lang_model = new QStandardItemModel(this);
2009 lang_model->insertColumns(0, 3);
2011 QIcon speller(getPixmap("images/", "dialog-show_spellchecker", "png"));
2012 QIcon saurus(getPixmap("images/", "thesaurus-entry", "png"));
2013 Languages::const_iterator it = lyx::languages.begin();
2014 Languages::const_iterator end = lyx::languages.end();
2015 for (; it != end; ++it) {
2016 current_row = lang_model->rowCount();
2017 lang_model->insertRows(current_row, 1);
2018 QModelIndex pl_item = lang_model->index(current_row, 0);
2019 QModelIndex sp_item = lang_model->index(current_row, 1);
2020 QModelIndex th_item = lang_model->index(current_row, 2);
2021 lang_model->setData(pl_item, qt_(it->second.display()), Qt::DisplayRole);
2022 lang_model->setData(pl_item, toqstr(it->second.lang()), Qt::UserRole);
2023 lang_model->setData(sp_item, qt_(it->second.display()), Qt::DisplayRole);
2024 lang_model->setData(sp_item, toqstr(it->second.lang()), Qt::UserRole);
2025 if (theSpellChecker() && theSpellChecker()->hasDictionary(&it->second))
2026 lang_model->setData(sp_item, speller, Qt::DecorationRole);
2027 lang_model->setData(th_item, qt_(it->second.display()), Qt::DisplayRole);
2028 lang_model->setData(th_item, toqstr(it->second.lang()), Qt::UserRole);
2029 if (thesaurus.thesaurusInstalled(from_ascii(it->second.code())))
2030 lang_model->setData(th_item, saurus, Qt::DecorationRole);
2032 d->language_model_ = new QSortFilterProxyModel(this);
2033 d->language_model_->setSourceModel(lang_model);
2034 #if QT_VERSION >= 0x040300
2035 d->language_model_->setSortLocaleAware(true);
2037 return d->language_model_;
2041 void GuiApplication::restoreGuiSession()
2043 if (!lyxrc.load_session)
2046 Session & session = theSession();
2047 LastOpenedSection::LastOpened const & lastopened =
2048 session.lastOpened().getfiles();
2050 FileName active_file;
2051 // do not add to the lastfile list since these files are restored from
2052 // last session, and should be already there (regular files), or should
2053 // not be added at all (help files).
2054 for (size_t i = 0; i < lastopened.size(); ++i) {
2055 FileName const & file_name = lastopened[i].file_name;
2056 if (d->views_.empty() || (!lyxrc.open_buffers_in_tabs
2057 && current_view_->documentBufferView() != 0)) {
2058 boost::crc_32_type crc;
2059 string const & fname = file_name.absFileName();
2060 crc = for_each(fname.begin(), fname.end(), crc);
2061 createView(crc.checksum());
2063 current_view_->loadDocument(file_name, false);
2065 if (lastopened[i].active)
2066 active_file = file_name;
2069 // Restore last active buffer
2070 Buffer * buffer = theBufferList().getBuffer(active_file);
2072 current_view_->setBuffer(buffer);
2074 // clear this list to save a few bytes of RAM
2075 session.lastOpened().clear();
2079 QString const GuiApplication::romanFontName()
2082 font.setKerning(false);
2083 font.setStyleHint(QFont::Serif);
2084 font.setFamily("serif");
2086 return QFontInfo(font).family();
2090 QString const GuiApplication::sansFontName()
2093 font.setKerning(false);
2094 font.setStyleHint(QFont::SansSerif);
2095 font.setFamily("sans");
2097 return QFontInfo(font).family();
2101 QString const GuiApplication::typewriterFontName()
2104 font.setKerning(false);
2105 font.setStyleHint(QFont::TypeWriter);
2106 font.setFamily("monospace");
2108 return QFontInfo(font).family();
2112 void GuiApplication::handleRegularEvents()
2114 ForkedCallsController::handleCompletedProcesses();
2118 bool GuiApplication::event(QEvent * e)
2121 case QEvent::FileOpen: {
2122 // Open a file; this happens only on Mac OS X for now.
2124 // We do this asynchronously because on startup the batch
2125 // commands are not executed here yet and the gui is not ready
2127 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
2128 dispatchDelayed(FuncRequest(LFUN_FILE_OPEN, qstring_to_ucs4(foe->file())));
2133 return QApplication::event(e);
2138 bool GuiApplication::notify(QObject * receiver, QEvent * event)
2141 return QApplication::notify(receiver, event);
2143 catch (ExceptionMessage const & e) {
2145 case ErrorException:
2147 setQuitOnLastWindowClosed(false);
2149 Alert::error(e.title_, e.details_);
2151 // Properly crash in debug mode in order to get a useful backtrace.
2154 // In release mode, try to exit gracefully.
2157 case BufferException: {
2158 if (!current_view_->documentBufferView())
2160 Buffer * buf = ¤t_view_->documentBufferView()->buffer();
2161 docstring details = e.details_ + '\n';
2162 details += buf->emergencyWrite();
2163 theBufferList().release(buf);
2164 details += "\n" + _("The current document was closed.");
2165 Alert::error(e.title_, details);
2168 case WarningException:
2169 Alert::warning(e.title_, e.details_);
2173 catch (exception const & e) {
2174 docstring s = _("LyX has caught an exception, it will now "
2175 "attempt to save all unsaved documents and exit."
2177 s += from_ascii(e.what());
2178 Alert::error(_("Software exception Detected"), s);
2182 docstring s = _("LyX has caught some really weird exception, it will "
2183 "now attempt to save all unsaved documents and exit.");
2184 Alert::error(_("Software exception Detected"), s);
2192 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
2194 QColor const & qcol = d->color_cache_.get(col);
2195 if (!qcol.isValid()) {
2201 rgbcol.r = qcol.red();
2202 rgbcol.g = qcol.green();
2203 rgbcol.b = qcol.blue();
2208 string const GuiApplication::hexName(ColorCode col)
2210 return ltrim(fromqstr(d->color_cache_.get(col).name()), "#");
2214 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
2216 SocketNotifier * sn = new SocketNotifier(this, fd, func);
2217 d->socket_notifiers_[fd] = sn;
2218 connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
2222 void GuiApplication::socketDataReceived(int fd)
2224 d->socket_notifiers_[fd]->func_();
2228 void GuiApplication::unregisterSocketCallback(int fd)
2230 d->socket_notifiers_.take(fd)->setEnabled(false);
2234 void GuiApplication::commitData(QSessionManager & sm)
2236 /// The implementation is required to avoid an application exit
2237 /// when session state save is triggered by session manager.
2238 /// The default implementation sends a close event to all
2239 /// visible top level widgets when session managment allows
2241 /// We are changing that to close all wiew one by one.
2242 /// FIXME: verify if the default implementation is enough now.
2243 if (sm.allowsInteraction() && !closeAllViews())
2248 void GuiApplication::unregisterView(GuiView * gv)
2250 LASSERT(d->views_[gv->id()] == gv, /**/);
2251 d->views_.remove(gv->id());
2252 if (current_view_ == gv)
2257 bool GuiApplication::closeAllViews()
2259 if (d->views_.empty())
2262 // When a view/window was closed before without quitting LyX, there
2263 // are already entries in the lastOpened list.
2264 theSession().lastOpened().clear();
2266 QList<GuiView *> views = d->views_.values();
2267 foreach (GuiView * view, views) {
2268 if (!view->closeScheduled())
2277 GuiView & GuiApplication::view(int id) const
2279 LASSERT(d->views_.contains(id), /**/);
2280 return *d->views_.value(id);
2284 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
2286 QList<GuiView *> views = d->views_.values();
2287 foreach (GuiView * view, views)
2288 view->hideDialog(name, inset);
2292 Buffer const * GuiApplication::updateInset(Inset const * inset) const
2294 Buffer const * buffer_ = 0;
2295 QHash<int, GuiView *>::iterator end = d->views_.end();
2296 for (QHash<int, GuiView *>::iterator it = d->views_.begin(); it != end; ++it) {
2297 if (Buffer const * ptr = (*it)->updateInset(inset))
2304 bool GuiApplication::searchMenu(FuncRequest const & func,
2305 docstring_list & names) const
2307 return d->menus_.searchMenu(func, names);
2311 bool GuiApplication::readUIFile(QString const & name, bool include)
2313 LYXERR(Debug::INIT, "About to read " << name << "...");
2317 ui_path = libFileSearch("ui", name, "inc");
2318 if (ui_path.empty())
2319 ui_path = libFileSearch("ui", changeExtension(name, "inc"));
2321 ui_path = libFileSearch("ui", name, "ui");
2324 if (ui_path.empty()) {
2325 static const QString defaultUIFile = "default";
2326 LYXERR(Debug::INIT, "Could not find " << name);
2328 Alert::warning(_("Could not find UI definition file"),
2329 bformat(_("Error while reading the included file\n%1$s\n"
2330 "Please check your installation."), qstring_to_ucs4(name)));
2333 if (name == defaultUIFile) {
2334 LYXERR(Debug::INIT, "Could not find default UI file!!");
2335 Alert::warning(_("Could not find default UI file"),
2336 _("LyX could not find the default UI file!\n"
2337 "Please check your installation."));
2340 Alert::warning(_("Could not find UI definition file"),
2341 bformat(_("Error while reading the configuration file\n%1$s\n"
2342 "Falling back to default.\n"
2343 "Please look under Tools>Preferences>User Interface and\n"
2344 "check which User Interface file you are using."), qstring_to_ucs4(name)));
2345 return readUIFile(defaultUIFile, false);
2348 // Ensure that a file is read only once (prevents include loops)
2349 static QStringList uifiles;
2350 QString const uifile = toqstr(ui_path.absFileName());
2351 if (uifiles.contains(uifile)) {
2353 // We are reading again the top uifile so reset the safeguard:
2356 d->toolbars_.reset();
2358 LYXERR(Debug::INIT, "UI file '" << name << "' has been read already. "
2359 << "Is this an include loop?");
2363 uifiles.push_back(uifile);
2365 LYXERR(Debug::INIT, "Found " << name << " in " << ui_path);
2375 LexerKeyword uitags[] = {
2376 { "include", ui_include },
2377 { "menuset", ui_menuset },
2378 { "toolbars", ui_toolbars },
2379 { "toolbarset", ui_toolbarset }
2383 lex.setFile(ui_path);
2385 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
2389 if (lyxerr.debugging(Debug::PARSER))
2390 lex.printTable(lyxerr);
2392 // store which ui files define Toolbars
2393 static QStringList toolbar_uifiles;
2395 while (lex.isOK()) {
2396 switch (lex.lex()) {
2399 QString const file = toqstr(lex.getString());
2400 if (!readUIFile(file, true))
2405 d->menus_.read(lex);
2409 d->toolbars_.readToolbars(lex);
2413 d->toolbars_.readToolbarSettings(lex);
2414 toolbar_uifiles.push_back(uifile);
2418 if (!rtrim(lex.getString()).empty())
2419 lex.printError("LyX::ReadUIFile: "
2420 "Unknown menu tag: `$$Token'");
2429 settings.beginGroup("ui_files");
2430 bool touched = false;
2431 for (int i = 0; i != uifiles.size(); ++i) {
2432 QFileInfo fi(uifiles[i]);
2433 QDateTime const date_value = fi.lastModified();
2434 QString const name_key = QString::number(i);
2435 // if an ui file which defines Toolbars has changed,
2436 // we have to reset the settings
2437 if (toolbar_uifiles.contains(uifiles[i])
2438 && (!settings.contains(name_key)
2439 || settings.value(name_key).toString() != uifiles[i]
2440 || settings.value(name_key + "/date").toDateTime() != date_value)) {
2442 settings.setValue(name_key, uifiles[i]);
2443 settings.setValue(name_key + "/date", date_value);
2446 settings.endGroup();
2448 settings.remove("views");
2454 void GuiApplication::onLastWindowClosed()
2456 if (d->global_menubar_)
2457 d->global_menubar_->grabKeyboard();
2461 ////////////////////////////////////////////////////////////////////////
2463 // X11 specific stuff goes here...
2466 bool GuiApplication::x11EventFilter(XEvent * xev)
2471 switch (xev->type) {
2472 case SelectionRequest: {
2473 if (xev->xselectionrequest.selection != XA_PRIMARY)
2475 LYXERR(Debug::SELECTION, "X requested selection.");
2476 BufferView * bv = current_view_->currentBufferView();
2478 docstring const sel = bv->requestSelection();
2480 d->selection_.put(sel);
2484 case SelectionClear: {
2485 if (xev->xselectionclear.selection != XA_PRIMARY)
2487 LYXERR(Debug::SELECTION, "Lost selection.");
2488 BufferView * bv = current_view_->currentBufferView();
2490 bv->clearSelection();
2498 } // namespace frontend
2501 void hideDialogs(std::string const & name, Inset * inset)
2504 frontend::guiApp->hideDialogs(name, inset);
2508 ////////////////////////////////////////////////////////////////////
2512 ////////////////////////////////////////////////////////////////////
2514 frontend::FontLoader & theFontLoader()
2516 LASSERT(frontend::guiApp, /**/);
2517 return frontend::guiApp->fontLoader();
2521 frontend::FontMetrics const & theFontMetrics(Font const & f)
2523 return theFontMetrics(f.fontInfo());
2527 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
2529 LASSERT(frontend::guiApp, /**/);
2530 return frontend::guiApp->fontLoader().metrics(f);
2534 ////////////////////////////////////////////////////////////////////
2538 ////////////////////////////////////////////////////////////////////
2540 frontend::Clipboard & theClipboard()
2542 LASSERT(frontend::guiApp, /**/);
2543 return frontend::guiApp->clipboard();
2547 frontend::Selection & theSelection()
2549 LASSERT(frontend::guiApp, /**/);
2550 return frontend::guiApp->selection();
2556 #include "moc_GuiApplication.cpp"