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 "support/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 = pimage->dim();
 130         } else {
 131                 dim.asc = 50;
 132                 dim.des = 0;
 133
 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);
 139         }
 140
 141         dim_ = dim;
 142 }
 143
 144
 145 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 146 {
 147         BOOST_ASSERT(pi.base.bv);
 148
 149         graphics::PreviewImage const * const pimage =
 150                 getPreviewImage(pi.base.bv->buffer());
 151         graphics::Image const * const image = pimage ? pimage->image() : 0;
 152
 153         if (image) {
 154                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 155                               *image);
 156
 157         } else {
 158                 int const offset = Inset::TEXT_TO_INSET_OFFSET;
 159
 160                 pi.pain.rectangle(x + offset,
 161                                   y - dim_.asc,
 162                                   dim_.wid - 2 * offset,
 163                                   dim_.asc + dim_.des,
 164                                   Color_foreground);
 165
 166                 FontInfo font(pi.base.font);
 167                 font.setFamily(SANS_FAMILY);
 168                 font.setSize(FONT_SIZE_FOOTNOTE);
 169
 170                 docstring const stat = statusMessage(pi.base.bv, snippet_);
 171                 pi.pain.text(x + offset + 6,
 172                              y - theFontMetrics(font).maxAscent() - 4,
 173                              stat, font);
 174         }
 175 }
 176
 177
 178 void RenderPreview::startLoading(Buffer const & buffer) const
 179 {
 180         if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
 181                 return;
 182
 183         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 184         loader.startLoading();
 185 }
 186
 187
 188 void RenderPreview::addPreview(docstring const & latex_snippet,
 189                                Buffer const & buffer)
 190 {
 191         if (status() == LyXRC::PREVIEW_OFF)
 192                 return;
 193
 194         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 195         addPreview(latex_snippet, loader);
 196 }
 197
 198
 199 void RenderPreview::addPreview(docstring const & latex_snippet,
 200                                graphics::PreviewLoader & ploader)
 201 {
 202         if (status() == LyXRC::PREVIEW_OFF)
 203                 return;
 204
 205         // FIXME UNICODE
 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())
 209                 return;
 210
 211         if (ploader.preview(snippet_))
 212                 return;
 213
 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                         boost::bind(&RenderPreview::imageReady, this, _1));
 220         }
 221
 222         ploader.add(snippet_);
 223 }
 224
 225
 226 void RenderPreview::removePreview(Buffer const & buffer)
 227 {
 228         if (snippet_.empty())
 229                 return;
 230
 231         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 232         loader.remove(snippet_);
 233         snippet_.erase();
 234 }
 235
 236
 237 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
 238 {
 239         // Check the current snippet is the same as that previewed.
 240         if (snippet_ == pimage.snippet())
 241                 parent_->updateFrontend();
 242 }
 243
 244
 245 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
 246         : RenderPreview(inset), monitor_(FileName(), 2000)
 247 {}
 248
 249
 250 void RenderMonitoredPreview::setAbsFile(FileName const & file)
 251 {
 252         monitor_.reset(file);
 253 }
 254
 255
 256 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
 257 {
 258         RenderPreview::draw(pi, x, y);
 259         if (!monitoring())
 260                 startMonitoring();
 261 }
 262
 263
 264 boost::signals::connection
 265 RenderMonitoredPreview::fileChanged(slot_type const & slot)
 266 {
 267         return monitor_.connect(slot);
 268 }
 269
 270 } // namespace lyx