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