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"
20 #include "MetricsInfo.h"
22 #include "frontends/FontMetrics.h"
23 #include "frontends/Painter.h"
25 #include "graphics/PreviewImage.h"
26 #include "graphics/PreviewLoader.h"
27 #include "graphics/Previews.h"
29 #include "support/FileName.h"
30 #include "support/gettext.h"
31 #include "support/lassert.h"
32 #include "support/lstrings.h"
34 #include "support/bind.h"
37 using namespace lyx::support;
42 LyXRC_PreviewStatus RenderPreview::status()
44 return graphics::Previews::status();
48 RenderPreview::RenderPreview(Inset const * inset)
53 RenderPreview::RenderPreview(RenderPreview const & other,
56 boost::signals::trackable(),
57 snippet_(other.snippet_),
62 RenderPreview::~RenderPreview()
64 if (ploader_connection_.connected())
65 ploader_connection_.disconnect();
69 RenderBase * RenderPreview::clone(Inset const * inset) const
71 return new RenderPreview(*this, inset);
77 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
79 return thePreviews().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 LASSERT(mi.base.bv, /**/);
123 graphics::PreviewImage const * const pimage =
124 getPreviewImage(mi.base.bv->buffer());
127 // If prepared, load the picture before dim calculation. See bug #5627.
134 FontInfo font(mi.base.font);
135 font.setFamily(SANS_FAMILY);
136 font.setSize(FONT_SIZE_FOOTNOTE);
137 docstring const stat = statusMessage(mi.base.bv, snippet_);
138 dim.wid = 15 + theFontMetrics(font).width(stat);
145 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
147 LASSERT(pi.base.bv, /**/);
149 graphics::PreviewImage const * const pimage =
150 getPreviewImage(pi.base.bv->buffer());
151 graphics::Image const * const image = pimage ? pimage->image() : 0;
154 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
158 int const offset = Inset::TEXT_TO_INSET_OFFSET;
160 pi.pain.rectangle(x + offset,
162 dim_.wid - 2 * offset,
166 FontInfo font(pi.base.font);
167 font.setFamily(SANS_FAMILY);
168 font.setSize(FONT_SIZE_FOOTNOTE);
170 docstring const stat = statusMessage(pi.base.bv, snippet_);
171 pi.pain.text(x + offset + 6,
172 y - theFontMetrics(font).maxAscent() - 4,
178 void RenderPreview::startLoading(Buffer const & buffer) const
180 if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
183 graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
184 loader.startLoading();
188 void RenderPreview::addPreview(docstring const & latex_snippet,
189 Buffer const & buffer)
191 if (status() == LyXRC::PREVIEW_OFF)
194 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
195 addPreview(latex_snippet, loader);
199 void RenderPreview::addPreview(docstring const & latex_snippet,
200 graphics::PreviewLoader & ploader)
202 if (status() == LyXRC::PREVIEW_OFF)
206 // We have to make sure that we call latex with the right encoding
207 snippet_ = support::trim(to_utf8(latex_snippet));
208 if (snippet_.empty())
211 if (ploader.preview(snippet_))
214 // If this is the first time of calling, connect to the
215 // PreviewLoader signal that'll inform us when the preview image
216 // is ready for loading.
217 if (!ploader_connection_.connected()) {
218 ploader_connection_ = ploader.connect(
219 bind(&RenderPreview::imageReady, this, _1));
222 ploader.add(snippet_);
226 void RenderPreview::removePreview(Buffer const & buffer)
228 if (snippet_.empty())
231 graphics::PreviewLoader & loader = getPreviewLoader(buffer);
232 loader.remove(snippet_);
237 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
239 // Check the current snippet is the same as that previewed.
240 if (snippet_ == pimage.snippet())
241 parent_->updateFrontend();
245 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
246 : RenderPreview(inset), monitor_(FileName(), 2000)
250 void RenderMonitoredPreview::setAbsFile(FileName 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);