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 "cursor.h"
  21 #include "debug.h"
  22 #include "dispatchresult.h"
  23 #include "funcrequest.h"
  24 #include "gettext.h"
  25 #include "LaTeXFeatures.h"
  26 #include "lyx_main.h"
  27 #include "lyxlex.h"
  28 #include "metricsinfo.h"
  29 #include "outputparams.h"
  30
  31 #include "frontends/LyXView.h"
  32 #include "frontends/Painter.h"
  33
  34 #include "graphics/PreviewLoader.h"
  35
  36 #include "insets/render_preview.h"
  37
  38 #include "support/FileInfo.h"
  39 #include "support/filetools.h"
  40 #include "support/lstrings.h" // contains
  41 #include "support/tostr.h"
  42
  43 #include <boost/bind.hpp>
  44
  45 #include "support/std_ostream.h"
  46 #include "support/std_sstream.h"
  47
  48 using lyx::support::AddName;
  49 using lyx::support::ChangeExtension;
  50 using lyx::support::contains;
  51 using lyx::support::FileInfo;
  52 using lyx::support::GetFileContents;
  53 using lyx::support::IsFileReadable;
  54 using lyx::support::IsLyXFilename;
  55 using lyx::support::MakeAbsPath;
  56 using lyx::support::MakeDisplayPath;
  57 using lyx::support::OnlyFilename;
  58 using lyx::support::OnlyPath;
  59 using lyx::support::subst;
  60
  61 using std::endl;
  62 using std::string;
  63 using std::auto_ptr;
  64 using std::istringstream;
  65 using std::ostream;
  66 using std::ostringstream;
  67
  68
  69 extern BufferList bufferlist;
  70
  71
  72 namespace {
  73
  74 string const uniqueID()
  75 {
  76         static unsigned int seed = 1000;
  77         return "file" + tostr(++seed);
  78 }
  79
  80 } // namespace anon
  81
  82
  83 InsetInclude::InsetInclude(InsetCommandParams const & p)
  84         : params_(p), include_label(uniqueID()),
  85           preview_(new RenderMonitoredPreview),
  86           set_label_(false)
  87 {
  88         preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
  89         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
  90 }
  91
  92
  93 InsetInclude::InsetInclude(InsetInclude const & other)
  94         : InsetOld(other),
  95           params_(other.params_),
  96           include_label(other.include_label),
  97           preview_(new RenderMonitoredPreview),
  98           set_label_(other.set_label_)
  99 {
 100         preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
 101         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 102 }
 103
 104
 105 InsetInclude::~InsetInclude()
 106 {
 107         InsetIncludeMailer(*this).hideDialog();
 108 }
 109
 110
 111 void InsetInclude::priv_dispatch(LCursor & cur, FuncRequest const & cmd)
 112 {
 113         switch (cmd.action) {
 114
 115         case LFUN_INSET_MODIFY: {
 116                 InsetCommandParams p;
 117                 InsetIncludeMailer::string2params(cmd.argument, p);
 118                 if (!p.getCmdName().empty()) {
 119                         set(p, *cur.bv().buffer());
 120                         cur.bv().update();
 121                 }
 122                 break;
 123         }
 124
 125         case LFUN_INSET_DIALOG_UPDATE:
 126                 InsetIncludeMailer(*this).updateDialog(&cur.bv());
 127                 break;
 128
 129         case LFUN_MOUSE_RELEASE:
 130                 if (button_.box().contains(cmd.x, cmd.y))
 131                         InsetIncludeMailer(*this).showDialog(&cur.bv());
 132                 break;
 133
 134         case LFUN_INSET_DIALOG_SHOW:
 135                 InsetIncludeMailer(*this).showDialog(&cur.bv());
 136                 break;
 137
 138         default:
 139                 InsetOld::dispatch(cur, cmd);
 140                 break;
 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                         OutputParams 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::plaintext(Buffer const & buffer, ostream & os,
 368                         OutputParams const &) const
 369 {
 370         if (isVerbatim(params_))
 371                 os << GetFileContents(includedFilename(buffer, params_));
 372         return 0;
 373 }
 374
 375
 376 int InsetInclude::linuxdoc(Buffer const & buffer, ostream & os,
 377                            OutputParams const & runparams) const
 378 {
 379         string incfile(params_.getContents());
 380
 381         // Do nothing if no file name has been specified
 382         if (incfile.empty())
 383                 return 0;
 384
 385         string const included_file = includedFilename(buffer, params_);
 386
 387         if (loadIfNeeded(buffer, params_)) {
 388                 Buffer * tmp = bufferlist.getBuffer(included_file);
 389
 390                 // write it to a file (so far the complete file)
 391                 string writefile = ChangeExtension(included_file, ".sgml");
 392                 if (!buffer.temppath().empty() && !runparams.nice) {
 393                         incfile = subst(incfile, '/','@');
 394                         writefile = AddName(buffer.temppath(), incfile);
 395                 } else
 396                         writefile = included_file;
 397
 398                 if (IsLyXFilename(included_file))
 399                         writefile = ChangeExtension(writefile, ".sgml");
 400
 401                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 402                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 403
 404                 OutputParams runp = runparams;
 405                 tmp->makeLinuxDocFile(writefile, runp, true);
 406         }
 407
 408         if (isVerbatim(params_)) {
 409                 os << "<![CDATA["
 410                    << GetFileContents(included_file)
 411                    << "]]>";
 412         } else
 413                 os << '&' << include_label << ';';
 414
 415         return 0;
 416 }
 417
 418
 419 int InsetInclude::docbook(Buffer const & buffer, ostream & os,
 420                           OutputParams const & runparams) const
 421 {
 422         string incfile(params_.getContents());
 423
 424         // Do nothing if no file name has been specified
 425         if (incfile.empty())
 426                 return 0;
 427
 428         string const included_file = includedFilename(buffer, params_);
 429
 430         if (loadIfNeeded(buffer, params_)) {
 431                 Buffer * tmp = bufferlist.getBuffer(included_file);
 432
 433                 // write it to a file (so far the complete file)
 434                 string writefile = ChangeExtension(included_file, ".sgml");
 435                 if (!buffer.temppath().empty() && !runparams.nice) {
 436                         incfile = subst(incfile, '/','@');
 437                         writefile = AddName(buffer.temppath(), incfile);
 438                 } else
 439                         writefile = included_file;
 440                 if (IsLyXFilename(included_file))
 441                         writefile = ChangeExtension(writefile, ".sgml");
 442
 443                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 444                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 445
 446                 OutputParams runp = runparams;
 447                 tmp->makeDocBookFile(writefile, runp, true);
 448         }
 449
 450         if (isVerbatim(params_)) {
 451                 os << "<inlinegraphic fileref=\""
 452                    << '&' << include_label << ';'
 453                    << "\" format=\"linespecific\">";
 454         } else
 455                 os << '&' << include_label << ';';
 456
 457         return 0;
 458 }
 459
 460
 461 void InsetInclude::validate(LaTeXFeatures & features) const
 462 {
 463         string incfile(params_.getContents());
 464         string writefile;
 465
 466         Buffer const & buffer = features.buffer();
 467
 468         string const included_file = includedFilename(buffer, params_);
 469
 470         if (IsLyXFilename(included_file))
 471                 writefile = ChangeExtension(writefile, ".sgml");
 472         else if (!buffer.temppath().empty() &&
 473                  !features.nice() &&
 474                  !isVerbatim(params_)) {
 475                 incfile = subst(incfile, '/','@');
 476 #ifdef __EMX__
 477 // FIXME: It seems that the following is necessary (see latex() above)
 478 //              incfile = subst(incfile, ':', '$');
 479 #endif
 480                 writefile = AddName(buffer.temppath(), incfile);
 481         } else
 482                 writefile = included_file;
 483
 484         features.includeFile(include_label, writefile);
 485
 486         if (isVerbatim(params_))
 487                 features.require("verbatim");
 488
 489         // Here we must do the fun stuff...
 490         // Load the file in the include if it needs
 491         // to be loaded:
 492         if (loadIfNeeded(buffer, params_)) {
 493                 // a file got loaded
 494                 Buffer * const tmp = bufferlist.getBuffer(included_file);
 495                 if (tmp)
 496                         tmp->validate(features);
 497         }
 498 }
 499
 500
 501 void InsetInclude::getLabelList(Buffer const & buffer,
 502                                 std::vector<string> & list) const
 503 {
 504         if (loadIfNeeded(buffer, params_)) {
 505                 string const included_file = includedFilename(buffer, params_);
 506                 Buffer * tmp = bufferlist.getBuffer(included_file);
 507                 tmp->setParentName("");
 508                 tmp->getLabelList(list);
 509                 tmp->setParentName(masterFilename(buffer));
 510         }
 511 }
 512
 513
 514 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
 515                                    std::vector<std::pair<string,string> > & keys) const
 516 {
 517         if (loadIfNeeded(buffer, params_)) {
 518                 string const included_file = includedFilename(buffer, params_);
 519                 Buffer * tmp = bufferlist.getBuffer(included_file);
 520                 tmp->setParentName("");
 521                 tmp->fillWithBibKeys(keys);
 522                 tmp->setParentName(masterFilename(buffer));
 523         }
 524 }
 525
 526
 527 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 528 {
 529         if (RenderPreview::activated() && preview_->previewReady()) {
 530                 preview_->metrics(mi, dim);
 531         } else {
 532                 if (!set_label_) {
 533                         set_label_ = true;
 534                         button_.update(getScreenLabel(*mi.base.bv->buffer()),
 535                                        editable() != NOT_EDITABLE);
 536                 }
 537                 button_.metrics(mi, dim);
 538         }
 539         int center_indent = type(params_) == INPUT ?
 540                 0 : (mi.base.textwidth - dim.wid) / 2;
 541         Box b(center_indent, center_indent + dim.wid, -dim.asc, dim.des);
 542         button_.setBox(b);
 543
 544         dim.wid = mi.base.textwidth;
 545         dim_ = dim;
 546 }
 547
 548
 549 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 550 {
 551         setPosCache(pi, x, y);
 552
 553         if (!RenderPreview::activated() || !preview_->previewReady()) {
 554                 button_.draw(pi, x + button_.box().x1, y);
 555                 return;
 556         }
 557
 558         preview_->draw(pi, x + button_.box().x1, y);
 559 }
 560
 561
 562 //
 563 // preview stuff
 564 //
 565
 566 void InsetInclude::statusChanged() const
 567 {
 568         LyX::cref().updateInset(this);
 569 }
 570
 571
 572 void InsetInclude::fileChanged() const
 573 {
 574         Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
 575         if (!buffer_ptr)
 576                 return;
 577
 578         Buffer const & buffer = *buffer_ptr;
 579         preview_->removePreview(buffer);
 580         add_preview(*preview_.get(), *this, buffer);
 581         preview_->startLoading(buffer);
 582 }
 583
 584
 585 namespace {
 586
 587 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 588 {
 589         string const included_file = includedFilename(buffer, params);
 590
 591         return type(params) == INPUT && params.preview() &&
 592                 IsFileReadable(included_file);
 593 }
 594
 595
 596 string const latex_string(InsetInclude const & inset, Buffer const & buffer)
 597 {
 598         ostringstream os;
 599         OutputParams runparams;
 600         runparams.flavor = OutputParams::LATEX;
 601         inset.latex(buffer, os, runparams);
 602
 603         return os.str();
 604 }
 605
 606
 607 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
 608                  Buffer const & buffer)
 609 {
 610         InsetCommandParams const & params = inset.params();
 611         if (RenderPreview::activated() && preview_wanted(params, buffer)) {
 612                 renderer.setAbsFile(includedFilename(buffer, params));
 613                 string const snippet = latex_string(inset, buffer);
 614                 renderer.addPreview(snippet, buffer);
 615         }
 616 }
 617
 618 } // namespace anon
 619
 620
 621 void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const
 622 {
 623         Buffer const & buffer = ploader.buffer();
 624         if (preview_wanted(params(), buffer)) {
 625                 preview_->setAbsFile(includedFilename(buffer, params()));
 626                 string const snippet = latex_string(*this, buffer);
 627                 preview_->addPreview(snippet, ploader);
 628         }
 629 }
 630
 631
 632 string const InsetIncludeMailer::name_("include");
 633
 634 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
 635         : inset_(inset)
 636 {}
 637
 638
 639 string const InsetIncludeMailer::inset2string(Buffer const &) const
 640 {
 641         return params2string(inset_.params());
 642 }
 643
 644
 645 void InsetIncludeMailer::string2params(string const & in,
 646                                        InsetCommandParams & params)
 647 {
 648         params = InsetCommandParams();
 649         if (in.empty())
 650                 return;
 651
 652         istringstream data(in);
 653         LyXLex lex(0,0);
 654         lex.setStream(data);
 655
 656         string name;
 657         lex >> name;
 658         if (!lex || name != name_)
 659                 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
 660
 661         // This is part of the inset proper that is usually swallowed
 662         // by LyXText::readInset
 663         string id;
 664         lex >> id;
 665         if (!lex || id != "Include")
 666                 return print_mailer_error("InsetBoxMailer", in, 2, "Include");
 667
 668         InsetInclude inset(params);
 669         inset.read(lex);
 670         params = inset.params();
 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 }