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"
18 #include "support/gettext.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>
36 using namespace lyx::support;
41 LyXRC_PreviewStatus RenderPreview::status()
43 return graphics::Previews::status();
47 RenderPreview::RenderPreview(Inset const * inset)
52 RenderPreview::RenderPreview(RenderPreview const & other,
55 boost::signals::trackable(),
56 snippet_(other.snippet_),
61 RenderPreview::~RenderPreview()
63 if (ploader_connection_.connected())
64 ploader_connection_.disconnect();
68 RenderBase * RenderPreview::clone(Inset const * inset) const
70 return new RenderPreview(*this, inset);
76 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
78 graphics::Previews const & previews = graphics::Previews::get();
79 return previews.loader(buffer);
83 docstring const statusMessage(BufferView const * bv, string const & snippet)
87 Buffer const & buffer = bv->buffer();
88 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
89 graphics::PreviewLoader::Status const status = loader.status(snippet);
93 case graphics::PreviewLoader::InQueue:
94 case graphics::PreviewLoader::Processing:
95 message = _("Preview loading");
97 case graphics::PreviewLoader::Ready:
98 message = _("Preview ready");
100 case graphics::PreviewLoader::NotFound:
101 message = _("Preview failed");
111 graphics::PreviewImage const *
112 RenderPreview::getPreviewImage(Buffer const & buffer) const
114 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
115 return loader.preview(snippet_);
119 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
121 BOOST_ASSERT(mi.base.bv);
123 graphics::PreviewImage const * const pimage =
124 getPreviewImage(mi.base.bv->buffer());
132 FontInfo font(mi.base.font);
133 font.setFamily(SANS_FAMILY);
134 font.setSize(FONT_SIZE_FOOTNOTE);
135 docstring const stat = 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);
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 = Inset::TEXT_TO_INSET_OFFSET;
158 pi.pain.rectangle(x + offset,
160 dim_.wid - 2 * offset,
164 FontInfo font(pi.base.font);
165 font.setFamily(SANS_FAMILY);
166 font.setSize(FONT_SIZE_FOOTNOTE);
168 docstring const stat = statusMessage(pi.base.bv, snippet_);
169 pi.pain.text(x + offset + 6,
170 y - theFontMetrics(font).maxAscent() - 4,
176 void RenderPreview::startLoading(Buffer const & buffer) const
178 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
181 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
182 loader.startLoading();
186 void RenderPreview::addPreview(docstring const & latex_snippet,
187 Buffer const & buffer)
189 if (status() == LyXRC::PREVIEW_OFF)
192 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
193 addPreview(latex_snippet, loader);
197 void RenderPreview::addPreview(docstring const & latex_snippet,
198 graphics::PreviewLoader & ploader)
200 if (status() == LyXRC::PREVIEW_OFF)
204 // We have to make sure that we call latex with the right encoding
205 snippet_ = support::trim(to_utf8(latex_snippet));
206 if (snippet_.empty())
209 if (ploader.preview(snippet_))
212 // If this is the first time of calling, connect to the
213 // PreviewLoader signal that'll inform us when the preview image
214 // is ready for loading.
215 if (!ploader_connection_.connected()) {
216 ploader_connection_ = ploader.connect(
217 boost::bind(&RenderPreview::imageReady, this, _1));
220 ploader.add(snippet_);
224 void RenderPreview::removePreview(Buffer const & buffer)
226 if (snippet_.empty())
229 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
230 loader.remove(snippet_);
235 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
237 // Check the current snippet is the same as that previewed.
238 if (snippet_ == pimage.snippet())
239 parent_->updateFrontend();
243 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
244 : RenderPreview(inset), monitor_(FileName(), 2000)
248 void RenderMonitoredPreview::setAbsFile(FileName const & file)
250 monitor_.reset(file);
254 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
256 RenderPreview::draw(pi, x, y);
262 boost::signals::connection
263 RenderMonitoredPreview::fileChanged(slot_type const & slot)
265 return monitor_.connect(slot);