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 "qt_helpers.h"
19 #include "GuiKeySymbol.h"
22 #include "frontends/alert.h"
23 #include "frontends/Application.h"
24 #include "frontends/FontLoader.h"
25 #include "frontends/FontMetrics.h"
28 #include "BufferList.h"
29 #include "BufferView.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
39 #include "support/debug.h"
40 #include "support/ExceptionMessage.h"
41 #include "support/FileName.h"
42 #include "support/ForkedCalls.h"
43 #include "support/gettext.h"
44 #include "support/lstrings.h"
45 #include "support/os.h"
46 #include "support/Package.h"
48 #include <QApplication>
51 #include <QFileOpenEvent>
53 #include <QLibraryInfo>
55 #include <QPixmapCache>
57 #include <QSessionManager>
58 #include <QSocketNotifier>
61 #include <QTranslator>
65 #include <X11/Xatom.h>
71 #include <boost/bind.hpp>
76 using namespace lyx::support;
80 frontend::Application * createApplication(int & argc, char * argv[])
82 return new frontend::GuiApplication(argc, argv);
88 class SocketNotifier : public QSocketNotifier
91 /// connect a connection notification from the LyXServerSocket
92 SocketNotifier(QObject * parent, int fd, Application::SocketCallback func)
93 : QSocketNotifier(fd, QSocketNotifier::Read, parent), func_(func)
97 /// The callback function
98 Application::SocketCallback func_;
102 ////////////////////////////////////////////////////////////////////////
103 // Mac specific stuff goes here...
105 class MenuTranslator : public QTranslator
108 MenuTranslator(QObject * parent)
109 : QTranslator(parent)
112 QString translate(const char * /*context*/,
113 const char * sourceText,
114 const char * /*comment*/ = 0)
116 string const s = sourceText;
117 if (s == N_("About %1") || s == N_("Preferences")
118 || s == N_("Reconfigure") || s == N_("Quit %1"))
125 class GlobalMenuBar : public QMenuBar
129 GlobalMenuBar() : QMenuBar(0) {}
132 bool event(QEvent * e)
134 if (e->type() == QEvent::ShortcutOverride) {
135 // && activeWindow() == 0) {
136 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
138 setKeySymbol(&sym, ke);
139 theLyXFunc().processKeySym(sym, q_key_state(ke->modifiers()));
147 ///////////////////////////////////////////////////////////////
148 // You can find more platform specific stuff
149 // at the end of this file...
150 ///////////////////////////////////////////////////////////////
153 GuiApplication * guiApp;
156 GuiApplication::GuiApplication(int & argc, char ** argv)
157 : QApplication(argc, argv), Application(), current_view_(0), global_menubar_(0)
159 QString app_name = "LyX";
160 QCoreApplication::setOrganizationName(app_name);
161 QCoreApplication::setOrganizationDomain("lyx.org");
162 QCoreApplication::setApplicationName(app_name + "-" + lyx_version);
164 // FIXME: quitOnLastWindowClosed is true by default. We should have a
165 // lyxrc setting for this in order to let the application stay resident.
166 // But then we need some kind of dock icon, at least on Windows.
168 if (lyxrc.quit_on_last_window_closed)
169 setQuitOnLastWindowClosed(false);
172 // FIXME: Do we need a lyxrc setting for this on Mac? This behaviour
173 // seems to be the default case for applications like LyX.
174 setQuitOnLastWindowClosed(false);
178 // doubleClickInterval() is 400 ms on X11 which is just too long.
179 // On Windows and Mac OS X, the operating system's value is used.
180 // On Microsoft Windows, calling this function sets the double
181 // click interval for all applications. So we don't!
182 QApplication::setDoubleClickInterval(300);
185 // install translation file for Qt built-in dialogs
186 QString language_name = QString("qt_") + QLocale::system().name();
188 // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
189 // Short-named translator can be loaded from a long name, but not the
190 // opposite. Therefore, long name should be used without truncation.
191 // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
192 if (qt_trans_.load(language_name,
193 QLibraryInfo::location(QLibraryInfo::TranslationsPath)))
195 installTranslator(&qt_trans_);
196 // even if the language calls for RtL, don't do that
197 setLayoutDirection(Qt::LeftToRight);
198 LYXERR(Debug::GUI, "Successfully installed Qt translations for locale "
199 << fromqstr(language_name));
201 LYXERR(Debug::GUI, "Could not find Qt translations for locale "
202 << fromqstr(language_name));
205 // This allows to translate the strings that appear in the LyX menu.
208 connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
210 using namespace lyx::graphics;
212 Image::newImage = boost::bind(&GuiImage::newImage);
213 Image::loadableFormats = boost::bind(&GuiImage::loadableFormats);
215 // needs to be done before reading lyxrc
217 lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
221 // Set the cache to 5120 kilobytes which corresponds to screen size of
222 // 1280 by 1024 pixels with a color depth of 32 bits.
223 QPixmapCache::setCacheLimit(5120);
225 // Initialize RC Fonts
226 if (lyxrc.roman_font_name.empty())
227 lyxrc.roman_font_name = fromqstr(romanFontName());
229 if (lyxrc.sans_font_name.empty())
230 lyxrc.sans_font_name = fromqstr(sansFontName());
232 if (lyxrc.typewriter_font_name.empty())
233 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
235 general_timer_.setInterval(500);
236 connect(&general_timer_, SIGNAL(timeout()),
237 this, SLOT(handleRegularEvents()));
238 general_timer_.start();
241 if (global_menubar_ == 0) {
242 // Create the global default menubar which is shown for the dialogs
243 // and if no GuiView is visible.
244 global_menubar_ = new GlobalMenuBar();
250 GuiApplication::~GuiApplication()
252 socket_notifiers_.clear();
256 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd)
263 case LFUN_WINDOW_CLOSE:
264 enable = view_ids_.size() > 0;
268 if (!current_view_) {
281 bool GuiApplication::dispatch(FuncRequest const & cmd)
285 case LFUN_WINDOW_NEW:
286 createView(toqstr(cmd.argument()));
289 case LFUN_WINDOW_CLOSE:
290 // update bookmark pit of the current buffer before window close
291 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
292 theLyXFunc().gotoBookmark(i+1, false, false);
293 current_view_->close();
297 // quitting is triggered by the gui code
298 // (leaving the event loop).
299 current_view_->message(from_utf8(N_("Exiting.")));
304 case LFUN_SCREEN_FONT_UPDATE: {
305 // handle the screen font changes.
306 font_loader_.update();
307 // Backup current_view_
308 GuiView * view = current_view_;
309 // Set current_view_ to zero to forbid GuiWorkArea::redraw()
310 // to skip the refresh.
312 BufferList::iterator it = theBufferList().begin();
313 BufferList::iterator const end = theBufferList().end();
314 for (; it != end; ++it)
316 // Restore current_view_
317 current_view_ = view;
321 case LFUN_BUFFER_NEW:
323 || (!lyxrc.open_buffers_in_tabs && current_view_->buffer() != 0))
325 current_view_->newDocument(to_utf8(cmd.argument()), false);
328 case LFUN_BUFFER_NEW_TEMPLATE:
330 || (!lyxrc.open_buffers_in_tabs && current_view_->buffer() != 0)) {
332 current_view_->newDocument(to_utf8(cmd.argument()), true);
333 if (!current_view_->buffer())
334 current_view_->close();
336 current_view_->newDocument(to_utf8(cmd.argument()), true);
341 || (!lyxrc.open_buffers_in_tabs && current_view_->buffer() != 0)) {
343 current_view_->openDocument(to_utf8(cmd.argument()));
344 if (!current_view_->buffer())
345 current_view_->close();
347 current_view_->openDocument(to_utf8(cmd.argument()));
351 // Notify the caller that the action has not been dispatched.
355 // The action has been dispatched.
360 void GuiApplication::resetGui()
362 map<int, GuiView *>::iterator it;
363 for (it = views_.begin(); it != views_.end(); ++it)
364 it->second->resetDialogs();
366 dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
370 static void updateIds(map<int, GuiView *> const & stdmap, vector<int> & ids)
373 map<int, GuiView *>::const_iterator it;
374 for (it = stdmap.begin(); it != stdmap.end(); ++it)
375 ids.push_back(it->first);
379 void GuiApplication::createView(QString const & geometry_arg)
381 // release the keyboard which might have been grabed by the global
382 // menubar on Mac to catch shortcuts even without any GuiView.
384 global_menubar_->releaseKeyboard();
387 updateIds(views_, view_ids_);
389 while (views_.find(id) != views_.end())
391 GuiView * view = new GuiView(id);
393 // copy the icon size from old view
395 view->setIconSize(current_view_->iconSize());
399 updateIds(views_, view_ids_);
402 if (!geometry_arg.isEmpty()) {
406 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)([+-][0-9]*)){0,1}" );
407 re.indexIn(geometry_arg);
408 w = re.cap(1).toInt();
409 h = re.cap(2).toInt();
410 x = re.cap(3).toInt();
411 y = re.cap(4).toInt();
412 view->setGeometry(x, y, w, h);
416 setActiveWindow(view);
417 setCurrentView(*view);
423 Clipboard & GuiApplication::clipboard()
429 Selection & GuiApplication::selection()
435 int GuiApplication::exec()
437 QTimer::singleShot(1, this, SLOT(execBatchCommands()));
438 return QApplication::exec();
442 void GuiApplication::exit(int status)
444 QApplication::exit(status);
448 void GuiApplication::execBatchCommands()
450 LyX::ref().execBatchCommands();
454 void GuiApplication::restoreGuiSession()
456 if (!lyxrc.load_session)
459 Session & session = LyX::ref().session();
460 vector<FileName> const & lastopened = session.lastOpened().getfiles();
461 // do not add to the lastfile list since these files are restored from
462 // last session, and should be already there (regular files), or should
463 // not be added at all (help files).
464 for_each(lastopened.begin(), lastopened.end(),
465 bind(&GuiView::loadDocument, current_view_, _1, false));
467 // clear this list to save a few bytes of RAM
468 session.lastOpened().clear();
472 QString const GuiApplication::romanFontName()
475 font.setKerning(false);
476 font.setStyleHint(QFont::Serif);
477 font.setFamily("serif");
479 return QFontInfo(font).family();
483 QString const GuiApplication::sansFontName()
486 font.setKerning(false);
487 font.setStyleHint(QFont::SansSerif);
488 font.setFamily("sans");
490 return QFontInfo(font).family();
494 QString const GuiApplication::typewriterFontName()
497 font.setKerning(false);
498 font.setStyleHint(QFont::TypeWriter);
499 font.setFamily("monospace");
501 return QFontInfo(font).family();
505 void GuiApplication::handleRegularEvents()
507 ForkedCallsController::handleCompletedProcesses();
511 bool GuiApplication::event(QEvent * e)
514 case QEvent::FileOpen: {
515 // Open a file; this happens only on Mac OS X for now
516 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
518 if (!current_view_ || !current_view_->view())
519 // The application is not properly initialized yet.
520 // So we acknowledge the event and delay the file opening
521 // until LyX is ready.
522 // FIXME UNICODE: FileName accept an utf8 encoded string.
523 LyX::ref().addFileToLoad(fromqstr(foe->file()));
525 lyx::dispatch(FuncRequest(LFUN_FILE_OPEN,
526 qstring_to_ucs4(foe->file())));
532 return QApplication::event(e);
537 bool GuiApplication::notify(QObject * receiver, QEvent * event)
540 return QApplication::notify(receiver, event);
542 catch (ExceptionMessage const & e) {
545 LyX::cref().emergencyCleanup();
546 setQuitOnLastWindowClosed(false);
548 Alert::error(e.title_, e.details_);
550 // Properly crash in debug mode in order to get a useful backtrace.
553 // In release mode, try to exit gracefully.
556 case BufferException: {
557 Buffer * buf = current_view_->buffer();
558 docstring details = e.details_ + '\n';
559 details += theBufferList().emergencyWrite(buf);
560 theBufferList().release(buf);
561 details += _("\nThe current document was closed.");
562 Alert::error(e.title_, details);
565 case WarningException:
566 Alert::warning(e.title_, e.details_);
570 catch (exception const & e) {
571 docstring s = _("LyX has caught an exception, it will now "
572 "attempt to save all unsaved documents and exit."
574 s += from_ascii(e.what());
575 Alert::error(_("Software exception Detected"), s);
579 docstring s = _("LyX has caught some really weird exception, it will "
580 "now attempt to save all unsaved documents and exit.");
581 Alert::error(_("Software exception Detected"), s);
589 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
591 QColor const & qcol = color_cache_.get(col);
592 if (!qcol.isValid()) {
598 rgbcol.r = qcol.red();
599 rgbcol.g = qcol.green();
600 rgbcol.b = qcol.blue();
605 string const GuiApplication::hexName(ColorCode col)
607 return ltrim(fromqstr(color_cache_.get(col).name()), "#");
611 void GuiApplication::updateColor(ColorCode)
613 // FIXME: Bleh, can't we just clear them all at once ?
614 color_cache_.clear();
618 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
620 SocketNotifier * sn = new SocketNotifier(this, fd, func);
621 socket_notifiers_[fd] = sn;
622 connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
626 void GuiApplication::socketDataReceived(int fd)
628 socket_notifiers_[fd]->func_();
632 void GuiApplication::unregisterSocketCallback(int fd)
634 socket_notifiers_.erase(fd);
638 void GuiApplication::commitData(QSessionManager & sm)
640 /// The implementation is required to avoid an application exit
641 /// when session state save is triggered by session manager.
642 /// The default implementation sends a close event to all
643 /// visible top level widgets when session managment allows
645 /// We are changing that to close all wiew one by one.
646 /// FIXME: verify if the default implementation is enough now.
647 if (sm.allowsInteraction() && !closeAllViews())
652 void GuiApplication::addMenuTranslator()
654 installTranslator(new MenuTranslator(this));
658 bool GuiApplication::unregisterView(int id)
660 updateIds(views_, view_ids_);
661 BOOST_ASSERT(views_.find(id) != views_.end());
662 BOOST_ASSERT(views_[id]);
664 map<int, GuiView *>::iterator it;
665 for (it = views_.begin(); it != views_.end(); ++it) {
666 if (it->first == id) {
671 updateIds(views_, view_ids_);
676 bool GuiApplication::closeAllViews()
678 updateIds(views_, view_ids_);
682 map<int, GuiView*> const cmap = views_;
683 map<int, GuiView*>::const_iterator it;
684 for (it = cmap.begin(); it != cmap.end(); ++it) {
685 if (!it->second->close())
695 GuiView & GuiApplication::view(int id) const
697 BOOST_ASSERT(views_.find(id) != views_.end());
698 return *views_.find(id)->second;
702 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
704 vector<int>::const_iterator it = view_ids_.begin();
705 vector<int>::const_iterator const end = view_ids_.end();
706 for (; it != end; ++it)
707 view(*it).hideDialog(name, inset);
711 Buffer const * GuiApplication::updateInset(Inset const * inset) const
713 Buffer const * buffer_ = 0;
714 vector<int>::const_iterator it = view_ids_.begin();
715 vector<int>::const_iterator const end = view_ids_.end();
716 for (; it != end; ++it) {
717 Buffer const * ptr = view(*it).updateInset(inset);
725 void GuiApplication::readMenus(Lexer & lex)
731 bool GuiApplication::searchMenu(FuncRequest const & func,
732 vector<docstring> & names) const
734 return menus().searchMenu(func, names);
738 void GuiApplication::initGlobalMenu()
741 menus().fillMenuBar(global_menubar_, 0);
745 void GuiApplication::onLastWindowClosed()
748 global_menubar_->grabKeyboard();
751 ////////////////////////////////////////////////////////////////////////
752 // X11 specific stuff goes here...
754 bool GuiApplication::x11EventFilter(XEvent * xev)
760 case SelectionRequest: {
761 if (xev->xselectionrequest.selection != XA_PRIMARY)
763 LYXERR(Debug::GUI, "X requested selection.");
764 BufferView * bv = current_view_->view();
766 docstring const sel = bv->requestSelection();
772 case SelectionClear: {
773 if (xev->xselectionclear.selection != XA_PRIMARY)
775 LYXERR(Debug::GUI, "Lost selection.");
776 BufferView * bv = current_view_->view();
778 bv->clearSelection();
786 } // namespace frontend
789 ////////////////////////////////////////////////////////////////////
793 ////////////////////////////////////////////////////////////////////
795 frontend::FontLoader & theFontLoader()
797 BOOST_ASSERT(frontend::guiApp);
798 return frontend::guiApp->fontLoader();
802 frontend::FontMetrics const & theFontMetrics(Font const & f)
804 return theFontMetrics(f.fontInfo());
808 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
810 BOOST_ASSERT(frontend::guiApp);
811 return frontend::guiApp->fontLoader().metrics(f);
815 frontend::Clipboard & theClipboard()
817 BOOST_ASSERT(frontend::guiApp);
818 return frontend::guiApp->clipboard();
822 frontend::Selection & theSelection()
824 BOOST_ASSERT(frontend::guiApp);
825 return frontend::guiApp->selection();
830 #include "GuiApplication_moc.cpp"