2 * \file RenderPreview.cpp
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/RenderPreview.h"
14 #include "insets/Inset.h"
16 #include "BufferView.h"
17 #include "Dimension.h"
21 #include "MetricsInfo.h"
23 #include "frontends/FontMetrics.h"
24 #include "frontends/Painter.h"
26 #include "graphics/PreviewImage.h"
27 #include "graphics/PreviewLoader.h"
28 #include "graphics/Previews.h"
30 #include "support/FileName.h"
31 #include "support/lstrings.h"
33 #include <boost/bind.hpp>
38 using support::FileName;
43 LyXRC_PreviewStatus RenderPreview::status()
45 return graphics::Previews::status();
49 RenderPreview::RenderPreview(Inset const * inset)
54 RenderPreview::RenderPreview(RenderPreview const & other,
57 boost::signals::trackable(),
58 snippet_(other.snippet_),
63 RenderPreview::~RenderPreview()
65 if (ploader_connection_.connected())
66 ploader_connection_.disconnect();
70 RenderBase * RenderPreview::clone(Inset const * inset) const
72 return new RenderPreview(*this, inset);
78 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
80 graphics::Previews const & previews = graphics::Previews::get();
81 return previews.loader(buffer);
85 docstring const statusMessage(BufferView const * bv, string const & snippet)
89 Buffer const & buffer = bv->buffer();
90 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
91 graphics::PreviewLoader::Status const status = loader.status(snippet);
95 case graphics::PreviewLoader::InQueue:
96 case graphics::PreviewLoader::Processing:
97 message = _("Preview loading");
99 case graphics::PreviewLoader::Ready:
100 message = _("Preview ready");
102 case graphics::PreviewLoader::NotFound:
103 message = _("Preview failed");
113 graphics::PreviewImage const *
114 RenderPreview::getPreviewImage(Buffer const & buffer) const
116 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
117 return loader.preview(snippet_);
121 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
123 BOOST_ASSERT(mi.base.bv);
125 graphics::PreviewImage const * const pimage =
126 getPreviewImage(mi.base.bv->buffer());
129 dim.asc = pimage->ascent();
130 dim.des = pimage->descent();
131 dim.wid = pimage->width();
136 Font font(mi.base.font);
137 font.setFamily(Font::SANS_FAMILY);
138 font.setSize(Font::SIZE_FOOTNOTE);
139 docstring const stat = statusMessage(mi.base.bv, snippet_);
140 dim.wid = 15 + theFontMetrics(font).width(stat);
147 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
149 BOOST_ASSERT(pi.base.bv);
151 graphics::PreviewImage const * const pimage =
152 getPreviewImage(pi.base.bv->buffer());
153 graphics::Image const * const image = pimage ? pimage->image() : 0;
156 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
160 int const offset = Inset::TEXT_TO_INSET_OFFSET;
162 pi.pain.rectangle(x + offset,
164 dim_.wid - 2 * offset,
168 Font font(pi.base.font);
169 font.setFamily(Font::SANS_FAMILY);
170 font.setSize(Font::SIZE_FOOTNOTE);
172 docstring const stat = statusMessage(pi.base.bv, snippet_);
173 pi.pain.text(x + offset + 6,
174 y - theFontMetrics(font).maxAscent() - 4,
180 void RenderPreview::startLoading(Buffer const & buffer) const
182 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
185 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
186 loader.startLoading();
190 void RenderPreview::addPreview(docstring const & latex_snippet,
191 Buffer const & buffer)
193 if (status() == LyXRC::PREVIEW_OFF)
196 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
197 addPreview(latex_snippet, loader);
201 void RenderPreview::addPreview(docstring const & latex_snippet,
202 graphics::PreviewLoader & ploader)
204 if (status() == LyXRC::PREVIEW_OFF)
208 // We have to make sure that we call latex with the right encoding
209 snippet_ = support::trim(to_utf8(latex_snippet));
210 if (snippet_.empty())
213 if (ploader.preview(snippet_))
216 // If this is the first time of calling, connect to the
217 // PreviewLoader signal that'll inform us when the preview image
218 // is ready for loading.
219 if (!ploader_connection_.connected()) {
220 ploader_connection_ = ploader.connect(
221 boost::bind(&RenderPreview::imageReady, this, _1));
224 ploader.add(snippet_);
228 void RenderPreview::removePreview(Buffer const & buffer)
230 if (snippet_.empty())
233 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
234 loader.remove(snippet_);
239 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
241 // Check the current snippet is the same as that previewed.
242 if (snippet_ == pimage.snippet())
243 LyX::cref().updateInset(parent_);
247 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
248 : RenderPreview(inset),
249 monitor_(FileName(), 2000)
253 void RenderMonitoredPreview::setAbsFile(FileName const & file)
255 monitor_.reset(file);
259 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
261 RenderPreview::draw(pi, x, y);
267 boost::signals::connection
268 RenderMonitoredPreview::fileChanged(slot_type const & slot)
270 return monitor_.connect(slot);