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,
 290                         bool /*fragile*/, bool /*fs*/) const
 291 {
 292         string incfile(params_.cparams.getContents());
 293
 294         // Do nothing if no file name has been specified
 295         if (incfile.empty())
 296                 return 0;
 297
 298         if (loadIfNeeded()) {
 299                 Buffer * tmp = bufferlist.getBuffer(getFileName());
 300
 301                 // FIXME: this should be a GUI warning
 302                 if (tmp->params.textclass != buffer->params.textclass) {
 303                         lyxerr << "WARNING: Included file `"
 304                                << MakeDisplayPath(getFileName())
 305                                << "' has textclass `"
 306                                << tmp->params.getLyXTextClass().name()
 307                                << "' while parent file has textclass `"
 308                                << buffer->params.getLyXTextClass().name()
 309                                << "'." << endl;
 310                         //return 0;
 311                 }
 312
 313                 // write it to a file (so far the complete file)
 314                 string writefile = ChangeExtension(getFileName(), ".tex");
 315
 316                 if (!buffer->tmppath.empty() && !runparams.nice) {
 317                         incfile = subst(incfile, '/','@');
 318 #ifdef __EMX__
 319                         incfile = subst(incfile, ':', '$');
 320 #endif
 321                         writefile = AddName(buffer->tmppath, incfile);
 322                 } else
 323                         writefile = getFileName();
 324                 writefile = ChangeExtension(writefile, ".tex");
 325                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 326                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 327
 328                 tmp->markDepClean(buffer->tmppath);
 329
 330                 tmp->makeLaTeXFile(writefile, OnlyPath(getMasterFilename()),
 331                                    runparams, true);
 332         }
 333
 334         if (isVerbatim()) {
 335                 os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
 336         } else if (params_.flag == INPUT) {
 337                 // \input wants file with extension (default is .tex)
 338                 if (!IsLyXFilename(getFileName())) {
 339                         os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
 340                 } else {
 341                         os << '\\' << params_.cparams.getCmdName() << '{'
 342                            << ChangeExtension(incfile, ".tex")
 343                            <<  '}';
 344                 }
 345         } else {
 346                 // \include don't want extension and demands that the
 347                 // file really have .tex
 348                 os << '\\' << params_.cparams.getCmdName() << '{'
 349                    << ChangeExtension(incfile, string())
 350                    << '}';
 351         }
 352
 353         return 0;
 354 }
 355
 356
 357 int InsetInclude::ascii(Buffer const *, ostream & os, int) const
 358 {
 359         if (isVerbatim())
 360                 os << GetFileContents(getFileName());
 361         return 0;
 362 }
 363
 364
 365 int InsetInclude::linuxdoc(Buffer const * buffer, ostream & os) const
 366 {
 367         string incfile(params_.cparams.getContents());
 368
 369         // Do nothing if no file name has been specified
 370         if (incfile.empty())
 371                 return 0;
 372
 373         if (loadIfNeeded()) {
 374                 Buffer * tmp = bufferlist.getBuffer(getFileName());
 375
 376                 // write it to a file (so far the complete file)
 377                 string writefile = ChangeExtension(getFileName(), ".sgml");
 378                 if (!buffer->tmppath.empty() && !buffer->niceFile) {
 379                         incfile = subst(incfile, '/','@');
 380                         writefile = AddName(buffer->tmppath, incfile);
 381                 } else
 382                         writefile = getFileName();
 383
 384                 if (IsLyXFilename(getFileName()))
 385                         writefile = ChangeExtension(writefile, ".sgml");
 386
 387                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 388                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 389
 390                 tmp->makeLinuxDocFile(writefile, buffer->niceFile, true);
 391         }
 392
 393         if (isVerbatim()) {
 394                 os << "<![CDATA["
 395                    << GetFileContents(getFileName())
 396                    << "]]>";
 397         } else
 398                 os << '&' << include_label << ';';
 399
 400         return 0;
 401 }
 402
 403
 404 int InsetInclude::docbook(Buffer const * buffer, ostream & os,
 405                           bool /*mixcont*/) const
 406 {
 407         string incfile(params_.cparams.getContents());
 408
 409         // Do nothing if no file name has been specified
 410         if (incfile.empty())
 411                 return 0;
 412
 413         if (loadIfNeeded()) {
 414                 Buffer * tmp = bufferlist.getBuffer(getFileName());
 415
 416                 // write it to a file (so far the complete file)
 417                 string writefile = ChangeExtension(getFileName(), ".sgml");
 418                 if (!buffer->tmppath.empty() && !buffer->niceFile) {
 419                         incfile = subst(incfile, '/','@');
 420                         writefile = AddName(buffer->tmppath, incfile);
 421                 } else
 422                         writefile = getFileName();
 423                 if (IsLyXFilename(getFileName()))
 424                         writefile = ChangeExtension(writefile, ".sgml");
 425
 426                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
 427                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
 428
 429                 tmp->makeDocBookFile(writefile, buffer->niceFile, true);
 430         }
 431
 432         if (isVerbatim()) {
 433                 os << "<inlinegraphic fileref=\""
 434                    << '&' << include_label << ';'
 435                    << "\" format=\"linespecific\">";
 436         } else
 437                 os << '&' << include_label << ';';
 438
 439         return 0;
 440 }
 441
 442
 443 void InsetInclude::validate(LaTeXFeatures & features) const
 444 {
 445
 446         string incfile(params_.cparams.getContents());
 447         string writefile;
 448
 449         Buffer const * const b = bufferlist.getBuffer(getMasterFilename());
 450
 451         if (b && !b->tmppath.empty() && !b->niceFile && !isVerbatim()) {
 452                 incfile = subst(incfile, '/','@');
 453                 writefile = AddName(b->tmppath, incfile);
 454         } else
 455                 writefile = getFileName();
 456
 457         if (IsLyXFilename(getFileName()))
 458                 writefile = ChangeExtension(writefile, ".sgml");
 459
 460         features.includeFile(include_label, writefile);
 461
 462         if (isVerbatim())
 463                 features.require("verbatim");
 464
 465         // Here we must do the fun stuff...
 466         // Load the file in the include if it needs
 467         // to be loaded:
 468         if (loadIfNeeded()) {
 469                 // a file got loaded
 470                 Buffer * const tmp = bufferlist.getBuffer(getFileName());
 471                 if (tmp) {
 472                         if (b)
 473                                 tmp->niceFile = b->niceFile;
 474                         tmp->validate(features);
 475                 }
 476         }
 477 }
 478
 479
 480 vector<string> const InsetInclude::getLabelList() const
 481 {
 482         vector<string> l;
 483
 484         if (loadIfNeeded()) {
 485                 Buffer * tmp = bufferlist.getBuffer(getFileName());
 486                 tmp->setParentName("");
 487                 l = tmp->getLabelList();
 488                 tmp->setParentName(getMasterFilename());
 489         }
 490
 491         return l;
 492 }
 493
 494
 495 void InsetInclude::fillWithBibKeys(vector<pair<string,string> > & keys) const
 496 {
 497         if (loadIfNeeded()) {
 498                 Buffer * tmp = bufferlist.getBuffer(getFileName());
 499                 tmp->setParentName("");
 500                 tmp->fillWithBibKeys(keys);
 501                 tmp->setParentName(getMasterFilename());
 502         }
 503 }
 504
 505
 506 int InsetInclude::ascent(BufferView * bv, LyXFont const & font) const
 507 {
 508         return preview_->previewReady() ?
 509                 preview_->pimage()->ascent() : InsetButton::ascent(bv, font);
 510 }
 511
 512
 513 int InsetInclude::descent(BufferView * bv, LyXFont const & font) const
 514 {
 515         return preview_->previewReady() ?
 516                 preview_->pimage()->descent() : InsetButton::descent(bv, font);
 517 }
 518
 519
 520 int InsetInclude::width(BufferView * bv, LyXFont const & font) const
 521 {
 522         return preview_->previewReady() ?
 523                 preview_->pimage()->width() : InsetButton::width(bv, font);
 524 }
 525
 526
 527 void InsetInclude::draw(BufferView * bv, LyXFont const & font, int y,
 528                         float & xx) const
 529 {
 530         cache(bv);
 531         if (!preview_->previewReady()) {
 532                 InsetButton::draw(bv, font, y, xx);
 533                 return;
 534         }
 535
 536         if (!preview_->monitoring())
 537                 preview_->startMonitoring();
 538
 539         int const x = int(xx);
 540         int const w = width(bv, font);
 541         int const d = descent(bv, font);
 542         int const a = ascent(bv, font);
 543         int const h = a + d;
 544
 545         bv->painter().image(x, y - a, w, h,
 546                             *(preview_->pimage()->image()));
 547
 548         xx += w;
 549 }
 550
 551
 552 //
 553 // preview stuff
 554 //
 555
 556 void InsetInclude::addPreview(grfx::PreviewLoader & ploader) const
 557 {
 558         preview_->addPreview(ploader);
 559 }
 560
 561
 562 bool InsetInclude::PreviewImpl::previewWanted() const
 563 {
 564         return parent().params_.flag == InsetInclude::INPUT &&
 565                 parent().params_.cparams.preview() &&
 566                 IsFileReadable(parent().getFileName());
 567 }
 568
 569
 570 string const InsetInclude::PreviewImpl::latexString() const
 571 {
 572         if (!view() || !view()->buffer())
 573                 return string();
 574
 575         ostringstream os;
 576         LatexRunParams runparams;
 577         runparams.flavor = LatexRunParams::LATEX;
 578         parent().latex(view()->buffer(), os, runparams, false, false);
 579
 580         return STRCONV(os.str());
 581 }
 582
 583
 584 void InsetInclude::PreviewImpl::startMonitoring()
 585 {
 586         monitor_.reset(new FileMonitor(parent().getFileName(), 2000));
 587         monitor_->connect(boost::bind(&PreviewImpl::restartLoading, this));
 588         monitor_->start();
 589 }
 590
 591
 592 void InsetInclude::PreviewImpl::restartLoading()
 593 {
 594         lyxerr << "restartLoading()" << std::endl;
 595         removePreview();
 596         if (view())
 597                 view()->updateInset(&parent());
 598         generatePreview();
 599 }
 600
 601
 602 string const InsetIncludeMailer::name_("include");
 603
 604 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
 605         : inset_(inset)
 606 {}
 607
 608
 609 string const InsetIncludeMailer::inset2string() const
 610 {
 611         return params2string(inset_.params());
 612 }
 613
 614
 615 void InsetIncludeMailer::string2params(string const & in,
 616                                        InsetInclude::Params & params)
 617 {
 618         params = InsetInclude::Params();
 619
 620         if (in.empty())
 621                 return;
 622
 623         istringstream data(STRCONV(in));
 624         LyXLex lex(0,0);
 625         lex.setStream(data);
 626
 627         if (lex.isOK()) {
 628                 lex.next();
 629                 string const token = lex.getString();
 630                 if (token != name_)
 631                         return;
 632         }
 633
 634         // This is part of the inset proper that is usually swallowed
 635         // by Buffer::readInset
 636         if (lex.isOK()) {
 637                 lex.next();
 638                 string const token = lex.getString();
 639                 if (token != "Include")
 640                         return;
 641         }
 642
 643         if (lex.isOK()) {
 644                 InsetInclude inset(params);
 645                 inset.read(0, lex);
 646                 params = inset.params();
 647         }
 648 }
 649
 650
 651 string const
 652 InsetIncludeMailer::params2string(InsetInclude::Params const & params)
 653 {
 654         InsetInclude inset(params);
 655         inset.set(params);
 656         ostringstream data;
 657         data << name_ << ' ';
 658         inset.write(0, data);
 659         data << "\\end_inset\n";
 660         return STRCONV(data.str());
 661 }