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/ExternalTemplate.h"
  16 #include "insets/RenderButton.h"
  17 #include "insets/RenderGraphic.h"
  18 #include "insets/RenderPreview.h"
  19
  20 #include "Buffer.h"
  21 #include "BufferView.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 "Lexer.h"
  29 #include "LyX.h" // use_gui
  30 #include "LyXRC.h"
  31 #include "MetricsInfo.h"
  32 #include "OutputParams.h"
  33
  34 #include "frontends/alert.h"
  35 #include "frontends/Application.h"
  36
  37 #include "graphics/PreviewLoader.h"
  38
  39 #include "support/debug.h"
  40 #include "support/ExceptionMessage.h"
  41 #include "support/filetools.h"
  42 #include "support/gettext.h"
  43 #include "support/lstrings.h"
  44 #include "support/lyxlib.h"
  45 #include "support/convert.h"
  46 #include "support/Translator.h"
  47
  48 #include <boost/bind.hpp>
  49
  50 #include <sstream>
  51
  52 using namespace std;
  53 using namespace lyx::support;
  54
  55 namespace {
  56
  57 lyx::external::DisplayType const defaultDisplayType = lyx::external::NoDisplay;
  58
  59 unsigned int const defaultLyxScale = 100;
  60
  61 string defaultTemplateName;
  62
  63 } // namespace anon
  64
  65
  66 namespace lyx {
  67
  68 namespace Alert = frontend::Alert;
  69
  70 namespace external {
  71
  72 TempName::TempName()
  73 {
  74         FileName const tempname = FileName::tempName("lyxext");
  75         // FIXME: This is unsafe
  76         tempname.removeFile();
  77         // must have an extension for the converter code to work correctly.
  78         tempname_ = FileName(tempname.absFilename() + ".tmp");
  79 }
  80
  81
  82 TempName::TempName(TempName const &)
  83 {
  84         tempname_ = TempName()();
  85 }
  86
  87
  88 TempName::~TempName()
  89 {
  90         tempname_.removeFile();
  91 }
  92
  93
  94 TempName & TempName::operator=(TempName const & other)
  95 {
  96         if (this != &other)
  97                 tempname_ = TempName()();
  98         return *this;
  99 }
 100
 101
 102 namespace {
 103
 104 /// The translator between the Display enum and corresponding lyx string.
 105 Translator<DisplayType, string> const initTranslator()
 106 {
 107         Translator<DisplayType, string> translator(DefaultDisplay, "default");
 108
 109         // Fill the display translator
 110         translator.addPair(MonochromeDisplay, "monochrome");
 111         translator.addPair(GrayscaleDisplay, "grayscale");
 112         translator.addPair(ColorDisplay, "color");
 113         translator.addPair(PreviewDisplay, "preview");
 114         translator.addPair(NoDisplay, "none");
 115
 116         return translator;
 117 }
 118
 119 } // namespace anon
 120
 121
 122 Translator<DisplayType, string> const & displayTranslator()
 123 {
 124         static Translator<DisplayType, string> const translator =
 125                 initTranslator();
 126         return translator;
 127 }
 128
 129 } // namespace external
 130
 131
 132 InsetExternalParams::InsetExternalParams()
 133         : display(defaultDisplayType),
 134           lyxscale(defaultLyxScale),
 135           draft(false)
 136 {
 137         if (defaultTemplateName.empty()) {
 138                 external::TemplateManager const & etm =
 139                         external::TemplateManager::get();
 140                 templatename_ = etm.getTemplates().begin()->first;
 141         } else
 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 = 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 & buf, ostream & os) const
 187 {
 188         os << "External\n"
 189            << "\ttemplate " << templatename() << '\n';
 190
 191         if (!filename.empty()) {
 192                 os << "\tfilename " << filename.outputFilename(buf.filePath()) << '\n';
 193                 os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\n';
 194         }
 195         if (display != defaultDisplayType)
 196                 os << "\tdisplay "
 197                    << external::displayTranslator().find(display)
 198                    << '\n';
 199
 200         if (lyxscale != defaultLyxScale)
 201                 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
 202
 203         if (draft)
 204                 os << "\tdraft\n";
 205
 206         if (!clipdata.bbox.empty())
 207                 os << "\tboundingBox " << clipdata.bbox << '\n';
 208         if (clipdata.clip)
 209                 os << "\tclip\n";
 210
 211         external::ExtraData::const_iterator it  = extradata.begin();
 212         external::ExtraData::const_iterator end = extradata.end();
 213         for (; it != end; ++it) {
 214                 if (!it->second.empty())
 215                         os << "\textra " << it->first << " \""
 216                            << it->second << "\"\n";
 217         }
 218
 219         if (!rotationdata.no_rotation()) {
 220                 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
 221                 if (rotationdata.origin() != external::RotationData::DEFAULT)
 222                         os << "\trotateOrigin "
 223                            << rotationdata.originString() << '\n';
 224         }
 225
 226         if (!resizedata.no_resize()) {
 227                 double const scl = convert<double>(resizedata.scale);
 228                 if (!float_equal(scl, 0.0, 0.05)) {
 229                         if (!float_equal(scl, 100.0, 0.05))
 230                                 os << "\tscale "
 231                                    << resizedata.scale << '\n';
 232                 } else {
 233                         if (!resizedata.width.zero())
 234                                 os << "\twidth "
 235                                    << resizedata.width.asString() << '\n';
 236                         if (!resizedata.height.zero())
 237                                 os << "\theight "
 238                                    << resizedata.height.asString() << '\n';
 239                 }
 240                 if (resizedata.keepAspectRatio)
 241                         os << "\tkeepAspectRatio\n";
 242         }
 243 }
 244
 245
 246 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
 247 {
 248         enum ExternalTags {
 249                 EX_TEMPLATE = 1,
 250                 EX_FILENAME,
 251                 EX_EMBED,
 252                 EX_DISPLAY,
 253                 EX_LYXSCALE,
 254                 EX_DRAFT,
 255                 EX_BOUNDINGBOX,
 256                 EX_CLIP,
 257                 EX_EXTRA,
 258                 EX_HEIGHT,
 259                 EX_KEEPASPECTRATIO,
 260                 EX_ROTATEANGLE,
 261                 EX_ROTATEORIGIN,
 262                 EX_SCALE,
 263                 EX_WIDTH,
 264                 EX_END
 265         };
 266
 267         LexerKeyword external_tags[] = {
 268                 { "\\end_inset",     EX_END },
 269                 { "boundingBox",     EX_BOUNDINGBOX },
 270                 { "clip",            EX_CLIP },
 271                 { "display",         EX_DISPLAY},
 272                 { "draft",           EX_DRAFT},
 273                 { "embed",           EX_EMBED},
 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.eatLine();
 300                         string const name = lex.getString();
 301                         filename.set(name, buffer.filePath());
 302                         break;
 303                 }
 304
 305                 case EX_EMBED: {
 306                         lex.next();
 307                         string const name = lex.getString();
 308                         filename.setInzipName(name);
 309                         filename.setEmbed(!name.empty());
 310                         break;
 311                 }
 312
 313                 case EX_DISPLAY: {
 314                         lex.next();
 315                         string const name = lex.getString();
 316                         display = external::displayTranslator().find(name);
 317                         break;
 318                 }
 319
 320                 case EX_LYXSCALE:
 321                         lex.next();
 322                         lyxscale = lex.getInteger();
 323                         break;
 324
 325                 case EX_DRAFT:
 326                         draft = true;
 327                         break;
 328
 329                 case EX_BOUNDINGBOX:
 330                         lex.next();
 331                         clipdata.bbox.xl = lex.getInteger();
 332                         lex.next();
 333                         clipdata.bbox.yb = lex.getInteger();
 334                         lex.next();
 335                         clipdata.bbox.xr = lex.getInteger();
 336                         lex.next();
 337                         clipdata.bbox.yt = lex.getInteger();
 338                         break;
 339
 340                 case EX_CLIP:
 341                         clipdata.clip = true;
 342                         break;
 343
 344                 case EX_EXTRA: {
 345                         lex.next();
 346                         string const name = lex.getString();
 347                         lex.next();
 348                         extradata.set(name, lex.getString());
 349                         break;
 350                 }
 351
 352                 case EX_HEIGHT:
 353                         lex.next();
 354                         resizedata.height = Length(lex.getString());
 355                         break;
 356
 357                 case EX_KEEPASPECTRATIO:
 358                         resizedata.keepAspectRatio = true;
 359                         break;
 360
 361                 case EX_ROTATEANGLE:
 362                         lex.next();
 363                         rotationdata.angle = lex.getString();
 364                         break;
 365
 366                 case EX_ROTATEORIGIN:
 367                         lex.next();
 368                         rotationdata.origin(lex.getString());
 369                         break;
 370
 371                 case EX_SCALE:
 372                         lex.next();
 373                         resizedata.scale = lex.getString();
 374                         break;
 375
 376                 case EX_WIDTH:
 377                         lex.next();
 378                         resizedata.width = Length(lex.getString());
 379                         break;
 380
 381                 case EX_END:
 382                         found_end = true;
 383                         break;
 384
 385                 default:
 386                         lex.printError("ExternalInset::read: Wrong tag: $$Token");
 387                         read_error = true;
 388                         break;
 389                 }
 390
 391                 if (found_end || read_error)
 392                         break;
 393         }
 394
 395         if (!found_end)
 396                 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
 397
 398         // This is a trick to make sure that the data are self-consistent.
 399         settemplate(templatename_);
 400
 401         if (lyxerr.debugging(Debug::EXTERNAL)) {
 402                 lyxerr  << "InsetExternalParams::read:\n";
 403                 write(buffer, lyxerr);
 404         }
 405
 406         return !read_error;
 407 }
 408
 409
 410 InsetExternal::InsetExternal(Buffer & buf)
 411         : renderer_(new RenderButton)
 412 {
 413         Inset::setBuffer(buf);
 414 }
 415
 416
 417 InsetExternal::InsetExternal(InsetExternal const & other)
 418         : Inset(other),
 419           boost::signals::trackable(),
 420           params_(other.params_),
 421           renderer_(other.renderer_->clone(this))
 422 {}
 423
 424
 425 InsetExternal::~InsetExternal()
 426 {
 427         hideDialogs("external", this);
 428 }
 429
 430
 431 void InsetExternal::setBuffer(Buffer & buffer)
 432 {
 433         if (buffer_) {
 434                 try {
 435                         // a file may not be copied successfully when, e.g. buffer_
 436                         // has already been closed.
 437                         params_.filename = params_.filename.copyTo(buffer);
 438                 } catch (ExceptionMessage const & message) {
 439                         Alert::error(message.title_, message.details_);
 440                         // failed to embed
 441                         params_.filename.setEmbed(false);
 442                 }
 443         }
 444         Inset::setBuffer(buffer);
 445 }
 446
 447
 448 void InsetExternal::statusChanged() const
 449 {
 450         updateFrontend();
 451 }
 452
 453
 454 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
 455 {
 456         switch (cmd.action) {
 457
 458         case LFUN_EXTERNAL_EDIT: {
 459                 InsetExternalParams p =  params();
 460                 if (!cmd.argument().empty())
 461                         string2params(to_utf8(cmd.argument()), buffer(), p);
 462                 external::editExternal(p, buffer());
 463                 break;
 464         }
 465
 466         case LFUN_INSET_MODIFY: {
 467                 InsetExternalParams p;
 468                 string2params(to_utf8(cmd.argument()), buffer(), p);
 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         case LFUN_MOUSE_RELEASE:
 479                 if (!cur.selection() && cmd.button() == mouse_button::button1)
 480                         cur.bv().showDialog("external",
 481                                 params2string(params(), cur.bv().buffer()),
 482                                 this);
 483                 break;
 484
 485         default:
 486                 Inset::doDispatch(cur, cmd);
 487         }
 488 }
 489
 490
 491 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
 492                 FuncStatus & flag) const
 493 {
 494         switch (cmd.action) {
 495
 496         case LFUN_EXTERNAL_EDIT:
 497         case LFUN_INSET_MODIFY:
 498         case LFUN_INSET_DIALOG_UPDATE:
 499                 flag.enabled(true);
 500                 return true;
 501
 502         default:
 503                 return Inset::getStatus(cur, cmd, flag);
 504         }
 505 }
 506
 507
 508 void InsetExternal::registerEmbeddedFiles(EmbeddedFileList & files) const
 509 {
 510         files.registerFile(params_.filename, this, buffer());
 511 }
 512
 513
 514 void InsetExternal::updateEmbeddedFile(EmbeddedFile const & file)
 515 {
 516         params_.filename = file;
 517 }
 518
 519
 520 void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
 521 {
 522         cur.bv().showDialog("external",
 523                 params2string(params(), cur.bv().buffer()),
 524                 this);
 525 }
 526
 527
 528 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
 529 {
 530         renderer_->metrics(mi, dim);
 531 }
 532
 533
 534 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
 535 {
 536         renderer_->draw(pi, x, y);
 537 }
 538
 539
 540 namespace {
 541
 542 enum RenderType {
 543         RENDERBUTTON,
 544         RENDERGRAPHIC,
 545         RENDERPREVIEW
 546 };
 547
 548
 549 RenderType getRenderType(InsetExternalParams const & p)
 550 {
 551         if (!external::getTemplatePtr(p) ||
 552             p.filename.empty() ||
 553             p.display == external::NoDisplay)
 554                 return RENDERBUTTON;
 555
 556         if (p.display == external::PreviewDisplay) {
 557                 if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
 558                         return RENDERPREVIEW;
 559                 return RENDERBUTTON;
 560         }
 561
 562         if (p.display == external::DefaultDisplay &&
 563             lyxrc.display_graphics == graphics::NoDisplay)
 564                 return RENDERBUTTON;
 565         return RENDERGRAPHIC;
 566 }
 567
 568
 569 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
 570 {
 571         graphics::Params gparams;
 572
 573         gparams.filename = eparams.filename.availableFile();
 574         gparams.icon = eparams.filename.embedded() ? "pin.png" : "";
 575         gparams.scale = eparams.lyxscale;
 576         if (eparams.clipdata.clip)
 577                 gparams.bb = eparams.clipdata.bbox;
 578         gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
 579
 580         switch (eparams.display) {
 581         case external::DefaultDisplay:
 582                 gparams.display = graphics::DefaultDisplay;
 583                 break;
 584         case external::MonochromeDisplay:
 585                 gparams.display = graphics::MonochromeDisplay;
 586                 break;
 587         case external::GrayscaleDisplay:
 588                 gparams.display = graphics::GrayscaleDisplay;
 589                 break;
 590         case external::ColorDisplay:
 591                 gparams.display = graphics::ColorDisplay;
 592                 break;
 593         case external::NoDisplay:
 594                 gparams.display = graphics::NoDisplay;
 595                 break;
 596         default:
 597                 BOOST_ASSERT(false);
 598         }
 599         if (gparams.display == graphics::DefaultDisplay)
 600                 gparams.display = graphics::DisplayType(lyxrc.display_graphics);
 601         // Override the above if we're not using a gui
 602         if (!use_gui)
 603                 gparams.display = graphics::NoDisplay;
 604
 605         return gparams;
 606 }
 607
 608
 609 docstring screenLabel(InsetExternalParams const & params,
 610                             Buffer const & buffer)
 611 {
 612         external::Template const * const ptr =
 613                 external::getTemplatePtr(params);
 614         if (!ptr)
 615                 // FIXME UNICODE
 616                 return bformat((_("External template %1$s is not installed")),
 617                                         from_utf8(params.templatename()));
 618         // FIXME UNICODE
 619         docstring gui = _(ptr->guiName);
 620         return from_utf8(external::doSubstitution(params, buffer,
 621                                 to_utf8(gui), false));
 622 }
 623
 624 } // namespace anon
 625
 626
 627 static bool isPreviewWanted(InsetExternalParams const & params)
 628 {
 629         return params.display == external::PreviewDisplay &&
 630                 params.filename.isReadableFile();
 631 }
 632
 633
 634 static docstring latexString(InsetExternal const & inset)
 635 {
 636         odocstringstream os;
 637         // We don't need to set runparams.encoding since it is not used by
 638         // latex().
 639         OutputParams runparams(0);
 640         runparams.flavor = OutputParams::LATEX;
 641         inset.latex(os, runparams);
 642         return os.str();
 643 }
 644
 645
 646 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
 647                                    InsetExternal const & inset,
 648                                    Buffer const & buffer)
 649 {
 650         InsetExternalParams const & params = inset.params();
 651
 652         if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
 653             isPreviewWanted(params)) {
 654                 renderer.setAbsFile(params.filename);
 655                 docstring const snippet = latexString(inset);
 656                 renderer.addPreview(snippet, buffer);
 657                 renderer.startLoading(buffer);
 658         }
 659 }
 660
 661
 662 InsetExternalParams const & InsetExternal::params() const
 663 {
 664         return params_;
 665 }
 666
 667
 668 void InsetExternal::setParams(InsetExternalParams const & p)
 669 {
 670         params_ = p;
 671
 672         // Subsequent calls to the InsetExternal::Params default constructor
 673         // will use this.
 674         defaultTemplateName = params_.templatename();
 675
 676         switch (getRenderType(params_)) {
 677         case RENDERBUTTON: {
 678                 RenderButton * button_ptr = renderer_->asButton();
 679                 if (!button_ptr) {
 680                         renderer_.reset(new RenderButton);
 681                         button_ptr = renderer_->asButton();
 682                 }
 683
 684                 button_ptr->update(screenLabel(params_, buffer()), true);
 685                 break;
 686         }
 687
 688         case RENDERGRAPHIC: {
 689                 RenderGraphic * graphic_ptr = renderer_->asGraphic();
 690                 if (!graphic_ptr) {
 691                         renderer_.reset(new RenderGraphic(this));
 692                         graphic_ptr = renderer_->asGraphic();
 693                 }
 694
 695                 graphic_ptr->update(get_grfx_params(params_));
 696
 697                 break;
 698         }
 699
 700         case RENDERPREVIEW: {
 701                 RenderMonitoredPreview * preview_ptr =
 702                         renderer_->asMonitoredPreview();
 703                 if (!preview_ptr) {
 704                         renderer_.reset(new RenderMonitoredPreview(this));
 705                         preview_ptr = renderer_->asMonitoredPreview();
 706                         preview_ptr->fileChanged(
 707                                 boost::bind(&InsetExternal::fileChanged, this));
 708                 }
 709
 710                 if (preview_ptr->monitoring())
 711                         preview_ptr->stopMonitoring();
 712                 add_preview_and_start_loading(*preview_ptr, *this, buffer());
 713
 714                 break;
 715         }
 716         }
 717 }
 718
 719
 720 void InsetExternal::fileChanged() const
 721 {
 722         Buffer const * const buffer = updateFrontend();
 723         if (!buffer)
 724                 return;
 725
 726         RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
 727         BOOST_ASSERT(ptr);
 728
 729         ptr->removePreview(*buffer);
 730         add_preview_and_start_loading(*ptr, *this, *buffer);
 731 }
 732
 733
 734 void InsetExternal::write(ostream & os) const
 735 {
 736         params_.write(buffer(), os);
 737 }
 738
 739
 740 void InsetExternal::read(Lexer & lex)
 741 {
 742         InsetExternalParams params;
 743         if (params.read(buffer(), lex)) {
 744                 // exception handling is not needed as long as embedded files are in place.
 745                 params.filename.enable(buffer().embedded(), buffer(), false);
 746                 setParams(params);
 747         }
 748 }
 749
 750
 751 int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
 752 {
 753         if (params_.draft) {
 754                 // FIXME UNICODE
 755                 os << "\\fbox{\\ttfamily{}"
 756                    << from_utf8(params_.filename.outputFilename(buffer().filePath()))
 757                    << "}\n";
 758                 return 1;
 759         }
 760
 761         // "nice" means that the buffer is exported to LaTeX format but not
 762         // run through the LaTeX compiler.
 763         // If we're running through the LaTeX compiler, we should write the
 764         // generated files in the buffer's temporary directory.
 765         bool const external_in_tmpdir = !runparams.nice;
 766         bool const dryrun = runparams.dryrun || runparams.inComment;
 767
 768         // If the template has specified a PDFLaTeX output, then we try and
 769         // use that.
 770         if (runparams.flavor == OutputParams::PDFLATEX) {
 771                 external::Template const * const et_ptr =
 772                         external::getTemplatePtr(params_);
 773                 if (!et_ptr)
 774                         return 0;
 775                 external::Template const & et = *et_ptr;
 776
 777                 external::Template::Formats::const_iterator cit =
 778                         et.formats.find("PDFLaTeX");
 779
 780                 if (cit != et.formats.end()) {
 781                         return external::writeExternal(params_, "PDFLaTeX",
 782                                                        buffer(), os,
 783                                                        *(runparams.exportdata),
 784                                                        external_in_tmpdir,
 785                                                        dryrun);
 786                 }
 787         }
 788
 789         return external::writeExternal(params_, "LaTeX", buffer(), os,
 790                                        *(runparams.exportdata),
 791                                        external_in_tmpdir,
 792                                        dryrun);
 793 }
 794
 795
 796 int InsetExternal::plaintext(odocstream & os,
 797                              OutputParams const & runparams) const
 798 {
 799         os << '\n'; // output external material on a new line
 800         external::writeExternal(params_, "Ascii", buffer(), os,
 801                                 *(runparams.exportdata), false,
 802                                 runparams.dryrun || runparams.inComment);
 803         return PLAINTEXT_NEWLINE;
 804 }
 805
 806
 807 int InsetExternal::docbook(odocstream & os,
 808                            OutputParams const & runparams) const
 809 {
 810         return external::writeExternal(params_, "DocBook", buffer(), os,
 811                                        *(runparams.exportdata), false,
 812                                        runparams.dryrun || runparams.inComment);
 813 }
 814
 815
 816 void InsetExternal::validate(LaTeXFeatures & features) const
 817 {
 818         if (params_.draft)
 819                 return;
 820
 821         external::Template const * const et_ptr =
 822                 external::getTemplatePtr(params_);
 823         if (!et_ptr)
 824                 return;
 825         external::Template const & et = *et_ptr;
 826
 827         string format;
 828         switch (features.runparams().flavor) {
 829         case OutputParams::LATEX:
 830                 format = "LaTeX";
 831                 break;
 832         case OutputParams::PDFLATEX:
 833                 format = "PDFLaTeX";
 834                 break;
 835         case OutputParams::XML:
 836                 format = "DocBook";
 837                 break;
 838         }
 839         external::Template::Formats::const_iterator cit =
 840                 et.formats.find(format);
 841         if (cit == et.formats.end())
 842                 return;
 843
 844         // FIXME: We don't need that always
 845         features.require("lyxdot");
 846
 847         vector<string>::const_iterator it  = cit->second.requirements.begin();
 848         vector<string>::const_iterator end = cit->second.requirements.end();
 849         for (; it != end; ++it)
 850                 features.require(*it);
 851
 852         external::TemplateManager & etm = external::TemplateManager::get();
 853
 854         it  = cit->second.preambleNames.begin();
 855         end = cit->second.preambleNames.end();
 856         for (; it != end; ++it) {
 857                 string const preamble = etm.getPreambleDefByName(*it);
 858                 if (!preamble.empty())
 859                         features.addPreambleSnippet(preamble);
 860         }
 861 }
 862
 863
 864 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
 865 {
 866         RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
 867         if (!ptr)
 868                 return;
 869
 870         if (isPreviewWanted(params())) {
 871                 ptr->setAbsFile(params_.filename);
 872                 docstring const snippet = latexString(*this);
 873                 ptr->addPreview(snippet, ploader);
 874         }
 875 }
 876
 877
 878 void InsetExternal::string2params(string const & in, Buffer const & buffer,
 879         InsetExternalParams & params)
 880 {
 881         params = InsetExternalParams();
 882         if (in.empty())
 883                 return;
 884
 885         istringstream data(in);
 886         Lexer lex;
 887         lex.setStream(data);
 888
 889         string name;
 890         lex >> name;
 891         if (!lex || name != "external") {
 892                 LYXERR0("InsetExternal::string2params(" << in << ")\n"
 893                                           "Expected arg 1 to be \"external\"\n");
 894                 return;
 895         }
 896
 897         // This is part of the inset proper that is usually swallowed
 898         // by Text::readInset
 899         string id;
 900         lex >> id;
 901         if (!lex || id != "External") {
 902                 LYXERR0("InsetExternal::string2params(" << in << ")\n"
 903                                           "Expected arg 2 to be \"External\"\n");
 904                 return;
 905         }
 906
 907         params.read(buffer, lex);
 908 }
 909
 910
 911 string InsetExternal::params2string(InsetExternalParams const & params,
 912         Buffer const & buffer)
 913 {
 914         ostringstream data;
 915         data << "external" << ' ';
 916         params.write(buffer, data);
 917         data << "\\end_inset\n";
 918         return data.str();
 919 }
 920
 921 } // namespace lyx