src/insets/RenderPreview.cpp

   1 /**
   2  * \file RenderPreview.cpp
   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/RenderPreview.h"
  14 #include "insets/InsetBase.h"
  15
  16 #include "BufferView.h"
  17 #include "Color.h"
  18 #include "Dimension.h"
  19 #include "gettext.h"
  20 #include "LyX.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 bool 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         bool const changed = dim_ != dim;
 139         dim_ = dim;
 140         return changed;
 141 }
 142
 143
 144 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 145 {
 146         BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
 147
 148         graphics::PreviewImage const * const pimage =
 149                 getPreviewImage(*pi.base.bv->buffer());
 150         graphics::Image const * const image = pimage ? pimage->image() : 0;
 151
 152         if (image) {
 153                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 154                               *image);
 155
 156         } else {
 157                 int const offset = InsetBase::TEXT_TO_INSET_OFFSET;
 158
 159                 pi.pain.rectangle(x + offset,
 160                                   y - dim_.asc,
 161                                   dim_.wid - 2 * offset,
 162                                   dim_.asc + dim_.des,
 163                                   Color::foreground);
 164
 165                 LyXFont font(pi.base.font);
 166                 font.setFamily(LyXFont::SANS_FAMILY);
 167                 font.setSize(LyXFont::SIZE_FOOTNOTE);
 168
 169                 docstring const stat = statusMessage(pi.base.bv, snippet_);
 170                 pi.pain.text(x + offset + 6,
 171                              y - theFontMetrics(font).maxAscent() - 4,
 172                              stat, font);
 173         }
 174 }
 175
 176
 177 void RenderPreview::startLoading(Buffer const & buffer) const
 178 {
 179         if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
 180                 return;
 181
 182         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 183         loader.startLoading();
 184 }
 185
 186
 187 void RenderPreview::addPreview(docstring const & latex_snippet,
 188                                Buffer const & buffer)
 189 {
 190         if (status() == LyXRC::PREVIEW_OFF)
 191                 return;
 192
 193         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 194         addPreview(latex_snippet, loader);
 195 }
 196
 197
 198 void RenderPreview::addPreview(docstring const & latex_snippet,
 199                                graphics::PreviewLoader & ploader)
 200 {
 201         if (status() == LyXRC::PREVIEW_OFF)
 202                 return;
 203
 204         // FIXME UNICODE
 205         // We have to make sure that we call latex with the right encoding
 206         snippet_ = support::trim(to_utf8(latex_snippet));
 207         if (snippet_.empty())
 208                 return;
 209
 210         if (ploader.preview(snippet_))
 211                 return;
 212
 213         // If this is the first time of calling, connect to the
 214         // PreviewLoader signal that'll inform us when the preview image
 215         // is ready for loading.
 216         if (!ploader_connection_.connected()) {
 217                 ploader_connection_ = ploader.connect(
 218                         boost::bind(&RenderPreview::imageReady, this, _1));
 219         }
 220
 221         ploader.add(snippet_);
 222 }
 223
 224
 225 void RenderPreview::removePreview(Buffer const & buffer)
 226 {
 227         if (snippet_.empty())
 228                 return;
 229
 230         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 231         loader.remove(snippet_);
 232         snippet_.erase();
 233 }
 234
 235
 236 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
 237 {
 238         // Check the current snippet is the same as that previewed.
 239         if (snippet_ == pimage.snippet())
 240                 LyX::cref().updateInset(parent_);
 241 }
 242
 243
 244 RenderMonitoredPreview::RenderMonitoredPreview(InsetBase const * inset)
 245         : RenderPreview(inset),
 246           monitor_(FileName(), 2000)
 247 {}
 248
 249
 250 void RenderMonitoredPreview::setAbsFile(FileName const & file)
 251 {
 252         monitor_.reset(file);
 253 }
 254
 255
 256 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
 257 {
 258         RenderPreview::draw(pi, x, y);
 259         if (!monitoring())
 260                 startMonitoring();
 261 }
 262
 263
 264 boost::signals::connection
 265 RenderMonitoredPreview::fileChanged(slot_type const & slot)
 266 {
 267         return monitor_.connect(slot);
 268 }
 269
 270 } // namespace lyx