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.screenUpdate(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.screenUpdate());
1113 // Do we have a selection?
1114 theSelection().haveSelection(bv->cursor().selection());
1117 current_view_->restartCursor();
1119 if (dr.needMessageUpdate()) {
1120 // Some messages may already be translated, so we cannot use _()
1121 current_view_->message(makeDispatchMessage(
1122 translateIfPossible(dr.message()), cmd));
1127 void GuiApplication::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
1129 LASSERT(current_view_, /**/);
1130 if (!theSession().bookmarks().isValid(idx))
1132 BookmarksSection::Bookmark const & bm = theSession().bookmarks().bookmark(idx);
1133 LASSERT(!bm.filename.empty(), /**/);
1134 string const file = bm.filename.absFileName();
1135 // if the file is not opened, open it.
1136 if (!theBufferList().exists(bm.filename)) {
1138 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
1142 // open may fail, so we need to test it again
1143 if (!theBufferList().exists(bm.filename))
1146 // bm can be changed when saving
1147 BookmarksSection::Bookmark tmp = bm;
1149 // Special case idx == 0 used for back-from-back jump navigation
1151 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
1153 // if the current buffer is not that one, switch to it.
1154 if (!current_view_->documentBufferView()
1155 || current_view_->documentBufferView()->buffer().fileName() != tmp.filename) {
1156 if (!switchToBuffer)
1158 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
1161 // moveToPosition try paragraph id first and then paragraph (pit, pos).
1162 if (!current_view_->documentBufferView()->moveToPosition(
1163 tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
1170 // Cursor jump succeeded!
1171 Cursor const & cur = current_view_->documentBufferView()->cursor();
1172 pit_type new_pit = cur.pit();
1173 pos_type new_pos = cur.pos();
1174 int new_id = cur.paragraph().id();
1176 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
1177 // see http://www.lyx.org/trac/ticket/3092
1178 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
1179 || bm.top_id != new_id) {
1180 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
1181 new_pit, new_pos, new_id);
1185 // This function runs "configure" and then rereads lyx.defaults to
1186 // reconfigure the automatic settings.
1187 void GuiApplication::reconfigure(string const & option)
1189 // emit message signal.
1191 current_view_->message(_("Running configure..."));
1193 // Run configure in user lyx directory
1194 PathChanger p(package().user_support());
1195 string configure_command = package().configure_command();
1196 configure_command += option;
1198 int ret = one.startscript(Systemcall::Wait, configure_command);
1200 // emit message signal.
1202 current_view_->message(_("Reloading configuration..."));
1203 lyxrc.read(libFileSearch(QString(), "lyxrc.defaults"));
1204 // Re-read packages.lst
1205 LaTeXFeatures::getAvailable();
1208 Alert::information(_("System reconfiguration failed"),
1209 _("The system reconfiguration has failed.\n"
1210 "Default textclass is used but LyX may "
1211 "not be able to work properly.\n"
1212 "Please reconfigure again if needed."));
1214 Alert::information(_("System reconfigured"),
1215 _("The system has been reconfigured.\n"
1216 "You need to restart LyX to make use of any\n"
1217 "updated document class specifications."));
1221 void GuiApplication::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1223 string const argument = to_utf8(cmd.argument());
1224 FuncCode const action = cmd.action();
1226 LYXERR(Debug::ACTION, "cmd: " << cmd);
1228 // we have not done anything wrong yet.
1231 FuncStatus const flag = getStatus(cmd);
1232 if (!flag.enabled()) {
1233 // We cannot use this function here
1234 LYXERR(Debug::ACTION, "action "
1235 << lyxaction.getActionName(action)
1236 << " [" << action << "] is disabled at this location");
1238 current_view_->restartCursor();
1239 dr.setMessage(flag.message());
1241 dr.dispatched(false);
1242 dr.screenUpdate(Update::None);
1243 dr.clearBufferUpdate();
1247 // Assumes that the action will be dispatched.
1248 dr.dispatched(true);
1250 switch (cmd.action()) {
1252 case LFUN_WINDOW_NEW:
1253 createView(toqstr(cmd.argument()));
1256 case LFUN_WINDOW_CLOSE:
1257 // update bookmark pit of the current buffer before window close
1258 for (size_t i = 0; i < theSession().bookmarks().size(); ++i)
1259 gotoBookmark(i+1, false, false);
1260 // clear the last opened list, because
1261 // maybe this will end the session
1262 theSession().lastOpened().clear();
1263 current_view_->closeScheduled();
1267 // quitting is triggered by the gui code
1268 // (leaving the event loop).
1270 current_view_->message(from_utf8(N_("Exiting.")));
1271 if (closeAllViews())
1275 case LFUN_SCREEN_FONT_UPDATE: {
1276 // handle the screen font changes.
1277 d->font_loader_.update();
1278 // Backup current_view_
1279 GuiView * view = current_view_;
1280 // Set current_view_ to zero to forbid GuiWorkArea::redraw()
1281 // to skip the refresh.
1283 theBufferList().changed(false);
1284 // Restore current_view_
1285 current_view_ = view;
1289 case LFUN_BUFFER_NEW:
1290 if (d->views_.empty()
1291 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1292 createView(QString(), false); // keep hidden
1293 current_view_->newDocument(to_utf8(cmd.argument()), false);
1294 current_view_->show();
1295 setActiveWindow(current_view_);
1297 current_view_->newDocument(to_utf8(cmd.argument()), false);
1301 case LFUN_BUFFER_NEW_TEMPLATE:
1302 if (d->views_.empty()
1303 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1305 current_view_->newDocument(to_utf8(cmd.argument()), true);
1306 if (!current_view_->documentBufferView())
1307 current_view_->close();
1309 current_view_->newDocument(to_utf8(cmd.argument()), true);
1313 case LFUN_FILE_OPEN:
1314 // FIXME: create a new method shared with LFUN_HELP_OPEN.
1315 if (d->views_.empty()
1316 || (!lyxrc.open_buffers_in_tabs && current_view_->documentBufferView() != 0)) {
1317 string const fname = to_utf8(cmd.argument());
1318 // We want the ui session to be saved per document and not per
1319 // window number. The filename crc is a good enough identifier.
1320 boost::crc_32_type crc;
1321 crc = for_each(fname.begin(), fname.end(), crc);
1322 createView(crc.checksum());
1323 current_view_->openDocument(fname);
1324 if (current_view_ && !current_view_->documentBufferView())
1325 current_view_->close();
1327 current_view_->openDocument(to_utf8(cmd.argument()));
1330 case LFUN_HELP_OPEN: {
1331 // FIXME: create a new method shared with LFUN_FILE_OPEN.
1332 if (current_view_ == 0)
1334 string const arg = to_utf8(cmd.argument());
1336 current_view_->message(_("Missing argument"));
1339 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
1341 fname = i18nLibFileSearch("examples", arg, "lyx");
1343 if (fname.empty()) {
1344 lyxerr << "LyX: unable to find documentation file `"
1345 << arg << "'. Bad installation?" << endl;
1348 current_view_->message(bformat(_("Opening help file %1$s..."),
1349 makeDisplayPath(fname.absFileName())));
1350 Buffer * buf = current_view_->loadDocument(fname, false);
1352 current_view_->setBuffer(buf);
1353 #ifndef DEVEL_VERSION
1354 buf->setReadonly(true);
1356 buf->errors("Parse");
1361 case LFUN_SET_COLOR: {
1363 string const x11_name = split(to_utf8(cmd.argument()), lyx_name, ' ');
1364 if (lyx_name.empty() || x11_name.empty()) {
1365 current_view_->message(
1366 _("Syntax: set-color <lyx_name> <x11_name>"));
1370 string const graphicsbg = lcolor.getLyXName(Color_graphicsbg);
1371 bool const graphicsbg_changed =
1372 lyx_name == graphicsbg && x11_name != graphicsbg;
1373 if (graphicsbg_changed) {
1374 // FIXME: The graphics cache no longer has a changeDisplay method.
1376 graphics::GCache::get().changeDisplay(true);
1380 if (!lcolor.setColor(lyx_name, x11_name)) {
1381 current_view_->message(
1382 bformat(_("Set-color \"%1$s\" failed "
1383 "- color is undefined or "
1384 "may not be redefined"),
1385 from_utf8(lyx_name)));
1388 // Make sure we don't keep old colors in cache.
1389 d->color_cache_.clear();
1393 case LFUN_LYXRC_APPLY: {
1394 // reset active key sequences, since the bindings
1395 // are updated (bug 6064)
1397 LyXRC const lyxrc_orig = lyxrc;
1399 istringstream ss(to_utf8(cmd.argument()));
1400 bool const success = lyxrc.read(ss) == 0;
1403 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1404 << "Unable to read lyxrc data"
1409 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1416 case LFUN_COMMAND_PREFIX:
1417 dispatch(FuncRequest(LFUN_MESSAGE, d->keyseq.printOptions(true)));
1422 d->meta_fake_bit = NoModifier;
1423 GuiView * gv = currentView();
1424 if (gv && gv->currentBufferView())
1425 // cancel any selection
1426 lyx::dispatch(FuncRequest(LFUN_MARK_OFF));
1427 dr.setMessage(from_ascii(N_("Cancel")));
1430 case LFUN_META_PREFIX:
1431 d->meta_fake_bit = AltModifier;
1432 dr.setMessage(d->keyseq.print(KeySequence::ForGui));
1435 // --- Menus -----------------------------------------------
1436 case LFUN_RECONFIGURE:
1437 // argument is any additional parameter to the configure.py command
1438 reconfigure(to_utf8(cmd.argument()));
1441 // --- lyxserver commands ----------------------------
1442 case LFUN_SERVER_GET_FILENAME: {
1443 LASSERT(current_view_ && current_view_->documentBufferView(), return);
1444 docstring const fname = from_utf8(
1445 current_view_->documentBufferView()->buffer().absFileName());
1446 dr.setMessage(fname);
1447 LYXERR(Debug::INFO, "FNAME[" << fname << ']');
1450 case LFUN_SERVER_NOTIFY: {
1451 docstring const dispatch_buffer = d->keyseq.print(KeySequence::Portable);
1452 dr.setMessage(dispatch_buffer);
1453 theServer().notifyClient(to_utf8(dispatch_buffer));
1457 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1458 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1464 string rest = split(argument, countstr, ' ');
1465 istringstream is(countstr);
1468 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1469 for (int i = 0; i < count; ++i)
1470 dispatch(lyxaction.lookupFunc(rest));
1474 case LFUN_COMMAND_SEQUENCE: {
1475 // argument contains ';'-terminated commands
1476 string arg = argument;
1477 // FIXME: this LFUN should also work without any view.
1478 Buffer * buffer = (current_view_ && current_view_->documentBufferView())
1479 ? &(current_view_->documentBufferView()->buffer()) : 0;
1481 buffer->undo().beginUndoGroup();
1482 while (!arg.empty()) {
1484 arg = split(arg, first, ';');
1485 FuncRequest func(lyxaction.lookupFunc(first));
1486 func.setOrigin(cmd.origin());
1489 // the buffer may have been closed by one action
1490 if (theBufferList().isLoaded(buffer))
1491 buffer->undo().endUndoGroup();
1495 case LFUN_COMMAND_ALTERNATIVES: {
1496 // argument contains ';'-terminated commands
1497 string arg = argument;
1498 while (!arg.empty()) {
1500 arg = split(arg, first, ';');
1501 FuncRequest func(lyxaction.lookupFunc(first));
1502 func.setOrigin(cmd.origin());
1503 FuncStatus const stat = getStatus(func);
1504 if (stat.enabled()) {
1514 if (theTopLevelCmdDef().lock(argument, func)) {
1515 func.setOrigin(cmd.origin());
1517 theTopLevelCmdDef().release(argument);
1519 if (func.action() == LFUN_UNKNOWN_ACTION) {
1520 // unknown command definition
1521 lyxerr << "Warning: unknown command definition `"
1525 // recursion detected
1526 lyxerr << "Warning: Recursion in the command definition `"
1527 << argument << "' detected"
1534 case LFUN_PREFERENCES_SAVE:
1535 lyxrc.write(support::makeAbsPath("preferences",
1536 package().user_support().absFileName()), false);
1539 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1540 string const fname = addName(addPath(package().user_support().absFileName(),
1541 "templates/"), "defaults.lyx");
1542 Buffer defaults(fname);
1544 istringstream ss(argument);
1547 int const unknown_tokens = defaults.readHeader(lex);
1549 if (unknown_tokens != 0) {
1550 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1551 << unknown_tokens << " unknown token"
1552 << (unknown_tokens == 1 ? "" : "s")
1556 if (defaults.writeFile(FileName(defaults.absFileName())))
1557 dr.setMessage(bformat(_("Document defaults saved in %1$s"),
1558 makeDisplayPath(fname)));
1561 dr.setMessage(from_ascii(N_("Unable to save document defaults")));
1566 case LFUN_BOOKMARK_GOTO:
1567 // go to bookmark, open unopened file and switch to buffer if necessary
1568 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1569 dr.screenUpdate(Update::Force | Update::FitCursor);
1572 case LFUN_BOOKMARK_CLEAR:
1573 theSession().bookmarks().clear();
1576 case LFUN_DEBUG_LEVEL_SET:
1577 lyxerr.setLevel(Debug::value(to_utf8(cmd.argument())));
1581 // Everything below is only for active window
1582 if (current_view_ == 0)
1585 // Let the current GuiView dispatch its own actions.
1586 current_view_->dispatch(cmd, dr);
1588 if (dr.dispatched())
1591 BufferView * bv = current_view_->currentBufferView();
1594 // Let the current BufferView dispatch its own actions.
1595 bv->dispatch(cmd, dr);
1596 if (dr.dispatched())
1599 BufferView * doc_bv = current_view_->documentBufferView();
1600 // Try with the document BufferView dispatch if any.
1602 doc_bv->dispatch(cmd, dr);
1603 if (dr.dispatched())
1607 // OK, so try the current Buffer itself...
1608 bv->buffer().dispatch(cmd, dr);
1609 if (dr.dispatched())
1612 // and with the document Buffer.
1614 doc_bv->buffer().dispatch(cmd, dr);
1615 if (dr.dispatched())
1619 // Let the current Cursor dispatch its own actions.
1620 Cursor old = bv->cursor();
1621 bv->cursor().dispatch(cmd);
1623 // notify insets we just left
1624 if (bv->cursor() != old) {
1626 bool badcursor = notifyCursorLeavesOrEnters(old, bv->cursor());
1628 bv->cursor().fixIfBroken();
1631 // update completion. We do it here and not in
1632 // processKeySym to avoid another redraw just for a
1633 // changed inline completion
1634 if (cmd.origin() == FuncRequest::KEYBOARD) {
1635 if (cmd.action() == LFUN_SELF_INSERT
1636 || (cmd.action() == LFUN_ERT_INSERT && bv->cursor().inMathed()))
1637 current_view_->updateCompletion(bv->cursor(), true, true);
1638 else if (cmd.action() == LFUN_CHAR_DELETE_BACKWARD)
1639 current_view_->updateCompletion(bv->cursor(), false, true);
1641 current_view_->updateCompletion(bv->cursor(), false, false);
1644 dr = bv->cursor().result();
1647 // if we executed a mutating lfun, mark the buffer as dirty
1648 Buffer * doc_buffer = (current_view_ && current_view_->documentBufferView())
1649 ? &(current_view_->documentBufferView()->buffer()) : 0;
1650 if (doc_buffer && theBufferList().isLoaded(doc_buffer)
1652 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1653 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1654 current_view_->currentBufferView()->buffer().markDirty();
1658 docstring GuiApplication::viewStatusMessage()
1660 // When meta-fake key is pressed, show the key sequence so far + "M-".
1661 if (d->meta_fake_bit != NoModifier)
1662 return d->keyseq.print(KeySequence::ForGui) + "M-";
1664 // Else, when a non-complete key sequence is pressed,
1665 // show the available options.
1666 if (d->keyseq.length() > 0 && !d->keyseq.deleted())
1667 return d->keyseq.printOptions(true);
1673 void GuiApplication::handleKeyFunc(FuncCode action)
1677 if (d->keyseq.length())
1679 GuiView * gv = currentView();
1680 LASSERT(gv && gv->currentBufferView(), return);
1681 BufferView * bv = gv->currentBufferView();
1682 bv->getIntl().getTransManager().deadkey(
1683 c, get_accent(action).accent, bv->cursor().innerText(),
1685 // Need to clear, in case the minibuffer calls these
1688 // copied verbatim from do_accent_char
1689 bv->cursor().resetAnchor();
1693 void GuiApplication::processKeySym(KeySymbol const & keysym, KeyModifier state)
1695 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
1697 // Do nothing if we have nothing (JMarc)
1698 if (!keysym.isOK()) {
1699 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
1700 current_view_->restartCursor();
1704 if (keysym.isModifier()) {
1705 LYXERR(Debug::KEY, "isModifier true");
1707 current_view_->restartCursor();
1711 char_type encoded_last_key = keysym.getUCSEncoded();
1713 // Do a one-deep top-level lookup for
1714 // cancel and meta-fake keys. RVDK_PATCH_5
1715 d->cancel_meta_seq.reset();
1717 FuncRequest func = d->cancel_meta_seq.addkey(keysym, state);
1718 LYXERR(Debug::KEY, "action first set to [" << func.action() << ']');
1720 // When not cancel or meta-fake, do the normal lookup.
1721 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
1722 // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
1723 if ((func.action() != LFUN_CANCEL) && (func.action() != LFUN_META_PREFIX)) {
1724 // remove Caps Lock and Mod2 as a modifiers
1725 func = d->keyseq.addkey(keysym, (state | d->meta_fake_bit));
1726 LYXERR(Debug::KEY, "action now set to [" << func.action() << ']');
1729 // Dont remove this unless you know what you are doing.
1730 d->meta_fake_bit = NoModifier;
1732 // Can this happen now ?
1733 if (func.action() == LFUN_NOACTION)
1734 func = FuncRequest(LFUN_COMMAND_PREFIX);
1736 LYXERR(Debug::KEY, " Key [action=" << func.action() << "]["
1737 << d->keyseq.print(KeySequence::Portable) << ']');
1739 // already here we know if it any point in going further
1740 // why not return already here if action == -1 and
1741 // num_bytes == 0? (Lgb)
1743 if (d->keyseq.length() > 1)
1744 current_view_->message(d->keyseq.print(KeySequence::ForGui));
1747 // Maybe user can only reach the key via holding down shift.
1748 // Let's see. But only if shift is the only modifier
1749 if (func.action() == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
1750 LYXERR(Debug::KEY, "Trying without shift");
1751 func = d->keyseq.addkey(keysym, NoModifier);
1752 LYXERR(Debug::KEY, "Action now " << func.action());
1755 if (func.action() == LFUN_UNKNOWN_ACTION) {
1756 // Hmm, we didn't match any of the keysequences. See
1757 // if it's normal insertable text not already covered
1759 if (keysym.isText() && d->keyseq.length() == 1) {
1760 LYXERR(Debug::KEY, "isText() is true, inserting.");
1761 func = FuncRequest(LFUN_SELF_INSERT,
1762 FuncRequest::KEYBOARD);
1764 LYXERR(Debug::KEY, "Unknown, !isText() - giving up");
1765 current_view_->message(_("Unknown function."));
1766 current_view_->restartCursor();
1771 if (func.action() == LFUN_SELF_INSERT) {
1772 if (encoded_last_key != 0) {
1773 docstring const arg(1, encoded_last_key);
1774 lyx::dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
1775 FuncRequest::KEYBOARD));
1776 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
1779 lyx::dispatch(func);
1783 void GuiApplication::dispatchDelayed(FuncRequest const & func)
1785 d->func_request_queue_.push(func);
1786 QTimer::singleShot(0, this, SLOT(processFuncRequestQueue()));
1790 void GuiApplication::resetGui()
1792 // Set the language defined by the user.
1796 if (!readUIFile(toqstr(lyxrc.ui_file)))
1797 // Gives some error box here.
1800 if (d->global_menubar_)
1801 d->menus_.fillMenuBar(d->global_menubar_, 0, false);
1803 QHash<int, GuiView *>::iterator it;
1804 for (it = d->views_.begin(); it != d->views_.end(); ++it) {
1807 gv->setLayoutDirection(layoutDirection());
1811 lyx::dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
1815 void GuiApplication::createView(int view_id)
1817 createView(QString(), true, view_id);
1821 void GuiApplication::createView(QString const & geometry_arg, bool autoShow,
1824 // release the keyboard which might have been grabed by the global
1825 // menubar on Mac to catch shortcuts even without any GuiView.
1826 if (d->global_menubar_)
1827 d->global_menubar_->releaseKeyboard();
1831 while (d->views_.find(id) != d->views_.end())
1834 LYXERR(Debug::GUI, "About to create new window with ID " << id);
1835 GuiView * view = new GuiView(id);
1837 d->views_[id] = view;
1841 setActiveWindow(view);
1844 if (!geometry_arg.isEmpty()) {
1848 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)([+-][0-9]*)){0,1}" );
1849 re.indexIn(geometry_arg);
1850 w = re.cap(1).toInt();
1851 h = re.cap(2).toInt();
1852 x = re.cap(3).toInt();
1853 y = re.cap(4).toInt();
1854 view->setGeometry(x, y, w, h);
1861 Clipboard & GuiApplication::clipboard()
1863 return d->clipboard_;
1867 Selection & GuiApplication::selection()
1869 return d->selection_;
1873 FontLoader & GuiApplication::fontLoader()
1875 return d->font_loader_;
1879 Toolbars const & GuiApplication::toolbars() const
1881 return d->toolbars_;
1885 Toolbars & GuiApplication::toolbars()
1887 return d->toolbars_;
1891 Menus const & GuiApplication::menus() const
1897 Menus & GuiApplication::menus()
1903 QList<int> GuiApplication::viewIds() const
1905 return d->views_.keys();
1909 ColorCache & GuiApplication::colorCache()
1911 return d->color_cache_;
1915 int GuiApplication::exec()
1917 // asynchronously handle batch commands. This event will be in
1918 // the event queue in front of other asynchronous events. Hence,
1919 // we can assume in the latter that the gui is setup already.
1920 QTimer::singleShot(0, this, SLOT(execBatchCommands()));
1922 return QApplication::exec();
1926 void GuiApplication::exit(int status)
1928 QApplication::exit(status);
1932 void GuiApplication::setGuiLanguage()
1934 // Set the language defined by the user.
1937 QString const default_language = toqstr(Messages::defaultLanguage());
1938 LYXERR(Debug::LOCALE, "Trying to set default locale to: " << default_language);
1939 QLocale const default_locale(default_language);
1940 QLocale::setDefault(default_locale);
1942 // install translation file for Qt built-in dialogs
1943 QString const language_name = QString("qt_") + default_locale.name();
1945 // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
1946 // Short-named translator can be loaded from a long name, but not the
1947 // opposite. Therefore, long name should be used without truncation.
1948 // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
1949 if (!d->qt_trans_.load(language_name,
1950 QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
1951 LYXERR(Debug::LOCALE, "Could not find Qt translations for locale "
1954 LYXERR(Debug::LOCALE, "Successfully installed Qt translations for locale "
1958 switch (default_locale.language()) {
1959 case QLocale::Arabic :
1960 case QLocale::Hebrew :
1961 case QLocale::Persian :
1962 case QLocale::Urdu :
1963 setLayoutDirection(Qt::RightToLeft);
1966 setLayoutDirection(Qt::LeftToRight);
1971 void GuiApplication::processFuncRequestQueue()
1973 while (!d->func_request_queue_.empty()) {
1974 lyx::dispatch(d->func_request_queue_.back());
1975 d->func_request_queue_.pop();
1980 void GuiApplication::execBatchCommands()
1985 if (!readUIFile(toqstr(lyxrc.ui_file)))
1986 // Gives some error box here.
1990 #if QT_VERSION > 0x040600
1991 setAttribute(Qt::AA_MacDontSwapCtrlAndMeta,lyxrc.mac_dontswap_ctrl_meta);
1993 // Create the global default menubar which is shown for the dialogs
1994 // and if no GuiView is visible.
1995 // This must be done after the session was recovered to know the "last files".
1996 d->global_menubar_ = new GlobalMenuBar();
1997 d->menus_.fillMenuBar(d->global_menubar_, 0, true);
2000 lyx::execBatchCommands();
2004 QAbstractItemModel * GuiApplication::languageModel()
2006 if (d->language_model_)
2007 return d->language_model_;
2009 QStandardItemModel * lang_model = new QStandardItemModel(this);
2010 lang_model->insertColumns(0, 3);
2012 QIcon speller(getPixmap("images/", "dialog-show_spellchecker", "png"));
2013 QIcon saurus(getPixmap("images/", "thesaurus-entry", "png"));
2014 Languages::const_iterator it = lyx::languages.begin();
2015 Languages::const_iterator end = lyx::languages.end();
2016 for (; it != end; ++it) {
2017 current_row = lang_model->rowCount();
2018 lang_model->insertRows(current_row, 1);
2019 QModelIndex pl_item = lang_model->index(current_row, 0);
2020 QModelIndex sp_item = lang_model->index(current_row, 1);
2021 QModelIndex th_item = lang_model->index(current_row, 2);
2022 lang_model->setData(pl_item, qt_(it->second.display()), Qt::DisplayRole);
2023 lang_model->setData(pl_item, toqstr(it->second.lang()), Qt::UserRole);
2024 lang_model->setData(sp_item, qt_(it->second.display()), Qt::DisplayRole);
2025 lang_model->setData(sp_item, toqstr(it->second.lang()), Qt::UserRole);
2026 if (theSpellChecker() && theSpellChecker()->hasDictionary(&it->second))
2027 lang_model->setData(sp_item, speller, Qt::DecorationRole);
2028 lang_model->setData(th_item, qt_(it->second.display()), Qt::DisplayRole);
2029 lang_model->setData(th_item, toqstr(it->second.lang()), Qt::UserRole);
2030 if (thesaurus.thesaurusInstalled(from_ascii(it->second.code())))
2031 lang_model->setData(th_item, saurus, Qt::DecorationRole);
2033 d->language_model_ = new QSortFilterProxyModel(this);
2034 d->language_model_->setSourceModel(lang_model);
2035 #if QT_VERSION >= 0x040300
2036 d->language_model_->setSortLocaleAware(true);
2038 return d->language_model_;
2042 void GuiApplication::restoreGuiSession()
2044 if (!lyxrc.load_session)
2047 Session & session = theSession();
2048 LastOpenedSection::LastOpened const & lastopened =
2049 session.lastOpened().getfiles();
2051 FileName active_file;
2052 // do not add to the lastfile list since these files are restored from
2053 // last session, and should be already there (regular files), or should
2054 // not be added at all (help files).
2055 for (size_t i = 0; i < lastopened.size(); ++i) {
2056 FileName const & file_name = lastopened[i].file_name;
2057 if (d->views_.empty() || (!lyxrc.open_buffers_in_tabs
2058 && current_view_->documentBufferView() != 0)) {
2059 boost::crc_32_type crc;
2060 string const & fname = file_name.absFileName();
2061 crc = for_each(fname.begin(), fname.end(), crc);
2062 createView(crc.checksum());
2064 current_view_->loadDocument(file_name, false);
2066 if (lastopened[i].active)
2067 active_file = file_name;
2070 // Restore last active buffer
2071 Buffer * buffer = theBufferList().getBuffer(active_file);
2073 current_view_->setBuffer(buffer);
2075 // clear this list to save a few bytes of RAM
2076 session.lastOpened().clear();
2080 QString const GuiApplication::romanFontName()
2083 font.setKerning(false);
2084 font.setStyleHint(QFont::Serif);
2085 font.setFamily("serif");
2087 return QFontInfo(font).family();
2091 QString const GuiApplication::sansFontName()
2094 font.setKerning(false);
2095 font.setStyleHint(QFont::SansSerif);
2096 font.setFamily("sans");
2098 return QFontInfo(font).family();
2102 QString const GuiApplication::typewriterFontName()
2105 font.setKerning(false);
2106 font.setStyleHint(QFont::TypeWriter);
2107 font.setFamily("monospace");
2109 return QFontInfo(font).family();
2113 void GuiApplication::handleRegularEvents()
2115 ForkedCallsController::handleCompletedProcesses();
2119 bool GuiApplication::event(QEvent * e)
2122 case QEvent::FileOpen: {
2123 // Open a file; this happens only on Mac OS X for now.
2125 // We do this asynchronously because on startup the batch
2126 // commands are not executed here yet and the gui is not ready
2128 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
2129 dispatchDelayed(FuncRequest(LFUN_FILE_OPEN, qstring_to_ucs4(foe->file())));
2134 return QApplication::event(e);
2139 bool GuiApplication::notify(QObject * receiver, QEvent * event)
2142 return QApplication::notify(receiver, event);
2144 catch (ExceptionMessage const & e) {
2146 case ErrorException:
2148 setQuitOnLastWindowClosed(false);
2150 Alert::error(e.title_, e.details_);
2152 // Properly crash in debug mode in order to get a useful backtrace.
2155 // In release mode, try to exit gracefully.
2158 case BufferException: {
2159 if (!current_view_->documentBufferView())
2161 Buffer * buf = ¤t_view_->documentBufferView()->buffer();
2162 docstring details = e.details_ + '\n';
2163 details += buf->emergencyWrite();
2164 theBufferList().release(buf);
2165 details += "\n" + _("The current document was closed.");
2166 Alert::error(e.title_, details);
2169 case WarningException:
2170 Alert::warning(e.title_, e.details_);
2174 catch (exception const & e) {
2175 docstring s = _("LyX has caught an exception, it will now "
2176 "attempt to save all unsaved documents and exit."
2178 s += from_ascii(e.what());
2179 Alert::error(_("Software exception Detected"), s);
2183 docstring s = _("LyX has caught some really weird exception, it will "
2184 "now attempt to save all unsaved documents and exit.");
2185 Alert::error(_("Software exception Detected"), s);
2193 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
2195 QColor const & qcol = d->color_cache_.get(col);
2196 if (!qcol.isValid()) {
2202 rgbcol.r = qcol.red();
2203 rgbcol.g = qcol.green();
2204 rgbcol.b = qcol.blue();
2209 string const GuiApplication::hexName(ColorCode col)
2211 return ltrim(fromqstr(d->color_cache_.get(col).name()), "#");
2215 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
2217 SocketNotifier * sn = new SocketNotifier(this, fd, func);
2218 d->socket_notifiers_[fd] = sn;
2219 connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
2223 void GuiApplication::socketDataReceived(int fd)
2225 d->socket_notifiers_[fd]->func_();
2229 void GuiApplication::unregisterSocketCallback(int fd)
2231 d->socket_notifiers_.take(fd)->setEnabled(false);
2235 void GuiApplication::commitData(QSessionManager & sm)
2237 /// The implementation is required to avoid an application exit
2238 /// when session state save is triggered by session manager.
2239 /// The default implementation sends a close event to all
2240 /// visible top level widgets when session managment allows
2242 /// We are changing that to close all wiew one by one.
2243 /// FIXME: verify if the default implementation is enough now.
2244 if (sm.allowsInteraction() && !closeAllViews())
2249 void GuiApplication::unregisterView(GuiView * gv)
2251 LASSERT(d->views_[gv->id()] == gv, /**/);
2252 d->views_.remove(gv->id());
2253 if (current_view_ == gv)
2258 bool GuiApplication::closeAllViews()
2260 if (d->views_.empty())
2263 // When a view/window was closed before without quitting LyX, there
2264 // are already entries in the lastOpened list.
2265 theSession().lastOpened().clear();
2267 QList<GuiView *> views = d->views_.values();
2268 foreach (GuiView * view, views) {
2269 if (!view->closeScheduled())
2278 GuiView & GuiApplication::view(int id) const
2280 LASSERT(d->views_.contains(id), /**/);
2281 return *d->views_.value(id);
2285 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
2287 QList<GuiView *> views = d->views_.values();
2288 foreach (GuiView * view, views)
2289 view->hideDialog(name, inset);
2293 Buffer const * GuiApplication::updateInset(Inset const * inset) const
2295 Buffer const * buffer_ = 0;
2296 QHash<int, GuiView *>::iterator end = d->views_.end();
2297 for (QHash<int, GuiView *>::iterator it = d->views_.begin(); it != end; ++it) {
2298 if (Buffer const * ptr = (*it)->updateInset(inset))
2305 bool GuiApplication::searchMenu(FuncRequest const & func,
2306 docstring_list & names) const
2308 return d->menus_.searchMenu(func, names);
2312 bool GuiApplication::readUIFile(QString const & name, bool include)
2314 LYXERR(Debug::INIT, "About to read " << name << "...");
2318 ui_path = libFileSearch("ui", name, "inc");
2319 if (ui_path.empty())
2320 ui_path = libFileSearch("ui", changeExtension(name, "inc"));
2322 ui_path = libFileSearch("ui", name, "ui");
2325 if (ui_path.empty()) {
2326 static const QString defaultUIFile = "default";
2327 LYXERR(Debug::INIT, "Could not find " << name);
2329 Alert::warning(_("Could not find UI definition file"),
2330 bformat(_("Error while reading the included file\n%1$s\n"
2331 "Please check your installation."), qstring_to_ucs4(name)));
2334 if (name == defaultUIFile) {
2335 LYXERR(Debug::INIT, "Could not find default UI file!!");
2336 Alert::warning(_("Could not find default UI file"),
2337 _("LyX could not find the default UI file!\n"
2338 "Please check your installation."));
2341 Alert::warning(_("Could not find UI definition file"),
2342 bformat(_("Error while reading the configuration file\n%1$s\n"
2343 "Falling back to default.\n"
2344 "Please look under Tools>Preferences>User Interface and\n"
2345 "check which User Interface file you are using."), qstring_to_ucs4(name)));
2346 return readUIFile(defaultUIFile, false);
2349 // Ensure that a file is read only once (prevents include loops)
2350 static QStringList uifiles;
2351 QString const uifile = toqstr(ui_path.absFileName());
2352 if (uifiles.contains(uifile)) {
2354 // We are reading again the top uifile so reset the safeguard:
2357 d->toolbars_.reset();
2359 LYXERR(Debug::INIT, "UI file '" << name << "' has been read already. "
2360 << "Is this an include loop?");
2364 uifiles.push_back(uifile);
2366 LYXERR(Debug::INIT, "Found " << name << " in " << ui_path);
2376 LexerKeyword uitags[] = {
2377 { "include", ui_include },
2378 { "menuset", ui_menuset },
2379 { "toolbars", ui_toolbars },
2380 { "toolbarset", ui_toolbarset }
2384 lex.setFile(ui_path);
2386 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
2390 if (lyxerr.debugging(Debug::PARSER))
2391 lex.printTable(lyxerr);
2393 // store which ui files define Toolbars
2394 static QStringList toolbar_uifiles;
2396 while (lex.isOK()) {
2397 switch (lex.lex()) {
2400 QString const file = toqstr(lex.getString());
2401 if (!readUIFile(file, true))
2406 d->menus_.read(lex);
2410 d->toolbars_.readToolbars(lex);
2414 d->toolbars_.readToolbarSettings(lex);
2415 toolbar_uifiles.push_back(uifile);
2419 if (!rtrim(lex.getString()).empty())
2420 lex.printError("LyX::ReadUIFile: "
2421 "Unknown menu tag: `$$Token'");
2430 settings.beginGroup("ui_files");
2431 bool touched = false;
2432 for (int i = 0; i != uifiles.size(); ++i) {
2433 QFileInfo fi(uifiles[i]);
2434 QDateTime const date_value = fi.lastModified();
2435 QString const name_key = QString::number(i);
2436 // if an ui file which defines Toolbars has changed,
2437 // we have to reset the settings
2438 if (toolbar_uifiles.contains(uifiles[i])
2439 && (!settings.contains(name_key)
2440 || settings.value(name_key).toString() != uifiles[i]
2441 || settings.value(name_key + "/date").toDateTime() != date_value)) {
2443 settings.setValue(name_key, uifiles[i]);
2444 settings.setValue(name_key + "/date", date_value);
2447 settings.endGroup();
2449 settings.remove("views");
2455 void GuiApplication::onLastWindowClosed()
2457 if (d->global_menubar_)
2458 d->global_menubar_->grabKeyboard();
2462 ////////////////////////////////////////////////////////////////////////
2464 // X11 specific stuff goes here...
2467 bool GuiApplication::x11EventFilter(XEvent * xev)
2472 switch (xev->type) {
2473 case SelectionRequest: {
2474 if (xev->xselectionrequest.selection != XA_PRIMARY)
2476 LYXERR(Debug::SELECTION, "X requested selection.");
2477 BufferView * bv = current_view_->currentBufferView();
2479 docstring const sel = bv->requestSelection();
2481 d->selection_.put(sel);
2485 case SelectionClear: {
2486 if (xev->xselectionclear.selection != XA_PRIMARY)
2488 LYXERR(Debug::SELECTION, "Lost selection.");
2489 BufferView * bv = current_view_->currentBufferView();
2491 bv->clearSelection();
2499 } // namespace frontend
2502 void hideDialogs(std::string const & name, Inset * inset)
2505 frontend::guiApp->hideDialogs(name, inset);
2509 ////////////////////////////////////////////////////////////////////
2513 ////////////////////////////////////////////////////////////////////
2515 frontend::FontLoader & theFontLoader()
2517 LASSERT(frontend::guiApp, /**/);
2518 return frontend::guiApp->fontLoader();
2522 frontend::FontMetrics const & theFontMetrics(Font const & f)
2524 return theFontMetrics(f.fontInfo());
2528 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
2530 LASSERT(frontend::guiApp, /**/);
2531 return frontend::guiApp->fontLoader().metrics(f);
2535 ////////////////////////////////////////////////////////////////////
2539 ////////////////////////////////////////////////////////////////////
2541 frontend::Clipboard & theClipboard()
2543 LASSERT(frontend::guiApp, /**/);
2544 return frontend::guiApp->clipboard();
2548 frontend::Selection & theSelection()
2550 LASSERT(frontend::guiApp, /**/);
2551 return frontend::guiApp->selection();
2557 #include "moc_GuiApplication.cpp"