src/insets/render_preview.C

   1 /**
   2  * \file render_preview.C
   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/render_preview.h"
  14 #include "insets/inset.h"
  15
  16 #include "BufferView.h"
  17 #include "debug.h"
  18 #include "dimension.h"
  19 #include "gettext.h"
  20 #include "LColor.h"
  21 #include "lyx_main.h"
  22 #include "lyxrc.h"
  23 #include "metricsinfo.h"
  24
  25 #include "frontends/font_metrics.h"
  26 #include "frontends/Painter.h"
  27
  28 #include "graphics/PreviewImage.h"
  29 #include "graphics/PreviewLoader.h"
  30 #include "graphics/Previews.h"
  31
  32 #include "support/lstrings.h"
  33
  34 #include <boost/bind.hpp>
  35
  36 using std::string;
  37 using std::auto_ptr;
  38
  39 namespace graphics = lyx::graphics;
  40 namespace support  = lyx::support;
  41
  42
  43 LyXRC_PreviewStatus RenderPreview::status()
  44 {
  45         return graphics::Previews::status();
  46 }
  47
  48
  49 RenderPreview::RenderPreview(InsetBase const * inset)
  50         : parent_(inset)
  51 {}
  52
  53
  54 RenderPreview::RenderPreview(RenderPreview const & other,
  55                              InsetBase const * inset)
  56         : RenderBase(other),
  57           boost::signals::trackable(),
  58           snippet_(other.snippet_),
  59           parent_(inset)
  60 {}
  61
  62
  63 auto_ptr<RenderBase> RenderPreview::clone(InsetBase const * inset) const
  64 {
  65         return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
  66 }
  67
  68
  69 namespace {
  70
  71 string const statusMessage(BufferView const * bv, string const & snippet)
  72 {
  73         BOOST_ASSERT(bv && bv->buffer());
  74
  75         Buffer const & buffer = *bv->buffer();
  76         graphics::Previews const & previews = graphics::Previews::get();
  77         graphics::PreviewLoader const & loader = previews.loader(buffer);
  78         graphics::PreviewLoader::Status const status = loader.status(snippet);
  79
  80         string message;
  81         switch (status) {
  82         case graphics::PreviewLoader::InQueue:
  83         case graphics::PreviewLoader::Processing:
  84                 message = _("Preview loading");
  85                 break;
  86         case graphics::PreviewLoader::Ready:
  87                 message = _("Preview ready");
  88                 break;
  89         case graphics::PreviewLoader::NotFound:
  90                 message = _("Preview failed");
  91                 break;
  92         }
  93
  94         return message;
  95 }
  96
  97 } // namespace anon
  98
  99
 100 graphics::PreviewImage const *
 101 RenderPreview::getPreviewImage(Buffer const & buffer) const
 102 {
 103         graphics::Previews & previews = graphics::Previews::get();
 104         graphics::PreviewLoader & loader = previews.loader(buffer);
 105         return loader.preview(snippet_);
 106 }
 107
 108
 109 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
 110 {
 111         BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
 112
 113         graphics::PreviewImage const * const pimage =
 114                 getPreviewImage(*mi.base.bv->buffer());
 115
 116         if (pimage) {
 117                 dim.asc = pimage->ascent();
 118                 dim.des = pimage->descent();
 119                 dim.wid = pimage->width();
 120         } else {
 121                 dim.asc = 50;
 122                 dim.des = 0;
 123
 124                 LyXFont font(mi.base.font);
 125                 font.setFamily(LyXFont::SANS_FAMILY);
 126                 font.setSize(LyXFont::SIZE_FOOTNOTE);
 127                 dim.wid = 15 +
 128                         font_metrics::width(statusMessage(mi.base.bv, snippet_),
 129                                             font);
 130         }
 131
 132         dim_ = dim;
 133 }
 134
 135
 136 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 137 {
 138         BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
 139
 140         graphics::PreviewImage const * const pimage =
 141                 getPreviewImage(*pi.base.bv->buffer());
 142
 143         if (pimage && pimage->image()) {
 144                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 145                               *(pimage->image()));
 146                 return;
 147         }
 148
 149         pi.pain.rectangle(x + InsetOld::TEXT_TO_INSET_OFFSET,
 150                           y - dim_.asc,
 151                           dim_.wid - 2 * InsetOld::TEXT_TO_INSET_OFFSET,
 152                           dim_.asc + dim_.des,
 153                           LColor::foreground);
 154
 155         LyXFont font(pi.base.font);
 156         font.setFamily(LyXFont::SANS_FAMILY);
 157         font.setSize(LyXFont::SIZE_FOOTNOTE);
 158         pi.pain.text(x + InsetOld::TEXT_TO_INSET_OFFSET + 6,
 159                      y - font_metrics::maxAscent(font) - 4,
 160                      statusMessage(pi.base.bv, snippet_), font);
 161 }
 162
 163
 164 void RenderPreview::startLoading(Buffer const & buffer) const
 165 {
 166         if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
 167                 return;
 168
 169         graphics::Previews & previews = graphics::Previews::get();
 170         graphics::PreviewLoader & loader = previews.loader(buffer);
 171         loader.startLoading();
 172         lyxerr << "RenderPreview::startLoading: " << snippet_ << std::endl;
 173 }
 174
 175
 176 void RenderPreview::addPreview(string const & latex_snippet,
 177                                Buffer const & buffer)
 178 {
 179         if (status() == LyXRC::PREVIEW_OFF)
 180                 return;
 181
 182         graphics::Previews & previews = graphics::Previews::get();
 183         graphics::PreviewLoader & loader = previews.loader(buffer);
 184         addPreview(latex_snippet, loader);
 185 }
 186
 187
 188 void RenderPreview::addPreview(string const & latex_snippet,
 189                                graphics::PreviewLoader & ploader)
 190 {
 191         if (status() == LyXRC::PREVIEW_OFF)
 192                 return;
 193
 194         snippet_ = support::trim(latex_snippet);
 195         if (snippet_.empty())
 196                 return;
 197
 198         if (ploader.preview(snippet_))
 199                 return;
 200
 201         // If this is the first time of calling, connect to the
 202         // PreviewLoader signal that'll inform us when the preview image
 203         // is ready for loading.
 204         if (!ploader_connection_.connected()) {
 205                 ploader_connection_ = ploader.connect(
 206                         boost::bind(&RenderPreview::imageReady, this, _1));
 207         }
 208
 209         ploader.add(snippet_);
 210 }
 211
 212
 213 void RenderPreview::removePreview(Buffer const & buffer)
 214 {
 215         if (snippet_.empty())
 216                 return;
 217
 218         graphics::Previews & previews = graphics::Previews::get();
 219         graphics::PreviewLoader & loader = previews.loader(buffer);
 220         loader.remove(snippet_);
 221         snippet_.erase();
 222 }
 223
 224
 225 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
 226 {
 227         // Check the current snippet is the same as that previewed.
 228         if (snippet_ == pimage.snippet())
 229                 LyX::cref().updateInset(parent_);
 230 }
 231
 232
 233 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
 234         : RenderPreview(inset),
 235           monitor_(std::string(), 2000)
 236 {}
 237
 238
 239 void RenderMonitoredPreview::setAbsFile(string const & file)
 240 {
 241         monitor_.reset(file);
 242 }
 243
 244
 245 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
 246 {
 247         RenderPreview::draw(pi, x, y);
 248         if (!monitoring())
 249                 startMonitoring();
 250 }
 251
 252
 253 boost::signals::connection
 254 RenderMonitoredPreview::fileChanged(slot_type const & slot)
 255 {
 256         return monitor_.connect(slot);
 257 }