src/insets/InsetExternal.cpp

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