src/insets/render_preview.C

   1 /**
   2  * \file render_preview.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "insets/render_preview.h"
  14 #include "insets/inset.h"
  15
  16 #include "BufferView.h"
  17 #include "dimension.h"
  18 #include "gettext.h"
  19 #include "LColor.h"
  20 #include "lyx_main.h"
  21 #include "lyxrc.h"
  22 #include "metricsinfo.h"
  23
  24 #include "frontends/FontMetrics.h"
  25 #include "frontends/Painter.h"
  26
  27 #include "graphics/PreviewImage.h"
  28 #include "graphics/PreviewLoader.h"
  29 #include "graphics/Previews.h"
  30
  31 #include "support/lstrings.h"
  32
  33 #include <boost/bind.hpp>
  34
  35
  36 namespace lyx {
  37
  38 using std::string;
  39 using std::auto_ptr;
  40
  41
  42 LyXRC_PreviewStatus RenderPreview::status()
  43 {
  44         return graphics::Previews::status();
  45 }
  46
  47
  48 RenderPreview::RenderPreview(InsetBase const * inset)
  49         : parent_(inset)
  50 {}
  51
  52
  53 RenderPreview::RenderPreview(RenderPreview const & other,
  54                              InsetBase const * inset)
  55         : RenderBase(other),
  56           boost::signals::trackable(),
  57           snippet_(other.snippet_),
  58           parent_(inset)
  59 {}
  60
  61
  62 auto_ptr<RenderBase> RenderPreview::clone(InsetBase const * inset) const
  63 {
  64         return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
  65 }
  66
  67
  68 namespace {
  69
  70 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
  71 {
  72         graphics::Previews const & previews = graphics::Previews::get();
  73         return previews.loader(buffer);
  74 }
  75
  76
  77 docstring const statusMessage(BufferView const * bv, string const & snippet)
  78 {
  79         BOOST_ASSERT(bv && bv->buffer());
  80
  81         Buffer const & buffer = *bv->buffer();
  82         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
  83         graphics::PreviewLoader::Status const status = loader.status(snippet);
  84
  85         docstring message;
  86         switch (status) {
  87         case graphics::PreviewLoader::InQueue:
  88         case graphics::PreviewLoader::Processing:
  89                 message = _("Preview loading");
  90                 break;
  91         case graphics::PreviewLoader::Ready:
  92                 message = _("Preview ready");
  93                 break;
  94         case graphics::PreviewLoader::NotFound:
  95                 message = _("Preview failed");
  96                 break;
  97         }
  98
  99         return message;
 100 }
 101
 102 } // namespace anon
 103
 104
 105 graphics::PreviewImage const *
 106 RenderPreview::getPreviewImage(Buffer const & buffer) const
 107 {
 108         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 109         return loader.preview(snippet_);
 110 }
 111
 112
 113 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
 114 {
 115         BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
 116
 117         graphics::PreviewImage const * const pimage =
 118                 getPreviewImage(*mi.base.bv->buffer());
 119
 120         if (pimage) {
 121                 dim.asc = pimage->ascent();
 122                 dim.des = pimage->descent();
 123                 dim.wid = pimage->width();
 124         } else {
 125                 dim.asc = 50;
 126                 dim.des = 0;
 127
 128                 LyXFont font(mi.base.font);
 129                 font.setFamily(LyXFont::SANS_FAMILY);
 130                 font.setSize(LyXFont::SIZE_FOOTNOTE);
 131                 docstring const stat = statusMessage(mi.base.bv, snippet_);
 132                 dim.wid = 15 + theFontMetrics(font).width(stat);
 133         }
 134
 135         dim_ = dim;
 136 }
 137
 138
 139 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 140 {
 141         BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
 142
 143         graphics::PreviewImage const * const pimage =
 144                 getPreviewImage(*pi.base.bv->buffer());
 145         graphics::Image const * const image = pimage ? pimage->image() : 0;
 146
 147         if (image) {
 148                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 149                               *image);
 150
 151         } else {
 152                 int const offset = InsetOld::TEXT_TO_INSET_OFFSET;
 153
 154                 pi.pain.rectangle(x + offset,
 155                                   y - dim_.asc,
 156                                   dim_.wid - 2 * offset,
 157                                   dim_.asc + dim_.des,
 158                                   LColor::foreground);
 159
 160                 LyXFont font(pi.base.font);
 161                 font.setFamily(LyXFont::SANS_FAMILY);
 162                 font.setSize(LyXFont::SIZE_FOOTNOTE);
 163
 164                 docstring const stat = statusMessage(pi.base.bv, snippet_);
 165                 pi.pain.text(x + offset + 6,
 166                              y - theFontMetrics(font).maxAscent() - 4,
 167                              stat, font);
 168         }
 169 }
 170
 171
 172 void RenderPreview::startLoading(Buffer const & buffer) const
 173 {
 174         if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
 175                 return;
 176
 177         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 178         loader.startLoading();
 179 }
 180
 181
 182 void RenderPreview::addPreview(docstring const & latex_snippet,
 183                                Buffer const & buffer)
 184 {
 185         if (status() == LyXRC::PREVIEW_OFF)
 186                 return;
 187
 188         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 189         addPreview(latex_snippet, loader);
 190 }
 191
 192
 193 void RenderPreview::addPreview(docstring const & latex_snippet,
 194                                graphics::PreviewLoader & ploader)
 195 {
 196         if (status() == LyXRC::PREVIEW_OFF)
 197                 return;
 198
 199         // FIXME UNICODE
 200         // We have to make sure that we call latex with the right encoding
 201         snippet_ = support::trim(to_utf8(latex_snippet));
 202         if (snippet_.empty())
 203                 return;
 204
 205         if (ploader.preview(snippet_))
 206                 return;
 207
 208         // If this is the first time of calling, connect to the
 209         // PreviewLoader signal that'll inform us when the preview image
 210         // is ready for loading.
 211         if (!ploader_connection_.connected()) {
 212                 ploader_connection_ = ploader.connect(
 213                         boost::bind(&RenderPreview::imageReady, this, _1));
 214         }
 215
 216         ploader.add(snippet_);
 217 }
 218
 219
 220 void RenderPreview::removePreview(Buffer const & buffer)
 221 {
 222         if (snippet_.empty())
 223                 return;
 224
 225         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 226         loader.remove(snippet_);
 227         snippet_.erase();
 228 }
 229
 230
 231 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
 232 {
 233         // Check the current snippet is the same as that previewed.
 234         if (snippet_ == pimage.snippet())
 235                 LyX::cref().updateInset(parent_);
 236 }
 237
 238
 239 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
 240         : RenderPreview(inset),
 241           monitor_(std::string(), 2000)
 242 {}
 243
 244
 245 void RenderMonitoredPreview::setAbsFile(string const & file)
 246 {
 247         monitor_.reset(file);
 248 }
 249
 250
 251 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
 252 {
 253         RenderPreview::draw(pi, x, y);
 254         if (!monitoring())
 255                 startMonitoring();
 256 }
 257
 258
 259 boost::signals::connection
 260 RenderMonitoredPreview::fileChanged(slot_type const & slot)
 261 {
 262         return monitor_.connect(slot);
 263 }
 264
 265 } // namespace lyx