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