3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Abdelrazak Younes
9 * Full author contact details are available in file CREDITS.
11 * Splash screen code added by Angus Leeming
16 #include "frontends/WorkArea.h"
18 #include "frontends/Application.h"
19 #include "frontends/FontLoader.h"
20 #include "frontends/FontMetrics.h"
22 #include "funcrequest.h"
27 #include "BufferView.h"
29 #include "bufferparams.h"
30 #include "coordcache.h"
40 #include "metricsinfo.h"
41 #include "paragraph.h"
42 #include "rowpainter.h"
45 #include "graphics/GraphicsImage.h"
46 #include "graphics/GraphicsLoader.h"
49 #include "support/filetools.h" // LibFileSearch
50 #include "support/forkedcontr.h"
52 #include <boost/utility.hpp>
53 #include <boost/bind.hpp>
54 #include <boost/current_function.hpp>
56 using lyx::support::libFileSearch;
57 using lyx::support::ForkedcallsController;
68 // FIXME: The SplashScreen should be transfered to the
69 // LyXView and create a WorkArea only when a new buffer exists. This
70 // will allow to call WorkArea::redraw() in the constructor.
71 class SplashScreen : boost::noncopyable, boost::signals::trackable {
73 /// This is a singleton class. Get the instance.
74 static SplashScreen const & get();
76 lyx::graphics::Image const * image() const { return loader_.image(); }
78 string const & text() const { return text_; }
80 LyXFont const & font() const { return font_; }
82 void connect(lyx::graphics::Loader::slot_type const & slot) const {
83 loader_.connect(slot);
86 void startLoading() const {
87 if (loader_.status() == lyx::graphics::WaitingToLoad)
88 loader_.startLoading();
92 /** Make the c-tor private so we can control how many objects
98 lyx::graphics::Loader loader_;
99 /// The text to be written on top of the pixmap
106 SplashScreen const & SplashScreen::get()
108 static SplashScreen singleton;
113 SplashScreen::SplashScreen()
114 : text_(lyx_version ? lyx_version : "unknown")
116 if (!lyxrc.show_banner)
119 string const file = libFileSearch("images", "banner", "ppm");
123 // The font used to display the version info
124 font_.setFamily(LyXFont::SANS_FAMILY);
125 font_.setSeries(LyXFont::BOLD_SERIES);
126 font_.setSize(LyXFont::SIZE_NORMAL);
127 font_.setColor(LColor::yellow);
129 // Load up the graphics file
135 // All the below connection objects are needed because of a bug in some
136 // versions of GCC (<=2.96 are on the suspects list.) By having and assigning
137 // to these connections we avoid a segfault upon startup, and also at exit.
140 boost::signals::connection timecon;
144 WorkArea::WorkArea(LyXView & lyx_view)
145 : buffer_view_(0), lyx_view_(lyx_view), greyed_out_(true),
146 cursor_visible_(false), cursor_timeout_(400)
148 // Start loading the pixmap as soon as possible
149 if (lyxrc.show_banner) {
150 SplashScreen const & splash = SplashScreen::get();
151 splash.connect(boost::bind(&WorkArea::checkAndGreyOut, this));
152 splash.startLoading();
156 timecon = cursor_timeout_.timeout
157 .connect(boost::bind(&WorkArea::toggleCursor, this));
159 cursor_timeout_.start();
163 void WorkArea::setBufferView(BufferView * buffer_view)
166 message_connection_.disconnect();
167 lyx_view_.disconnectBufferView();
170 theApp->setBufferView(buffer_view);
173 buffer_view_ = buffer_view;
176 message_connection_ = buffer_view_->message.connect(
177 boost::bind(&WorkArea::displayMessage, this, _1));
179 lyx_view_.connectBufferView(*buffer_view);
183 BufferView & WorkArea::bufferView()
185 return *buffer_view_;
189 BufferView const & WorkArea::bufferView() const
191 return *buffer_view_;
195 void WorkArea::checkAndGreyOut()
202 void WorkArea::redraw()
207 if (!buffer_view_->buffer()) {
213 buffer_view_->updateMetrics(false);
217 ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
219 getPainter().start();
220 paintText(*buffer_view_, vi, getPainter());
221 lyxerr[Debug::DEBUG] << "Redraw screen" << endl;
222 int const ymin = std::max(vi.y1, 0);
224 ( vi.p2 < vi.size - 1 ? vi.y2 : height() );
225 expose(0, ymin, width(), ymax - ymin);
229 << " ymin = " << ymin << " width() = " << width()
230 << " ymax-ymin = " << ymax-ymin << std::endl;
234 void WorkArea::processKeySym(LyXKeySymPtr key,
235 key_modifier::state state)
238 lyx_view_.getLyXFunc().processKeySym(key, state);
240 /* This is perhaps a bit of a hack. When we move
241 * around, or type, it's nice to be able to see
242 * the cursor immediately after the keypress. So
243 * we reset the toggle timeout and force the visibility
244 * of the cursor. Note we cannot do this inside
245 * dispatch() itself, because that's called recursively.
247 // if (buffer_view_->buffer())
250 // uneeded "redraw()" call commented out for now.
251 // When/if the call to LyXView::redrawWorkArea() in "lyxfunc.C:1610"
252 // is not needed anymore, this line should be uncommented out
257 void WorkArea::dispatch(FuncRequest const & cmd0)
260 if (cmd0.action == LFUN_FILE_OPEN) {
261 lyx_view_.dispatch(cmd0);
265 buffer_view_->workAreaDispatch(cmd0);
267 // Skip these when selecting
268 if (cmd0.action != LFUN_MOUSE_MOTION) {
269 lyx_view_.updateLayoutChoice();
270 lyx_view_.updateMenubar();
271 lyx_view_.updateToolbars();
274 // Slight hack: this is only called currently when we
275 // clicked somewhere, so we force through the display
276 // of the new status here.
277 lyx_view_.clearMessage();
283 void WorkArea::resizeBufferView()
285 lyx_view_.busy(true);
286 lyx_view_.message(_("Formatting document..."));
287 buffer_view_->workAreaResize(width(), height());
288 lyx_view_.updateLayoutChoice();
290 lyx_view_.busy(false);
291 lyx_view_.clearMessage();
295 void WorkArea::updateScrollbar()
297 buffer_view_->updateScrollbar();
298 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
299 setScrollbarParams(scroll_.height, scroll_.position,
300 scroll_.lineScrollHeight);
304 void WorkArea::scrollBufferView(int position)
306 buffer_view_->scrollDocView(position);
309 if (lyxrc.cursor_follows_scrollbar) {
310 buffer_view_->setCursorFromScrollbar();
311 lyx_view_.updateLayoutChoice();
317 void WorkArea::greyOut()
320 getPainter().start();
322 getPainter().fillRectangle(0, 0,
327 // Add a splash screen to the centre of the work area
328 SplashScreen const & splash = SplashScreen::get();
329 lyx::graphics::Image const * const splash_image = splash.image();
331 int const w = splash_image->getWidth();
332 int const h = splash_image->getHeight();
334 int x = (width() - w) / 2;
335 int y = (height() - h) / 2;
337 getPainter().image(x, y, w, h, *splash_image);
342 string stext = splash.text();
343 docstring dstext(stext.begin(), stext.end());
344 getPainter().text(x, y, dstext, splash.font());
346 expose(0, 0, width(), height());
351 void WorkArea::showCursor()
356 if (!buffer_view_->buffer())
359 CursorShape shape = BAR_SHAPE;
361 LyXText const & text = *buffer_view_->getLyXText();
362 LyXFont const & realfont = text.real_current_font;
363 BufferParams const & bp = buffer_view_->buffer()->params();
364 bool const samelang = realfont.language() == bp.language;
365 bool const isrtl = realfont.isVisibleRightToLeft();
367 if (!samelang || isrtl != bp.language->rightToLeft()) {
370 shape = REVERSED_L_SHAPE;
373 // The ERT language hack needs fixing up
374 if (realfont.language() == latex_language)
377 LyXFont const font = buffer_view_->cursor().getFont();
378 FontMetrics const & fm = theApp->fontLoader().metrics(font);
379 int const asc = fm.maxAscent();
380 int const des = fm.maxDescent();
384 buffer_view_->cursor().getPos(x, y);
387 // if it doesn't touch the screen, don't try to show it
388 if (y + h < 0 || y >= height())
391 cursor_visible_ = true;
392 showCursor(x, y, h, shape);
396 void WorkArea::hideCursor()
398 if (!cursor_visible_)
401 cursor_visible_ = false;
406 void WorkArea::toggleCursor()
408 if (buffer_view_->buffer()) {
415 // Use this opportunity to deal with any child processes that
416 // have finished but are waiting to communicate this fact
417 // to the rest of LyX.
418 ForkedcallsController & fcc = ForkedcallsController::get();
419 fcc.handleCompletedProcesses();
422 cursor_timeout_.restart();
426 void WorkArea::displayMessage(lyx::docstring const & message)
428 lyx_view_.message(message);
431 } // namespace frontend