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 #include "version.h"
  42
  43 #include "graphics/GraphicsImage.h"
  44 #include "graphics/GraphicsLoader.h"
  45
  46 #include "gettext.h"
  47 #include "support/filetools.h" // LibFileSearch
  48 #include "support/forkedcontr.h"
  49
  50 #include <boost/utility.hpp>
  51 #include <boost/bind.hpp>
  52 #include <boost/current_function.hpp>
  53
  54 using lyx::support::libFileSearch;
  55 using lyx::support::ForkedcallsController;
  56
  57 using std::endl;
  58 using std::min;
  59 using std::max;
  60 using std::string;
  61
  62
  63 namespace lyx {
  64 namespace frontend {
  65
  66 // FIXME: The SplashScreen should be transfered to the
  67 // LyXView and create a WorkArea only when a new buffer exists. This
  68 // will allow to call WorkArea::redraw() in the constructor.
  69 class SplashScreen : boost::noncopyable, boost::signals::trackable {
  70 public:
  71         /// This is a singleton class. Get the instance.
  72         static SplashScreen const & get();
  73         ///
  74         lyx::graphics::Image const * image() const { return loader_.image(); }
  75         ///
  76         string const & text() const { return text_; }
  77         ///
  78         LyXFont const & font() const { return font_; }
  79         ///
  80         void connect(lyx::graphics::Loader::slot_type const & slot) const {
  81                 loader_.connect(slot);
  82         }
  83         ///
  84         void startLoading() const {
  85                 if (loader_.status() == lyx::graphics::WaitingToLoad)
  86                         loader_.startLoading();
  87         }
  88
  89 private:
  90         /** Make the c-tor private so we can control how many objects
  91          *  are instantiated.
  92          */
  93         SplashScreen();
  94
  95         ///
  96         lyx::graphics::Loader loader_;
  97         /// The text to be written on top of the pixmap
  98         string const text_;
  99         /// in this font...
 100         LyXFont font_;
 101 };
 102
 103
 104 SplashScreen const & SplashScreen::get()
 105 {
 106         static SplashScreen singleton;
 107         return singleton;
 108 }
 109
 110
 111 SplashScreen::SplashScreen()
 112         : text_(lyx_version ? lyx_version : "unknown")
 113 {
 114         if (!lyxrc.show_banner)
 115                 return;
 116
 117         string const file = libFileSearch("images", "banner", "ppm");
 118         if (file.empty())
 119                 return;
 120
 121         // The font used to display the version info
 122         font_.setFamily(LyXFont::SANS_FAMILY);
 123         font_.setSeries(LyXFont::BOLD_SERIES);
 124         font_.setSize(LyXFont::SIZE_NORMAL);
 125         font_.setColor(LColor::yellow);
 126
 127         // Load up the graphics file
 128         loader_.reset(file);
 129 }
 130
 131 namespace {
 132
 133 // All the below connection objects are needed because of a bug in some
 134 // versions of GCC (<=2.96 are on the suspects list.) By having and assigning
 135 // to these connections we avoid a segfault upon startup, and also at exit.
 136 // (Lgb)
 137
 138 boost::signals::connection timecon;
 139
 140 } // anon namespace
 141
 142 WorkArea::WorkArea(LyXView & lyx_view)
 143         :  buffer_view_(0), lyx_view_(lyx_view), greyed_out_(true),
 144         cursor_visible_(false), cursor_timeout_(400)
 145 {
 146         // Start loading the pixmap as soon as possible
 147         if (lyxrc.show_banner) {
 148                 SplashScreen const & splash = SplashScreen::get();
 149                 splash.connect(boost::bind(&WorkArea::checkAndGreyOut, this));
 150                 splash.startLoading();
 151         }
 152
 153         // Setup the signals
 154         timecon = cursor_timeout_.timeout
 155                 .connect(boost::bind(&WorkArea::toggleCursor, this));
 156
 157         cursor_timeout_.start();
 158 }
 159
 160
 161 void WorkArea::setBufferView(BufferView * buffer_view)
 162 {
 163         if (buffer_view_) {
 164                 message_connection_.disconnect();
 165                 lyx_view_.disconnectBufferView();
 166         }
 167
 168         theApp->setBufferView(buffer_view);
 169
 170         hideCursor();
 171         buffer_view_ = buffer_view;
 172         toggleCursor();
 173
 174         message_connection_ = buffer_view_->message.connect(
 175                         boost::bind(&WorkArea::displayMessage, this, _1));
 176
 177         lyx_view_.connectBufferView(*buffer_view);
 178 }
 179
 180
 181 BufferView & WorkArea::bufferView()
 182 {
 183         return *buffer_view_;
 184 }
 185
 186
 187 BufferView const & WorkArea::bufferView() const
 188 {
 189         return *buffer_view_;
 190 }
 191
 192
 193 void WorkArea::checkAndGreyOut()
 194 {
 195         if (greyed_out_)
 196                 greyOut();
 197 }
 198
 199
 200 void WorkArea::redraw()
 201 {
 202         if (!buffer_view_)
 203                 return;
 204
 205         if (!buffer_view_->buffer()) {
 206                 greyOut();
 207                 updateScrollbar();
 208                 return;
 209         }
 210
 211         buffer_view_->updateMetrics(false);
 212
 213         updateScrollbar();
 214
 215         ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
 216         greyed_out_ = false;
 217         getPainter().start();
 218         paintText(*buffer_view_, vi, getPainter());
 219         lyxerr[Debug::WORKAREA] << "WorkArea::redraw screen" << endl;
 220         int const ymin = std::max(vi.y1, 0);
 221         int const ymax =
 222                 ( vi.p2 < vi.size - 1 ?  vi.y2 : height() );
 223         expose(0, ymin, width(), ymax - ymin);
 224         getPainter().end();
 225
 226         lyxerr[Debug::WORKAREA]
 227         << "  ymin = " << ymin << "  width() = " << width()
 228                 << "  ymax-ymin = " << ymax-ymin << std::endl;
 229
 230         if (lyxerr.debugging(Debug::WORKAREA)) {
 231                 buffer_view_->coordCache().dump();
 232         }
 233 }
 234
 235
 236 void WorkArea::processKeySym(LyXKeySymPtr key,
 237                                                          key_modifier::state state)
 238 {
 239         hideCursor();
 240
 241         theLyXFunc().setLyXView(&lyx_view_);
 242         theLyXFunc().processKeySym(key, state);
 243
 244         /* This is perhaps a bit of a hack. When we move
 245          * around, or type, it's nice to be able to see
 246          * the cursor immediately after the keypress. So
 247          * we reset the toggle timeout and force the visibility
 248          * of the cursor. Note we cannot do this inside
 249          * dispatch() itself, because that's called recursively.
 250          */
 251 //      if (buffer_view_->buffer())
 252         toggleCursor();
 253 }
 254
 255
 256 void WorkArea::dispatch(FuncRequest const & cmd0)
 257 {
 258         // Handle drag&drop
 259         if (cmd0.action == LFUN_FILE_OPEN) {
 260                 lyx_view_.dispatch(cmd0);
 261                 return;
 262         }
 263
 264         theLyXFunc().setLyXView(&lyx_view_);
 265
 266         buffer_view_->workAreaDispatch(cmd0);
 267
 268         // Skip these when selecting
 269         if (cmd0.action != LFUN_MOUSE_MOTION) {
 270                 lyx_view_.updateLayoutChoice();
 271                 lyx_view_.updateMenubar();
 272                 lyx_view_.updateToolbars();
 273         }
 274
 275         // Slight hack: this is only called currently when we
 276         // clicked somewhere, so we force through the display
 277         // of the new status here.
 278         lyx_view_.clearMessage();
 279
 280         redraw();
 281 }
 282
 283
 284 void WorkArea::resizeBufferView()
 285 {
 286         lyx_view_.busy(true);
 287         lyx_view_.message(_("Formatting document..."));
 288         buffer_view_->workAreaResize(width(), height());
 289         lyx_view_.updateLayoutChoice();
 290         redraw();
 291         lyx_view_.busy(false);
 292         lyx_view_.clearMessage();
 293 }
 294
 295
 296 void WorkArea::updateScrollbar()
 297 {
 298         buffer_view_->updateScrollbar();
 299         ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
 300         setScrollbarParams(scroll_.height, scroll_.position,
 301                 scroll_.lineScrollHeight);
 302 }
 303
 304
 305 void WorkArea::scrollBufferView(int position)
 306 {
 307         buffer_view_->scrollDocView(position);
 308         redraw();
 309         hideCursor();
 310         if (lyxrc.cursor_follows_scrollbar) {
 311                 buffer_view_->setCursorFromScrollbar();
 312                 lyx_view_.updateLayoutChoice();
 313         }
 314         toggleCursor();
 315 }
 316
 317
 318 void WorkArea::greyOut()
 319 {
 320         greyed_out_ = true;
 321         getPainter().start();
 322
 323         getPainter().fillRectangle(0, 0,
 324                 width(),
 325                 height(),
 326                 LColor::bottomarea);
 327
 328         // Add a splash screen to the centre of the work area
 329         SplashScreen const & splash = SplashScreen::get();
 330         lyx::graphics::Image const * const splash_image = splash.image();
 331         if (splash_image) {
 332                 int const w = splash_image->getWidth();
 333                 int const h = splash_image->getHeight();
 334
 335                 int x = (width() - w) / 2;
 336                 int y = (height() - h) / 2;
 337
 338                 getPainter().image(x, y, w, h, *splash_image);
 339
 340                 x += 260;
 341                 y += 265;
 342
 343                 string stext = splash.text();
 344                 docstring dstext(stext.begin(), stext.end());
 345                 getPainter().text(x, y, dstext, splash.font());
 346         }
 347         expose(0, 0, width(), height());
 348         getPainter().end();
 349 }
 350
 351
 352 void WorkArea::showCursor()
 353 {
 354         if (cursor_visible_)
 355                 return;
 356
 357         if (!buffer_view_->buffer())
 358                 return;
 359
 360         CursorShape shape = BAR_SHAPE;
 361
 362         LyXText const & text = *buffer_view_->getLyXText();
 363         LyXFont const & realfont = text.real_current_font;
 364         BufferParams const & bp = buffer_view_->buffer()->params();
 365         bool const samelang = realfont.language() == bp.language;
 366         bool const isrtl = realfont.isVisibleRightToLeft();
 367
 368         if (!samelang || isrtl != bp.language->rightToLeft()) {
 369                 shape = L_SHAPE;
 370                 if (isrtl)
 371                         shape = REVERSED_L_SHAPE;
 372         }
 373
 374         // The ERT language hack needs fixing up
 375         if (realfont.language() == latex_language)
 376                 shape = BAR_SHAPE;
 377
 378         LyXFont const font = buffer_view_->cursor().getFont();
 379         FontMetrics const & fm = theFontMetrics(font);
 380         int const asc = fm.maxAscent();
 381         int const des = fm.maxDescent();
 382         int h = asc + des;
 383         int x = 0;
 384         int y = 0;
 385         buffer_view_->cursor().getPos(x, y);
 386         y -= asc;
 387
 388         // if it doesn't touch the screen, don't try to show it
 389         if (y + h < 0 || y >= height())
 390                 return;
 391
 392         cursor_visible_ = true;
 393         showCursor(x, y, h, shape);
 394 }
 395
 396
 397 void WorkArea::hideCursor()
 398 {
 399         if (!cursor_visible_)
 400                 return;
 401
 402         cursor_visible_ = false;
 403         removeCursor();
 404 }
 405
 406
 407 void WorkArea::toggleCursor()
 408 {
 409         if (buffer_view_->buffer()) {
 410
 411                 if (cursor_visible_)
 412                         hideCursor();
 413                 else
 414                         showCursor();
 415
 416                 // Use this opportunity to deal with any child processes that
 417                 // have finished but are waiting to communicate this fact
 418                 // to the rest of LyX.
 419                 ForkedcallsController & fcc = ForkedcallsController::get();
 420                 fcc.handleCompletedProcesses();
 421         }
 422
 423         cursor_timeout_.restart();
 424 }
 425
 426
 427 void WorkArea::displayMessage(lyx::docstring const & message)
 428 {
 429         lyx_view_.message(message);
 430 }
 431
 432 } // namespace frontend
 433 } // namespace lyx