src/insets/InsetInclude.cpp

   1 /**
   2  * \file InsetInclude.cpp
   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  * \author Richard Heck (conversion to InsetCommand)
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetInclude.h"
  15
  16 #include "Buffer.h"
  17 #include "buffer_funcs.h"
  18 #include "BufferList.h"
  19 #include "BufferParams.h"
  20 #include "BufferView.h"
  21 #include "Cursor.h"
  22 #include "DispatchResult.h"
  23 #include "ErrorList.h"
  24 #include "Exporter.h"
  25 #include "Format.h"
  26 #include "FuncRequest.h"
  27 #include "FuncStatus.h"
  28 #include "LaTeXFeatures.h"
  29 #include "LayoutFile.h"
  30 #include "LayoutModuleList.h"
  31 #include "LyX.h"
  32 #include "LyXFunc.h"
  33 #include "LyXRC.h"
  34 #include "Lexer.h"
  35 #include "MetricsInfo.h"
  36 #include "OutputParams.h"
  37 #include "TextClass.h"
  38 #include "TocBackend.h"
  39
  40 #include "frontends/alert.h"
  41 #include "frontends/Painter.h"
  42
  43 #include "graphics/PreviewImage.h"
  44 #include "graphics/PreviewLoader.h"
  45
  46 #include "insets/InsetLabel.h"
  47 #include "insets/InsetListingsParams.h"
  48 #include "insets/RenderPreview.h"
  49
  50 #include "support/convert.h"
  51 #include "support/debug.h"
  52 #include "support/docstream.h"
  53 #include "support/FileNameList.h"
  54 #include "support/filetools.h"
  55 #include "support/gettext.h"
  56 #include "support/lassert.h"
  57 #include "support/lstrings.h" // contains
  58 #include "support/lyxalgo.h"
  59
  60 #include <boost/bind.hpp>
  61
  62 using namespace std;
  63 using namespace lyx::support;
  64
  65 namespace lyx {
  66
  67 namespace Alert = frontend::Alert;
  68
  69
  70 namespace {
  71
  72 docstring const uniqueID()
  73 {
  74         static unsigned int seed = 1000;
  75         return "file" + convert<docstring>(++seed);
  76 }
  77
  78
  79 /// the type of inclusion
  80 enum Types {
  81         INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
  82 };
  83
  84
  85 Types type(string const & s)
  86 {
  87         if (s == "input")
  88                 return INPUT;
  89         if (s == "verbatiminput")
  90                 return VERB;
  91         if (s == "verbatiminput*")
  92                 return VERBAST;
  93         if (s == "lstinputlisting")
  94                 return LISTINGS;
  95         if (s == "include")
  96                 return INCLUDE;
  97         return NONE;
  98 }
  99
 100
 101 Types type(InsetCommandParams const & params)
 102 {
 103         return type(params.getCmdName());
 104 }
 105
 106
 107 bool isListings(InsetCommandParams const & params)
 108 {
 109         return type(params) == LISTINGS;
 110 }
 111
 112
 113 bool isVerbatim(InsetCommandParams const & params)
 114 {
 115         Types const t = type(params);
 116         return t == VERB || t == VERBAST;
 117 }
 118
 119
 120 bool isInputOrInclude(InsetCommandParams const & params)
 121 {
 122         Types const t = type(params);
 123         return t == INPUT || t == INCLUDE;
 124 }
 125
 126
 127 FileName const masterFileName(Buffer const & buffer)
 128 {
 129         return buffer.masterBuffer()->fileName();
 130 }
 131
 132
 133 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
 134
 135
 136 string const parentFilename(Buffer const & buffer)
 137 {
 138         return buffer.absFileName();
 139 }
 140
 141
 142 FileName const includedFilename(Buffer const & buffer,
 143                               InsetCommandParams const & params)
 144 {
 145         return makeAbsPath(to_utf8(params["filename"]),
 146                         onlyPath(parentFilename(buffer)));
 147 }
 148
 149
 150 InsetLabel * createLabel(docstring const & label_str)
 151 {
 152         if (label_str.empty())
 153                 return 0;
 154         InsetCommandParams icp(LABEL_CODE);
 155         icp["name"] = label_str;
 156         return new InsetLabel(icp);
 157 }
 158
 159 } // namespace anon
 160
 161
 162 InsetInclude::InsetInclude(InsetCommandParams const & p)
 163         : InsetCommand(p, "include"), include_label(uniqueID()),
 164           preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
 165           set_label_(false), label_(0), child_buffer_(0)
 166 {
 167         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 168
 169         if (isListings(params())) {
 170                 InsetListingsParams listing_params(to_utf8(p["lstparams"]));
 171                 label_ = createLabel(from_utf8(listing_params.getParamValue("label")));
 172         }
 173 }
 174
 175
 176 InsetInclude::InsetInclude(InsetInclude const & other)
 177         : InsetCommand(other), include_label(other.include_label),
 178           preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
 179           set_label_(false), label_(0), child_buffer_(0)
 180 {
 181         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 182
 183         if (other.label_)
 184                 label_ = new InsetLabel(*other.label_);
 185 }
 186
 187
 188 InsetInclude::~InsetInclude()
 189 {
 190         delete label_;
 191 }
 192
 193
 194 void InsetInclude::setBuffer(Buffer & buffer)
 195 {
 196         InsetCommand::setBuffer(buffer);
 197         if (label_)
 198                 label_->setBuffer(buffer);
 199 }
 200
 201
 202 ParamInfo const & InsetInclude::findInfo(string const & /* cmdName */)
 203 {
 204         // FIXME
 205         // This is only correct for the case of listings, but it'll do for now.
 206         // In the other cases, this second parameter should just be empty.
 207         static ParamInfo param_info_;
 208         if (param_info_.empty()) {
 209                 param_info_.add("filename", ParamInfo::LATEX_REQUIRED);
 210                 param_info_.add("lstparams", ParamInfo::LATEX_OPTIONAL);
 211         }
 212         return param_info_;
 213 }
 214
 215
 216 bool InsetInclude::isCompatibleCommand(string const & s)
 217 {
 218         return type(s) != NONE;
 219 }
 220
 221
 222 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
 223 {
 224         switch (cmd.action) {
 225
 226         case LFUN_INSET_EDIT: {
 227                 editIncluded(to_utf8(params()["filename"]));
 228                 break;
 229         }
 230
 231         case LFUN_INSET_MODIFY: {
 232                 // It should be OK just to invalidate the cache is setParams()
 233                 // If not....
 234                 // child_buffer_ = 0;
 235                 InsetCommandParams p(INCLUDE_CODE);
 236                 if (cmd.getArg(0) == "changetype") {
 237                         InsetCommand::doDispatch(cur, cmd);
 238                         p = params();
 239                 } else
 240                         InsetCommand::string2params("include", to_utf8(cmd.argument()), p);
 241                 if (!p.getCmdName().empty()) {
 242                         if (isListings(p)){
 243                                 InsetListingsParams new_params(to_utf8(p["lstparams"]));
 244                                 docstring const new_label =
 245                                         from_utf8(new_params.getParamValue("label"));
 246
 247                                 if (new_label.empty()) {
 248                                         delete label_;
 249                                         label_ = 0;
 250                                 } else {
 251                                         docstring old_label;
 252                                         if (label_)
 253                                                 old_label = label_->getParam("name");
 254                                         else {
 255                                                 label_ = createLabel(new_label);
 256                                                 label_->setBuffer(buffer());
 257                                         }
 258
 259                                         if (new_label != old_label) {
 260                                                 label_->updateCommand(new_label);
 261                                                 // the label might have been adapted (duplicate)
 262                                                 if (new_label != label_->getParam("name")) {
 263                                                         new_params.addParam("label", "{" +
 264                                                                 to_utf8(label_->getParam("name")) + "}", true);
 265                                                         p["lstparams"] = from_utf8(new_params.params());
 266                                                 }
 267                                         }
 268                                 }
 269                         }
 270                         setParams(p);
 271                 } else
 272                         cur.noUpdate();
 273                 break;
 274         }
 275
 276         //pass everything else up the chain
 277         default:
 278                 InsetCommand::doDispatch(cur, cmd);
 279                 break;
 280         }
 281 }
 282
 283
 284 void InsetInclude::editIncluded(string const & file)
 285 {
 286         string const ext = support::getExtension(file);
 287         if (ext == "lyx") {
 288                 FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, file);
 289                 lyx::dispatch(fr);
 290         } else
 291                 // tex file or other text file in verbatim mode
 292                 formats.edit(buffer(),
 293                         support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
 294                         "text");
 295 }
 296
 297
 298 bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
 299                 FuncStatus & flag) const
 300 {
 301         switch (cmd.action) {
 302
 303         case LFUN_INSET_EDIT:
 304                 flag.setEnabled(true);
 305                 return true;
 306
 307         case LFUN_INSET_MODIFY:
 308                 if (cmd.getArg(0) == "changetype")
 309                         return InsetCommand::getStatus(cur, cmd, flag);
 310                 else
 311                         flag.setEnabled(true);
 312                 return true;
 313
 314         default:
 315                 return InsetCommand::getStatus(cur, cmd, flag);
 316         }
 317 }
 318
 319
 320 void InsetInclude::setParams(InsetCommandParams const & p)
 321 {
 322         // invalidate the cache
 323         child_buffer_ = 0;
 324
 325         InsetCommand::setParams(p);
 326         set_label_ = false;
 327
 328         if (preview_->monitoring())
 329                 preview_->stopMonitoring();
 330
 331         if (type(params()) == INPUT)
 332                 add_preview(*preview_, *this, buffer());
 333
 334         buffer().updateBibfilesCache();
 335 }
 336
 337
 338 docstring InsetInclude::screenLabel() const
 339 {
 340         docstring temp;
 341
 342         switch (type(params())) {
 343                 case INPUT:
 344                         temp = buffer().B_("Input");
 345                         break;
 346                 case VERB:
 347                         temp = buffer().B_("Verbatim Input");
 348                         break;
 349                 case VERBAST:
 350                         temp = buffer().B_("Verbatim Input*");
 351                         break;
 352                 case INCLUDE:
 353                         temp = buffer().B_("Include");
 354                         break;
 355                 case LISTINGS:
 356                         temp = listings_label_;
 357                         break;
 358                 case NONE:
 359                         LASSERT(false, /**/);
 360         }
 361
 362         temp += ": ";
 363
 364         if (params()["filename"].empty())
 365                 temp += "???";
 366         else
 367                 temp += from_utf8(onlyFilename(to_utf8(params()["filename"])));
 368
 369         return temp;
 370 }
 371
 372
 373 Buffer * InsetInclude::getChildBuffer() const
 374 {
 375         Buffer * childBuffer = loadIfNeeded();
 376
 377         // FIXME: recursive includes
 378         return (childBuffer == &buffer()) ? 0 : childBuffer;
 379 }
 380
 381
 382 Buffer * InsetInclude::loadIfNeeded() const
 383 {
 384         // Don't try to load it again if we failed before.
 385         if (failedtoload_ || isVerbatim(params()) || isListings(params()))
 386                 return 0;
 387
 388         // Use cached Buffer if possible.
 389         if (child_buffer_ != 0) {
 390                 if (theBufferList().isLoaded(child_buffer_))
 391                         return child_buffer_;
 392                 // Buffer vanished, so invalidate cache and try to reload.
 393                 child_buffer_ = 0;
 394         }
 395
 396         string const parent_filename = buffer().absFileName();
 397         FileName const included_file =
 398                 makeAbsPath(to_utf8(params()["filename"]), onlyPath(parent_filename));
 399
 400         if (!isLyXFilename(included_file.absFilename()))
 401                 return 0;
 402
 403         Buffer * child = theBufferList().getBuffer(included_file);
 404         if (!child) {
 405                 // the readonly flag can/will be wrong, not anymore I think.
 406                 if (!included_file.exists())
 407                         return 0;
 408
 409                 child = theBufferList().newBuffer(included_file.absFilename());
 410                 if (!child)
 411                         // Buffer creation is not possible.
 412                         return 0;
 413
 414                 if (!child->loadLyXFile(included_file)) {
 415                         failedtoload_ = true;
 416                         //close the buffer we just opened
 417                         theBufferList().release(child);
 418                         return 0;
 419                 }
 420
 421                 if (!child->errorList("Parse").empty()) {
 422                         // FIXME: Do something.
 423                 }
 424         }
 425         child->setParent(&buffer());
 426         // Cache the child buffer.
 427         child_buffer_ = child;
 428         return child;
 429 }
 430
 431
 432 int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
 433 {
 434         string incfile = to_utf8(params()["filename"]);
 435
 436         // Do nothing if no file name has been specified
 437         if (incfile.empty())
 438                 return 0;
 439
 440         FileName const included_file = includedFilename(buffer(), params());
 441
 442         // Check we're not trying to include ourselves.
 443         // FIXME RECURSIVE INCLUDE
 444         // This isn't sufficient, as the inclusion could be downstream.
 445         // But it'll have to do for now.
 446         if (isInputOrInclude(params()) &&
 447                 buffer().absFileName() == included_file.absFilename())
 448         {
 449                 Alert::error(_("Recursive input"),
 450                                bformat(_("Attempted to include file %1$s in itself! "
 451                                "Ignoring inclusion."), from_utf8(incfile)));
 452                 return 0;
 453         }
 454
 455         Buffer const * const masterBuffer = buffer().masterBuffer();
 456
 457         // if incfile is relative, make it relative to the master
 458         // buffer directory.
 459         if (!FileName::isAbsolute(incfile)) {
 460                 // FIXME UNICODE
 461                 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
 462                                               from_utf8(masterBuffer->filePath())));
 463         }
 464
 465         // write it to a file (so far the complete file)
 466         string exportfile;
 467         string mangled;
 468         // bug 5681
 469         if (type(params()) == LISTINGS) {
 470                 exportfile = incfile;
 471                 mangled = DocFileName(included_file).mangledFilename();
 472         } else {
 473                 exportfile = changeExtension(incfile, ".tex");
 474                 mangled = DocFileName(changeExtension(included_file.absFilename(), ".tex")).
 475                         mangledFilename();
 476         }
 477
 478         FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
 479
 480         if (!runparams.nice)
 481                 incfile = mangled;
 482         else if (!isValidLaTeXFilename(incfile)) {
 483                 frontend::Alert::warning(_("Invalid filename"),
 484                                          _("The following filename is likely to cause trouble "
 485                                            "when running the exported file through LaTeX: ") +
 486                                             from_utf8(incfile));
 487         }
 488         LYXERR(Debug::LATEX, "incfile:" << incfile);
 489         LYXERR(Debug::LATEX, "exportfile:" << exportfile);
 490         LYXERR(Debug::LATEX, "writefile:" << writefile);
 491
 492         if (runparams.inComment || runparams.dryrun) {
 493                 //Don't try to load or copy the file if we're
 494                 //in a comment or doing a dryrun
 495         } else if (isInputOrInclude(params()) &&
 496                  isLyXFilename(included_file.absFilename())) {
 497                 //if it's a LyX file and we're inputting or including,
 498                 //try to load it so we can write the associated latex
 499                 if (!loadIfNeeded())
 500                         return false;
 501
 502                 Buffer * tmp = theBufferList().getBuffer(included_file);
 503
 504                 if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
 505                         // FIXME UNICODE
 506                         docstring text = bformat(_("Included file `%1$s'\n"
 507                                 "has textclass `%2$s'\n"
 508                                 "while parent file has textclass `%3$s'."),
 509                                 included_file.displayName(),
 510                                 from_utf8(tmp->params().documentClass().name()),
 511                                 from_utf8(masterBuffer->params().documentClass().name()));
 512                         Alert::warning(_("Different textclasses"), text, true);
 513                 }
 514
 515                 // Make sure modules used in child are all included in master
 516                 // FIXME It might be worth loading the children's modules into the master
 517                 // over in BufferParams rather than doing this check.
 518                 LayoutModuleList const masterModules = masterBuffer->params().getModules();
 519                 LayoutModuleList const childModules = tmp->params().getModules();
 520                 LayoutModuleList::const_iterator it = childModules.begin();
 521                 LayoutModuleList::const_iterator end = childModules.end();
 522                 for (; it != end; ++it) {
 523                         string const module = *it;
 524                         LayoutModuleList::const_iterator found =
 525                                 find(masterModules.begin(), masterModules.end(), module);
 526                         if (found == masterModules.end()) {
 527                                 docstring text = bformat(_("Included file `%1$s'\n"
 528                                         "uses module `%2$s'\n"
 529                                         "which is not used in parent file."),
 530                                         included_file.displayName(), from_utf8(module));
 531                                 Alert::warning(_("Module not found"), text);
 532                         }
 533                 }
 534
 535                 tmp->markDepClean(masterBuffer->temppath());
 536
 537                 // FIXME: handle non existing files
 538                 // FIXME: Second argument is irrelevant!
 539                 // since only_body is true, makeLaTeXFile will not look at second
 540                 // argument. Should we set it to string(), or should makeLaTeXFile
 541                 // make use of it somehow? (JMarc 20031002)
 542                 // The included file might be written in a different encoding
 543                 Encoding const * const oldEnc = runparams.encoding;
 544                 runparams.encoding = &tmp->params().encoding();
 545                 tmp->makeLaTeXFile(writefile,
 546                                    masterFileName(buffer()).onlyPath().absFilename(),
 547                                    runparams, false);
 548                 runparams.encoding = oldEnc;
 549         } else {
 550                 // In this case, it's not a LyX file, so we copy the file
 551                 // to the temp dir, so that .aux files etc. are not created
 552                 // in the original dir. Files included by this file will be
 553                 // found via input@path, see ../Buffer.cpp.
 554                 unsigned long const checksum_in  = included_file.checksum();
 555                 unsigned long const checksum_out = writefile.checksum();
 556
 557                 if (checksum_in != checksum_out) {
 558                         if (!included_file.copyTo(writefile)) {
 559                                 // FIXME UNICODE
 560                                 LYXERR(Debug::LATEX,
 561                                         to_utf8(bformat(_("Could not copy the file\n%1$s\n"
 562                                                                   "into the temporary directory."),
 563                                                    from_utf8(included_file.absFilename()))));
 564                                 return 0;
 565                         }
 566                 }
 567         }
 568
 569         string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
 570                         "latex" : "pdflatex";
 571         switch (type(params())) {
 572         case VERB:
 573         case VERBAST: {
 574                 incfile = latex_path(incfile);
 575                 // FIXME UNICODE
 576                 os << '\\' << from_ascii(params().getCmdName()) << '{'
 577                    << from_utf8(incfile) << '}';
 578                 break;
 579         }
 580         case INPUT: {
 581                 runparams.exportdata->addExternalFile(tex_format, writefile,
 582                                                       exportfile);
 583
 584                 // \input wants file with extension (default is .tex)
 585                 if (!isLyXFilename(included_file.absFilename())) {
 586                         incfile = latex_path(incfile);
 587                         // FIXME UNICODE
 588                         os << '\\' << from_ascii(params().getCmdName())
 589                            << '{' << from_utf8(incfile) << '}';
 590                 } else {
 591                 incfile = changeExtension(incfile, ".tex");
 592                 incfile = latex_path(incfile);
 593                         // FIXME UNICODE
 594                         os << '\\' << from_ascii(params().getCmdName())
 595                            << '{' << from_utf8(incfile) <<  '}';
 596                 }
 597                 break;
 598         }
 599         case LISTINGS: {
 600                 os << '\\' << from_ascii(params().getCmdName());
 601                 string const opt = to_utf8(params()["lstparams"]);
 602                 // opt is set in QInclude dialog and should have passed validation.
 603                 InsetListingsParams params(opt);
 604                 if (!params.params().empty())
 605                         os << "[" << from_utf8(params.params()) << "]";
 606                 os << '{'  << from_utf8(incfile) << '}';
 607                 break;
 608         }
 609         case INCLUDE: {
 610                 runparams.exportdata->addExternalFile(tex_format, writefile,
 611                                                       exportfile);
 612
 613                 // \include don't want extension and demands that the
 614                 // file really have .tex
 615                 incfile = changeExtension(incfile, string());
 616                 incfile = latex_path(incfile);
 617                 // FIXME UNICODE
 618                 os << '\\' << from_ascii(params().getCmdName()) << '{'
 619                    << from_utf8(incfile) << '}';
 620                 break;
 621         }
 622         case NONE:
 623                 break;
 624         }
 625
 626         return 0;
 627 }
 628
 629
 630 docstring InsetInclude::xhtml(odocstream & os, OutputParams const &rp) const
 631 {
 632         if (rp.inComment)
 633                  return docstring();
 634
 635         // For verbatim and listings, we just include the contents of the file as-is.
 636         // In the case of listings, we wrap it in <pre>.
 637         bool const listing = isListings(params());
 638         if (listing || isVerbatim(params())) {
 639                 if (listing)
 640                         os << "<pre>\n";
 641                 // FIXME: We don't know the encoding of the file, default to UTF-8.
 642                 os << includedFilename(buffer(), params()).fileContents("UTF-8");
 643                 if (listing)
 644                         os << "</pre>\n";
 645                 return docstring();
 646         }
 647
 648         // We don't (yet) know how to Input or Include non-LyX files.
 649         // (If we wanted to get really arcane, we could run some tex2html
 650         // converter on the included file. But that's just masochistic.)
 651         string const parent_filename = buffer().absFileName();
 652         FileName const included_file =
 653                 makeAbsPath(to_utf8(params()["filename"]), onlyPath(parent_filename));
 654         if (!isLyXFilename(included_file.absFilename())) {
 655                 frontend::Alert::warning(_("Unsupported Inclusion"),
 656                                          _("LyX does not know how to include non-LyX files when "
 657                                            "generating HTML output. Offending file: ") +
 658                                             params()["filename"]);
 659                 return docstring();
 660         }
 661
 662         // In the other cases, we will generate the HTML and include it.
 663
 664         // Check we're not trying to include ourselves.
 665         // FIXME RECURSIVE INCLUDE
 666         if (buffer().absFileName() == included_file.absFilename()) {
 667                 Alert::error(_("Recursive input"),
 668                                bformat(_("Attempted to include file %1$s in itself! "
 669                                "Ignoring inclusion."), params()["filename"]));
 670                 return docstring();
 671         }
 672
 673         Buffer const * const ibuf = loadIfNeeded();
 674         if (!ibuf)
 675                 return docstring();
 676         ibuf->writeLyXHTMLSource(os, rp, true);
 677         return docstring();
 678 }
 679
 680
 681 int InsetInclude::plaintext(odocstream & os, OutputParams const &) const
 682 {
 683         if (isVerbatim(params()) || isListings(params())) {
 684                 os << '[' << screenLabel() << '\n';
 685                 // FIXME: We don't know the encoding of the file, default to UTF-8.
 686                 os << includedFilename(buffer(), params()).fileContents("UTF-8");
 687                 os << "\n]";
 688                 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 689         } else {
 690                 docstring const str = '[' + screenLabel() + ']';
 691                 os << str;
 692                 return str.size();
 693         }
 694 }
 695
 696
 697 int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
 698 {
 699         string incfile = to_utf8(params()["filename"]);
 700
 701         // Do nothing if no file name has been specified
 702         if (incfile.empty())
 703                 return 0;
 704
 705         string const included_file = includedFilename(buffer(), params()).absFilename();
 706
 707         // Check we're not trying to include ourselves.
 708         // FIXME RECURSIVE INCLUDE
 709         // This isn't sufficient, as the inclusion could be downstream.
 710         // But it'll have to do for now.
 711         if (buffer().absFileName() == included_file) {
 712                 Alert::error(_("Recursive input"),
 713                                bformat(_("Attempted to include file %1$s in itself! "
 714                                "Ignoring inclusion."), from_utf8(incfile)));
 715                 return 0;
 716         }
 717
 718         // write it to a file (so far the complete file)
 719         string const exportfile = changeExtension(incfile, ".sgml");
 720         DocFileName writefile(changeExtension(included_file, ".sgml"));
 721
 722         if (loadIfNeeded()) {
 723                 Buffer * tmp = theBufferList().getBuffer(FileName(included_file));
 724
 725                 string const mangled = writefile.mangledFilename();
 726                 writefile = makeAbsPath(mangled,
 727                                         buffer().masterBuffer()->temppath());
 728                 if (!runparams.nice)
 729                         incfile = mangled;
 730
 731                 LYXERR(Debug::LATEX, "incfile:" << incfile);
 732                 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
 733                 LYXERR(Debug::LATEX, "writefile:" << writefile);
 734
 735                 tmp->makeDocBookFile(writefile, runparams, true);
 736         }
 737
 738         runparams.exportdata->addExternalFile("docbook", writefile,
 739                                               exportfile);
 740         runparams.exportdata->addExternalFile("docbook-xml", writefile,
 741                                               exportfile);
 742
 743         if (isVerbatim(params()) || isListings(params())) {
 744                 os << "<inlinegraphic fileref=\""
 745                    << '&' << include_label << ';'
 746                    << "\" format=\"linespecific\">";
 747         } else
 748                 os << '&' << include_label << ';';
 749
 750         return 0;
 751 }
 752
 753
 754 void InsetInclude::validate(LaTeXFeatures & features) const
 755 {
 756         string incfile = to_utf8(params()["filename"]);
 757         string writefile;
 758
 759         LASSERT(&buffer() == &features.buffer(), /**/);
 760
 761         string const included_file =
 762                 includedFilename(buffer(), params()).absFilename();
 763
 764         if (isLyXFilename(included_file))
 765                 writefile = changeExtension(included_file, ".sgml");
 766         else
 767                 writefile = included_file;
 768
 769         if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
 770                 incfile = DocFileName(writefile).mangledFilename();
 771                 writefile = makeAbsPath(incfile,
 772                                         buffer().masterBuffer()->temppath()).absFilename();
 773         }
 774
 775         features.includeFile(include_label, writefile);
 776
 777         if (isVerbatim(params()))
 778                 features.require("verbatim");
 779         else if (isListings(params()))
 780                 features.require("listings");
 781
 782         // Here we must do the fun stuff...
 783         // Load the file in the include if it needs
 784         // to be loaded:
 785         if (loadIfNeeded()) {
 786                 // a file got loaded
 787                 Buffer * const tmp = theBufferList().getBuffer(FileName(included_file));
 788                 // make sure the buffer isn't us
 789                 // FIXME RECURSIVE INCLUDES
 790                 // This is not sufficient, as recursive includes could be
 791                 // more than a file away. But it will do for now.
 792                 if (tmp && tmp != &buffer()) {
 793                         // We must temporarily change features.buffer,
 794                         // otherwise it would always be the master buffer,
 795                         // and nested includes would not work.
 796                         features.setBuffer(*tmp);
 797                         tmp->validate(features);
 798                         features.setBuffer(buffer());
 799                 }
 800         }
 801 }
 802
 803
 804 void InsetInclude::fillWithBibKeys(BiblioInfo & keys,
 805         InsetIterator const & /*di*/) const
 806 {
 807         if (loadIfNeeded()) {
 808                 string const included_file = includedFilename(buffer(), params()).absFilename();
 809                 Buffer * tmp = theBufferList().getBuffer(FileName(included_file));
 810                 BiblioInfo const & newkeys = tmp->localBibInfo();
 811                 keys.mergeBiblioInfo(newkeys);
 812         }
 813 }
 814
 815
 816 void InsetInclude::updateBibfilesCache()
 817 {
 818         Buffer const * const child = getChildBuffer();
 819         if (child)
 820                 child->updateBibfilesCache(Buffer::UpdateChildOnly);
 821 }
 822
 823
 824 support::FileNameList const &
 825         InsetInclude::getBibfilesCache() const
 826 {
 827         Buffer const * const child = getChildBuffer();
 828         if (child)
 829                 return child->getBibfilesCache(Buffer::UpdateChildOnly);
 830
 831         static support::FileNameList const empty;
 832         return empty;
 833 }
 834
 835
 836 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 837 {
 838         LASSERT(mi.base.bv, /**/);
 839
 840         bool use_preview = false;
 841         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
 842                 graphics::PreviewImage const * pimage =
 843                         preview_->getPreviewImage(mi.base.bv->buffer());
 844                 use_preview = pimage && pimage->image();
 845         }
 846
 847         if (use_preview) {
 848                 preview_->metrics(mi, dim);
 849         } else {
 850                 if (!set_label_) {
 851                         set_label_ = true;
 852                         button_.update(screenLabel(), true);
 853                 }
 854                 button_.metrics(mi, dim);
 855         }
 856
 857         Box b(0, dim.wid, -dim.asc, dim.des);
 858         button_.setBox(b);
 859 }
 860
 861
 862 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 863 {
 864         LASSERT(pi.base.bv, /**/);
 865
 866         bool use_preview = false;
 867         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
 868                 graphics::PreviewImage const * pimage =
 869                         preview_->getPreviewImage(pi.base.bv->buffer());
 870                 use_preview = pimage && pimage->image();
 871         }
 872
 873         if (use_preview)
 874                 preview_->draw(pi, x, y);
 875         else
 876                 button_.draw(pi, x, y);
 877 }
 878
 879
 880 docstring InsetInclude::contextMenu(BufferView const &, int, int) const
 881 {
 882         return from_ascii("context-include");
 883 }
 884
 885
 886 Inset::DisplayType InsetInclude::display() const
 887 {
 888         return type(params()) == INPUT ? Inline : AlignCenter;
 889 }
 890
 891
 892
 893 //
 894 // preview stuff
 895 //
 896
 897 void InsetInclude::fileChanged() const
 898 {
 899         Buffer const * const buffer = updateFrontend();
 900         if (!buffer)
 901                 return;
 902
 903         preview_->removePreview(*buffer);
 904         add_preview(*preview_.get(), *this, *buffer);
 905         preview_->startLoading(*buffer);
 906 }
 907
 908
 909 namespace {
 910
 911 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 912 {
 913         FileName const included_file = includedFilename(buffer, params);
 914
 915         return type(params) == INPUT && params.preview() &&
 916                 included_file.isReadableFile();
 917 }
 918
 919
 920 docstring latexString(InsetInclude const & inset)
 921 {
 922         odocstringstream os;
 923         // We don't need to set runparams.encoding since this will be done
 924         // by latex() anyway.
 925         OutputParams runparams(0);
 926         runparams.flavor = OutputParams::LATEX;
 927         inset.latex(os, runparams);
 928
 929         return os.str();
 930 }
 931
 932
 933 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
 934                  Buffer const & buffer)
 935 {
 936         InsetCommandParams const & params = inset.params();
 937         if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
 938             preview_wanted(params, buffer)) {
 939                 renderer.setAbsFile(includedFilename(buffer, params));
 940                 docstring const snippet = latexString(inset);
 941                 renderer.addPreview(snippet, buffer);
 942         }
 943 }
 944
 945 } // namespace anon
 946
 947
 948 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
 949 {
 950         Buffer const & buffer = ploader.buffer();
 951         if (!preview_wanted(params(), buffer))
 952                 return;
 953         preview_->setAbsFile(includedFilename(buffer, params()));
 954         docstring const snippet = latexString(*this);
 955         preview_->addPreview(snippet, ploader);
 956 }
 957
 958
 959 void InsetInclude::addToToc(DocIterator const & cpit)
 960 {
 961         TocBackend & backend = buffer().tocBackend();
 962
 963         if (isListings(params())) {
 964                 if (label_)
 965                         label_->addToToc(cpit);
 966
 967                 InsetListingsParams p(to_utf8(params()["lstparams"]));
 968                 string caption = p.getParamValue("caption");
 969                 if (caption.empty())
 970                         return;
 971                 Toc & toc = backend.toc("listing");
 972                 docstring str = convert<docstring>(toc.size() + 1)
 973                         + ". " +  from_utf8(caption);
 974                 DocIterator pit = cpit;
 975                 toc.push_back(TocItem(pit, 0, str));
 976                 return;
 977         }
 978         Buffer const * const childbuffer = getChildBuffer();
 979         if (!childbuffer)
 980                 return;
 981
 982         Toc & toc = backend.toc("child");
 983         docstring str = childbuffer->fileName().displayName();
 984         toc.push_back(TocItem(cpit, 0, str));
 985
 986         TocList & toclist = backend.tocs();
 987         childbuffer->tocBackend().update();
 988         TocList const & childtoclist = childbuffer->tocBackend().tocs();
 989         TocList::const_iterator it = childtoclist.begin();
 990         TocList::const_iterator const end = childtoclist.end();
 991         for(; it != end; ++it)
 992                 toclist[it->first].insert(toclist[it->first].end(),
 993                         it->second.begin(), it->second.end());
 994 }
 995
 996
 997 void InsetInclude::updateCommand()
 998 {
 999         if (!label_)
1000                 return;
1001
1002         docstring old_label = label_->getParam("name");
1003         label_->updateCommand(old_label, false);
1004         // the label might have been adapted (duplicate)
1005         docstring new_label = label_->getParam("name");
1006         if (old_label == new_label)
1007                 return;
1008
1009         // update listings parameters...
1010         InsetCommandParams p(INCLUDE_CODE);
1011         p = params();
1012         InsetListingsParams par(to_utf8(params()["lstparams"]));
1013         par.addParam("label", "{" + to_utf8(new_label) + "}", true);
1014         p["lstparams"] = from_utf8(par.params());
1015         setParams(p);
1016 }
1017
1018 void InsetInclude::updateLabels(ParIterator const & it)
1019 {
1020         Buffer const * const childbuffer = getChildBuffer();
1021         if (childbuffer) {
1022                 childbuffer->updateLabels(Buffer::UpdateChildOnly);
1023                 return;
1024         }
1025         if (!isListings(params()))
1026                 return;
1027
1028         if (label_)
1029                 label_->updateLabels(it);
1030
1031         InsetListingsParams const par(to_utf8(params()["lstparams"]));
1032         if (par.getParamValue("caption").empty()) {
1033                 listings_label_ = buffer().B_("Program Listing");
1034                 return;
1035         }
1036         Buffer const & master = *buffer().masterBuffer();
1037         Counters & counters = master.params().documentClass().counters();
1038         docstring const cnt = from_ascii("listing");
1039         listings_label_ = master.B_("Program Listing");
1040         if (counters.hasCounter(cnt)) {
1041                 counters.step(cnt);
1042                 listings_label_ += " " + convert<docstring>(counters.value(cnt));
1043         }
1044 }
1045
1046
1047 } // namespace lyx