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