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