src/insets/insetexternal.C

   1 /**
   2  * \file insetexternal.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup Nielsen
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "insetexternal.h"
  14 #include "insets/ExternalSupport.h"
  15 #include "insets/ExternalTemplate.h"
  16 #include "insets/render_button.h"
  17 #include "insets/render_graphic.h"
  18 #include "insets/render_preview.h"
  19
  20 #include "buffer.h"
  21 #include "BufferView.h"
  22 #include "debug.h"
  23 #include "dispatchresult.h"
  24 #include "funcrequest.h"
  25 #include "gettext.h"
  26 #include "LaTeXFeatures.h"
  27 #include "lyx_main.h"
  28 #include "lyxlex.h"
  29 #include "lyxrc.h"
  30 #include "metricsinfo.h"
  31 #include "outputparams.h"
  32
  33 #include "frontends/lyx_gui.h"
  34 #include "frontends/LyXView.h"
  35
  36 #include "graphics/PreviewLoader.h"
  37
  38 #include "support/FileInfo.h"
  39 #include "support/filetools.h"
  40 #include "support/lstrings.h"
  41 #include "support/lyxlib.h"
  42 #include "support/tostr.h"
  43 #include "support/translator.h"
  44
  45 #include <boost/bind.hpp>
  46
  47 #include "support/std_sstream.h"
  48
  49 namespace support = lyx::support;
  50 namespace external = lyx::external;
  51 namespace graphics = lyx::graphics;
  52
  53 using std::endl;
  54 using std::string;
  55 using std::auto_ptr;
  56 using std::istringstream;
  57 using std::ostream;
  58 using std::ostringstream;
  59 using std::vector;
  60
  61
  62 namespace {
  63
  64 external::DisplayType const defaultDisplayType = external::NoDisplay;
  65
  66 unsigned int const defaultLyxScale = 100;
  67
  68 string defaultTemplateName = "RasterImage";
  69
  70 } // namespace anon
  71
  72
  73 namespace lyx {
  74 namespace external {
  75
  76 TempName::TempName()
  77 {
  78         tempname_ = support::tempName(string(), "lyxext");
  79         support::unlink(tempname_);
  80         // must have an extension for the converter code to work correctly.
  81         tempname_ += ".tmp";
  82 }
  83
  84
  85 TempName::TempName(TempName const &)
  86 {
  87         tempname_ = TempName()();
  88 }
  89
  90
  91 TempName::~TempName()
  92 {
  93         support::unlink(tempname_);
  94 }
  95
  96
  97 TempName &
  98 TempName::operator=(TempName const & other)
  99 {
 100         if (this != &other)
 101                 tempname_ = TempName()();
 102         return *this;
 103 }
 104
 105
 106 namespace {
 107
 108 /// The translator between the Display enum and corresponding lyx string.
 109 Translator<DisplayType, string> const initTranslator()
 110 {
 111         Translator<DisplayType, string> translator(DefaultDisplay, "default");
 112
 113         // Fill the display translator
 114         translator.addPair(MonochromeDisplay, "monochrome");
 115         translator.addPair(GrayscaleDisplay, "grayscale");
 116         translator.addPair(ColorDisplay, "color");
 117         translator.addPair(PreviewDisplay, "preview");
 118         translator.addPair(NoDisplay, "none");
 119
 120         return translator;
 121 }
 122
 123 } // namespace anon
 124
 125
 126 Translator<DisplayType, string> const & displayTranslator()
 127 {
 128         static Translator<DisplayType, string> const translator =
 129                 initTranslator();
 130         return translator;
 131 }
 132
 133 } // namespace external
 134 } // namespace lyx
 135
 136
 137 InsetExternalParams::InsetExternalParams()
 138         : display(defaultDisplayType),
 139           lyxscale(defaultLyxScale),
 140           draft(false),
 141           templatename_(defaultTemplateName)
 142 {}
 143
 144
 145 namespace {
 146
 147 template <typename T>
 148 void clearIfNotFound(T & data, external::TransformID value,
 149                      vector<external::TransformID> const & ids)
 150 {
 151         typedef vector<external::TransformID>::const_iterator
 152                 const_iterator;
 153
 154         const_iterator it  = ids.begin();
 155         const_iterator end = ids.end();
 156         it = std::find(it, end, value);
 157         if (it == end)
 158                 data = T();
 159 }
 160
 161 } // namespace anon
 162
 163
 164 void InsetExternalParams::settemplate(string const & name)
 165 {
 166         templatename_ = name;
 167
 168         external::TemplateManager const & etm =
 169                 external::TemplateManager::get();
 170         external::Template const * const et = etm.getTemplateByName(name);
 171         if (!et)
 172                 // Be safe. Don't lose data.
 173                 return;
 174
 175         // Ascertain which transforms the template supports.
 176         // Empty all those that it doesn't.
 177         vector<external::TransformID> const & ids = et->transformIds;
 178         clearIfNotFound(clipdata,     external::Clip,   ids);
 179         clearIfNotFound(extradata,    external::Extra,  ids);
 180         clearIfNotFound(resizedata,   external::Resize, ids);
 181         clearIfNotFound(rotationdata, external::Rotate, ids);
 182 }
 183
 184
 185 void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
 186 {
 187         os << "External\n"
 188            << "\ttemplate " << templatename() << '\n';
 189
 190         if (!filename.empty())
 191                 os << "\tfilename "
 192                    << filename.outputFilename(buffer.filePath())
 193                    << '\n';
 194
 195         if (display != defaultDisplayType)
 196                 os << "\tdisplay "
 197                    << external::displayTranslator().find(display)
 198                    << '\n';
 199
 200         if (lyxscale != defaultLyxScale)
 201                 os << "\tlyxscale " << tostr(lyxscale) << '\n';
 202
 203         if (draft)
 204                 os << "\tdraft\n";
 205
 206         if (!clipdata.bbox.empty())
 207                 os << "\tboundingBox " << clipdata.bbox << '\n';
 208         if (clipdata.clip)
 209                 os << "\tclip\n";
 210
 211         external::ExtraData::const_iterator it  = extradata.begin();
 212         external::ExtraData::const_iterator end = extradata.end();
 213         for (; it != end; ++it) {
 214                 if (!it->second.empty())
 215                         os << "\textra " << it->first << " \""
 216                            << it->second << "\"\n";
 217         }
 218
 219         if (!rotationdata.no_rotation()) {
 220                 os << "\trotateAngle " << rotationdata.angle() << '\n';
 221                 if (rotationdata.origin() != external::RotationData::DEFAULT)
 222                         os << "\trotateOrigin "
 223                            << rotationdata.originString() << '\n';
 224         }
 225
 226         if (!resizedata.no_resize()) {
 227                 using support::float_equal;
 228
 229                 if (!float_equal(resizedata.scale, 0.0, 0.05)) {
 230                         if (!float_equal(resizedata.scale, 100.0, 0.05))
 231                                 os << "\tscale "
 232                                    << resizedata.scale << '\n';
 233                 } else {
 234                         if (!resizedata.width.zero())
 235                                 os << "\twidth "
 236                                    << resizedata.width.asString() << '\n';
 237                         if (!resizedata.height.zero())
 238                                 os << "\theight "
 239                                    << resizedata.height.asString() << '\n';
 240                 }
 241                 if (resizedata.keepAspectRatio)
 242                         os << "\tkeepAspectRatio\n";
 243         }
 244 }
 245
 246
 247 bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex)
 248 {
 249         enum ExternalTags {
 250                 EX_TEMPLATE = 1,
 251                 EX_FILENAME,
 252                 EX_DISPLAY,
 253                 EX_LYXSCALE,
 254                 EX_DRAFT,
 255                 EX_BOUNDINGBOX,
 256                 EX_CLIP,
 257                 EX_EXTRA,
 258                 EX_HEIGHT,
 259                 EX_KEEPASPECTRATIO,
 260                 EX_ROTATEANGLE,
 261                 EX_ROTATEORIGIN,
 262                 EX_SCALE,
 263                 EX_WIDTH,
 264                 EX_END
 265         };
 266
 267         keyword_item external_tags[] = {
 268                 { "\\end_inset",     EX_END },
 269                 { "boundingBox",     EX_BOUNDINGBOX },
 270                 { "clip",            EX_CLIP },
 271                 { "display",         EX_DISPLAY},
 272                 { "draft",           EX_DRAFT},
 273                 { "extra",           EX_EXTRA },
 274                 { "filename",        EX_FILENAME},
 275                 { "height",          EX_HEIGHT },
 276                 { "keepAspectRatio", EX_KEEPASPECTRATIO },
 277                 { "lyxscale",        EX_LYXSCALE},
 278                 { "rotateAngle",     EX_ROTATEANGLE },
 279                 { "rotateOrigin",    EX_ROTATEORIGIN },
 280                 { "scale",           EX_SCALE },
 281                 { "template",        EX_TEMPLATE },
 282                 { "width",           EX_WIDTH }
 283         };
 284
 285         pushpophelper pph(lex, external_tags, EX_END);
 286
 287         bool found_end  = false;
 288         bool read_error = false;
 289
 290         while (lex.isOK()) {
 291                 switch (lex.lex()) {
 292                 case EX_TEMPLATE:
 293                         lex.next();
 294                         templatename_ = lex.getString();
 295                         break;
 296
 297                 case EX_FILENAME: {
 298                         lex.next();
 299                         string const name = lex.getString();
 300                         filename.set(name, buffer.filePath());
 301                         break;
 302                 }
 303
 304                 case EX_DISPLAY: {
 305                         lex.next();
 306                         string const name = lex.getString();
 307                         display = external::displayTranslator().find(name);
 308                         break;
 309                 }
 310
 311                 case EX_LYXSCALE:
 312                         lex.next();
 313                         lyxscale = lex.getInteger();
 314                         break;
 315
 316                 case EX_DRAFT:
 317                         draft = true;
 318                         break;
 319
 320                 case EX_BOUNDINGBOX:
 321                         lex.next();
 322                         clipdata.bbox.xl = lex.getInteger();
 323                         lex.next();
 324                         clipdata.bbox.yb = lex.getInteger();
 325                         lex.next();
 326                         clipdata.bbox.xr = lex.getInteger();
 327                         lex.next();
 328                         clipdata.bbox.yt = lex.getInteger();
 329                         break;
 330
 331                 case EX_CLIP:
 332                         clipdata.clip = true;
 333                         break;
 334
 335                 case EX_EXTRA: {
 336                         lex.next();
 337                         string const name = lex.getString();
 338                         lex.next();
 339                         extradata.set(name, lex.getString());
 340                         break;
 341                 }
 342
 343                 case EX_HEIGHT:
 344                         lex.next();
 345                         resizedata.height = LyXLength(lex.getString());
 346                         break;
 347
 348                 case EX_KEEPASPECTRATIO:
 349                         resizedata.keepAspectRatio = true;
 350                         break;
 351
 352                 case EX_ROTATEANGLE:
 353                         lex.next();
 354                         rotationdata.angle(lex.getFloat());
 355                         break;
 356
 357                 case EX_ROTATEORIGIN:
 358                         lex.next();
 359                         rotationdata.origin(lex.getString());
 360                         break;
 361
 362                 case EX_SCALE:
 363                         lex.next();
 364                         resizedata.scale = lex.getFloat();
 365                         break;
 366
 367                 case EX_WIDTH:
 368                         lex.next();
 369                         resizedata.width = LyXLength(lex.getString());
 370                         break;
 371
 372                 case EX_END:
 373                         found_end = true;
 374                         break;
 375
 376                 default:
 377                         lex.printError("ExternalInset::read: "
 378                                        "Wrong tag: $$Token");
 379                         read_error = true;
 380                         break;
 381                 }
 382
 383                 if (found_end || read_error)
 384                         break;
 385         }
 386
 387         if (!found_end)
 388                 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
 389
 390         // This is a trick to make sure that the data are self-consistent.
 391         settemplate(templatename_);
 392
 393         if (lyxerr.debugging(Debug::EXTERNAL)) {
 394                 lyxerr  << "InsetExternalParams::read:\n";
 395                 write(buffer, lyxerr);
 396         }
 397
 398         return !read_error;
 399 }
 400
 401
 402 InsetExternal::InsetExternal()
 403         : renderer_(new RenderButton)
 404 {}
 405
 406
 407 InsetExternal::InsetExternal(InsetExternal const & other)
 408         : InsetOld(other),
 409           boost::signals::trackable(),
 410           params_(other.params_),
 411           renderer_(other.renderer_->clone())
 412 {
 413         if (renderer_->asMonitoredPreview() != 0) {
 414                 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
 415                 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
 416                 ptr->fileChanged(boost::bind(&InsetExternal::fileChanged, this));
 417
 418         } else if (renderer_->asGraphic() != 0 ) {
 419                 RenderGraphic * const ptr = renderer_->asGraphic();
 420                 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
 421         }
 422 }
 423
 424
 425 auto_ptr<InsetBase> InsetExternal::clone() const
 426 {
 427         return auto_ptr<InsetBase>(new InsetExternal(*this));
 428 }
 429
 430
 431 InsetExternal::~InsetExternal()
 432 {
 433         InsetExternalMailer(*this).hideDialog();
 434 }
 435
 436
 437 void InsetExternal::statusChanged() const
 438 {
 439         LyX::cref().updateInset(this);
 440 }
 441
 442
 443 DispatchResult
 444 InsetExternal::priv_dispatch(BufferView & bv, FuncRequest const & cmd)
 445 {
 446         switch (cmd.action) {
 447
 448         case LFUN_EXTERNAL_EDIT: {
 449                 Buffer const & buffer = *bv.buffer();
 450                 InsetExternalParams p;
 451                 InsetExternalMailer::string2params(cmd.argument, buffer, p);
 452                 external::editExternal(p, buffer);
 453                 return DispatchResult(true);
 454         }
 455
 456         case LFUN_INSET_MODIFY: {
 457                 Buffer const & buffer = *bv.buffer();
 458                 InsetExternalParams p;
 459                 InsetExternalMailer::string2params(cmd.argument, buffer, p);
 460                 setParams(p, buffer);
 461                 bv.update();
 462                 return DispatchResult(true, true);
 463         }
 464
 465         case LFUN_INSET_DIALOG_UPDATE:
 466                 InsetExternalMailer(*this).updateDialog(&bv);
 467                 return DispatchResult(true, true);
 468
 469         case LFUN_MOUSE_RELEASE:
 470                 InsetExternalMailer(*this).showDialog(&bv);
 471                 return DispatchResult(true, true);
 472
 473         default:
 474                 return DispatchResult(false);
 475         }
 476 }
 477
 478
 479 void InsetExternal::edit(BufferView * bv, bool)
 480 {
 481         InsetExternalMailer(*this).showDialog(bv);
 482 }
 483
 484
 485 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
 486 {
 487         renderer_->metrics(mi, dim);
 488         dim_ = dim;
 489 }
 490
 491
 492 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
 493 {
 494         xo_ = x;
 495         yo_ = y;
 496         renderer_->draw(pi, x, y);
 497 }
 498
 499
 500 namespace {
 501
 502 enum RenderType {
 503         RENDERBUTTON,
 504         RENDERGRAPHIC,
 505         RENDERPREVIEW
 506 };
 507
 508
 509 RenderType getRenderType(InsetExternalParams const & p)
 510 {
 511         if (!external::getTemplatePtr(p) ||
 512             p.filename.empty() ||
 513             p.display == external::NoDisplay)
 514                 return RENDERBUTTON;
 515
 516         if (p.display == external::PreviewDisplay) {
 517                 if (RenderPreview::activated())
 518                         return RENDERPREVIEW;
 519                 return RENDERBUTTON;
 520         }
 521
 522         if (p.display == external::DefaultDisplay &&
 523             lyxrc.display_graphics == graphics::NoDisplay)
 524                 return RENDERBUTTON;
 525         return RENDERGRAPHIC;
 526 }
 527
 528
 529 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
 530 {
 531         graphics::Params gparams;
 532
 533         gparams.filename = eparams.filename.absFilename();
 534         gparams.scale = eparams.lyxscale;
 535         if (eparams.clipdata.clip)
 536                 gparams.bb = eparams.clipdata.bbox;
 537         gparams.angle = eparams.rotationdata.angle();
 538
 539         switch (eparams.display) {
 540         case external::DefaultDisplay:
 541                 gparams.display = graphics::DefaultDisplay;
 542                 break;
 543         case external::MonochromeDisplay:
 544                 gparams.display = graphics::MonochromeDisplay;
 545                 break;
 546         case external::GrayscaleDisplay:
 547                 gparams.display = graphics::GrayscaleDisplay;
 548                 break;
 549         case external::ColorDisplay:
 550                 gparams.display = graphics::ColorDisplay;
 551                 break;
 552         case external::NoDisplay:
 553                 gparams.display = graphics::NoDisplay;
 554                 break;
 555         default:
 556                 BOOST_ASSERT(false);
 557         }
 558         if (gparams.display == graphics::DefaultDisplay)
 559                 gparams.display = lyxrc.display_graphics;
 560         // Override the above if we're not using a gui
 561         if (!lyx_gui::use_gui)
 562                 gparams.display = graphics::NoDisplay;
 563
 564         return gparams;
 565 }
 566
 567
 568 string const getScreenLabel(InsetExternalParams const & params,
 569                             Buffer const & buffer)
 570 {
 571         external::Template const * const ptr =
 572                 external::getTemplatePtr(params);
 573         if (!ptr)
 574                 return support::bformat(_("External template %1$s is not installed"),
 575                                         params.templatename());
 576         return external::doSubstitution(params, buffer, ptr->guiName);
 577 }
 578
 579 void add_preview(RenderMonitoredPreview &, InsetExternal const &, Buffer const &);
 580
 581 } // namespace anon
 582
 583
 584 InsetExternalParams const & InsetExternal::params() const
 585 {
 586         return params_;
 587 }
 588
 589
 590 void InsetExternal::setParams(InsetExternalParams const & p,
 591                               Buffer const & buffer)
 592 {
 593         params_ = p;
 594
 595         // Subsequent calls to the InsetExternal::Params default constructor
 596         // will use this.
 597         defaultTemplateName = params_.templatename();
 598
 599         switch (getRenderType(params_)) {
 600         case RENDERBUTTON: {
 601                 RenderButton * button_ptr = renderer_->asButton();
 602                 if (!button_ptr) {
 603                         renderer_.reset(new RenderButton);
 604                         button_ptr = renderer_->asButton();
 605                 }
 606
 607                 button_ptr->update(getScreenLabel(params_, buffer), true);
 608                 break;
 609
 610         } case RENDERGRAPHIC: {
 611                 RenderGraphic * graphic_ptr = renderer_->asGraphic();
 612                 if (!graphic_ptr) {
 613                         renderer_.reset(new RenderGraphic);
 614                         graphic_ptr = renderer_->asGraphic();
 615                         graphic_ptr->connect(
 616                                 boost::bind(&InsetExternal::statusChanged, this));
 617                 }
 618
 619                 graphic_ptr->update(get_grfx_params(params_));
 620
 621                 break;
 622
 623         } case RENDERPREVIEW: {
 624                 RenderMonitoredPreview * preview_ptr =
 625                         renderer_->asMonitoredPreview();
 626                 if (!preview_ptr) {
 627                         renderer_.reset(new RenderMonitoredPreview);
 628                         preview_ptr = renderer_->asMonitoredPreview();
 629                         preview_ptr->connect(
 630                                 boost::bind(&InsetExternal::statusChanged, this));
 631                         preview_ptr->fileChanged(
 632                                 boost::bind(&InsetExternal::fileChanged, this));
 633                 }
 634
 635                 if (preview_ptr->monitoring())
 636                         preview_ptr->stopMonitoring();
 637                 add_preview(*preview_ptr, *this, buffer);
 638
 639                 break;
 640         }
 641         }
 642 }
 643
 644
 645 void InsetExternal::fileChanged() const
 646 {
 647         Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
 648         if (!buffer_ptr)
 649                 return;
 650
 651         RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
 652         BOOST_ASSERT(ptr);
 653
 654         Buffer const & buffer = *buffer_ptr;
 655         ptr->removePreview(buffer);
 656         add_preview(*ptr, *this, buffer);
 657         ptr->startLoading(buffer);
 658 }
 659
 660
 661 void InsetExternal::write(Buffer const & buffer, ostream & os) const
 662 {
 663         params_.write(buffer, os);
 664 }
 665
 666
 667 void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
 668 {
 669         InsetExternalParams params;
 670         if (params.read(buffer, lex))
 671                 setParams(params, buffer);
 672 }
 673
 674
 675 int InsetExternal::latex(Buffer const & buf, ostream & os,
 676                          OutputParams const & runparams) const
 677 {
 678         if (params_.draft) {
 679                 os << "\\fbox{\\ttfamily{}"
 680                    << params_.filename.outputFilename(buf.filePath())
 681                    << "}\n";
 682                 return 1;
 683         }
 684
 685         // "nice" means that the buffer is exported to LaTeX format but not
 686         // run through the LaTeX compiler.
 687         // If we're running through the LaTeX compiler, we should write the
 688         // generated files in the bufer's temporary directory.
 689         bool const external_in_tmpdir =
 690                 lyxrc.use_tempdir && !buf.temppath().empty() && !runparams.nice;
 691
 692         // If the template has specified a PDFLaTeX output, then we try and
 693         // use that.
 694         if (runparams.flavor == OutputParams::PDFLATEX) {
 695                 external::Template const * const et_ptr =
 696                         external::getTemplatePtr(params_);
 697                 if (!et_ptr)
 698                         return 0;
 699                 external::Template const & et = *et_ptr;
 700
 701                 external::Template::Formats::const_iterator cit =
 702                         et.formats.find("PDFLaTeX");
 703                 if (cit != et.formats.end())
 704                         return external::writeExternal(params_, "PDFLaTeX",
 705                                              buf, os, external_in_tmpdir);
 706         }
 707
 708         return external::writeExternal(params_, "LaTeX",
 709                                        buf, os, external_in_tmpdir);
 710 }
 711
 712
 713 int InsetExternal::plaintext(Buffer const & buf, ostream & os,
 714                          OutputParams const &) const
 715 {
 716         return external::writeExternal(params_, "Ascii", buf, os);
 717 }
 718
 719
 720 int InsetExternal::linuxdoc(Buffer const & buf, ostream & os,
 721                             OutputParams const &) const
 722 {
 723         return external::writeExternal(params_, "LinuxDoc", buf, os);
 724 }
 725
 726
 727 int InsetExternal::docbook(Buffer const & buf, ostream & os,
 728                            OutputParams const &) const
 729 {
 730         return external::writeExternal(params_, "DocBook", buf, os);
 731 }
 732
 733
 734 void InsetExternal::validate(LaTeXFeatures & features) const
 735 {
 736         if (params_.draft)
 737                 return;
 738
 739         external::Template const * const et_ptr =
 740                 external::getTemplatePtr(params_);
 741         if (!et_ptr)
 742                 return;
 743         external::Template const & et = *et_ptr;
 744
 745         external::Template::Formats::const_iterator cit =
 746                 et.formats.find("LaTeX");
 747         if (cit == et.formats.end())
 748                 return;
 749
 750         if (!cit->second.requirement.empty())
 751                 features.require(cit->second.requirement);
 752
 753         external::TemplateManager & etm = external::TemplateManager::get();
 754
 755         vector<string>::const_iterator it  = cit->second.preambleNames.begin();
 756         vector<string>::const_iterator end = cit->second.preambleNames.end();
 757         for (; it != end; ++it) {
 758                 string const preamble = etm.getPreambleDefByName(*it);
 759                 if (!preamble.empty())
 760                         features.addExternalPreamble(preamble);
 761         }
 762 }
 763
 764
 765 //
 766 // preview stuff
 767 //
 768
 769 namespace {
 770
 771 bool preview_wanted(InsetExternalParams const & params)
 772 {
 773         string const included_file = params.filename.absFilename();
 774
 775         return params.display == external::PreviewDisplay &&
 776                 support::IsFileReadable(included_file);
 777 }
 778
 779
 780 string const latex_string(InsetExternal const & inset, Buffer const & buffer)
 781 {
 782         ostringstream os;
 783         OutputParams runparams;
 784         runparams.flavor = OutputParams::LATEX;
 785         inset.latex(buffer, os, runparams);
 786
 787         return os.str();
 788 }
 789
 790
 791 void add_preview(RenderMonitoredPreview & renderer, InsetExternal const & inset,
 792                  Buffer const & buffer)
 793 {
 794         InsetExternalParams const & params = inset.params();
 795         if (RenderPreview::activated() && preview_wanted(params)) {
 796                 renderer.setAbsFile(params.filename.absFilename());
 797                 string const snippet = latex_string(inset, buffer);
 798                 renderer.addPreview(snippet, buffer);
 799         }
 800 }
 801
 802 } // namespace anon
 803
 804
 805 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
 806 {
 807         RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
 808         if (!ptr)
 809                 return;
 810
 811         if (preview_wanted(params())) {
 812                 ptr->setAbsFile(params_.filename.absFilename());
 813                 string const snippet = latex_string(*this, ploader.buffer());
 814                 ptr->addPreview(snippet, ploader);
 815         }
 816 }
 817
 818
 819 /// Mailer stuff
 820
 821 string const InsetExternalMailer::name_("external");
 822
 823 InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
 824         : inset_(inset)
 825 {}
 826
 827
 828 string const InsetExternalMailer::inset2string(Buffer const & buffer) const
 829 {
 830         return params2string(inset_.params(), buffer);
 831 }
 832
 833
 834 void InsetExternalMailer::string2params(string const & in,
 835                                         Buffer const & buffer,
 836                                         InsetExternalParams & params)
 837 {
 838         params = InsetExternalParams();
 839         if (in.empty())
 840                 return;
 841
 842         istringstream data(in);
 843         LyXLex lex(0,0);
 844         lex.setStream(data);
 845
 846         string name;
 847         lex >> name;
 848         if (!lex || name != name_)
 849                 return print_mailer_error("InsetExternalMailer", in, 1, name_);
 850
 851         // This is part of the inset proper that is usually swallowed
 852         // by LyXText::readInset
 853         string id;
 854         lex >> id;
 855         if (!lex || id != "External")
 856                 return print_mailer_error("InsetBoxMailer", in, 2, "External");
 857
 858         params.read(buffer, lex);
 859 }
 860
 861
 862 string const
 863 InsetExternalMailer::params2string(InsetExternalParams const & params,
 864                                    Buffer const & buffer)
 865 {
 866         ostringstream data;
 867         data << name_ << ' ';
 868         params.write(buffer, data);
 869         data << "\\end_inset\n";
 870         return data.str();
 871 }