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::signals::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         graphics::PreviewLoader::Status const status = loader->status(snippet);
 108
 109         docstring message;
 110         switch (status) {
 111         case graphics::PreviewLoader::InQueue:
 112         case graphics::PreviewLoader::Processing:
 113                 message = _("Preview loading");
 114                 break;
 115         case graphics::PreviewLoader::Ready:
 116                 message = _("Preview ready");
 117                 break;
 118         case graphics::PreviewLoader::NotFound:
 119                 message = _("Preview failed");
 120                 break;
 121         }
 122
 123         return message;
 124 }
 125
 126 } // namespace anon
 127
 128
 129 graphics::PreviewImage const *
 130 RenderPreview::getPreviewImage(Buffer const & buffer) const
 131 {
 132         graphics::PreviewLoader const * loader = buffer.loader();
 133         LASSERT(loader, return 0);
 134         return loader->preview(snippet_);
 135 }
 136
 137
 138 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
 139 {
 140         LBUFERR(mi.base.bv);
 141
 142         graphics::PreviewImage const * const pimage =
 143                 getPreviewImage(mi.base.bv->buffer());
 144
 145         if (pimage) {
 146                 // If prepared, load the picture before dim calculation. See bug #5627.
 147                 pimage->image();
 148                 dim = pimage->dim();
 149         } else {
 150                 dim.asc = 50;
 151                 dim.des = 0;
 152
 153                 FontInfo font(mi.base.font);
 154                 font.setFamily(SANS_FAMILY);
 155                 font.setSize(FONT_SIZE_FOOTNOTE);
 156                 docstring const stat = statusMessage(mi.base.bv, snippet_);
 157                 dim.wid = 15 + theFontMetrics(font).width(stat);
 158         }
 159
 160         dim_ = dim;
 161 }
 162
 163
 164 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 165 {
 166         LBUFERR(pi.base.bv);
 167
 168         graphics::PreviewImage const * const pimage =
 169                 getPreviewImage(pi.base.bv->buffer());
 170         graphics::Image const * const image = pimage ? pimage->image() : 0;
 171
 172         if (image) {
 173                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 174                               *image);
 175         } else {
 176                 int const offset = Inset::TEXT_TO_INSET_OFFSET;
 177
 178                 pi.pain.rectangle(x + offset,
 179                                   y - dim_.asc,
 180                                   dim_.wid - 2 * offset,
 181                                   dim_.asc + dim_.des,
 182                                   Color_foreground);
 183
 184                 FontInfo font(pi.base.font);
 185                 font.setFamily(SANS_FAMILY);
 186                 font.setSize(FONT_SIZE_FOOTNOTE);
 187
 188                 docstring const stat = statusMessage(pi.base.bv, snippet_);
 189                 pi.pain.text(x + offset + 6,
 190                              y - theFontMetrics(font).maxAscent() - 4,
 191                              stat, font);
 192         }
 193 }
 194
 195
 196 void RenderPreview::startLoading(Buffer const & buffer, bool forexport) const
 197 {
 198         if (!forexport && (lyxrc.preview == LyXRC::PREVIEW_OFF || snippet_.empty()))
 199                 return;
 200
 201         graphics::PreviewLoader * loader = buffer.loader();
 202         LASSERT(loader, return);
 203         loader->startLoading(forexport);
 204 }
 205
 206
 207 void RenderPreview::addPreview(docstring const & latex_snippet,
 208                                Buffer const & buffer,
 209                                bool ignore_lyxrc)
 210 {
 211         if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
 212                 return;
 213
 214         graphics::PreviewLoader * loader = buffer.loader();
 215         LASSERT(loader, return);
 216         addPreview(latex_snippet, *loader, ignore_lyxrc);
 217 }
 218
 219
 220 void RenderPreview::addPreview(docstring const & latex_snippet,
 221                                graphics::PreviewLoader & ploader,
 222                                bool ignore_lyxrc)
 223 {
 224         if (lyxrc.preview == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
 225                 return;
 226
 227         // FIXME UNICODE
 228         // We have to make sure that we call latex with the right encoding
 229         snippet_ = support::trim(to_utf8(latex_snippet));
 230         if (snippet_.empty())
 231                 return;
 232
 233         if (ploader.preview(snippet_))
 234                 return;
 235
 236         // If this is the first time of calling, connect to the
 237         // PreviewLoader signal that'll inform us when the preview image
 238         // is ready for loading.
 239         if (!ploader_connection_.connected()) {
 240                 ploader_connection_ = ploader.connect(
 241                         bind(&RenderPreview::imageReady, this, _1));
 242         }
 243
 244         ploader.add(snippet_);
 245 }
 246
 247
 248 void RenderPreview::removePreview(Buffer const & buffer)
 249 {
 250         if (snippet_.empty())
 251                 return;
 252
 253         graphics::PreviewLoader * loader = buffer.loader();
 254         LASSERT(loader, return);
 255         loader->remove(snippet_);
 256         snippet_.erase();
 257 }
 258
 259
 260 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
 261 {
 262         // Check the current snippet is the same as that previewed.
 263         if (snippet_ == pimage.snippet())
 264                 parent_->updateFrontend();
 265 }
 266
 267
 268 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
 269         : RenderPreview(inset), monitor_(FileName(), 2000)
 270 {}
 271
 272
 273 void RenderMonitoredPreview::setAbsFile(FileName const & file)
 274 {
 275         monitor_.reset(file);
 276 }
 277
 278
 279 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
 280 {
 281         RenderPreview::draw(pi, x, y);
 282         if (!monitoring())
 283                 startMonitoring();
 284 }
 285
 286
 287 boost::signals::connection
 288 RenderMonitoredPreview::fileChanged(slot_type const & slot)
 289 {
 290         return monitor_.connect(slot);
 291 }
 292
 293 } // namespace lyx