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, return docstring());
  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         LBUFERR(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         LBUFERR(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         } else {
 152                 int const offset = Inset::TEXT_TO_INSET_OFFSET;
 153
 154                 pi.pain.rectangle(x + offset,
 155                                   y - dim_.asc,
 156                                   dim_.wid - 2 * offset,
 157                                   dim_.asc + dim_.des,
 158                                   Color_foreground);
 159
 160                 FontInfo font(pi.base.font);
 161                 font.setFamily(SANS_FAMILY);
 162                 font.setSize(FONT_SIZE_FOOTNOTE);
 163
 164                 docstring const stat = statusMessage(pi.base.bv, snippet_);
 165                 pi.pain.text(x + offset + 6,
 166                              y - theFontMetrics(font).maxAscent() - 4,
 167                              stat, font);
 168         }
 169 }
 170
 171
 172 void RenderPreview::startLoading(Buffer const & buffer, bool forexport) const
 173 {
 174         if (!forexport && (status() == LyXRC::PREVIEW_OFF || snippet_.empty()))
 175                 return;
 176
 177         graphics::PreviewLoader * loader = buffer.loader();
 178         LASSERT(loader, return);
 179         loader->startLoading(forexport);
 180 }
 181
 182
 183 void RenderPreview::addPreview(docstring const & latex_snippet,
 184                                Buffer const & buffer,
 185                                bool ignore_lyxrc)
 186 {
 187         if (status() == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
 188                 return;
 189
 190         graphics::PreviewLoader * loader = buffer.loader();
 191         LASSERT(loader, return);
 192         addPreview(latex_snippet, *loader, ignore_lyxrc);
 193 }
 194
 195
 196 void RenderPreview::addPreview(docstring const & latex_snippet,
 197                                graphics::PreviewLoader & ploader,
 198                                bool ignore_lyxrc)
 199 {
 200         if (status() == LyXRC::PREVIEW_OFF && !ignore_lyxrc)
 201                 return;
 202
 203         // FIXME UNICODE
 204         // We have to make sure that we call latex with the right encoding
 205         snippet_ = support::trim(to_utf8(latex_snippet));
 206         if (snippet_.empty())
 207                 return;
 208
 209         if (ploader.preview(snippet_))
 210                 return;
 211
 212         // If this is the first time of calling, connect to the
 213         // PreviewLoader signal that'll inform us when the preview image
 214         // is ready for loading.
 215         if (!ploader_connection_.connected()) {
 216                 ploader_connection_ = ploader.connect(
 217                         bind(&RenderPreview::imageReady, this, _1));
 218         }
 219
 220         ploader.add(snippet_);
 221 }
 222
 223
 224 void RenderPreview::removePreview(Buffer const & buffer)
 225 {
 226         if (snippet_.empty())
 227                 return;
 228
 229         graphics::PreviewLoader * loader = buffer.loader();
 230         LASSERT(loader, return);
 231         loader->remove(snippet_);
 232         snippet_.erase();
 233 }
 234
 235
 236 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
 237 {
 238         // Check the current snippet is the same as that previewed.
 239         if (snippet_ == pimage.snippet())
 240                 parent_->updateFrontend();
 241 }
 242
 243
 244 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
 245         : RenderPreview(inset), monitor_(FileName(), 2000)
 246 {}
 247
 248
 249 void RenderMonitoredPreview::setAbsFile(FileName const & file)
 250 {
 251         monitor_.reset(file);
 252 }
 253
 254
 255 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
 256 {
 257         RenderPreview::draw(pi, x, y);
 258         if (!monitoring())
 259                 startMonitoring();
 260 }
 261
 262
 263 boost::signals::connection
 264 RenderMonitoredPreview::fileChanged(slot_type const & slot)
 265 {
 266         return monitor_.connect(slot);
 267 }
 268
 269 } // namespace lyx