src/insets/insetinclude.C

   1 /**
   2  * \file insetinclude.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "insetinclude.h"
  14
  15 #include "buffer.h"
  16 #include "buffer_funcs.h"
  17 #include "bufferlist.h"
  18 #include "bufferparams.h"
  19 #include "BufferView.h"
  20 #include "debug.h"
  21 #include "dispatchresult.h"
  22 #include "funcrequest.h"
  23 #include "gettext.h"
  24 #include "LaTeXFeatures.h"
  25 #include "latexrunparams.h"
  26 #include "lyx_main.h"
  27 #include "lyxlex.h"
  28 #include "metricsinfo.h"
  29
  30 #include "frontends/LyXView.h"
  31 #include "frontends/Painter.h"
  32
  33 #include "graphics/PreviewLoader.h"
  34
  35 #include "insets/render_preview.h"
  36
  37 #include "support/FileInfo.h"
  38 #include "support/filetools.h"
  39 #include "support/lstrings.h" // contains
  40 #include "support/tostr.h"
  41
  42 #include <boost/bind.hpp>
  43
  44 #include "support/std_ostream.h"
  45 #include "support/std_sstream.h"
  46
  47 using lyx::support::AddName;
  48 using lyx::support::ChangeExtension;
  49 using lyx::support::contains;
  50 using lyx::support::FileInfo;
  51 using lyx::support::GetFileContents;
  52 using lyx::support::IsFileReadable;
  53 using lyx::support::IsLyXFilename;
  54 using lyx::support::MakeAbsPath;
  55 using lyx::support::MakeDisplayPath;
  56 using lyx::support::OnlyFilename;
  57 using lyx::support::OnlyPath;
  58 using lyx::support::subst;
  59
  60 using std::endl;
  61 using std::string;
  62 using std::auto_ptr;
  63 using std::istringstream;
  64 using std::ostream;
  65 using std::ostringstream;
  66
  67
  68 extern BufferList bufferlist;
  69
  70
  71 namespace {
  72
  73 string const uniqueID()
  74 {
  75         static unsigned int seed = 1000;
  76         return "file" + tostr(++seed);
  77 }
  78
  79 } // namespace anon
  80
  81
  82 InsetInclude::InsetInclude(InsetCommandParams const & p)
  83         : params_(p), include_label(uniqueID()),
  84           preview_(new RenderMonitoredPreview),
  85           set_label_(false)
  86 {
  87         preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
  88         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
  89 }
  90
  91
  92 InsetInclude::InsetInclude(InsetInclude const & other)
  93         : InsetOld(other),
  94           params_(other.params_),
  95           include_label(other.include_label),
  96           preview_(new RenderMonitoredPreview),
  97           set_label_(other.set_label_)
  98 {
  99         preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
 100         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 101 }
 102
 103
 104 InsetInclude::~InsetInclude()
 105 {
 106         InsetIncludeMailer mailer(*this);
 107         mailer.hideDialog();
 108 }
 109
 110
 111 DispatchResult
 112 InsetInclude::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
 113 {
 114         switch (cmd.action) {
 115
 116         case LFUN_INSET_MODIFY: {
 117                 InsetCommandParams p;
 118                 InsetIncludeMailer::string2params(cmd.argument, p);
 119                 if (!p.getCmdName().empty()) {
 120                         set(p, *cmd.view()->buffer());
 121                         cmd.view()->updateInset(this);
 122                 }
 123                 return DispatchResult(DISPATCHED);
 124         }
 125
 126         case LFUN_INSET_DIALOG_UPDATE:
 127                 InsetIncludeMailer(*this).updateDialog(cmd.view());
 128                 return DispatchResult(DISPATCHED);
 129
 130         case LFUN_MOUSE_RELEASE:
 131                 if (button_.box().contains(cmd.x, cmd.y))
 132                         InsetIncludeMailer(*this).showDialog(cmd.view());
 133                 return DispatchResult(DISPATCHED);
 134
 135         case LFUN_INSET_DIALOG_SHOW:
 136                 InsetIncludeMailer(*this).showDialog(cmd.view());
 137                 return DispatchResult(DISPATCHED);
 138
 139         default:
 140                 return DispatchResult(UNDISPATCHED);
 141         }
 142 }
 143
 144
 145 InsetCommandParams const & InsetInclude::params() const
 146 {
 147         return params_;
 148 }
 149
 150
 151 namespace {
 152
 153 /// the type of inclusion
 154 enum Types {
 155         INCLUDE = 0,
 156         VERB = 1,
 157         INPUT = 2,
 158         VERBAST = 3
 159 };
 160
 161
 162 Types type(InsetCommandParams const & params)
 163 {
 164         string const command_name = params.getCmdName();
 165
 166         if (command_name == "input")
 167                 return INPUT;
 168         if  (command_name == "verbatiminput")
 169                 return VERB;
 170         if  (command_name == "verbatiminput*")
 171                 return VERBAST;
 172         return INCLUDE;
 173 }
 174
 175
 176 bool isVerbatim(InsetCommandParams const & params)
 177 {
 178         string const command_name = params.getCmdName();
 179         return command_name == "verbatiminput" ||
 180                 command_name == "verbatiminput*";
 181 }
 182
 183
 184 string const masterFilename(Buffer const & buffer)
 185 {
 186         return buffer.fileName();
 187 }
 188
 189
 190 string const includedFilename(Buffer const & buffer,
 191                               InsetCommandParams const & params)
 192 {
 193         return MakeAbsPath(params.getContents(),
 194                            OnlyPath(masterFilename(buffer)));
 195 }
 196
 197
 198 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
 199
 200 } // namespace anon
 201
 202
 203 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
 204 {
 205         params_ = p;
 206         set_label_ = false;
 207
 208         if (preview_->monitoring())
 209                 preview_->stopMonitoring();
 210
 211         if (type(params_) == INPUT)
 212                 add_preview(*preview_, *this, buffer);
 213 }
 214
 215
 216 auto_ptr<InsetBase> InsetInclude::clone() const
 217 {
 218         return auto_ptr<InsetBase>(new InsetInclude(*this));
 219 }
 220
 221
 222 void InsetInclude::write(Buffer const &, ostream & os) const
 223 {
 224         write(os);
 225 }
 226
 227
 228 void InsetInclude::write(ostream & os) const
 229 {
 230         os << "Include " << params_.getCommand() << '\n'
 231            << "preview " << tostr(params_.preview()) << '\n';
 232 }
 233
 234
 235 void InsetInclude::read(Buffer const &, LyXLex & lex)
 236 {
 237         read(lex);
 238 }
 239
 240
 241 void InsetInclude::read(LyXLex & lex)
 242 {
 243         params_.read(lex);
 244 }
 245
 246
 247 string const InsetInclude::getScreenLabel(Buffer const &) const
 248 {
 249         string temp;
 250
 251         switch (type(params_)) {
 252                 case INPUT: temp += _("Input"); break;
 253                 case VERB: temp += _("Verbatim Input"); break;
 254                 case VERBAST: temp += _("Verbatim Input*"); break;
 255                 case INCLUDE: temp += _("Include"); break;
 256         }
 257
 258         temp += ": ";
 259
 260         if (params_.getContents().empty())
 261                 temp += "???";
 262         else
 263                 temp += OnlyFilename(params_.getContents());
 264
 265         return temp;
 266 }
 267
 268
 269 namespace {
 270
 271 /// return true if the file is or got loaded.
 272 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
 273 {
 274         if (isVerbatim(params))
 275                 return false;
 276
 277         string const included_file = includedFilename(buffer, params);
 278         if (!IsLyXFilename(included_file))
 279                 return false;
 280
 281         if (bufferlist.exists(included_file))
 282                 return true;
 283
 284         // the readonly flag can/will be wrong, not anymore I think.
 285         FileInfo finfo(included_file);
 286         if (!finfo.isOK())
 287                 return false;
 288         return loadLyXFile(bufferlist.newBuffer(included_file),
 289                            included_file);
 290 }
 291
 292
 293 } // namespace anon
 294
 295
 296 int InsetInclude::latex(Buffer const & buffer, ostream & os,
 297                         LatexRunParams const & runparams) const
 298 {
 299         string incfile(params_.getContents());
 300
 301         // Do nothing if no file name has been specified
 302         if (incfile.empty())
 303                 return 0;
 304
 305         string const included_file = includedFilename(buffer, params_);
 306
 307         if (loadIfNeeded(buffer, params_)) {
 308                 Buffer * tmp = bufferlist.getBuffer(included_file);
 309
 310                 // FIXME: this should be a GUI warning
 311                 if (tmp->params().textclass != buffer.params().textclass) {
 312                         lyxerr << "WARNING: Included file `"
 313                                << MakeDisplayPath(included_file)
 314                                << "' has textclass `"
 315                                << tmp->params().getLyXTextClass().name()
 316                                << "' while parent file has textclass `"
 317                                << buffer.params().getLyXTextClass().name()
 318                                << "'." << endl;
 319                         //return 0;
 320                 }
 321
 322                 // write it to a file (so far the complete file)
 323                 string writefile = ChangeExtension(included_file, ".tex");
 324
 325                 if (!buffer.temppath().empty() && !runparams.nice) {
 326                         incfile = subst(incfile, '/','@');
 327 #ifdef __EMX__
 328                         incfile = subst(incfile, ':', '$');
 329 #endif
 330                         writefile = AddName(buffer.temppath(), incfile);
 331                 } else
 332                         writefile = included_file;
 333                 writefile = ChangeExtension(writefile, ".tex");
 334                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 335                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 336
 337                 tmp->markDepClean(buffer.temppath());
 338
 339                 tmp->makeLaTeXFile(writefile,
 340                                    OnlyPath(masterFilename(buffer)),
 341                                    runparams, false);
 342         }
 343
 344         if (isVerbatim(params_)) {
 345                 os << '\\' << params_.getCmdName() << '{' << incfile << '}';
 346         } else if (type(params_) == INPUT) {
 347                 // \input wants file with extension (default is .tex)
 348                 if (!IsLyXFilename(included_file)) {
 349                         os << '\\' << params_.getCmdName() << '{' << incfile << '}';
 350                 } else {
 351                         os << '\\' << params_.getCmdName() << '{'
 352                            << ChangeExtension(incfile, ".tex")
 353                            <<  '}';
 354                 }
 355         } else {
 356                 // \include don't want extension and demands that the
 357                 // file really have .tex
 358                 os << '\\' << params_.getCmdName() << '{'
 359                    << ChangeExtension(incfile, string())
 360                    << '}';
 361         }
 362
 363         return 0;
 364 }
 365
 366
 367 int InsetInclude::ascii(Buffer const & buffer, ostream & os, int) const
 368 {
 369         if (isVerbatim(params_))
 370                 os << GetFileContents(includedFilename(buffer, params_));
 371         return 0;
 372 }
 373
 374
 375 int InsetInclude::linuxdoc(Buffer const & buffer, ostream & os) const
 376 {
 377         string incfile(params_.getContents());
 378
 379         // Do nothing if no file name has been specified
 380         if (incfile.empty())
 381                 return 0;
 382
 383         string const included_file = includedFilename(buffer, params_);
 384
 385         if (loadIfNeeded(buffer, params_)) {
 386                 Buffer * tmp = bufferlist.getBuffer(included_file);
 387
 388                 // write it to a file (so far the complete file)
 389                 string writefile = ChangeExtension(included_file, ".sgml");
 390                 if (!buffer.temppath().empty() && !buffer.niceFile()) {
 391                         incfile = subst(incfile, '/','@');
 392                         writefile = AddName(buffer.temppath(), incfile);
 393                 } else
 394                         writefile = included_file;
 395
 396                 if (IsLyXFilename(included_file))
 397                         writefile = ChangeExtension(writefile, ".sgml");
 398
 399                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 400                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 401
 402                 tmp->makeLinuxDocFile(writefile, buffer.niceFile(), true);
 403         }
 404
 405         if (isVerbatim(params_)) {
 406                 os << "<![CDATA["
 407                    << GetFileContents(included_file)
 408                    << "]]>";
 409         } else
 410                 os << '&' << include_label << ';';
 411
 412         return 0;
 413 }
 414
 415
 416 int InsetInclude::docbook(Buffer const & buffer, ostream & os,
 417                           bool /*mixcont*/) const
 418 {
 419         string incfile(params_.getContents());
 420
 421         // Do nothing if no file name has been specified
 422         if (incfile.empty())
 423                 return 0;
 424
 425         string const included_file = includedFilename(buffer, params_);
 426
 427         if (loadIfNeeded(buffer, params_)) {
 428                 Buffer * tmp = bufferlist.getBuffer(included_file);
 429
 430                 // write it to a file (so far the complete file)
 431                 string writefile = ChangeExtension(included_file, ".sgml");
 432                 if (!buffer.temppath().empty() && !buffer.niceFile()) {
 433                         incfile = subst(incfile, '/','@');
 434                         writefile = AddName(buffer.temppath(), incfile);
 435                 } else
 436                         writefile = included_file;
 437                 if (IsLyXFilename(included_file))
 438                         writefile = ChangeExtension(writefile, ".sgml");
 439
 440                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 441                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 442
 443                 tmp->makeDocBookFile(writefile, buffer.niceFile(), true);
 444         }
 445
 446         if (isVerbatim(params_)) {
 447                 os << "<inlinegraphic fileref=\""
 448                    << '&' << include_label << ';'
 449                    << "\" format=\"linespecific\">";
 450         } else
 451                 os << '&' << include_label << ';';
 452
 453         return 0;
 454 }
 455
 456
 457 void InsetInclude::validate(LaTeXFeatures & features) const
 458 {
 459         string incfile(params_.getContents());
 460         string writefile;
 461
 462         Buffer const & buffer = features.buffer();
 463
 464         string const included_file = includedFilename(buffer, params_);
 465
 466         if (!buffer.temppath().empty() &&
 467             !buffer.niceFile() &&
 468             !isVerbatim(params_)) {
 469                 incfile = subst(incfile, '/','@');
 470                 writefile = AddName(buffer.temppath(), incfile);
 471         } else
 472                 writefile = included_file;
 473
 474         if (IsLyXFilename(included_file))
 475                 writefile = ChangeExtension(writefile, ".sgml");
 476
 477         features.includeFile(include_label, writefile);
 478
 479         if (isVerbatim(params_))
 480                 features.require("verbatim");
 481
 482         // Here we must do the fun stuff...
 483         // Load the file in the include if it needs
 484         // to be loaded:
 485         if (loadIfNeeded(buffer, params_)) {
 486                 // a file got loaded
 487                 Buffer * const tmp = bufferlist.getBuffer(included_file);
 488                 if (tmp) {
 489                         tmp->niceFile() = buffer.niceFile();
 490                         tmp->validate(features);
 491                 }
 492         }
 493 }
 494
 495
 496 void InsetInclude::getLabelList(Buffer const & buffer,
 497                                 std::vector<string> & list) const
 498 {
 499         if (loadIfNeeded(buffer, params_)) {
 500                 string const included_file = includedFilename(buffer, params_);
 501                 Buffer * tmp = bufferlist.getBuffer(included_file);
 502                 tmp->setParentName("");
 503                 tmp->getLabelList(list);
 504                 tmp->setParentName(masterFilename(buffer));
 505         }
 506 }
 507
 508
 509 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
 510                                    std::vector<std::pair<string,string> > & keys) const
 511 {
 512         if (loadIfNeeded(buffer, params_)) {
 513                 string const included_file = includedFilename(buffer, params_);
 514                 Buffer * tmp = bufferlist.getBuffer(included_file);
 515                 tmp->setParentName("");
 516                 tmp->fillWithBibKeys(keys);
 517                 tmp->setParentName(masterFilename(buffer));
 518         }
 519 }
 520
 521
 522 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 523 {
 524         if (RenderPreview::activated() && preview_->previewReady()) {
 525                 preview_->metrics(mi, dim);
 526         } else {
 527                 if (!set_label_) {
 528                         set_label_ = true;
 529                         button_.update(getScreenLabel(*mi.base.bv->buffer()),
 530                                        editable() != NOT_EDITABLE);
 531                 }
 532                 button_.metrics(mi, dim);
 533         }
 534         int center_indent = type(params_) == INPUT ?
 535                 0 : (mi.base.textwidth - dim.wid) / 2;
 536         Box b(center_indent, center_indent + dim.wid, -dim.asc, dim.des);
 537         button_.setBox(b);
 538
 539         dim.wid = mi.base.textwidth;
 540         dim_ = dim;
 541 }
 542
 543
 544 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 545 {
 546         if (!RenderPreview::activated() || !preview_->previewReady()) {
 547                 button_.draw(pi, x + button_.box().x1, y);
 548                 return;
 549         }
 550
 551         preview_->draw(pi, x + button_.box().x1, y);
 552 }
 553
 554
 555 //
 556 // preview stuff
 557 //
 558
 559 void InsetInclude::statusChanged() const
 560 {
 561         LyX::cref().updateInset(this);
 562 }
 563
 564
 565 void InsetInclude::fileChanged() const
 566 {
 567         Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
 568         if (!buffer_ptr)
 569                 return;
 570
 571         Buffer const & buffer = *buffer_ptr;
 572         preview_->removePreview(buffer);
 573         add_preview(*preview_.get(), *this, buffer);
 574         preview_->startLoading(buffer);
 575 }
 576
 577
 578 namespace {
 579
 580 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 581 {
 582         string const included_file = includedFilename(buffer, params);
 583
 584         return type(params) == INPUT && params.preview() &&
 585                 IsFileReadable(included_file);
 586 }
 587
 588
 589 string const latex_string(InsetInclude const & inset, Buffer const & buffer)
 590 {
 591         ostringstream os;
 592         LatexRunParams runparams;
 593         runparams.flavor = LatexRunParams::LATEX;
 594         inset.latex(buffer, os, runparams);
 595
 596         return os.str();
 597 }
 598
 599
 600 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
 601                  Buffer const & buffer)
 602 {
 603         InsetCommandParams const & params = inset.params();
 604         if (RenderPreview::activated() && preview_wanted(params, buffer)) {
 605                 renderer.setAbsFile(includedFilename(buffer, params));
 606                 string const snippet = latex_string(inset, buffer);
 607                 renderer.addPreview(snippet, buffer);
 608         }
 609 }
 610
 611 } // namespace anon
 612
 613
 614 void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const
 615 {
 616         Buffer const & buffer = ploader.buffer();
 617         if (preview_wanted(params(), buffer)) {
 618                 preview_->setAbsFile(includedFilename(buffer, params()));
 619                 string const snippet = latex_string(*this, buffer);
 620                 preview_->addPreview(snippet, ploader);
 621         }
 622 }
 623
 624
 625 string const InsetIncludeMailer::name_("include");
 626
 627 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
 628         : inset_(inset)
 629 {}
 630
 631
 632 string const InsetIncludeMailer::inset2string(Buffer const &) const
 633 {
 634         return params2string(inset_.params());
 635 }
 636
 637
 638 void InsetIncludeMailer::string2params(string const & in,
 639                                        InsetCommandParams & params)
 640 {
 641         params = InsetCommandParams();
 642
 643         if (in.empty())
 644                 return;
 645
 646         istringstream data(in);
 647         LyXLex lex(0,0);
 648         lex.setStream(data);
 649
 650         if (lex.isOK()) {
 651                 lex.next();
 652                 string const token = lex.getString();
 653                 if (token != name_)
 654                         return;
 655         }
 656
 657         // This is part of the inset proper that is usually swallowed
 658         // by Buffer::readInset
 659         if (lex.isOK()) {
 660                 lex.next();
 661                 string const token = lex.getString();
 662                 if (token != "Include")
 663                         return;
 664         }
 665
 666         if (lex.isOK()) {
 667                 InsetInclude inset(params);
 668                 inset.read(lex);
 669                 params = inset.params();
 670         }
 671 }
 672
 673
 674 string const
 675 InsetIncludeMailer::params2string(InsetCommandParams const & params)
 676 {
 677         InsetInclude inset(params);
 678         ostringstream data;
 679         data << name_ << ' ';
 680         inset.write(data);
 681         data << "\\end_inset\n";
 682         return data.str();
 683 }