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 "Converter.h"
  22 #include "Cursor.h"
  23 #include "DispatchResult.h"
  24 #include "Encoding.h"
  25 #include "ErrorList.h"
  26 #include "Exporter.h"
  27 #include "Format.h"
  28 #include "FuncRequest.h"
  29 #include "FuncStatus.h"
  30 #include "LaTeXFeatures.h"
  31 #include "LayoutFile.h"
  32 #include "LayoutModuleList.h"
  33 #include "LyX.h"
  34 #include "Lexer.h"
  35 #include "MetricsInfo.h"
  36 #include "output_plaintext.h"
  37 #include "output_xhtml.h"
  38 #include "OutputParams.h"
  39 #include "texstream.h"
  40 #include "TextClass.h"
  41 #include "TocBackend.h"
  42
  43 #include "frontends/alert.h"
  44 #include "frontends/Painter.h"
  45
  46 #include "graphics/PreviewImage.h"
  47 #include "graphics/PreviewLoader.h"
  48
  49 #include "insets/InsetLabel.h"
  50 #include "insets/InsetListingsParams.h"
  51 #include "insets/RenderPreview.h"
  52
  53 #include "mathed/MacroTable.h"
  54
  55 #include "support/convert.h"
  56 #include "support/debug.h"
  57 #include "support/docstream.h"
  58 #include "support/FileName.h"
  59 #include "support/FileNameList.h"
  60 #include "support/filetools.h"
  61 #include "support/gettext.h"
  62 #include "support/lassert.h"
  63 #include "support/lstrings.h" // contains
  64 #include "support/lyxalgo.h"
  65 #include "support/mutex.h"
  66 #include "support/ExceptionMessage.h"
  67
  68 #include "support/bind.h"
  69
  70 using namespace std;
  71 using namespace lyx::support;
  72
  73 namespace lyx {
  74
  75 namespace Alert = frontend::Alert;
  76
  77
  78 namespace {
  79
  80 docstring const uniqueID()
  81 {
  82         static unsigned int seed = 1000;
  83         static Mutex mutex;
  84         Mutex::Locker lock(&mutex);
  85         return "file" + convert<docstring>(++seed);
  86 }
  87
  88
  89 /// the type of inclusion
  90 enum Types {
  91         INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
  92 };
  93
  94
  95 Types type(string const & s)
  96 {
  97         if (s == "input")
  98                 return INPUT;
  99         if (s == "verbatiminput")
 100                 return VERB;
 101         if (s == "verbatiminput*")
 102                 return VERBAST;
 103         if (s == "lstinputlisting" || s == "inputminted")
 104                 return LISTINGS;
 105         if (s == "include")
 106                 return INCLUDE;
 107         return NONE;
 108 }
 109
 110
 111 Types type(InsetCommandParams const & params)
 112 {
 113         return type(params.getCmdName());
 114 }
 115
 116
 117 bool isListings(InsetCommandParams const & params)
 118 {
 119         return type(params) == LISTINGS;
 120 }
 121
 122
 123 bool isVerbatim(InsetCommandParams const & params)
 124 {
 125         Types const t = type(params);
 126         return t == VERB || t == VERBAST;
 127 }
 128
 129
 130 bool isInputOrInclude(InsetCommandParams const & params)
 131 {
 132         Types const t = type(params);
 133         return t == INPUT || t == INCLUDE;
 134 }
 135
 136
 137 FileName const masterFileName(Buffer const & buffer)
 138 {
 139         return buffer.masterBuffer()->fileName();
 140 }
 141
 142
 143 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
 144
 145
 146 string const parentFileName(Buffer const & buffer)
 147 {
 148         return buffer.absFileName();
 149 }
 150
 151
 152 FileName const includedFileName(Buffer const & buffer,
 153                               InsetCommandParams const & params)
 154 {
 155         return makeAbsPath(ltrim(to_utf8(params["filename"])),
 156                         onlyPath(parentFileName(buffer)));
 157 }
 158
 159
 160 InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
 161 {
 162         if (label_str.empty())
 163                 return nullptr;
 164         InsetCommandParams icp(LABEL_CODE);
 165         icp["name"] = label_str;
 166         return new InsetLabel(buf, icp);
 167 }
 168
 169
 170 char_type replaceCommaInBraces(docstring & params)
 171 {
 172         // Code point from private use area
 173         char_type private_char = 0xE000;
 174         int count = 0;
 175         for (char_type & c : params) {
 176                 if (c == '{')
 177                         ++count;
 178                 else if (c == '}')
 179                         --count;
 180                 else if (c == ',' && count)
 181                         c = private_char;
 182         }
 183         return private_char;
 184 }
 185
 186 } // namespace
 187
 188
 189 InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
 190         : InsetCommand(buf, p), include_label(uniqueID()),
 191           preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
 192           set_label_(false), label_(nullptr), child_buffer_(nullptr), file_exist_(false)
 193 {
 194         preview_->connect([=](){ fileChanged(); });
 195
 196         if (isListings(params())) {
 197                 InsetListingsParams listing_params(to_utf8(p["lstparams"]));
 198                 label_ = createLabel(buffer_, from_utf8(listing_params.getParamValue("label")));
 199         } else if (isInputOrInclude(params()) && buf)
 200                 loadIfNeeded();
 201 }
 202
 203
 204 InsetInclude::InsetInclude(InsetInclude const & other)
 205         : InsetCommand(other), include_label(other.include_label),
 206           preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
 207           set_label_(false), label_(nullptr), child_buffer_(nullptr),
 208           file_exist_(other.file_exist_)
 209 {
 210         preview_->connect([=](){ fileChanged(); });
 211
 212         if (other.label_)
 213                 label_ = new InsetLabel(*other.label_);
 214 }
 215
 216
 217 InsetInclude::~InsetInclude()
 218 {
 219         delete label_;
 220 }
 221
 222
 223 void InsetInclude::setBuffer(Buffer & buffer)
 224 {
 225         InsetCommand::setBuffer(buffer);
 226         if (label_)
 227                 label_->setBuffer(buffer);
 228 }
 229
 230
 231 void InsetInclude::setChildBuffer(Buffer * buffer)
 232 {
 233         child_buffer_ = buffer;
 234 }
 235
 236
 237 ParamInfo const & InsetInclude::findInfo(string const & /* cmdName */)
 238 {
 239         // FIXME
 240         // This is only correct for the case of listings, but it'll do for now.
 241         // In the other cases, this second parameter should just be empty.
 242         static ParamInfo param_info_;
 243         if (param_info_.empty()) {
 244                 param_info_.add("filename", ParamInfo::LATEX_REQUIRED);
 245                 param_info_.add("lstparams", ParamInfo::LATEX_OPTIONAL);
 246                 param_info_.add("literal", ParamInfo::LYX_INTERNAL);
 247         }
 248         return param_info_;
 249 }
 250
 251
 252 bool InsetInclude::isCompatibleCommand(string const & s)
 253 {
 254         return type(s) != NONE;
 255 }
 256
 257
 258 bool InsetInclude::needsCProtection(bool const /*maintext*/, bool const fragile) const
 259 {
 260         // We need to \cprotect all types in fragile context
 261         return fragile;
 262 }
 263
 264
 265 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
 266 {
 267         switch (cmd.action()) {
 268
 269         case LFUN_INSET_EDIT: {
 270                 editIncluded(ltrim(to_utf8(params()["filename"])));
 271                 break;
 272         }
 273
 274         case LFUN_INSET_MODIFY: {
 275                 // It should be OK just to invalidate the cache in setParams()
 276                 // If not....
 277                 // child_buffer_ = 0;
 278                 InsetCommandParams p(INCLUDE_CODE);
 279                 if (cmd.getArg(0) == "changetype") {
 280                         cur.recordUndo();
 281                         InsetCommand::doDispatch(cur, cmd);
 282                         p = params();
 283                 } else
 284                         InsetCommand::string2params(to_utf8(cmd.argument()), p);
 285                 if (!p.getCmdName().empty()) {
 286                         if (isListings(p)){
 287                                 InsetListingsParams new_params(to_utf8(p["lstparams"]));
 288                                 docstring const new_label =
 289                                         from_utf8(new_params.getParamValue("label"));
 290
 291                                 if (new_label.empty()) {
 292                                         delete label_;
 293                                         label_ = nullptr;
 294                                 } else {
 295                                         docstring old_label;
 296                                         if (label_)
 297                                                 old_label = label_->getParam("name");
 298                                         else {
 299                                                 label_ = createLabel(buffer_, new_label);
 300                                                 label_->setBuffer(buffer());
 301                                         }
 302
 303                                         if (new_label != old_label) {
 304                                                 label_->updateLabelAndRefs(new_label, &cur);
 305                                                 // the label might have been adapted (duplicate)
 306                                                 if (new_label != label_->getParam("name")) {
 307                                                         new_params.addParam("label", "{" +
 308                                                                 to_utf8(label_->getParam("name")) + "}", true);
 309                                                         p["lstparams"] = from_utf8(new_params.params());
 310                                                 }
 311                                         }
 312                                 }
 313                         }
 314                         cur.recordUndo();
 315                         setParams(p);
 316                         cur.forceBufferUpdate();
 317                 } else
 318                         cur.noScreenUpdate();
 319                 break;
 320         }
 321
 322         case LFUN_MOUSE_RELEASE: {
 323                 if (cmd.modifier() == ControlModifier) {
 324                         FileName const incfile = includedFileName(buffer(), params());
 325                         string const & incname = incfile.absFileName();
 326                         editIncluded(incname);
 327                         break;
 328                 }
 329         }
 330         // fall through
 331
 332         //pass everything else up the chain
 333         default:
 334                 InsetCommand::doDispatch(cur, cmd);
 335                 break;
 336         }
 337 }
 338
 339
 340 void InsetInclude::editIncluded(string const & f)
 341 {
 342         if (isLyXFileName(f)) {
 343                 FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, f);
 344                 lyx::dispatch(fr);
 345         } else
 346                 // tex file or other text file in verbatim mode
 347                 theFormats().edit(buffer(),
 348                         support::makeAbsPath(f, support::onlyPath(buffer().absFileName())),
 349                         "text");
 350 }
 351
 352
 353 bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
 354                 FuncStatus & flag) const
 355 {
 356         switch (cmd.action()) {
 357
 358         case LFUN_INSET_EDIT:
 359                 flag.setEnabled(true);
 360                 return true;
 361
 362         case LFUN_INSET_MODIFY:
 363                 if (cmd.getArg(0) == "changetype")
 364                         return InsetCommand::getStatus(cur, cmd, flag);
 365                 else
 366                         flag.setEnabled(true);
 367                 return true;
 368
 369         default:
 370                 return InsetCommand::getStatus(cur, cmd, flag);
 371         }
 372 }
 373
 374
 375 void InsetInclude::setParams(InsetCommandParams const & p)
 376 {
 377         // invalidate the cache
 378         child_buffer_ = nullptr;
 379
 380         // reset in order to allow loading new file
 381         failedtoload_ = false;
 382
 383         InsetCommand::setParams(p);
 384         set_label_ = false;
 385
 386         if (preview_->monitoring())
 387                 preview_->stopMonitoring();
 388
 389         if (type(params()) == INPUT)
 390                 add_preview(*preview_, *this, buffer());
 391 }
 392
 393
 394 bool InsetInclude::isChildIncluded() const
 395 {
 396         std::list<std::string> includeonlys =
 397                 buffer().params().getIncludedChildren();
 398         if (includeonlys.empty())
 399                 return true;
 400         return (std::find(includeonlys.begin(),
 401                           includeonlys.end(),
 402                           ltrim(to_utf8(params()["filename"]))) != includeonlys.end());
 403 }
 404
 405
 406 docstring InsetInclude::screenLabel() const
 407 {
 408         docstring pre = file_exist_ ? docstring() : _("FILE MISSING:");
 409
 410         docstring temp;
 411
 412         switch (type(params())) {
 413                 case INPUT:
 414                         temp = buffer().B_("Input");
 415                         break;
 416                 case VERB:
 417                         temp = buffer().B_("Verbatim");
 418                         break;
 419                 case VERBAST:
 420                         temp = buffer().B_("Verbatim*");
 421                         break;
 422                 case INCLUDE:
 423                         if (isChildIncluded())
 424                                 temp = buffer().B_("Include");
 425                         else
 426                                 temp += buffer().B_("Include (excluded)");
 427                         break;
 428                 case LISTINGS:
 429                         temp = listings_label_;
 430                         break;
 431                 case NONE:
 432                         LASSERT(false, temp = buffer().B_("Unknown"));
 433                         break;
 434         }
 435
 436         temp += ": ";
 437
 438         if (ltrim(params()["filename"]).empty())
 439                 temp += "???";
 440         else
 441                 temp += from_utf8(onlyFileName(ltrim(to_utf8(params()["filename"]))));
 442
 443         return pre.empty() ? temp : pre + from_ascii(" ") + temp;
 444 }
 445
 446
 447 Buffer * InsetInclude::getChildBuffer() const
 448 {
 449         Buffer * childBuffer = loadIfNeeded();
 450
 451         // FIXME RECURSIVE INCLUDE
 452         // This isn't sufficient, as the inclusion could be downstream.
 453         // But it'll have to do for now.
 454         return (childBuffer == &buffer()) ? nullptr : childBuffer;
 455 }
 456
 457
 458 Buffer * InsetInclude::loadIfNeeded() const
 459 {
 460         // This is for background export and preview. We don't even want to
 461         // try to load the cloned child document again.
 462         if (buffer().isClone())
 463                 return child_buffer_;
 464
 465         // Don't try to load it again if we failed before.
 466         if (failedtoload_ || isVerbatim(params()) || isListings(params()))
 467                 return nullptr;
 468
 469         FileName const included_file = includedFileName(buffer(), params());
 470         // Use cached Buffer if possible.
 471         if (child_buffer_ != nullptr) {
 472                 if (theBufferList().isLoaded(child_buffer_)
 473                     // additional sanity check: make sure the Buffer really is
 474                     // associated with the file we want.
 475                     && child_buffer_ == theBufferList().getBuffer(included_file))
 476                         return child_buffer_;
 477                 // Buffer vanished, so invalidate cache and try to reload.
 478                 child_buffer_ = nullptr;
 479         }
 480
 481         if (!isLyXFileName(included_file.absFileName()))
 482                 return nullptr;
 483
 484         Buffer * child = theBufferList().getBuffer(included_file);
 485         if (!child) {
 486                 // the readonly flag can/will be wrong, not anymore I think.
 487                 if (!included_file.exists()) {
 488                         failedtoload_ = true;
 489                         return nullptr;
 490                 }
 491
 492                 child = theBufferList().newBuffer(included_file.absFileName());
 493                 if (!child)
 494                         // Buffer creation is not possible.
 495                         return nullptr;
 496
 497                 // Set parent before loading, such that macros can be tracked
 498                 child->setParent(&buffer());
 499
 500                 if (child->loadLyXFile() != Buffer::ReadSuccess) {
 501                         failedtoload_ = true;
 502                         child->setParent(nullptr);
 503                         //close the buffer we just opened
 504                         theBufferList().release(child);
 505                         return nullptr;
 506                 }
 507
 508                 if (!child->errorList("Parse").empty()) {
 509                         // FIXME: Do something.
 510                 }
 511         } else {
 512                 // The file was already loaded, so, simply
 513                 // inform parent buffer about local macros.
 514                 Buffer const * parent = &buffer();
 515                 child->setParent(parent);
 516                 MacroNameSet macros;
 517                 child->listMacroNames(macros);
 518                 MacroNameSet::const_iterator cit = macros.begin();
 519                 MacroNameSet::const_iterator end = macros.end();
 520                 for (; cit != end; ++cit)
 521                         parent->usermacros.insert(*cit);
 522         }
 523
 524         // Cache the child buffer.
 525         child_buffer_ = child;
 526         return child;
 527 }
 528
 529
 530 void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
 531 {
 532         string incfile = ltrim(to_utf8(params()["filename"]));
 533
 534         // Warn if no file name has been specified
 535         if (incfile.empty()) {
 536                 frontend::Alert::warning(_("No file name specified"),
 537                         _("An included file name is empty.\n"
 538                            "Ignoring Inclusion"),
 539                         true);
 540                 return;
 541         }
 542         // Warn if file doesn't exist
 543         if (!includedFileExist()) {
 544                 frontend::Alert::warning(_("Included file not found"),
 545                         bformat(_("The included file\n"
 546                                   "'%1$s'\n"
 547                                   "has not been found. LyX will ignore the inclusion."),
 548                                 from_utf8(incfile)),
 549                         true);
 550                  return;
 551         }
 552
 553         FileName const included_file = includedFileName(buffer(), params());
 554
 555         // Check we're not trying to include ourselves.
 556         // FIXME RECURSIVE INCLUDE
 557         // This isn't sufficient, as the inclusion could be downstream.
 558         // But it'll have to do for now.
 559         if (isInputOrInclude(params()) &&
 560                 buffer().absFileName() == included_file.absFileName())
 561         {
 562                 Alert::error(_("Recursive input"),
 563                                bformat(_("Attempted to include file %1$s in itself! "
 564                                "Ignoring inclusion."), from_utf8(incfile)));
 565                 return;
 566         }
 567
 568         Buffer const * const masterBuffer = buffer().masterBuffer();
 569
 570         // if incfile is relative, make it relative to the master
 571         // buffer directory.
 572         if (!FileName::isAbsolute(incfile)) {
 573                 // FIXME UNICODE
 574                 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFileName()),
 575                                               from_utf8(masterBuffer->filePath())));
 576         }
 577
 578         string exppath = incfile;
 579         if (!runparams.export_folder.empty()) {
 580                 exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
 581         }
 582
 583         // write it to a file (so far the complete file)
 584         string exportfile;
 585         string mangled;
 586         // bug 5681
 587         if (type(params()) == LISTINGS) {
 588                 exportfile = exppath;
 589                 mangled = DocFileName(included_file).mangledFileName();
 590         } else {
 591                 exportfile = changeExtension(exppath, ".tex");
 592                 mangled = DocFileName(changeExtension(included_file.absFileName(), ".tex")).
 593                         mangledFileName();
 594         }
 595
 596         if (!runparams.nice)
 597                 incfile = mangled;
 598         else if (!runparams.silent)
 599                 ; // no warning wanted
 600         else if (!isValidLaTeXFileName(incfile)) {
 601                 frontend::Alert::warning(_("Invalid filename"),
 602                         _("The following filename will cause troubles "
 603                                 "when running the exported file through LaTeX: ") +
 604                         from_utf8(incfile));
 605         } else if (!isValidDVIFileName(incfile)) {
 606                 frontend::Alert::warning(_("Problematic filename for DVI"),
 607                         _("The following filename can cause troubles "
 608                                 "when running the exported file through LaTeX "
 609                                 "and opening the resulting DVI: ") +
 610                         from_utf8(incfile), true);
 611         }
 612
 613         FileName const writefile(makeAbsPath(mangled, runparams.for_preview ?
 614                                                  buffer().temppath() : masterBuffer->temppath()));
 615
 616         LYXERR(Debug::LATEX, "incfile:" << incfile);
 617         LYXERR(Debug::LATEX, "exportfile:" << exportfile);
 618         LYXERR(Debug::LATEX, "writefile:" << writefile);
 619
 620         string const tex_format = flavor2format(runparams.flavor);
 621
 622         switch (type(params())) {
 623         case VERB:
 624         case VERBAST: {
 625                 incfile = latex_path(incfile);
 626                 // FIXME UNICODE
 627                 os << '\\' << from_ascii(params().getCmdName()) << '{'
 628                    << from_utf8(incfile) << '}';
 629                 break;
 630         }
 631         case INPUT: {
 632                 runparams.exportdata->addExternalFile(tex_format, writefile,
 633                                                       exportfile);
 634
 635                 // \input wants file with extension (default is .tex)
 636                 if (!isLyXFileName(included_file.absFileName())) {
 637                         incfile = latex_path(incfile);
 638                         // FIXME UNICODE
 639                         os << '\\' << from_ascii(params().getCmdName())
 640                            << '{' << from_utf8(incfile) << '}';
 641                 } else {
 642                         incfile = changeExtension(incfile, ".tex");
 643                         incfile = latex_path(incfile);
 644                         // FIXME UNICODE
 645                         os << '\\' << from_ascii(params().getCmdName())
 646                            << '{' << from_utf8(incfile) <<  '}';
 647                 }
 648                 break;
 649         }
 650         case LISTINGS: {
 651                 // Here, listings and minted have sligthly different behaviors.
 652                 // Using listings, it is always possible to have a caption,
 653                 // even for non-floats. Using minted, only floats can have a
 654                 // caption. So, with minted we use the following strategy.
 655                 // If a caption was specified but the float parameter was not,
 656                 // we ourselves add a caption above the listing (because the
 657                 // listing comes from a file and might span several pages).
 658                 // Otherwise, if float was specified, the floating listing
 659                 // environment provided by minted is used. In either case, the
 660                 // label parameter is taken as the label by which the float
 661                 // can be referenced, otherwise it will have the meaning
 662                 // intended by minted. In this last case, the label will
 663                 // serve as a sort of caption that, however, will be shown
 664                 // by minted only if the frame parameter is also specified.
 665                 bool const use_minted = buffer().params().use_minted;
 666                 runparams.exportdata->addExternalFile(tex_format, writefile,
 667                                                       exportfile);
 668                 string const opt = to_utf8(params()["lstparams"]);
 669                 // opt is set in QInclude dialog and should have passed validation.
 670                 InsetListingsParams lstparams(opt);
 671                 docstring parameters = from_utf8(lstparams.params());
 672                 docstring language;
 673                 docstring caption;
 674                 docstring label;
 675                 docstring placement;
 676                 bool isfloat = lstparams.isFloat();
 677                 // We are going to split parameters at commas, so
 678                 // replace commas that are not parameter separators
 679                 // with a code point from the private use area
 680                 char_type comma = replaceCommaInBraces(parameters);
 681                 // Get float placement, language, caption, and
 682                 // label, then remove the relative options if minted.
 683                 vector<docstring> opts =
 684                         getVectorFromString(parameters, from_ascii(","), false);
 685                 vector<docstring> latexed_opts;
 686                 for (size_t i = 0; i < opts.size(); ++i) {
 687                         // Restore replaced commas
 688                         opts[i] = subst(opts[i], comma, ',');
 689                         if (use_minted && prefixIs(opts[i], from_ascii("float"))) {
 690                                 if (prefixIs(opts[i], from_ascii("float=")))
 691                                         placement = opts[i].substr(6);
 692                                 opts.erase(opts.begin() + i--);
 693                         } else if (use_minted && prefixIs(opts[i], from_ascii("language="))) {
 694                                 language = opts[i].substr(9);
 695                                 opts.erase(opts.begin() + i--);
 696                         } else if (prefixIs(opts[i], from_ascii("caption="))) {
 697                                 caption = params().prepareCommand(runparams, trim(opts[i].substr(8), "{}"),
 698                                                                   ParamInfo::HANDLING_LATEXIFY);
 699                                 opts.erase(opts.begin() + i--);
 700                                 if (!use_minted)
 701                                         latexed_opts.push_back(from_ascii("caption={") + caption + "}");
 702                         } else if (prefixIs(opts[i], from_ascii("label="))) {
 703                                 label = params().prepareCommand(runparams, trim(opts[i].substr(6), "{}"),
 704                                                                 ParamInfo::HANDLING_ESCAPE);
 705                                 opts.erase(opts.begin() + i--);
 706                                 if (!use_minted)
 707                                         latexed_opts.push_back(from_ascii("label={") + label + "}");
 708                         }
 709                         if (use_minted && !label.empty()) {
 710                                 if (isfloat || !caption.empty())
 711                                         label = trim(label, "{}");
 712                                 else
 713                                         opts.push_back(from_ascii("label=") + label);
 714                         }
 715                 }
 716                 if (!latexed_opts.empty())
 717                         opts.insert(opts.end(), latexed_opts.begin(), latexed_opts.end());
 718                 parameters = getStringFromVector(opts, from_ascii(","));
 719                 if (language.empty())
 720                         language = from_ascii("TeX");
 721                 if (use_minted && isfloat) {
 722                         os << breakln << "\\begin{listing}";
 723                         if (!placement.empty())
 724                                 os << '[' << placement << "]";
 725                         os << breakln;
 726                 } else if (use_minted && !caption.empty()) {
 727                         os << breakln << "\\lyxmintcaption[t]{" << caption;
 728                         if (!label.empty())
 729                                 os << "\\label{" << label << "}";
 730                         os << "}\n";
 731                 }
 732                 os << (use_minted ? "\\inputminted" : "\\lstinputlisting");
 733                 if (!parameters.empty())
 734                         os << "[" << parameters << "]";
 735                 if (use_minted)
 736                         os << '{'  << ascii_lowercase(language) << '}';
 737                 os << '{'  << incfile << '}';
 738                 if (use_minted && isfloat) {
 739                         if (!caption.empty())
 740                                 os << breakln << "\\caption{" << caption << "}";
 741                         if (!label.empty())
 742                                 os << breakln << "\\label{" << label << "}";
 743                         os << breakln << "\\end{listing}\n";
 744                 }
 745                 break;
 746         }
 747         case INCLUDE: {
 748                 runparams.exportdata->addExternalFile(tex_format, writefile,
 749                                                       exportfile);
 750
 751                 // \include don't want extension and demands that the
 752                 // file really have .tex
 753                 incfile = changeExtension(incfile, string());
 754                 incfile = latex_path(incfile);
 755                 // FIXME UNICODE
 756                 os << '\\' << from_ascii(params().getCmdName()) << '{'
 757                    << from_utf8(incfile) << '}';
 758                 break;
 759         }
 760         case NONE:
 761                 break;
 762         }
 763
 764         if (runparams.inComment || runparams.dryrun)
 765                 // Don't try to load or copy the file if we're
 766                 // in a comment or doing a dryrun
 767                 return;
 768
 769         if (!isInputOrInclude(params()) ||
 770                  !isLyXFileName(included_file.absFileName())) {
 771                 // In this case, it's not a LyX file, so we copy the file
 772                 // to the temp dir, so that .aux files etc. are not created
 773                 // in the original dir. Files included by this file will be
 774                 // found via either the environment variable TEXINPUTS, or
 775                 // input@path, see ../Buffer.cpp.
 776                 unsigned long const checksum_in  = included_file.checksum();
 777                 unsigned long const checksum_out = writefile.checksum();
 778                 if (checksum_in != checksum_out) {
 779                         if (!included_file.copyTo(writefile)) {
 780                                 // FIXME UNICODE
 781                                 LYXERR(Debug::LATEX,
 782                                         to_utf8(bformat(_("Could not copy the file\n%1$s\n"
 783                                                                         "into the temporary directory."),
 784                                                          from_utf8(included_file.absFileName()))));
 785                         }
 786                 }
 787                 return;
 788         }
 789
 790
 791         // it's a LyX file and we're inputting or including, so
 792         // try to load it so we can write the associated latex
 793         Buffer * tmp = loadIfNeeded();
 794         if (!tmp) {
 795                 if (!runparams.silent) {
 796                         docstring text = bformat(_("Could not load included "
 797                                 "file\n`%1$s'\n"
 798                                 "Please, check whether it actually exists."),
 799                                 included_file.displayName());
 800                         throw ExceptionMessage(ErrorException, _("Error: "),
 801                                                    text);
 802                 }
 803                 return;
 804         }
 805
 806         if (!runparams.silent) {
 807                 if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
 808                         // FIXME UNICODE
 809                         docstring text = bformat(_("Included file `%1$s'\n"
 810                                 "has textclass `%2$s'\n"
 811                                 "while parent file has textclass `%3$s'."),
 812                                 included_file.displayName(),
 813                                 from_utf8(tmp->params().documentClass().name()),
 814                                 from_utf8(masterBuffer->params().documentClass().name()));
 815                         Alert::warning(_("Different textclasses"), text, true);
 816                 }
 817
 818                 string const child_tf = tmp->params().useNonTeXFonts ? "true" : "false";
 819                 string const master_tf = masterBuffer->params().useNonTeXFonts ? "true" : "false";
 820                 if (tmp->params().useNonTeXFonts != masterBuffer->params().useNonTeXFonts) {
 821                         docstring text = bformat(_("Included file `%1$s'\n"
 822                                 "has use-non-TeX-fonts set to `%2$s'\n"
 823                                 "while parent file has use-non-TeX-fonts set to `%3$s'."),
 824                                 included_file.displayName(),
 825                                 from_utf8(child_tf),
 826                                 from_utf8(master_tf));
 827                         Alert::warning(_("Different use-non-TeX-fonts settings"), text, true);
 828                 }
 829                 else if (tmp->params().inputenc != masterBuffer->params().inputenc) {
 830                         docstring text = bformat(_("Included file `%1$s'\n"
 831                                 "uses input encoding \"%2$s\" [%3$s]\n"
 832                                 "while parent file uses input encoding \"%4$s\" [%5$s]."),
 833                                 included_file.displayName(),
 834                                 _(tmp->params().inputenc),
 835                                 from_utf8(tmp->params().encoding().guiName()),
 836                                 _(masterBuffer->params().inputenc),
 837                                 from_utf8(masterBuffer->params().encoding().guiName()));
 838                         Alert::warning(_("Different LaTeX input encodings"), text, true);
 839                 }
 840
 841                 // Make sure modules used in child are all included in master
 842                 // FIXME It might be worth loading the children's modules into the master
 843                 // over in BufferParams rather than doing this check.
 844                 LayoutModuleList const masterModules = masterBuffer->params().getModules();
 845                 LayoutModuleList const childModules = tmp->params().getModules();
 846                 LayoutModuleList::const_iterator it = childModules.begin();
 847                 LayoutModuleList::const_iterator end = childModules.end();
 848                 for (; it != end; ++it) {
 849                         string const module = *it;
 850                         LayoutModuleList::const_iterator found =
 851                                 find(masterModules.begin(), masterModules.end(), module);
 852                         if (found == masterModules.end()) {
 853                                 docstring text = bformat(_("Included file `%1$s'\n"
 854                                         "uses module `%2$s'\n"
 855                                         "which is not used in parent file."),
 856                                         included_file.displayName(), from_utf8(module));
 857                                 Alert::warning(_("Module not found"), text, true);
 858                         }
 859                 }
 860         }
 861
 862         tmp->markDepClean(masterBuffer->temppath());
 863
 864         // Don't assume the child's format is latex
 865         string const inc_format = tmp->params().bufferFormat();
 866         FileName const tmpwritefile(changeExtension(writefile.absFileName(),
 867                 theFormats().extension(inc_format)));
 868
 869         // FIXME: handle non existing files
 870         // The included file might be written in a different encoding
 871         // and language.
 872         Encoding const * const oldEnc = runparams.encoding;
 873         Language const * const oldLang = runparams.master_language;
 874         // If the master uses non-TeX fonts (XeTeX, LuaTeX),
 875         // the children must be encoded in plain utf8!
 876         if (masterBuffer->params().useNonTeXFonts)
 877                 runparams.encoding = encodings.fromLyXName("utf8-plain");
 878         else if (oldEnc)
 879                 runparams.encoding = oldEnc;
 880         else runparams.encoding = &tmp->params().encoding();
 881         runparams.master_language = buffer().params().language;
 882         runparams.par_begin = 0;
 883         runparams.par_end = tmp->paragraphs().size();
 884         runparams.is_child = true;
 885         Buffer::ExportStatus retval =
 886                 tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
 887                         onlyPath().absFileName(), runparams, Buffer::OnlyBody);
 888         if (retval == Buffer::ExportKilled && buffer().isClone() &&
 889                   buffer().isExporting()) {
 890           // We really shouldn't get here, I don't think.
 891           LYXERR0("No conversion exception?");
 892                 throw ConversionException();
 893         }
 894         else if (retval != Buffer::ExportSuccess) {
 895                 if (!runparams.silent) {
 896                         docstring msg = bformat(_("Included file `%1$s' "
 897                                 "was not exported correctly.\n "
 898                                 "LaTeX export is probably incomplete."),
 899                                 included_file.displayName());
 900                         ErrorList const & el = tmp->errorList("Export");
 901                         if (!el.empty())
 902                                 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
 903                                                 msg, el.begin()->error, el.begin()->description);
 904                         throw ExceptionMessage(ErrorException, _("Error: "), msg);
 905                 }
 906         }
 907         runparams.encoding = oldEnc;
 908         runparams.master_language = oldLang;
 909         runparams.is_child = false;
 910
 911         // If needed, use converters to produce a latex file from the child
 912         if (tmpwritefile != writefile) {
 913                 ErrorList el;
 914                 Converters::RetVal const conv_retval =
 915                         theConverters().convert(tmp, tmpwritefile, writefile,
 916                                 included_file, inc_format, tex_format, el);
 917                 if (conv_retval == Converters::KILLED && buffer().isClone() &&
 918                         buffer().isExporting()) {
 919                         // We really shouldn't get here, I don't think.
 920                         LYXERR0("No conversion exception?");
 921                         throw ConversionException();
 922                 } else if (conv_retval != Converters::SUCCESS && !runparams.silent) {
 923                         docstring msg = bformat(_("Included file `%1$s' "
 924                                         "was not exported correctly.\n "
 925                                         "LaTeX export is probably incomplete."),
 926                                         included_file.displayName());
 927                         if (!el.empty())
 928                                 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
 929                                                 msg, el.begin()->error, el.begin()->description);
 930                         throw ExceptionMessage(ErrorException, _("Error: "), msg);
 931                 }
 932         }
 933 }
 934
 935
 936 docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 937 {
 938         if (rp.inComment)
 939                  return docstring();
 940
 941         // For verbatim and listings, we just include the contents of the file as-is.
 942         // In the case of listings, we wrap it in <pre>.
 943         bool const listing = isListings(params());
 944         if (listing || isVerbatim(params())) {
 945                 if (listing)
 946                         xs << html::StartTag("pre");
 947                 // FIXME: We don't know the encoding of the file, default to UTF-8.
 948                 xs << includedFileName(buffer(), params()).fileContents("UTF-8");
 949                 if (listing)
 950                         xs << html::EndTag("pre");
 951                 return docstring();
 952         }
 953
 954         // We don't (yet) know how to Input or Include non-LyX files.
 955         // (If we wanted to get really arcane, we could run some tex2html
 956         // converter on the included file. But that's just masochistic.)
 957         FileName const included_file = includedFileName(buffer(), params());
 958         if (!isLyXFileName(included_file.absFileName())) {
 959                 if (!rp.silent)
 960                         frontend::Alert::warning(_("Unsupported Inclusion"),
 961                                          bformat(_("LyX does not know how to include non-LyX files when "
 962                                                    "generating HTML output. Offending file:\n%1$s"),
 963                                                     ltrim(params()["filename"])));
 964                 return docstring();
 965         }
 966
 967         // In the other cases, we will generate the HTML and include it.
 968
 969         // Check we're not trying to include ourselves.
 970         // FIXME RECURSIVE INCLUDE
 971         if (buffer().absFileName() == included_file.absFileName()) {
 972                 Alert::error(_("Recursive input"),
 973                                bformat(_("Attempted to include file %1$s in itself! "
 974                                "Ignoring inclusion."), ltrim(params()["filename"])));
 975                 return docstring();
 976         }
 977
 978         Buffer const * const ibuf = loadIfNeeded();
 979         if (!ibuf)
 980                 return docstring();
 981
 982         // are we generating only some paragraphs, or all of them?
 983         bool const all_pars = !rp.dryrun ||
 984                         (rp.par_begin == 0 &&
 985                          rp.par_end == (int)buffer().text().paragraphs().size());
 986
 987         OutputParams op = rp;
 988         if (all_pars) {
 989                 op.par_begin = 0;
 990                 op.par_end = 0;
 991                 ibuf->writeLyXHTMLSource(xs.os(), op, Buffer::IncludedFile);
 992         } else
 993                 xs << XHTMLStream::ESCAPE_NONE
 994                    << "<!-- Included file: "
 995                    << from_utf8(included_file.absFileName())
 996                    << XHTMLStream::ESCAPE_NONE
 997                          << " -->";
 998         return docstring();
 999 }
1000
1001
1002 int InsetInclude::plaintext(odocstringstream & os,
1003         OutputParams const & op, size_t) const
1004 {
1005         // just write the filename if we're making a tooltip or toc entry,
1006         // or are generating this for advanced search
1007         if (op.for_tooltip || op.for_toc || op.for_search) {
1008                 os << '[' << screenLabel() << '\n'
1009                    << ltrim(getParam("filename")) << "\n]";
1010                 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
1011         }
1012
1013         if (isVerbatim(params()) || isListings(params())) {
1014                 if (op.for_search) {
1015                         os << '[' << screenLabel() << ']';
1016                 }
1017                 else {
1018                         os << '[' << screenLabel() << '\n'
1019                            // FIXME: We don't know the encoding of the file, default to UTF-8.
1020                            << includedFileName(buffer(), params()).fileContents("UTF-8")
1021                            << "\n]";
1022                 }
1023                 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
1024         }
1025
1026         Buffer const * const ibuf = loadIfNeeded();
1027         if (!ibuf) {
1028                 docstring const str = '[' + screenLabel() + ']';
1029                 os << str;
1030                 return str.size();
1031         }
1032         writePlaintextFile(*ibuf, os, op);
1033         return 0;
1034 }
1035
1036
1037 int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
1038 {
1039         string incfile = ltrim(to_utf8(params()["filename"]));
1040
1041         // Do nothing if no file name has been specified
1042         if (incfile.empty())
1043                 return 0;
1044
1045         string const included_file = includedFileName(buffer(), params()).absFileName();
1046
1047         // Check we're not trying to include ourselves.
1048         // FIXME RECURSIVE INCLUDE
1049         // This isn't sufficient, as the inclusion could be downstream.
1050         // But it'll have to do for now.
1051         if (buffer().absFileName() == included_file) {
1052                 Alert::error(_("Recursive input"),
1053                                bformat(_("Attempted to include file %1$s in itself! "
1054                                "Ignoring inclusion."), from_utf8(incfile)));
1055                 return 0;
1056         }
1057
1058         string exppath = incfile;
1059         if (!runparams.export_folder.empty()) {
1060                 exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
1061                 FileName(exppath).onlyPath().createPath();
1062         }
1063
1064         // write it to a file (so far the complete file)
1065         string const exportfile = changeExtension(exppath, ".sgml");
1066         DocFileName writefile(changeExtension(included_file, ".sgml"));
1067
1068         Buffer * tmp = loadIfNeeded();
1069         if (tmp) {
1070                 string const mangled = writefile.mangledFileName();
1071                 writefile = makeAbsPath(mangled,
1072                                         buffer().masterBuffer()->temppath());
1073                 if (!runparams.nice)
1074                         incfile = mangled;
1075
1076                 LYXERR(Debug::LATEX, "incfile:" << incfile);
1077                 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
1078                 LYXERR(Debug::LATEX, "writefile:" << writefile);
1079
1080                 tmp->makeDocBookFile(writefile, runparams, Buffer::OnlyBody);
1081         }
1082
1083         runparams.exportdata->addExternalFile("docbook", writefile,
1084                                               exportfile);
1085         runparams.exportdata->addExternalFile("docbook-xml", writefile,
1086                                               exportfile);
1087
1088         if (isVerbatim(params()) || isListings(params())) {
1089                 os << "<inlinegraphic fileref=\""
1090                    << '&' << include_label << ';'
1091                    << "\" format=\"linespecific\">";
1092         } else
1093                 os << '&' << include_label << ';';
1094
1095         return 0;
1096 }
1097
1098
1099 void InsetInclude::validate(LaTeXFeatures & features) const
1100 {
1101         LATTEST(&buffer() == &features.buffer());
1102
1103         string incfile = ltrim(to_utf8(params()["filename"]));
1104         string const included_file =
1105                 includedFileName(buffer(), params()).absFileName();
1106
1107         string writefile;
1108         if (isLyXFileName(included_file))
1109                 writefile = changeExtension(included_file, ".sgml");
1110         else
1111                 writefile = included_file;
1112
1113         if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
1114                 incfile = DocFileName(writefile).mangledFileName();
1115                 writefile = makeAbsPath(incfile,
1116                                         buffer().masterBuffer()->temppath()).absFileName();
1117         }
1118
1119         features.includeFile(include_label, writefile);
1120
1121         features.useInsetLayout(getLayout());
1122         if (isVerbatim(params()))
1123                 features.require("verbatim");
1124         else if (isListings(params())) {
1125                 if (buffer().params().use_minted) {
1126                         features.require("minted");
1127                         string const opts = to_utf8(params()["lstparams"]);
1128                         InsetListingsParams lstpars(opts);
1129                         if (!lstpars.isFloat() && contains(opts, "caption="))
1130                                 features.require("lyxmintcaption");
1131                 } else
1132                         features.require("listings");
1133         }
1134
1135         // Here we must do the fun stuff...
1136         // Load the file in the include if it needs
1137         // to be loaded:
1138         Buffer * const tmp = loadIfNeeded();
1139         if (tmp) {
1140                 // the file is loaded
1141                 // make sure the buffer isn't us
1142                 // FIXME RECURSIVE INCLUDES
1143                 // This is not sufficient, as recursive includes could be
1144                 // more than a file away. But it will do for now.
1145                 if (tmp && tmp != &buffer()) {
1146                         // We must temporarily change features.buffer,
1147                         // otherwise it would always be the master buffer,
1148                         // and nested includes would not work.
1149                         features.setBuffer(*tmp);
1150                         // Maybe this is already a child
1151                         bool const is_child =
1152                                 features.runparams().is_child;
1153                         features.runparams().is_child = true;
1154                         tmp->validate(features);
1155                         features.runparams().is_child = is_child;
1156                         features.setBuffer(buffer());
1157                 }
1158         }
1159 }
1160
1161
1162 void InsetInclude::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const
1163 {
1164         Buffer * child = loadIfNeeded();
1165         if (!child)
1166                 return;
1167         // FIXME RECURSIVE INCLUDE
1168         // This isn't sufficient, as the inclusion could be downstream.
1169         // But it'll have to do for now.
1170         if (child == &buffer())
1171                 return;
1172         child->collectBibKeys(checkedFiles);
1173 }
1174
1175
1176 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
1177 {
1178         LBUFERR(mi.base.bv);
1179
1180         bool use_preview = false;
1181         if (RenderPreview::previewText()) {
1182                 graphics::PreviewImage const * pimage =
1183                         preview_->getPreviewImage(mi.base.bv->buffer());
1184                 use_preview = pimage && pimage->image();
1185         }
1186
1187         if (use_preview) {
1188                 preview_->metrics(mi, dim);
1189         } else {
1190                 if (!set_label_) {
1191                         set_label_ = true;
1192                         button_.update(screenLabel(), true, false, !file_exist_);
1193                 }
1194                 button_.metrics(mi, dim);
1195         }
1196
1197         Box b(0, dim.wid, -dim.asc, dim.des);
1198         button_.setBox(b);
1199 }
1200
1201
1202 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
1203 {
1204         LBUFERR(pi.base.bv);
1205
1206         bool use_preview = false;
1207         if (RenderPreview::previewText()) {
1208                 graphics::PreviewImage const * pimage =
1209                         preview_->getPreviewImage(pi.base.bv->buffer());
1210                 use_preview = pimage && pimage->image();
1211         }
1212
1213         if (use_preview)
1214                 preview_->draw(pi, x, y);
1215         else
1216                 button_.draw(pi, x, y);
1217 }
1218
1219
1220 void InsetInclude::write(ostream & os) const
1221 {
1222         params().Write(os, &buffer());
1223 }
1224
1225
1226 string InsetInclude::contextMenuName() const
1227 {
1228         return "context-include";
1229 }
1230
1231
1232 Inset::DisplayType InsetInclude::display() const
1233 {
1234         return type(params()) == INPUT ? Inline : AlignCenter;
1235 }
1236
1237
1238 docstring InsetInclude::layoutName() const
1239 {
1240         if (isListings(params()))
1241                 return from_ascii("IncludeListings");
1242         return InsetCommand::layoutName();
1243 }
1244
1245
1246 //
1247 // preview stuff
1248 //
1249
1250 void InsetInclude::fileChanged() const
1251 {
1252         Buffer const * const buffer = updateFrontend();
1253         if (!buffer)
1254                 return;
1255
1256         preview_->removePreview(*buffer);
1257         add_preview(*preview_, *this, *buffer);
1258         preview_->startLoading(*buffer);
1259 }
1260
1261
1262 namespace {
1263
1264 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
1265 {
1266         FileName const included_file = includedFileName(buffer, params);
1267
1268         return type(params) == INPUT && params.preview() &&
1269                 included_file.isReadableFile();
1270 }
1271
1272
1273 docstring latexString(InsetInclude const & inset)
1274 {
1275         odocstringstream ods;
1276         otexstream os(ods);
1277         // We don't need to set runparams.encoding since this will be done
1278         // by latex() anyway.
1279         OutputParams runparams(nullptr);
1280         runparams.flavor = OutputParams::LATEX;
1281         runparams.for_preview = true;
1282         inset.latex(os, runparams);
1283
1284         return ods.str();
1285 }
1286
1287
1288 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
1289                  Buffer const & buffer)
1290 {
1291         InsetCommandParams const & params = inset.params();
1292         if (RenderPreview::previewText() && preview_wanted(params, buffer)) {
1293                 renderer.setAbsFile(includedFileName(buffer, params));
1294                 docstring const snippet = latexString(inset);
1295                 renderer.addPreview(snippet, buffer);
1296         }
1297 }
1298
1299 } // namespace
1300
1301
1302 void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
1303         graphics::PreviewLoader & ploader) const
1304 {
1305         Buffer const & buffer = ploader.buffer();
1306         if (!preview_wanted(params(), buffer))
1307                 return;
1308         preview_->setAbsFile(includedFileName(buffer, params()));
1309         docstring const snippet = latexString(*this);
1310         preview_->addPreview(snippet, ploader);
1311 }
1312
1313
1314 void InsetInclude::addToToc(DocIterator const & cpit, bool output_active,
1315                             UpdateType utype, TocBackend & backend) const
1316 {
1317         if (isListings(params())) {
1318                 if (label_)
1319                         label_->addToToc(cpit, output_active, utype, backend);
1320                 TocBuilder & b = backend.builder("listing");
1321                 b.pushItem(cpit, screenLabel(), output_active);
1322                 InsetListingsParams p(to_utf8(params()["lstparams"]));
1323                 b.argumentItem(from_utf8(p.getParamValue("caption")));
1324                 b.pop();
1325         } else if (isVerbatim(params())) {
1326                 TocBuilder & b = backend.builder("child");
1327                 b.pushItem(cpit, screenLabel(), output_active);
1328                 b.pop();
1329         } else {
1330                 Buffer const * const childbuffer = getChildBuffer();
1331
1332                 TocBuilder & b = backend.builder("child");
1333                 docstring str = childbuffer ? childbuffer->fileName().displayName()
1334                         : from_ascii("?");
1335                 b.pushItem(cpit, str, output_active);
1336                 b.pop();
1337
1338                 if (!childbuffer)
1339                         return;
1340
1341                 // Update the child's tocBackend. The outliner uses the master's, but
1342                 // the navigation menu uses the child's.
1343                 childbuffer->tocBackend().update(output_active, utype);
1344                 // Include Tocs from children
1345                 childbuffer->inset().addToToc(DocIterator(), output_active, utype,
1346                                               backend);
1347                 //Copy missing outliner names (though the user has been warned against
1348                 //having different document class and module selection between master
1349                 //and child).
1350                 for (auto const & name
1351                              : childbuffer->params().documentClass().outlinerNames())
1352                         backend.addName(name.first, translateIfPossible(name.second));
1353         }
1354 }
1355
1356
1357 void InsetInclude::updateCommand()
1358 {
1359         if (!label_)
1360                 return;
1361
1362         docstring old_label = label_->getParam("name");
1363         label_->updateLabel(old_label);
1364         // the label might have been adapted (duplicate)
1365         docstring new_label = label_->getParam("name");
1366         if (old_label == new_label)
1367                 return;
1368
1369         // update listings parameters...
1370         InsetCommandParams p(INCLUDE_CODE);
1371         p = params();
1372         InsetListingsParams par(to_utf8(params()["lstparams"]));
1373         par.addParam("label", "{" + to_utf8(new_label) + "}", true);
1374         p["lstparams"] = from_utf8(par.params());
1375         setParams(p);
1376 }
1377
1378
1379 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
1380 {
1381         file_exist_ = includedFileExist();
1382
1383         button_.update(screenLabel(), true, false, !file_exist_);
1384
1385         Buffer const * const childbuffer = getChildBuffer();
1386         if (childbuffer) {
1387                 childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);
1388                 return;
1389         }
1390         if (!isListings(params()))
1391                 return;
1392
1393         if (label_)
1394                 label_->updateBuffer(it, utype, deleted);
1395
1396         InsetListingsParams const par(to_utf8(params()["lstparams"]));
1397         if (par.getParamValue("caption").empty()) {
1398                 listings_label_ = buffer().B_("Program Listing");
1399                 return;
1400         }
1401         Buffer const & master = *buffer().masterBuffer();
1402         Counters & counters = master.params().documentClass().counters();
1403         docstring const cnt = from_ascii("listing");
1404         listings_label_ = master.B_("Program Listing");
1405         if (counters.hasCounter(cnt)) {
1406                 counters.step(cnt, utype);
1407                 listings_label_ += " " + convert<docstring>(counters.value(cnt));
1408         }
1409 }
1410
1411
1412 bool InsetInclude::includedFileExist() const
1413 {
1414         // check whether the included file exist
1415         string incFileName = ltrim(to_utf8(params()["filename"]));
1416         FileName fn =
1417                 support::makeAbsPath(incFileName,
1418                                      support::onlyPath(buffer().absFileName()));
1419         return fn.exists();
1420 }
1421
1422 } // namespace lyx