]> git.lyx.org Git - lyx.git/blob - src/frontends/qt4/GuiApplication.cpp
b3ba440f41beaea0864fbe553f20d1e3322b0f84
[lyx.git] / src / frontends / qt4 / GuiApplication.cpp
1 /**
2  * \file GuiApplication.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author unknown
7  * \author John Levon
8  * \author Abdelrazak Younes
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 #include <config.h>
14
15 #include "GuiApplication.h"
16
17 #include "qt_helpers.h"
18 #include "GuiImage.h"
19 #include "GuiKeySymbol.h"
20 #include "GuiView.h"
21
22 #include "frontends/alert.h"
23 #include "frontends/Application.h"
24 #include "frontends/FontLoader.h"
25 #include "frontends/FontMetrics.h"
26
27 #include "Buffer.h"
28 #include "BufferList.h"
29 #include "BufferView.h"
30 #include "Font.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
33 #include "LyX.h"
34 #include "LyXFunc.h"
35 #include "LyXRC.h"
36 #include "Session.h"
37 #include "version.h"
38
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"
47
48 #include <QApplication>
49 #include <QClipboard>
50 #include <QEventLoop>
51 #include <QFileOpenEvent>
52 #include <QLocale>
53 #include <QLibraryInfo>
54 #include <QMenuBar>
55 #include <QPixmapCache>
56 #include <QRegExp>
57 #include <QSessionManager>
58 #include <QSocketNotifier>
59 #include <QTextCodec>
60 #include <QTimer>
61 #include <QTranslator>
62 #include <QWidget>
63
64 #ifdef Q_WS_X11
65 #include <X11/Xatom.h>
66 #include <X11/Xlib.h>
67 #undef CursorShape
68 #undef None
69 #endif
70
71 #include <boost/bind.hpp>
72
73 #include <exception>
74
75 using namespace std;
76 using namespace lyx::support;
77
78 namespace lyx {
79
80 frontend::Application * createApplication(int & argc, char * argv[])
81 {
82         return new frontend::GuiApplication(argc, argv);
83 }
84
85
86 namespace frontend {
87
88 class SocketNotifier : public QSocketNotifier
89 {
90 public:
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)
94         {}
95
96 public:
97         /// The callback function
98         Application::SocketCallback func_;
99 };
100
101
102 ////////////////////////////////////////////////////////////////////////
103 // Mac specific stuff goes here...
104
105 class MenuTranslator : public QTranslator
106 {
107 public:
108         MenuTranslator(QObject * parent)
109                 : QTranslator(parent)
110         {}
111
112         QString translate(const char * /*context*/, 
113           const char * sourceText, 
114           const char * /*comment*/ = 0) 
115         {
116                 string const s = sourceText;
117                 if (s == N_("About %1") || s == N_("Preferences") 
118                                 || s == N_("Reconfigure") || s == N_("Quit %1"))
119                         return qt_(s);
120                 else 
121                         return QString();
122         }
123 };
124
125 class GlobalMenuBar : public QMenuBar
126 {
127 public:
128         ///
129         GlobalMenuBar() : QMenuBar(0) {}
130         
131         ///
132         bool event(QEvent * e)
133         {
134                 if (e->type() == QEvent::ShortcutOverride) {
135                         //          && activeWindow() == 0) {
136                         QKeyEvent * ke = static_cast<QKeyEvent*>(e);
137                         KeySymbol sym;
138                         setKeySymbol(&sym, ke);
139                         theLyXFunc().processKeySym(sym, q_key_state(ke->modifiers()));
140                         e->accept();
141                         return true;
142                 }
143                 return false;
144         }
145 };
146
147 ///////////////////////////////////////////////////////////////
148 // You can find more platform specific stuff
149 // at the end of this file...
150 ///////////////////////////////////////////////////////////////
151
152
153 GuiApplication * guiApp;
154
155
156 GuiApplication::GuiApplication(int & argc, char ** argv)
157         : QApplication(argc, argv), Application(), current_view_(0), global_menubar_(0)
158 {
159         QString app_name = "LyX";
160         QCoreApplication::setOrganizationName(app_name);
161         QCoreApplication::setOrganizationDomain("lyx.org");
162         QCoreApplication::setApplicationName(app_name + "-" + lyx_version);
163
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.
167         /*
168         if (lyxrc.quit_on_last_window_closed)
169                 setQuitOnLastWindowClosed(false);
170         */
171 #ifdef Q_WS_MAC
172         setQuitOnLastWindowClosed(false);
173 #endif
174         
175 #ifdef Q_WS_X11
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);
181 #endif
182
183         // install translation file for Qt built-in dialogs
184         QString language_name = QString("qt_") + QLocale::system().name();
185         
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)))
192         {
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));
198         } else
199                 LYXERR(Debug::GUI, "Could not find  Qt translations for locale "
200                         << fromqstr(language_name));
201
202 #ifdef Q_WS_MACX
203         // This allows to translate the strings that appear in the LyX menu.
204         addMenuTranslator();
205 #endif
206         connect(this, SIGNAL(lastWindowClosed()), this, SLOT(onLastWindowClosed()));
207
208         using namespace lyx::graphics;
209
210         Image::newImage = boost::bind(&GuiImage::newImage);
211         Image::loadableFormats = boost::bind(&GuiImage::loadableFormats);
212
213         // needs to be done before reading lyxrc
214         QWidget w;
215         lyxrc.dpi = (w.logicalDpiX() + w.logicalDpiY()) / 2;
216
217         guiApp = this;
218
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);
222
223         // Initialize RC Fonts
224         if (lyxrc.roman_font_name.empty())
225                 lyxrc.roman_font_name = fromqstr(romanFontName());
226
227         if (lyxrc.sans_font_name.empty())
228                 lyxrc.sans_font_name = fromqstr(sansFontName());
229
230         if (lyxrc.typewriter_font_name.empty())
231                 lyxrc.typewriter_font_name = fromqstr(typewriterFontName());
232
233         general_timer_.setInterval(500);
234         connect(&general_timer_, SIGNAL(timeout()),
235                 this, SLOT(handleRegularEvents()));
236         general_timer_.start();
237         
238 #ifdef Q_WS_MACX
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();
243         }
244 #endif  
245 }
246
247
248 GuiApplication::~GuiApplication()
249 {
250         socket_notifiers_.clear();
251 }
252
253
254 FuncStatus GuiApplication::getStatus(FuncRequest const & cmd)
255 {
256         FuncStatus flag;
257         bool enable = true;
258
259         switch(cmd.action) {
260
261         case LFUN_WINDOW_CLOSE:
262                 enable = view_ids_.size() > 0;
263                 break;
264
265         default:
266                 if (!current_view_) {
267                         enable = false;
268                         break;
269                 }
270         }
271
272         if (!enable)
273                 flag.enabled(false);
274
275         return flag;
276 }
277
278         
279 bool GuiApplication::dispatch(FuncRequest const & cmd)
280 {
281         switch(cmd.action) {
282
283         case LFUN_WINDOW_NEW:
284                 createView(toqstr(cmd.argument()));
285                 break;
286
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();
292                 break;
293
294         case LFUN_LYX_QUIT:
295                 // quitting is triggered by the gui code
296                 // (leaving the event loop).
297                 current_view_->message(from_utf8(N_("Exiting.")));
298                 if (closeAllViews())
299                         quit();
300                 break;
301
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.
309                 current_view_ = 0;
310                 BufferList::iterator it = theBufferList().begin();
311                 BufferList::iterator const end = theBufferList().end();
312                 for (; it != end; ++it)
313                         (*it)->changed();
314                 // Restore current_view_
315                 current_view_ = view;
316                 break;
317         }
318
319         case LFUN_BUFFER_NEW:
320                 if (viewCount() == 0
321                     || (!lyxrc.single_window && current_view_->buffer() != 0))
322                         createView();
323                 current_view_->newDocument(to_utf8(cmd.argument()), false);
324                 break;
325
326         case LFUN_BUFFER_NEW_TEMPLATE:
327                 if (viewCount() == 0 
328                     || (!lyxrc.single_window && current_view_->buffer() != 0)) {
329                         createView();
330                         current_view_->newDocument(to_utf8(cmd.argument()), true);
331                         if (!current_view_->buffer())
332                                 current_view_->close();
333                 } else
334                         current_view_->newDocument(to_utf8(cmd.argument()), true);
335                 break;
336
337         case LFUN_FILE_OPEN:
338                 if (viewCount() == 0
339                     || (!lyxrc.single_window && current_view_->buffer() != 0)) {
340                         createView();
341                         current_view_->openDocument(to_utf8(cmd.argument()));
342                         if (!current_view_->buffer())
343                                 current_view_->close();
344                 } else
345                         current_view_->openDocument(to_utf8(cmd.argument()));
346                 break;
347
348         default:
349                 // Notify the caller that the action has not been dispatched.
350                 return false;
351         }
352
353         // The action has been dispatched.
354         return true;
355 }
356
357
358 void GuiApplication::resetGui()
359 {
360         map<int, GuiView *>::iterator it;
361         for (it = views_.begin(); it != views_.end(); ++it)
362                 it->second->resetDialogs();
363
364         dispatch(FuncRequest(LFUN_SCREEN_FONT_UPDATE));
365 }
366
367
368 static void updateIds(map<int, GuiView *> const & stdmap, vector<int> & ids)
369 {
370         ids.clear();
371         map<int, GuiView *>::const_iterator it;
372         for (it = stdmap.begin(); it != stdmap.end(); ++it)
373                 ids.push_back(it->first);
374 }
375
376
377 void GuiApplication::createView(QString const & geometry_arg)
378 {
379         // create new view
380         updateIds(views_, view_ids_);
381         int id = 0;
382         while (views_.find(id) != views_.end())
383                 id++;
384         GuiView * view = new GuiView(id);
385         
386         // copy the icon size from old view
387         if (viewCount() > 0)
388                 view->setIconSize(current_view_->iconSize());
389
390         // register view
391         views_[id] = view;
392         updateIds(views_, view_ids_);
393         
394         theLyXFunc().setLyXView(view);
395         view->show();
396         if (!geometry_arg.isEmpty()) {
397 #ifdef Q_WS_WIN
398                 int x, y;
399                 int w, h;
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);
407 #endif
408         }
409         view->setFocus();
410         setActiveWindow(view);
411         setCurrentView(*view);
412 }
413
414
415
416
417 Clipboard & GuiApplication::clipboard()
418 {
419         return clipboard_;
420 }
421
422
423 Selection & GuiApplication::selection()
424 {
425         return selection_;
426 }
427
428
429 int GuiApplication::exec()
430 {
431         QTimer::singleShot(1, this, SLOT(execBatchCommands()));
432         return QApplication::exec();
433 }
434
435
436 void GuiApplication::exit(int status)
437 {
438         QApplication::exit(status);
439 }
440
441
442 void GuiApplication::execBatchCommands()
443 {
444         LyX::ref().execBatchCommands();
445 }
446
447
448 void GuiApplication::restoreGuiSession()
449 {
450         if (!lyxrc.load_session)
451                 return;
452
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));
460
461         // clear this list to save a few bytes of RAM
462         session.lastOpened().clear();
463 }
464
465
466 QString const GuiApplication::romanFontName()
467 {
468         QFont font;
469         font.setKerning(false);
470         font.setStyleHint(QFont::Serif);
471         font.setFamily("serif");
472
473         return QFontInfo(font).family();
474 }
475
476
477 QString const GuiApplication::sansFontName()
478 {
479         QFont font;
480         font.setKerning(false);
481         font.setStyleHint(QFont::SansSerif);
482         font.setFamily("sans");
483
484         return QFontInfo(font).family();
485 }
486
487
488 QString const GuiApplication::typewriterFontName()
489 {
490         QFont font;
491         font.setKerning(false);
492         font.setStyleHint(QFont::TypeWriter);
493         font.setFamily("monospace");
494
495         return QFontInfo(font).family();
496 }
497
498
499 void GuiApplication::handleRegularEvents()
500 {
501         ForkedCallsController::handleCompletedProcesses();
502 }
503
504
505 bool GuiApplication::event(QEvent * e)
506 {
507         switch(e->type()) {
508         case QEvent::FileOpen: {
509                 // Open a file; this happens only on Mac OS X for now
510                 QFileOpenEvent * foe = static_cast<QFileOpenEvent *>(e);
511
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()));
518                 else
519                         lyx::dispatch(FuncRequest(LFUN_FILE_OPEN,
520                                 qstring_to_ucs4(foe->file())));
521
522                 e->accept();
523                 return true;
524         }
525         default:
526                 return QApplication::event(e);
527         }
528 }
529
530
531 bool GuiApplication::notify(QObject * receiver, QEvent * event)
532 {
533         try {
534                 return QApplication::notify(receiver, event);
535         }
536         catch (ExceptionMessage const & e) {
537                 switch(e.type_) { 
538                 case ErrorException:
539                         LyX::cref().emergencyCleanup();
540                         setQuitOnLastWindowClosed(false);
541                         closeAllViews();
542                         Alert::error(e.title_, e.details_);
543 #ifndef NDEBUG
544                         // Properly crash in debug mode in order to get a useful backtrace.
545                         abort();
546 #endif
547                         // In release mode, try to exit gracefully.
548                         this->exit(1);
549
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);
557                         return false;
558                 }
559                 case WarningException:
560                         Alert::warning(e.title_, e.details_);
561                         return false;
562                 };
563         }
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."
567                         "\n\nException: ");
568                 s += from_ascii(e.what());
569                 Alert::error(_("Software exception Detected"), s);
570                 LyX::cref().exit(1);
571         }
572         catch (...) {
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);
576                 LyX::cref().exit(1);
577         }
578
579         return false;
580 }
581
582
583 bool GuiApplication::getRgbColor(ColorCode col, RGBColor & rgbcol)
584 {
585         QColor const & qcol = color_cache_.get(col);
586         if (!qcol.isValid()) {
587                 rgbcol.r = 0;
588                 rgbcol.g = 0;
589                 rgbcol.b = 0;
590                 return false;
591         }
592         rgbcol.r = qcol.red();
593         rgbcol.g = qcol.green();
594         rgbcol.b = qcol.blue();
595         return true;
596 }
597
598
599 string const GuiApplication::hexName(ColorCode col)
600 {
601         return ltrim(fromqstr(color_cache_.get(col).name()), "#");
602 }
603
604
605 void GuiApplication::updateColor(ColorCode)
606 {
607         // FIXME: Bleh, can't we just clear them all at once ?
608         color_cache_.clear();
609 }
610
611
612 void GuiApplication::registerSocketCallback(int fd, SocketCallback func)
613 {
614         SocketNotifier * sn = new SocketNotifier(this, fd, func);
615         socket_notifiers_[fd] = sn;
616         connect(sn, SIGNAL(activated(int)), this, SLOT(socketDataReceived(int)));
617 }
618
619
620 void GuiApplication::socketDataReceived(int fd)
621 {
622         socket_notifiers_[fd]->func_();
623 }
624
625
626 void GuiApplication::unregisterSocketCallback(int fd)
627 {
628         socket_notifiers_.erase(fd);
629 }
630
631
632 void GuiApplication::commitData(QSessionManager & sm)
633 {
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
638         /// interaction.
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())
642                 sm.cancel();
643 }
644
645
646 void GuiApplication::addMenuTranslator()
647 {
648         installTranslator(new MenuTranslator(this));
649 }
650
651
652 bool GuiApplication::unregisterView(int id)
653 {
654         updateIds(views_, view_ids_);
655         BOOST_ASSERT(views_.find(id) != views_.end());
656         BOOST_ASSERT(views_[id]);
657
658         map<int, GuiView *>::iterator it;
659         for (it = views_.begin(); it != views_.end(); ++it) {
660                 if (it->first == id) {
661                         views_.erase(id);
662                         break;
663                 }
664         }
665         updateIds(views_, view_ids_);
666         return true;
667 }
668
669
670 bool GuiApplication::closeAllViews()
671 {
672         updateIds(views_, view_ids_);
673         if (views_.empty())
674                 return true;
675
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())
680                         return false;
681         }
682
683         views_.clear();
684         view_ids_.clear();
685         return true;
686 }
687
688
689 GuiView & GuiApplication::view(int id) const
690 {
691         BOOST_ASSERT(views_.find(id) != views_.end());
692         return *views_.find(id)->second;
693 }
694
695
696 void GuiApplication::hideDialogs(string const & name, Inset * inset) const
697 {
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);
702 }
703
704
705 Buffer const * GuiApplication::updateInset(Inset const * inset) const
706 {
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);
712                 if (ptr)
713                         buffer_ = ptr;
714         }
715         return buffer_;
716 }
717
718
719 void GuiApplication::readMenus(Lexer & lex)
720 {
721         menus().read(lex);
722 }
723
724
725 bool GuiApplication::searchMenu(FuncRequest const & func,
726         vector<docstring> & names) const
727 {
728         return menus().searchMenu(func, names);
729 }
730
731
732 void GuiApplication::initGlobalMenu()
733 {
734         if (global_menubar_)
735                 menus().fillMenuBar(global_menubar_, 0);
736 }
737
738
739 void GuiApplication::onLastWindowClosed()
740 {
741         if (global_menubar_)
742                 global_menubar_->grabKeyboard();
743 }
744
745 ////////////////////////////////////////////////////////////////////////
746 // X11 specific stuff goes here...
747 #ifdef Q_WS_X11
748 bool GuiApplication::x11EventFilter(XEvent * xev)
749 {
750         if (!current_view_)
751                 return false;
752
753         switch (xev->type) {
754         case SelectionRequest: {
755                 if (xev->xselectionrequest.selection != XA_PRIMARY)
756                         break;
757                 LYXERR(Debug::GUI, "X requested selection.");
758                 BufferView * bv = current_view_->view();
759                 if (bv) {
760                         docstring const sel = bv->requestSelection();
761                         if (!sel.empty())
762                                 selection_.put(sel);
763                 }
764                 break;
765         }
766         case SelectionClear: {
767                 if (xev->xselectionclear.selection != XA_PRIMARY)
768                         break;
769                 LYXERR(Debug::GUI, "Lost selection.");
770                 BufferView * bv = current_view_->view();
771                 if (bv)
772                         bv->clearSelection();
773                 break;
774         }
775         }
776         return false;
777 }
778 #endif
779
780 } // namespace frontend
781
782
783 ////////////////////////////////////////////////////////////////////
784 //
785 // Font stuff
786 //
787 ////////////////////////////////////////////////////////////////////
788
789 frontend::FontLoader & theFontLoader()
790 {
791         BOOST_ASSERT(frontend::guiApp);
792         return frontend::guiApp->fontLoader();
793 }
794
795
796 frontend::FontMetrics const & theFontMetrics(Font const & f)
797 {
798         return theFontMetrics(f.fontInfo());
799 }
800
801
802 frontend::FontMetrics const & theFontMetrics(FontInfo const & f)
803 {
804         BOOST_ASSERT(frontend::guiApp);
805         return frontend::guiApp->fontLoader().metrics(f);
806 }
807
808
809 frontend::Clipboard & theClipboard()
810 {
811         BOOST_ASSERT(frontend::guiApp);
812         return frontend::guiApp->clipboard();
813 }
814
815
816 frontend::Selection & theSelection()
817 {
818         BOOST_ASSERT(frontend::guiApp);
819         return frontend::guiApp->selection();
820 }
821
822 } // namespace lyx
823
824 #include "GuiApplication_moc.cpp"