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 #include "font_metrics.h"
  17 #include "lyx_gui.h"
  18 #include "Painter.h"
  19 #include "WorkArea.h"
  20
  21 #include "BufferView.h"
  22 #include "buffer.h"
  23 #include "bufferparams.h"
  24 #include "coordcache.h"
  25 #include "cursor.h"
  26 #include "debug.h"
  27 #include "language.h"
  28 #include "LColor.h"
  29 #include "lyxfont.h"
  30 #include "lyxrc.h"
  31 #include "lyxrow.h"
  32 #include "lyxtext.h"
  33 #include "metricsinfo.h"
  34 #include "paragraph.h"
  35 #include "rowpainter.h"
  36 #include "version.h"
  37
  38 #include "insets/updatableinset.h"
  39
  40 #include "graphics/GraphicsImage.h"
  41 #include "graphics/GraphicsLoader.h"
  42
  43 #include "support/filetools.h" // LibFileSearch
  44
  45 #include <boost/utility.hpp>
  46 #include <boost/bind.hpp>
  47 #include <boost/signals/trackable.hpp>
  48
  49 using lyx::support::LibFileSearch;
  50
  51 using std::endl;
  52 using std::min;
  53 using std::max;
  54 using std::string;
  55
  56
  57 namespace {
  58
  59 class SplashScreen : boost::noncopyable, boost::signals::trackable {
  60 public:
  61         /// This is a singleton class. Get the instance.
  62         static SplashScreen const & get();
  63         ///
  64         lyx::graphics::Image const * image() const { return loader_.image(); }
  65         ///
  66         string const & text() const { return text_; }
  67         ///
  68         LyXFont const & font() const { return font_; }
  69         ///
  70         void connect(lyx::graphics::Loader::slot_type const & slot) const {
  71                 loader_.connect(slot);
  72         }
  73         ///
  74         void startLoading() const {
  75                 if (loader_.status() == lyx::graphics::WaitingToLoad)
  76                         loader_.startLoading();
  77         }
  78
  79 private:
  80         /** Make the c-tor private so we can control how many objects
  81          *  are instantiated.
  82          */
  83         SplashScreen();
  84
  85         ///
  86         lyx::graphics::Loader loader_;
  87         /// The text to be written on top of the pixmap
  88         string const text_;
  89         /// in this font...
  90         LyXFont font_;
  91 };
  92
  93
  94 SplashScreen const & SplashScreen::get()
  95 {
  96         static SplashScreen singleton;
  97         return singleton;
  98 }
  99
 100
 101 SplashScreen::SplashScreen()
 102         : text_(lyx_version ? lyx_version : "unknown")
 103 {
 104         if (!lyxrc.show_banner)
 105                 return;
 106
 107         string const file = LibFileSearch("images", "banner", "ppm");
 108         if (file.empty())
 109                 return;
 110
 111         // The font used to display the version info
 112         font_.setFamily(LyXFont::SANS_FAMILY);
 113         font_.setSeries(LyXFont::BOLD_SERIES);
 114         font_.setSize(LyXFont::SIZE_NORMAL);
 115         font_.setColor(LColor::yellow);
 116
 117         // Load up the graphics file
 118         loader_.reset(file);
 119 }
 120
 121 } // namespace anon
 122
 123
 124 LyXScreen::LyXScreen()
 125         : greyed_out_(true), cursor_visible_(false), sync_allowed_(true)
 126 {
 127         // Start loading the pixmap as soon as possible
 128         if (lyxrc.show_banner) {
 129                 SplashScreen const & splash = SplashScreen::get();
 130                 splash.connect(boost::bind(&LyXScreen::checkAndGreyOut, this));
 131                 splash.startLoading();
 132         }
 133 }
 134
 135
 136 LyXScreen::~LyXScreen()
 137 {
 138 }
 139
 140
 141 void LyXScreen::checkAndGreyOut()
 142 {
 143         if (greyed_out_)
 144                 greyOut();
 145 }
 146
 147
 148 void LyXScreen::showCursor(BufferView & bv)
 149 {
 150         // This code is currently meaningful only for the Qt frontend.
 151         // This is the place (like below in hideCursor) where
 152         // processEvents is being called, and things like keystrokes and
 153         // mouse clicks are being handed to the LyX core, once every
 154         // cursor blink.
 155         // THERE IS NOT SUPPOSED TO BE ANY OTHER CALL TO processEvents
 156         // ANYWHERE ELSE.
 157         // in BufferView::Pimpl::update() and here, the sync_allowed_
 158         // guard is set/cleared which is used here to prevent recursive
 159         // calls to screen update. startUpdating() and doneUpdating() in
 160         // coordcache again contain asserts to detect such recursion.
 161         if (sync_allowed_)
 162                 lyx_gui::sync_events();
 163
 164         if (cursor_visible_)
 165                 return;
 166
 167         if (!bv.available())
 168                 return;
 169
 170         Cursor_Shape shape = BAR_SHAPE;
 171
 172         LyXText const & text = *bv.getLyXText();
 173         LyXFont const & realfont = text.real_current_font;
 174         BufferParams const & bp = bv.buffer()->params();
 175         bool const samelang = realfont.language() == bp.language;
 176         bool const isrtl = realfont.isVisibleRightToLeft();
 177
 178         if (!samelang || isrtl != bp.language->RightToLeft()) {
 179                 shape = L_SHAPE;
 180                 if (isrtl)
 181                         shape = REVERSED_L_SHAPE;
 182         }
 183
 184         // The ERT language hack needs fixing up
 185         if (realfont.language() == latex_language)
 186                 shape = BAR_SHAPE;
 187
 188         LyXFont const font = bv.cursor().getFont();
 189         int const asc = font_metrics::maxAscent(font);
 190         int const des = font_metrics::maxDescent(font);
 191         int h = asc + des;
 192         int x = 0;
 193         int y = 0;
 194         bv.cursor().getPos(x, y);
 195         y -= asc;
 196         //lyxerr << "LyXScreen::showCursor x: " << x << " y: " << y << endl;
 197
 198         // if it doesn't touch the screen, don't try to show it
 199         if (y + h < 0 || y >= workarea().workHeight())
 200                 return;
 201
 202         cursor_visible_ = true;
 203         showCursor(x, y, h, shape);
 204 }
 205
 206
 207 void LyXScreen::hideCursor()
 208 {
 209         if (sync_allowed_)
 210                 lyx_gui::sync_events();
 211
 212         if (!cursor_visible_)
 213                 return;
 214
 215         cursor_visible_ = false;
 216         removeCursor();
 217 }
 218
 219
 220 void LyXScreen::toggleCursor(BufferView & bv)
 221 {
 222         if (cursor_visible_)
 223                 hideCursor();
 224         else
 225                 showCursor(bv);
 226 }
 227
 228
 229 void LyXScreen::redraw(BufferView & bv, ViewMetricsInfo const & vi)
 230 {
 231         greyed_out_ = false;
 232         workarea().getPainter().start();
 233         paintText(bv, vi);
 234         lyxerr[Debug::DEBUG] << "Redraw screen" << endl;
 235         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 236         workarea().getPainter().end();
 237         theCoords.doneUpdating();
 238         sync_allowed_ = true;
 239 }
 240
 241
 242 void LyXScreen::greyOut()
 243 {
 244         greyed_out_ = true;
 245         workarea().getPainter().start();
 246
 247         workarea().getPainter().fillRectangle(0, 0,
 248                 workarea().workWidth(),
 249                 workarea().workHeight(),
 250                 LColor::bottomarea);
 251
 252         // Add a splash screen to the centre of the work area
 253         SplashScreen const & splash = SplashScreen::get();
 254         lyx::graphics::Image const * const splash_image = splash.image();
 255         if (splash_image) {
 256                 int const w = splash_image->getWidth();
 257                 int const h = splash_image->getHeight();
 258
 259                 int x = (workarea().workWidth() - w) / 2;
 260                 int y = (workarea().workHeight() - h) / 2;
 261
 262                 workarea().getPainter().image(x, y, w, h, *splash_image);
 263
 264                 x += 260;
 265                 y += 265;
 266
 267                 workarea().getPainter().text(x, y, splash.text(), splash.font());
 268         }
 269         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 270         workarea().getPainter().end();
 271 }