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"
21 #include "metricsinfo.h"
23 #include "frontends/font_metrics.h"
24 #include "frontends/Painter.h"
26 #include "graphics/PreviewImage.h"
27 #include "graphics/PreviewLoader.h"
28 #include "graphics/Previews.h"
30 #include "support/lstrings.h"
32 #include <boost/bind.hpp>
37 namespace graphics = lyx::graphics;
38 namespace support = lyx::support;
41 bool RenderPreview::activated()
43 return graphics::Previews::activated();
47 RenderPreview::RenderPreview(InsetBase const * inset)
53 RenderPreview::RenderPreview(RenderPreview const & other,
54 InsetBase const * inset)
56 boost::signals::trackable(),
57 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 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
102 if (previewReady()) {
103 dim.asc = pimage_->ascent();
104 dim.des = pimage_->descent();
105 dim.wid = pimage_->width();
110 LyXFont font(mi.base.font);
111 font.setFamily(LyXFont::SANS_FAMILY);
112 font.setSize(LyXFont::SIZE_FOOTNOTE);
114 font_metrics::width(statusMessage(mi.base.bv, snippet_),
122 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
124 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
125 Buffer const & buffer = *pi.base.bv->buffer();
126 startLoading(buffer);
128 if (previewReady()) {
129 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
130 *(pimage_->image()));
134 pi.pain.rectangle(x + InsetOld::TEXT_TO_INSET_OFFSET,
136 dim_.wid - 2 * InsetOld::TEXT_TO_INSET_OFFSET,
140 LyXFont font(pi.base.font);
141 font.setFamily(LyXFont::SANS_FAMILY);
142 font.setSize(LyXFont::SIZE_FOOTNOTE);
143 pi.pain.text(x + InsetOld::TEXT_TO_INSET_OFFSET + 6,
144 y - font_metrics::maxAscent(font) - 4,
145 statusMessage(pi.base.bv, snippet_), font);
149 void RenderPreview::startLoading(Buffer const & buffer) const
151 if (!activated() && !snippet_.empty())
154 graphics::Previews & previews = graphics::Previews::get();
155 graphics::PreviewLoader & loader = previews.loader(buffer);
156 loader.startLoading();
160 void RenderPreview::addPreview(string const & latex_snippet,
161 Buffer const & buffer)
166 graphics::Previews & previews = graphics::Previews::get();
167 graphics::PreviewLoader & loader = previews.loader(buffer);
168 addPreview(latex_snippet, loader);
172 void RenderPreview::addPreview(string const & latex_snippet,
173 graphics::PreviewLoader & ploader)
178 snippet_ = support::trim(latex_snippet);
180 if (snippet_.empty())
183 pimage_ = ploader.preview(snippet_);
187 // If this is the first time of calling, connect to the
188 // PreviewLoader signal that'll inform us when the preview image
189 // is ready for loading.
190 if (!ploader_connection_.connected()) {
191 ploader_connection_ = ploader.connect(
192 boost::bind(&RenderPreview::imageReady, this, _1));
195 ploader.add(snippet_);
199 void RenderPreview::removePreview(Buffer const & buffer)
201 if (snippet_.empty())
204 graphics::Previews & previews = graphics::Previews::get();
205 graphics::PreviewLoader & loader = previews.loader(buffer);
206 loader.remove(snippet_);
212 bool RenderPreview::previewReady() const
214 return pimage_ ? pimage_->image() : false;
218 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
220 // Check the current snippet is the same as that previewed.
221 if (snippet_ != pimage.snippet())
225 LyX::cref().updateInset(parent_);
229 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
230 : RenderPreview(inset),
231 monitor_(std::string(), 2000)
235 void RenderMonitoredPreview::setAbsFile(string const & file)
237 monitor_.reset(file);
241 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
243 RenderPreview::draw(pi, x, y);
249 boost::signals::connection
250 RenderMonitoredPreview::fileChanged(slot_type const & slot)
252 return monitor_.connect(slot);