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/font_metrics.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>
40 namespace graphics = lyx::graphics;
41 namespace support = lyx::support;
44 LyXRC_PreviewStatus RenderPreview::status()
46 return graphics::Previews::status();
50 RenderPreview::RenderPreview(InsetBase const * inset)
55 RenderPreview::RenderPreview(RenderPreview const & other,
56 InsetBase const * inset)
58 boost::signals::trackable(),
59 snippet_(other.snippet_),
64 auto_ptr<RenderBase> RenderPreview::clone(InsetBase const * inset) const
66 return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
72 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
74 graphics::Previews const & previews = graphics::Previews::get();
75 return previews.loader(buffer);
79 string const statusMessage(BufferView const * bv, string const & snippet)
81 BOOST_ASSERT(bv && bv->buffer());
83 Buffer const & buffer = *bv->buffer();
84 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
85 graphics::PreviewLoader::Status const status = loader.status(snippet);
89 case graphics::PreviewLoader::InQueue:
90 case graphics::PreviewLoader::Processing:
91 message = _("Preview loading");
93 case graphics::PreviewLoader::Ready:
94 message = _("Preview ready");
96 case graphics::PreviewLoader::NotFound:
97 message = _("Preview failed");
107 graphics::PreviewImage const *
108 RenderPreview::getPreviewImage(Buffer const & buffer) const
110 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
111 return loader.preview(snippet_);
115 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
117 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
119 graphics::PreviewImage const * const pimage =
120 getPreviewImage(*mi.base.bv->buffer());
123 dim.asc = pimage->ascent();
124 dim.des = pimage->descent();
125 dim.wid = pimage->width();
130 LyXFont font(mi.base.font);
131 font.setFamily(LyXFont::SANS_FAMILY);
132 font.setSize(LyXFont::SIZE_FOOTNOTE);
133 string stat = statusMessage(mi.base.bv, snippet_);
134 docstring dstat(stat.begin(), stat.end());
135 dim.wid = 15 + font_metrics::width(dstat, font);
142 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
144 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
146 graphics::PreviewImage const * const pimage =
147 getPreviewImage(*pi.base.bv->buffer());
148 graphics::Image const * const image = pimage ? pimage->image() : 0;
151 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
155 int const offset = InsetOld::TEXT_TO_INSET_OFFSET;
157 pi.pain.rectangle(x + offset,
159 dim_.wid - 2 * offset,
163 LyXFont font(pi.base.font);
164 font.setFamily(LyXFont::SANS_FAMILY);
165 font.setSize(LyXFont::SIZE_FOOTNOTE);
167 string stat = statusMessage(pi.base.bv, snippet_);
168 docstring dstat(stat.begin(), stat.end());
169 pi.pain.text(x + offset + 6,
170 y - font_metrics::maxAscent(font) - 4,
176 void RenderPreview::startLoading(Buffer const & buffer) const
178 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
181 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
182 loader.startLoading();
186 void RenderPreview::addPreview(string const & latex_snippet,
187 Buffer const & buffer)
189 if (status() == LyXRC::PREVIEW_OFF)
192 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
193 addPreview(latex_snippet, loader);
197 void RenderPreview::addPreview(string const & latex_snippet,
198 graphics::PreviewLoader & ploader)
200 if (status() == LyXRC::PREVIEW_OFF)
203 snippet_ = support::trim(latex_snippet);
204 if (snippet_.empty())
207 if (ploader.preview(snippet_))
210 // If this is the first time of calling, connect to the
211 // PreviewLoader signal that'll inform us when the preview image
212 // is ready for loading.
213 if (!ploader_connection_.connected()) {
214 ploader_connection_ = ploader.connect(
215 boost::bind(&RenderPreview::imageReady, this, _1));
218 ploader.add(snippet_);
222 void RenderPreview::removePreview(Buffer const & buffer)
224 if (snippet_.empty())
227 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
228 loader.remove(snippet_);
233 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
235 // Check the current snippet is the same as that previewed.
236 if (snippet_ == pimage.snippet())
237 LyX::cref().updateInset(parent_);
241 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
242 : RenderPreview(inset),
243 monitor_(std::string(), 2000)
247 void RenderMonitoredPreview::setAbsFile(string const & file)
249 monitor_.reset(file);
253 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
255 RenderPreview::draw(pi, x, y);
261 boost::signals::connection
262 RenderMonitoredPreview::fileChanged(slot_type const & slot)
264 return monitor_.connect(slot);