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/filename.h"
32 #include "support/lstrings.h"
34 #include <boost/bind.hpp>
39 using support::FileName;
45 LyXRC_PreviewStatus RenderPreview::status()
47 return graphics::Previews::status();
51 RenderPreview::RenderPreview(InsetBase const * inset)
56 RenderPreview::RenderPreview(RenderPreview const & other,
57 InsetBase const * inset)
59 boost::signals::trackable(),
60 snippet_(other.snippet_),
65 auto_ptr<RenderBase> RenderPreview::clone(InsetBase const * inset) const
67 return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
73 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
75 graphics::Previews const & previews = graphics::Previews::get();
76 return previews.loader(buffer);
80 docstring const statusMessage(BufferView const * bv, string const & snippet)
82 BOOST_ASSERT(bv && bv->buffer());
84 Buffer const & buffer = *bv->buffer();
85 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
86 graphics::PreviewLoader::Status const status = loader.status(snippet);
90 case graphics::PreviewLoader::InQueue:
91 case graphics::PreviewLoader::Processing:
92 message = _("Preview loading");
94 case graphics::PreviewLoader::Ready:
95 message = _("Preview ready");
97 case graphics::PreviewLoader::NotFound:
98 message = _("Preview failed");
108 graphics::PreviewImage const *
109 RenderPreview::getPreviewImage(Buffer const & buffer) const
111 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
112 return loader.preview(snippet_);
116 bool RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
118 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
120 graphics::PreviewImage const * const pimage =
121 getPreviewImage(*mi.base.bv->buffer());
124 dim.asc = pimage->ascent();
125 dim.des = pimage->descent();
126 dim.wid = pimage->width();
131 LyXFont font(mi.base.font);
132 font.setFamily(LyXFont::SANS_FAMILY);
133 font.setSize(LyXFont::SIZE_FOOTNOTE);
134 docstring const stat = statusMessage(mi.base.bv, snippet_);
135 dim.wid = 15 + theFontMetrics(font).width(stat);
138 bool const changed = dim_ != dim;
144 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
146 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
148 graphics::PreviewImage const * const pimage =
149 getPreviewImage(*pi.base.bv->buffer());
150 graphics::Image const * const image = pimage ? pimage->image() : 0;
153 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
157 int const offset = InsetOld::TEXT_TO_INSET_OFFSET;
159 pi.pain.rectangle(x + offset,
161 dim_.wid - 2 * offset,
165 LyXFont font(pi.base.font);
166 font.setFamily(LyXFont::SANS_FAMILY);
167 font.setSize(LyXFont::SIZE_FOOTNOTE);
169 docstring const stat = statusMessage(pi.base.bv, snippet_);
170 pi.pain.text(x + offset + 6,
171 y - theFontMetrics(font).maxAscent() - 4,
177 void RenderPreview::startLoading(Buffer const & buffer) const
179 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
182 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
183 loader.startLoading();
187 void RenderPreview::addPreview(docstring const & latex_snippet,
188 Buffer const & buffer)
190 if (status() == LyXRC::PREVIEW_OFF)
193 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
194 addPreview(latex_snippet, loader);
198 void RenderPreview::addPreview(docstring const & latex_snippet,
199 graphics::PreviewLoader & ploader)
201 if (status() == LyXRC::PREVIEW_OFF)
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 boost::bind(&RenderPreview::imageReady, this, _1));
221 ploader.add(snippet_);
225 void RenderPreview::removePreview(Buffer const & buffer)
227 if (snippet_.empty())
230 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
231 loader.remove(snippet_);
236 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
238 // Check the current snippet is the same as that previewed.
239 if (snippet_ == pimage.snippet())
240 LyX::cref().updateInset(parent_);
244 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
245 : RenderPreview(inset),
246 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);