src/frontends/WorkArea.cpp

   1 /**
   2  * \file WorkArea.cpp
   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 "Color.h"
  33 #include "Font.h"
  34 #include "LyXRC.h"
  35 #include "Row.h"
  36 #include "Text.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/ForkedcallsController.h"
  44
  45 #include <boost/utility.hpp>
  46 #include <boost/bind.hpp>
  47 #include <boost/current_function.hpp>
  48
  49 using lyx::support::ForkedcallsController;
  50
  51 using std::endl;
  52 using std::min;
  53 using std::max;
  54 using std::string;
  55
  56
  57 namespace {
  58
  59 // All the below connection objects are needed because of a bug in some
  60 // versions of GCC (<=2.96 are on the suspects list.) By having and assigning
  61 // to these connections we avoid a segfault upon startup, and also at exit.
  62 // (Lgb)
  63
  64 boost::signals::connection timecon;
  65
  66 } // anon namespace
  67
  68 namespace lyx {
  69 namespace frontend {
  70
  71 WorkArea::WorkArea(int id, LyXView & lyx_view)
  72         : buffer_view_(0), lyx_view_(lyx_view), greyed_out_(true),
  73           id_(id), cursor_visible_(false), cursor_timeout_(400)
  74 {
  75         // Start loading the pixmap as soon as possible
  76         //if (lyxrc.show_banner) {
  77         //      showBanner();
  78         //}
  79
  80         // Setup the signals
  81         timecon = cursor_timeout_.timeout
  82                 .connect(boost::bind(&WorkArea::toggleCursor, this));
  83
  84         cursor_timeout_.start();
  85 }
  86
  87
  88 void WorkArea::setBufferView(BufferView * buffer_view)
  89 {
  90         if (buffer_view_) {
  91                 message_connection_.disconnect();
  92                 lyx_view_.disconnectBufferView();
  93         }
  94
  95         hideCursor();
  96         buffer_view_ = buffer_view;
  97         toggleCursor();
  98
  99         message_connection_ = buffer_view_->message.connect(
 100                         boost::bind(&WorkArea::displayMessage, this, _1));
 101
 102         lyx_view_.connectBufferView(*buffer_view);
 103 }
 104
 105
 106 BufferView & WorkArea::bufferView()
 107 {
 108         return *buffer_view_;
 109 }
 110
 111
 112 BufferView const & WorkArea::bufferView() const
 113 {
 114         return *buffer_view_;
 115 }
 116
 117
 118 void WorkArea::stopBlinkingCursor()
 119 {
 120         cursor_timeout_.stop();
 121         hideCursor();
 122 }
 123
 124
 125 void WorkArea::startBlinkingCursor()
 126 {
 127         showCursor();
 128         cursor_timeout_.restart();
 129 }
 130
 131
 132 void WorkArea::redraw()
 133 {
 134         if (!buffer_view_ || !buffer_view_->buffer()) {
 135                 greyed_out_ = true;
 136                 // The argument here are meaningless.
 137                 expose(1,1,1,1);
 138                 return;
 139         }
 140
 141         // No need to do anything if this is the current view. The BufferView
 142         // metrics are already up to date.
 143         if (&lyx_view_ != theApp()->currentView()) {
 144                 // FIXME: it would be nice to optimize for the off-screen case.
 145                 buffer_view_->updateMetrics(false);
 146                 buffer_view_->cursor().fixIfBroken();
 147         }
 148
 149         updateScrollbar();
 150
 151         ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
 152         greyed_out_ = false;
 153
 154         LYXERR(Debug::WORKAREA) << "WorkArea::redraw screen" << endl;
 155
 156         int const ymin = std::max(vi.y1, 0);
 157         int const ymax = vi.p2 < vi.size - 1 ? vi.y2 : height();
 158
 159         expose(0, ymin, width(), ymax - ymin);
 160
 161         //LYXERR(Debug::WORKAREA)
 162         //<< "  ymin = " << ymin << "  width() = " << width()
 163 //              << "  ymax-ymin = " << ymax-ymin << std::endl;
 164
 165         if (lyxerr.debugging(Debug::WORKAREA))
 166                 buffer_view_->coordCache().dump();
 167 }
 168
 169
 170 void WorkArea::processKeySym(KeySymbolPtr key, key_modifier::state state)
 171 {
 172         // In order to avoid bad surprise in the middle of an operation, we better stop
 173         // the blinking cursor.
 174         stopBlinkingCursor();
 175
 176         theLyXFunc().setLyXView(&lyx_view_);
 177         theLyXFunc().processKeySym(key, state);
 178
 179         /* When we move around, or type, it's nice to be able to see
 180          * the cursor immediately after the keypress.
 181          */
 182         startBlinkingCursor();
 183 }
 184
 185
 186 void WorkArea::dispatch(FuncRequest const & cmd0, key_modifier::state k)
 187 {
 188         // Handle drag&drop
 189         if (cmd0.action == LFUN_FILE_OPEN) {
 190                 lyx_view_.dispatch(cmd0);
 191                 return;
 192         }
 193
 194         theLyXFunc().setLyXView(&lyx_view_);
 195
 196         FuncRequest cmd;
 197
 198         if (cmd0.action == LFUN_MOUSE_PRESS) {
 199                 if (k == key_modifier::shift)
 200                         cmd = FuncRequest(cmd0, "region-select");
 201                 else if (k == key_modifier::ctrl)
 202                         cmd = FuncRequest(cmd0, "paragraph-select");
 203                 else
 204                         cmd = cmd0;
 205         }
 206         else
 207                 cmd = cmd0;
 208
 209         // In order to avoid bad surprise in the middle of an operation, we better stop
 210         // the blinking cursor.
 211         if (!(cmd.action == LFUN_MOUSE_MOTION
 212                 && cmd.button() == mouse_button::none))
 213                 stopBlinkingCursor();
 214
 215         bool const needRedraw = buffer_view_->workAreaDispatch(cmd);
 216
 217         if (needRedraw)
 218                 redraw();
 219
 220         // Skip these when selecting
 221         if (cmd.action != LFUN_MOUSE_MOTION) {
 222                 lyx_view_.updateLayoutChoice();
 223                 lyx_view_.updateMenubar();
 224                 lyx_view_.updateToolbars();
 225         }
 226
 227         // GUI tweaks except with mouse motion with no button pressed.
 228         if (!(cmd.action == LFUN_MOUSE_MOTION
 229                 && cmd.button() == mouse_button::none)) {
 230                 // Slight hack: this is only called currently when we
 231                 // clicked somewhere, so we force through the display
 232                 // of the new status here.
 233                 lyx_view_.clearMessage();
 234
 235                 // Show the cursor immediately after any operation.
 236                 startBlinkingCursor();
 237         }
 238 }
 239
 240
 241 void WorkArea::resizeBufferView()
 242 {
 243         lyx_view_.busy(true);
 244         lyx_view_.message(_("Formatting document..."));
 245         buffer_view_->workAreaResize(width(), height());
 246         lyx_view_.updateLayoutChoice();
 247         lyx_view_.clearMessage();
 248         lyx_view_.busy(false);
 249 }
 250
 251
 252 void WorkArea::updateScrollbar()
 253 {
 254         buffer_view_->updateScrollbar();
 255         ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
 256         setScrollbarParams(scroll_.height, scroll_.position,
 257                 scroll_.lineScrollHeight);
 258 }
 259
 260
 261 void WorkArea::scrollBufferView(int position)
 262 {
 263         stopBlinkingCursor();
 264         buffer_view_->scrollDocView(position);
 265         redraw();
 266         if (lyxrc.cursor_follows_scrollbar) {
 267                 buffer_view_->setCursorFromScrollbar();
 268                 lyx_view_.updateLayoutChoice();
 269         }
 270         // Show the cursor immediately after any operation.
 271         startBlinkingCursor();
 272 }
 273
 274
 275 void WorkArea::showCursor()
 276 {
 277         if (cursor_visible_)
 278                 return;
 279
 280         if (!buffer_view_->buffer())
 281                 return;
 282
 283         CursorShape shape = BAR_SHAPE;
 284
 285         Text const & text = *buffer_view_->cursor().innerText();
 286         Font const & realfont = text.real_current_font;
 287         BufferParams const & bp = buffer_view_->buffer()->params();
 288         bool const samelang = realfont.language() == bp.language;
 289         bool const isrtl = realfont.isVisibleRightToLeft();
 290
 291         if (!samelang || isrtl != bp.language->rightToLeft()) {
 292                 shape = L_SHAPE;
 293                 if (isrtl)
 294                         shape = REVERSED_L_SHAPE;
 295         }
 296
 297         // The ERT language hack needs fixing up
 298         if (realfont.language() == latex_language)
 299                 shape = BAR_SHAPE;
 300
 301         Font const font = buffer_view_->cursor().getFont();
 302         FontMetrics const & fm = theFontMetrics(font);
 303         int const asc = fm.maxAscent();
 304         int const des = fm.maxDescent();
 305         int h = asc + des;
 306         int x = 0;
 307         int y = 0;
 308         buffer_view_->cursor().getPos(x, y);
 309         y -= asc;
 310
 311         // if it doesn't touch the screen, don't try to show it
 312         if (y + h < 0 || y >= height())
 313                 return;
 314
 315         cursor_visible_ = true;
 316         showCursor(x, y, h, shape);
 317 }
 318
 319
 320 void WorkArea::hideCursor()
 321 {
 322         if (!cursor_visible_)
 323                 return;
 324
 325         cursor_visible_ = false;
 326         removeCursor();
 327 }
 328
 329
 330 void WorkArea::toggleCursor()
 331 {
 332         if (buffer_view_->buffer()) {
 333
 334                 if (cursor_visible_)
 335                         hideCursor();
 336                 else
 337                         showCursor();
 338
 339                 // Use this opportunity to deal with any child processes that
 340                 // have finished but are waiting to communicate this fact
 341                 // to the rest of LyX.
 342                 ForkedcallsController & fcc = ForkedcallsController::get();
 343                 fcc.handleCompletedProcesses();
 344         }
 345
 346         cursor_timeout_.restart();
 347 }
 348
 349
 350 void WorkArea::displayMessage(lyx::docstring const & message)
 351 {
 352         lyx_view_.message(message);
 353 }
 354
 355 } // namespace frontend
 356 } // namespace lyx