2 * \file RenderPreview.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
8 * Full author contact details are available in file CREDITS.
13 #include "insets/RenderPreview.h"
14 #include "insets/Inset.h"
17 #include "BufferView.h"
18 #include "Dimension.h"
21 #include "MetricsInfo.h"
23 #include "frontends/FontMetrics.h"
24 #include "frontends/Painter.h"
26 #include "graphics/PreviewImage.h"
27 #include "graphics/PreviewLoader.h"
29 #include "support/FileName.h"
30 #include "support/gettext.h"
31 #include "support/lassert.h"
32 #include "support/lstrings.h"
34 #include "support/bind.h"
37 using namespace lyx::support;
42 bool RenderPreview::previewText()
44 // Use a switch to trigger a warning if the enum is changed.
45 switch(lyxrc.preview) {
46 case LyXRC::PREVIEW_ON:
47 case LyXRC::PREVIEW_NO_MATH:
49 case LyXRC::PREVIEW_OFF:
57 bool RenderPreview::previewMath()
59 // Use a switch to trigger a warning if the enum is changed.
60 switch(lyxrc.preview) {
61 case LyXRC::PREVIEW_ON:
63 case LyXRC::PREVIEW_NO_MATH:
64 case LyXRC::PREVIEW_OFF:
72 RenderPreview::RenderPreview(Inset const * inset)
77 RenderPreview::RenderPreview(RenderPreview const & other,
80 boost::signals::trackable(),
81 snippet_(other.snippet_),
86 RenderPreview::~RenderPreview()
88 if (ploader_connection_.connected())
89 ploader_connection_.disconnect();
93 RenderBase * RenderPreview::clone(Inset const * inset) const
95 return new RenderPreview(*this, inset);
101 docstring const statusMessage(BufferView const * bv, string const & snippet)
103 LASSERT(bv, return docstring());
105 Buffer const & buffer = bv->buffer();
106 graphics::PreviewLoader const * loader = buffer.loader();
107 graphics::PreviewLoader::Status const status = loader->status(snippet);
111 case graphics::PreviewLoader::InQueue:
112 case graphics::PreviewLoader::Processing:
113 message = _("Preview loading");
115 case graphics::PreviewLoader::Ready:
116 message = _("Preview ready");
118 case graphics::PreviewLoader::NotFound:
119 message = _("Preview failed");
129 graphics::PreviewImage const *
130 RenderPreview::getPreviewImage(Buffer const & buffer) const
132 graphics::PreviewLoader const * loader = buffer.loader();
133 LASSERT(loader, return 0);
134 return loader->preview(snippet_);
138 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
142 graphics::PreviewImage const * const pimage =
143 getPreviewImage(mi.base.bv->buffer());
146 // If prepared, load the picture before dim calculation. See bug #5627.
153 FontInfo font(mi.base.font);
154 font.setFamily(SANS_FAMILY);
155 font.setSize(FONT_SIZE_FOOTNOTE);
156 docstring const stat = statusMessage(mi.base.bv, snippet_);
157 dim.wid = 15 + theFontMetrics(font).width(stat);
164 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
168 graphics::PreviewImage const * const pimage =
169 getPreviewImage(pi.base.bv->buffer());
170 graphics::Image const * const image = pimage ? pimage->image() : 0;
173 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
176 int const offset = Inset::TEXT_TO_INSET_OFFSET;
178 pi.pain.rectangle(x + offset,
180 dim_.wid - 2 * offset,
184 FontInfo font(pi.base.font);
185 font.setFamily(SANS_FAMILY);
186 font.setSize(FONT_SIZE_FOOTNOTE);
188 docstring const stat = statusMessage(pi.base.bv, snippet_);
189 pi.pain.text(x + offset + 6,
190 y - theFontMetrics(font).maxAscent() - 4,
196 void RenderPreview::startLoading(Buffer const & buffer, bool forexport) const
198 if (!forexport && (lyxrc.preview == LyXRC::PREVIEW_OFF || snippet_.empty()))
201 graphics::PreviewLoader * loader = buffer.loader();
202 LASSERT(loader, return);
203 loader->startLoading(forexport);
207 void RenderPreview::addPreview(docstring const & latex_snippet,
208 Buffer const & buffer,
211 if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
214 graphics::PreviewLoader * loader = buffer.loader();
215 LASSERT(loader, return);
216 addPreview(latex_snippet, *loader, ignore_lyxrc);
220 void RenderPreview::addPreview(docstring const & latex_snippet,
221 graphics::PreviewLoader & ploader,
224 if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
228 // We have to make sure that we call latex with the right encoding
229 snippet_ = support::trim(to_utf8(latex_snippet));
230 if (snippet_.empty())
233 if (ploader.preview(snippet_))
236 // If this is the first time of calling, connect to the
237 // PreviewLoader signal that'll inform us when the preview image
238 // is ready for loading.
239 if (!ploader_connection_.connected()) {
240 ploader_connection_ = ploader.connect(
241 bind(&RenderPreview::imageReady, this, _1));
244 ploader.add(snippet_);
248 void RenderPreview::removePreview(Buffer const & buffer)
250 if (snippet_.empty())
253 graphics::PreviewLoader * loader = buffer.loader();
254 LASSERT(loader, return);
255 loader->remove(snippet_);
260 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
262 // Check the current snippet is the same as that previewed.
263 if (snippet_ == pimage.snippet())
264 parent_->updateFrontend();
268 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
269 : RenderPreview(inset), monitor_(FileName(), 2000)
273 void RenderMonitoredPreview::setAbsFile(FileName const & file)
275 monitor_.reset(file);
279 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
281 RenderPreview::draw(pi, x, y);
287 boost::signals::connection
288 RenderMonitoredPreview::fileChanged(slot_type const & slot)
290 return monitor_.connect(slot);