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.next();
 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                 // FIXME: We don't know the encoding of the filename
 322                 temp += from_ascii(onlyFilename(to_utf8(params_["filename"])));
 323
 324         return temp;
 325 }
 326
 327
 328 namespace {
 329
 330 /// return the child buffer if the file is a LyX doc and is loaded
 331 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
 332 {
 333         if (isVerbatim(params))
 334                 return 0;
 335
 336         string const included_file = includedFilename(buffer, params).absFilename();
 337         if (!isLyXFilename(included_file))
 338                 return 0;
 339
 340         return theBufferList().getBuffer(included_file);
 341 }
 342
 343
 344 /// return true if the file is or got loaded.
 345 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
 346 {
 347         if (isVerbatim(params))
 348                 return false;
 349
 350         FileName const included_file = includedFilename(buffer, params);
 351         if (!isLyXFilename(included_file.absFilename()))
 352                 return false;
 353
 354         Buffer * buf = theBufferList().getBuffer(included_file.absFilename());
 355         if (!buf) {
 356                 // the readonly flag can/will be wrong, not anymore I think.
 357                 if (!fs::exists(included_file.toFilesystemEncoding()))
 358                         return false;
 359                 buf = theBufferList().newBuffer(included_file.absFilename());
 360                 if (!loadLyXFile(buf, included_file))
 361                         return false;
 362         }
 363         if (buf)
 364                 buf->setParentName(parentFilename(buffer));
 365         return buf != 0;
 366 }
 367
 368
 369 } // namespace anon
 370
 371
 372 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
 373                         OutputParams const & runparams) const
 374 {
 375         string incfile(to_utf8(params_["filename"]));
 376
 377         // Do nothing if no file name has been specified
 378         if (incfile.empty())
 379                 return 0;
 380
 381         FileName const included_file(includedFilename(buffer, params_));
 382         Buffer const * const m_buffer = buffer.getMasterBuffer();
 383
 384         // if incfile is relative, make it relative to the master
 385         // buffer directory.
 386         if (!absolutePath(incfile)) {
 387                 incfile = makeRelPath(included_file.absFilename(),
 388                                       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                 tmp->makeLaTeXFile(writefile,
 431                                    onlyPath(masterFilename(buffer)),
 432                                    runparams, false);
 433         } else {
 434                 // Copy the file to the temp dir, so that .aux files etc.
 435                 // are not created in the original dir. Files included by
 436                 // this file will be found via input@path, see ../buffer.C.
 437                 unsigned long const checksum_in  = sum(included_file);
 438                 unsigned long const checksum_out = sum(writefile);
 439
 440                 if (checksum_in != checksum_out) {
 441                         if (!copy(included_file, writefile)) {
 442                                 // FIXME UNICODE
 443                                 lyxerr[Debug::LATEX]
 444                                         << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
 445                                                                   "into the temporary directory."),
 446                                                    from_utf8(included_file.absFilename())))
 447                                         << endl;
 448                                 return 0;
 449                         }
 450                 }
 451         }
 452
 453         string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
 454                         "latex" : "pdflatex";
 455         if (isVerbatim(params_)) {
 456                 incfile = latex_path(incfile);
 457                 // FIXME UNICODE
 458                 os << '\\' << from_ascii(params_.getCmdName()) << '{'
 459                    << from_utf8(incfile) << '}';
 460         } else if (type(params_) == INPUT) {
 461                 runparams.exportdata->addExternalFile(tex_format, writefile,
 462                                                       exportfile);
 463
 464                 // \input wants file with extension (default is .tex)
 465                 if (!isLyXFilename(included_file.absFilename())) {
 466                         incfile = latex_path(incfile);
 467                         // FIXME UNICODE
 468                         os << '\\' << from_ascii(params_.getCmdName())
 469                            << '{' << from_utf8(incfile) << '}';
 470                 } else {
 471                 incfile = changeExtension(incfile, ".tex");
 472                 incfile = latex_path(incfile);
 473                         // FIXME UNICODE
 474                         os << '\\' << from_ascii(params_.getCmdName())
 475                            << '{' << from_utf8(incfile) <<  '}';
 476                 }
 477         } else {
 478                 runparams.exportdata->addExternalFile(tex_format, writefile,
 479                                                       exportfile);
 480
 481                 // \include don't want extension and demands that the
 482                 // file really have .tex
 483                 incfile = changeExtension(incfile, string());
 484                 incfile = latex_path(incfile);
 485                 // FIXME UNICODE
 486                 os << '\\' << from_ascii(params_.getCmdName()) << '{'
 487                    << from_utf8(incfile) << '}';
 488         }
 489
 490         return 0;
 491 }
 492
 493
 494 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
 495                         OutputParams const &) const
 496 {
 497         if (isVerbatim(params_)) {
 498                 // FIXME: We don't know the encoding of the file
 499                 docstring const str = from_utf8(
 500                         getFileContents(includedFilename(buffer, params_)));
 501                 os << str;
 502                 // Return how many newlines we issued.
 503                 return int(lyx::count(str.begin(), str.end(), '\n'));
 504         }
 505         return 0;
 506 }
 507
 508
 509 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
 510                           OutputParams const & runparams) const
 511 {
 512         string incfile = to_utf8(params_["filename"]);
 513
 514         // Do nothing if no file name has been specified
 515         if (incfile.empty())
 516                 return 0;
 517
 518         string const included_file = includedFilename(buffer, params_).absFilename();
 519
 520         // write it to a file (so far the complete file)
 521         string const exportfile = changeExtension(incfile, ".sgml");
 522         DocFileName writefile(changeExtension(included_file, ".sgml"));
 523
 524         if (loadIfNeeded(buffer, params_)) {
 525                 Buffer * tmp = theBufferList().getBuffer(included_file);
 526
 527                 string const mangled = writefile.mangledFilename();
 528                 writefile = makeAbsPath(mangled,
 529                                         buffer.getMasterBuffer()->temppath());
 530                 if (!runparams.nice)
 531                         incfile = mangled;
 532
 533                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 534                 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
 535                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 536
 537                 tmp->makeDocBookFile(writefile, runparams, true);
 538         }
 539
 540         runparams.exportdata->addExternalFile("docbook", writefile,
 541                                               exportfile);
 542         runparams.exportdata->addExternalFile("docbook-xml", writefile,
 543                                               exportfile);
 544
 545         if (isVerbatim(params_)) {
 546                 os << "<inlinegraphic fileref=\""
 547                    << '&' << include_label << ';'
 548                    << "\" format=\"linespecific\">";
 549         } else
 550                 os << '&' << include_label << ';';
 551
 552         return 0;
 553 }
 554
 555
 556 void InsetInclude::validate(LaTeXFeatures & features) const
 557 {
 558         string incfile(to_utf8(params_["filename"]));
 559         string writefile;
 560
 561         Buffer const & buffer = features.buffer();
 562
 563         string const included_file = includedFilename(buffer, params_).absFilename();
 564
 565         if (isLyXFilename(included_file))
 566                 writefile = changeExtension(included_file, ".sgml");
 567         else
 568                 writefile = included_file;
 569
 570         if (!features.runparams().nice && !isVerbatim(params_)) {
 571                 incfile = DocFileName(writefile).mangledFilename();
 572                 writefile = makeAbsPath(incfile,
 573                                         buffer.getMasterBuffer()->temppath()).absFilename();
 574         }
 575
 576         features.includeFile(include_label, writefile);
 577
 578         if (isVerbatim(params_))
 579                 features.require("verbatim");
 580
 581         // Here we must do the fun stuff...
 582         // Load the file in the include if it needs
 583         // to be loaded:
 584         if (loadIfNeeded(buffer, params_)) {
 585                 // a file got loaded
 586                 Buffer * const tmp = theBufferList().getBuffer(included_file);
 587                 if (tmp) {
 588                         // We must temporarily change features.buffer,
 589                         // otherwise it would always be the master buffer,
 590                         // and nested includes would not work.
 591                         features.setBuffer(*tmp);
 592                         tmp->validate(features);
 593                         features.setBuffer(buffer);
 594                 }
 595         }
 596 }
 597
 598
 599 void InsetInclude::getLabelList(Buffer const & buffer,
 600                                 std::vector<docstring> & list) const
 601 {
 602         if (loadIfNeeded(buffer, params_)) {
 603                 string const included_file = includedFilename(buffer, params_).absFilename();
 604                 Buffer * tmp = theBufferList().getBuffer(included_file);
 605                 tmp->setParentName("");
 606                 tmp->getLabelList(list);
 607                 tmp->setParentName(parentFilename(buffer));
 608         }
 609 }
 610
 611
 612 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
 613                 std::vector<std::pair<string, docstring> > & keys) const
 614 {
 615         if (loadIfNeeded(buffer, params_)) {
 616                 string const included_file = includedFilename(buffer, params_).absFilename();
 617                 Buffer * tmp = theBufferList().getBuffer(included_file);
 618                 tmp->setParentName("");
 619                 tmp->fillWithBibKeys(keys);
 620                 tmp->setParentName(parentFilename(buffer));
 621         }
 622 }
 623
 624
 625 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
 626 {
 627         Buffer * const tmp = getChildBuffer(buffer, params_);
 628         if (tmp) {
 629                 tmp->setParentName("");
 630                 tmp->updateBibfilesCache();
 631                 tmp->setParentName(parentFilename(buffer));
 632         }
 633 }
 634
 635
 636 std::vector<FileName> const &
 637 InsetInclude::getBibfilesCache(Buffer const & buffer) const
 638 {
 639         Buffer * const tmp = getChildBuffer(buffer, params_);
 640         if (tmp) {
 641                 tmp->setParentName("");
 642                 std::vector<FileName> const & cache = tmp->getBibfilesCache();
 643                 tmp->setParentName(parentFilename(buffer));
 644                 return cache;
 645         }
 646         static std::vector<FileName> const empty;
 647         return empty;
 648 }
 649
 650
 651 bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 652 {
 653         BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
 654
 655         bool use_preview = false;
 656         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
 657                 graphics::PreviewImage const * pimage =
 658                         preview_->getPreviewImage(*mi.base.bv->buffer());
 659                 use_preview = pimage && pimage->image();
 660         }
 661
 662         if (use_preview) {
 663                 preview_->metrics(mi, dim);
 664         } else {
 665                 if (!set_label_) {
 666                         set_label_ = true;
 667                         button_.update(getScreenLabel(*mi.base.bv->buffer()),
 668                                        true);
 669                 }
 670                 button_.metrics(mi, dim);
 671         }
 672
 673         Box b(0, dim.wid, -dim.asc, dim.des);
 674         button_.setBox(b);
 675
 676         bool const changed = dim_ != dim;
 677         dim_ = dim;
 678         return changed;
 679 }
 680
 681
 682 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 683 {
 684         setPosCache(pi, x, y);
 685
 686         BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
 687
 688         bool use_preview = false;
 689         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
 690                 graphics::PreviewImage const * pimage =
 691                         preview_->getPreviewImage(*pi.base.bv->buffer());
 692                 use_preview = pimage && pimage->image();
 693         }
 694
 695         if (use_preview)
 696                 preview_->draw(pi, x, y);
 697         else
 698                 button_.draw(pi, x, y);
 699 }
 700
 701 bool InsetInclude::display() const
 702 {
 703         return type(params_) != INPUT;
 704 }
 705
 706
 707
 708 //
 709 // preview stuff
 710 //
 711
 712 void InsetInclude::fileChanged() const
 713 {
 714         Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
 715         if (!buffer_ptr)
 716                 return;
 717
 718         Buffer const & buffer = *buffer_ptr;
 719         preview_->removePreview(buffer);
 720         add_preview(*preview_.get(), *this, buffer);
 721         preview_->startLoading(buffer);
 722 }
 723
 724
 725 namespace {
 726
 727 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 728 {
 729         FileName const included_file = includedFilename(buffer, params);
 730
 731         return type(params) == INPUT && params.preview() &&
 732                 isFileReadable(included_file);
 733 }
 734
 735
 736 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
 737 {
 738         odocstringstream os;
 739         OutputParams runparams;
 740         runparams.flavor = OutputParams::LATEX;
 741         inset.latex(buffer, os, runparams);
 742
 743         return os.str();
 744 }
 745
 746
 747 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
 748                  Buffer const & buffer)
 749 {
 750         InsetCommandParams const & params = inset.params();
 751         if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
 752             preview_wanted(params, buffer)) {
 753                 renderer.setAbsFile(includedFilename(buffer, params));
 754                 docstring const snippet = latex_string(inset, buffer);
 755                 renderer.addPreview(snippet, buffer);
 756         }
 757 }
 758
 759 } // namespace anon
 760
 761
 762 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
 763 {
 764         Buffer const & buffer = ploader.buffer();
 765         if (preview_wanted(params(), buffer)) {
 766                 preview_->setAbsFile(includedFilename(buffer, params()));
 767                 docstring const snippet = latex_string(*this, buffer);
 768                 preview_->addPreview(snippet, ploader);
 769         }
 770 }
 771
 772
 773 void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
 774 {
 775         Buffer const * const childbuffer = getChildBuffer(buffer, params_);
 776         if (!childbuffer)
 777                 return;
 778
 779         TocList const & childtoclist = childbuffer->tocBackend().tocs();
 780         TocList::const_iterator it = childtoclist.begin();
 781         TocList::const_iterator const end = childtoclist.end();
 782         for(; it != end; ++it)
 783                 toclist[it->first].insert(toclist[it->first].end(),
 784                                 it->second.begin(), it->second.end());
 785 }
 786
 787
 788 void InsetInclude::updateLabels(Buffer const & buffer) const
 789 {
 790         Buffer const * const childbuffer = getChildBuffer(buffer, params_);
 791         if (!childbuffer)
 792                 return;
 793
 794         lyx::updateLabels(*childbuffer, true);
 795 }
 796
 797
 798 string const InsetIncludeMailer::name_("include");
 799
 800 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
 801         : inset_(inset)
 802 {}
 803
 804
 805 string const InsetIncludeMailer::inset2string(Buffer const &) const
 806 {
 807         return params2string(inset_.params());
 808 }
 809
 810
 811 void InsetIncludeMailer::string2params(string const & in,
 812                                        InsetCommandParams & params)
 813 {
 814         params.clear();
 815         if (in.empty())
 816                 return;
 817
 818         istringstream data(in);
 819         LyXLex lex(0,0);
 820         lex.setStream(data);
 821
 822         string name;
 823         lex >> name;
 824         if (!lex || name != name_)
 825                 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
 826
 827         // This is part of the inset proper that is usually swallowed
 828         // by LyXText::readInset
 829         string id;
 830         lex >> id;
 831         if (!lex || id != "Include")
 832                 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
 833
 834         InsetInclude inset(params);
 835         inset.read(lex);
 836         params = inset.params();
 837 }
 838
 839
 840 string const
 841 InsetIncludeMailer::params2string(InsetCommandParams const & params)
 842 {
 843         InsetInclude inset(params);
 844         ostringstream data;
 845         data << name_ << ' ';
 846         inset.write(data);
 847         data << "\\end_inset\n";
 848         return data.str();
 849 }
 850
 851
 852 } // namespace lyx