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