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 "LyX.h"
  19 #include "LyXRC.h"
  20 #include "MetricsInfo.h"
  21
  22 #include "frontends/FontMetrics.h"
  23 #include "frontends/Painter.h"
  24
  25 #include "graphics/PreviewImage.h"
  26 #include "graphics/PreviewLoader.h"
  27 #include "graphics/Previews.h"
  28
  29 #include "support/FileName.h"
  30 #include "support/gettext.h"
  31 #include "support/lassert.h"
  32 #include "support/lstrings.h"
  33
  34 #include "support/bind.h"
  35
  36 using namespace std;
  37 using namespace lyx::support;
  38
  39 namespace lyx {
  40
  41
  42 LyXRC_PreviewStatus RenderPreview::status()
  43 {
  44         return graphics::Previews::status();
  45 }
  46
  47
  48 RenderPreview::RenderPreview(Inset const * inset)
  49         : parent_(inset)
  50 {}
  51
  52
  53 RenderPreview::RenderPreview(RenderPreview const & other,
  54                              Inset const * inset)
  55         : RenderBase(other),
  56           boost::signals::trackable(),
  57           snippet_(other.snippet_),
  58           parent_(inset)
  59 {}
  60
  61
  62 RenderPreview::~RenderPreview()
  63 {
  64         if (ploader_connection_.connected())
  65                 ploader_connection_.disconnect();
  66 }
  67
  68
  69 RenderBase * RenderPreview::clone(Inset const * inset) const
  70 {
  71         return new RenderPreview(*this, inset);
  72 }
  73
  74
  75 namespace {
  76
  77 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
  78 {
  79         return thePreviews().loader(buffer);
  80 }
  81
  82
  83 docstring const statusMessage(BufferView const * bv, string const & snippet)
  84 {
  85         LASSERT(bv, /**/);
  86
  87         Buffer const & buffer = bv->buffer();
  88         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
  89         graphics::PreviewLoader::Status const status = loader.status(snippet);
  90
  91         docstring message;
  92         switch (status) {
  93         case graphics::PreviewLoader::InQueue:
  94         case graphics::PreviewLoader::Processing:
  95                 message = _("Preview loading");
  96                 break;
  97         case graphics::PreviewLoader::Ready:
  98                 message = _("Preview ready");
  99                 break;
 100         case graphics::PreviewLoader::NotFound:
 101                 message = _("Preview failed");
 102                 break;
 103         }
 104
 105         return message;
 106 }
 107
 108 } // namespace anon
 109
 110
 111 graphics::PreviewImage const *
 112 RenderPreview::getPreviewImage(Buffer const & buffer) const
 113 {
 114         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 115         return loader.preview(snippet_);
 116 }
 117
 118
 119 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
 120 {
 121         LASSERT(mi.base.bv, /**/);
 122
 123         graphics::PreviewImage const * const pimage =
 124                 getPreviewImage(mi.base.bv->buffer());
 125
 126         if (pimage) {
 127                 // If prepared, load the picture before dim calculation. See bug #5627.
 128                 pimage->image();
 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         LASSERT(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, bool wait) const
 179 {
 180         if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
 181                 return;
 182
 183         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 184         loader.startLoading(wait);
 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                         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