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