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/Application.h"
  25 #include "frontends/FontLoader.h"
  26 #include "frontends/FontMetrics.h"
  27 #include "frontends/Painter.h"
  28
  29 #include "graphics/PreviewImage.h"
  30 #include "graphics/PreviewLoader.h"
  31 #include "graphics/Previews.h"
  32
  33 #include "support/lstrings.h"
  34
  35 #include <boost/bind.hpp>
  36
  37 using lyx::docstring;
  38
  39 using std::string;
  40 using std::auto_ptr;
  41
  42 namespace graphics = lyx::graphics;
  43 namespace support  = lyx::support;
  44
  45
  46 LyXRC_PreviewStatus RenderPreview::status()
  47 {
  48         return graphics::Previews::status();
  49 }
  50
  51
  52 RenderPreview::RenderPreview(InsetBase const * inset)
  53         : parent_(inset)
  54 {}
  55
  56
  57 RenderPreview::RenderPreview(RenderPreview const & other,
  58                              InsetBase const * inset)
  59         : RenderBase(other),
  60           boost::signals::trackable(),
  61           snippet_(other.snippet_),
  62           parent_(inset)
  63 {}
  64
  65
  66 auto_ptr<RenderBase> RenderPreview::clone(InsetBase const * inset) const
  67 {
  68         return auto_ptr<RenderBase>(new RenderPreview(*this, inset));
  69 }
  70
  71
  72 namespace {
  73
  74 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
  75 {
  76         graphics::Previews const & previews = graphics::Previews::get();
  77         return previews.loader(buffer);
  78 }
  79
  80
  81 string const statusMessage(BufferView const * bv, string const & snippet)
  82 {
  83         BOOST_ASSERT(bv && bv->buffer());
  84
  85         Buffer const & buffer = *bv->buffer();
  86         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
  87         graphics::PreviewLoader::Status const status = loader.status(snippet);
  88
  89         docstring message;
  90         switch (status) {
  91         case graphics::PreviewLoader::InQueue:
  92         case graphics::PreviewLoader::Processing:
  93                 message = _("Preview loading");
  94                 break;
  95         case graphics::PreviewLoader::Ready:
  96                 message = _("Preview ready");
  97                 break;
  98         case graphics::PreviewLoader::NotFound:
  99                 message = _("Preview failed");
 100                 break;
 101         }
 102
 103         // FIXME UNICODE
 104         return lyx::to_utf8(message);
 105 }
 106
 107 } // namespace anon
 108
 109
 110 graphics::PreviewImage const *
 111 RenderPreview::getPreviewImage(Buffer const & buffer) const
 112 {
 113         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 114         return loader.preview(snippet_);
 115 }
 116
 117
 118 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
 119 {
 120         BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
 121
 122         graphics::PreviewImage const * const pimage =
 123                 getPreviewImage(*mi.base.bv->buffer());
 124
 125         if (pimage) {
 126                 dim.asc = pimage->ascent();
 127                 dim.des = pimage->descent();
 128                 dim.wid = pimage->width();
 129         } else {
 130                 dim.asc = 50;
 131                 dim.des = 0;
 132
 133                 LyXFont font(mi.base.font);
 134                 font.setFamily(LyXFont::SANS_FAMILY);
 135                 font.setSize(LyXFont::SIZE_FOOTNOTE);
 136                 string stat = statusMessage(mi.base.bv, snippet_);
 137                 docstring dstat(stat.begin(), stat.end());
 138                 dim.wid = 15 + theApp->fontLoader().metrics(font).width(dstat);
 139         }
 140
 141         dim_ = dim;
 142 }
 143
 144
 145 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 146 {
 147         BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
 148
 149         graphics::PreviewImage const * const pimage =
 150                 getPreviewImage(*pi.base.bv->buffer());
 151         graphics::Image const * const image = pimage ? pimage->image() : 0;
 152
 153         if (image) {
 154                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 155                               *image);
 156
 157         } else {
 158                 int const offset = InsetOld::TEXT_TO_INSET_OFFSET;
 159
 160                 pi.pain.rectangle(x + offset,
 161                                   y - dim_.asc,
 162                                   dim_.wid - 2 * offset,
 163                                   dim_.asc + dim_.des,
 164                                   LColor::foreground);
 165
 166                 LyXFont font(pi.base.font);
 167                 font.setFamily(LyXFont::SANS_FAMILY);
 168                 font.setSize(LyXFont::SIZE_FOOTNOTE);
 169
 170                 string stat = statusMessage(pi.base.bv, snippet_);
 171                 docstring dstat(stat.begin(), stat.end());
 172                 pi.pain.text(x + offset + 6,
 173                              y - theApp->fontLoader().metrics(font).maxAscent() - 4,
 174                              dstat, font);
 175         }
 176 }
 177
 178
 179 void RenderPreview::startLoading(Buffer const & buffer) const
 180 {
 181         if (status() == LyXRC::PREVIEW_OFF || snippet_.empty())
 182                 return;
 183
 184         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 185         loader.startLoading();
 186 }
 187
 188
 189 void RenderPreview::addPreview(string const & latex_snippet,
 190                                Buffer const & buffer)
 191 {
 192         if (status() == LyXRC::PREVIEW_OFF)
 193                 return;
 194
 195         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 196         addPreview(latex_snippet, loader);
 197 }
 198
 199
 200 void RenderPreview::addPreview(string const & latex_snippet,
 201                                graphics::PreviewLoader & ploader)
 202 {
 203         if (status() == LyXRC::PREVIEW_OFF)
 204                 return;
 205
 206         snippet_ = support::trim(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_(std::string(), 2000)
 247 {}
 248
 249
 250 void RenderMonitoredPreview::setAbsFile(string 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 }