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