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"
18 #include "dimension.h"
23 #include "metricsinfo.h"
25 #include "frontends/font_metrics.h"
26 #include "frontends/Painter.h"
28 #include "graphics/PreviewImage.h"
29 #include "graphics/PreviewLoader.h"
30 #include "graphics/Previews.h"
32 #include "support/lstrings.h"
34 #include <boost/bind.hpp>
39 namespace graphics = lyx::graphics;
40 namespace support = lyx::support;
43 LyXRC_PreviewStatus RenderPreview::status()
45 return graphics::Previews::status();
49 RenderPreview::RenderPreview(InsetBase const * inset)
54 RenderPreview::RenderPreview(RenderPreview const & other,
55 InsetBase const * inset)
57 boost::signals::trackable(),
58 snippet_(other.snippet_),
63 auto_ptr<RenderBase> RenderPreview::clone(InsetBase const * inset) const
65 return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
71 string const statusMessage(BufferView const * bv, string const & snippet)
73 BOOST_ASSERT(bv && bv->buffer());
75 Buffer const & buffer = *bv->buffer();
76 graphics::Previews const & previews = graphics::Previews::get();
77 graphics::PreviewLoader const & loader = previews.loader(buffer);
78 graphics::PreviewLoader::Status const status = loader.status(snippet);
82 case graphics::PreviewLoader::InQueue:
83 case graphics::PreviewLoader::Processing:
84 message = _("Preview loading");
86 case graphics::PreviewLoader::Ready:
87 message = _("Preview ready");
89 case graphics::PreviewLoader::NotFound:
90 message = _("Preview failed");
100 graphics::PreviewImage const *
101 RenderPreview::getPreviewImage(Buffer const & buffer) const
103 graphics::Previews & previews = graphics::Previews::get();
104 graphics::PreviewLoader & loader = previews.loader(buffer);
105 return loader.preview(snippet_);
109 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
111 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
113 graphics::PreviewImage const * const pimage =
114 getPreviewImage(*mi.base.bv->buffer());
117 dim.asc = pimage->ascent();
118 dim.des = pimage->descent();
119 dim.wid = pimage->width();
124 LyXFont font(mi.base.font);
125 font.setFamily(LyXFont::SANS_FAMILY);
126 font.setSize(LyXFont::SIZE_FOOTNOTE);
128 font_metrics::width(statusMessage(mi.base.bv, snippet_),
136 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
138 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
140 graphics::PreviewImage const * const pimage =
141 getPreviewImage(*pi.base.bv->buffer());
143 if (pimage && pimage->image()) {
144 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
149 pi.pain.rectangle(x + InsetOld::TEXT_TO_INSET_OFFSET,
151 dim_.wid - 2 * InsetOld::TEXT_TO_INSET_OFFSET,
155 LyXFont font(pi.base.font);
156 font.setFamily(LyXFont::SANS_FAMILY);
157 font.setSize(LyXFont::SIZE_FOOTNOTE);
158 pi.pain.text(x + InsetOld::TEXT_TO_INSET_OFFSET + 6,
159 y - font_metrics::maxAscent(font) - 4,
160 statusMessage(pi.base.bv, snippet_), font);
164 void RenderPreview::startLoading(Buffer const & buffer) const
166 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
169 graphics::Previews & previews = graphics::Previews::get();
170 graphics::PreviewLoader & loader = previews.loader(buffer);
171 loader.startLoading();
172 lyxerr << "RenderPreview::startLoading: " << snippet_ << std::endl;
176 void RenderPreview::addPreview(string const & latex_snippet,
177 Buffer const & buffer)
179 if (status() == LyXRC::PREVIEW_OFF)
182 graphics::Previews & previews = graphics::Previews::get();
183 graphics::PreviewLoader & loader = previews.loader(buffer);
184 addPreview(latex_snippet, loader);
188 void RenderPreview::addPreview(string const & latex_snippet,
189 graphics::PreviewLoader & ploader)
191 if (status() == LyXRC::PREVIEW_OFF)
194 snippet_ = support::trim(latex_snippet);
195 if (snippet_.empty())
198 if (ploader.preview(snippet_))
201 // If this is the first time of calling, connect to the
202 // PreviewLoader signal that'll inform us when the preview image
203 // is ready for loading.
204 if (!ploader_connection_.connected()) {
205 ploader_connection_ = ploader.connect(
206 boost::bind(&RenderPreview::imageReady, this, _1));
209 ploader.add(snippet_);
213 void RenderPreview::removePreview(Buffer const & buffer)
215 if (snippet_.empty())
218 graphics::Previews & previews = graphics::Previews::get();
219 graphics::PreviewLoader & loader = previews.loader(buffer);
220 loader.remove(snippet_);
225 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
227 // Check the current snippet is the same as that previewed.
228 if (snippet_ == pimage.snippet())
229 LyX::cref().updateInset(parent_);
233 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
234 : RenderPreview(inset),
235 monitor_(std::string(), 2000)
239 void RenderMonitoredPreview::setAbsFile(string const & file)
241 monitor_.reset(file);
245 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
247 RenderPreview::draw(pi, x, y);
253 boost::signals::connection
254 RenderMonitoredPreview::fileChanged(slot_type const & slot)
256 return monitor_.connect(slot);