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 "cursor.h"
  25 #include "debug.h"
  26 #include "language.h"
  27 #include "LColor.h"
  28 #include "lyxfont.h"
  29 #include "lyxrc.h"
  30 #include "lyxrow.h"
  31 #include "lyxtext.h"
  32 #include "metricsinfo.h"
  33 #include "paragraph.h"
  34 #include "rowpainter.h"
  35 #include "version.h"
  36
  37 #include "insets/updatableinset.h"
  38
  39 #include "graphics/GraphicsImage.h"
  40 #include "graphics/GraphicsLoader.h"
  41
  42 #include "support/filetools.h" // LibFileSearch
  43
  44 #include <boost/utility.hpp>
  45 #include <boost/bind.hpp>
  46 #include <boost/signals/trackable.hpp>
  47
  48 using lyx::support::LibFileSearch;
  49
  50 using std::endl;
  51 using std::min;
  52 using std::max;
  53 using std::string;
  54
  55
  56 namespace {
  57
  58 class SplashScreen : boost::noncopyable, boost::signals::trackable {
  59 public:
  60         /// This is a singleton class. Get the instance.
  61         static SplashScreen const & get();
  62         ///
  63         lyx::graphics::Image const * image() const { return loader_.image(); }
  64         ///
  65         string const & text() const { return text_; }
  66         ///
  67         LyXFont const & font() const { return font_; }
  68         ///
  69         void connect(lyx::graphics::Loader::slot_type const & slot) const {
  70                 loader_.connect(slot);
  71         }
  72         ///
  73         void startLoading() const {
  74                 if (loader_.status() == lyx::graphics::WaitingToLoad)
  75                         loader_.startLoading();
  76         }
  77
  78 private:
  79         /** Make the c-tor private so we can control how many objects
  80          *  are instantiated.
  81          */
  82         SplashScreen();
  83
  84         ///
  85         lyx::graphics::Loader loader_;
  86         /// The text to be written on top of the pixmap
  87         string const text_;
  88         /// in this font...
  89         LyXFont font_;
  90 };
  91
  92
  93 SplashScreen const & SplashScreen::get()
  94 {
  95         static SplashScreen singleton;
  96         return singleton;
  97 }
  98
  99
 100 SplashScreen::SplashScreen()
 101         : text_(lyx_version ? lyx_version : "unknown")
 102 {
 103         if (!lyxrc.show_banner)
 104                 return;
 105
 106         string const file = LibFileSearch("images", "banner", "ppm");
 107         if (file.empty())
 108                 return;
 109
 110         // The font used to display the version info
 111         font_.setFamily(LyXFont::SANS_FAMILY);
 112         font_.setSeries(LyXFont::BOLD_SERIES);
 113         font_.setSize(LyXFont::SIZE_NORMAL);
 114         font_.setColor(LColor::yellow);
 115
 116         // Load up the graphics file
 117         loader_.reset(file);
 118 }
 119
 120 } // namespace anon
 121
 122
 123 LyXScreen::LyXScreen()
 124         : cursor_visible_(false), greyed_out_(true)
 125 {
 126         // Start loading the pixmap as soon as possible
 127         if (lyxrc.show_banner) {
 128                 SplashScreen const & splash = SplashScreen::get();
 129                 splash.connect(boost::bind(&LyXScreen::greyOut, this));
 130                 splash.startLoading();
 131         }
 132 }
 133
 134
 135 LyXScreen::~LyXScreen()
 136 {
 137 }
 138
 139
 140 void LyXScreen::showCursor(BufferView & bv)
 141 {
 142         // this is needed to make sure we copy back the right
 143         // pixmap on the hide for the Qt frontend
 144         lyx_gui::sync_events();
 145
 146         if (cursor_visible_)
 147                 return;
 148
 149         if (!bv.available())
 150                 return;
 151
 152         Cursor_Shape shape = BAR_SHAPE;
 153
 154         LyXText const & text = *bv.getLyXText();
 155         LyXFont const & realfont = text.real_current_font;
 156         BufferParams const & bp = bv.buffer()->params();
 157         bool const samelang = realfont.language() == bp.language;
 158         bool const isrtl = realfont.isVisibleRightToLeft();
 159
 160         if (!samelang || isrtl != bp.language->RightToLeft()) {
 161                 shape = L_SHAPE;
 162                 if (isrtl)
 163                         shape = REVERSED_L_SHAPE;
 164         }
 165
 166         // The ERT language hack needs fixing up
 167         if (realfont.language() == latex_language)
 168                 shape = BAR_SHAPE;
 169
 170         int ascent = font_metrics::maxAscent(realfont);
 171         int descent = font_metrics::maxDescent(realfont);
 172         int h = ascent + descent;
 173         int x = 0;
 174         int y = 0;
 175         bv.cursor().getPos(x, y);
 176         y -= ascent + bv.top_y();
 177         //lyxerr << "LyXScreen::showCursor x: " << x << " y: " << y << endl;
 178
 179         // if it doesn't fit entirely on the screen, don't try to show it
 180         if (y < 0 || y + h > workarea().workHeight())
 181                 return;
 182
 183         cursor_visible_ = true;
 184         showCursor(x, y, h, shape);
 185 }
 186
 187
 188 void LyXScreen::hideCursor()
 189 {
 190         if (!cursor_visible_)
 191                 return;
 192
 193         cursor_visible_ = false;
 194         removeCursor();
 195 }
 196
 197
 198 void LyXScreen::toggleCursor(BufferView & bv)
 199 {
 200         if (cursor_visible_)
 201                 hideCursor();
 202         else
 203                 showCursor(bv);
 204 }
 205
 206
 207 bool LyXScreen::fitCursor(BufferView * bv)
 208 {
 209         int const top_y = bv->top_y();
 210         int const h = workarea().workHeight();
 211         int newtop = top_y;
 212         int x, y, asc, desc;
 213
 214         bv->cursor().getPos(x, y);
 215         bv->cursor().getDim(asc, desc);
 216         lyxerr << "LyXScreen::fitCursor: x: " << x << " y: " << y
 217                << "  top_y: " << top_y << endl;
 218
 219         bool const big_row = h / 4 < asc + desc && asc + desc < h;
 220
 221         if (y + desc - top_y >= h) {
 222                 if (big_row)
 223                         newtop = y + desc - h;
 224                 else
 225                         newtop = y - h / 2;
 226
 227         } else if (top_y > max(y - asc, 0)) {
 228                 if (big_row)
 229                         newtop = y - asc;
 230                 else {
 231                         newtop = y - h / 2;
 232                         newtop = min(newtop, top_y);
 233                 }
 234         }
 235
 236         newtop = max(newtop, 0);
 237         if (newtop == top_y)
 238                 return false;
 239
 240         bv->top_y(newtop);
 241         return true;
 242 }
 243
 244
 245 void LyXScreen::redraw(BufferView & bv)
 246 {
 247         greyed_out_ = !bv.text();
 248
 249         if (greyed_out_) {
 250                 greyOut();
 251                 return;
 252         }
 253
 254         workarea().getPainter().start();
 255
 256         hideCursor();
 257
 258         int const y = paintText(bv);
 259
 260         // maybe we have to clear the screen at the bottom
 261         int const y2 = workarea().workHeight();
 262         if (y < y2 && bv.text()->isMainText()) {
 263                 workarea().getPainter().fillRectangle(0, y,
 264                         workarea().workWidth(), y2 - y,
 265                         LColor::bottomarea);
 266         }
 267
 268         lyxerr << "Redraw screen" << endl;
 269
 270         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 271
 272         workarea().getPainter().end();
 273
 274         showCursor(bv);
 275 }
 276
 277
 278 void LyXScreen::greyOut()
 279 {
 280         if (!greyed_out_)
 281                 return;
 282
 283         workarea().getPainter().start();
 284
 285         workarea().getPainter().fillRectangle(0, 0,
 286                 workarea().workWidth(),
 287                 workarea().workHeight(),
 288                 LColor::bottomarea);
 289
 290         // Add a splash screen to the centre of the work area
 291         SplashScreen const & splash = SplashScreen::get();
 292         lyx::graphics::Image const * const splash_image = splash.image();
 293         if (splash_image) {
 294                 int const w = splash_image->getWidth();
 295                 int const h = splash_image->getHeight();
 296
 297                 int x = (workarea().workWidth() - w) / 2;
 298                 int y = (workarea().workHeight() - h) / 2;
 299
 300                 workarea().getPainter().image(x, y, w, h, *splash_image);
 301
 302                 x += 260;
 303                 y += 265;
 304
 305                 workarea().getPainter().text(x, y, splash.text(), splash.font());
 306         }
 307         expose(0, 0, workarea().workWidth(), workarea().workHeight());
 308         workarea().getPainter().end();
 309 }