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