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, at least on Windows and
165 // X11 platforms. We should have a lyxrc setting for this in order to let the
166 // application stay resident.
168 if (lyxrc.quit_on_last_window_closed)
169 setQuitOnLastWindowClosed(false);
172 setQuitOnLastWindowClosed(false);
176 // doubleClickInterval() is 400 ms on X11 which is just too long.
177 // On Windows and Mac OS X, the operating system's value is used.
178 // On Microsoft Windows, calling this function sets the double
179 // click interval for all applications. So we don't!
180 QApplication::setDoubleClickInterval(300);
183 // install translation file for Qt built-in dialogs
184 QString language_name = QString("qt_") + QLocale::system().name();
186 // language_name can be short (e.g. qt_zh) or long (e.g. qt_zh_CN).
187 // Short-named translator can be loaded from a long name, but not the
188 // opposite. Therefore, long name should be used without truncation.
189 // c.f. http://doc.trolltech.com/4.1/qtranslator.html#load
190 if (qt_trans_.load(language_name,
191 QLibraryInfo::location(QLibraryInfo::TranslationsPath)))
193 installTranslator(&qt_trans_);
194 // even if the language calls for RtL, don't do that
195 setLayoutDirection(Qt::LeftToRight);
196 LYXERR(Debug::GUI, "Successfully installed Qt translations for locale "
197 << fromqstr(language_name));
199 LYXERR(Debug::GUI, "Could not find Qt translations for locale "
200 << fromqstr(language_name));
203 // This allows to translate the strings that appear in the LyX menu.
206 connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
208 using namespace lyx::graphics;
210 Image::newImage = boost::bind(&GuiImage::newImage);
211 Image::loadableFormats = boost::bind(&GuiImage::loadableFormats);
213 // needs to be done before reading lyxrc
215 lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
219 // Set the cache to 5120 kilobytes which corresponds to screen size of
220 // 1280 by 1024 pixels with a color depth of 32 bits.
221 QPixmapCache::setCacheLimit(5120);
223 // Initialize RC Fonts
224 if (lyxrc.roman_font_name.empty())
225 lyxrc.roman_font_name = fromqstr(romanFontName());
227 if (lyxrc.sans_font_name.empty())
228 lyxrc.sans_font_name = fromqstr(sansFontName());
230 if (lyxrc.typewriter_font_name.empty())
231 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
233 general_timer_.setInterval(500);
234 connect(&general_timer_, SIGNAL(timeout()),
235 this, SLOT(handleRegularEvents()));
236 general_timer_.start();
239 if (global_menubar_ == 0) {
240 // Create the global default menubar which is shown for the dialogs
241 // and if no GuiView is visible.
242 global_menubar_ = new GlobalMenuBar();
248 GuiApplication::~GuiApplication()
250 socket_notifiers_.clear();
254 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd)
261 case LFUN_WINDOW_CLOSE:
262 enable = view_ids_.size() > 0;
266 if (!current_view_) {
279 bool GuiApplication::dispatch(FuncRequest const & cmd)
283 case LFUN_WINDOW_NEW:
284 createView(toqstr(cmd.argument()));
287 case LFUN_WINDOW_CLOSE:
288 // update bookmark pit of the current buffer before window close
289 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
290 theLyXFunc().gotoBookmark(i+1, false, false);
291 current_view_->close();
295 // quitting is triggered by the gui code
296 // (leaving the event loop).
297 current_view_->message(from_utf8(N_("Exiting.")));
302 case LFUN_SCREEN_FONT_UPDATE: {
303 // handle the screen font changes.
304 font_loader_.update();
305 // Backup current_view_
306 GuiView * view = current_view_;
307 // Set current_view_ to zero to forbid GuiWorkArea::redraw()
308 // to skip the refresh.
310 BufferList::iterator it = theBufferList().begin();
311 BufferList::iterator const end = theBufferList().end();
312 for (; it != end; ++it)
314 // Restore current_view_
315 current_view_ = view;
319 case LFUN_BUFFER_NEW:
321 || (!lyxrc.single_window && current_view_->buffer() != 0))
323 current_view_->newDocument(to_utf8(cmd.argument()), false);
326 case LFUN_BUFFER_NEW_TEMPLATE:
328 || (!lyxrc.single_window && current_view_->buffer() != 0)) {
330 current_view_->newDocument(to_utf8(cmd.argument()), true);
331 if (!current_view_->buffer())
332 current_view_->close();
334 current_view_->newDocument(to_utf8(cmd.argument()), true);
339 || (!lyxrc.single_window && current_view_->buffer() != 0)) {
341 current_view_->openDocument(to_utf8(cmd.argument()));
342 if (!current_view_->buffer())
343 current_view_->close();
345 current_view_->openDocument(to_utf8(cmd.argument()));
349 // Notify the caller that the action has not been dispatched.
353 // The action has been dispatched.
358 void GuiApplication::resetGui()
360 map<int, GuiView *>::iterator it;
361 for (it = views_.begin(); it != views_.end(); ++it)
362 it->second->resetDialogs();
364 dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
368 static void updateIds(map<int, GuiView *> const & stdmap, vector<int> & ids)
371 map<int, GuiView *>::const_iterator it;
372 for (it = stdmap.begin(); it != stdmap.end(); ++it)
373 ids.push_back(it->first);
377 void GuiApplication::createView(QString const & geometry_arg)
380 updateIds(views_, view_ids_);
382 while (views_.find(id) != views_.end())
384 GuiView * view = new GuiView(id);
386 // copy the icon size from old view
388 view->setIconSize(current_view_->iconSize());
392 updateIds(views_, view_ids_);
394 theLyXFunc().setLyXView(view);
396 if (!geometry_arg.isEmpty()) {
400 QRegExp re( "[=]*(?:([0-9]+)[xX]([0-9]+)){0,1}[ ]*(?:([+-][0-9]*)([+-][0-9]*)){0,1}" );
401 re.indexIn(geometry_arg);
402 w = re.cap(1).toInt();
403 h = re.cap(2).toInt();
404 x = re.cap(3).toInt();
405 y = re.cap(4).toInt();
406 view->setGeometry(x, y, w, h);
410 setActiveWindow(view);
411 setCurrentView(*view);
417 Clipboard & GuiApplication::clipboard()
423 Selection & GuiApplication::selection()
429 int GuiApplication::exec()
431 QTimer::singleShot(1, this, SLOT(execBatchCommands()));
432 return QApplication::exec();
436 void GuiApplication::exit(int status)
438 QApplication::exit(status);
442 void GuiApplication::execBatchCommands()
444 LyX::ref().execBatchCommands();
448 void GuiApplication::restoreGuiSession()
450 if (!lyxrc.load_session)
453 Session & session = LyX::ref().session();
454 vector<FileName> const & lastopened = session.lastOpened().getfiles();
455 // do not add to the lastfile list since these files are restored from
456 // last session, and should be already there (regular files), or should
457 // not be added at all (help files).
458 for_each(lastopened.begin(), lastopened.end(),
459 bind(&GuiView::loadDocument, current_view_, _1, false));
461 // clear this list to save a few bytes of RAM
462 session.lastOpened().clear();
466 QString const GuiApplication::romanFontName()
469 font.setKerning(false);
470 font.setStyleHint(QFont::Serif);
471 font.setFamily("serif");
473 return QFontInfo(font).family();
477 QString const GuiApplication::sansFontName()
480 font.setKerning(false);
481 font.setStyleHint(QFont::SansSerif);
482 font.setFamily("sans");
484 return QFontInfo(font).family();
488 QString const GuiApplication::typewriterFontName()
491 font.setKerning(false);
492 font.setStyleHint(QFont::TypeWriter);
493 font.setFamily("monospace");
495 return QFontInfo(font).family();
499 void GuiApplication::handleRegularEvents()
501 ForkedCallsController::handleCompletedProcesses();
505 bool GuiApplication::event(QEvent * e)
508 case QEvent::FileOpen: {
509 // Open a file; this happens only on Mac OS X for now
510 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
512 if (!current_view_ || !current_view_->view())
513 // The application is not properly initialized yet.
514 // So we acknowledge the event and delay the file opening
515 // until LyX is ready.
516 // FIXME UNICODE: FileName accept an utf8 encoded string.
517 LyX::ref().addFileToLoad(fromqstr(foe->file()));
519 lyx::dispatch(FuncRequest(LFUN_FILE_OPEN,
520 qstring_to_ucs4(foe->file())));
526 return QApplication::event(e);
531 bool GuiApplication::notify(QObject * receiver, QEvent * event)
534 return QApplication::notify(receiver, event);
536 catch (ExceptionMessage const & e) {
539 LyX::cref().emergencyCleanup();
540 setQuitOnLastWindowClosed(false);
542 Alert::error(e.title_, e.details_);
544 // Properly crash in debug mode in order to get a useful backtrace.
547 // In release mode, try to exit gracefully.
550 case BufferException: {
551 Buffer * buf = current_view_->buffer();
552 docstring details = e.details_ + '\n';
553 details += theBufferList().emergencyWrite(buf);
554 theBufferList().release(buf);
555 details += _("\nThe current document was closed.");
556 Alert::error(e.title_, details);
559 case WarningException:
560 Alert::warning(e.title_, e.details_);
564 catch (exception const & e) {
565 docstring s = _("LyX has caught an exception, it will now "
566 "attempt to save all unsaved documents and exit."
568 s += from_ascii(e.what());
569 Alert::error(_("Software exception Detected"), s);
573 docstring s = _("LyX has caught some really weird exception, it will "
574 "now attempt to save all unsaved documents and exit.");
575 Alert::error(_("Software exception Detected"), s);
583 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
585 QColor const & qcol = color_cache_.get(col);
586 if (!qcol.isValid()) {
592 rgbcol.r = qcol.red();
593 rgbcol.g = qcol.green();
594 rgbcol.b = qcol.blue();
599 string const GuiApplication::hexName(ColorCode col)
601 return ltrim(fromqstr(color_cache_.get(col).name()), "#");
605 void GuiApplication::updateColor(ColorCode)
607 // FIXME: Bleh, can't we just clear them all at once ?
608 color_cache_.clear();
612 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
614 SocketNotifier * sn = new SocketNotifier(this, fd, func);
615 socket_notifiers_[fd] = sn;
616 connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
620 void GuiApplication::socketDataReceived(int fd)
622 socket_notifiers_[fd]->func_();
626 void GuiApplication::unregisterSocketCallback(int fd)
628 socket_notifiers_.erase(fd);
632 void GuiApplication::commitData(QSessionManager & sm)
634 /// The implementation is required to avoid an application exit
635 /// when session state save is triggered by session manager.
636 /// The default implementation sends a close event to all
637 /// visible top level widgets when session managment allows
639 /// We are changing that to close all wiew one by one.
640 /// FIXME: verify if the default implementation is enough now.
641 if (sm.allowsInteraction() && !closeAllViews())
646 void GuiApplication::addMenuTranslator()
648 installTranslator(new MenuTranslator(this));
652 bool GuiApplication::unregisterView(int id)
654 updateIds(views_, view_ids_);
655 BOOST_ASSERT(views_.find(id) != views_.end());
656 BOOST_ASSERT(views_[id]);
658 map<int, GuiView *>::iterator it;
659 for (it = views_.begin(); it != views_.end(); ++it) {
660 if (it->first == id) {
665 updateIds(views_, view_ids_);
670 bool GuiApplication::closeAllViews()
672 updateIds(views_, view_ids_);
676 map<int, GuiView*> const cmap = views_;
677 map<int, GuiView*>::const_iterator it;
678 for (it = cmap.begin(); it != cmap.end(); ++it) {
679 if (!it->second->close())
689 GuiView & GuiApplication::view(int id) const
691 BOOST_ASSERT(views_.find(id) != views_.end());
692 return *views_.find(id)->second;
696 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
698 vector<int>::const_iterator it = view_ids_.begin();
699 vector<int>::const_iterator const end = view_ids_.end();
700 for (; it != end; ++it)
701 view(*it).hideDialog(name, inset);
705 Buffer const * GuiApplication::updateInset(Inset const * inset) const
707 Buffer const * buffer_ = 0;
708 vector<int>::const_iterator it = view_ids_.begin();
709 vector<int>::const_iterator const end = view_ids_.end();
710 for (; it != end; ++it) {
711 Buffer const * ptr = view(*it).updateInset(inset);
719 void GuiApplication::readMenus(Lexer & lex)
725 bool GuiApplication::searchMenu(FuncRequest const & func,
726 vector<docstring> & names) const
728 return menus().searchMenu(func, names);
732 void GuiApplication::initGlobalMenu()
735 menus().fillMenuBar(global_menubar_, 0);
739 void GuiApplication::onLastWindowClosed()
742 global_menubar_->grabKeyboard();
745 ////////////////////////////////////////////////////////////////////////
746 // X11 specific stuff goes here...
748 bool GuiApplication::x11EventFilter(XEvent * xev)
754 case SelectionRequest: {
755 if (xev->xselectionrequest.selection != XA_PRIMARY)
757 LYXERR(Debug::GUI, "X requested selection.");
758 BufferView * bv = current_view_->view();
760 docstring const sel = bv->requestSelection();
766 case SelectionClear: {
767 if (xev->xselectionclear.selection != XA_PRIMARY)
769 LYXERR(Debug::GUI, "Lost selection.");
770 BufferView * bv = current_view_->view();
772 bv->clearSelection();
780 } // namespace frontend
783 ////////////////////////////////////////////////////////////////////
787 ////////////////////////////////////////////////////////////////////
789 frontend::FontLoader & theFontLoader()
791 BOOST_ASSERT(frontend::guiApp);
792 return frontend::guiApp->fontLoader();
796 frontend::FontMetrics const & theFontMetrics(Font const & f)
798 return theFontMetrics(f.fontInfo());
802 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
804 BOOST_ASSERT(frontend::guiApp);
805 return frontend::guiApp->fontLoader().metrics(f);
809 frontend::Clipboard & theClipboard()
811 BOOST_ASSERT(frontend::guiApp);
812 return frontend::guiApp->clipboard();
816 frontend::Selection & theSelection()
818 BOOST_ASSERT(frontend::guiApp);
819 return frontend::guiApp->selection();
824 #include "GuiApplication_moc.cpp"