src/frontends/WorkArea.C

   1 /**
   2  * \file WorkArea.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  * Splash screen code added by Angus Leeming
  12  */
  13
  14 #include <config.h>
  15
  16 #include "frontends/WorkArea.h"
  17
  18 #include "frontends/Application.h"
  19 #include "frontends/FontMetrics.h"
  20
  21 #include "funcrequest.h"
  22 #include "lyxfunc.h"
  23 #include "Painter.h"
  24
  25 #include "BufferView.h"
  26 #include "buffer.h"
  27 #include "bufferparams.h"
  28 #include "coordcache.h"
  29 #include "cursor.h"
  30 #include "debug.h"
  31 #include "language.h"
  32 #include "LColor.h"
  33 #include "lyxfont.h"
  34 #include "lyxrc.h"
  35 #include "lyxrow.h"
  36 #include "lyxtext.h"
  37 #include "LyXView.h"
  38 #include "metricsinfo.h"
  39 #include "paragraph.h"
  40 #include "rowpainter.h"
  41
  42 #include "gettext.h"
  43 #include "support/filetools.h" // LibFileSearch
  44 #include "support/forkedcontr.h"
  45
  46 #include <boost/utility.hpp>
  47 #include <boost/bind.hpp>
  48 #include <boost/current_function.hpp>
  49
  50 using lyx::support::libFileSearch;
  51 using lyx::support::ForkedcallsController;
  52
  53 using std::endl;
  54 using std::min;
  55 using std::max;
  56 using std::string;
  57
  58
  59 namespace {
  60
  61 // All the below connection objects are needed because of a bug in some
  62 // versions of GCC (<=2.96 are on the suspects list.) By having and assigning
  63 // to these connections we avoid a segfault upon startup, and also at exit.
  64 // (Lgb)
  65
  66 boost::signals::connection timecon;
  67
  68 } // anon namespace
  69
  70 namespace lyx {
  71 namespace frontend {
  72
  73 WorkArea::WorkArea(int id, LyXView & lyx_view)
  74         : buffer_view_(0), lyx_view_(lyx_view), greyed_out_(true),
  75           id_(id), cursor_visible_(false), cursor_timeout_(400)
  76 {
  77         // Start loading the pixmap as soon as possible
  78         //if (lyxrc.show_banner) {
  79         //      showBanner();
  80         //}
  81
  82         // Setup the signals
  83         timecon = cursor_timeout_.timeout
  84                 .connect(boost::bind(&WorkArea::toggleCursor, this));
  85
  86         cursor_timeout_.start();
  87 }
  88
  89
  90 void WorkArea::setBufferView(BufferView * buffer_view)
  91 {
  92         if (buffer_view_) {
  93                 message_connection_.disconnect();
  94                 lyx_view_.disconnectBufferView();
  95         }
  96
  97         hideCursor();
  98         buffer_view_ = buffer_view;
  99         toggleCursor();
 100
 101         message_connection_ = buffer_view_->message.connect(
 102                         boost::bind(&WorkArea::displayMessage, this, _1));
 103
 104         lyx_view_.connectBufferView(*buffer_view);
 105 }
 106
 107
 108 BufferView & WorkArea::bufferView()
 109 {
 110         return *buffer_view_;
 111 }
 112
 113
 114 BufferView const & WorkArea::bufferView() const
 115 {
 116         return *buffer_view_;
 117 }
 118
 119
 120 void WorkArea::stopBlinkingCursor()
 121 {
 122         cursor_timeout_.stop();
 123 }
 124
 125
 126 void WorkArea::startBlinkingCursor()
 127 {
 128         cursor_timeout_.restart();
 129 }
 130
 131
 132 void WorkArea::checkAndGreyOut()
 133 {
 134         if (greyed_out_)
 135                 greyOut();
 136 }
 137
 138
 139 void WorkArea::redraw(bool singlePar)
 140 {
 141         if (!buffer_view_)
 142                 return;
 143
 144         if (!buffer_view_->buffer()) {
 145                 checkAndGreyOut();
 146                 return;
 147         }
 148
 149         buffer_view_->updateMetrics(singlePar && hasFocus());
 150
 151         updateScrollbar();
 152
 153         ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
 154         greyed_out_ = false;
 155
 156         if (lyxerr.debugging(Debug::WORKAREA)) {
 157                 lyxerr[Debug::WORKAREA] << "WorkArea::redraw screen" << endl;
 158         }
 159         int const ymin = std::max(vi.y1, 0);
 160         int const ymax = vi.p2 < vi.size - 1 ? vi.y2 : height();
 161
 162         expose(0, ymin, width(), ymax - ymin);
 163
 164         //lyxerr[Debug::WORKAREA]
 165         //<< "  ymin = " << ymin << "  width() = " << width()
 166 //              << "  ymax-ymin = " << ymax-ymin << std::endl;
 167
 168         if (lyxerr.debugging(Debug::WORKAREA))
 169                 buffer_view_->coordCache().dump();
 170 }
 171
 172
 173 void WorkArea::processKeySym(LyXKeySymPtr key,
 174                                                          key_modifier::state state)
 175 {
 176         hideCursor();
 177
 178         theLyXFunc().setLyXView(&lyx_view_);
 179         theLyXFunc().processKeySym(key, state);
 180
 181         /* This is perhaps a bit of a hack. When we move
 182          * around, or type, it's nice to be able to see
 183          * the cursor immediately after the keypress. So
 184          * we reset the toggle timeout and force the visibility
 185          * of the cursor. Note we cannot do this inside
 186          * dispatch() itself, because that's called recursively.
 187          */
 188 //      if (buffer_view_->buffer())
 189         toggleCursor();
 190 }
 191
 192
 193 void WorkArea::dispatch(FuncRequest const & cmd0)
 194 {
 195         // Handle drag&drop
 196         if (cmd0.action == LFUN_FILE_OPEN) {
 197                 lyx_view_.dispatch(cmd0);
 198                 return;
 199         }
 200
 201         theLyXFunc().setLyXView(&lyx_view_);
 202
 203         bool needRedraw = buffer_view_->workAreaDispatch(cmd0);
 204
 205         // Skip these when selecting
 206         if (cmd0.action != LFUN_MOUSE_MOTION) {
 207                 lyx_view_.updateLayoutChoice();
 208                 lyx_view_.updateMenubar();
 209                 lyx_view_.updateToolbars();
 210         }
 211
 212         // Slight hack: this is only called currently when we
 213         // clicked somewhere, so we force through the display
 214         // of the new status here.
 215         lyx_view_.clearMessage();
 216
 217         // Show the cursor immediately after any operation.
 218         hideCursor();
 219         toggleCursor();
 220
 221         if (needRedraw)
 222                 redraw();
 223 }
 224
 225
 226 void WorkArea::resizeBufferView()
 227 {
 228         lyx_view_.busy(true);
 229         lyx_view_.message(_("Formatting document..."));
 230         buffer_view_->workAreaResize(width(), height());
 231         lyx_view_.updateLayoutChoice();
 232         redraw();
 233         lyx_view_.busy(false);
 234         lyx_view_.clearMessage();
 235 }
 236
 237
 238 void WorkArea::updateScrollbar()
 239 {
 240         buffer_view_->updateScrollbar();
 241         ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
 242         setScrollbarParams(scroll_.height, scroll_.position,
 243                 scroll_.lineScrollHeight);
 244 }
 245
 246
 247 void WorkArea::scrollBufferView(int position)
 248 {
 249         buffer_view_->scrollDocView(position);
 250         redraw();
 251         hideCursor();
 252         if (lyxrc.cursor_follows_scrollbar) {
 253                 buffer_view_->setCursorFromScrollbar();
 254                 lyx_view_.updateLayoutChoice();
 255         }
 256         toggleCursor();
 257 }
 258
 259
 260 void WorkArea::greyOut()
 261 {
 262         greyed_out_ = true;
 263         expose(4, 5, 3, 3);
 264 }
 265
 266
 267 void WorkArea::showCursor()
 268 {
 269         if (cursor_visible_)
 270                 return;
 271
 272         if (!buffer_view_->buffer())
 273                 return;
 274
 275         CursorShape shape = BAR_SHAPE;
 276
 277         LyXText const & text = *buffer_view_->getLyXText();
 278         LyXFont const & realfont = text.real_current_font;
 279         BufferParams const & bp = buffer_view_->buffer()->params();
 280         bool const samelang = realfont.language() == bp.language;
 281         bool const isrtl = realfont.isVisibleRightToLeft();
 282
 283         if (!samelang || isrtl != bp.language->rightToLeft()) {
 284                 shape = L_SHAPE;
 285                 if (isrtl)
 286                         shape = REVERSED_L_SHAPE;
 287         }
 288
 289         // The ERT language hack needs fixing up
 290         if (realfont.language() == latex_language)
 291                 shape = BAR_SHAPE;
 292
 293         LyXFont const font = buffer_view_->cursor().getFont();
 294         FontMetrics const & fm = theFontMetrics(font);
 295         int const asc = fm.maxAscent();
 296         int const des = fm.maxDescent();
 297         int h = asc + des;
 298         int x = 0;
 299         int y = 0;
 300         buffer_view_->cursor().getPos(x, y);
 301         y -= asc;
 302
 303         // if it doesn't touch the screen, don't try to show it
 304         if (y + h < 0 || y >= height())
 305                 return;
 306
 307         cursor_visible_ = true;
 308         showCursor(x, y, h, shape);
 309 }
 310
 311
 312 void WorkArea::hideCursor()
 313 {
 314         if (!cursor_visible_)
 315                 return;
 316
 317         cursor_visible_ = false;
 318         removeCursor();
 319 }
 320
 321
 322 void WorkArea::toggleCursor()
 323 {
 324         if (buffer_view_->buffer()) {
 325
 326                 if (cursor_visible_)
 327                         hideCursor();
 328                 else
 329                         showCursor();
 330
 331                 // Use this opportunity to deal with any child processes that
 332                 // have finished but are waiting to communicate this fact
 333                 // to the rest of LyX.
 334                 ForkedcallsController & fcc = ForkedcallsController::get();
 335                 fcc.handleCompletedProcesses();
 336         }
 337
 338         cursor_timeout_.restart();
 339 }
 340
 341
 342 void WorkArea::displayMessage(lyx::docstring const & message)
 343 {
 344         lyx_view_.message(message);
 345 }
 346
 347 } // namespace frontend
 348 } // namespace lyx