2 * \file render_preview.C
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/render_preview.h"
14 #include "insets/inset.h"
16 #include "BufferView.h"
17 #include "dimension.h"
22 #include "metricsinfo.h"
24 #include "frontends/FontMetrics.h"
25 #include "frontends/Painter.h"
27 #include "graphics/PreviewImage.h"
28 #include "graphics/PreviewLoader.h"
29 #include "graphics/Previews.h"
31 #include "support/lstrings.h"
33 #include <boost/bind.hpp>
42 LyXRC_PreviewStatus RenderPreview::status()
44 return graphics::Previews::status();
48 RenderPreview::RenderPreview(InsetBase const * inset)
53 RenderPreview::RenderPreview(RenderPreview const & other,
54 InsetBase const * inset)
56 boost::signals::trackable(),
57 snippet_(other.snippet_),
62 auto_ptr<RenderBase> RenderPreview::clone(InsetBase const * inset) const
64 return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
70 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
72 graphics::Previews const & previews = graphics::Previews::get();
73 return previews.loader(buffer);
77 docstring const statusMessage(BufferView const * bv, string const & snippet)
79 BOOST_ASSERT(bv && bv->buffer());
81 Buffer const & buffer = *bv->buffer();
82 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
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 = getPreviewLoader(buffer);
109 return loader.preview(snippet_);
113 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
115 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
117 graphics::PreviewImage const * const pimage =
118 getPreviewImage(*mi.base.bv->buffer());
121 dim.asc = pimage->ascent();
122 dim.des = pimage->descent();
123 dim.wid = pimage->width();
128 LyXFont font(mi.base.font);
129 font.setFamily(LyXFont::SANS_FAMILY);
130 font.setSize(LyXFont::SIZE_FOOTNOTE);
131 docstring const stat = statusMessage(mi.base.bv, snippet_);
132 dim.wid = 15 + theFontMetrics(font).width(stat);
139 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
141 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
143 graphics::PreviewImage const * const pimage =
144 getPreviewImage(*pi.base.bv->buffer());
145 graphics::Image const * const image = pimage ? pimage->image() : 0;
148 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
152 int const offset = InsetOld::TEXT_TO_INSET_OFFSET;
154 pi.pain.rectangle(x + offset,
156 dim_.wid - 2 * offset,
160 LyXFont font(pi.base.font);
161 font.setFamily(LyXFont::SANS_FAMILY);
162 font.setSize(LyXFont::SIZE_FOOTNOTE);
164 docstring const stat = statusMessage(pi.base.bv, snippet_);
165 pi.pain.text(x + offset + 6,
166 y - theFontMetrics(font).maxAscent() - 4,
172 void RenderPreview::startLoading(Buffer const & buffer) const
174 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
177 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
178 loader.startLoading();
182 void RenderPreview::addPreview(docstring const & latex_snippet,
183 Buffer const & buffer)
185 if (status() == LyXRC::PREVIEW_OFF)
188 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
189 addPreview(latex_snippet, loader);
193 void RenderPreview::addPreview(docstring const & latex_snippet,
194 graphics::PreviewLoader & ploader)
196 if (status() == LyXRC::PREVIEW_OFF)
200 // We have to make sure that we call latex with the right encoding
201 snippet_ = support::trim(to_utf8(latex_snippet));
202 if (snippet_.empty())
205 if (ploader.preview(snippet_))
208 // If this is the first time of calling, connect to the
209 // PreviewLoader signal that'll inform us when the preview image
210 // is ready for loading.
211 if (!ploader_connection_.connected()) {
212 ploader_connection_ = ploader.connect(
213 boost::bind(&RenderPreview::imageReady, this, _1));
216 ploader.add(snippet_);
220 void RenderPreview::removePreview(Buffer const & buffer)
222 if (snippet_.empty())
225 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
226 loader.remove(snippet_);
231 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
233 // Check the current snippet is the same as that previewed.
234 if (snippet_ == pimage.snippet())
235 LyX::cref().updateInset(parent_);
239 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
240 : RenderPreview(inset),
241 monitor_(std::string(), 2000)
245 void RenderMonitoredPreview::setAbsFile(string const & file)
247 monitor_.reset(file);
251 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
253 RenderPreview::draw(pi, x, y);
259 boost::signals::connection
260 RenderMonitoredPreview::fileChanged(slot_type const & slot)
262 return monitor_.connect(slot);