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