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 LyXRC_PreviewStatus RenderPreview::status()
48 RenderPreview::RenderPreview(Inset const * inset)
53 RenderPreview::RenderPreview(RenderPreview const & other,
56 boost::signals::trackable(),
57 snippet_(other.snippet_),
62 RenderPreview::~RenderPreview()
64 if (ploader_connection_.connected())
65 ploader_connection_.disconnect();
69 RenderBase * RenderPreview::clone(Inset const * inset) const
71 return new RenderPreview(*this, inset);
77 docstring const statusMessage(BufferView const * bv, string const & snippet)
79 LASSERT(bv, return docstring());
81 Buffer const & buffer = bv->buffer();
82 graphics::PreviewLoader const * loader = buffer.loader();
83 graphics::PreviewLoader::Status const status = loader->status(snippet);
87 case graphics::PreviewLoader::InQueue:
88 case graphics::PreviewLoader::Processing:
89 message = _("Preview loading");
91 case graphics::PreviewLoader::Ready:
92 message = _("Preview ready");
94 case graphics::PreviewLoader::NotFound:
95 message = _("Preview failed");
105 graphics::PreviewImage const *
106 RenderPreview::getPreviewImage(Buffer const & buffer) const
108 graphics::PreviewLoader const * loader = buffer.loader();
109 LASSERT(loader, return 0);
110 return loader->preview(snippet_);
114 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
118 graphics::PreviewImage const * const pimage =
119 getPreviewImage(mi.base.bv->buffer());
122 // If prepared, load the picture before dim calculation. See bug #5627.
129 FontInfo font(mi.base.font);
130 font.setFamily(SANS_FAMILY);
131 font.setSize(FONT_SIZE_FOOTNOTE);
132 docstring const stat = statusMessage(mi.base.bv, snippet_);
133 dim.wid = 15 + theFontMetrics(font).width(stat);
140 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
144 graphics::PreviewImage const * const pimage =
145 getPreviewImage(pi.base.bv->buffer());
146 graphics::Image const * const image = pimage ? pimage->image() : 0;
149 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
153 int const offset = Inset::TEXT_TO_INSET_OFFSET;
155 pi.pain.rectangle(x + offset,
157 dim_.wid - 2 * offset,
161 FontInfo font(pi.base.font);
162 font.setFamily(SANS_FAMILY);
163 font.setSize(FONT_SIZE_FOOTNOTE);
165 docstring const stat = statusMessage(pi.base.bv, snippet_);
166 pi.pain.text(x + offset + 6,
167 y - theFontMetrics(font).maxAscent() - 4,
173 void RenderPreview::startLoading(Buffer const & buffer, bool forexport) const
175 if (!forexport && (status() == LyXRC::PREVIEW_OFF || snippet_.empty()))
178 graphics::PreviewLoader * loader = buffer.loader();
179 LASSERT(loader, return);
180 loader->startLoading(forexport);
184 void RenderPreview::addPreview(docstring const & latex_snippet,
185 Buffer const & buffer,
188 if (status() == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
191 graphics::PreviewLoader * loader = buffer.loader();
192 LASSERT(loader, return);
193 addPreview(latex_snippet, *loader, ignore_lyxrc);
197 void RenderPreview::addPreview(docstring const & latex_snippet,
198 graphics::PreviewLoader & ploader,
201 if (status() == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
205 // We have to make sure that we call latex with the right encoding
206 snippet_ = support::trim(to_utf8(latex_snippet));
207 if (snippet_.empty())
210 if (ploader.preview(snippet_))
213 // If this is the first time of calling, connect to the
214 // PreviewLoader signal that'll inform us when the preview image
215 // is ready for loading.
216 if (!ploader_connection_.connected()) {
217 ploader_connection_ = ploader.connect(
218 bind(&RenderPreview::imageReady, this, _1));
221 ploader.add(snippet_);
225 void RenderPreview::removePreview(Buffer const & buffer)
227 if (snippet_.empty())
230 graphics::PreviewLoader * loader = buffer.loader();
231 LASSERT(loader, return);
232 loader->remove(snippet_);
237 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
239 // Check the current snippet is the same as that previewed.
240 if (snippet_ == pimage.snippet())
241 parent_->updateFrontend();
245 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
246 : RenderPreview(inset), monitor_(FileName(), 2000)
250 void RenderMonitoredPreview::setAbsFile(FileName const & file)
252 monitor_.reset(file);
256 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
258 RenderPreview::draw(pi, x, y);
264 boost::signals::connection
265 RenderMonitoredPreview::fileChanged(slot_type const & slot)
267 return monitor_.connect(slot);