src/insets/RenderPreview.cpp

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