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