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