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;
45 LyXRC_PreviewStatus RenderPreview::status()
47 return graphics::Previews::status();
51 RenderPreview::RenderPreview(Inset const * inset)
56 RenderPreview::RenderPreview(RenderPreview const & other,
59 boost::signals::trackable(),
60 snippet_(other.snippet_),
65 RenderPreview::~RenderPreview()
67 if (ploader_connection_.connected())
68 ploader_connection_.disconnect();
72 auto_ptr<RenderBase> RenderPreview::clone(Inset const * inset) const
74 return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
80 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
82 graphics::Previews const & previews = graphics::Previews::get();
83 return previews.loader(buffer);
87 docstring const statusMessage(BufferView const * bv, string const & snippet)
91 Buffer const & buffer = bv->buffer();
92 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
93 graphics::PreviewLoader::Status const status = loader.status(snippet);
97 case graphics::PreviewLoader::InQueue:
98 case graphics::PreviewLoader::Processing:
99 message = _("Preview loading");
101 case graphics::PreviewLoader::Ready:
102 message = _("Preview ready");
104 case graphics::PreviewLoader::NotFound:
105 message = _("Preview failed");
115 graphics::PreviewImage const *
116 RenderPreview::getPreviewImage(Buffer const & buffer) const
118 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
119 return loader.preview(snippet_);
123 bool RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
125 BOOST_ASSERT(mi.base.bv);
127 graphics::PreviewImage const * const pimage =
128 getPreviewImage(mi.base.bv->buffer());
131 dim.asc = pimage->ascent();
132 dim.des = pimage->descent();
133 dim.wid = pimage->width();
138 Font font(mi.base.font);
139 font.setFamily(Font::SANS_FAMILY);
140 font.setSize(Font::SIZE_FOOTNOTE);
141 docstring const stat = statusMessage(mi.base.bv, snippet_);
142 dim.wid = 15 + theFontMetrics(font).width(stat);
145 bool const changed = dim_ != dim;
151 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
153 BOOST_ASSERT(pi.base.bv);
155 graphics::PreviewImage const * const pimage =
156 getPreviewImage(pi.base.bv->buffer());
157 graphics::Image const * const image = pimage ? pimage->image() : 0;
160 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
164 int const offset = Inset::TEXT_TO_INSET_OFFSET;
166 pi.pain.rectangle(x + offset,
168 dim_.wid - 2 * offset,
172 Font font(pi.base.font);
173 font.setFamily(Font::SANS_FAMILY);
174 font.setSize(Font::SIZE_FOOTNOTE);
176 docstring const stat = statusMessage(pi.base.bv, snippet_);
177 pi.pain.text(x + offset + 6,
178 y - theFontMetrics(font).maxAscent() - 4,
184 void RenderPreview::startLoading(Buffer const & buffer) const
186 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
189 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
190 loader.startLoading();
194 void RenderPreview::addPreview(docstring const & latex_snippet,
195 Buffer const & buffer)
197 if (status() == LyXRC::PREVIEW_OFF)
200 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
201 addPreview(latex_snippet, loader);
205 void RenderPreview::addPreview(docstring const & latex_snippet,
206 graphics::PreviewLoader & ploader)
208 if (status() == LyXRC::PREVIEW_OFF)
212 // We have to make sure that we call latex with the right encoding
213 snippet_ = support::trim(to_utf8(latex_snippet));
214 if (snippet_.empty())
217 if (ploader.preview(snippet_))
220 // If this is the first time of calling, connect to the
221 // PreviewLoader signal that'll inform us when the preview image
222 // is ready for loading.
223 if (!ploader_connection_.connected()) {
224 ploader_connection_ = ploader.connect(
225 boost::bind(&RenderPreview::imageReady, this, _1));
228 ploader.add(snippet_);
232 void RenderPreview::removePreview(Buffer const & buffer)
234 if (snippet_.empty())
237 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
238 loader.remove(snippet_);
243 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
245 // Check the current snippet is the same as that previewed.
246 if (snippet_ == pimage.snippet())
247 LyX::cref().updateInset(parent_);
251 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
252 : RenderPreview(inset),
253 monitor_(FileName(), 2000)
257 void RenderMonitoredPreview::setAbsFile(FileName const & file)
259 monitor_.reset(file);
263 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
265 RenderPreview::draw(pi, x, y);
271 boost::signals::connection
272 RenderMonitoredPreview::fileChanged(slot_type const & slot)
274 return monitor_.connect(slot);