src/frontends/LyXView.cpp

   1 /**
   2  * \file LyXView.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "LyXView.h"
  15 #include "Dialogs.h"
  16 #include "Timeout.h"
  17 #include "Toolbars.h"
  18 #include "Menubar.h"
  19 #include "WorkArea.h"
  20 #include "Gui.h"
  21
  22 #include "Buffer.h"
  23 #include "buffer_funcs.h"
  24 #include "BufferList.h"
  25 #include "BufferParams.h"
  26 #include "BufferView.h"
  27 #include "bufferview_funcs.h"
  28 #include "Cursor.h"
  29 #include "debug.h"
  30 #include "ErrorList.h"
  31 #include "FuncRequest.h"
  32 #include "gettext.h"
  33 #include "Intl.h"
  34 #include "callback.h"
  35 #include "LyX.h"
  36 #include "LyXFunc.h"
  37 #include "LyXRC.h"
  38 #include "Text.h"
  39 #include "MenuBackend.h"
  40 #include "Paragraph.h"
  41
  42 #include "controllers/ControlCommandBuffer.h"
  43
  44 #include "support/lstrings.h"
  45 #include "support/filetools.h" // OnlyFilename()
  46
  47 #include <boost/bind.hpp>
  48
  49
  50 namespace lyx {
  51
  52 #ifdef HAVE_SYS_TIME_H
  53 # include <sys/time.h>
  54 #endif
  55 #ifdef HAVE_UNISTD_H
  56 # include <unistd.h>
  57 #endif
  58
  59 using frontend::WorkArea;
  60
  61 using support::bformat;
  62 using support::FileName;
  63 using support::makeDisplayPath;
  64 using support::onlyFilename;
  65
  66 using std::endl;
  67 using std::string;
  68
  69 using lyx::frontend::ControlCommandBuffer;
  70
  71 string current_layout;
  72
  73
  74 LyXView::LyXView(int id)
  75         : work_area_(0),
  76           toolbars_(new Toolbars(*this)),
  77           autosave_timeout_(new Timeout(5000)),
  78           dialogs_(new Dialogs(*this)),
  79           controlcommand_(new ControlCommandBuffer(*this)), id_(id)
  80 {
  81         // Start autosave timer
  82         if (lyxrc.autosave) {
  83                 autosave_timeout_->timeout.connect(boost::bind(&LyXView::autoSave, this));
  84                 autosave_timeout_->setTimeout(lyxrc.autosave * 1000);
  85                 autosave_timeout_->start();
  86         }
  87 }
  88
  89
  90 LyXView::~LyXView()
  91 {
  92         disconnectBuffer();
  93 }
  94
  95
  96 // FIXME, there's only one WorkArea per LyXView possible for now.
  97 void LyXView::setWorkArea(WorkArea * work_area)
  98 {
  99         BOOST_ASSERT(work_area);
 100         work_area_ = work_area;
 101         work_area_ids_.clear();
 102         work_area_ids_.push_back(work_area_->id());
 103 }
 104
 105
 106 // FIXME, there's only one WorkArea per LyXView possible for now.
 107 WorkArea const * LyXView::currentWorkArea() const
 108 {
 109         return work_area_;
 110 }
 111
 112
 113 // FIXME, there's only one WorkArea per LyXView possible for now.
 114 WorkArea * LyXView::currentWorkArea()
 115 {
 116         return work_area_;
 117 }
 118
 119
 120 Buffer * LyXView::buffer() const
 121 {
 122         BOOST_ASSERT(work_area_);
 123         return work_area_->bufferView().buffer();
 124 }
 125
 126
 127 void LyXView::setBuffer(Buffer * b, bool child_document)
 128 {
 129         busy(true);
 130
 131         BOOST_ASSERT(work_area_);
 132         Buffer * oldBuffer = work_area_->bufferView().buffer();
 133         // parentfilename will be used in case when we switch to a child
 134         // document (hence when child_document is true)
 135         string parentfilename;
 136         if (oldBuffer) {
 137                 parentfilename = oldBuffer->fileName();
 138                 disconnectBuffer();
 139         }
 140
 141         if (!b && theBufferList().empty())
 142                 getDialogs().hideBufferDependent();
 143
 144         work_area_->bufferView().setBuffer(b);
 145
 146         //FIXME This would be a little simpler if setBuffer returned the buffer.
 147         Buffer * newBuffer = work_area_->bufferView().buffer();
 148         if (newBuffer) {
 149                 if (child_document && newBuffer->getMasterBuffer() != oldBuffer) {
 150                         // Set the parent name of the child document.
 151                         // This makes insertion of citations and references in the child work,
 152                         // when the target is in the parent or another child document.
 153                         newBuffer->setParentName(parentfilename);
 154                         // Update the labels and section numbering to the new master Buffer.
 155                         updateLabels(*newBuffer->getMasterBuffer());
 156                 }
 157
 158                 connectBuffer(*newBuffer);
 159
 160                 // Buffer-dependent dialogs should be updated or
 161                 // hidden. This should go here because some dialogs (eg ToC)
 162                 // require bv_->text.
 163                 getDialogs().updateBufferDependent(true);
 164         }
 165
 166         if (quitting)
 167                 return;
 168
 169         updateMenubar();
 170         updateToolbars();
 171         updateLayoutChoice();
 172         updateWindowTitle();
 173         updateStatusBar();
 174         updateTab();
 175         busy(false);
 176         work_area_->redraw();
 177 }
 178
 179
 180 bool LyXView::loadLyXFile(FileName const & filename, bool tolastfiles,
 181                 bool child_document, bool auto_open)
 182 {
 183         busy(true);
 184
 185         BOOST_ASSERT(work_area_);
 186         string parentfilename;
 187         Buffer * oldBuffer = work_area_->bufferView().buffer();
 188         if (oldBuffer)
 189                 parentfilename = oldBuffer->fileName();
 190
 191         Buffer * newBuffer = checkAndLoadLyXFile(filename);
 192
 193         if (!newBuffer) {
 194                 message(_("Document not loaded."));
 195                 updateStatusBar();
 196                 busy(false);
 197                 work_area_->redraw();
 198                 return false;
 199         }
 200
 201         if (child_document && newBuffer != oldBuffer) {
 202                 // Set the parent name of the child document.
 203                 // This makes insertion of citations and references in the child work,
 204                 // when the target is in the parent or another child document.
 205                 newBuffer->setParentName(parentfilename);
 206                 message(bformat(_("Opening child document %1$s..."),
 207                         makeDisplayPath(filename.absFilename())));
 208         }
 209
 210         // Update the labels and section numbering.
 211         updateLabels(*newBuffer->getMasterBuffer());
 212
 213         bool const parse_error = !newBuffer->errorList("Parse").empty();
 214         if (parse_error || !auto_open) {
 215                 setBuffer(newBuffer, child_document);
 216                 showErrorList("Parse");
 217         }
 218
 219         // scroll to the position when the file was last closed
 220         if (!auto_open && lyxrc.use_lastfilepos) {
 221                 pit_type pit;
 222                 pos_type pos;
 223                 boost::tie(pit, pos) = LyX::ref().session().lastFilePos().load(filename);
 224                 // if successfully move to pit (returned par_id is not zero),
 225                 // update metrics and reset font
 226                 if (work_area_->bufferView().moveToPosition(pit, pos, 0, 0).get<1>()) {
 227                         if (work_area_->bufferView().fitCursor())
 228                                 work_area_->bufferView().updateMetrics(false);
 229                         newBuffer->text().setCurrentFont(work_area_->bufferView().cursor());
 230                         updateMenubar();
 231                         updateToolbars();
 232                         updateLayoutChoice();
 233                         updateStatusBar();
 234                         work_area_->redraw();
 235                 }
 236         }
 237
 238         if (tolastfiles)
 239                 LyX::ref().session().lastFiles().add(filename);
 240
 241         busy(false);
 242         return true;
 243 }
 244
 245
 246 void LyXView::connectBuffer(Buffer & buf)
 247 {
 248         if (errorsConnection_.connected())
 249                 disconnectBuffer();
 250
 251         BOOST_ASSERT(work_area_);
 252         bufferChangedConnection_ =
 253                 buf.changed.connect(
 254                         boost::bind(&WorkArea::redraw, work_area_));
 255
 256         bufferStructureChangedConnection_ =
 257                 buf.getMasterBuffer()->structureChanged.connect(
 258                         boost::bind(&LyXView::updateToc, this));
 259
 260         errorsConnection_ =
 261                 buf.errors.connect(
 262                         boost::bind(&LyXView::showErrorList, this, _1));
 263
 264         messageConnection_ =
 265                 buf.message.connect(
 266                         boost::bind(&LyXView::message, this, _1));
 267
 268         busyConnection_ =
 269                 buf.busy.connect(
 270                         boost::bind(&LyXView::busy, this, _1));
 271
 272         titleConnection_ =
 273                 buf.updateTitles.connect(
 274                         boost::bind(&LyXView::updateWindowTitle, this));
 275
 276         timerConnection_ =
 277                 buf.resetAutosaveTimers.connect(
 278                         boost::bind(&LyXView::resetAutosaveTimer, this));
 279
 280         readonlyConnection_ =
 281                 buf.readonly.connect(
 282                         boost::bind(&LyXView::showReadonly, this, _1));
 283
 284         closingConnection_ =
 285                 buf.closing.connect(
 286                         boost::bind(&LyXView::setBuffer, this, (Buffer *)0, false));
 287 }
 288
 289
 290 void LyXView::disconnectBuffer()
 291 {
 292         errorsConnection_.disconnect();
 293         bufferChangedConnection_.disconnect();
 294         bufferStructureChangedConnection_.disconnect();
 295         messageConnection_.disconnect();
 296         busyConnection_.disconnect();
 297         titleConnection_.disconnect();
 298         timerConnection_.disconnect();
 299         readonlyConnection_.disconnect();
 300         closingConnection_.disconnect();
 301         layout_changed_connection_.disconnect();
 302 }
 303
 304
 305 void LyXView::connectBufferView(BufferView & bv)
 306 {
 307         show_dialog_connection_ = bv.showDialog.connect(
 308                         boost::bind(&LyXView::showDialog, this, _1));
 309         show_dialog_with_data_connection_ = bv.showDialogWithData.connect(
 310                         boost::bind(&LyXView::showDialogWithData, this, _1, _2));
 311         show_inset_dialog_connection_ = bv.showInsetDialog.connect(
 312                         boost::bind(&LyXView::showInsetDialog, this, _1, _2, _3));
 313         update_dialog_connection_ = bv.updateDialog.connect(
 314                         boost::bind(&LyXView::updateDialog, this, _1, _2));
 315         layout_changed_connection_ = bv.layoutChanged.connect(
 316                         boost::bind(&Toolbars::setLayout, toolbars_.get(), _1));
 317 }
 318
 319
 320 void LyXView::disconnectBufferView()
 321 {
 322         show_dialog_connection_.disconnect();
 323         show_dialog_with_data_connection_.disconnect();
 324         show_inset_dialog_connection_.disconnect();
 325         update_dialog_connection_.disconnect();
 326 }
 327
 328
 329 void LyXView::showErrorList(string const & error_type)
 330 {
 331         ErrorList & el = buffer()->errorList(error_type);
 332         if (!el.empty()) {
 333                 getDialogs().show("errorlist", error_type);
 334         }
 335 }
 336
 337
 338 void LyXView::showDialog(string const & name)
 339 {
 340         getDialogs().show(name);
 341 }
 342
 343
 344 void LyXView::showDialogWithData(string const & name, string const & data)
 345 {
 346         getDialogs().show(name, data);
 347 }
 348
 349
 350 void LyXView::showInsetDialog(string const & name, string const & data,
 351                 Inset * inset)
 352 {
 353         getDialogs().show(name, data, inset);
 354 }
 355
 356
 357 void LyXView::updateDialog(string const & name, string const & data)
 358 {
 359         if (getDialogs().visible(name))
 360                 getDialogs().update(name, data);
 361 }
 362
 363
 364 void LyXView::showReadonly(bool)
 365 {
 366         updateWindowTitle();
 367         getDialogs().updateBufferDependent(false);
 368 }
 369
 370
 371 BufferView * LyXView::view() const
 372 {
 373         BOOST_ASSERT(work_area_);
 374         return &work_area_->bufferView();
 375 }
 376
 377
 378 void LyXView::updateToc()
 379 {
 380         updateDialog("toc", "");
 381 }
 382
 383
 384 void LyXView::updateToolbars()
 385 {
 386         BOOST_ASSERT(work_area_);
 387         bool const math =
 388                 work_area_->bufferView().cursor().inMathed();
 389         bool const table =
 390                 lyx::getStatus(FuncRequest(LFUN_LAYOUT_TABULAR)).enabled();
 391         bool const review =
 392                 lyx::getStatus(FuncRequest(LFUN_CHANGES_TRACK)).enabled() &&
 393                 lyx::getStatus(FuncRequest(LFUN_CHANGES_TRACK)).onoff(true);
 394
 395         toolbars_->update(math, table, review);
 396         // update redaonly status of open dialogs. This could also be in
 397         // updateMenubar(), but since updateToolbars() and updateMenubar()
 398         // are always called together it is only here.
 399         getDialogs().checkStatus();
 400 }
 401
 402
 403 ToolbarInfo::Flags LyXView::getToolbarState(string const & name)
 404 {
 405         return toolbars_->getToolbarState(name);
 406 }
 407
 408
 409 void LyXView::toggleToolbarState(string const & name, bool allowauto)
 410 {
 411         // it is possible to get current toolbar status like this,...
 412         // but I decide to obey the order of ToolbarBackend::flags
 413         // and disregard real toolbar status.
 414         // toolbars_->saveToolbarInfo();
 415         //
 416         // toggle state on/off/auto
 417         toolbars_->toggleToolbarState(name, allowauto);
 418         // update toolbar
 419         updateToolbars();
 420 }
 421
 422
 423 void LyXView::updateMenubar()
 424 {
 425         menubar_->update();
 426 }
 427
 428
 429 void LyXView::autoSave()
 430 {
 431         LYXERR(Debug::INFO) << "Running autoSave()" << endl;
 432
 433         if (view()->buffer())
 434                 lyx::autoSave(view());
 435 }
 436
 437
 438 void LyXView::resetAutosaveTimer()
 439 {
 440         if (lyxrc.autosave)
 441                 autosave_timeout_->restart();
 442 }
 443
 444
 445 void LyXView::updateLayoutChoice()
 446 {
 447         // Don't show any layouts without a buffer
 448         if (!view()->buffer()) {
 449                 toolbars_->clearLayoutList();
 450                 return;
 451         }
 452
 453         // Update the layout display
 454         if (toolbars_->updateLayoutList(buffer()->params().textclass)) {
 455                 current_layout = buffer()->params().getTextClass().defaultLayoutName();
 456         }
 457
 458         BOOST_ASSERT(work_area_);
 459         string const & layout = work_area_->bufferView().cursor().
 460                 innerParagraph().layout()->name();
 461
 462         if (layout != current_layout) {
 463                 toolbars_->setLayout(layout);
 464                 current_layout = layout;
 465         }
 466 }
 467
 468
 469 void LyXView::updateWindowTitle()
 470 {
 471         docstring maximize_title = lyx::from_ascii("LyX");
 472         docstring minimize_title = lyx::from_ascii("LyX");
 473
 474         if (view()->buffer()) {
 475                 string const cur_title = buffer()->fileName();
 476                 if (!cur_title.empty()) {
 477                         maximize_title += ": " + makeDisplayPath(cur_title, 30);
 478                         minimize_title = lyx::from_utf8(onlyFilename(cur_title));
 479                         if (!buffer()->isClean()) {
 480                                 maximize_title += _(" (changed)");
 481                                 minimize_title += lyx::char_type('*');
 482                         }
 483                         if (buffer()->isReadonly())
 484                                 maximize_title += _(" (read only)");
 485                 }
 486         }
 487
 488         setWindowTitle(maximize_title, minimize_title);
 489         updateTab();
 490 }
 491
 492
 493 void LyXView::dispatch(FuncRequest const & cmd)
 494 {
 495         theLyXFunc().setLyXView(this);
 496         lyx::dispatch(cmd);
 497 }
 498
 499
 500 Buffer const * const LyXView::updateInset(Inset const * inset) const
 501 {
 502         Buffer const * buffer_ptr = 0;
 503         if (inset) {
 504                 BOOST_ASSERT(work_area_);
 505                 work_area_->scheduleRedraw();
 506
 507                 buffer_ptr = work_area_->bufferView().buffer();
 508         }
 509         return buffer_ptr;
 510 }
 511
 512
 513 } // namespace lyx