src/insets/insetinclude.C

   1 /**
   2  * \file insetinclude.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "insetinclude.h"
  14
  15 #include "buffer.h"
  16 #include "buffer_funcs.h"
  17 #include "bufferlist.h"
  18 #include "bufferparams.h"
  19 #include "BufferView.h"
  20 #include "cursor.h"
  21 #include "debug.h"
  22 #include "dispatchresult.h"
  23 #include "exporter.h"
  24 #include "funcrequest.h"
  25 #include "FuncStatus.h"
  26 #include "gettext.h"
  27 #include "LaTeXFeatures.h"
  28 #include "lyx_main.h"
  29 #include "lyxrc.h"
  30 #include "lyxlex.h"
  31 #include "metricsinfo.h"
  32 #include "outputparams.h"
  33 #include "TocBackend.h"
  34
  35 #include "frontends/Alert.h"
  36 #include "frontends/Painter.h"
  37
  38 #include "graphics/PreviewImage.h"
  39 #include "graphics/PreviewLoader.h"
  40
  41 #include "insets/render_preview.h"
  42
  43 #include "support/filetools.h"
  44 #include "support/lstrings.h" // contains
  45 #include "support/lyxalgo.h"
  46 #include "support/lyxlib.h"
  47 #include "support/convert.h"
  48
  49 #include <boost/bind.hpp>
  50 #include <boost/filesystem/operations.hpp>
  51
  52
  53 namespace lyx {
  54
  55 using support::addName;
  56 using support::absolutePath;
  57 using support::bformat;
  58 using support::changeExtension;
  59 using support::contains;
  60 using support::copy;
  61 using support::DocFileName;
  62 using support::FileName;
  63 using support::getFileContents;
  64 using support::isFileReadable;
  65 using support::isLyXFilename;
  66 using support::latex_path;
  67 using support::makeAbsPath;
  68 using support::makeDisplayPath;
  69 using support::makeRelPath;
  70 using support::onlyFilename;
  71 using support::onlyPath;
  72 using support::subst;
  73 using support::sum;
  74
  75 using std::endl;
  76 using std::string;
  77 using std::auto_ptr;
  78 using std::istringstream;
  79 using std::ostream;
  80 using std::ostringstream;
  81
  82 namespace Alert = frontend::Alert;
  83 namespace fs = boost::filesystem;
  84
  85
  86 namespace {
  87
  88 docstring const uniqueID()
  89 {
  90         static unsigned int seed = 1000;
  91         return "file" + convert<docstring>(++seed);
  92 }
  93
  94 } // namespace anon
  95
  96
  97 InsetInclude::InsetInclude(InsetCommandParams const & p)
  98         : params_(p), include_label(uniqueID()),
  99           preview_(new RenderMonitoredPreview(this)),
 100           set_label_(false)
 101 {
 102         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 103 }
 104
 105
 106 InsetInclude::InsetInclude(InsetInclude const & other)
 107         : InsetOld(other),
 108           params_(other.params_),
 109           include_label(other.include_label),
 110           preview_(new RenderMonitoredPreview(this)),
 111           set_label_(false)
 112 {
 113         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 114 }
 115
 116
 117 InsetInclude::~InsetInclude()
 118 {
 119         InsetIncludeMailer(*this).hideDialog();
 120 }
 121
 122
 123 void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd)
 124 {
 125         switch (cmd.action) {
 126
 127         case LFUN_INSET_MODIFY: {
 128                 InsetCommandParams p("include");
 129                 InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p);
 130                 if (!p.getCmdName().empty()) {
 131                         set(p, cur.buffer());
 132                         cur.buffer().updateBibfilesCache();
 133                 } else
 134                         cur.noUpdate();
 135                 break;
 136         }
 137
 138         case LFUN_INSET_DIALOG_UPDATE:
 139                 InsetIncludeMailer(*this).updateDialog(&cur.bv());
 140                 break;
 141
 142         case LFUN_MOUSE_RELEASE:
 143                 InsetIncludeMailer(*this).showDialog(&cur.bv());
 144                 break;
 145
 146         default:
 147                 InsetBase::doDispatch(cur, cmd);
 148                 break;
 149         }
 150 }
 151
 152
 153 bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd,
 154                 FuncStatus & flag) const
 155 {
 156         switch (cmd.action) {
 157
 158         case LFUN_INSET_MODIFY:
 159         case LFUN_INSET_DIALOG_UPDATE:
 160                 flag.enabled(true);
 161                 return true;
 162
 163         default:
 164                 return InsetBase::getStatus(cur, cmd, flag);
 165         }
 166 }
 167
 168
 169 InsetCommandParams const & InsetInclude::params() const
 170 {
 171         return params_;
 172 }
 173
 174
 175 namespace {
 176
 177 /// the type of inclusion
 178 enum Types {
 179         INCLUDE = 0,
 180         VERB = 1,
 181         INPUT = 2,
 182         VERBAST = 3
 183 };
 184
 185
 186 Types type(InsetCommandParams const & params)
 187 {
 188         string const command_name = params.getCmdName();
 189
 190         if (command_name == "input")
 191                 return INPUT;
 192         if  (command_name == "verbatiminput")
 193                 return VERB;
 194         if  (command_name == "verbatiminput*")
 195                 return VERBAST;
 196         return INCLUDE;
 197 }
 198
 199
 200 bool isVerbatim(InsetCommandParams const & params)
 201 {
 202         string const command_name = params.getCmdName();
 203         return command_name == "verbatiminput" ||
 204                 command_name == "verbatiminput*";
 205 }
 206
 207
 208 string const masterFilename(Buffer const & buffer)
 209 {
 210         return buffer.getMasterBuffer()->fileName();
 211 }
 212
 213
 214 string const parentFilename(Buffer const & buffer)
 215 {
 216         return buffer.fileName();
 217 }
 218
 219
 220 FileName const includedFilename(Buffer const & buffer,
 221                               InsetCommandParams const & params)
 222 {
 223         return makeAbsPath(to_utf8(params["filename"]),
 224                            onlyPath(parentFilename(buffer)));
 225 }
 226
 227
 228 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
 229
 230 } // namespace anon
 231
 232
 233 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
 234 {
 235         params_ = p;
 236         set_label_ = false;
 237
 238         if (preview_->monitoring())
 239                 preview_->stopMonitoring();
 240
 241         if (type(params_) == INPUT)
 242                 add_preview(*preview_, *this, buffer);
 243 }
 244
 245
 246 auto_ptr<InsetBase> InsetInclude::doClone() const
 247 {
 248         return auto_ptr<InsetBase>(new InsetInclude(*this));
 249 }
 250
 251
 252 void InsetInclude::write(Buffer const &, ostream & os) const
 253 {
 254         write(os);
 255 }
 256
 257
 258 void InsetInclude::write(ostream & os) const
 259 {
 260         os << "Include " << to_utf8(params_.getCommand()) << '\n'
 261            << "preview " << convert<string>(params_.preview()) << '\n';
 262 }
 263
 264
 265 void InsetInclude::read(Buffer const &, LyXLex & lex)
 266 {
 267         read(lex);
 268 }
 269
 270
 271 void InsetInclude::read(LyXLex & lex)
 272 {
 273         if (lex.isOK()) {
 274                 lex.eatLine();
 275                 string const command = lex.getString();
 276                 params_.scanCommand(command);
 277         }
 278         string token;
 279         while (lex.isOK()) {
 280                 lex.next();
 281                 token = lex.getString();
 282                 if (token == "\\end_inset")
 283                         break;
 284                 if (token == "preview") {
 285                         lex.next();
 286                         params_.preview(lex.getBool());
 287                 } else
 288                         lex.printError("Unknown parameter name `$$Token' for command " + params_.getCmdName());
 289         }
 290         if (token != "\\end_inset") {
 291                 lex.printError("Missing \\end_inset at this point. "
 292                                "Read: `$$Token'");
 293         }
 294 }
 295
 296
 297 docstring const InsetInclude::getScreenLabel(Buffer const &) const
 298 {
 299         docstring temp;
 300
 301         switch (type(params_)) {
 302                 case INPUT:
 303                         temp += _("Input");
 304                         break;
 305                 case VERB:
 306                         temp += _("Verbatim Input");
 307                         break;
 308                 case VERBAST:
 309                         temp += _("Verbatim Input*");
 310                         break;
 311                 case INCLUDE:
 312                         temp += _("Include");
 313                         break;
 314         }
 315
 316         temp += ": ";
 317
 318         if (params_["filename"].empty())
 319                 temp += "???";
 320         else
 321                 temp += from_utf8(onlyFilename(to_utf8(params_["filename"])));
 322
 323         return temp;
 324 }
 325
 326
 327 namespace {
 328
 329 /// return the child buffer if the file is a LyX doc and is loaded
 330 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
 331 {
 332         if (isVerbatim(params))
 333                 return 0;
 334
 335         string const included_file = includedFilename(buffer, params).absFilename();
 336         if (!isLyXFilename(included_file))
 337                 return 0;
 338
 339         return theBufferList().getBuffer(included_file);
 340 }
 341
 342
 343 /// return true if the file is or got loaded.
 344 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
 345 {
 346         if (isVerbatim(params))
 347                 return false;
 348
 349         FileName const included_file = includedFilename(buffer, params);
 350         if (!isLyXFilename(included_file.absFilename()))
 351                 return false;
 352
 353         Buffer * buf = theBufferList().getBuffer(included_file.absFilename());
 354         if (!buf) {
 355                 // the readonly flag can/will be wrong, not anymore I think.
 356                 if (!fs::exists(included_file.toFilesystemEncoding()))
 357                         return false;
 358                 buf = theBufferList().newBuffer(included_file.absFilename());
 359                 if (!loadLyXFile(buf, included_file))
 360                         return false;
 361         }
 362         if (buf)
 363                 buf->setParentName(parentFilename(buffer));
 364         return buf != 0;
 365 }
 366
 367
 368 } // namespace anon
 369
 370
 371 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
 372                         OutputParams const & runparams) const
 373 {
 374         string incfile(to_utf8(params_["filename"]));
 375
 376         // Do nothing if no file name has been specified
 377         if (incfile.empty())
 378                 return 0;
 379
 380         FileName const included_file(includedFilename(buffer, params_));
 381         Buffer const * const m_buffer = buffer.getMasterBuffer();
 382
 383         // if incfile is relative, make it relative to the master
 384         // buffer directory.
 385         if (!absolutePath(incfile)) {
 386                 // FIXME UNICODE
 387                 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
 388                                               from_utf8(m_buffer->filePath())));
 389         }
 390
 391         // write it to a file (so far the complete file)
 392         string const exportfile = changeExtension(incfile, ".tex");
 393         string const mangled = DocFileName(changeExtension(included_file.absFilename(),
 394                                                         ".tex")).mangledFilename();
 395         FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
 396
 397         if (!runparams.nice)
 398                 incfile = mangled;
 399         LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
 400         LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
 401         LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
 402
 403         if (runparams.inComment || runparams.dryrun)
 404                 // Don't try to load or copy the file
 405                 ;
 406         else if (loadIfNeeded(buffer, params_)) {
 407                 Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
 408
 409                 if (tmp->params().textclass != m_buffer->params().textclass) {
 410                         // FIXME UNICODE
 411                         docstring text = bformat(_("Included file `%1$s'\n"
 412                                                 "has textclass `%2$s'\n"
 413                                                              "while parent file has textclass `%3$s'."),
 414                                               makeDisplayPath(included_file.absFilename()),
 415                                               from_utf8(tmp->params().getLyXTextClass().name()),
 416                                               from_utf8(m_buffer->params().getLyXTextClass().name()));
 417                         Alert::warning(_("Different textclasses"), text);
 418                         //return 0;
 419                 }
 420
 421                 tmp->markDepClean(m_buffer->temppath());
 422
 423 #ifdef WITH_WARNINGS
 424 #warning handle non existing files
 425 #warning Second argument is irrelevant!
 426 // since only_body is true, makeLaTeXFile will not look at second
 427 // argument. Should we set it to string(), or should makeLaTeXFile
 428 // make use of it somehow? (JMarc 20031002)
 429 #endif
 430                 // The included file might be written in a different encoding
 431                 Encoding const * const oldEnc = runparams.encoding;
 432                 runparams.encoding = &tmp->params().encoding();
 433                 tmp->makeLaTeXFile(writefile,
 434                                    onlyPath(masterFilename(buffer)),
 435                                    runparams, false);
 436                 runparams.encoding = oldEnc;
 437         } else {
 438                 // Copy the file to the temp dir, so that .aux files etc.
 439                 // are not created in the original dir. Files included by
 440                 // this file will be found via input@path, see ../buffer.C.
 441                 unsigned long const checksum_in  = sum(included_file);
 442                 unsigned long const checksum_out = sum(writefile);
 443
 444                 if (checksum_in != checksum_out) {
 445                         if (!copy(included_file, writefile)) {
 446                                 // FIXME UNICODE
 447                                 LYXERR(Debug::LATEX)
 448                                         << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
 449                                                                   "into the temporary directory."),
 450                                                    from_utf8(included_file.absFilename())))
 451                                         << endl;
 452                                 return 0;
 453                         }
 454                 }
 455         }
 456
 457         string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
 458                         "latex" : "pdflatex";
 459         if (isVerbatim(params_)) {
 460                 incfile = latex_path(incfile);
 461                 // FIXME UNICODE
 462                 os << '\\' << from_ascii(params_.getCmdName()) << '{'
 463                    << from_utf8(incfile) << '}';
 464         } else if (type(params_) == INPUT) {
 465                 runparams.exportdata->addExternalFile(tex_format, writefile,
 466                                                       exportfile);
 467
 468                 // \input wants file with extension (default is .tex)
 469                 if (!isLyXFilename(included_file.absFilename())) {
 470                         incfile = latex_path(incfile);
 471                         // FIXME UNICODE
 472                         os << '\\' << from_ascii(params_.getCmdName())
 473                            << '{' << from_utf8(incfile) << '}';
 474                 } else {
 475                 incfile = changeExtension(incfile, ".tex");
 476                 incfile = latex_path(incfile);
 477                         // FIXME UNICODE
 478                         os << '\\' << from_ascii(params_.getCmdName())
 479                            << '{' << from_utf8(incfile) <<  '}';
 480                 }
 481         } else {
 482                 runparams.exportdata->addExternalFile(tex_format, writefile,
 483                                                       exportfile);
 484
 485                 // \include don't want extension and demands that the
 486                 // file really have .tex
 487                 incfile = changeExtension(incfile, string());
 488                 incfile = latex_path(incfile);
 489                 // FIXME UNICODE
 490                 os << '\\' << from_ascii(params_.getCmdName()) << '{'
 491                    << from_utf8(incfile) << '}';
 492         }
 493
 494         return 0;
 495 }
 496
 497
 498 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
 499                             OutputParams const &) const
 500 {
 501         if (isVerbatim(params_)) {
 502                 os << '[' << getScreenLabel(buffer) << '\n';
 503                 // FIXME: We don't know the encoding of the file
 504                 docstring const str =
 505                      from_utf8(getFileContents(includedFilename(buffer, params_)));
 506                 os << str;
 507                 os << "\n]";
 508                 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 509         } else {
 510                 docstring const str = '[' + getScreenLabel(buffer) + ']';
 511                 os << str;
 512                 return str.size();
 513         }
 514 }
 515
 516
 517 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
 518                           OutputParams const & runparams) const
 519 {
 520         string incfile = to_utf8(params_["filename"]);
 521
 522         // Do nothing if no file name has been specified
 523         if (incfile.empty())
 524                 return 0;
 525
 526         string const included_file = includedFilename(buffer, params_).absFilename();
 527
 528         // write it to a file (so far the complete file)
 529         string const exportfile = changeExtension(incfile, ".sgml");
 530         DocFileName writefile(changeExtension(included_file, ".sgml"));
 531
 532         if (loadIfNeeded(buffer, params_)) {
 533                 Buffer * tmp = theBufferList().getBuffer(included_file);
 534
 535                 string const mangled = writefile.mangledFilename();
 536                 writefile = makeAbsPath(mangled,
 537                                         buffer.getMasterBuffer()->temppath());
 538                 if (!runparams.nice)
 539                         incfile = mangled;
 540
 541                 LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
 542                 LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
 543                 LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
 544
 545                 tmp->makeDocBookFile(writefile, runparams, true);
 546         }
 547
 548         runparams.exportdata->addExternalFile("docbook", writefile,
 549                                               exportfile);
 550         runparams.exportdata->addExternalFile("docbook-xml", writefile,
 551                                               exportfile);
 552
 553         if (isVerbatim(params_)) {
 554                 os << "<inlinegraphic fileref=\""
 555                    << '&' << include_label << ';'
 556                    << "\" format=\"linespecific\">";
 557         } else
 558                 os << '&' << include_label << ';';
 559
 560         return 0;
 561 }
 562
 563
 564 void InsetInclude::validate(LaTeXFeatures & features) const
 565 {
 566         string incfile(to_utf8(params_["filename"]));
 567         string writefile;
 568
 569         Buffer const & buffer = features.buffer();
 570
 571         string const included_file = includedFilename(buffer, params_).absFilename();
 572
 573         if (isLyXFilename(included_file))
 574                 writefile = changeExtension(included_file, ".sgml");
 575         else
 576                 writefile = included_file;
 577
 578         if (!features.runparams().nice && !isVerbatim(params_)) {
 579                 incfile = DocFileName(writefile).mangledFilename();
 580                 writefile = makeAbsPath(incfile,
 581                                         buffer.getMasterBuffer()->temppath()).absFilename();
 582         }
 583
 584         features.includeFile(include_label, writefile);
 585
 586         if (isVerbatim(params_))
 587                 features.require("verbatim");
 588
 589         // Here we must do the fun stuff...
 590         // Load the file in the include if it needs
 591         // to be loaded:
 592         if (loadIfNeeded(buffer, params_)) {
 593                 // a file got loaded
 594                 Buffer * const tmp = theBufferList().getBuffer(included_file);
 595                 if (tmp) {
 596                         // We must temporarily change features.buffer,
 597                         // otherwise it would always be the master buffer,
 598                         // and nested includes would not work.
 599                         features.setBuffer(*tmp);
 600                         tmp->validate(features);
 601                         features.setBuffer(buffer);
 602                 }
 603         }
 604 }
 605
 606
 607 void InsetInclude::getLabelList(Buffer const & buffer,
 608                                 std::vector<docstring> & list) const
 609 {
 610         if (loadIfNeeded(buffer, params_)) {
 611                 string const included_file = includedFilename(buffer, params_).absFilename();
 612                 Buffer * tmp = theBufferList().getBuffer(included_file);
 613                 tmp->setParentName("");
 614                 tmp->getLabelList(list);
 615                 tmp->setParentName(parentFilename(buffer));
 616         }
 617 }
 618
 619
 620 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
 621                 std::vector<std::pair<string, docstring> > & keys) const
 622 {
 623         if (loadIfNeeded(buffer, params_)) {
 624                 string const included_file = includedFilename(buffer, params_).absFilename();
 625                 Buffer * tmp = theBufferList().getBuffer(included_file);
 626                 tmp->setParentName("");
 627                 tmp->fillWithBibKeys(keys);
 628                 tmp->setParentName(parentFilename(buffer));
 629         }
 630 }
 631
 632
 633 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
 634 {
 635         Buffer * const tmp = getChildBuffer(buffer, params_);
 636         if (tmp) {
 637                 tmp->setParentName("");
 638                 tmp->updateBibfilesCache();
 639                 tmp->setParentName(parentFilename(buffer));
 640         }
 641 }
 642
 643
 644 std::vector<FileName> const &
 645 InsetInclude::getBibfilesCache(Buffer const & buffer) const
 646 {
 647         Buffer * const tmp = getChildBuffer(buffer, params_);
 648         if (tmp) {
 649                 tmp->setParentName("");
 650                 std::vector<FileName> const & cache = tmp->getBibfilesCache();
 651                 tmp->setParentName(parentFilename(buffer));
 652                 return cache;
 653         }
 654         static std::vector<FileName> const empty;
 655         return empty;
 656 }
 657
 658
 659 bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 660 {
 661         BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
 662
 663         bool use_preview = false;
 664         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
 665                 graphics::PreviewImage const * pimage =
 666                         preview_->getPreviewImage(*mi.base.bv->buffer());
 667                 use_preview = pimage && pimage->image();
 668         }
 669
 670         if (use_preview) {
 671                 preview_->metrics(mi, dim);
 672         } else {
 673                 if (!set_label_) {
 674                         set_label_ = true;
 675                         button_.update(getScreenLabel(*mi.base.bv->buffer()),
 676                                        true);
 677                 }
 678                 button_.metrics(mi, dim);
 679         }
 680
 681         Box b(0, dim.wid, -dim.asc, dim.des);
 682         button_.setBox(b);
 683
 684         bool const changed = dim_ != dim;
 685         dim_ = dim;
 686         return changed;
 687 }
 688
 689
 690 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 691 {
 692         setPosCache(pi, x, y);
 693
 694         BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
 695
 696         bool use_preview = false;
 697         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
 698                 graphics::PreviewImage const * pimage =
 699                         preview_->getPreviewImage(*pi.base.bv->buffer());
 700                 use_preview = pimage && pimage->image();
 701         }
 702
 703         if (use_preview)
 704                 preview_->draw(pi, x, y);
 705         else
 706                 button_.draw(pi, x, y);
 707 }
 708
 709 bool InsetInclude::display() const
 710 {
 711         return type(params_) != INPUT;
 712 }
 713
 714
 715
 716 //
 717 // preview stuff
 718 //
 719
 720 void InsetInclude::fileChanged() const
 721 {
 722         Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
 723         if (!buffer_ptr)
 724                 return;
 725
 726         Buffer const & buffer = *buffer_ptr;
 727         preview_->removePreview(buffer);
 728         add_preview(*preview_.get(), *this, buffer);
 729         preview_->startLoading(buffer);
 730 }
 731
 732
 733 namespace {
 734
 735 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 736 {
 737         FileName const included_file = includedFilename(buffer, params);
 738
 739         return type(params) == INPUT && params.preview() &&
 740                 isFileReadable(included_file);
 741 }
 742
 743
 744 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
 745 {
 746         odocstringstream os;
 747         // We don't need to set runparams.encoding since this will be done
 748         // by latex() anyway.
 749         OutputParams runparams(0);
 750         runparams.flavor = OutputParams::LATEX;
 751         inset.latex(buffer, os, runparams);
 752
 753         return os.str();
 754 }
 755
 756
 757 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
 758                  Buffer const & buffer)
 759 {
 760         InsetCommandParams const & params = inset.params();
 761         if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
 762             preview_wanted(params, buffer)) {
 763                 renderer.setAbsFile(includedFilename(buffer, params));
 764                 docstring const snippet = latex_string(inset, buffer);
 765                 renderer.addPreview(snippet, buffer);
 766         }
 767 }
 768
 769 } // namespace anon
 770
 771
 772 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
 773 {
 774         Buffer const & buffer = ploader.buffer();
 775         if (preview_wanted(params(), buffer)) {
 776                 preview_->setAbsFile(includedFilename(buffer, params()));
 777                 docstring const snippet = latex_string(*this, buffer);
 778                 preview_->addPreview(snippet, ploader);
 779         }
 780 }
 781
 782
 783 void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
 784 {
 785         Buffer const * const childbuffer = getChildBuffer(buffer, params_);
 786         if (!childbuffer)
 787                 return;
 788
 789         TocList const & childtoclist = childbuffer->tocBackend().tocs();
 790         TocList::const_iterator it = childtoclist.begin();
 791         TocList::const_iterator const end = childtoclist.end();
 792         for(; it != end; ++it)
 793                 toclist[it->first].insert(toclist[it->first].end(),
 794                                 it->second.begin(), it->second.end());
 795 }
 796
 797
 798 void InsetInclude::updateLabels(Buffer const & buffer) const
 799 {
 800         Buffer const * const childbuffer = getChildBuffer(buffer, params_);
 801         if (!childbuffer)
 802                 return;
 803
 804         lyx::updateLabels(*childbuffer, true);
 805 }
 806
 807
 808 string const InsetIncludeMailer::name_("include");
 809
 810 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
 811         : inset_(inset)
 812 {}
 813
 814
 815 string const InsetIncludeMailer::inset2string(Buffer const &) const
 816 {
 817         return params2string(inset_.params());
 818 }
 819
 820
 821 void InsetIncludeMailer::string2params(string const & in,
 822                                        InsetCommandParams & params)
 823 {
 824         params.clear();
 825         if (in.empty())
 826                 return;
 827
 828         istringstream data(in);
 829         LyXLex lex(0,0);
 830         lex.setStream(data);
 831
 832         string name;
 833         lex >> name;
 834         if (!lex || name != name_)
 835                 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
 836
 837         // This is part of the inset proper that is usually swallowed
 838         // by LyXText::readInset
 839         string id;
 840         lex >> id;
 841         if (!lex || id != "Include")
 842                 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
 843
 844         InsetInclude inset(params);
 845         inset.read(lex);
 846         params = inset.params();
 847 }
 848
 849
 850 string const
 851 InsetIncludeMailer::params2string(InsetCommandParams const & params)
 852 {
 853         InsetInclude inset(params);
 854         ostringstream data;
 855         data << name_ << ' ';
 856         inset.write(data);
 857         data << "\\end_inset\n";
 858         return data.str();
 859 }
 860
 861
 862 } // namespace lyx