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>
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");
102 return lyx::to_utf8(message);
108 graphics::PreviewImage const *
109 RenderPreview::getPreviewImage(Buffer const & buffer) const
111 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
112 return loader.preview(snippet_);
116 void 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);
135 docstring const stat = lyx::from_utf8(statusMessage(mi.base.bv, snippet_));
136 dim.wid = 15 + theFontMetrics(font).width(stat);
143 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
145 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
147 graphics::PreviewImage const * const pimage =
148 getPreviewImage(*pi.base.bv->buffer());
149 graphics::Image const * const image = pimage ? pimage->image() : 0;
152 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
156 int const offset = InsetOld::TEXT_TO_INSET_OFFSET;
158 pi.pain.rectangle(x + offset,
160 dim_.wid - 2 * offset,
164 LyXFont font(pi.base.font);
165 font.setFamily(LyXFont::SANS_FAMILY);
166 font.setSize(LyXFont::SIZE_FOOTNOTE);
169 docstring const stat = lyx::from_utf8(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(lyx::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_(std::string(), 2000)
250 void RenderMonitoredPreview::setAbsFile(string 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);