src/frontends/screen.C

   1 /**
   2  * \file screen.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  *
   8  * Full author contact details are available in file CREDITS
   9  *
  10  * Splash screen code added by Angus Leeming
  11  */
  12
  13 #include <config.h>
  14
  15 #include "screen.h"
  16
  17 #include "lyxtext.h"
  18 #include "lyxrc.h"
  19 #include "lyxrow.h"
  20 #include "BufferView.h"
  21 #include "buffer.h"
  22 #include "WorkArea.h"
  23 #include "Painter.h"
  24 #include "font_metrics.h"
  25 #include "language.h"
  26 #include "debug.h"
  27 #include "rowpainter.h"
  28 #include "insets/updatableinset.h"
  29 #include "lyx_gui.h"
  30 #include "metricsinfo.h"
  31
  32 // Splash screen-specific stuff
  33 #include "lyxfont.h"
  34 #include "version.h"
  35
  36 #include "graphics/GraphicsLoader.h"
  37 #include "graphics/GraphicsImage.h"
  38
  39 #include "support/filetools.h" // LibFileSearch
  40
  41 #include <boost/utility.hpp>
  42 #include <boost/bind.hpp>
  43 #include <boost/signals/trackable.hpp>
  44
  45 using namespace lyx::support;
  46
  47 using std::min;
  48 using std::max;
  49 using std::endl;
  50
  51 namespace {
  52
  53 class SplashScreen : boost::noncopyable, boost::signals::trackable {
  54 public:
  55         /// This is a singleton class. Get the instance.
  56         static SplashScreen const & get();
  57         ///
  58         lyx::graphics::Image const * image() const { return loader_.image(); }
  59         ///
  60         string const & text() const { return text_; }
  61         ///
  62         LyXFont const & font() const { return font_; }
  63         ///
  64         void connect(lyx::graphics::Loader::slot_type const & slot) const {
  65                 loader_.connect(slot);
  66         }
  67         ///
  68         void startLoading() const {
  69                 if (loader_.status() == lyx::graphics::WaitingToLoad)
  70                         loader_.startLoading();
  71         }
  72
  73 private:
  74         /** Make the c-tor private so we can control how many objects
  75          *  are instantiated.
  76          */
  77         SplashScreen();
  78
  79         ///
  80         lyx::graphics::Loader loader_;
  81         /// The text to be written on top of the pixmap
  82         string const text_;
  83         /// in this font...
  84         LyXFont font_;
  85 };
  86
  87
  88 SplashScreen const & SplashScreen::get()
  89 {
  90         static SplashScreen singleton;
  91         return singleton;
  92 }
  93
  94
  95 SplashScreen::SplashScreen()
  96         : text_(lyx_version ? lyx_version : "unknown")
  97 {
  98         if (!lyxrc.show_banner)
  99                 return;
 100
 101         string const file = LibFileSearch("images", "banner", "ppm");
 102         if (file.empty())
 103                 return;
 104
 105         // The font used to display the version info
 106         font_.setFamily(LyXFont::SANS_FAMILY);
 107         font_.setSeries(LyXFont::BOLD_SERIES);
 108         font_.setSize(LyXFont::SIZE_NORMAL);
 109         font_.setColor(LColor::yellow);
 110
 111         // Load up the graphics file
 112         loader_.reset(file);
 113 }
 114
 115 } // namespace anon
 116
 117
 118 LyXScreen::LyXScreen()
 119         : cursor_visible_(false), greyed_out_(true)
 120 {
 121         // Start loading the pixmap as soon as possible
 122         if (lyxrc.show_banner) {
 123                 SplashScreen const & splash = SplashScreen::get();
 124                 splash.connect(boost::bind(&LyXScreen::greyOut, this));
 125                 splash.startLoading();
 126         }
 127 }
 128
 129
 130 LyXScreen::~LyXScreen()
 131 {
 132 }
 133
 134
 135 void LyXScreen::showCursor(BufferView & bv)
 136 {
 137         // this is needed to make sure we copy back the right
 138         // pixmap on the hide for the Qt frontend
 139         lyx_gui::sync_events();
 140
 141         if (cursor_visible_)
 142                 return;
 143
 144         if (!bv.available())
 145                 return;
 146
 147         Cursor_Shape shape = BAR_SHAPE;
 148
 149         LyXText const & text = *bv.getLyXText();
 150         LyXFont const & realfont = text.real_current_font;
 151         BufferParams const & bp = bv.buffer()->params;
 152         bool const samelang = realfont.language() == bp.language;
 153         bool const isrtl = realfont.isVisibleRightToLeft();
 154
 155         if (!samelang || isrtl != bp.language->RightToLeft()) {
 156                 shape = L_SHAPE;
 157                 if (isrtl)
 158                         shape = REVERSED_L_SHAPE;
 159         }
 160
 161         int ascent = font_metrics::maxAscent(realfont);
 162         int descent = font_metrics::maxDescent(realfont);
 163         int h = ascent + descent;
 164         int x = 0;
 165         int y = 0;
 166         int const top_y = bv.text->top_y();
 167
 168         if (bv.theLockingInset()) {
 169                 // Would be nice to clean this up to make some understandable sense...
 170                 UpdatableInset * inset = bv.theLockingInset();
 171                 inset->getCursor(bv, x, y);
 172
 173                 // Non-obvious. The reason we have to have these
 174                 // extra checks is that the ->getCursor() calls rely
 175                 // on the inset's own knowledge of its screen position.
 176                 // If we scroll up or down in a big enough increment, the
 177                 // inset->draw() is not called: this doesn't update
 178                 // inset.top_baseline, so getCursor() returns an old value.
 179                 // Ugly as you like.
 180                 int bx, by;
 181                 inset->getCursorPos(&bv, bx, by);
 182                 by += inset->insetInInsetY() + bv.text->cursor.iy();
 183                 if (by < top_y)
 184                         return;
 185                 if (by > top_y + workarea().workHeight())
 186                         return;
 187         } else {
 188                 x = bv.text->cursor.x();
 189                 y = bv.text->cursor.y();
 190                 y -= top_y;
 191         }
 192
 193         y -= ascent;
 194
 195         // if it doesn't fit entirely on the screen, don't try to show it
 196         if (y < 0 || y + h > workarea().workHeight())
 197                 return;
 198
 199         cursor_visible_ = true;
 200         showCursor(x, y, h, shape);
 201 }
 202
 203
 204 void LyXScreen::hideCursor()
 205 {
 206         if (!cursor_visible_)
 207                 return;
 208
 209         cursor_visible_ = false;
 210         removeCursor();
 211 }
 212
 213
 214 void LyXScreen::toggleCursor(BufferView & bv)
 215 {
 216         if (cursor_visible_)
 217                 hideCursor();
 218         else
 219                 showCursor(bv);
 220 }
 221
 222
 223 bool LyXScreen::fitManualCursor(BufferView * bv, LyXText * text,
 224         int /*x*/, int y, int asc, int desc)
 225 {
 226         int const vheight = workarea().workHeight();
 227         int newtop = text->top_y();
 228
 229         if (y + desc - text->top_y() >= vheight)
 230                 newtop = y - 3 * vheight / 4;  // the scroll region must be so big!!
 231         else if (y - asc < text->top_y() && text->top_y() > 0)
 232                 newtop = y - vheight / 4;
 233
 234         newtop = max(newtop, 0); // can newtop ever be < 0? (Lgb)
 235
 236         if (newtop == text->top_y())
 237                 return false;
 238
 239         draw(text, bv, newtop);
 240         text->top_y(newtop);
 241         return true;
 242 }
 243
 244
 245 unsigned int LyXScreen::topCursorVisible(LyXText * text)
 246 {
 247         LyXCursor const & cursor = text->cursor;
 248         int top_y = text->top_y();
 249         int newtop = top_y;
 250         int const vheight = workarea().workHeight();
 251
 252         RowList::iterator row = text->cursorRow();
 253
 254 #warning SUPER HACK DISABLED (Lgb)
 255 #if 0
 256         // Is this a hack? Yes, probably... (Lgb)
 257         if (!row)
 258                 return max(newtop, 0);
 259 #endif
 260         if (cursor.y() - row->baseline() + row->height() - top_y >= vheight) {
 261                 if (row->height() < vheight
 262                     && row->height() > vheight / 4) {
 263                         newtop = cursor.y()
 264                                 + row->height()
 265                                 - row->baseline() - vheight;
 266                 } else {
 267                         // scroll down, the scroll region must be so big!!
 268                         newtop = cursor.y() - vheight / 2;
 269                 }
 270
 271         } else if (int(cursor.y() - row->baseline()) < top_y && top_y > 0) {
 272                 if (row->height() < vheight && row->height() > vheight / 4) {
 273                         newtop = cursor.y() - row->baseline();
 274                 } else {
 275                         // scroll up
 276                         newtop = cursor.y() - vheight / 2;
 277                         newtop = min(newtop, top_y);
 278                 }
 279         }
 280
 281         newtop = max(newtop, 0);
 282
 283         return newtop;
 284 }
 285
 286
 287 bool LyXScreen::fitCursor(LyXText * text, BufferView * bv)
 288 {
 289         // Is a change necessary?
 290         int const newtop = topCursorVisible(text);
 291         bool const result = (newtop != text->top_y());
 292         if (result) {
 293                 draw(text, bv, newtop);
 294         }
 295
 296         return result;
 297 }
 298
 299
 300 void LyXScreen::update(BufferView & bv, int yo, int xo)
 301 {
 302         LyXText * text = bv.text;
 303
 304         workarea().getPainter().start();
 305
 306         if (text->needRefresh()) {
 307                 int const vwidth = workarea().workWidth();
 308                 int const vheight = workarea().workHeight();
 309                 text->updateRowPositions();
 310                 int const y = 0;
 311                 drawFromTo(text, &bv, y, vheight, yo, xo);
 312                 expose(0, y, vwidth, vheight - y);
 313         }
 314
 315         workarea().getPainter().end();
 316 }
 317
 318
 319 void LyXScreen::toggleSelection(LyXText * text, BufferView * bv,
 320                                 bool kill_selection,
 321                                 int yo, int xo)
 322 {
 323         // only if there is a selection
 324         if (!text->selection.set()) return;
 325
 326         int const bottom = min(
 327                 max(static_cast<int>(text->selection.end.y()
 328                                      - text->getRow(text->selection.end)->baseline()
 329                                      + text->getRow(text->selection.end)->height()),
 330                     text->top_y()),
 331                 static_cast<int>(text->top_y() + workarea().workHeight()));
 332         int const top = min(
 333                 max(static_cast<int>(text->selection.start.y() -
 334                                      text->getRow(text->selection.start)->baseline()),
 335                     text->top_y()),
 336                 static_cast<int>(text->top_y() + workarea().workHeight()));
 337
 338         if (kill_selection)
 339                 text->selection.set(false);
 340
 341         workarea().getPainter().start();
 342
 343         drawFromTo(text, bv, top - text->top_y(), bottom - text->top_y(),
 344                    yo, xo);
 345         expose(0, top - text->top_y(),
 346                workarea().workWidth(),
 347                bottom - text->top_y() - (top - text->top_y()));
 348
 349         workarea().getPainter().end();
 350 }
 351
 352
 353 void LyXScreen::redraw(BufferView * bv, LyXText * text)
 354 {
 355         greyed_out_ = !text;
 356
 357         if (greyed_out_) {
 358                 greyOut();
 359                 return;
 360         }
 361
 362         workarea().getPainter().start();
 363
 364         text->updateRowPositions();
 365         drawFromTo(text, bv, 0, workarea().workHeight(), 0, 0);
 366         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 367
 368         workarea().getPainter().end();
 369 }
 370
 371
 372 void LyXScreen::greyOut()
 373 {
 374         if (!greyed_out_)
 375                 return;
 376
 377         workarea().getPainter().start();
 378
 379         workarea().getPainter().fillRectangle(0, 0,
 380                 workarea().workWidth(),
 381                 workarea().workHeight(),
 382                 LColor::bottomarea);
 383
 384         // Add a splash screen to the centre of the work area
 385         SplashScreen const & splash = SplashScreen::get();
 386         lyx::graphics::Image const * const splash_image = splash.image();
 387         if (splash_image) {
 388                 int const w = splash_image->getWidth();
 389                 int const h = splash_image->getHeight();
 390
 391                 int x = (workarea().workWidth() - w) / 2;
 392                 int y = (workarea().workHeight() - h) / 2;
 393
 394                 workarea().getPainter().image(x, y, w, h, *splash_image);
 395
 396                 string const & splash_text  = splash.text();
 397                 LyXFont const & splash_font = splash.font();
 398
 399                 x += 260;
 400                 y += 265;
 401
 402                 workarea().getPainter().text(x, y, splash_text, splash_font);
 403         }
 404         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 405         workarea().getPainter().end();
 406 }
 407
 408
 409 void LyXScreen::drawFromTo(LyXText * text, BufferView * bv,
 410         int y1, int y2, int yo, int xo)
 411 {
 412         lyxerr[Debug::GUI] << "screen: drawFromTo " << y1 << '-' << y2 << endl;
 413         hideCursor();
 414
 415         int const topy = text->top_y();
 416         int y_text = topy + y1;
 417         RowList::iterator rit = text->getRowNearY(y_text);
 418         int y = y_text - topy;
 419
 420         y = paintRows(*bv, *text, rit, xo, y, y, y2, yo);
 421
 422         // maybe we have to clear the screen at the bottom
 423         if (y < y2 && !text->isInInset()) {
 424                 workarea().getPainter().fillRectangle(0, y,
 425                         workarea().workWidth(), y2 - y,
 426                         LColor::bottomarea);
 427         }
 428 }