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::signals2::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 // please coverity (probably worth the check anyway)
110 graphics::PreviewLoader::Status const status = loader->status(snippet);
114 case graphics::PreviewLoader::InQueue:
115 case graphics::PreviewLoader::Processing:
116 message = _("Preview loading");
118 case graphics::PreviewLoader::Ready:
119 message = _("Preview ready");
121 case graphics::PreviewLoader::NotFound:
122 message = _("Preview failed");
132 graphics::PreviewImage const *
133 RenderPreview::getPreviewImage(Buffer const & buffer) const
135 graphics::PreviewLoader const * loader = buffer.loader();
136 LASSERT(loader, return 0);
137 return loader->preview(snippet_);
141 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
145 graphics::PreviewImage const * const pimage =
146 getPreviewImage(mi.base.bv->buffer());
149 // If prepared, load the picture before dim calculation. See bug #5627.
156 FontInfo font(mi.base.font);
157 font.setFamily(SANS_FAMILY);
158 font.setSize(FONT_SIZE_FOOTNOTE);
159 docstring const stat = statusMessage(mi.base.bv, snippet_);
160 dim.wid = 15 + theFontMetrics(font).width(stat);
167 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
171 graphics::PreviewImage const * const pimage =
172 getPreviewImage(pi.base.bv->buffer());
173 graphics::Image const * const image = pimage ? pimage->image() : 0;
176 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
179 int const offset = Inset::TEXT_TO_INSET_OFFSET;
181 pi.pain.rectangle(x + offset,
183 dim_.wid - 2 * offset,
187 FontInfo font(pi.base.font);
188 font.setFamily(SANS_FAMILY);
189 font.setSize(FONT_SIZE_FOOTNOTE);
191 docstring const stat = statusMessage(pi.base.bv, snippet_);
192 pi.pain.text(x + offset + 6,
193 y - theFontMetrics(font).maxAscent() - 4,
196 pi.change_.paintCue(pi, x, y - dim_.asc,
197 x + dim_.width(), y - dim_.asc + dim_.height());
201 void RenderPreview::startLoading(Buffer const & buffer, bool forexport) const
203 if (!forexport && (lyxrc.preview == LyXRC::PREVIEW_OFF || snippet_.empty()))
206 graphics::PreviewLoader * loader = buffer.loader();
207 LASSERT(loader, return);
208 loader->startLoading(forexport);
212 void RenderPreview::addPreview(docstring const & latex_snippet,
213 Buffer const & buffer,
216 if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
219 graphics::PreviewLoader * loader = buffer.loader();
220 LASSERT(loader, return);
221 addPreview(latex_snippet, *loader, ignore_lyxrc);
225 void RenderPreview::addPreview(docstring const & latex_snippet,
226 graphics::PreviewLoader & ploader,
229 if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
233 // We have to make sure that we call latex with the right encoding
234 snippet_ = support::trim(to_utf8(latex_snippet));
235 if (snippet_.empty())
238 if (ploader.preview(snippet_))
241 // If this is the first time of calling, connect to the
242 // PreviewLoader signal that'll inform us when the preview image
243 // is ready for loading.
244 if (!ploader_connection_.connected()) {
245 ploader_connection_ = ploader.connect(
246 bind(&RenderPreview::imageReady, this, _1));
249 ploader.add(snippet_);
253 void RenderPreview::removePreview(Buffer const & buffer)
255 if (snippet_.empty())
258 graphics::PreviewLoader * loader = buffer.loader();
259 LASSERT(loader, return);
260 loader->remove(snippet_);
265 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
267 // Check the current snippet is the same as that previewed.
268 if (snippet_ == pimage.snippet())
269 parent_->updateFrontend();
273 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
274 : RenderPreview(inset), monitor_(FileName(), 2000)
278 void RenderMonitoredPreview::setAbsFile(FileName const & file)
280 monitor_.reset(file);
284 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
286 RenderPreview::draw(pi, x, y);
292 boost::signals2::connection
293 RenderMonitoredPreview::fileChanged(slot_type const & slot)
295 return monitor_.connect(slot);