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