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"
18 #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;
44 LyXRC_PreviewStatus RenderPreview::status()
46 return graphics::Previews::status();
50 RenderPreview::RenderPreview(Inset const * inset)
55 RenderPreview::RenderPreview(RenderPreview const & other,
58 boost::signals::trackable(),
59 snippet_(other.snippet_),
64 RenderPreview::~RenderPreview()
66 if (ploader_connection_.connected())
67 ploader_connection_.disconnect();
71 RenderBase * RenderPreview::clone(Inset const * inset) const
73 return new RenderPreview(*this, inset);
79 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
81 graphics::Previews const & previews = graphics::Previews::get();
82 return previews.loader(buffer);
86 docstring const statusMessage(BufferView const * bv, string const & snippet)
90 Buffer const & buffer = bv->buffer();
91 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
92 graphics::PreviewLoader::Status const status = loader.status(snippet);
96 case graphics::PreviewLoader::InQueue:
97 case graphics::PreviewLoader::Processing:
98 message = _("Preview loading");
100 case graphics::PreviewLoader::Ready:
101 message = _("Preview ready");
103 case graphics::PreviewLoader::NotFound:
104 message = _("Preview failed");
114 graphics::PreviewImage const *
115 RenderPreview::getPreviewImage(Buffer const & buffer) const
117 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
118 return loader.preview(snippet_);
122 bool RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
124 BOOST_ASSERT(mi.base.bv);
126 graphics::PreviewImage const * const pimage =
127 getPreviewImage(mi.base.bv->buffer());
130 dim.asc = pimage->ascent();
131 dim.des = pimage->descent();
132 dim.wid = pimage->width();
137 Font font(mi.base.font);
138 font.setFamily(Font::SANS_FAMILY);
139 font.setSize(Font::SIZE_FOOTNOTE);
140 docstring const stat = statusMessage(mi.base.bv, snippet_);
141 dim.wid = 15 + theFontMetrics(font).width(stat);
144 bool const changed = dim_ != dim;
150 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
152 BOOST_ASSERT(pi.base.bv);
154 graphics::PreviewImage const * const pimage =
155 getPreviewImage(pi.base.bv->buffer());
156 graphics::Image const * const image = pimage ? pimage->image() : 0;
159 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
163 int const offset = Inset::TEXT_TO_INSET_OFFSET;
165 pi.pain.rectangle(x + offset,
167 dim_.wid - 2 * offset,
171 Font font(pi.base.font);
172 font.setFamily(Font::SANS_FAMILY);
173 font.setSize(Font::SIZE_FOOTNOTE);
175 docstring const stat = statusMessage(pi.base.bv, snippet_);
176 pi.pain.text(x + offset + 6,
177 y - theFontMetrics(font).maxAscent() - 4,
183 void RenderPreview::startLoading(Buffer const & buffer) const
185 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
188 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
189 loader.startLoading();
193 void RenderPreview::addPreview(docstring const & latex_snippet,
194 Buffer const & buffer)
196 if (status() == LyXRC::PREVIEW_OFF)
199 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
200 addPreview(latex_snippet, loader);
204 void RenderPreview::addPreview(docstring const & latex_snippet,
205 graphics::PreviewLoader & ploader)
207 if (status() == LyXRC::PREVIEW_OFF)
211 // We have to make sure that we call latex with the right encoding
212 snippet_ = support::trim(to_utf8(latex_snippet));
213 if (snippet_.empty())
216 if (ploader.preview(snippet_))
219 // If this is the first time of calling, connect to the
220 // PreviewLoader signal that'll inform us when the preview image
221 // is ready for loading.
222 if (!ploader_connection_.connected()) {
223 ploader_connection_ = ploader.connect(
224 boost::bind(&RenderPreview::imageReady, this, _1));
227 ploader.add(snippet_);
231 void RenderPreview::removePreview(Buffer const & buffer)
233 if (snippet_.empty())
236 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
237 loader.remove(snippet_);
242 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
244 // Check the current snippet is the same as that previewed.
245 if (snippet_ == pimage.snippet())
246 LyX::cref().updateInset(parent_);
250 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
251 : RenderPreview(inset),
252 monitor_(FileName(), 2000)
256 void RenderMonitoredPreview::setAbsFile(FileName const & file)
258 monitor_.reset(file);
262 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
264 RenderPreview::draw(pi, x, y);
270 boost::signals::connection
271 RenderMonitoredPreview::fileChanged(slot_type const & slot)
273 return monitor_.connect(slot);