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 LyXRC_PreviewStatus RenderPreview::status()
  43 {
  44         return lyxrc.preview;
  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 docstring const statusMessage(BufferView const * bv, string const & snippet)
  78 {
  79         LASSERT(bv, /**/);
  80
  81         Buffer const & buffer = bv->buffer();
  82         graphics::PreviewLoader const * loader = buffer.loader();
  83         graphics::PreviewLoader::Status const status = loader->status(snippet);
  84
  85         docstring message;
  86         switch (status) {
  87         case graphics::PreviewLoader::InQueue:
  88         case graphics::PreviewLoader::Processing:
  89                 message = _("Preview loading");
  90                 break;
  91         case graphics::PreviewLoader::Ready:
  92                 message = _("Preview ready");
  93                 break;
  94         case graphics::PreviewLoader::NotFound:
  95                 message = _("Preview failed");
  96                 break;
  97         }
  98
  99         return message;
 100 }
 101
 102 } // namespace anon
 103
 104
 105 graphics::PreviewImage const *
 106 RenderPreview::getPreviewImage(Buffer const & buffer) const
 107 {
 108         graphics::PreviewLoader const * loader = buffer.loader();
 109         LASSERT(loader, return 0);
 110         return loader->preview(snippet_);
 111 }
 112
 113
 114 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
 115 {
 116         LASSERT(mi.base.bv, /**/);
 117
 118         graphics::PreviewImage const * const pimage =
 119                 getPreviewImage(mi.base.bv->buffer());
 120
 121         if (pimage) {
 122                 // If prepared, load the picture before dim calculation. See bug #5627.
 123                 pimage->image();
 124                 dim = pimage->dim();
 125         } else {
 126                 dim.asc = 50;
 127                 dim.des = 0;
 128
 129                 FontInfo font(mi.base.font);
 130                 font.setFamily(SANS_FAMILY);
 131                 font.setSize(FONT_SIZE_FOOTNOTE);
 132                 docstring const stat = statusMessage(mi.base.bv, snippet_);
 133                 dim.wid = 15 + theFontMetrics(font).width(stat);
 134         }
 135
 136         dim_ = dim;
 137 }
 138
 139
 140 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 141 {
 142         LASSERT(pi.base.bv, /**/);
 143
 144         graphics::PreviewImage const * const pimage =
 145                 getPreviewImage(pi.base.bv->buffer());
 146         graphics::Image const * const image = pimage ? pimage->image() : 0;
 147
 148         if (image) {
 149                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 150                               *image);
 151
 152         } else {
 153                 int const offset = Inset::TEXT_TO_INSET_OFFSET;
 154
 155                 pi.pain.rectangle(x + offset,
 156                                   y - dim_.asc,
 157                                   dim_.wid - 2 * offset,
 158                                   dim_.asc + dim_.des,
 159                                   Color_foreground);
 160
 161                 FontInfo font(pi.base.font);
 162                 font.setFamily(SANS_FAMILY);
 163                 font.setSize(FONT_SIZE_FOOTNOTE);
 164
 165                 docstring const stat = statusMessage(pi.base.bv, snippet_);
 166                 pi.pain.text(x + offset + 6,
 167                              y - theFontMetrics(font).maxAscent() - 4,
 168                              stat, font);
 169         }
 170 }
 171
 172
 173 void RenderPreview::startLoading(Buffer const & buffer, bool forexport) const
 174 {
 175         if (!forexport && (status() == LyXRC::PREVIEW_OFF || snippet_.empty()))
 176                 return;
 177
 178         graphics::PreviewLoader * loader = buffer.loader();
 179         LASSERT(loader, return);
 180         loader->startLoading(forexport);
 181 }
 182
 183
 184 void RenderPreview::addPreview(docstring const & latex_snippet,
 185                                Buffer const & buffer,
 186                                bool ignore_lyxrc)
 187 {
 188         if (status() == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
 189                 return;
 190
 191         graphics::PreviewLoader * loader = buffer.loader();
 192         LASSERT(loader, return);
 193         addPreview(latex_snippet, *loader, ignore_lyxrc);
 194 }
 195
 196
 197 void RenderPreview::addPreview(docstring const & latex_snippet,
 198                                graphics::PreviewLoader & ploader,
 199                                bool ignore_lyxrc)
 200 {
 201         if (status() == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
 202                 return;
 203
 204         // FIXME UNICODE
 205         // We have to make sure that we call latex with the right encoding
 206         snippet_ = support::trim(to_utf8(latex_snippet));
 207         if (snippet_.empty())
 208                 return;
 209
 210         if (ploader.preview(snippet_))
 211                 return;
 212
 213         // If this is the first time of calling, connect to the
 214         // PreviewLoader signal that'll inform us when the preview image
 215         // is ready for loading.
 216         if (!ploader_connection_.connected()) {
 217                 ploader_connection_ = ploader.connect(
 218                         bind(&RenderPreview::imageReady, this, _1));
 219         }
 220
 221         ploader.add(snippet_);
 222 }
 223
 224
 225 void RenderPreview::removePreview(Buffer const & buffer)
 226 {
 227         if (snippet_.empty())
 228                 return;
 229
 230         graphics::PreviewLoader * loader = buffer.loader();
 231         LASSERT(loader, return);
 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