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