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();
167 theApp->setBufferView(buffer_view);
170 buffer_view_ = buffer_view;
173 message_connection_ = buffer_view_->message.connect(
174 boost::bind(&WorkArea::displayMessage, this, _1));
176 lyx_view_.connectBufferView(*buffer_view);
180 BufferView & WorkArea::bufferView()
182 return *buffer_view_;
186 BufferView const & WorkArea::bufferView() const
188 return *buffer_view_;
192 void WorkArea::checkAndGreyOut()
199 void WorkArea::redraw()
204 if (!buffer_view_->buffer()) {
210 buffer_view_->updateMetrics(false);
214 ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
216 getPainter().start();
217 paintText(*buffer_view_, vi, getPainter());
218 lyxerr[Debug::DEBUG] << "Redraw screen" << endl;
219 int const ymin = std::max(vi.y1, 0);
221 ( vi.p2 < vi.size - 1 ? vi.y2 : height() );
222 expose(0, ymin, width(), ymax - ymin);
226 << " ymin = " << ymin << " width() = " << width()
227 << " ymax-ymin = " << ymax-ymin << std::endl;
231 void WorkArea::processKeySym(LyXKeySymPtr key,
232 key_modifier::state state)
235 lyx_view_.getLyXFunc().processKeySym(key, state);
237 /* This is perhaps a bit of a hack. When we move
238 * around, or type, it's nice to be able to see
239 * the cursor immediately after the keypress. So
240 * we reset the toggle timeout and force the visibility
241 * of the cursor. Note we cannot do this inside
242 * dispatch() itself, because that's called recursively.
244 // if (buffer_view_->buffer())
247 // uneeded "redraw()" call commented out for now.
248 // When/if the call to LyXView::redrawWorkArea() in "lyxfunc.C:1610"
249 // is not needed anymore, this line should be uncommented out
254 void WorkArea::dispatch(FuncRequest const & cmd0)
257 if (cmd0.action == LFUN_FILE_OPEN) {
258 lyx_view_.dispatch(cmd0);
262 buffer_view_->workAreaDispatch(cmd0);
264 // Skip these when selecting
265 if (cmd0.action != LFUN_MOUSE_MOTION) {
266 lyx_view_.updateLayoutChoice();
267 lyx_view_.updateToolbars();
270 // Slight hack: this is only called currently when we
271 // clicked somewhere, so we force through the display
272 // of the new status here.
273 lyx_view_.clearMessage();
279 void WorkArea::resizeBufferView()
281 lyx_view_.busy(true);
282 lyx_view_.message(_("Formatting document..."));
283 buffer_view_->workAreaResize(width(), height());
284 lyx_view_.updateLayoutChoice();
286 lyx_view_.busy(false);
287 lyx_view_.clearMessage();
291 void WorkArea::updateScrollbar()
293 buffer_view_->updateScrollbar();
294 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
295 setScrollbarParams(scroll_.height, scroll_.position,
296 scroll_.lineScrollHeight);
300 void WorkArea::scrollBufferView(int position)
302 buffer_view_->scrollDocView(position);
305 if (lyxrc.cursor_follows_scrollbar) {
306 buffer_view_->setCursorFromScrollbar();
307 lyx_view_.updateLayoutChoice();
313 void WorkArea::greyOut()
316 getPainter().start();
318 getPainter().fillRectangle(0, 0,
323 // Add a splash screen to the centre of the work area
324 SplashScreen const & splash = SplashScreen::get();
325 lyx::graphics::Image const * const splash_image = splash.image();
327 int const w = splash_image->getWidth();
328 int const h = splash_image->getHeight();
330 int x = (width() - w) / 2;
331 int y = (height() - h) / 2;
333 getPainter().image(x, y, w, h, *splash_image);
338 string stext = splash.text();
339 docstring dstext(stext.begin(), stext.end());
340 getPainter().text(x, y, dstext, splash.font());
342 expose(0, 0, width(), height());
347 void WorkArea::showCursor()
352 if (!buffer_view_->buffer())
355 CursorShape shape = BAR_SHAPE;
357 LyXText const & text = *buffer_view_->getLyXText();
358 LyXFont const & realfont = text.real_current_font;
359 BufferParams const & bp = buffer_view_->buffer()->params();
360 bool const samelang = realfont.language() == bp.language;
361 bool const isrtl = realfont.isVisibleRightToLeft();
363 if (!samelang || isrtl != bp.language->rightToLeft()) {
366 shape = REVERSED_L_SHAPE;
369 // The ERT language hack needs fixing up
370 if (realfont.language() == latex_language)
373 LyXFont const font = buffer_view_->cursor().getFont();
374 int const asc = font_metrics::maxAscent(font);
375 int const des = font_metrics::maxDescent(font);
379 buffer_view_->cursor().getPos(x, y);
382 // if it doesn't touch the screen, don't try to show it
383 if (y + h < 0 || y >= height())
386 cursor_visible_ = true;
387 showCursor(x, y, h, shape);
391 void WorkArea::hideCursor()
393 if (!cursor_visible_)
396 cursor_visible_ = false;
401 void WorkArea::toggleCursor()
403 if (buffer_view_->buffer()) {
410 // Use this opportunity to deal with any child processes that
411 // have finished but are waiting to communicate this fact
412 // to the rest of LyX.
413 ForkedcallsController & fcc = ForkedcallsController::get();
414 fcc.handleCompletedProcesses();
417 cursor_timeout_.restart();
421 void WorkArea::displayMessage(lyx::docstring const & message)
423 lyx_view_.message(message);
426 } // namespace frontend