3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "insetinclude.h"
16 #include "buffer_funcs.h"
17 #include "bufferlist.h"
18 #include "bufferparams.h"
19 #include "BufferView.h"
22 #include "dispatchresult.h"
24 #include "funcrequest.h"
25 #include "FuncStatus.h"
27 #include "LaTeXFeatures.h"
31 #include "metricsinfo.h"
32 #include "outputparams.h"
33 #include "TocBackend.h"
35 #include "frontends/Alert.h"
36 #include "frontends/Painter.h"
38 #include "graphics/PreviewImage.h"
39 #include "graphics/PreviewLoader.h"
41 #include "insets/render_preview.h"
43 #include "support/filetools.h"
44 #include "support/lstrings.h" // contains
45 #include "support/lyxalgo.h"
46 #include "support/lyxlib.h"
47 #include "support/convert.h"
49 #include <boost/bind.hpp>
50 #include <boost/filesystem/operations.hpp>
55 using support::addName;
56 using support::absolutePath;
57 using support::bformat;
58 using support::changeExtension;
59 using support::contains;
61 using support::DocFileName;
62 using support::FileName;
63 using support::getFileContents;
64 using support::isFileReadable;
65 using support::isLyXFilename;
66 using support::latex_path;
67 using support::makeAbsPath;
68 using support::makeDisplayPath;
69 using support::makeRelPath;
70 using support::onlyFilename;
71 using support::onlyPath;
78 using std::istringstream;
80 using std::ostringstream;
82 namespace Alert = frontend::Alert;
83 namespace fs = boost::filesystem;
88 docstring const uniqueID()
90 static unsigned int seed = 1000;
91 return "file" + convert<docstring>(++seed);
97 InsetInclude::InsetInclude(InsetCommandParams const & p)
98 : params_(p), include_label(uniqueID()),
99 preview_(new RenderMonitoredPreview(this)),
102 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
106 InsetInclude::InsetInclude(InsetInclude const & other)
108 params_(other.params_),
109 include_label(other.include_label),
110 preview_(new RenderMonitoredPreview(this)),
113 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
117 InsetInclude::~InsetInclude()
119 InsetIncludeMailer(*this).hideDialog();
123 void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd)
125 switch (cmd.action) {
127 case LFUN_INSET_MODIFY: {
128 InsetCommandParams p("include");
129 InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p);
130 if (!p.getCmdName().empty()) {
131 set(p, cur.buffer());
132 cur.buffer().updateBibfilesCache();
138 case LFUN_INSET_DIALOG_UPDATE:
139 InsetIncludeMailer(*this).updateDialog(&cur.bv());
142 case LFUN_MOUSE_RELEASE:
143 InsetIncludeMailer(*this).showDialog(&cur.bv());
147 InsetBase::doDispatch(cur, cmd);
153 bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd,
154 FuncStatus & flag) const
156 switch (cmd.action) {
158 case LFUN_INSET_MODIFY:
159 case LFUN_INSET_DIALOG_UPDATE:
164 return InsetBase::getStatus(cur, cmd, flag);
169 InsetCommandParams const & InsetInclude::params() const
177 /// the type of inclusion
186 Types type(InsetCommandParams const & params)
188 string const command_name = params.getCmdName();
190 if (command_name == "input")
192 if (command_name == "verbatiminput")
194 if (command_name == "verbatiminput*")
200 bool isVerbatim(InsetCommandParams const & params)
202 string const command_name = params.getCmdName();
203 return command_name == "verbatiminput" ||
204 command_name == "verbatiminput*";
208 string const masterFilename(Buffer const & buffer)
210 return buffer.getMasterBuffer()->fileName();
214 string const parentFilename(Buffer const & buffer)
216 return buffer.fileName();
220 FileName const includedFilename(Buffer const & buffer,
221 InsetCommandParams const & params)
223 return makeAbsPath(to_utf8(params["filename"]),
224 onlyPath(parentFilename(buffer)));
228 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
233 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
238 if (preview_->monitoring())
239 preview_->stopMonitoring();
241 if (type(params_) == INPUT)
242 add_preview(*preview_, *this, buffer);
246 auto_ptr<InsetBase> InsetInclude::doClone() const
248 return auto_ptr<InsetBase>(new InsetInclude(*this));
252 void InsetInclude::write(Buffer const &, ostream & os) const
258 void InsetInclude::write(ostream & os) const
260 os << "Include " << to_utf8(params_.getCommand()) << '\n'
261 << "preview " << convert<string>(params_.preview()) << '\n';
265 void InsetInclude::read(Buffer const &, LyXLex & lex)
271 void InsetInclude::read(LyXLex & lex)
275 string const command = lex.getString();
276 params_.scanCommand(command);
281 token = lex.getString();
282 if (token == "\\end_inset")
284 if (token == "preview") {
286 params_.preview(lex.getBool());
288 lex.printError("Unknown parameter name `$$Token' for command " + params_.getCmdName());
290 if (token != "\\end_inset") {
291 lex.printError("Missing \\end_inset at this point. "
297 docstring const InsetInclude::getScreenLabel(Buffer const &) const
301 switch (type(params_)) {
306 temp += _("Verbatim Input");
309 temp += _("Verbatim Input*");
312 temp += _("Include");
318 if (params_["filename"].empty())
321 // FIXME: We don't know the encoding of the filename
322 temp += from_ascii(onlyFilename(to_utf8(params_["filename"])));
330 /// return the child buffer if the file is a LyX doc and is loaded
331 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
333 if (isVerbatim(params))
336 string const included_file = includedFilename(buffer, params).absFilename();
337 if (!isLyXFilename(included_file))
340 return theBufferList().getBuffer(included_file);
344 /// return true if the file is or got loaded.
345 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
347 if (isVerbatim(params))
350 FileName const included_file = includedFilename(buffer, params);
351 if (!isLyXFilename(included_file.absFilename()))
354 Buffer * buf = theBufferList().getBuffer(included_file.absFilename());
356 // the readonly flag can/will be wrong, not anymore I think.
357 if (!fs::exists(included_file.toFilesystemEncoding()))
359 buf = theBufferList().newBuffer(included_file.absFilename());
360 if (!loadLyXFile(buf, included_file))
364 buf->setParentName(parentFilename(buffer));
372 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
373 OutputParams const & runparams) const
375 string incfile(to_utf8(params_["filename"]));
377 // Do nothing if no file name has been specified
381 FileName const included_file(includedFilename(buffer, params_));
382 Buffer const * const m_buffer = buffer.getMasterBuffer();
384 // if incfile is relative, make it relative to the master
386 if (!absolutePath(incfile)) {
387 incfile = makeRelPath(included_file.absFilename(),
388 m_buffer->filePath());
391 // write it to a file (so far the complete file)
392 string const exportfile = changeExtension(incfile, ".tex");
393 string const mangled = DocFileName(changeExtension(included_file.absFilename(),
394 ".tex")).mangledFilename();
395 FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
399 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
400 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
401 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
403 if (runparams.inComment || runparams.dryrun)
404 // Don't try to load or copy the file
406 else if (loadIfNeeded(buffer, params_)) {
407 Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
409 if (tmp->params().textclass != m_buffer->params().textclass) {
411 docstring text = bformat(_("Included file `%1$s'\n"
412 "has textclass `%2$s'\n"
413 "while parent file has textclass `%3$s'."),
414 makeDisplayPath(included_file.absFilename()),
415 from_utf8(tmp->params().getLyXTextClass().name()),
416 from_utf8(m_buffer->params().getLyXTextClass().name()));
417 Alert::warning(_("Different textclasses"), text);
421 tmp->markDepClean(m_buffer->temppath());
424 #warning handle non existing files
425 #warning Second argument is irrelevant!
426 // since only_body is true, makeLaTeXFile will not look at second
427 // argument. Should we set it to string(), or should makeLaTeXFile
428 // make use of it somehow? (JMarc 20031002)
430 tmp->makeLaTeXFile(writefile,
431 onlyPath(masterFilename(buffer)),
434 // Copy the file to the temp dir, so that .aux files etc.
435 // are not created in the original dir. Files included by
436 // this file will be found via input@path, see ../buffer.C.
437 unsigned long const checksum_in = sum(included_file);
438 unsigned long const checksum_out = sum(writefile);
440 if (checksum_in != checksum_out) {
441 if (!copy(included_file, writefile)) {
444 << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
445 "into the temporary directory."),
446 from_utf8(included_file.absFilename())))
453 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
454 "latex" : "pdflatex";
455 if (isVerbatim(params_)) {
456 incfile = latex_path(incfile);
458 os << '\\' << from_ascii(params_.getCmdName()) << '{'
459 << from_utf8(incfile) << '}';
460 } else if (type(params_) == INPUT) {
461 runparams.exportdata->addExternalFile(tex_format, writefile,
464 // \input wants file with extension (default is .tex)
465 if (!isLyXFilename(included_file.absFilename())) {
466 incfile = latex_path(incfile);
468 os << '\\' << from_ascii(params_.getCmdName())
469 << '{' << from_utf8(incfile) << '}';
471 incfile = changeExtension(incfile, ".tex");
472 incfile = latex_path(incfile);
474 os << '\\' << from_ascii(params_.getCmdName())
475 << '{' << from_utf8(incfile) << '}';
478 runparams.exportdata->addExternalFile(tex_format, writefile,
481 // \include don't want extension and demands that the
482 // file really have .tex
483 incfile = changeExtension(incfile, string());
484 incfile = latex_path(incfile);
486 os << '\\' << from_ascii(params_.getCmdName()) << '{'
487 << from_utf8(incfile) << '}';
494 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
495 OutputParams const &) const
497 if (isVerbatim(params_)) {
498 // FIXME: We don't know the encoding of the file
499 docstring const str = from_utf8(
500 getFileContents(includedFilename(buffer, params_)));
502 // Return how many newlines we issued.
503 return int(lyx::count(str.begin(), str.end(), '\n'));
509 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
510 OutputParams const & runparams) const
512 string incfile = to_utf8(params_["filename"]);
514 // Do nothing if no file name has been specified
518 string const included_file = includedFilename(buffer, params_).absFilename();
520 // write it to a file (so far the complete file)
521 string const exportfile = changeExtension(incfile, ".sgml");
522 DocFileName writefile(changeExtension(included_file, ".sgml"));
524 if (loadIfNeeded(buffer, params_)) {
525 Buffer * tmp = theBufferList().getBuffer(included_file);
527 string const mangled = writefile.mangledFilename();
528 writefile = makeAbsPath(mangled,
529 buffer.getMasterBuffer()->temppath());
533 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
534 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
535 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
537 tmp->makeDocBookFile(writefile, runparams, true);
540 runparams.exportdata->addExternalFile("docbook", writefile,
542 runparams.exportdata->addExternalFile("docbook-xml", writefile,
545 if (isVerbatim(params_)) {
546 os << "<inlinegraphic fileref=\""
547 << '&' << include_label << ';'
548 << "\" format=\"linespecific\">";
550 os << '&' << include_label << ';';
556 void InsetInclude::validate(LaTeXFeatures & features) const
558 string incfile(to_utf8(params_["filename"]));
561 Buffer const & buffer = features.buffer();
563 string const included_file = includedFilename(buffer, params_).absFilename();
565 if (isLyXFilename(included_file))
566 writefile = changeExtension(included_file, ".sgml");
568 writefile = included_file;
570 if (!features.runparams().nice && !isVerbatim(params_)) {
571 incfile = DocFileName(writefile).mangledFilename();
572 writefile = makeAbsPath(incfile,
573 buffer.getMasterBuffer()->temppath()).absFilename();
576 features.includeFile(include_label, writefile);
578 if (isVerbatim(params_))
579 features.require("verbatim");
581 // Here we must do the fun stuff...
582 // Load the file in the include if it needs
584 if (loadIfNeeded(buffer, params_)) {
586 Buffer * const tmp = theBufferList().getBuffer(included_file);
588 // We must temporarily change features.buffer,
589 // otherwise it would always be the master buffer,
590 // and nested includes would not work.
591 features.setBuffer(*tmp);
592 tmp->validate(features);
593 features.setBuffer(buffer);
599 void InsetInclude::getLabelList(Buffer const & buffer,
600 std::vector<docstring> & list) const
602 if (loadIfNeeded(buffer, params_)) {
603 string const included_file = includedFilename(buffer, params_).absFilename();
604 Buffer * tmp = theBufferList().getBuffer(included_file);
605 tmp->setParentName("");
606 tmp->getLabelList(list);
607 tmp->setParentName(parentFilename(buffer));
612 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
613 std::vector<std::pair<string, docstring> > & keys) const
615 if (loadIfNeeded(buffer, params_)) {
616 string const included_file = includedFilename(buffer, params_).absFilename();
617 Buffer * tmp = theBufferList().getBuffer(included_file);
618 tmp->setParentName("");
619 tmp->fillWithBibKeys(keys);
620 tmp->setParentName(parentFilename(buffer));
625 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
627 Buffer * const tmp = getChildBuffer(buffer, params_);
629 tmp->setParentName("");
630 tmp->updateBibfilesCache();
631 tmp->setParentName(parentFilename(buffer));
636 std::vector<FileName> const &
637 InsetInclude::getBibfilesCache(Buffer const & buffer) const
639 Buffer * const tmp = getChildBuffer(buffer, params_);
641 tmp->setParentName("");
642 std::vector<FileName> const & cache = tmp->getBibfilesCache();
643 tmp->setParentName(parentFilename(buffer));
646 static std::vector<FileName> const empty;
651 bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
653 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
655 bool use_preview = false;
656 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
657 graphics::PreviewImage const * pimage =
658 preview_->getPreviewImage(*mi.base.bv->buffer());
659 use_preview = pimage && pimage->image();
663 preview_->metrics(mi, dim);
667 button_.update(getScreenLabel(*mi.base.bv->buffer()),
670 button_.metrics(mi, dim);
673 Box b(0, dim.wid, -dim.asc, dim.des);
676 bool const changed = dim_ != dim;
682 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
684 setPosCache(pi, x, y);
686 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
688 bool use_preview = false;
689 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
690 graphics::PreviewImage const * pimage =
691 preview_->getPreviewImage(*pi.base.bv->buffer());
692 use_preview = pimage && pimage->image();
696 preview_->draw(pi, x, y);
698 button_.draw(pi, x, y);
701 bool InsetInclude::display() const
703 return type(params_) != INPUT;
712 void InsetInclude::fileChanged() const
714 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
718 Buffer const & buffer = *buffer_ptr;
719 preview_->removePreview(buffer);
720 add_preview(*preview_.get(), *this, buffer);
721 preview_->startLoading(buffer);
727 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
729 FileName const included_file = includedFilename(buffer, params);
731 return type(params) == INPUT && params.preview() &&
732 isFileReadable(included_file);
736 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
739 OutputParams runparams;
740 runparams.flavor = OutputParams::LATEX;
741 inset.latex(buffer, os, runparams);
747 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
748 Buffer const & buffer)
750 InsetCommandParams const & params = inset.params();
751 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
752 preview_wanted(params, buffer)) {
753 renderer.setAbsFile(includedFilename(buffer, params));
754 docstring const snippet = latex_string(inset, buffer);
755 renderer.addPreview(snippet, buffer);
762 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
764 Buffer const & buffer = ploader.buffer();
765 if (preview_wanted(params(), buffer)) {
766 preview_->setAbsFile(includedFilename(buffer, params()));
767 docstring const snippet = latex_string(*this, buffer);
768 preview_->addPreview(snippet, ploader);
773 void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
775 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
779 TocList const & childtoclist = childbuffer->tocBackend().tocs();
780 TocList::const_iterator it = childtoclist.begin();
781 TocList::const_iterator const end = childtoclist.end();
782 for(; it != end; ++it)
783 toclist[it->first].insert(toclist[it->first].end(),
784 it->second.begin(), it->second.end());
788 void InsetInclude::updateLabels(Buffer const & buffer) const
790 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
794 lyx::updateLabels(*childbuffer, true);
798 string const InsetIncludeMailer::name_("include");
800 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
805 string const InsetIncludeMailer::inset2string(Buffer const &) const
807 return params2string(inset_.params());
811 void InsetIncludeMailer::string2params(string const & in,
812 InsetCommandParams & params)
818 istringstream data(in);
824 if (!lex || name != name_)
825 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
827 // This is part of the inset proper that is usually swallowed
828 // by LyXText::readInset
831 if (!lex || id != "Include")
832 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
834 InsetInclude inset(params);
836 params = inset.params();
841 InsetIncludeMailer::params2string(InsetCommandParams const & params)
843 InsetInclude inset(params);
845 data << name_ << ' ';
847 data << "\\end_inset\n";