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.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 const topy = bv->top_y();
 228         int newtop = topy;
 229
 230
 231         if (y + desc - topy >= vheight)
 232                 newtop = y - 3 * vheight / 4;  // the scroll region must be so big!!
 233         else if (y - asc < topy && topy > 0)
 234                 newtop = y - vheight / 4;
 235
 236         newtop = max(newtop, 0); // can newtop ever be < 0? (Lgb)
 237
 238         if (newtop == topy)
 239                 return false;
 240
 241         bv->top_y(newtop);
 242         return true;
 243 }
 244
 245
 246 unsigned int LyXScreen::topCursorVisible(LyXText * text)
 247 {
 248         LyXCursor const & cursor = text->cursor;
 249         int top_y = text->bv()->top_y();
 250         int newtop = top_y;
 251         int const vheight = workarea().workHeight();
 252
 253         RowList::iterator row = text->cursorRow();
 254
 255         if (int(cursor.y() - row->baseline() + row->height() - top_y) >= vheight) {
 256                 if (row->height() < vheight
 257                     && row->height() > vheight / 4) {
 258                         newtop = cursor.y()
 259                                 + row->height()
 260                                 - row->baseline() - vheight;
 261                 } else {
 262                         // scroll down, the scroll region must be so big!!
 263                         newtop = cursor.y() - vheight / 2;
 264                 }
 265
 266         } else if (int(cursor.y() - row->baseline()) < top_y && top_y > 0) {
 267                 if (row->height() < vheight && row->height() > vheight / 4) {
 268                         newtop = cursor.y() - row->baseline();
 269                 } else {
 270                         // scroll up
 271                         newtop = cursor.y() - vheight / 2;
 272                         newtop = min(newtop, top_y);
 273                 }
 274         }
 275
 276         return max(newtop, 0);
 277 }
 278
 279
 280 bool LyXScreen::fitCursor(LyXText * text, BufferView * bv)
 281 {
 282         // Is a change necessary?
 283         int const newtop = topCursorVisible(text);
 284         bool const result = (newtop != bv->top_y());
 285         bv->top_y(newtop);
 286         return result;
 287 }
 288
 289
 290 void LyXScreen::redraw(BufferView & bv)
 291 {
 292         greyed_out_ = !bv.text;
 293
 294         if (greyed_out_) {
 295                 greyOut();
 296                 return;
 297         }
 298
 299         workarea().getPainter().start();
 300
 301         hideCursor();
 302
 303         int const y = paintText(bv);
 304
 305         // maybe we have to clear the screen at the bottom
 306         int const y2 = workarea().workHeight();
 307         if (y < y2 && !bv.text->isInInset()) {
 308                 workarea().getPainter().fillRectangle(0, y,
 309                         workarea().workWidth(), y2 - y,
 310                         LColor::bottomarea);
 311         }
 312
 313         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 314
 315         workarea().getPainter().end();
 316 }
 317
 318
 319 void LyXScreen::greyOut()
 320 {
 321         if (!greyed_out_)
 322                 return;
 323
 324         workarea().getPainter().start();
 325
 326         workarea().getPainter().fillRectangle(0, 0,
 327                 workarea().workWidth(),
 328                 workarea().workHeight(),
 329                 LColor::bottomarea);
 330
 331         // Add a splash screen to the centre of the work area
 332         SplashScreen const & splash = SplashScreen::get();
 333         lyx::graphics::Image const * const splash_image = splash.image();
 334         if (splash_image) {
 335                 int const w = splash_image->getWidth();
 336                 int const h = splash_image->getHeight();
 337
 338                 int x = (workarea().workWidth() - w) / 2;
 339                 int y = (workarea().workHeight() - h) / 2;
 340
 341                 workarea().getPainter().image(x, y, w, h, *splash_image);
 342
 343                 x += 260;
 344                 y += 265;
 345
 346                 workarea().getPainter().text(x, y, splash.text(), splash.font());
 347         }
 348         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 349         workarea().getPainter().end();
 350 }