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