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