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
18 #include "font_metrics.h"
19 #include "funcrequest.h"
24 #include "BufferView.h"
26 #include "bufferparams.h"
27 #include "coordcache.h"
37 #include "metricsinfo.h"
38 #include "paragraph.h"
39 #include "rowpainter.h"
42 #include "graphics/GraphicsImage.h"
43 #include "graphics/GraphicsLoader.h"
46 #include "support/filetools.h" // LibFileSearch
47 #include "support/forkedcontr.h"
49 #include <boost/utility.hpp>
50 #include <boost/bind.hpp>
51 #include <boost/current_function.hpp>
53 using lyx::support::libFileSearch;
54 using lyx::support::ForkedcallsController;
65 // FIXME: The SplashScreen should be transfered to the
66 // LyXView and create a WorkArea only when a new buffer exists. This
67 // will allow to call WorkArea::redraw() in the constructor.
68 class SplashScreen : boost::noncopyable, boost::signals::trackable {
70 /// This is a singleton class. Get the instance.
71 static SplashScreen const & get();
73 lyx::graphics::Image const * image() const { return loader_.image(); }
75 string const & text() const { return text_; }
77 LyXFont const & font() const { return font_; }
79 void connect(lyx::graphics::Loader::slot_type const & slot) const {
80 loader_.connect(slot);
83 void startLoading() const {
84 if (loader_.status() == lyx::graphics::WaitingToLoad)
85 loader_.startLoading();
89 /** Make the c-tor private so we can control how many objects
95 lyx::graphics::Loader loader_;
96 /// The text to be written on top of the pixmap
103 SplashScreen const & SplashScreen::get()
105 static SplashScreen singleton;
110 SplashScreen::SplashScreen()
111 : text_(lyx_version ? lyx_version : "unknown")
113 if (!lyxrc.show_banner)
116 string const file = libFileSearch("images", "banner", "ppm");
120 // The font used to display the version info
121 font_.setFamily(LyXFont::SANS_FAMILY);
122 font_.setSeries(LyXFont::BOLD_SERIES);
123 font_.setSize(LyXFont::SIZE_NORMAL);
124 font_.setColor(LColor::yellow);
126 // Load up the graphics file
132 // All the below connection objects are needed because of a bug in some
133 // versions of GCC (<=2.96 are on the suspects list.) By having and assigning
134 // to these connections we avoid a segfault upon startup, and also at exit.
137 boost::signals::connection timecon;
141 WorkArea::WorkArea(LyXView & lyx_view)
142 : buffer_view_(0), lyx_view_(lyx_view), greyed_out_(true),
143 cursor_visible_(false), cursor_timeout_(400)
145 // Start loading the pixmap as soon as possible
146 if (lyxrc.show_banner) {
147 SplashScreen const & splash = SplashScreen::get();
148 splash.connect(boost::bind(&WorkArea::checkAndGreyOut, this));
149 splash.startLoading();
153 timecon = cursor_timeout_.timeout
154 .connect(boost::bind(&WorkArea::toggleCursor, this));
156 cursor_timeout_.start();
160 void WorkArea::setBufferView(BufferView * buffer_view)
163 message_connection_.disconnect();
164 lyx_view_.disconnectBufferView();
168 buffer_view_ = buffer_view;
171 message_connection_ = buffer_view_->message.connect(
172 boost::bind(&WorkArea::displayMessage, this, _1));
174 lyx_view_.connectBufferView(*buffer_view);
178 BufferView & WorkArea::bufferView()
180 return *buffer_view_;
184 BufferView const & WorkArea::bufferView() const
186 return *buffer_view_;
190 void WorkArea::checkAndGreyOut()
197 void WorkArea::redraw()
202 if (!buffer_view_->buffer()) {
208 buffer_view_->updateMetrics(false);
212 ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
214 getPainter().start();
215 paintText(*buffer_view_, vi, getPainter());
216 lyxerr[Debug::DEBUG] << "Redraw screen" << endl;
217 int const ymin = std::max(vi.y1, 0);
219 ( vi.p2 < vi.size - 1 ? vi.y2 : height() );
220 expose(0, ymin, width(), ymax - ymin);
224 << " ymin = " << ymin << " width() = " << width()
225 << " ymax-ymin = " << ymax-ymin << std::endl;
229 void WorkArea::processKeySym(LyXKeySymPtr key,
230 key_modifier::state state)
233 lyx_view_.getLyXFunc().processKeySym(key, state);
235 /* This is perhaps a bit of a hack. When we move
236 * around, or type, it's nice to be able to see
237 * the cursor immediately after the keypress. So
238 * we reset the toggle timeout and force the visibility
239 * of the cursor. Note we cannot do this inside
240 * dispatch() itself, because that's called recursively.
242 // if (buffer_view_->buffer())
245 // uneeded "redraw()" call commented out for now.
246 // When/if the call to LyXView::redrawWorkArea() in "lyxfunc.C:1610"
247 // is not needed anymore, this line should be uncommented out
252 void WorkArea::dispatch(FuncRequest const & cmd0)
255 if (cmd0.action == LFUN_FILE_OPEN) {
256 lyx_view_.dispatch(cmd0);
260 buffer_view_->workAreaDispatch(cmd0);
262 // Skip these when selecting
263 if (cmd0.action != LFUN_MOUSE_MOTION) {
264 lyx_view_.updateLayoutChoice();
265 lyx_view_.updateToolbars();
268 // Slight hack: this is only called currently when we
269 // clicked somewhere, so we force through the display
270 // of the new status here.
271 lyx_view_.clearMessage();
277 void WorkArea::resizeBufferView()
279 lyx_view_.busy(true);
280 lyx_view_.message(_("Formatting document..."));
281 buffer_view_->workAreaResize(width(), height());
282 lyx_view_.updateLayoutChoice();
284 lyx_view_.busy(false);
285 lyx_view_.clearMessage();
289 void WorkArea::updateScrollbar()
291 buffer_view_->updateScrollbar();
292 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
293 setScrollbarParams(scroll_.height, scroll_.position,
294 scroll_.lineScrollHeight);
298 void WorkArea::scrollBufferView(int position)
300 buffer_view_->scrollDocView(position);
303 if (lyxrc.cursor_follows_scrollbar) {
304 buffer_view_->setCursorFromScrollbar();
305 lyx_view_.updateLayoutChoice();
311 void WorkArea::greyOut()
314 getPainter().start();
316 getPainter().fillRectangle(0, 0,
321 // Add a splash screen to the centre of the work area
322 SplashScreen const & splash = SplashScreen::get();
323 lyx::graphics::Image const * const splash_image = splash.image();
325 int const w = splash_image->getWidth();
326 int const h = splash_image->getHeight();
328 int x = (width() - w) / 2;
329 int y = (height() - h) / 2;
331 getPainter().image(x, y, w, h, *splash_image);
336 string stext = splash.text();
337 docstring dstext(stext.begin(), stext.end());
338 getPainter().text(x, y, dstext, splash.font());
340 expose(0, 0, width(), height());
345 void WorkArea::showCursor()
350 if (!buffer_view_->buffer())
353 CursorShape shape = BAR_SHAPE;
355 LyXText const & text = *buffer_view_->getLyXText();
356 LyXFont const & realfont = text.real_current_font;
357 BufferParams const & bp = buffer_view_->buffer()->params();
358 bool const samelang = realfont.language() == bp.language;
359 bool const isrtl = realfont.isVisibleRightToLeft();
361 if (!samelang || isrtl != bp.language->rightToLeft()) {
364 shape = REVERSED_L_SHAPE;
367 // The ERT language hack needs fixing up
368 if (realfont.language() == latex_language)
371 LyXFont const font = buffer_view_->cursor().getFont();
372 int const asc = font_metrics::maxAscent(font);
373 int const des = font_metrics::maxDescent(font);
377 buffer_view_->cursor().getPos(x, y);
380 // if it doesn't touch the screen, don't try to show it
381 if (y + h < 0 || y >= height())
384 cursor_visible_ = true;
385 showCursor(x, y, h, shape);
389 void WorkArea::hideCursor()
391 if (!cursor_visible_)
394 cursor_visible_ = false;
399 void WorkArea::toggleCursor()
401 if (buffer_view_->buffer()) {
408 // Use this opportunity to deal with any child processes that
409 // have finished but are waiting to communicate this fact
410 // to the rest of LyX.
411 ForkedcallsController & fcc = ForkedcallsController::get();
412 fcc.handleCompletedProcesses();
415 cursor_timeout_.restart();
419 void WorkArea::displayMessage(lyx::docstring const & message)
421 lyx_view_.message(message);
424 } // namespace frontend