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"
35 using namespace lyx::support;
40 bool RenderPreview::previewText()
42 // Use a switch to trigger a warning if the enum is changed.
43 switch(lyxrc.preview) {
44 case LyXRC::PREVIEW_ON:
45 case LyXRC::PREVIEW_NO_MATH:
47 case LyXRC::PREVIEW_OFF:
55 bool RenderPreview::previewMath()
57 // Use a switch to trigger a warning if the enum is changed.
58 switch(lyxrc.preview) {
59 case LyXRC::PREVIEW_ON:
61 case LyXRC::PREVIEW_NO_MATH:
62 case LyXRC::PREVIEW_OFF:
70 RenderPreview::RenderPreview(Inset const * inset)
75 RenderPreview::RenderPreview(RenderPreview const & other,
78 snippet_(other.snippet_),
83 RenderBase * RenderPreview::clone(Inset const * inset) const
85 return new RenderPreview(*this, inset);
91 docstring const statusMessage(BufferView const * bv, string const & snippet)
93 LASSERT(bv, return docstring());
95 Buffer const & buffer = bv->buffer();
96 graphics::PreviewLoader const * loader = buffer.loader();
97 // please coverity (probably worth the check anyway)
100 graphics::PreviewLoader::Status const status = loader->status(snippet);
104 case graphics::PreviewLoader::InQueue:
105 case graphics::PreviewLoader::Processing:
106 message = _("Preview loading");
108 case graphics::PreviewLoader::Ready:
109 message = _("Preview ready");
111 case graphics::PreviewLoader::NotFound:
112 message = _("Preview failed");
122 graphics::PreviewImage const *
123 RenderPreview::getPreviewImage(Buffer const & buffer) const
125 graphics::PreviewLoader const * loader = buffer.loader();
126 LASSERT(loader, return 0);
127 return loader->preview(snippet_);
131 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
135 graphics::PreviewImage const * const pimage =
136 getPreviewImage(mi.base.bv->buffer());
139 // If prepared, load the picture before dim calculation. See bug #5627.
146 FontInfo font(mi.base.font);
147 font.setFamily(SANS_FAMILY);
148 font.setSize(FOOTNOTE_SIZE);
149 docstring const stat = statusMessage(mi.base.bv, snippet_);
150 dim.wid = 15 + theFontMetrics(font).width(stat);
157 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
161 graphics::PreviewImage const * const pimage =
162 getPreviewImage(pi.base.bv->buffer());
163 graphics::Image const * const image = pimage ? pimage->image() : 0;
166 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
169 int const offset = Inset::textOffset(pi.base.bv);
171 pi.pain.rectangle(x + offset,
173 dim_.wid - 2 * offset,
177 FontInfo font(pi.base.font);
178 font.setFamily(SANS_FAMILY);
179 font.setSize(FOOTNOTE_SIZE);
181 docstring const stat = statusMessage(pi.base.bv, snippet_);
182 pi.pain.text(x + offset + 6,
183 y - theFontMetrics(font).maxAscent() - 4,
186 pi.change.paintCue(pi, x, y - dim_.asc,
187 x + dim_.width(), y - dim_.asc + dim_.height());
191 void RenderPreview::startLoading(Buffer const & buffer, bool forexport) const
193 if (!forexport && (lyxrc.preview == LyXRC::PREVIEW_OFF || snippet_.empty()))
196 graphics::PreviewLoader * loader = buffer.loader();
197 LASSERT(loader, return);
198 loader->startLoading(forexport);
202 void RenderPreview::addPreview(docstring const & latex_snippet,
203 Buffer const & buffer,
206 if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
209 graphics::PreviewLoader * loader = buffer.loader();
210 LASSERT(loader, return);
211 addPreview(latex_snippet, *loader, ignore_lyxrc);
215 void RenderPreview::addPreview(docstring const & latex_snippet,
216 graphics::PreviewLoader & ploader,
219 if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
223 // We have to make sure that we call latex with the right encoding
224 snippet_ = support::trim(to_utf8(latex_snippet));
225 if (snippet_.empty())
228 if (ploader.preview(snippet_))
231 // If this is the first time of calling, connect to the
232 // PreviewLoader signal that'll inform us when the preview image
233 // is ready for loading.
234 if (!ploader_connection_.connected())
235 // This is a scoped connection.
236 ploader_connection_ =
237 ploader.connect([this](graphics::PreviewImage const & pi){
241 ploader.add(snippet_);
245 void RenderPreview::removePreview(Buffer const & buffer)
247 if (snippet_.empty())
250 graphics::PreviewLoader * loader = buffer.loader();
251 LASSERT(loader, return);
252 loader->remove(snippet_);
257 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
259 // Check the current snippet is the same as that previewed.
260 if (snippet_ == pimage.snippet())
261 parent_->updateFrontend();
265 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
266 : RenderPreview(inset)
268 setAbsFile(FileName());
272 void RenderMonitoredPreview::setAbsFile(FileName const & file)
274 bool mon = monitoring();
283 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
285 RenderPreview::draw(pi, x, y);
287 monitor_->checkModifiedAsync();
291 signals2::connection RenderMonitoredPreview::connect(slot const & slot)
293 return changed_.connect(slot);
297 bool RenderMonitoredPreview::monitoring() const
299 return (bool) monitor_;
303 void RenderMonitoredPreview::startMonitoring() const
306 monitor_ = FileSystemWatcher::activeMonitor(filename_);
307 // Disconnected at the same time as this is destroyed.
308 monitor_->connect([this](bool /* exists */){ changed_(); });
313 void RenderMonitoredPreview::stopMonitoring() const