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