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