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/Inset.h"
  15
  16 #include "BufferView.h"
  17 #include "Dimension.h"
  18 #include "LyX.h"
  19 #include "LyXRC.h"
  20 #include "MetricsInfo.h"
  21
  22 #include "frontends/FontMetrics.h"
  23 #include "frontends/Painter.h"
  24
  25 #include "graphics/PreviewImage.h"
  26 #include "graphics/PreviewLoader.h"
  27 #include "graphics/Previews.h"
  28
  29 #include "support/FileName.h"
  30 #include "support/gettext.h"
  31 #include "support/lassert.h"
  32 #include "support/lstrings.h"
  33
  34 #include <boost/bind.hpp>
  35
  36 using namespace std;
  37 using namespace lyx::support;
  38
  39 namespace lyx {
  40
  41
  42 LyXRC_PreviewStatus RenderPreview::status()
  43 {
  44         return graphics::Previews::status();
  45 }
  46
  47
  48 RenderPreview::RenderPreview(Inset const * inset)
  49         : parent_(inset)
  50 {}
  51
  52
  53 RenderPreview::RenderPreview(RenderPreview const & other,
  54                              Inset const * inset)
  55         : RenderBase(other),
  56           boost::signals::trackable(),
  57           snippet_(other.snippet_),
  58           parent_(inset)
  59 {}
  60
  61
  62 RenderPreview::~RenderPreview()
  63 {
  64         if (ploader_connection_.connected())
  65                 ploader_connection_.disconnect();
  66 }
  67
  68
  69 RenderBase * RenderPreview::clone(Inset const * inset) const
  70 {
  71         return new RenderPreview(*this, inset);
  72 }
  73
  74
  75 namespace {
  76
  77 graphics::PreviewLoader & getPreviewLoader(Buffer const & buffer)
  78 {
  79         return thePreviews().loader(buffer);
  80 }
  81
  82
  83 docstring const statusMessage(BufferView const * bv, string const & snippet)
  84 {
  85         LASSERT(bv, /**/);
  86
  87         Buffer const & buffer = bv->buffer();
  88         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
  89         graphics::PreviewLoader::Status const status = loader.status(snippet);
  90
  91         docstring message;
  92         switch (status) {
  93         case graphics::PreviewLoader::InQueue:
  94         case graphics::PreviewLoader::Processing:
  95                 message = _("Preview loading");
  96                 break;
  97         case graphics::PreviewLoader::Ready:
  98                 message = _("Preview ready");
  99                 break;
 100         case graphics::PreviewLoader::NotFound:
 101                 message = _("Preview failed");
 102                 break;
 103         }
 104
 105         return message;
 106 }
 107
 108 } // namespace anon
 109
 110
 111 graphics::PreviewImage const *
 112 RenderPreview::getPreviewImage(Buffer const & buffer) const
 113 {
 114         graphics::PreviewLoader const & loader = getPreviewLoader(buffer);
 115         return loader.preview(snippet_);
 116 }
 117
 118
 119 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
 120 {
 121         LASSERT(mi.base.bv, /**/);
 122
 123         graphics::PreviewImage const * const pimage =
 124                 getPreviewImage(mi.base.bv->buffer());
 125
 126         if (pimage) {
 127                 dim = pimage->dim();
 128         } else {
 129                 dim.asc = 50;
 130                 dim.des = 0;
 131
 132                 FontInfo font(mi.base.font);
 133                 font.setFamily(SANS_FAMILY);
 134                 font.setSize(FONT_SIZE_FOOTNOTE);
 135                 docstring const stat = statusMessage(mi.base.bv, snippet_);
 136                 dim.wid = 15 + theFontMetrics(font).width(stat);
 137         }
 138
 139         dim_ = dim;
 140 }
 141
 142
 143 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
 144 {
 145         LASSERT(pi.base.bv, /**/);
 146
 147         graphics::PreviewImage const * const pimage =
 148                 getPreviewImage(pi.base.bv->buffer());
 149         graphics::Image const * const image = pimage ? pimage->image() : 0;
 150
 151         if (image) {
 152                 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
 153                               *image);
 154
 155         } else {
 156                 int const offset = Inset::TEXT_TO_INSET_OFFSET;
 157
 158                 pi.pain.rectangle(x + offset,
 159                                   y - dim_.asc,
 160                                   dim_.wid - 2 * offset,
 161                                   dim_.asc + dim_.des,
 162                                   Color_foreground);
 163
 164                 FontInfo font(pi.base.font);
 165                 font.setFamily(SANS_FAMILY);
 166                 font.setSize(FONT_SIZE_FOOTNOTE);
 167
 168                 docstring const stat = statusMessage(pi.base.bv, snippet_);
 169                 pi.pain.text(x + offset + 6,
 170                              y - theFontMetrics(font).maxAscent() - 4,
 171                              stat, 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(docstring 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(docstring const & latex_snippet,
 198                                graphics::PreviewLoader & ploader)
 199 {
 200         if (status() == LyXRC::PREVIEW_OFF)
 201                 return;
 202
 203         // FIXME UNICODE
 204         // We have to make sure that we call latex with the right encoding
 205         snippet_ = support::trim(to_utf8(latex_snippet));
 206         if (snippet_.empty())
 207                 return;
 208
 209         if (ploader.preview(snippet_))
 210                 return;
 211
 212         // If this is the first time of calling, connect to the
 213         // PreviewLoader signal that'll inform us when the preview image
 214         // is ready for loading.
 215         if (!ploader_connection_.connected()) {
 216                 ploader_connection_ = ploader.connect(
 217                         boost::bind(&RenderPreview::imageReady, this, _1));
 218         }
 219
 220         ploader.add(snippet_);
 221 }
 222
 223
 224 void RenderPreview::removePreview(Buffer const & buffer)
 225 {
 226         if (snippet_.empty())
 227                 return;
 228
 229         graphics::PreviewLoader & loader = getPreviewLoader(buffer);
 230         loader.remove(snippet_);
 231         snippet_.erase();
 232 }
 233
 234
 235 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
 236 {
 237         // Check the current snippet is the same as that previewed.
 238         if (snippet_ == pimage.snippet())
 239                 parent_->updateFrontend();
 240 }
 241
 242
 243 RenderMonitoredPreview::RenderMonitoredPreview(Inset const * inset)
 244         : RenderPreview(inset), 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