3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * \author Abdelrazak Younes
11 * Full author contact details are available in file CREDITS.
18 #include "DispatchResult.h"
19 #include "FileDialog.h"
20 #include "FontLoader.h"
21 #include "GuiApplication.h"
22 #include "GuiClickableLabel.h"
23 #include "GuiCommandBuffer.h"
24 #include "GuiCompleter.h"
25 #include "GuiKeySymbol.h"
27 #include "GuiToolbar.h"
28 #include "GuiWorkArea.h"
29 #include "GuiProgress.h"
30 #include "LayoutBox.h"
34 #include "qt_helpers.h"
35 #include "support/filetools.h"
37 #include "frontends/alert.h"
38 #include "frontends/KeySymbol.h"
40 #include "buffer_funcs.h"
42 #include "BufferList.h"
43 #include "BufferParams.h"
44 #include "BufferView.h"
46 #include "Converter.h"
48 #include "CutAndPaste.h"
50 #include "ErrorList.h"
52 #include "FuncStatus.h"
53 #include "FuncRequest.h"
57 #include "LayoutFile.h"
59 #include "LyXAction.h"
63 #include "Paragraph.h"
64 #include "SpellChecker.h"
67 #include "TextClass.h"
72 #include "support/convert.h"
73 #include "support/debug.h"
74 #include "support/ExceptionMessage.h"
75 #include "support/FileName.h"
76 #include "support/filetools.h"
77 #include "support/gettext.h"
78 #include "support/filetools.h"
79 #include "support/ForkedCalls.h"
80 #include "support/lassert.h"
81 #include "support/lstrings.h"
82 #include "support/os.h"
83 #include "support/Package.h"
84 #include "support/PathChanger.h"
85 #include "support/Systemcall.h"
86 #include "support/Timeout.h"
87 #include "support/ProgressInterface.h"
90 #include <QApplication>
91 #include <QCloseEvent>
93 #include <QDesktopWidget>
94 #include <QDragEnterEvent>
97 #include <QFutureWatcher>
107 #include <QPushButton>
108 #include <QScrollBar>
110 #include <QShowEvent>
112 #include <QStackedWidget>
113 #include <QStatusBar>
114 #include <QSvgRenderer>
115 #include <QtConcurrentRun>
123 // sync with GuiAlert.cpp
124 #define EXPORT_in_THREAD 1
127 #include "support/bind.h"
131 #ifdef HAVE_SYS_TIME_H
132 # include <sys/time.h>
140 using namespace lyx::support;
144 using support::addExtension;
145 using support::changeExtension;
146 using support::removeExtension;
152 class BackgroundWidget : public QWidget
155 BackgroundWidget(int width, int height)
156 : width_(width), height_(height)
158 LYXERR(Debug::GUI, "show banner: " << lyxrc.show_banner);
159 if (!lyxrc.show_banner)
161 /// The text to be written on top of the pixmap
162 QString const htext = qt_("The Document\nProcessor[[welcome banner]]");
163 QString const htextsize = qt_("1.0[[possibly scale the welcome banner text size]]");
164 /// The text to be written on top of the pixmap
165 QString const text = lyx_version ?
166 qt_("version ") + lyx_version : qt_("unknown version");
167 #if QT_VERSION >= 0x050000
168 QString imagedir = "images/";
169 FileName fname = imageLibFileSearch(imagedir, "banner", "svgz");
170 QSvgRenderer svgRenderer(toqstr(fname.absFileName()));
171 if (svgRenderer.isValid()) {
172 splash_ = QPixmap(splashSize());
173 QPainter painter(&splash_);
174 svgRenderer.render(&painter);
175 splash_.setDevicePixelRatio(pixelRatio());
177 splash_ = getPixmap("images/", "banner", "png");
180 splash_ = getPixmap("images/", "banner", "svgz,png");
183 QPainter pain(&splash_);
184 pain.setPen(QColor(0, 0, 0));
185 qreal const fsize = fontSize();
188 qreal locscale = htextsize.toFloat(&ok);
191 QPointF const position = textPosition(false);
192 QPointF const hposition = textPosition(true);
193 QRectF const hrect(hposition, splashSize());
195 "widget pixel ratio: " << pixelRatio() <<
196 " splash pixel ratio: " << splashPixelRatio() <<
197 " version text size,position: " << fsize << "@" << position.x() << "+" << position.y());
199 // The font used to display the version info
200 font.setStyleHint(QFont::SansSerif);
201 font.setWeight(QFont::Bold);
202 font.setPointSizeF(fsize);
204 pain.drawText(position, text);
205 // The font used to display the version info
206 font.setStyleHint(QFont::SansSerif);
207 font.setWeight(QFont::Normal);
208 font.setPointSizeF(hfsize);
209 // Check how long the logo gets with the current font
210 // and adapt if the font is running wider than what
212 QFontMetrics fm(font);
213 // Split the title into lines to measure the longest line
214 // in the current l7n.
215 QStringList titlesegs = htext.split('\n');
217 int hline = fm.height();
218 QStringList::const_iterator sit;
219 for (sit = titlesegs.constBegin(); sit != titlesegs.constEnd(); ++sit) {
220 if (fm.width(*sit) > wline)
221 wline = fm.width(*sit);
223 // The longest line in the reference font (for English)
224 // is 180. Calculate scale factor from that.
225 double const wscale = wline > 0 ? (180.0 / wline) : 1;
226 // Now do the same for the height (necessary for condensed fonts)
227 double const hscale = (34.0 / hline);
228 // take the lower of the two scale factors.
229 double const scale = min(wscale, hscale);
230 // Now rescale. Also consider l7n's offset factor.
231 font.setPointSizeF(hfsize * scale * locscale);
234 pain.drawText(hrect, Qt::AlignLeft, htext);
235 setFocusPolicy(Qt::StrongFocus);
238 void paintEvent(QPaintEvent *)
240 int const w = width_;
241 int const h = height_;
242 int const x = (width() - w) / 2;
243 int const y = (height() - h) / 2;
245 "widget pixel ratio: " << pixelRatio() <<
246 " splash pixel ratio: " << splashPixelRatio() <<
247 " paint pixmap: " << w << "x" << h << "@" << x << "+" << y);
249 pain.drawPixmap(x, y, w, h, splash_);
252 void keyPressEvent(QKeyEvent * ev)
255 setKeySymbol(&sym, ev);
257 guiApp->processKeySym(sym, q_key_state(ev->modifiers()));
269 /// Current ratio between physical pixels and device-independent pixels
270 double pixelRatio() const {
271 #if QT_VERSION >= 0x050000
272 return qt_scale_factor * devicePixelRatio();
278 qreal fontSize() const {
279 return toqstr(lyxrc.font_sizes[NORMAL_SIZE]).toDouble();
282 QPointF textPosition(bool const heading) const {
283 return heading ? QPointF(width_/2 - 18, height_/2 - 45)
284 : QPointF(width_/2 - 18, height_/2 + 45);
287 QSize splashSize() const {
289 static_cast<unsigned int>(width_ * pixelRatio()),
290 static_cast<unsigned int>(height_ * pixelRatio()));
293 /// Ratio between physical pixels and device-independent pixels of splash image
294 double splashPixelRatio() const {
295 #if QT_VERSION >= 0x050000
296 return splash_.devicePixelRatio();
304 /// Toolbar store providing access to individual toolbars by name.
305 typedef map<string, GuiToolbar *> ToolbarMap;
307 typedef shared_ptr<Dialog> DialogPtr;
312 class GuiView::GuiViewPrivate
315 GuiViewPrivate(GuiViewPrivate const &);
316 void operator=(GuiViewPrivate const &);
318 GuiViewPrivate(GuiView * gv)
319 : gv_(gv), current_work_area_(nullptr), current_main_work_area_(nullptr),
320 layout_(nullptr), autosave_timeout_(5000),
323 // hardcode here the platform specific icon size
324 smallIconSize = 16; // scaling problems
325 normalIconSize = 20; // ok, default if iconsize.png is missing
326 bigIconSize = 26; // better for some math icons
327 hugeIconSize = 32; // better for hires displays
330 // if it exists, use width of iconsize.png as normal size
331 QString const dir = toqstr(addPath("images", lyxrc.icon_set));
332 FileName const fn = lyx::libFileSearch(dir, "iconsize.png");
334 QImage image(toqstr(fn.absFileName()));
335 if (image.width() < int(smallIconSize))
336 normalIconSize = smallIconSize;
337 else if (image.width() > int(giantIconSize))
338 normalIconSize = giantIconSize;
340 normalIconSize = image.width();
343 splitter_ = new QSplitter;
344 bg_widget_ = new BackgroundWidget(400, 250);
345 stack_widget_ = new QStackedWidget;
346 stack_widget_->addWidget(bg_widget_);
347 stack_widget_->addWidget(splitter_);
350 // TODO cleanup, remove the singleton, handle multiple Windows?
351 progress_ = ProgressInterface::instance();
352 if (!dynamic_cast<GuiProgress*>(progress_)) {
353 progress_ = new GuiProgress; // TODO who deletes it
354 ProgressInterface::setInstance(progress_);
357 dynamic_cast<GuiProgress*>(progress_),
358 SIGNAL(updateStatusBarMessage(QString const&)),
359 gv, SLOT(updateStatusBarMessage(QString const&)));
361 dynamic_cast<GuiProgress*>(progress_),
362 SIGNAL(clearMessageText()),
363 gv, SLOT(clearMessageText()));
370 delete stack_widget_;
375 stack_widget_->setCurrentWidget(bg_widget_);
376 bg_widget_->setUpdatesEnabled(true);
377 bg_widget_->setFocus();
380 int tabWorkAreaCount()
382 return splitter_->count();
385 TabWorkArea * tabWorkArea(int i)
387 return dynamic_cast<TabWorkArea *>(splitter_->widget(i));
390 TabWorkArea * currentTabWorkArea()
392 int areas = tabWorkAreaCount();
394 // The first TabWorkArea is always the first one, if any.
395 return tabWorkArea(0);
397 for (int i = 0; i != areas; ++i) {
398 TabWorkArea * twa = tabWorkArea(i);
399 if (current_main_work_area_ == twa->currentWorkArea())
403 // None has the focus so we just take the first one.
404 return tabWorkArea(0);
407 int countWorkAreasOf(Buffer & buf)
409 int areas = tabWorkAreaCount();
411 for (int i = 0; i != areas; ++i) {
412 TabWorkArea * twa = tabWorkArea(i);
413 if (twa->workArea(buf))
419 void setPreviewFuture(QFuture<Buffer::ExportStatus> const & f)
421 if (processing_thread_watcher_.isRunning()) {
422 // we prefer to cancel this preview in order to keep a snappy
426 processing_thread_watcher_.setFuture(f);
429 QSize iconSize(docstring const & icon_size)
432 if (icon_size == "small")
433 size = smallIconSize;
434 else if (icon_size == "normal")
435 size = normalIconSize;
436 else if (icon_size == "big")
438 else if (icon_size == "huge")
440 else if (icon_size == "giant")
441 size = giantIconSize;
443 size = icon_size.empty() ? normalIconSize : convert<int>(icon_size);
445 if (size < smallIconSize)
446 size = smallIconSize;
448 return QSize(size, size);
451 QSize iconSize(QString const & icon_size)
453 return iconSize(qstring_to_ucs4(icon_size));
456 string & iconSize(QSize const & qsize)
458 LATTEST(qsize.width() == qsize.height());
460 static string icon_size;
462 unsigned int size = qsize.width();
464 if (size < smallIconSize)
465 size = smallIconSize;
467 if (size == smallIconSize)
469 else if (size == normalIconSize)
470 icon_size = "normal";
471 else if (size == bigIconSize)
473 else if (size == hugeIconSize)
475 else if (size == giantIconSize)
478 icon_size = convert<string>(size);
483 static Buffer::ExportStatus previewAndDestroy(Buffer const * orig,
484 Buffer * buffer, string const & format);
485 static Buffer::ExportStatus exportAndDestroy(Buffer const * orig,
486 Buffer * buffer, string const & format);
487 static Buffer::ExportStatus compileAndDestroy(Buffer const * orig,
488 Buffer * buffer, string const & format);
489 static docstring autosaveAndDestroy(Buffer const * orig, Buffer * buffer);
492 static Buffer::ExportStatus runAndDestroy(const T& func,
493 Buffer const * orig, Buffer * buffer, string const & format);
495 // TODO syncFunc/previewFunc: use bind
496 bool asyncBufferProcessing(string const & argument,
497 Buffer const * used_buffer,
498 docstring const & msg,
499 Buffer::ExportStatus (*asyncFunc)(Buffer const *, Buffer *, string const &),
500 Buffer::ExportStatus (Buffer::*syncFunc)(string const &, bool) const,
501 Buffer::ExportStatus (Buffer::*previewFunc)(string const &) const,
504 QVector<GuiWorkArea*> guiWorkAreas();
508 GuiWorkArea * current_work_area_;
509 GuiWorkArea * current_main_work_area_;
510 QSplitter * splitter_;
511 QStackedWidget * stack_widget_;
512 BackgroundWidget * bg_widget_;
514 ToolbarMap toolbars_;
515 ProgressInterface* progress_;
516 /// The main layout box.
518 * \warning Don't Delete! The layout box is actually owned by
519 * whichever toolbar contains it. All the GuiView class needs is a
520 * means of accessing it.
522 * FIXME: replace that with a proper model so that we are not limited
523 * to only one dialog.
528 map<string, DialogPtr> dialogs_;
531 QTimer statusbar_timer_;
532 /// auto-saving of buffers
533 Timeout autosave_timeout_;
536 TocModels toc_models_;
539 QFutureWatcher<docstring> autosave_watcher_;
540 QFutureWatcher<Buffer::ExportStatus> processing_thread_watcher_;
542 string last_export_format;
543 string processing_format;
545 static QSet<Buffer const *> busyBuffers;
547 unsigned int smallIconSize;
548 unsigned int normalIconSize;
549 unsigned int bigIconSize;
550 unsigned int hugeIconSize;
551 unsigned int giantIconSize;
553 /// flag against a race condition due to multiclicks, see bug #1119
557 QSet<Buffer const *> GuiView::GuiViewPrivate::busyBuffers;
560 GuiView::GuiView(int id)
561 : d(*new GuiViewPrivate(this)), id_(id), closing_(false), busy_(0),
562 command_execute_(false), minibuffer_focus_(false), toolbarsMovable_(true),
565 connect(this, SIGNAL(bufferViewChanged()),
566 this, SLOT(onBufferViewChanged()));
568 // GuiToolbars *must* be initialised before the menu bar.
569 setIconSize(QSize(d.normalIconSize, d.normalIconSize)); // at least on Mac the default is 32 otherwise, which is huge
572 // set ourself as the current view. This is needed for the menu bar
573 // filling, at least for the static special menu item on Mac. Otherwise
574 // they are greyed out.
575 guiApp->setCurrentView(this);
577 // Fill up the menu bar.
578 guiApp->menus().fillMenuBar(menuBar(), this, true);
580 setCentralWidget(d.stack_widget_);
582 // Start autosave timer
583 if (lyxrc.autosave) {
584 // The connection is closed when this is destroyed.
585 d.autosave_timeout_.timeout.connect([this](){ autoSave();});
586 d.autosave_timeout_.setTimeout(lyxrc.autosave * 1000);
587 d.autosave_timeout_.start();
589 connect(&d.statusbar_timer_, SIGNAL(timeout()),
590 this, SLOT(clearMessage()));
592 // We don't want to keep the window in memory if it is closed.
593 setAttribute(Qt::WA_DeleteOnClose, true);
595 #if !(defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && !defined(Q_OS_MAC)
596 // QIcon::fromTheme was introduced in Qt 4.6
597 #if (QT_VERSION >= 0x040600)
598 // assign an icon to main form. We do not do it under Qt/Win or Qt/Mac,
599 // since the icon is provided in the application bundle. We use a themed
600 // version when available and use the bundled one as fallback.
601 setWindowIcon(QIcon::fromTheme("lyx", getPixmap("images/", "lyx", "svg,png")));
603 setWindowIcon(getPixmap("images/", "lyx", "svg,png"));
609 // use tabbed dock area for multiple docks
610 // (such as "source" and "messages")
611 setDockOptions(QMainWindow::ForceTabbedDocks);
614 setAcceptDrops(true);
616 // add busy indicator to statusbar
617 GuiClickableLabel * busylabel = new GuiClickableLabel(statusBar());
618 statusBar()->addPermanentWidget(busylabel);
619 search_mode mode = theGuiApp()->imageSearchMode();
620 QString fn = toqstr(lyx::libFileSearch("images", "busy", "gif", mode).absFileName());
621 QMovie * busyanim = new QMovie(fn, QByteArray(), busylabel);
622 busylabel->setMovie(busyanim);
626 connect(&d.processing_thread_watcher_, SIGNAL(started()),
627 busylabel, SLOT(show()));
628 connect(&d.processing_thread_watcher_, SIGNAL(finished()),
629 busylabel, SLOT(hide()));
630 connect(busylabel, SIGNAL(clicked()), this, SLOT(checkCancelBackground()));
632 QFontMetrics const fm(statusBar()->fontMetrics());
633 int const iconheight = max(int(d.normalIconSize), fm.height());
634 QSize const iconsize(iconheight, iconheight);
636 QPixmap shellescape = QIcon(getPixmap("images/", "emblem-shellescape", "svgz,png")).pixmap(iconsize);
637 shell_escape_ = new QLabel(statusBar());
638 shell_escape_->setPixmap(shellescape);
639 shell_escape_->setScaledContents(true);
640 shell_escape_->setAlignment(Qt::AlignCenter);
641 shell_escape_->setContextMenuPolicy(Qt::CustomContextMenu);
642 shell_escape_->setToolTip(qt_("WARNING: LaTeX is allowed to execute "
643 "external commands for this document. "
644 "Right click to change."));
645 SEMenu * menu = new SEMenu(this);
646 connect(shell_escape_, SIGNAL(customContextMenuRequested(QPoint)),
647 menu, SLOT(showMenu(QPoint)));
648 shell_escape_->hide();
649 statusBar()->addPermanentWidget(shell_escape_);
651 QPixmap readonly = QIcon(getPixmap("images/", "emblem-readonly", "svgz,png")).pixmap(iconsize);
652 read_only_ = new QLabel(statusBar());
653 read_only_->setPixmap(readonly);
654 read_only_->setScaledContents(true);
655 read_only_->setAlignment(Qt::AlignCenter);
657 statusBar()->addPermanentWidget(read_only_);
659 version_control_ = new QLabel(statusBar());
660 version_control_->setAlignment(Qt::AlignCenter);
661 version_control_->setFrameStyle(QFrame::StyledPanel);
662 version_control_->hide();
663 statusBar()->addPermanentWidget(version_control_);
665 statusBar()->setSizeGripEnabled(true);
668 connect(&d.autosave_watcher_, SIGNAL(finished()), this,
669 SLOT(autoSaveThreadFinished()));
671 connect(&d.processing_thread_watcher_, SIGNAL(started()), this,
672 SLOT(processingThreadStarted()));
673 connect(&d.processing_thread_watcher_, SIGNAL(finished()), this,
674 SLOT(processingThreadFinished()));
676 connect(this, SIGNAL(triggerShowDialog(QString const &, QString const &, Inset *)),
677 SLOT(doShowDialog(QString const &, QString const &, Inset *)));
679 // set custom application bars context menu, e.g. tool bar and menu bar
680 setContextMenuPolicy(Qt::CustomContextMenu);
681 connect(this, SIGNAL(customContextMenuRequested(const QPoint &)),
682 SLOT(toolBarPopup(const QPoint &)));
684 // Forbid too small unresizable window because it can happen
685 // with some window manager under X11.
686 setMinimumSize(300, 200);
688 if (lyxrc.allow_geometry_session) {
689 // Now take care of session management.
694 // no session handling, default to a sane size.
695 setGeometry(50, 50, 690, 510);
698 // clear session data if any.
700 settings.remove("views");
710 void GuiView::disableShellEscape()
712 BufferView * bv = documentBufferView();
715 theSession().shellescapeFiles().remove(bv->buffer().absFileName());
716 bv->buffer().params().shell_escape = false;
717 bv->processUpdateFlags(Update::Force);
721 void GuiView::checkCancelBackground()
723 docstring const ttl = _("Cancel Export?");
724 docstring const msg = _("Do you want to cancel the background export process?");
726 Alert::prompt(ttl, msg, 1, 1,
727 _("&Cancel export"), _("Co&ntinue"));
729 Systemcall::killscript();
733 QVector<GuiWorkArea*> GuiView::GuiViewPrivate::guiWorkAreas()
735 QVector<GuiWorkArea*> areas;
736 for (int i = 0; i < tabWorkAreaCount(); i++) {
737 TabWorkArea* ta = tabWorkArea(i);
738 for (int u = 0; u < ta->count(); u++) {
739 areas << ta->workArea(u);
745 static void handleExportStatus(GuiView * view, Buffer::ExportStatus status,
746 string const & format)
748 docstring const fmt = theFormats().prettyName(format);
751 case Buffer::ExportSuccess:
752 msg = bformat(_("Successful export to format: %1$s"), fmt);
754 case Buffer::ExportCancel:
755 msg = _("Document export cancelled.");
757 case Buffer::ExportError:
758 case Buffer::ExportNoPathToFormat:
759 case Buffer::ExportTexPathHasSpaces:
760 case Buffer::ExportConverterError:
761 msg = bformat(_("Error while exporting format: %1$s"), fmt);
763 case Buffer::PreviewSuccess:
764 msg = bformat(_("Successful preview of format: %1$s"), fmt);
766 case Buffer::PreviewError:
767 msg = bformat(_("Error while previewing format: %1$s"), fmt);
769 case Buffer::ExportKilled:
770 msg = bformat(_("Conversion cancelled while previewing format: %1$s"), fmt);
777 void GuiView::processingThreadStarted()
782 void GuiView::processingThreadFinished()
784 QFutureWatcher<Buffer::ExportStatus> const * watcher =
785 static_cast<QFutureWatcher<Buffer::ExportStatus> const *>(sender());
787 Buffer::ExportStatus const status = watcher->result();
788 handleExportStatus(this, status, d.processing_format);
791 BufferView const * const bv = currentBufferView();
792 if (bv && !bv->buffer().errorList("Export").empty()) {
797 bool const error = (status != Buffer::ExportSuccess &&
798 status != Buffer::PreviewSuccess &&
799 status != Buffer::ExportCancel);
801 ErrorList & el = bv->buffer().errorList(d.last_export_format);
802 // at this point, we do not know if buffer-view or
803 // master-buffer-view was called. If there was an export error,
804 // and the current buffer's error log is empty, we guess that
805 // it must be master-buffer-view that was called so we set
807 errors(d.last_export_format, el.empty());
812 void GuiView::autoSaveThreadFinished()
814 QFutureWatcher<docstring> const * watcher =
815 static_cast<QFutureWatcher<docstring> const *>(sender());
816 message(watcher->result());
821 void GuiView::saveLayout() const
824 settings.setValue("zoom_ratio", zoom_ratio_);
825 settings.setValue("devel_mode", devel_mode_);
826 settings.beginGroup("views");
827 settings.beginGroup(QString::number(id_));
828 #if defined(Q_WS_X11) || defined(QPA_XCB)
829 settings.setValue("pos", pos());
830 settings.setValue("size", size());
832 settings.setValue("geometry", saveGeometry());
834 settings.setValue("layout", saveState(0));
835 settings.setValue("icon_size", toqstr(d.iconSize(iconSize())));
839 void GuiView::saveUISettings() const
843 // Save the toolbar private states
844 ToolbarMap::iterator end = d.toolbars_.end();
845 for (ToolbarMap::iterator it = d.toolbars_.begin(); it != end; ++it)
846 it->second->saveSession(settings);
847 // Now take care of all other dialogs
848 map<string, DialogPtr>::const_iterator it = d.dialogs_.begin();
849 for (; it!= d.dialogs_.end(); ++it)
850 it->second->saveSession(settings);
854 bool GuiView::restoreLayout()
857 zoom_ratio_ = settings.value("zoom_ratio", 1.0).toDouble();
858 // Actual zoom value: default zoom + fractional offset
859 int zoom = (int)(lyxrc.defaultZoom * zoom_ratio_);
860 if (zoom < static_cast<int>(zoom_min_))
862 lyxrc.currentZoom = zoom;
863 devel_mode_ = settings.value("devel_mode", devel_mode_).toBool();
864 settings.beginGroup("views");
865 settings.beginGroup(QString::number(id_));
866 QString const icon_key = "icon_size";
867 if (!settings.contains(icon_key))
870 //code below is skipped when when ~/.config/LyX is (re)created
871 setIconSize(d.iconSize(settings.value(icon_key).toString()));
873 #if defined(Q_WS_X11) || defined(QPA_XCB)
874 QPoint pos = settings.value("pos", QPoint(50, 50)).toPoint();
875 QSize size = settings.value("size", QSize(690, 510)).toSize();
879 // Work-around for bug #6034: the window ends up in an undetermined
880 // state when trying to restore a maximized window when it is
881 // already maximized.
882 if (!(windowState() & Qt::WindowMaximized))
883 if (!restoreGeometry(settings.value("geometry").toByteArray()))
884 setGeometry(50, 50, 690, 510);
886 // Make sure layout is correctly oriented.
887 setLayoutDirection(qApp->layoutDirection());
889 // Allow the toc and view-source dock widget to be restored if needed.
891 if ((dialog = findOrBuild("toc", true)))
892 // see bug 5082. At least setup title and enabled state.
893 // Visibility will be adjusted by restoreState below.
894 dialog->prepareView();
895 if ((dialog = findOrBuild("view-source", true)))
896 dialog->prepareView();
897 if ((dialog = findOrBuild("progress", true)))
898 dialog->prepareView();
900 if (!restoreState(settings.value("layout").toByteArray(), 0))
903 // init the toolbars that have not been restored
904 Toolbars::Infos::iterator cit = guiApp->toolbars().begin();
905 Toolbars::Infos::iterator end = guiApp->toolbars().end();
906 for (; cit != end; ++cit) {
907 GuiToolbar * tb = toolbar(cit->name);
908 if (tb && !tb->isRestored())
909 initToolbar(cit->name);
912 // update lock (all) toolbars positions
913 updateLockToolbars();
920 GuiToolbar * GuiView::toolbar(string const & name)
922 ToolbarMap::iterator it = d.toolbars_.find(name);
923 if (it != d.toolbars_.end())
926 LYXERR(Debug::GUI, "Toolbar::display: no toolbar named " << name);
931 void GuiView::updateLockToolbars()
933 toolbarsMovable_ = false;
934 for (ToolbarInfo const & info : guiApp->toolbars()) {
935 GuiToolbar * tb = toolbar(info.name);
936 if (tb && tb->isMovable())
937 toolbarsMovable_ = true;
942 void GuiView::constructToolbars()
944 ToolbarMap::iterator it = d.toolbars_.begin();
945 for (; it != d.toolbars_.end(); ++it)
949 // I don't like doing this here, but the standard toolbar
950 // destroys this object when it's destroyed itself (vfr)
951 d.layout_ = new LayoutBox(*this);
952 d.stack_widget_->addWidget(d.layout_);
953 d.layout_->move(0,0);
955 // extracts the toolbars from the backend
956 Toolbars::Infos::iterator cit = guiApp->toolbars().begin();
957 Toolbars::Infos::iterator end = guiApp->toolbars().end();
958 for (; cit != end; ++cit)
959 d.toolbars_[cit->name] = new GuiToolbar(*cit, *this);
963 void GuiView::initToolbars()
965 // extracts the toolbars from the backend
966 Toolbars::Infos::iterator cit = guiApp->toolbars().begin();
967 Toolbars::Infos::iterator end = guiApp->toolbars().end();
968 for (; cit != end; ++cit)
969 initToolbar(cit->name);
973 void GuiView::initToolbar(string const & name)
975 GuiToolbar * tb = toolbar(name);
978 int const visibility = guiApp->toolbars().defaultVisibility(name);
979 bool newline = !(visibility & Toolbars::SAMEROW);
980 tb->setVisible(false);
981 tb->setVisibility(visibility);
983 if (visibility & Toolbars::TOP) {
985 addToolBarBreak(Qt::TopToolBarArea);
986 addToolBar(Qt::TopToolBarArea, tb);
989 if (visibility & Toolbars::BOTTOM) {
991 addToolBarBreak(Qt::BottomToolBarArea);
992 addToolBar(Qt::BottomToolBarArea, tb);
995 if (visibility & Toolbars::LEFT) {
997 addToolBarBreak(Qt::LeftToolBarArea);
998 addToolBar(Qt::LeftToolBarArea, tb);
1001 if (visibility & Toolbars::RIGHT) {
1003 addToolBarBreak(Qt::RightToolBarArea);
1004 addToolBar(Qt::RightToolBarArea, tb);
1007 if (visibility & Toolbars::ON)
1008 tb->setVisible(true);
1010 tb->setMovable(true);
1014 TocModels & GuiView::tocModels()
1016 return d.toc_models_;
1020 void GuiView::setFocus()
1022 LYXERR(Debug::DEBUG, "GuiView::setFocus()" << this);
1023 QMainWindow::setFocus();
1027 bool GuiView::hasFocus() const
1029 if (currentWorkArea())
1030 return currentWorkArea()->hasFocus();
1031 if (currentMainWorkArea())
1032 return currentMainWorkArea()->hasFocus();
1033 return d.bg_widget_->hasFocus();
1037 void GuiView::focusInEvent(QFocusEvent * e)
1039 LYXERR(Debug::DEBUG, "GuiView::focusInEvent()" << this);
1040 QMainWindow::focusInEvent(e);
1041 // Make sure guiApp points to the correct view.
1042 guiApp->setCurrentView(this);
1043 if (currentWorkArea())
1044 currentWorkArea()->setFocus();
1045 else if (currentMainWorkArea())
1046 currentMainWorkArea()->setFocus();
1048 d.bg_widget_->setFocus();
1052 void GuiView::showEvent(QShowEvent * e)
1054 LYXERR(Debug::GUI, "Passed Geometry "
1055 << size().height() << "x" << size().width()
1056 << "+" << pos().x() << "+" << pos().y());
1058 if (d.splitter_->count() == 0)
1059 // No work area, switch to the background widget.
1063 QMainWindow::showEvent(e);
1067 bool GuiView::closeScheduled()
1074 bool GuiView::prepareAllBuffersForLogout()
1076 Buffer * first = theBufferList().first();
1080 // First, iterate over all buffers and ask the users if unsaved
1081 // changes should be saved.
1082 // We cannot use a for loop as the buffer list cycles.
1085 if (!saveBufferIfNeeded(const_cast<Buffer &>(*b), false))
1087 b = theBufferList().next(b);
1088 } while (b != first);
1090 // Next, save session state
1091 // When a view/window was closed before without quitting LyX, there
1092 // are already entries in the lastOpened list.
1093 theSession().lastOpened().clear();
1100 /** Destroy only all tabbed WorkAreas. Destruction of other WorkAreas
1101 ** is responsibility of the container (e.g., dialog)
1103 void GuiView::closeEvent(QCloseEvent * close_event)
1105 LYXERR(Debug::DEBUG, "GuiView::closeEvent()");
1107 if (!GuiViewPrivate::busyBuffers.isEmpty()) {
1108 Alert::warning(_("Exit LyX"),
1109 _("LyX could not be closed because documents are being processed by LyX."));
1110 close_event->setAccepted(false);
1114 // If the user pressed the x (so we didn't call closeView
1115 // programmatically), we want to clear all existing entries.
1117 theSession().lastOpened().clear();
1122 // it can happen that this event arrives without selecting the view,
1123 // e.g. when clicking the close button on a background window.
1125 if (!closeWorkAreaAll()) {
1127 close_event->ignore();
1131 // Make sure that nothing will use this to be closed View.
1132 guiApp->unregisterView(this);
1134 if (isFullScreen()) {
1135 // Switch off fullscreen before closing.
1140 // Make sure the timer time out will not trigger a statusbar update.
1141 d.statusbar_timer_.stop();
1143 // Saving fullscreen requires additional tweaks in the toolbar code.
1144 // It wouldn't also work under linux natively.
1145 if (lyxrc.allow_geometry_session) {
1150 close_event->accept();
1154 void GuiView::dragEnterEvent(QDragEnterEvent * event)
1156 if (event->mimeData()->hasUrls())
1158 /// \todo Ask lyx-devel is this is enough:
1159 /// if (event->mimeData()->hasFormat("text/plain"))
1160 /// event->acceptProposedAction();
1164 void GuiView::dropEvent(QDropEvent * event)
1166 QList<QUrl> files = event->mimeData()->urls();
1167 if (files.isEmpty())
1170 LYXERR(Debug::GUI, "GuiView::dropEvent: got URLs!");
1171 for (int i = 0; i != files.size(); ++i) {
1172 string const file = os::internal_path(fromqstr(
1173 files.at(i).toLocalFile()));
1177 string const ext = support::getExtension(file);
1178 vector<const Format *> found_formats;
1180 // Find all formats that have the correct extension.
1181 vector<const Format *> const & import_formats
1182 = theConverters().importableFormats();
1183 vector<const Format *>::const_iterator it = import_formats.begin();
1184 for (; it != import_formats.end(); ++it)
1185 if ((*it)->hasExtension(ext))
1186 found_formats.push_back(*it);
1189 if (found_formats.size() >= 1) {
1190 if (found_formats.size() > 1) {
1191 //FIXME: show a dialog to choose the correct importable format
1192 LYXERR(Debug::FILES,
1193 "Multiple importable formats found, selecting first");
1195 string const arg = found_formats[0]->name() + " " + file;
1196 cmd = FuncRequest(LFUN_BUFFER_IMPORT, arg);
1199 //FIXME: do we have to explicitly check whether it's a lyx file?
1200 LYXERR(Debug::FILES,
1201 "No formats found, trying to open it as a lyx file");
1202 cmd = FuncRequest(LFUN_FILE_OPEN, file);
1204 // add the functions to the queue
1205 guiApp->addToFuncRequestQueue(cmd);
1208 // now process the collected functions. We perform the events
1209 // asynchronously. This prevents potential problems in case the
1210 // BufferView is closed within an event.
1211 guiApp->processFuncRequestQueueAsync();
1215 void GuiView::message(docstring const & str)
1217 if (ForkedProcess::iAmAChild())
1220 // call is moved to GUI-thread by GuiProgress
1221 d.progress_->appendMessage(toqstr(str));
1225 void GuiView::clearMessageText()
1227 message(docstring());
1231 void GuiView::updateStatusBarMessage(QString const & str)
1233 statusBar()->showMessage(str);
1234 d.statusbar_timer_.stop();
1235 d.statusbar_timer_.start(3000);
1239 void GuiView::clearMessage()
1241 // FIXME: This code was introduced in r19643 to fix bug #4123. However,
1242 // the hasFocus function mostly returns false, even if the focus is on
1243 // a workarea in this view.
1247 d.statusbar_timer_.stop();
1251 void GuiView::updateWindowTitle(GuiWorkArea * wa)
1253 if (wa != d.current_work_area_
1254 || wa->bufferView().buffer().isInternal())
1256 Buffer const & buf = wa->bufferView().buffer();
1257 // Set the windows title
1258 docstring title = buf.fileName().displayName(130) + from_ascii("[*]");
1259 if (buf.notifiesExternalModification()) {
1260 title = bformat(_("%1$s (modified externally)"), title);
1261 // If the external modification status has changed, then maybe the status of
1262 // buffer-save has changed too.
1266 title += from_ascii(" - LyX");
1268 setWindowTitle(toqstr(title));
1269 // Sets the path for the window: this is used by OSX to
1270 // allow a context click on the title bar showing a menu
1271 // with the path up to the file
1272 setWindowFilePath(toqstr(buf.absFileName()));
1273 // Tell Qt whether the current document is changed
1274 setWindowModified(!buf.isClean());
1276 if (buf.params().shell_escape)
1277 shell_escape_->show();
1279 shell_escape_->hide();
1281 if (buf.hasReadonlyFlag())
1286 if (buf.lyxvc().inUse()) {
1287 version_control_->show();
1288 version_control_->setText(toqstr(buf.lyxvc().vcstatus()));
1290 version_control_->hide();
1294 void GuiView::on_currentWorkAreaChanged(GuiWorkArea * wa)
1296 if (d.current_work_area_)
1297 // disconnect the current work area from all slots
1298 QObject::disconnect(d.current_work_area_, nullptr, this, nullptr);
1300 disconnectBufferView();
1301 connectBufferView(wa->bufferView());
1302 connectBuffer(wa->bufferView().buffer());
1303 d.current_work_area_ = wa;
1304 QObject::connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
1305 this, SLOT(updateWindowTitle(GuiWorkArea *)));
1306 QObject::connect(wa, SIGNAL(busy(bool)),
1307 this, SLOT(setBusy(bool)));
1308 // connection of a signal to a signal
1309 QObject::connect(wa, SIGNAL(bufferViewChanged()),
1310 this, SIGNAL(bufferViewChanged()));
1311 Q_EMIT updateWindowTitle(wa);
1312 Q_EMIT bufferViewChanged();
1316 void GuiView::onBufferViewChanged()
1319 // Buffer-dependent dialogs must be updated. This is done here because
1320 // some dialogs require buffer()->text.
1325 void GuiView::on_lastWorkAreaRemoved()
1328 // We already are in a close event. Nothing more to do.
1331 if (d.splitter_->count() > 1)
1332 // We have a splitter so don't close anything.
1335 // Reset and updates the dialogs.
1336 Q_EMIT bufferViewChanged();
1341 if (lyxrc.open_buffers_in_tabs)
1342 // Nothing more to do, the window should stay open.
1345 if (guiApp->viewIds().size() > 1) {
1351 // On Mac we also close the last window because the application stay
1352 // resident in memory. On other platforms we don't close the last
1353 // window because this would quit the application.
1359 void GuiView::updateStatusBar()
1361 // let the user see the explicit message
1362 if (d.statusbar_timer_.isActive())
1369 void GuiView::showMessage()
1373 QString msg = toqstr(theGuiApp()->viewStatusMessage());
1374 if (msg.isEmpty()) {
1375 BufferView const * bv = currentBufferView();
1377 msg = toqstr(bv->cursor().currentState(devel_mode_));
1379 msg = qt_("Welcome to LyX!");
1381 statusBar()->showMessage(msg);
1385 bool GuiView::event(QEvent * e)
1389 // Useful debug code:
1390 //case QEvent::ActivationChange:
1391 //case QEvent::WindowDeactivate:
1392 //case QEvent::Paint:
1393 //case QEvent::Enter:
1394 //case QEvent::Leave:
1395 //case QEvent::HoverEnter:
1396 //case QEvent::HoverLeave:
1397 //case QEvent::HoverMove:
1398 //case QEvent::StatusTip:
1399 //case QEvent::DragEnter:
1400 //case QEvent::DragLeave:
1401 //case QEvent::Drop:
1404 case QEvent::WindowActivate: {
1405 GuiView * old_view = guiApp->currentView();
1406 if (this == old_view) {
1408 return QMainWindow::event(e);
1410 if (old_view && old_view->currentBufferView()) {
1411 // save current selection to the selection buffer to allow
1412 // middle-button paste in this window.
1413 cap::saveSelection(old_view->currentBufferView()->cursor());
1415 guiApp->setCurrentView(this);
1416 if (d.current_work_area_)
1417 on_currentWorkAreaChanged(d.current_work_area_);
1421 return QMainWindow::event(e);
1424 case QEvent::ShortcutOverride: {
1426 if (isFullScreen() && menuBar()->isHidden()) {
1427 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
1428 // FIXME: we should also try to detect special LyX shortcut such as
1429 // Alt-P and Alt-M. Right now there is a hack in
1430 // GuiWorkArea::processKeySym() that hides again the menubar for
1432 if (ke->modifiers() & Qt::AltModifier && ke->key() != Qt::Key_Alt) {
1434 return QMainWindow::event(e);
1437 return QMainWindow::event(e);
1441 return QMainWindow::event(e);
1445 void GuiView::resetWindowTitle()
1447 setWindowTitle(qt_("LyX"));
1450 bool GuiView::focusNextPrevChild(bool /*next*/)
1457 bool GuiView::busy() const
1463 void GuiView::setBusy(bool busy)
1465 bool const busy_before = busy_ > 0;
1466 busy ? ++busy_ : --busy_;
1467 if ((busy_ > 0) == busy_before)
1468 // busy state didn't change
1472 QApplication::setOverrideCursor(Qt::WaitCursor);
1475 QApplication::restoreOverrideCursor();
1480 void GuiView::resetCommandExecute()
1482 command_execute_ = false;
1487 double GuiView::pixelRatio() const
1489 #if QT_VERSION >= 0x050000
1490 return qt_scale_factor * devicePixelRatio();
1497 GuiWorkArea * GuiView::workArea(int index)
1499 if (TabWorkArea * twa = d.currentTabWorkArea())
1500 if (index < twa->count())
1501 return twa->workArea(index);
1506 GuiWorkArea * GuiView::workArea(Buffer & buffer)
1508 if (currentWorkArea()
1509 && ¤tWorkArea()->bufferView().buffer() == &buffer)
1510 return currentWorkArea();
1511 if (TabWorkArea * twa = d.currentTabWorkArea())
1512 return twa->workArea(buffer);
1517 GuiWorkArea * GuiView::addWorkArea(Buffer & buffer)
1519 // Automatically create a TabWorkArea if there are none yet.
1520 TabWorkArea * tab_widget = d.splitter_->count()
1521 ? d.currentTabWorkArea() : addTabWorkArea();
1522 return tab_widget->addWorkArea(buffer, *this);
1526 TabWorkArea * GuiView::addTabWorkArea()
1528 TabWorkArea * twa = new TabWorkArea;
1529 QObject::connect(twa, SIGNAL(currentWorkAreaChanged(GuiWorkArea *)),
1530 this, SLOT(on_currentWorkAreaChanged(GuiWorkArea *)));
1531 QObject::connect(twa, SIGNAL(lastWorkAreaRemoved()),
1532 this, SLOT(on_lastWorkAreaRemoved()));
1534 d.splitter_->addWidget(twa);
1535 d.stack_widget_->setCurrentWidget(d.splitter_);
1540 GuiWorkArea const * GuiView::currentWorkArea() const
1542 return d.current_work_area_;
1546 GuiWorkArea * GuiView::currentWorkArea()
1548 return d.current_work_area_;
1552 GuiWorkArea const * GuiView::currentMainWorkArea() const
1554 if (!d.currentTabWorkArea())
1556 return d.currentTabWorkArea()->currentWorkArea();
1560 GuiWorkArea * GuiView::currentMainWorkArea()
1562 if (!d.currentTabWorkArea())
1564 return d.currentTabWorkArea()->currentWorkArea();
1568 void GuiView::setCurrentWorkArea(GuiWorkArea * wa)
1570 LYXERR(Debug::DEBUG, "Setting current wa: " << wa << endl);
1572 d.current_work_area_ = nullptr;
1574 Q_EMIT bufferViewChanged();
1578 // FIXME: I've no clue why this is here and why it accesses
1579 // theGuiApp()->currentView, which might be 0 (bug 6464).
1580 // See also 27525 (vfr).
1581 if (theGuiApp()->currentView() == this
1582 && theGuiApp()->currentView()->currentWorkArea() == wa)
1585 if (currentBufferView())
1586 cap::saveSelection(currentBufferView()->cursor());
1588 theGuiApp()->setCurrentView(this);
1589 d.current_work_area_ = wa;
1591 // We need to reset this now, because it will need to be
1592 // right if the tabWorkArea gets reset in the for loop. We
1593 // will change it back if we aren't in that case.
1594 GuiWorkArea * const old_cmwa = d.current_main_work_area_;
1595 d.current_main_work_area_ = wa;
1597 for (int i = 0; i != d.splitter_->count(); ++i) {
1598 if (d.tabWorkArea(i)->setCurrentWorkArea(wa)) {
1599 LYXERR(Debug::DEBUG, "Current wa: " << currentWorkArea()
1600 << ", Current main wa: " << currentMainWorkArea());
1605 d.current_main_work_area_ = old_cmwa;
1607 LYXERR(Debug::DEBUG, "This is not a tabbed wa");
1608 on_currentWorkAreaChanged(wa);
1609 BufferView & bv = wa->bufferView();
1610 bv.cursor().fixIfBroken();
1612 wa->setUpdatesEnabled(true);
1613 LYXERR(Debug::DEBUG, "Current wa: " << currentWorkArea() << ", Current main wa: " << currentMainWorkArea());
1617 void GuiView::removeWorkArea(GuiWorkArea * wa)
1619 LASSERT(wa, return);
1620 if (wa == d.current_work_area_) {
1622 disconnectBufferView();
1623 d.current_work_area_ = nullptr;
1624 d.current_main_work_area_ = nullptr;
1627 bool found_twa = false;
1628 for (int i = 0; i != d.splitter_->count(); ++i) {
1629 TabWorkArea * twa = d.tabWorkArea(i);
1630 if (twa->removeWorkArea(wa)) {
1631 // Found in this tab group, and deleted the GuiWorkArea.
1633 if (twa->count() != 0) {
1634 if (d.current_work_area_ == nullptr)
1635 // This means that we are closing the current GuiWorkArea, so
1636 // switch to the next GuiWorkArea in the found TabWorkArea.
1637 setCurrentWorkArea(twa->currentWorkArea());
1639 // No more WorkAreas in this tab group, so delete it.
1646 // It is not a tabbed work area (i.e., the search work area), so it
1647 // should be deleted by other means.
1648 LASSERT(found_twa, return);
1650 if (d.current_work_area_ == nullptr) {
1651 if (d.splitter_->count() != 0) {
1652 TabWorkArea * twa = d.currentTabWorkArea();
1653 setCurrentWorkArea(twa->currentWorkArea());
1655 // No more work areas, switch to the background widget.
1656 setCurrentWorkArea(nullptr);
1662 LayoutBox * GuiView::getLayoutDialog() const
1668 void GuiView::updateLayoutList()
1671 d.layout_->updateContents(false);
1675 void GuiView::updateToolbars()
1677 ToolbarMap::iterator end = d.toolbars_.end();
1678 if (d.current_work_area_) {
1680 if (d.current_work_area_->bufferView().cursor().inMathed()
1681 && !d.current_work_area_->bufferView().cursor().inRegexped())
1682 context |= Toolbars::MATH;
1683 if (lyx::getStatus(FuncRequest(LFUN_LAYOUT_TABULAR)).enabled())
1684 context |= Toolbars::TABLE;
1685 if (currentBufferView()->buffer().areChangesPresent()
1686 || (lyx::getStatus(FuncRequest(LFUN_CHANGES_TRACK)).enabled()
1687 && lyx::getStatus(FuncRequest(LFUN_CHANGES_TRACK)).onOff(true))
1688 || (lyx::getStatus(FuncRequest(LFUN_CHANGES_OUTPUT)).enabled()
1689 && lyx::getStatus(FuncRequest(LFUN_CHANGES_OUTPUT)).onOff(true)))
1690 context |= Toolbars::REVIEW;
1691 if (lyx::getStatus(FuncRequest(LFUN_IN_MATHMACROTEMPLATE)).enabled())
1692 context |= Toolbars::MATHMACROTEMPLATE;
1693 if (lyx::getStatus(FuncRequest(LFUN_IN_IPA)).enabled())
1694 context |= Toolbars::IPA;
1695 if (command_execute_)
1696 context |= Toolbars::MINIBUFFER;
1697 if (minibuffer_focus_) {
1698 context |= Toolbars::MINIBUFFER_FOCUS;
1699 minibuffer_focus_ = false;
1702 for (ToolbarMap::iterator it = d.toolbars_.begin(); it != end; ++it)
1703 it->second->update(context);
1705 for (ToolbarMap::iterator it = d.toolbars_.begin(); it != end; ++it)
1706 it->second->update();
1710 void GuiView::setBuffer(Buffer * newBuffer, bool switch_to)
1712 LYXERR(Debug::DEBUG, "Setting buffer: " << newBuffer << endl);
1713 LASSERT(newBuffer, return);
1715 GuiWorkArea * wa = workArea(*newBuffer);
1716 if (wa == nullptr) {
1718 newBuffer->masterBuffer()->updateBuffer();
1720 wa = addWorkArea(*newBuffer);
1721 // scroll to the position when the BufferView was last closed
1722 if (lyxrc.use_lastfilepos) {
1723 LastFilePosSection::FilePos filepos =
1724 theSession().lastFilePos().load(newBuffer->fileName());
1725 wa->bufferView().moveToPosition(filepos.pit, filepos.pos, 0, 0);
1728 //Disconnect the old buffer...there's no new one.
1731 connectBuffer(*newBuffer);
1732 connectBufferView(wa->bufferView());
1734 setCurrentWorkArea(wa);
1738 void GuiView::connectBuffer(Buffer & buf)
1740 buf.setGuiDelegate(this);
1744 void GuiView::disconnectBuffer()
1746 if (d.current_work_area_)
1747 d.current_work_area_->bufferView().buffer().setGuiDelegate(nullptr);
1751 void GuiView::connectBufferView(BufferView & bv)
1753 bv.setGuiDelegate(this);
1757 void GuiView::disconnectBufferView()
1759 if (d.current_work_area_)
1760 d.current_work_area_->bufferView().setGuiDelegate(nullptr);
1764 void GuiView::errors(string const & error_type, bool from_master)
1766 BufferView const * const bv = currentBufferView();
1770 ErrorList const & el = from_master ?
1771 bv->buffer().masterBuffer()->errorList(error_type) :
1772 bv->buffer().errorList(error_type);
1777 string err = error_type;
1779 err = "from_master|" + error_type;
1780 showDialog("errorlist", err);
1784 void GuiView::updateTocItem(string const & type, DocIterator const & dit)
1786 d.toc_models_.updateItem(toqstr(type), dit);
1790 void GuiView::structureChanged()
1792 // This is called from the Buffer, which has no way to ensure that cursors
1793 // in BufferView remain valid.
1794 if (documentBufferView())
1795 documentBufferView()->cursor().sanitize();
1796 // FIXME: This is slightly expensive, though less than the tocBackend update
1797 // (#9880). This also resets the view in the Toc Widget (#6675).
1798 d.toc_models_.reset(documentBufferView());
1799 // Navigator needs more than a simple update in this case. It needs to be
1801 updateDialog("toc", "");
1805 void GuiView::updateDialog(string const & name, string const & sdata)
1807 if (!isDialogVisible(name))
1810 map<string, DialogPtr>::const_iterator it = d.dialogs_.find(name);
1811 if (it == d.dialogs_.end())
1814 Dialog * const dialog = it->second.get();
1815 if (dialog->isVisibleView())
1816 dialog->initialiseParams(sdata);
1820 BufferView * GuiView::documentBufferView()
1822 return currentMainWorkArea()
1823 ? ¤tMainWorkArea()->bufferView()
1828 BufferView const * GuiView::documentBufferView() const
1830 return currentMainWorkArea()
1831 ? ¤tMainWorkArea()->bufferView()
1836 BufferView * GuiView::currentBufferView()
1838 return d.current_work_area_ ? &d.current_work_area_->bufferView() : nullptr;
1842 BufferView const * GuiView::currentBufferView() const
1844 return d.current_work_area_ ? &d.current_work_area_->bufferView() : nullptr;
1848 docstring GuiView::GuiViewPrivate::autosaveAndDestroy(
1849 Buffer const * orig, Buffer * clone)
1851 bool const success = clone->autoSave();
1853 busyBuffers.remove(orig);
1855 ? _("Automatic save done.")
1856 : _("Automatic save failed!");
1860 void GuiView::autoSave()
1862 LYXERR(Debug::INFO, "Running autoSave()");
1864 Buffer * buffer = documentBufferView()
1865 ? &documentBufferView()->buffer() : nullptr;
1867 resetAutosaveTimers();
1871 GuiViewPrivate::busyBuffers.insert(buffer);
1872 QFuture<docstring> f = QtConcurrent::run(GuiViewPrivate::autosaveAndDestroy,
1873 buffer, buffer->cloneBufferOnly());
1874 d.autosave_watcher_.setFuture(f);
1875 resetAutosaveTimers();
1879 void GuiView::resetAutosaveTimers()
1882 d.autosave_timeout_.restart();
1886 bool GuiView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1889 Buffer * buf = currentBufferView()
1890 ? ¤tBufferView()->buffer() : nullptr;
1891 Buffer * doc_buffer = documentBufferView()
1892 ? &(documentBufferView()->buffer()) : nullptr;
1895 /* In LyX/Mac, when a dialog is open, the menus of the
1896 application can still be accessed without giving focus to
1897 the main window. In this case, we want to disable the menu
1898 entries that are buffer-related.
1899 This code must not be used on Linux and Windows, since it
1900 would disable buffer-related entries when hovering over the
1901 menu (see bug #9574).
1903 if (cmd.origin() == FuncRequest::MENU && !hasFocus()) {
1909 // Check whether we need a buffer
1910 if (!lyxaction.funcHasFlag(cmd.action(), LyXAction::NoBuffer) && !buf) {
1911 // no, exit directly
1912 flag.message(from_utf8(N_("Command not allowed with"
1913 "out any document open")));
1914 flag.setEnabled(false);
1918 if (cmd.origin() == FuncRequest::TOC) {
1919 GuiToc * toc = static_cast<GuiToc*>(findOrBuild("toc", false));
1920 if (!toc || !toc->getStatus(documentBufferView()->cursor(), cmd, flag))
1921 flag.setEnabled(false);
1925 switch(cmd.action()) {
1926 case LFUN_BUFFER_IMPORT:
1929 case LFUN_MASTER_BUFFER_EXPORT:
1931 && (doc_buffer->parent() != nullptr
1932 || doc_buffer->hasChildren())
1933 && !d.processing_thread_watcher_.isRunning()
1934 // this launches a dialog, which would be in the wrong Buffer
1935 && !(::lyx::operator==(cmd.argument(), "custom"));
1938 case LFUN_MASTER_BUFFER_UPDATE:
1939 case LFUN_MASTER_BUFFER_VIEW:
1941 && (doc_buffer->parent() != nullptr
1942 || doc_buffer->hasChildren())
1943 && !d.processing_thread_watcher_.isRunning();
1946 case LFUN_BUFFER_UPDATE:
1947 case LFUN_BUFFER_VIEW: {
1948 if (!doc_buffer || d.processing_thread_watcher_.isRunning()) {
1952 string format = to_utf8(cmd.argument());
1953 if (cmd.argument().empty())
1954 format = doc_buffer->params().getDefaultOutputFormat();
1955 enable = doc_buffer->params().isExportable(format, true);
1959 case LFUN_BUFFER_RELOAD:
1960 enable = doc_buffer && !doc_buffer->isUnnamed()
1961 && doc_buffer->fileName().exists()
1962 && (!doc_buffer->isClean() || doc_buffer->notifiesExternalModification());
1965 case LFUN_BUFFER_RESET_EXPORT:
1966 enable = doc_buffer != nullptr;
1969 case LFUN_BUFFER_CHILD_OPEN:
1970 enable = doc_buffer != nullptr;
1973 case LFUN_MASTER_BUFFER_FORALL: {
1974 if (doc_buffer == nullptr) {
1975 flag.message(from_utf8(N_("Command not allowed without a buffer open")));
1979 FuncRequest const cmdToPass = lyxaction.lookupFunc(cmd.getLongArg(0));
1980 if (cmdToPass.action() == LFUN_UNKNOWN_ACTION) {
1981 flag.message(from_utf8(N_("Invalid argument of master-buffer-forall")));
1986 for (Buffer * buf : doc_buffer->allRelatives()) {
1987 GuiWorkArea * wa = workArea(*buf);
1990 if (wa->bufferView().getStatus(cmdToPass, flag)) {
1991 enable = flag.enabled();
1998 case LFUN_BUFFER_WRITE:
1999 enable = doc_buffer && (doc_buffer->isUnnamed() || !doc_buffer->isClean());
2002 //FIXME: This LFUN should be moved to GuiApplication.
2003 case LFUN_BUFFER_WRITE_ALL: {
2004 // We enable the command only if there are some modified buffers
2005 Buffer * first = theBufferList().first();
2010 // We cannot use a for loop as the buffer list is a cycle.
2012 if (!b->isClean()) {
2016 b = theBufferList().next(b);
2017 } while (b != first);
2021 case LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR:
2022 enable = doc_buffer && doc_buffer->notifiesExternalModification();
2025 case LFUN_BUFFER_EXPORT: {
2026 if (!doc_buffer || d.processing_thread_watcher_.isRunning()) {
2030 return doc_buffer->getStatus(cmd, flag);
2033 case LFUN_BUFFER_EXPORT_AS:
2034 if (!doc_buffer || d.processing_thread_watcher_.isRunning()) {
2039 case LFUN_BUFFER_WRITE_AS:
2040 case LFUN_BUFFER_WRITE_AS_TEMPLATE:
2041 enable = doc_buffer != nullptr;
2044 case LFUN_EXPORT_CANCEL:
2045 enable = d.processing_thread_watcher_.isRunning();
2048 case LFUN_BUFFER_CLOSE:
2049 case LFUN_VIEW_CLOSE:
2050 enable = doc_buffer != nullptr;
2053 case LFUN_BUFFER_CLOSE_ALL:
2054 enable = theBufferList().last() != theBufferList().first();
2057 case LFUN_BUFFER_CHKTEX: {
2058 // hide if we have no checktex command
2059 if (lyxrc.chktex_command.empty()) {
2060 flag.setUnknown(true);
2064 if (!doc_buffer || !doc_buffer->params().isLatex()
2065 || d.processing_thread_watcher_.isRunning()) {
2066 // grey out, don't hide
2074 case LFUN_VIEW_SPLIT:
2075 if (cmd.getArg(0) == "vertical")
2076 enable = doc_buffer && (d.splitter_->count() == 1 ||
2077 d.splitter_->orientation() == Qt::Vertical);
2079 enable = doc_buffer && (d.splitter_->count() == 1 ||
2080 d.splitter_->orientation() == Qt::Horizontal);
2083 case LFUN_TAB_GROUP_CLOSE:
2084 enable = d.tabWorkAreaCount() > 1;
2087 case LFUN_DEVEL_MODE_TOGGLE:
2088 flag.setOnOff(devel_mode_);
2091 case LFUN_TOOLBAR_TOGGLE: {
2092 string const name = cmd.getArg(0);
2093 if (GuiToolbar * t = toolbar(name))
2094 flag.setOnOff(t->isVisible());
2097 docstring const msg =
2098 bformat(_("Unknown toolbar \"%1$s\""), from_utf8(name));
2104 case LFUN_TOOLBAR_MOVABLE: {
2105 string const name = cmd.getArg(0);
2106 // use negation since locked == !movable
2108 // toolbar name * locks all toolbars
2109 flag.setOnOff(!toolbarsMovable_);
2110 else if (GuiToolbar * t = toolbar(name))
2111 flag.setOnOff(!(t->isMovable()));
2114 docstring const msg =
2115 bformat(_("Unknown toolbar \"%1$s\""), from_utf8(name));
2121 case LFUN_ICON_SIZE:
2122 flag.setOnOff(d.iconSize(cmd.argument()) == iconSize());
2125 case LFUN_DROP_LAYOUTS_CHOICE:
2126 enable = buf != nullptr;
2129 case LFUN_UI_TOGGLE:
2130 flag.setOnOff(isFullScreen());
2133 case LFUN_DIALOG_DISCONNECT_INSET:
2136 case LFUN_DIALOG_HIDE:
2137 // FIXME: should we check if the dialog is shown?
2140 case LFUN_DIALOG_TOGGLE:
2141 flag.setOnOff(isDialogVisible(cmd.getArg(0)));
2144 case LFUN_DIALOG_SHOW: {
2145 string const name = cmd.getArg(0);
2147 enable = name == "aboutlyx"
2148 || name == "file" //FIXME: should be removed.
2149 || name == "lyxfiles"
2151 || name == "texinfo"
2152 || name == "progress"
2153 || name == "compare";
2154 else if (name == "character" || name == "symbols"
2155 || name == "mathdelimiter" || name == "mathmatrix") {
2156 if (!buf || buf->isReadonly())
2159 Cursor const & cur = currentBufferView()->cursor();
2160 enable = !(cur.inTexted() && cur.paragraph().isPassThru());
2163 else if (name == "latexlog")
2164 enable = FileName(doc_buffer->logName()).isReadableFile();
2165 else if (name == "spellchecker")
2166 enable = theSpellChecker()
2167 && !doc_buffer->isReadonly()
2168 && !doc_buffer->text().empty();
2169 else if (name == "vclog")
2170 enable = doc_buffer->lyxvc().inUse();
2174 case LFUN_DIALOG_UPDATE: {
2175 string const name = cmd.getArg(0);
2177 enable = name == "prefs";
2181 case LFUN_COMMAND_EXECUTE:
2183 case LFUN_MENU_OPEN:
2184 // Nothing to check.
2187 case LFUN_COMPLETION_INLINE:
2188 if (!d.current_work_area_
2189 || !d.current_work_area_->completer().inlinePossible(
2190 currentBufferView()->cursor()))
2194 case LFUN_COMPLETION_POPUP:
2195 if (!d.current_work_area_
2196 || !d.current_work_area_->completer().popupPossible(
2197 currentBufferView()->cursor()))
2202 if (!d.current_work_area_
2203 || !d.current_work_area_->completer().inlinePossible(
2204 currentBufferView()->cursor()))
2208 case LFUN_COMPLETION_ACCEPT:
2209 if (!d.current_work_area_
2210 || (!d.current_work_area_->completer().popupVisible()
2211 && !d.current_work_area_->completer().inlineVisible()
2212 && !d.current_work_area_->completer().completionAvailable()))
2216 case LFUN_COMPLETION_CANCEL:
2217 if (!d.current_work_area_
2218 || (!d.current_work_area_->completer().popupVisible()
2219 && !d.current_work_area_->completer().inlineVisible()))
2223 case LFUN_BUFFER_ZOOM_OUT:
2224 case LFUN_BUFFER_ZOOM_IN: {
2225 // only diff between these two is that the default for ZOOM_OUT
2227 bool const neg_zoom =
2228 convert<int>(cmd.argument()) < 0 ||
2229 (cmd.action() == LFUN_BUFFER_ZOOM_OUT && cmd.argument().empty());
2230 if (lyxrc.currentZoom <= zoom_min_ && neg_zoom) {
2231 docstring const msg =
2232 bformat(_("Zoom level cannot be less than %1$d%."), zoom_min_);
2236 enable = doc_buffer;
2240 case LFUN_BUFFER_ZOOM: {
2241 bool const less_than_min_zoom =
2242 !cmd.argument().empty() && convert<int>(cmd.argument()) < zoom_min_;
2243 if (lyxrc.currentZoom <= zoom_min_ && less_than_min_zoom) {
2244 docstring const msg =
2245 bformat(_("Zoom level cannot be less than %1$d%."), zoom_min_);
2250 enable = doc_buffer;
2254 case LFUN_BUFFER_MOVE_NEXT:
2255 case LFUN_BUFFER_MOVE_PREVIOUS:
2256 // we do not cycle when moving
2257 case LFUN_BUFFER_NEXT:
2258 case LFUN_BUFFER_PREVIOUS:
2259 // because we cycle, it doesn't matter whether on first or last
2260 enable = (d.currentTabWorkArea()->count() > 1);
2262 case LFUN_BUFFER_SWITCH:
2263 // toggle on the current buffer, but do not toggle off
2264 // the other ones (is that a good idea?)
2266 && to_utf8(cmd.argument()) == doc_buffer->absFileName())
2267 flag.setOnOff(true);
2270 case LFUN_VC_REGISTER:
2271 enable = doc_buffer && !doc_buffer->lyxvc().inUse();
2273 case LFUN_VC_RENAME:
2274 enable = doc_buffer && doc_buffer->lyxvc().renameEnabled();
2277 enable = doc_buffer && doc_buffer->lyxvc().copyEnabled();
2279 case LFUN_VC_CHECK_IN:
2280 enable = doc_buffer && doc_buffer->lyxvc().checkInEnabled();
2282 case LFUN_VC_CHECK_OUT:
2283 enable = doc_buffer && doc_buffer->lyxvc().checkOutEnabled();
2285 case LFUN_VC_LOCKING_TOGGLE:
2286 enable = doc_buffer && !doc_buffer->hasReadonlyFlag()
2287 && doc_buffer->lyxvc().lockingToggleEnabled();
2288 flag.setOnOff(enable && doc_buffer->lyxvc().locking());
2290 case LFUN_VC_REVERT:
2291 enable = doc_buffer && doc_buffer->lyxvc().inUse()
2292 && !doc_buffer->hasReadonlyFlag();
2294 case LFUN_VC_UNDO_LAST:
2295 enable = doc_buffer && doc_buffer->lyxvc().undoLastEnabled();
2297 case LFUN_VC_REPO_UPDATE:
2298 enable = doc_buffer && doc_buffer->lyxvc().repoUpdateEnabled();
2300 case LFUN_VC_COMMAND: {
2301 if (cmd.argument().empty())
2303 if (!doc_buffer && contains(cmd.getArg(0), 'D'))
2307 case LFUN_VC_COMPARE:
2308 enable = doc_buffer && doc_buffer->lyxvc().prepareFileRevisionEnabled();
2311 case LFUN_SERVER_GOTO_FILE_ROW:
2312 case LFUN_LYX_ACTIVATE:
2314 case LFUN_FORWARD_SEARCH:
2315 enable = !(lyxrc.forward_search_dvi.empty() && lyxrc.forward_search_pdf.empty());
2318 case LFUN_FILE_INSERT_PLAINTEXT:
2319 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2320 enable = documentBufferView() && documentBufferView()->cursor().inTexted();
2323 case LFUN_SPELLING_CONTINUOUSLY:
2324 flag.setOnOff(lyxrc.spellcheck_continuously);
2332 flag.setEnabled(false);
2338 static FileName selectTemplateFile()
2340 FileDialog dlg(qt_("Select template file"));
2341 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
2342 dlg.setButton2(qt_("&Templates"), toqstr(lyxrc.template_path));
2344 FileDialog::Result result = dlg.open(toqstr(lyxrc.template_path),
2345 QStringList(qt_("LyX Documents (*.lyx)")));
2347 if (result.first == FileDialog::Later)
2349 if (result.second.isEmpty())
2351 return FileName(fromqstr(result.second));
2355 Buffer * GuiView::loadDocument(FileName const & filename, bool tolastfiles)
2359 Buffer * newBuffer = nullptr;
2361 newBuffer = checkAndLoadLyXFile(filename);
2362 } catch (ExceptionMessage const & e) {
2369 message(_("Document not loaded."));
2373 setBuffer(newBuffer);
2374 newBuffer->errors("Parse");
2377 theSession().lastFiles().add(filename);
2378 theSession().writeFile();
2385 void GuiView::openDocument(string const & fname)
2387 string initpath = lyxrc.document_path;
2389 if (documentBufferView()) {
2390 string const trypath = documentBufferView()->buffer().filePath();
2391 // If directory is writeable, use this as default.
2392 if (FileName(trypath).isDirWritable())
2398 if (fname.empty()) {
2399 FileDialog dlg(qt_("Select document to open"));
2400 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
2401 dlg.setButton2(qt_("&Examples"), toqstr(lyxrc.example_path));
2403 QStringList const filter(qt_("LyX Documents (*.lyx)"));
2404 FileDialog::Result result =
2405 dlg.open(toqstr(initpath), filter);
2407 if (result.first == FileDialog::Later)
2410 filename = fromqstr(result.second);
2412 // check selected filename
2413 if (filename.empty()) {
2414 message(_("Canceled."));
2420 // get absolute path of file and add ".lyx" to the filename if
2422 FileName const fullname =
2423 fileSearch(string(), filename, "lyx", support::may_not_exist);
2424 if (!fullname.empty())
2425 filename = fullname.absFileName();
2427 if (!fullname.onlyPath().isDirectory()) {
2428 Alert::warning(_("Invalid filename"),
2429 bformat(_("The directory in the given path\n%1$s\ndoes not exist."),
2430 from_utf8(fullname.absFileName())));
2434 // if the file doesn't exist and isn't already open (bug 6645),
2435 // let the user create one
2436 if (!fullname.exists() && !theBufferList().exists(fullname) &&
2437 !LyXVC::file_not_found_hook(fullname)) {
2438 // the user specifically chose this name. Believe him.
2439 Buffer * const b = newFile(filename, string(), true);
2445 docstring const disp_fn = makeDisplayPath(filename);
2446 message(bformat(_("Opening document %1$s..."), disp_fn));
2449 Buffer * buf = loadDocument(fullname);
2451 str2 = bformat(_("Document %1$s opened."), disp_fn);
2452 if (buf->lyxvc().inUse())
2453 str2 += " " + from_utf8(buf->lyxvc().versionString()) +
2454 " " + _("Version control detected.");
2456 str2 = bformat(_("Could not open document %1$s"), disp_fn);
2461 // FIXME: clean that
2462 static bool import(GuiView * lv, FileName const & filename,
2463 string const & format, ErrorList & errorList)
2465 FileName const lyxfile(support::changeExtension(filename.absFileName(), ".lyx"));
2467 string loader_format;
2468 vector<string> loaders = theConverters().loaders();
2469 if (find(loaders.begin(), loaders.end(), format) == loaders.end()) {
2470 vector<string>::const_iterator it = loaders.begin();
2471 vector<string>::const_iterator en = loaders.end();
2472 for (; it != en; ++it) {
2473 if (!theConverters().isReachable(format, *it))
2476 string const tofile =
2477 support::changeExtension(filename.absFileName(),
2478 theFormats().extension(*it));
2479 if (theConverters().convert(nullptr, filename, FileName(tofile),
2480 filename, format, *it, errorList) != Converters::SUCCESS)
2482 loader_format = *it;
2485 if (loader_format.empty()) {
2486 frontend::Alert::error(_("Couldn't import file"),
2487 bformat(_("No information for importing the format %1$s."),
2488 theFormats().prettyName(format)));
2492 loader_format = format;
2494 if (loader_format == "lyx") {
2495 Buffer * buf = lv->loadDocument(lyxfile);
2499 Buffer * const b = newFile(lyxfile.absFileName(), string(), true);
2503 bool as_paragraphs = loader_format == "textparagraph";
2504 string filename2 = (loader_format == format) ? filename.absFileName()
2505 : support::changeExtension(filename.absFileName(),
2506 theFormats().extension(loader_format));
2507 lv->currentBufferView()->insertPlaintextFile(FileName(filename2),
2509 guiApp->setCurrentView(lv);
2510 lyx::dispatch(FuncRequest(LFUN_MARK_OFF));
2517 void GuiView::importDocument(string const & argument)
2520 string filename = split(argument, format, ' ');
2522 LYXERR(Debug::INFO, format << " file: " << filename);
2524 // need user interaction
2525 if (filename.empty()) {
2526 string initpath = lyxrc.document_path;
2527 if (documentBufferView()) {
2528 string const trypath = documentBufferView()->buffer().filePath();
2529 // If directory is writeable, use this as default.
2530 if (FileName(trypath).isDirWritable())
2534 docstring const text = bformat(_("Select %1$s file to import"),
2535 theFormats().prettyName(format));
2537 FileDialog dlg(toqstr(text));
2538 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
2539 dlg.setButton2(qt_("&Examples"), toqstr(lyxrc.example_path));
2541 docstring filter = theFormats().prettyName(format);
2544 filter += from_utf8(theFormats().extensions(format));
2547 FileDialog::Result result =
2548 dlg.open(toqstr(initpath), fileFilters(toqstr(filter)));
2550 if (result.first == FileDialog::Later)
2553 filename = fromqstr(result.second);
2555 // check selected filename
2556 if (filename.empty())
2557 message(_("Canceled."));
2560 if (filename.empty())
2563 // get absolute path of file
2564 FileName const fullname(support::makeAbsPath(filename));
2566 // Can happen if the user entered a path into the dialog
2568 if (fullname.onlyFileName().empty()) {
2569 docstring msg = bformat(_("The file name '%1$s' is invalid!\n"
2570 "Aborting import."),
2571 from_utf8(fullname.absFileName()));
2572 frontend::Alert::error(_("File name error"), msg);
2573 message(_("Canceled."));
2578 FileName const lyxfile(support::changeExtension(fullname.absFileName(), ".lyx"));
2580 // Check if the document already is open
2581 Buffer * buf = theBufferList().getBuffer(lyxfile);
2584 if (!closeBuffer()) {
2585 message(_("Canceled."));
2590 docstring const displaypath = makeDisplayPath(lyxfile.absFileName(), 30);
2592 // if the file exists already, and we didn't do
2593 // -i lyx thefile.lyx, warn
2594 if (lyxfile.exists() && fullname != lyxfile) {
2596 docstring text = bformat(_("The document %1$s already exists.\n\n"
2597 "Do you want to overwrite that document?"), displaypath);
2598 int const ret = Alert::prompt(_("Overwrite document?"),
2599 text, 0, 1, _("&Overwrite"), _("&Cancel"));
2602 message(_("Canceled."));
2607 message(bformat(_("Importing %1$s..."), displaypath));
2608 ErrorList errorList;
2609 if (import(this, fullname, format, errorList))
2610 message(_("imported."));
2612 message(_("file not imported!"));
2614 // FIXME (Abdel 12/08/06): Is there a need to display the error list here?
2618 void GuiView::newDocument(string const & filename, string templatefile,
2621 FileName initpath(lyxrc.document_path);
2622 if (documentBufferView()) {
2623 FileName const trypath(documentBufferView()->buffer().filePath());
2624 // If directory is writeable, use this as default.
2625 if (trypath.isDirWritable())
2629 if (from_template) {
2630 if (templatefile.empty())
2631 templatefile = selectTemplateFile().absFileName();
2632 if (templatefile.empty())
2637 if (filename.empty())
2638 b = newUnnamedFile(initpath, to_utf8(_("newfile")), templatefile);
2640 b = newFile(filename, templatefile, true);
2645 // If no new document could be created, it is unsure
2646 // whether there is a valid BufferView.
2647 if (currentBufferView())
2648 // Ensure the cursor is correctly positioned on screen.
2649 currentBufferView()->showCursor();
2653 void GuiView::insertLyXFile(docstring const & fname, bool ignorelang)
2655 BufferView * bv = documentBufferView();
2660 FileName filename(to_utf8(fname));
2661 if (filename.empty()) {
2662 // Launch a file browser
2664 string initpath = lyxrc.document_path;
2665 string const trypath = bv->buffer().filePath();
2666 // If directory is writeable, use this as default.
2667 if (FileName(trypath).isDirWritable())
2671 FileDialog dlg(qt_("Select LyX document to insert"));
2672 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
2673 dlg.setButton2(qt_("&Examples"), toqstr(lyxrc.example_path));
2675 FileDialog::Result result = dlg.open(toqstr(initpath),
2676 QStringList(qt_("LyX Documents (*.lyx)")));
2678 if (result.first == FileDialog::Later)
2682 filename.set(fromqstr(result.second));
2684 // check selected filename
2685 if (filename.empty()) {
2686 // emit message signal.
2687 message(_("Canceled."));
2692 bv->insertLyXFile(filename, ignorelang);
2693 bv->buffer().errors("Parse");
2697 string const GuiView::getTemplatesPath(Buffer & b)
2699 // We start off with the user's templates path
2700 string result = addPath(package().user_support().absFileName(), "templates");
2701 // Check for the document language
2702 string const langcode = b.params().language->code();
2703 string const shortcode = langcode.substr(0, 2);
2704 if (!langcode.empty() && shortcode != "en") {
2705 string subpath = addPath(result, shortcode);
2706 string subpath_long = addPath(result, langcode);
2707 // If we have a subdirectory for the language already,
2709 FileName sp = FileName(subpath);
2710 if (sp.isDirectory())
2712 else if (FileName(subpath_long).isDirectory())
2713 result = subpath_long;
2715 // Ask whether we should create such a subdirectory
2716 docstring const text =
2717 bformat(_("It is suggested to save the template in a subdirectory\n"
2718 "appropriate to the document language (%1$s).\n"
2719 "This subdirectory does not exists yet.\n"
2720 "Do you want to create it?"),
2721 _(b.params().language->display()));
2722 if (Alert::prompt(_("Create Language Directory?"),
2723 text, 0, 1, _("&Yes, Create"), _("&No, Save Template in Parent Directory")) == 0) {
2724 // If the user agreed, we try to create it and report if this failed.
2725 if (!sp.createDirectory(0777))
2726 Alert::error(_("Subdirectory creation failed!"),
2727 _("Could not create subdirectory.\n"
2728 "The template will be saved in the parent directory."));
2734 // Do we have a layout category?
2735 string const cat = b.params().baseClass() ?
2736 b.params().baseClass()->category()
2739 string subpath = addPath(result, cat);
2740 // If we have a subdirectory for the category already,
2742 FileName sp = FileName(subpath);
2743 if (sp.isDirectory())
2746 // Ask whether we should create such a subdirectory
2747 docstring const text =
2748 bformat(_("It is suggested to save the template in a subdirectory\n"
2749 "appropriate to the layout category (%1$s).\n"
2750 "This subdirectory does not exists yet.\n"
2751 "Do you want to create it?"),
2753 if (Alert::prompt(_("Create Category Directory?"),
2754 text, 0, 1, _("&Yes, Create"), _("&No, Save Template in Parent Directory")) == 0) {
2755 // If the user agreed, we try to create it and report if this failed.
2756 if (!sp.createDirectory(0777))
2757 Alert::error(_("Subdirectory creation failed!"),
2758 _("Could not create subdirectory.\n"
2759 "The template will be saved in the parent directory."));
2769 bool GuiView::renameBuffer(Buffer & b, docstring const & newname, RenameKind kind)
2771 FileName fname = b.fileName();
2772 FileName const oldname = fname;
2773 bool const as_template = (kind == LV_WRITE_AS_TEMPLATE);
2775 if (!newname.empty()) {
2778 fname = support::makeAbsPath(to_utf8(newname), getTemplatesPath(b));
2780 fname = support::makeAbsPath(to_utf8(newname),
2781 oldname.onlyPath().absFileName());
2783 // Switch to this Buffer.
2786 // No argument? Ask user through dialog.
2788 QString const title = as_template ? qt_("Choose a filename to save template as")
2789 : qt_("Choose a filename to save document as");
2790 FileDialog dlg(title);
2791 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
2792 dlg.setButton2(qt_("&Templates"), toqstr(lyxrc.template_path));
2794 if (!isLyXFileName(fname.absFileName()))
2795 fname.changeExtension(".lyx");
2797 string const path = as_template ?
2799 : fname.onlyPath().absFileName();
2800 FileDialog::Result result =
2801 dlg.save(toqstr(path),
2802 QStringList(qt_("LyX Documents (*.lyx)")),
2803 toqstr(fname.onlyFileName()));
2805 if (result.first == FileDialog::Later)
2808 fname.set(fromqstr(result.second));
2813 if (!isLyXFileName(fname.absFileName()))
2814 fname.changeExtension(".lyx");
2817 // fname is now the new Buffer location.
2819 // if there is already a Buffer open with this name, we do not want
2820 // to have another one. (the second test makes sure we're not just
2821 // trying to overwrite ourselves, which is fine.)
2822 if (theBufferList().exists(fname) && fname != oldname
2823 && theBufferList().getBuffer(fname) != &b) {
2824 docstring const text =
2825 bformat(_("The file\n%1$s\nis already open in your current session.\n"
2826 "Please close it before attempting to overwrite it.\n"
2827 "Do you want to choose a new filename?"),
2828 from_utf8(fname.absFileName()));
2829 int const ret = Alert::prompt(_("Chosen File Already Open"),
2830 text, 0, 1, _("&Rename"), _("&Cancel"));
2832 case 0: return renameBuffer(b, docstring(), kind);
2833 case 1: return false;
2838 bool const existsLocal = fname.exists();
2839 bool const existsInVC = LyXVC::fileInVC(fname);
2840 if (existsLocal || existsInVC) {
2841 docstring const file = makeDisplayPath(fname.absFileName(), 30);
2842 if (kind != LV_WRITE_AS && existsInVC) {
2843 // renaming to a name that is already in VC
2845 docstring text = bformat(_("The document %1$s "
2846 "is already registered.\n\n"
2847 "Do you want to choose a new name?"),
2849 docstring const title = (kind == LV_VC_RENAME) ?
2850 _("Rename document?") : _("Copy document?");
2851 docstring const button = (kind == LV_VC_RENAME) ?
2852 _("&Rename") : _("&Copy");
2853 int const ret = Alert::prompt(title, text, 0, 1,
2854 button, _("&Cancel"));
2856 case 0: return renameBuffer(b, docstring(), kind);
2857 case 1: return false;
2862 docstring text = bformat(_("The document %1$s "
2863 "already exists.\n\n"
2864 "Do you want to overwrite that document?"),
2866 int const ret = Alert::prompt(_("Overwrite document?"),
2867 text, 0, 2, _("&Overwrite"),
2868 _("&Rename"), _("&Cancel"));
2871 case 1: return renameBuffer(b, docstring(), kind);
2872 case 2: return false;
2878 case LV_VC_RENAME: {
2879 string msg = b.lyxvc().rename(fname);
2882 message(from_utf8(msg));
2886 string msg = b.lyxvc().copy(fname);
2889 message(from_utf8(msg));
2893 case LV_WRITE_AS_TEMPLATE:
2896 // LyXVC created the file already in case of LV_VC_RENAME or
2897 // LV_VC_COPY, but call saveBuffer() nevertheless to get
2898 // relative paths of included stuff right if we moved e.g. from
2899 // /a/b.lyx to /a/c/b.lyx.
2901 bool const saved = saveBuffer(b, fname);
2908 bool GuiView::exportBufferAs(Buffer & b, docstring const & iformat)
2910 FileName fname = b.fileName();
2912 FileDialog dlg(qt_("Choose a filename to export the document as"));
2913 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
2916 QString const anyformat = qt_("Guess from extension (*.*)");
2919 vector<Format const *> export_formats;
2920 for (Format const & f : theFormats())
2921 if (f.documentFormat())
2922 export_formats.push_back(&f);
2923 sort(export_formats.begin(), export_formats.end(), Format::formatSorter);
2924 map<QString, string> fmap;
2927 for (Format const * f : export_formats) {
2928 docstring const loc_prettyname = translateIfPossible(f->prettyname());
2929 QString const loc_filter = toqstr(bformat(from_ascii("%1$s (*.%2$s)"),
2931 from_ascii(f->extension())));
2932 types << loc_filter;
2933 fmap[loc_filter] = f->name();
2934 if (from_ascii(f->name()) == iformat) {
2935 filter = loc_filter;
2936 ext = f->extension();
2939 string ofname = fname.onlyFileName();
2941 ofname = support::changeExtension(ofname, ext);
2942 FileDialog::Result result =
2943 dlg.save(toqstr(fname.onlyPath().absFileName()),
2947 if (result.first != FileDialog::Chosen)
2951 fname.set(fromqstr(result.second));
2952 if (filter == anyformat)
2953 fmt_name = theFormats().getFormatFromExtension(fname.extension());
2955 fmt_name = fmap[filter];
2956 LYXERR(Debug::FILES, "filter=" << fromqstr(filter)
2957 << ", fmt_name=" << fmt_name << ", fname=" << fname.absFileName());
2959 if (fmt_name.empty() || fname.empty())
2962 // fname is now the new Buffer location.
2963 if (FileName(fname).exists()) {
2964 docstring const file = makeDisplayPath(fname.absFileName(), 30);
2965 docstring text = bformat(_("The document %1$s already "
2966 "exists.\n\nDo you want to "
2967 "overwrite that document?"),
2969 int const ret = Alert::prompt(_("Overwrite document?"),
2970 text, 0, 2, _("&Overwrite"), _("&Rename"), _("&Cancel"));
2973 case 1: return exportBufferAs(b, from_ascii(fmt_name));
2974 case 2: return false;
2978 FuncRequest cmd(LFUN_BUFFER_EXPORT, fmt_name + " " + fname.absFileName());
2981 return dr.dispatched();
2985 bool GuiView::saveBuffer(Buffer & b)
2987 return saveBuffer(b, FileName());
2991 bool GuiView::saveBuffer(Buffer & b, FileName const & fn)
2993 if (workArea(b) && workArea(b)->inDialogMode())
2996 if (fn.empty() && b.isUnnamed())
2997 return renameBuffer(b, docstring());
2999 bool const success = (fn.empty() ? b.save() : b.saveAs(fn));
3001 theSession().lastFiles().add(b.fileName());
3002 theSession().writeFile();
3006 // Switch to this Buffer.
3009 // FIXME: we don't tell the user *WHY* the save failed !!
3010 docstring const file = makeDisplayPath(b.absFileName(), 30);
3011 docstring text = bformat(_("The document %1$s could not be saved.\n\n"
3012 "Do you want to rename the document and "
3013 "try again?"), file);
3014 int const ret = Alert::prompt(_("Rename and save?"),
3015 text, 0, 2, _("&Rename"), _("&Retry"), _("&Cancel"));
3018 if (!renameBuffer(b, docstring()))
3027 return saveBuffer(b, fn);
3031 bool GuiView::hideWorkArea(GuiWorkArea * wa)
3033 return closeWorkArea(wa, false);
3037 // We only want to close the buffer if it is not visible in other workareas
3038 // of the same view, nor in other views, and if this is not a child
3039 bool GuiView::closeWorkArea(GuiWorkArea * wa)
3041 Buffer & buf = wa->bufferView().buffer();
3043 bool last_wa = d.countWorkAreasOf(buf) == 1
3044 && !inOtherView(buf) && !buf.parent();
3046 bool close_buffer = last_wa;
3049 if (lyxrc.close_buffer_with_last_view == "yes")
3051 else if (lyxrc.close_buffer_with_last_view == "no")
3052 close_buffer = false;
3055 if (buf.isUnnamed())
3056 file = from_utf8(buf.fileName().onlyFileName());
3058 file = buf.fileName().displayName(30);
3059 docstring const text = bformat(
3060 _("Last view on document %1$s is being closed.\n"
3061 "Would you like to close or hide the document?\n"
3063 "Hidden documents can be displayed back through\n"
3064 "the menu: View->Hidden->...\n"
3066 "To remove this question, set your preference in:\n"
3067 " Tools->Preferences->Look&Feel->UserInterface\n"
3069 int ret = Alert::prompt(_("Close or hide document?"),
3070 text, 0, 1, _("&Close"), _("&Hide"));
3071 close_buffer = (ret == 0);
3075 return closeWorkArea(wa, close_buffer);
3079 bool GuiView::closeBuffer()
3081 GuiWorkArea * wa = currentMainWorkArea();
3082 // coverity complained about this
3083 // it seems unnecessary, but perhaps is worth the check
3084 LASSERT(wa, return false);
3086 setCurrentWorkArea(wa);
3087 Buffer & buf = wa->bufferView().buffer();
3088 return closeWorkArea(wa, !buf.parent());
3092 void GuiView::writeSession() const {
3093 GuiWorkArea const * active_wa = currentMainWorkArea();
3094 for (int i = 0; i < d.splitter_->count(); ++i) {
3095 TabWorkArea * twa = d.tabWorkArea(i);
3096 for (int j = 0; j < twa->count(); ++j) {
3097 GuiWorkArea * wa = twa->workArea(j);
3098 Buffer & buf = wa->bufferView().buffer();
3099 theSession().lastOpened().add(buf.fileName(), wa == active_wa);
3105 bool GuiView::closeBufferAll()
3107 // Close the workareas in all other views
3108 QList<int> const ids = guiApp->viewIds();
3109 for (int i = 0; i != ids.size(); ++i) {
3110 if (id_ != ids[i] && !guiApp->view(ids[i]).closeWorkAreaAll())
3114 // Close our own workareas
3115 if (!closeWorkAreaAll())
3118 // Now close the hidden buffers. We prevent hidden buffers from being
3119 // dirty, so we can just close them.
3120 theBufferList().closeAll();
3125 bool GuiView::closeWorkAreaAll()
3127 setCurrentWorkArea(currentMainWorkArea());
3129 // We might be in a situation that there is still a tabWorkArea, but
3130 // there are no tabs anymore. This can happen when we get here after a
3131 // TabWorkArea::lastWorkAreaRemoved() signal. Therefore we count how
3132 // many TabWorkArea's have no documents anymore.
3135 // We have to call count() each time, because it can happen that
3136 // more than one splitter will disappear in one iteration (bug 5998).
3137 while (d.splitter_->count() > empty_twa) {
3138 TabWorkArea * twa = d.tabWorkArea(empty_twa);
3140 if (twa->count() == 0)
3143 setCurrentWorkArea(twa->currentWorkArea());
3144 if (!closeTabWorkArea(twa))
3152 bool GuiView::closeWorkArea(GuiWorkArea * wa, bool close_buffer)
3157 Buffer & buf = wa->bufferView().buffer();
3159 if (GuiViewPrivate::busyBuffers.contains(&buf)) {
3160 Alert::warning(_("Close document"),
3161 _("Document could not be closed because it is being processed by LyX."));
3166 return closeBuffer(buf);
3168 if (!inMultiTabs(wa))
3169 if (!saveBufferIfNeeded(buf, true))
3177 bool GuiView::closeBuffer(Buffer & buf)
3179 bool success = true;
3180 ListOfBuffers clist = buf.getChildren();
3181 ListOfBuffers::const_iterator it = clist.begin();
3182 ListOfBuffers::const_iterator const bend = clist.end();
3183 for (; it != bend; ++it) {
3184 Buffer * child_buf = *it;
3185 if (theBufferList().isOthersChild(&buf, child_buf)) {
3186 child_buf->setParent(nullptr);
3190 // FIXME: should we look in other tabworkareas?
3191 // ANSWER: I don't think so. I've tested, and if the child is
3192 // open in some other window, it closes without a problem.
3193 GuiWorkArea * child_wa = workArea(*child_buf);
3196 // If we are in a close_event all children will be closed in some time,
3197 // so no need to do it here. This will ensure that the children end up
3198 // in the session file in the correct order. If we close the master
3199 // buffer, we can close or release the child buffers here too.
3201 success = closeWorkArea(child_wa, true);
3205 // In this case the child buffer is open but hidden.
3206 // Even in this case, children can be dirty (e.g.,
3207 // after a label change in the master, see #11405).
3208 // Therefore, check this
3209 if (closing_ && (child_buf->isClean() || child_buf->paragraphs().empty()))
3210 // If we are in a close_event all children will be closed in some time,
3211 // so no need to do it here. This will ensure that the children end up
3212 // in the session file in the correct order. If we close the master
3213 // buffer, we can close or release the child buffers here too.
3215 // Save dirty buffers also if closing_!
3216 if (saveBufferIfNeeded(*child_buf, false)) {
3217 child_buf->removeAutosaveFile();
3218 theBufferList().release(child_buf);
3220 // Saving of dirty children has been cancelled.
3221 // Cancel the whole process.
3228 // goto bookmark to update bookmark pit.
3229 // FIXME: we should update only the bookmarks related to this buffer!
3230 LYXERR(Debug::DEBUG, "GuiView::closeBuffer()");
3231 for (size_t i = 0; i < theSession().bookmarks().size(); ++i)
3232 guiApp->gotoBookmark(i+1, false, false);
3234 if (saveBufferIfNeeded(buf, false)) {
3235 buf.removeAutosaveFile();
3236 theBufferList().release(&buf);
3240 // open all children again to avoid a crash because of dangling
3241 // pointers (bug 6603)
3247 bool GuiView::closeTabWorkArea(TabWorkArea * twa)
3249 while (twa == d.currentTabWorkArea()) {
3250 twa->setCurrentIndex(twa->count() - 1);
3252 GuiWorkArea * wa = twa->currentWorkArea();
3253 Buffer & b = wa->bufferView().buffer();
3255 // We only want to close the buffer if the same buffer is not visible
3256 // in another view, and if this is not a child and if we are closing
3257 // a view (not a tabgroup).
3258 bool const close_buffer =
3259 !inOtherView(b) && !b.parent() && closing_;
3261 if (!closeWorkArea(wa, close_buffer))
3268 bool GuiView::saveBufferIfNeeded(Buffer & buf, bool hiding)
3270 if (buf.isClean() || buf.paragraphs().empty())
3273 // Switch to this Buffer.
3279 if (buf.isUnnamed()) {
3280 file = from_utf8(buf.fileName().onlyFileName());
3283 FileName filename = buf.fileName();
3285 file = filename.displayName(30);
3286 exists = filename.exists();
3289 // Bring this window to top before asking questions.
3294 if (hiding && buf.isUnnamed()) {
3295 docstring const text = bformat(_("The document %1$s has not been "
3296 "saved yet.\n\nDo you want to save "
3297 "the document?"), file);
3298 ret = Alert::prompt(_("Save new document?"),
3299 text, 0, 1, _("&Save"), _("&Cancel"));
3303 docstring const text = exists ?
3304 bformat(_("The document %1$s has unsaved changes."
3305 "\n\nDo you want to save the document or "
3306 "discard the changes?"), file) :
3307 bformat(_("The document %1$s has not been saved yet."
3308 "\n\nDo you want to save the document or "
3309 "discard it entirely?"), file);
3310 docstring const title = exists ?
3311 _("Save changed document?") : _("Save document?");
3312 ret = Alert::prompt(title, text, 0, 2,
3313 _("&Save"), _("&Discard"), _("&Cancel"));
3318 if (!saveBuffer(buf))
3322 // If we crash after this we could have no autosave file
3323 // but I guess this is really improbable (Jug).
3324 // Sometimes improbable things happen:
3325 // - see bug http://www.lyx.org/trac/ticket/6587 (ps)
3326 // buf.removeAutosaveFile();
3328 // revert all changes
3339 bool GuiView::inMultiTabs(GuiWorkArea * wa)
3341 Buffer & buf = wa->bufferView().buffer();
3343 for (int i = 0; i != d.splitter_->count(); ++i) {
3344 GuiWorkArea * wa_ = d.tabWorkArea(i)->workArea(buf);
3345 if (wa_ && wa_ != wa)
3348 return inOtherView(buf);
3352 bool GuiView::inOtherView(Buffer & buf)
3354 QList<int> const ids = guiApp->viewIds();
3356 for (int i = 0; i != ids.size(); ++i) {
3360 if (guiApp->view(ids[i]).workArea(buf))
3367 void GuiView::gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move)
3369 if (!documentBufferView())
3372 if (TabWorkArea * twa = d.currentTabWorkArea()) {
3373 Buffer * const curbuf = &documentBufferView()->buffer();
3374 int nwa = twa->count();
3375 for (int i = 0; i < nwa; ++i) {
3376 if (&workArea(i)->bufferView().buffer() == curbuf) {
3378 if (np == NEXTBUFFER)
3379 next_index = (i == nwa - 1 ? 0 : i + 1);
3381 next_index = (i == 0 ? nwa - 1 : i - 1);
3383 twa->moveTab(i, next_index);
3385 setBuffer(&workArea(next_index)->bufferView().buffer());
3393 /// make sure the document is saved
3394 static bool ensureBufferClean(Buffer * buffer)
3396 LASSERT(buffer, return false);
3397 if (buffer->isClean() && !buffer->isUnnamed())
3400 docstring const file = buffer->fileName().displayName(30);
3403 if (!buffer->isUnnamed()) {
3404 text = bformat(_("The document %1$s has unsaved "
3405 "changes.\n\nDo you want to save "
3406 "the document?"), file);
3407 title = _("Save changed document?");
3410 text = bformat(_("The document %1$s has not been "
3411 "saved yet.\n\nDo you want to save "
3412 "the document?"), file);
3413 title = _("Save new document?");
3415 int const ret = Alert::prompt(title, text, 0, 1, _("&Save"), _("&Cancel"));
3418 dispatch(FuncRequest(LFUN_BUFFER_WRITE));
3420 return buffer->isClean() && !buffer->isUnnamed();
3424 bool GuiView::reloadBuffer(Buffer & buf)
3426 currentBufferView()->cursor().reset();
3427 Buffer::ReadStatus status = buf.reload();
3428 return status == Buffer::ReadSuccess;
3432 void GuiView::checkExternallyModifiedBuffers()
3434 BufferList::iterator bit = theBufferList().begin();
3435 BufferList::iterator const bend = theBufferList().end();
3436 for (; bit != bend; ++bit) {
3437 Buffer * buf = *bit;
3438 if (buf->fileName().exists() && buf->isChecksumModified()) {
3439 docstring text = bformat(_("Document \n%1$s\n has been externally modified."
3440 " Reload now? Any local changes will be lost."),
3441 from_utf8(buf->absFileName()));
3442 int const ret = Alert::prompt(_("Reload externally changed document?"),
3443 text, 0, 1, _("&Reload"), _("&Cancel"));
3451 void GuiView::dispatchVC(FuncRequest const & cmd, DispatchResult & dr)
3453 Buffer * buffer = documentBufferView()
3454 ? &(documentBufferView()->buffer()) : nullptr;
3456 switch (cmd.action()) {
3457 case LFUN_VC_REGISTER:
3458 if (!buffer || !ensureBufferClean(buffer))
3460 if (!buffer->lyxvc().inUse()) {
3461 if (buffer->lyxvc().registrer()) {
3462 reloadBuffer(*buffer);
3463 dr.clearMessageUpdate();
3468 case LFUN_VC_RENAME:
3469 case LFUN_VC_COPY: {
3470 if (!buffer || !ensureBufferClean(buffer))
3472 if (buffer->lyxvc().inUse() && !buffer->hasReadonlyFlag()) {
3473 if (buffer->lyxvc().isCheckInWithConfirmation()) {
3474 // Some changes are not yet committed.
3475 // We test here and not in getStatus(), since
3476 // this test is expensive.
3478 LyXVC::CommandResult ret =
3479 buffer->lyxvc().checkIn(log);
3481 if (ret == LyXVC::ErrorCommand ||
3482 ret == LyXVC::VCSuccess)
3483 reloadBuffer(*buffer);
3484 if (buffer->lyxvc().isCheckInWithConfirmation()) {
3485 frontend::Alert::error(
3486 _("Revision control error."),
3487 _("Document could not be checked in."));
3491 RenameKind const kind = (cmd.action() == LFUN_VC_RENAME) ?
3492 LV_VC_RENAME : LV_VC_COPY;
3493 renameBuffer(*buffer, cmd.argument(), kind);
3498 case LFUN_VC_CHECK_IN:
3499 if (!buffer || !ensureBufferClean(buffer))
3501 if (buffer->lyxvc().inUse() && !buffer->hasReadonlyFlag()) {
3503 LyXVC::CommandResult ret = buffer->lyxvc().checkIn(log);
3505 // Only skip reloading if the checkin was cancelled or
3506 // an error occurred before the real checkin VCS command
3507 // was executed, since the VCS might have changed the
3508 // file even if it could not checkin successfully.
3509 if (ret == LyXVC::ErrorCommand || ret == LyXVC::VCSuccess)
3510 reloadBuffer(*buffer);
3514 case LFUN_VC_CHECK_OUT:
3515 if (!buffer || !ensureBufferClean(buffer))
3517 if (buffer->lyxvc().inUse()) {
3518 dr.setMessage(buffer->lyxvc().checkOut());
3519 reloadBuffer(*buffer);
3523 case LFUN_VC_LOCKING_TOGGLE:
3524 if (!buffer || !ensureBufferClean(buffer) || buffer->hasReadonlyFlag())
3526 if (buffer->lyxvc().inUse()) {
3527 string res = buffer->lyxvc().lockingToggle();
3529 frontend::Alert::error(_("Revision control error."),
3530 _("Error when setting the locking property."));
3533 reloadBuffer(*buffer);
3538 case LFUN_VC_REVERT:
3541 if (buffer->lyxvc().revert()) {
3542 reloadBuffer(*buffer);
3543 dr.clearMessageUpdate();
3547 case LFUN_VC_UNDO_LAST:
3550 buffer->lyxvc().undoLast();
3551 reloadBuffer(*buffer);
3552 dr.clearMessageUpdate();
3555 case LFUN_VC_REPO_UPDATE:
3558 if (ensureBufferClean(buffer)) {
3559 dr.setMessage(buffer->lyxvc().repoUpdate());
3560 checkExternallyModifiedBuffers();
3564 case LFUN_VC_COMMAND: {
3565 string flag = cmd.getArg(0);
3566 if (buffer && contains(flag, 'R') && !ensureBufferClean(buffer))
3569 if (contains(flag, 'M')) {
3570 if (!Alert::askForText(message, _("LyX VC: Log Message")))
3573 string path = cmd.getArg(1);
3574 if (contains(path, "$$p") && buffer)
3575 path = subst(path, "$$p", buffer->filePath());
3576 LYXERR(Debug::LYXVC, "Directory: " << path);
3578 if (!pp.isReadableDirectory()) {
3579 lyxerr << _("Directory is not accessible.") << endl;
3582 support::PathChanger p(pp);
3584 string command = cmd.getArg(2);
3585 if (command.empty())
3588 command = subst(command, "$$i", buffer->absFileName());
3589 command = subst(command, "$$p", buffer->filePath());
3591 command = subst(command, "$$m", to_utf8(message));
3592 LYXERR(Debug::LYXVC, "Command: " << command);
3594 one.startscript(Systemcall::Wait, command);
3598 if (contains(flag, 'I'))
3599 buffer->markDirty();
3600 if (contains(flag, 'R'))
3601 reloadBuffer(*buffer);
3606 case LFUN_VC_COMPARE: {
3607 if (cmd.argument().empty()) {
3608 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "comparehistory"));
3614 string rev1 = cmd.getArg(0);
3618 if (!buffer->lyxvc().prepareFileRevision(rev1, f1))
3621 if (isStrInt(rev1) && convert<int>(rev1) <= 0) {
3622 f2 = buffer->absFileName();
3624 string rev2 = cmd.getArg(1);
3628 if (!buffer->lyxvc().prepareFileRevision(rev2, f2))
3632 LYXERR(Debug::LYXVC, "Launching comparison for fetched revisions:\n" <<
3633 f1 << "\n" << f2 << "\n" );
3634 string par = "compare run " + quoteName(f1) + " " + quoteName(f2);
3635 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
3645 void GuiView::openChildDocument(string const & fname)
3647 LASSERT(documentBufferView(), return);
3648 Buffer & buffer = documentBufferView()->buffer();
3649 FileName const filename = support::makeAbsPath(fname, buffer.filePath());
3650 documentBufferView()->saveBookmark(false);
3651 Buffer * child = nullptr;
3652 if (theBufferList().exists(filename)) {
3653 child = theBufferList().getBuffer(filename);
3656 message(bformat(_("Opening child document %1$s..."),
3657 makeDisplayPath(filename.absFileName())));
3658 child = loadDocument(filename, false);
3660 // Set the parent name of the child document.
3661 // This makes insertion of citations and references in the child work,
3662 // when the target is in the parent or another child document.
3664 child->setParent(&buffer);
3668 bool GuiView::goToFileRow(string const & argument)
3672 size_t i = argument.find_last_of(' ');
3673 if (i != string::npos) {
3674 file_name = os::internal_path(FileName(trim(argument.substr(0, i))).realPath());
3675 istringstream is(argument.substr(i + 1));
3680 if (i == string::npos) {
3681 LYXERR0("Wrong argument: " << argument);
3684 Buffer * buf = nullptr;
3685 string const realtmp = package().temp_dir().realPath();
3686 // We have to use os::path_prefix_is() here, instead of
3687 // simply prefixIs(), because the file name comes from
3688 // an external application and may need case adjustment.
3689 if (os::path_prefix_is(file_name, realtmp, os::CASE_ADJUSTED)) {
3690 buf = theBufferList().getBufferFromTmp(file_name, true);
3691 LYXERR(Debug::FILES, "goToFileRow: buffer lookup for " << file_name
3692 << (buf ? " success" : " failed"));
3694 // Must replace extension of the file to be .lyx
3695 // and get full path
3696 FileName const s = fileSearch(string(),
3697 support::changeExtension(file_name, ".lyx"), "lyx");
3698 // Either change buffer or load the file
3699 if (theBufferList().exists(s))
3700 buf = theBufferList().getBuffer(s);
3701 else if (s.exists()) {
3702 buf = loadDocument(s);
3707 _("File does not exist: %1$s"),
3708 makeDisplayPath(file_name)));
3714 _("No buffer for file: %1$s."),
3715 makeDisplayPath(file_name))
3720 bool success = documentBufferView()->setCursorFromRow(row);
3722 LYXERR(Debug::LATEX,
3723 "setCursorFromRow: invalid position for row " << row);
3724 frontend::Alert::error(_("Inverse Search Failed"),
3725 _("Invalid position requested by inverse search.\n"
3726 "You may need to update the viewed document."));
3732 void GuiView::toolBarPopup(const QPoint & /*pos*/)
3734 QMenu * menu = guiApp->menus().menu(toqstr("context-toolbars"), * this);
3735 menu->exec(QCursor::pos());
3740 Buffer::ExportStatus GuiView::GuiViewPrivate::runAndDestroy(const T& func,
3741 Buffer const * orig, Buffer * clone, string const & format)
3743 Buffer::ExportStatus const status = func(format);
3745 // the cloning operation will have produced a clone of the entire set of
3746 // documents, starting from the master. so we must delete those.
3747 Buffer * mbuf = const_cast<Buffer *>(clone->masterBuffer());
3749 busyBuffers.remove(orig);
3754 Buffer::ExportStatus GuiView::GuiViewPrivate::compileAndDestroy(
3755 Buffer const * orig, Buffer * clone, string const & format)
3757 Buffer::ExportStatus (Buffer::* mem_func)(std::string const &, bool) const =
3759 return runAndDestroy(lyx::bind(mem_func, clone, _1, true), orig, clone, format);
3763 Buffer::ExportStatus GuiView::GuiViewPrivate::exportAndDestroy(
3764 Buffer const * orig, Buffer * clone, string const & format)
3766 Buffer::ExportStatus (Buffer::* mem_func)(std::string const &, bool) const =
3768 return runAndDestroy(lyx::bind(mem_func, clone, _1, false), orig, clone, format);
3772 Buffer::ExportStatus GuiView::GuiViewPrivate::previewAndDestroy(
3773 Buffer const * orig, Buffer * clone, string const & format)
3775 Buffer::ExportStatus (Buffer::* mem_func)(std::string const &) const =
3777 return runAndDestroy(lyx::bind(mem_func, clone, _1), orig, clone, format);
3781 bool GuiView::GuiViewPrivate::asyncBufferProcessing(
3782 string const & argument,
3783 Buffer const * used_buffer,
3784 docstring const & msg,
3785 Buffer::ExportStatus (*asyncFunc)(Buffer const *, Buffer *, string const &),
3786 Buffer::ExportStatus (Buffer::*syncFunc)(string const &, bool) const,
3787 Buffer::ExportStatus (Buffer::*previewFunc)(string const &) const,
3793 string format = argument;
3795 format = used_buffer->params().getDefaultOutputFormat();
3796 processing_format = format;
3798 progress_->clearMessages();
3801 #if EXPORT_in_THREAD
3803 GuiViewPrivate::busyBuffers.insert(used_buffer);
3804 Buffer * cloned_buffer = used_buffer->cloneWithChildren();
3805 if (!cloned_buffer) {
3806 Alert::error(_("Export Error"),
3807 _("Error cloning the Buffer."));
3810 QFuture<Buffer::ExportStatus> f = QtConcurrent::run(
3815 setPreviewFuture(f);
3816 last_export_format = used_buffer->params().bufferFormat();
3819 // We are asynchronous, so we don't know here anything about the success
3822 Buffer::ExportStatus status;
3824 status = (used_buffer->*syncFunc)(format, false);
3825 } else if (previewFunc) {
3826 status = (used_buffer->*previewFunc)(format);
3829 handleExportStatus(gv_, status, format);
3831 return (status == Buffer::ExportSuccess
3832 || status == Buffer::PreviewSuccess);
3836 Buffer::ExportStatus status;
3838 status = (used_buffer->*syncFunc)(format, true);
3839 } else if (previewFunc) {
3840 status = (used_buffer->*previewFunc)(format);
3843 handleExportStatus(gv_, status, format);
3845 return (status == Buffer::ExportSuccess
3846 || status == Buffer::PreviewSuccess);
3850 void GuiView::dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr)
3852 BufferView * bv = currentBufferView();
3853 LASSERT(bv, return);
3855 // Let the current BufferView dispatch its own actions.
3856 bv->dispatch(cmd, dr);
3857 if (dr.dispatched()) {
3858 if (cmd.action() == LFUN_REDO || cmd.action() == LFUN_UNDO)
3859 updateDialog("document", "");
3863 // Try with the document BufferView dispatch if any.
3864 BufferView * doc_bv = documentBufferView();
3865 if (doc_bv && doc_bv != bv) {
3866 doc_bv->dispatch(cmd, dr);
3867 if (dr.dispatched()) {
3868 if (cmd.action() == LFUN_REDO || cmd.action() == LFUN_UNDO)
3869 updateDialog("document", "");
3874 // Then let the current Cursor dispatch its own actions.
3875 bv->cursor().dispatch(cmd);
3877 // update completion. We do it here and not in
3878 // processKeySym to avoid another redraw just for a
3879 // changed inline completion
3880 if (cmd.origin() == FuncRequest::KEYBOARD) {
3881 if (cmd.action() == LFUN_SELF_INSERT
3882 || (cmd.action() == LFUN_ERT_INSERT && bv->cursor().inMathed()))
3883 updateCompletion(bv->cursor(), true, true);
3884 else if (cmd.action() == LFUN_CHAR_DELETE_BACKWARD)
3885 updateCompletion(bv->cursor(), false, true);
3887 updateCompletion(bv->cursor(), false, false);
3890 dr = bv->cursor().result();
3894 void GuiView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
3896 BufferView * bv = currentBufferView();
3897 // By default we won't need any update.
3898 dr.screenUpdate(Update::None);
3899 // assume cmd will be dispatched
3900 dr.dispatched(true);
3902 Buffer * doc_buffer = documentBufferView()
3903 ? &(documentBufferView()->buffer()) : nullptr;
3905 if (cmd.origin() == FuncRequest::TOC) {
3906 GuiToc * toc = static_cast<GuiToc*>(findOrBuild("toc", false));
3907 // FIXME: do we need to pass a DispatchResult object here?
3908 toc->doDispatch(bv->cursor(), cmd);
3912 string const argument = to_utf8(cmd.argument());
3914 switch(cmd.action()) {
3915 case LFUN_BUFFER_CHILD_OPEN:
3916 openChildDocument(to_utf8(cmd.argument()));
3919 case LFUN_BUFFER_IMPORT:
3920 importDocument(to_utf8(cmd.argument()));
3923 case LFUN_MASTER_BUFFER_EXPORT:
3925 doc_buffer = const_cast<Buffer *>(doc_buffer->masterBuffer());
3927 case LFUN_BUFFER_EXPORT: {
3930 // GCC only sees strfwd.h when building merged
3931 if (::lyx::operator==(cmd.argument(), "custom")) {
3932 // LFUN_MASTER_BUFFER_EXPORT is not enabled for this case,
3933 // so the following test should not be needed.
3934 // In principle, we could try to switch to such a view...
3935 // if (cmd.action() == LFUN_BUFFER_EXPORT)
3936 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "sendto"), dr);
3940 string const dest = cmd.getArg(1);
3941 FileName target_dir;
3942 if (!dest.empty() && FileName::isAbsolute(dest))
3943 target_dir = FileName(support::onlyPath(dest));
3945 target_dir = doc_buffer->fileName().onlyPath();
3947 string const format = (argument.empty() || argument == "default") ?
3948 doc_buffer->params().getDefaultOutputFormat() : argument;
3950 if ((dest.empty() && doc_buffer->isUnnamed())
3951 || !target_dir.isDirWritable()) {
3952 exportBufferAs(*doc_buffer, from_utf8(format));
3955 /* TODO/Review: Is it a problem to also export the children?
3956 See the update_unincluded flag */
3957 d.asyncBufferProcessing(format,
3960 &GuiViewPrivate::exportAndDestroy,
3962 nullptr, cmd.allowAsync());
3963 // TODO Inform user about success
3967 case LFUN_BUFFER_EXPORT_AS: {
3968 LASSERT(doc_buffer, break);
3969 docstring f = cmd.argument();
3971 f = from_ascii(doc_buffer->params().getDefaultOutputFormat());
3972 exportBufferAs(*doc_buffer, f);
3976 case LFUN_BUFFER_UPDATE: {
3977 d.asyncBufferProcessing(argument,
3980 &GuiViewPrivate::compileAndDestroy,
3982 nullptr, cmd.allowAsync());
3985 case LFUN_BUFFER_VIEW: {
3986 d.asyncBufferProcessing(argument,
3988 _("Previewing ..."),
3989 &GuiViewPrivate::previewAndDestroy,
3991 &Buffer::preview, cmd.allowAsync());
3994 case LFUN_MASTER_BUFFER_UPDATE: {
3995 d.asyncBufferProcessing(argument,
3996 (doc_buffer ? doc_buffer->masterBuffer() : nullptr),
3998 &GuiViewPrivate::compileAndDestroy,
4000 nullptr, cmd.allowAsync());
4003 case LFUN_MASTER_BUFFER_VIEW: {
4004 d.asyncBufferProcessing(argument,
4005 (doc_buffer ? doc_buffer->masterBuffer() : nullptr),
4007 &GuiViewPrivate::previewAndDestroy,
4008 nullptr, &Buffer::preview, cmd.allowAsync());
4011 case LFUN_EXPORT_CANCEL: {
4012 Systemcall::killscript();
4015 case LFUN_BUFFER_SWITCH: {
4016 string const file_name = to_utf8(cmd.argument());
4017 if (!FileName::isAbsolute(file_name)) {
4019 dr.setMessage(_("Absolute filename expected."));
4023 Buffer * buffer = theBufferList().getBuffer(FileName(file_name));
4026 dr.setMessage(_("Document not loaded"));
4030 // Do we open or switch to the buffer in this view ?
4031 if (workArea(*buffer)
4032 || lyxrc.open_buffers_in_tabs || !documentBufferView()) {
4037 // Look for the buffer in other views
4038 QList<int> const ids = guiApp->viewIds();
4040 for (; i != ids.size(); ++i) {
4041 GuiView & gv = guiApp->view(ids[i]);
4042 if (gv.workArea(*buffer)) {
4044 gv.activateWindow();
4046 gv.setBuffer(buffer);
4051 // If necessary, open a new window as a last resort
4052 if (i == ids.size()) {
4053 lyx::dispatch(FuncRequest(LFUN_WINDOW_NEW));
4059 case LFUN_BUFFER_NEXT:
4060 gotoNextOrPreviousBuffer(NEXTBUFFER, false);
4063 case LFUN_BUFFER_MOVE_NEXT:
4064 gotoNextOrPreviousBuffer(NEXTBUFFER, true);
4067 case LFUN_BUFFER_PREVIOUS:
4068 gotoNextOrPreviousBuffer(PREVBUFFER, false);
4071 case LFUN_BUFFER_MOVE_PREVIOUS:
4072 gotoNextOrPreviousBuffer(PREVBUFFER, true);
4075 case LFUN_BUFFER_CHKTEX:
4076 LASSERT(doc_buffer, break);
4077 doc_buffer->runChktex();
4080 case LFUN_COMMAND_EXECUTE: {
4081 command_execute_ = true;
4082 minibuffer_focus_ = true;
4085 case LFUN_DROP_LAYOUTS_CHOICE:
4086 d.layout_->showPopup();
4089 case LFUN_MENU_OPEN:
4090 if (QMenu * menu = guiApp->menus().menu(toqstr(cmd.argument()), *this))
4091 menu->exec(QCursor::pos());
4094 case LFUN_FILE_INSERT: {
4095 if (cmd.getArg(1) == "ignorelang")
4096 insertLyXFile(from_utf8(cmd.getArg(0)), true);
4098 insertLyXFile(cmd.argument());
4102 case LFUN_FILE_INSERT_PLAINTEXT:
4103 case LFUN_FILE_INSERT_PLAINTEXT_PARA: {
4104 string const fname = to_utf8(cmd.argument());
4105 if (!fname.empty() && !FileName::isAbsolute(fname)) {
4106 dr.setMessage(_("Absolute filename expected."));
4110 FileName filename(fname);
4111 if (fname.empty()) {
4112 FileDialog dlg(qt_("Select file to insert"));
4114 FileDialog::Result result = dlg.open(toqstr(bv->buffer().filePath()),
4115 QStringList(qt_("All Files (*)")));
4117 if (result.first == FileDialog::Later || result.second.isEmpty()) {
4118 dr.setMessage(_("Canceled."));
4122 filename.set(fromqstr(result.second));
4126 FuncRequest const new_cmd(cmd, filename.absoluteFilePath());
4127 bv->dispatch(new_cmd, dr);
4132 case LFUN_BUFFER_RELOAD: {
4133 LASSERT(doc_buffer, break);
4136 bool drop = (cmd.argument() == "dump");
4139 if (!drop && !doc_buffer->isClean()) {
4140 docstring const file =
4141 makeDisplayPath(doc_buffer->absFileName(), 20);
4142 if (doc_buffer->notifiesExternalModification()) {
4143 docstring text = _("The current version will be lost. "
4144 "Are you sure you want to load the version on disk "
4145 "of the document %1$s?");
4146 ret = Alert::prompt(_("Reload saved document?"),
4147 bformat(text, file), 1, 1,
4148 _("&Reload"), _("&Cancel"));
4150 docstring text = _("Any changes will be lost. "
4151 "Are you sure you want to revert to the saved version "
4152 "of the document %1$s?");
4153 ret = Alert::prompt(_("Revert to saved document?"),
4154 bformat(text, file), 1, 1,
4155 _("&Revert"), _("&Cancel"));
4160 doc_buffer->markClean();
4161 reloadBuffer(*doc_buffer);
4162 dr.forceBufferUpdate();
4167 case LFUN_BUFFER_RESET_EXPORT:
4168 LASSERT(doc_buffer, break);
4169 doc_buffer->requireFreshStart(true);
4170 dr.setMessage(_("Buffer export reset."));
4173 case LFUN_BUFFER_WRITE:
4174 LASSERT(doc_buffer, break);
4175 saveBuffer(*doc_buffer);
4178 case LFUN_BUFFER_WRITE_AS:
4179 LASSERT(doc_buffer, break);
4180 renameBuffer(*doc_buffer, cmd.argument());
4183 case LFUN_BUFFER_WRITE_AS_TEMPLATE:
4184 LASSERT(doc_buffer, break);
4185 renameBuffer(*doc_buffer, cmd.argument(),
4186 LV_WRITE_AS_TEMPLATE);
4189 case LFUN_BUFFER_WRITE_ALL: {
4190 Buffer * first = theBufferList().first();
4193 message(_("Saving all documents..."));
4194 // We cannot use a for loop as the buffer list cycles.
4197 if (!b->isClean()) {
4199 LYXERR(Debug::ACTION, "Saved " << b->absFileName());
4201 b = theBufferList().next(b);
4202 } while (b != first);
4203 dr.setMessage(_("All documents saved."));
4207 case LFUN_MASTER_BUFFER_FORALL: {
4211 FuncRequest funcToRun = lyxaction.lookupFunc(cmd.getLongArg(0));
4212 funcToRun.allowAsync(false);
4214 for (Buffer const * buf : doc_buffer->allRelatives()) {
4215 // Switch to other buffer view and resend cmd
4216 lyx::dispatch(FuncRequest(
4217 LFUN_BUFFER_SWITCH, buf->absFileName()));
4218 lyx::dispatch(funcToRun);
4221 lyx::dispatch(FuncRequest(
4222 LFUN_BUFFER_SWITCH, doc_buffer->absFileName()));
4226 case LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR:
4227 LASSERT(doc_buffer, break);
4228 doc_buffer->clearExternalModification();
4231 case LFUN_BUFFER_CLOSE:
4235 case LFUN_BUFFER_CLOSE_ALL:
4239 case LFUN_DEVEL_MODE_TOGGLE:
4240 devel_mode_ = !devel_mode_;
4242 dr.setMessage(_("Developer mode is now enabled."));
4244 dr.setMessage(_("Developer mode is now disabled."));
4247 case LFUN_TOOLBAR_TOGGLE: {
4248 string const name = cmd.getArg(0);
4249 if (GuiToolbar * t = toolbar(name))
4254 case LFUN_TOOLBAR_MOVABLE: {
4255 string const name = cmd.getArg(0);
4257 // toggle (all) toolbars movablility
4258 toolbarsMovable_ = !toolbarsMovable_;
4259 for (ToolbarInfo const & ti : guiApp->toolbars()) {
4260 GuiToolbar * tb = toolbar(ti.name);
4261 if (tb && tb->isMovable() != toolbarsMovable_)
4262 // toggle toolbar movablity if it does not fit lock
4263 // (all) toolbars positions state silent = true, since
4264 // status bar notifications are slow
4267 if (toolbarsMovable_)
4268 dr.setMessage(_("Toolbars unlocked."));
4270 dr.setMessage(_("Toolbars locked."));
4271 } else if (GuiToolbar * t = toolbar(name)) {
4272 // toggle current toolbar movablity
4274 // update lock (all) toolbars positions
4275 updateLockToolbars();
4280 case LFUN_ICON_SIZE: {
4281 QSize size = d.iconSize(cmd.argument());
4283 dr.setMessage(bformat(_("Icon size set to %1$dx%2$d."),
4284 size.width(), size.height()));
4288 case LFUN_DIALOG_UPDATE: {
4289 string const name = to_utf8(cmd.argument());
4290 if (name == "prefs" || name == "document")
4291 updateDialog(name, string());
4292 else if (name == "paragraph")
4293 lyx::dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
4294 else if (currentBufferView()) {
4295 Inset * inset = currentBufferView()->editedInset(name);
4296 // Can only update a dialog connected to an existing inset
4298 // FIXME: get rid of this indirection; GuiView ask the inset
4299 // if he is kind enough to update itself...
4300 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument());
4301 //FIXME: pass DispatchResult here?
4302 inset->dispatch(currentBufferView()->cursor(), fr);
4308 case LFUN_DIALOG_TOGGLE: {
4309 FuncCode const func_code = isDialogVisible(cmd.getArg(0))
4310 ? LFUN_DIALOG_HIDE : LFUN_DIALOG_SHOW;
4311 dispatch(FuncRequest(func_code, cmd.argument()), dr);
4315 case LFUN_DIALOG_DISCONNECT_INSET:
4316 disconnectDialog(to_utf8(cmd.argument()));
4319 case LFUN_DIALOG_HIDE: {
4320 guiApp->hideDialogs(to_utf8(cmd.argument()), nullptr);
4324 case LFUN_DIALOG_SHOW: {
4325 string const name = cmd.getArg(0);
4326 string sdata = trim(to_utf8(cmd.argument()).substr(name.size()));
4328 if (name == "latexlog") {
4329 // getStatus checks that
4330 LASSERT(doc_buffer, break);
4331 Buffer::LogType type;
4332 string const logfile = doc_buffer->logName(&type);
4334 case Buffer::latexlog:
4337 case Buffer::buildlog:
4338 sdata = "literate ";
4341 sdata += Lexer::quoteString(logfile);
4342 showDialog("log", sdata);
4343 } else if (name == "vclog") {
4344 // getStatus checks that
4345 LASSERT(doc_buffer, break);
4346 string const sdata2 = "vc " +
4347 Lexer::quoteString(doc_buffer->lyxvc().getLogFile());
4348 showDialog("log", sdata2);
4349 } else if (name == "symbols") {
4350 sdata = bv->cursor().getEncoding()->name();
4352 showDialog("symbols", sdata);
4354 } else if (name == "prefs" && isFullScreen()) {
4355 lfunUiToggle("fullscreen");
4356 showDialog("prefs", sdata);
4358 showDialog(name, sdata);
4363 dr.setMessage(cmd.argument());
4366 case LFUN_UI_TOGGLE: {
4367 string arg = cmd.getArg(0);
4368 if (!lfunUiToggle(arg)) {
4369 docstring const msg = "ui-toggle " + _("%1$s unknown command!");
4370 dr.setMessage(bformat(msg, from_utf8(arg)));
4372 // Make sure the keyboard focus stays in the work area.
4377 case LFUN_VIEW_SPLIT: {
4378 LASSERT(doc_buffer, break);
4379 string const orientation = cmd.getArg(0);
4380 d.splitter_->setOrientation(orientation == "vertical"
4381 ? Qt::Vertical : Qt::Horizontal);
4382 TabWorkArea * twa = addTabWorkArea();
4383 GuiWorkArea * wa = twa->addWorkArea(*doc_buffer, *this);
4384 setCurrentWorkArea(wa);
4387 case LFUN_TAB_GROUP_CLOSE:
4388 if (TabWorkArea * twa = d.currentTabWorkArea()) {
4389 closeTabWorkArea(twa);
4390 d.current_work_area_ = nullptr;
4391 twa = d.currentTabWorkArea();
4392 // Switch to the next GuiWorkArea in the found TabWorkArea.
4394 // Make sure the work area is up to date.
4395 setCurrentWorkArea(twa->currentWorkArea());
4397 setCurrentWorkArea(nullptr);
4402 case LFUN_VIEW_CLOSE:
4403 if (TabWorkArea * twa = d.currentTabWorkArea()) {
4404 closeWorkArea(twa->currentWorkArea());
4405 d.current_work_area_ = nullptr;
4406 twa = d.currentTabWorkArea();
4407 // Switch to the next GuiWorkArea in the found TabWorkArea.
4409 // Make sure the work area is up to date.
4410 setCurrentWorkArea(twa->currentWorkArea());
4412 setCurrentWorkArea(nullptr);
4417 case LFUN_COMPLETION_INLINE:
4418 if (d.current_work_area_)
4419 d.current_work_area_->completer().showInline();
4422 case LFUN_COMPLETION_POPUP:
4423 if (d.current_work_area_)
4424 d.current_work_area_->completer().showPopup();
4429 if (d.current_work_area_)
4430 d.current_work_area_->completer().tab();
4433 case LFUN_COMPLETION_CANCEL:
4434 if (d.current_work_area_) {
4435 if (d.current_work_area_->completer().popupVisible())
4436 d.current_work_area_->completer().hidePopup();
4438 d.current_work_area_->completer().hideInline();
4442 case LFUN_COMPLETION_ACCEPT:
4443 if (d.current_work_area_)
4444 d.current_work_area_->completer().activate();
4447 case LFUN_BUFFER_ZOOM_IN:
4448 case LFUN_BUFFER_ZOOM_OUT:
4449 case LFUN_BUFFER_ZOOM: {
4450 if (cmd.argument().empty()) {
4451 if (cmd.action() == LFUN_BUFFER_ZOOM)
4453 else if (cmd.action() == LFUN_BUFFER_ZOOM_IN)
4458 if (cmd.action() == LFUN_BUFFER_ZOOM)
4459 zoom_ratio_ = convert<int>(cmd.argument()) / double(lyxrc.defaultZoom);
4460 else if (cmd.action() == LFUN_BUFFER_ZOOM_IN)
4461 zoom_ratio_ += convert<int>(cmd.argument()) / 100.0;
4463 zoom_ratio_ -= convert<int>(cmd.argument()) / 100.0;
4466 // Actual zoom value: default zoom + fractional extra value
4467 int zoom = (int)(lyxrc.defaultZoom * zoom_ratio_);
4468 if (zoom < static_cast<int>(zoom_min_))
4471 lyxrc.currentZoom = zoom;
4473 dr.setMessage(bformat(_("Zoom level is now %1$d% (default value: %2$d%)"),
4474 lyxrc.currentZoom, lyxrc.defaultZoom));
4476 guiApp->fontLoader().update();
4477 dr.screenUpdate(Update::Force | Update::FitCursor);
4481 case LFUN_VC_REGISTER:
4482 case LFUN_VC_RENAME:
4484 case LFUN_VC_CHECK_IN:
4485 case LFUN_VC_CHECK_OUT:
4486 case LFUN_VC_REPO_UPDATE:
4487 case LFUN_VC_LOCKING_TOGGLE:
4488 case LFUN_VC_REVERT:
4489 case LFUN_VC_UNDO_LAST:
4490 case LFUN_VC_COMMAND:
4491 case LFUN_VC_COMPARE:
4492 dispatchVC(cmd, dr);
4495 case LFUN_SERVER_GOTO_FILE_ROW:
4496 if(goToFileRow(to_utf8(cmd.argument())))
4497 dr.screenUpdate(Update::Force | Update::FitCursor);
4500 case LFUN_LYX_ACTIVATE:
4504 case LFUN_FORWARD_SEARCH: {
4505 // it seems safe to assume we have a document buffer, since
4506 // getStatus wants one.
4507 LASSERT(doc_buffer, break);
4508 Buffer const * doc_master = doc_buffer->masterBuffer();
4509 FileName const path(doc_master->temppath());
4510 string const texname = doc_master->isChild(doc_buffer)
4511 ? DocFileName(changeExtension(
4512 doc_buffer->absFileName(),
4513 "tex")).mangledFileName()
4514 : doc_buffer->latexName();
4515 string const fulltexname =
4516 support::makeAbsPath(texname, doc_master->temppath()).absFileName();
4517 string const mastername =
4518 removeExtension(doc_master->latexName());
4519 FileName const dviname(addName(path.absFileName(),
4520 addExtension(mastername, "dvi")));
4521 FileName const pdfname(addName(path.absFileName(),
4522 addExtension(mastername, "pdf")));
4523 bool const have_dvi = dviname.exists();
4524 bool const have_pdf = pdfname.exists();
4525 if (!have_dvi && !have_pdf) {
4526 dr.setMessage(_("Please, preview the document first."));
4529 string outname = dviname.onlyFileName();
4530 string command = lyxrc.forward_search_dvi;
4531 if (!have_dvi || (have_pdf &&
4532 pdfname.lastModified() > dviname.lastModified())) {
4533 outname = pdfname.onlyFileName();
4534 command = lyxrc.forward_search_pdf;
4537 DocIterator cur = bv->cursor();
4538 int row = doc_buffer->texrow().rowFromDocIterator(cur).first;
4539 LYXERR(Debug::ACTION, "Forward search: row:" << row
4541 if (row == -1 || command.empty()) {
4542 dr.setMessage(_("Couldn't proceed."));
4545 string texrow = convert<string>(row);
4547 command = subst(command, "$$n", texrow);
4548 command = subst(command, "$$f", fulltexname);
4549 command = subst(command, "$$t", texname);
4550 command = subst(command, "$$o", outname);
4552 volatile PathChanger p(path);
4554 one.startscript(Systemcall::DontWait, command);
4558 case LFUN_SPELLING_CONTINUOUSLY:
4559 lyxrc.spellcheck_continuously = !lyxrc.spellcheck_continuously;
4560 dr.screenUpdate(Update::Force);
4564 // The LFUN must be for one of BufferView, Buffer or Cursor;
4566 dispatchToBufferView(cmd, dr);
4570 // Part of automatic menu appearance feature.
4571 if (isFullScreen()) {
4572 if (menuBar()->isVisible() && lyxrc.full_screen_menubar)
4576 // Need to update bv because many LFUNs here might have destroyed it
4577 bv = currentBufferView();
4579 // Clear non-empty selections
4580 // (e.g. from a "char-forward-select" followed by "char-backward-select")
4582 Cursor & cur = bv->cursor();
4583 if ((cur.selection() && cur.selBegin() == cur.selEnd())) {
4584 cur.clearSelection();
4590 bool GuiView::lfunUiToggle(string const & ui_component)
4592 if (ui_component == "scrollbar") {
4593 // hide() is of no help
4594 if (d.current_work_area_->verticalScrollBarPolicy() ==
4595 Qt::ScrollBarAlwaysOff)
4597 d.current_work_area_->setVerticalScrollBarPolicy(
4598 Qt::ScrollBarAsNeeded);
4600 d.current_work_area_->setVerticalScrollBarPolicy(
4601 Qt::ScrollBarAlwaysOff);
4602 } else if (ui_component == "statusbar") {
4603 statusBar()->setVisible(!statusBar()->isVisible());
4604 } else if (ui_component == "menubar") {
4605 menuBar()->setVisible(!menuBar()->isVisible());
4607 if (ui_component == "frame") {
4609 getContentsMargins(&l, &t, &r, &b);
4610 //are the frames in default state?
4611 d.current_work_area_->setFrameStyle(QFrame::NoFrame);
4613 setContentsMargins(-2, -2, -2, -2);
4615 setContentsMargins(0, 0, 0, 0);
4618 if (ui_component == "fullscreen") {
4626 void GuiView::toggleFullScreen()
4628 if (isFullScreen()) {
4629 for (int i = 0; i != d.splitter_->count(); ++i)
4630 d.tabWorkArea(i)->setFullScreen(false);
4631 setContentsMargins(0, 0, 0, 0);
4632 setWindowState(windowState() ^ Qt::WindowFullScreen);
4635 statusBar()->show();
4638 hideDialogs("prefs", nullptr);
4639 for (int i = 0; i != d.splitter_->count(); ++i)
4640 d.tabWorkArea(i)->setFullScreen(true);
4641 setContentsMargins(-2, -2, -2, -2);
4643 setWindowState(windowState() ^ Qt::WindowFullScreen);
4644 if (lyxrc.full_screen_statusbar)
4645 statusBar()->hide();
4646 if (lyxrc.full_screen_menubar)
4648 if (lyxrc.full_screen_toolbars) {
4649 ToolbarMap::iterator end = d.toolbars_.end();
4650 for (ToolbarMap::iterator it = d.toolbars_.begin(); it != end; ++it)
4655 // give dialogs like the TOC a chance to adapt
4660 Buffer const * GuiView::updateInset(Inset const * inset)
4665 Buffer const * inset_buffer = &(inset->buffer());
4667 for (int i = 0; i != d.splitter_->count(); ++i) {
4668 GuiWorkArea * wa = d.tabWorkArea(i)->currentWorkArea();
4671 Buffer const * buffer = &(wa->bufferView().buffer());
4672 if (inset_buffer == buffer)
4673 wa->scheduleRedraw(true);
4675 return inset_buffer;
4679 void GuiView::restartCaret()
4681 /* When we move around, or type, it's nice to be able to see
4682 * the caret immediately after the keypress.
4684 if (d.current_work_area_)
4685 d.current_work_area_->startBlinkingCaret();
4687 // Take this occasion to update the other GUI elements.
4693 void GuiView::updateCompletion(Cursor & cur, bool start, bool keep)
4695 if (d.current_work_area_)
4696 d.current_work_area_->completer().updateVisibility(cur, start, keep);
4701 // This list should be kept in sync with the list of insets in
4702 // src/insets/Inset.cpp. I.e., if a dialog goes with an inset, the
4703 // dialog should have the same name as the inset.
4704 // Changes should be also recorded in LFUN_DIALOG_SHOW doxygen
4705 // docs in LyXAction.cpp.
4707 char const * const dialognames[] = {
4709 "aboutlyx", "bibitem", "bibtex", "box", "branch", "changes", "character",
4710 "citation", "compare", "comparehistory", "document", "errorlist", "ert",
4711 "external", "file", "findreplace", "findreplaceadv", "float", "graphics",
4712 "href", "include", "index", "index_print", "info", "listings", "label", "line",
4713 "log", "lyxfiles", "mathdelimiter", "mathmatrix", "mathspace", "nomenclature",
4714 "nomencl_print", "note", "paragraph", "phantom", "prefs", "ref",
4715 "sendto", "space", "spellchecker", "symbols", "tabular", "tabularcreate",
4716 "thesaurus", "texinfo", "toc", "view-source", "vspace", "wrap", "progress"};
4718 char const * const * const end_dialognames =
4719 dialognames + (sizeof(dialognames) / sizeof(char *));
4723 cmpCStr(char const * name) : name_(name) {}
4724 bool operator()(char const * other) {
4725 return strcmp(other, name_) == 0;
4732 bool isValidName(string const & name)
4734 return find_if(dialognames, end_dialognames,
4735 cmpCStr(name.c_str())) != end_dialognames;
4741 void GuiView::resetDialogs()
4743 // Make sure that no LFUN uses any GuiView.
4744 guiApp->setCurrentView(nullptr);
4748 constructToolbars();
4749 guiApp->menus().fillMenuBar(menuBar(), this, false);
4750 d.layout_->updateContents(true);
4751 // Now update controls with current buffer.
4752 guiApp->setCurrentView(this);
4758 Dialog * GuiView::findOrBuild(string const & name, bool hide_it)
4760 if (!isValidName(name))
4763 map<string, DialogPtr>::iterator it = d.dialogs_.find(name);
4765 if (it != d.dialogs_.end()) {
4767 it->second->hideView();
4768 return it->second.get();
4771 Dialog * dialog = build(name);
4772 d.dialogs_[name].reset(dialog);
4773 if (lyxrc.allow_geometry_session)
4774 dialog->restoreSession();
4781 void GuiView::showDialog(string const & name, string const & sdata,
4784 triggerShowDialog(toqstr(name), toqstr(sdata), inset);
4788 void GuiView::doShowDialog(QString const & qname, QString const & qdata,
4794 const string name = fromqstr(qname);
4795 const string sdata = fromqstr(qdata);
4799 Dialog * dialog = findOrBuild(name, false);
4801 bool const visible = dialog->isVisibleView();
4802 dialog->showData(sdata);
4803 if (currentBufferView())
4804 currentBufferView()->editInset(name, inset);
4805 // We only set the focus to the new dialog if it was not yet
4806 // visible in order not to change the existing previous behaviour
4808 // activateWindow is needed for floating dockviews
4809 dialog->asQWidget()->raise();
4810 dialog->asQWidget()->activateWindow();
4811 dialog->asQWidget()->setFocus();
4815 catch (ExceptionMessage const & ex) {
4823 bool GuiView::isDialogVisible(string const & name) const
4825 map<string, DialogPtr>::const_iterator it = d.dialogs_.find(name);
4826 if (it == d.dialogs_.end())
4828 return it->second.get()->isVisibleView() && !it->second.get()->isClosing();
4832 void GuiView::hideDialog(string const & name, Inset * inset)
4834 map<string, DialogPtr>::const_iterator it = d.dialogs_.find(name);
4835 if (it == d.dialogs_.end())
4839 if (!currentBufferView())
4841 if (inset != currentBufferView()->editedInset(name))
4845 Dialog * const dialog = it->second.get();
4846 if (dialog->isVisibleView())
4848 if (currentBufferView())
4849 currentBufferView()->editInset(name, nullptr);
4853 void GuiView::disconnectDialog(string const & name)
4855 if (!isValidName(name))
4857 if (currentBufferView())
4858 currentBufferView()->editInset(name, nullptr);
4862 void GuiView::hideAll() const
4864 map<string, DialogPtr>::const_iterator it = d.dialogs_.begin();
4865 map<string, DialogPtr>::const_iterator end = d.dialogs_.end();
4867 for(; it != end; ++it)
4868 it->second->hideView();
4872 void GuiView::updateDialogs()
4874 map<string, DialogPtr>::const_iterator it = d.dialogs_.begin();
4875 map<string, DialogPtr>::const_iterator end = d.dialogs_.end();
4877 for(; it != end; ++it) {
4878 Dialog * dialog = it->second.get();
4880 if (dialog->needBufferOpen() && !documentBufferView())
4881 hideDialog(fromqstr(dialog->name()), nullptr);
4882 else if (dialog->isVisibleView())
4883 dialog->checkStatus();
4890 Dialog * createDialog(GuiView & lv, string const & name);
4892 // will be replaced by a proper factory...
4893 Dialog * createGuiAbout(GuiView & lv);
4894 Dialog * createGuiBibtex(GuiView & lv);
4895 Dialog * createGuiChanges(GuiView & lv);
4896 Dialog * createGuiCharacter(GuiView & lv);
4897 Dialog * createGuiCitation(GuiView & lv);
4898 Dialog * createGuiCompare(GuiView & lv);
4899 Dialog * createGuiCompareHistory(GuiView & lv);
4900 Dialog * createGuiDelimiter(GuiView & lv);
4901 Dialog * createGuiDocument(GuiView & lv);
4902 Dialog * createGuiErrorList(GuiView & lv);
4903 Dialog * createGuiExternal(GuiView & lv);
4904 Dialog * createGuiGraphics(GuiView & lv);
4905 Dialog * createGuiInclude(GuiView & lv);
4906 Dialog * createGuiIndex(GuiView & lv);
4907 Dialog * createGuiListings(GuiView & lv);
4908 Dialog * createGuiLog(GuiView & lv);
4909 Dialog * createGuiLyXFiles(GuiView & lv);
4910 Dialog * createGuiMathMatrix(GuiView & lv);
4911 Dialog * createGuiNote(GuiView & lv);
4912 Dialog * createGuiParagraph(GuiView & lv);
4913 Dialog * createGuiPhantom(GuiView & lv);
4914 Dialog * createGuiPreferences(GuiView & lv);
4915 Dialog * createGuiPrint(GuiView & lv);
4916 Dialog * createGuiPrintindex(GuiView & lv);
4917 Dialog * createGuiRef(GuiView & lv);
4918 Dialog * createGuiSearch(GuiView & lv);
4919 Dialog * createGuiSearchAdv(GuiView & lv);
4920 Dialog * createGuiSendTo(GuiView & lv);
4921 Dialog * createGuiShowFile(GuiView & lv);
4922 Dialog * createGuiSpellchecker(GuiView & lv);
4923 Dialog * createGuiSymbols(GuiView & lv);
4924 Dialog * createGuiTabularCreate(GuiView & lv);
4925 Dialog * createGuiTexInfo(GuiView & lv);
4926 Dialog * createGuiToc(GuiView & lv);
4927 Dialog * createGuiThesaurus(GuiView & lv);
4928 Dialog * createGuiViewSource(GuiView & lv);
4929 Dialog * createGuiWrap(GuiView & lv);
4930 Dialog * createGuiProgressView(GuiView & lv);
4934 Dialog * GuiView::build(string const & name)
4936 LASSERT(isValidName(name), return nullptr);
4938 Dialog * dialog = createDialog(*this, name);
4942 if (name == "aboutlyx")
4943 return createGuiAbout(*this);
4944 if (name == "bibtex")
4945 return createGuiBibtex(*this);
4946 if (name == "changes")
4947 return createGuiChanges(*this);
4948 if (name == "character")
4949 return createGuiCharacter(*this);
4950 if (name == "citation")
4951 return createGuiCitation(*this);
4952 if (name == "compare")
4953 return createGuiCompare(*this);
4954 if (name == "comparehistory")
4955 return createGuiCompareHistory(*this);
4956 if (name == "document")
4957 return createGuiDocument(*this);
4958 if (name == "errorlist")
4959 return createGuiErrorList(*this);
4960 if (name == "external")
4961 return createGuiExternal(*this);
4963 return createGuiShowFile(*this);
4964 if (name == "findreplace")
4965 return createGuiSearch(*this);
4966 if (name == "findreplaceadv")
4967 return createGuiSearchAdv(*this);
4968 if (name == "graphics")
4969 return createGuiGraphics(*this);
4970 if (name == "include")
4971 return createGuiInclude(*this);
4972 if (name == "index")
4973 return createGuiIndex(*this);
4974 if (name == "index_print")
4975 return createGuiPrintindex(*this);
4976 if (name == "listings")
4977 return createGuiListings(*this);
4979 return createGuiLog(*this);
4980 if (name == "lyxfiles")
4981 return createGuiLyXFiles(*this);
4982 if (name == "mathdelimiter")
4983 return createGuiDelimiter(*this);
4984 if (name == "mathmatrix")
4985 return createGuiMathMatrix(*this);
4987 return createGuiNote(*this);
4988 if (name == "paragraph")
4989 return createGuiParagraph(*this);
4990 if (name == "phantom")
4991 return createGuiPhantom(*this);
4992 if (name == "prefs")
4993 return createGuiPreferences(*this);
4995 return createGuiRef(*this);
4996 if (name == "sendto")
4997 return createGuiSendTo(*this);
4998 if (name == "spellchecker")
4999 return createGuiSpellchecker(*this);
5000 if (name == "symbols")
5001 return createGuiSymbols(*this);
5002 if (name == "tabularcreate")
5003 return createGuiTabularCreate(*this);
5004 if (name == "texinfo")
5005 return createGuiTexInfo(*this);
5006 if (name == "thesaurus")
5007 return createGuiThesaurus(*this);
5009 return createGuiToc(*this);
5010 if (name == "view-source")
5011 return createGuiViewSource(*this);
5013 return createGuiWrap(*this);
5014 if (name == "progress")
5015 return createGuiProgressView(*this);
5021 SEMenu::SEMenu(QWidget * parent)
5023 QAction * action = addAction(qt_("Disable Shell Escape"));
5024 connect(action, SIGNAL(triggered()),
5025 parent, SLOT(disableShellEscape()));
5028 } // namespace frontend
5031 #include "moc_GuiView.cpp"