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/forkedcontr.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
 147         updateScrollbar();
 148
 149         ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
 150         greyed_out_ = false;
 151
 152         if (lyxerr.debugging(Debug::WORKAREA)) {
 153                 lyxerr[Debug::WORKAREA] << "WorkArea::redraw screen" << endl;
 154         }
 155         int const ymin = std::max(vi.y1, 0);
 156         int const ymax = vi.p2 < vi.size - 1 ? vi.y2 : height();
 157
 158         expose(0, ymin, width(), ymax - ymin);
 159
 160         //lyxerr[Debug::WORKAREA]
 161         //<< "  ymin = " << ymin << "  width() = " << width()
 162 //              << "  ymax-ymin = " << ymax-ymin << std::endl;
 163
 164         if (lyxerr.debugging(Debug::WORKAREA))
 165                 buffer_view_->coordCache().dump();
 166 }
 167
 168
 169 void WorkArea::processKeySym(LyXKeySymPtr key, key_modifier::state state)
 170 {
 171         // In order to avoid bad surprise in the middle of an operation, we better stop
 172         // the blinking cursor.
 173         stopBlinkingCursor();
 174
 175         theLyXFunc().setLyXView(&lyx_view_);
 176         theLyXFunc().processKeySym(key, state);
 177
 178         /* When we move around, or type, it's nice to be able to see
 179          * the cursor immediately after the keypress.
 180          */
 181         startBlinkingCursor();
 182 }
 183
 184
 185 void WorkArea::dispatch(FuncRequest const & cmd0, key_modifier::state k)
 186 {
 187         // Handle drag&drop
 188         if (cmd0.action == LFUN_FILE_OPEN) {
 189                 lyx_view_.dispatch(cmd0);
 190                 return;
 191         }
 192
 193         theLyXFunc().setLyXView(&lyx_view_);
 194
 195         FuncRequest cmd;
 196
 197         if (cmd0.action == LFUN_MOUSE_PRESS) {
 198                 if (k == key_modifier::shift)
 199                         cmd = FuncRequest(cmd0, "region-select");
 200                 else if (k == key_modifier::ctrl)
 201                         cmd = FuncRequest(cmd0, "paragraph-select");
 202                 else
 203                         cmd = cmd0;
 204         }
 205         else
 206                 cmd = cmd0;
 207
 208         // In order to avoid bad surprise in the middle of an operation, we better stop
 209         // the blinking cursor.
 210         if (!(cmd.action == LFUN_MOUSE_MOTION
 211                 && cmd.button() == mouse_button::none))
 212                 stopBlinkingCursor();
 213
 214         bool const needRedraw = buffer_view_->workAreaDispatch(cmd);
 215
 216         if (needRedraw)
 217                 redraw();
 218
 219         // Skip these when selecting
 220         if (cmd.action != LFUN_MOUSE_MOTION) {
 221                 lyx_view_.updateLayoutChoice();
 222                 lyx_view_.updateMenubar();
 223                 lyx_view_.updateToolbars();
 224         }
 225
 226         // GUI tweaks except with mouse motion with no button pressed.
 227         if (!(cmd.action == LFUN_MOUSE_MOTION
 228                 && cmd.button() == mouse_button::none)) {
 229                 // Slight hack: this is only called currently when we
 230                 // clicked somewhere, so we force through the display
 231                 // of the new status here.
 232                 lyx_view_.clearMessage();
 233
 234                 // Show the cursor immediately after any operation.
 235                 startBlinkingCursor();
 236         }
 237 }
 238
 239
 240 void WorkArea::resizeBufferView()
 241 {
 242         lyx_view_.busy(true);
 243         lyx_view_.message(_("Formatting document..."));
 244         buffer_view_->workAreaResize(width(), height());
 245         lyx_view_.updateLayoutChoice();
 246         lyx_view_.busy(false);
 247         lyx_view_.clearMessage();
 248 }
 249
 250
 251 void WorkArea::updateScrollbar()
 252 {
 253         buffer_view_->updateScrollbar();
 254         ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
 255         setScrollbarParams(scroll_.height, scroll_.position,
 256                 scroll_.lineScrollHeight);
 257 }
 258
 259
 260 void WorkArea::scrollBufferView(int position)
 261 {
 262         stopBlinkingCursor();
 263         buffer_view_->scrollDocView(position);
 264         redraw();
 265         if (lyxrc.cursor_follows_scrollbar) {
 266                 buffer_view_->setCursorFromScrollbar();
 267                 lyx_view_.updateLayoutChoice();
 268         }
 269         // Show the cursor immediately after any operation.
 270         startBlinkingCursor();
 271 }
 272
 273
 274 void WorkArea::showCursor()
 275 {
 276         if (cursor_visible_)
 277                 return;
 278
 279         if (!buffer_view_->buffer())
 280                 return;
 281
 282         CursorShape shape = BAR_SHAPE;
 283
 284         LyXText const & text = *buffer_view_->cursor().innerText();
 285         LyXFont const & realfont = text.real_current_font;
 286         BufferParams const & bp = buffer_view_->buffer()->params();
 287         bool const samelang = realfont.language() == bp.language;
 288         bool const isrtl = realfont.isVisibleRightToLeft();
 289
 290         if (!samelang || isrtl != bp.language->rightToLeft()) {
 291                 shape = L_SHAPE;
 292                 if (isrtl)
 293                         shape = REVERSED_L_SHAPE;
 294         }
 295
 296         // The ERT language hack needs fixing up
 297         if (realfont.language() == latex_language)
 298                 shape = BAR_SHAPE;
 299
 300         LyXFont const font = buffer_view_->cursor().getFont();
 301         FontMetrics const & fm = theFontMetrics(font);
 302         int const asc = fm.maxAscent();
 303         int const des = fm.maxDescent();
 304         int h = asc + des;
 305         int x = 0;
 306         int y = 0;
 307         buffer_view_->cursor().getPos(x, y);
 308         y -= asc;
 309
 310         // if it doesn't touch the screen, don't try to show it
 311         if (y + h < 0 || y >= height())
 312                 return;
 313
 314         cursor_visible_ = true;
 315         showCursor(x, y, h, shape);
 316 }
 317
 318
 319 void WorkArea::hideCursor()
 320 {
 321         if (!cursor_visible_)
 322                 return;
 323
 324         cursor_visible_ = false;
 325         removeCursor();
 326 }
 327
 328
 329 void WorkArea::toggleCursor()
 330 {
 331         if (buffer_view_->buffer()) {
 332
 333                 if (cursor_visible_)
 334                         hideCursor();
 335                 else
 336                         showCursor();
 337
 338                 // Use this opportunity to deal with any child processes that
 339                 // have finished but are waiting to communicate this fact
 340                 // to the rest of LyX.
 341                 ForkedcallsController & fcc = ForkedcallsController::get();
 342                 fcc.handleCompletedProcesses();
 343         }
 344
 345         cursor_timeout_.restart();
 346 }
 347
 348
 349 void WorkArea::displayMessage(lyx::docstring const & message)
 350 {
 351         lyx_view_.message(message);
 352 }
 353
 354 } // namespace frontend
 355 } // namespace lyx