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 string 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);
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 string const included_file = includedFilename(buffer, params);
351 if (!isLyXFilename(included_file))
354 Buffer * buf = theBufferList().getBuffer(included_file);
356 // the readonly flag can/will be wrong, not anymore I think.
357 FileName const fullname(included_file);
358 if (!fs::exists(fullname.toFilesystemEncoding()))
360 buf = theBufferList().newBuffer(included_file);
361 if (!loadLyXFile(buf, fullname))
365 buf->setParentName(parentFilename(buffer));
373 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
374 OutputParams const & runparams) const
376 string incfile(to_utf8(params_["filename"]));
378 // Do nothing if no file name has been specified
382 FileName const included_file(includedFilename(buffer, params_));
383 Buffer const * const m_buffer = buffer.getMasterBuffer();
385 // if incfile is relative, make it relative to the master
387 if (!absolutePath(incfile)) {
388 incfile = makeRelPath(included_file.absFilename(),
389 m_buffer->filePath());
392 // write it to a file (so far the complete file)
393 string const exportfile = changeExtension(incfile, ".tex");
394 string const mangled = DocFileName(changeExtension(included_file.absFilename(),
395 ".tex")).mangledFilename();
396 FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
400 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
401 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
402 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
404 if (runparams.inComment || runparams.dryrun)
405 // Don't try to load or copy the file
407 else if (loadIfNeeded(buffer, params_)) {
408 Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
410 if (tmp->params().textclass != m_buffer->params().textclass) {
412 docstring text = bformat(_("Included file `%1$s'\n"
413 "has textclass `%2$s'\n"
414 "while parent file has textclass `%3$s'."),
415 makeDisplayPath(included_file.absFilename()),
416 from_utf8(tmp->params().getLyXTextClass().name()),
417 from_utf8(m_buffer->params().getLyXTextClass().name()));
418 Alert::warning(_("Different textclasses"), text);
422 tmp->markDepClean(m_buffer->temppath());
425 #warning handle non existing files
426 #warning Second argument is irrelevant!
427 // since only_body is true, makeLaTeXFile will not look at second
428 // argument. Should we set it to string(), or should makeLaTeXFile
429 // make use of it somehow? (JMarc 20031002)
431 tmp->makeLaTeXFile(writefile,
432 onlyPath(masterFilename(buffer)),
435 // Copy the file to the temp dir, so that .aux files etc.
436 // are not created in the original dir. Files included by
437 // this file will be found via input@path, see ../buffer.C.
438 unsigned long const checksum_in = sum(included_file);
439 unsigned long const checksum_out = sum(writefile);
441 if (checksum_in != checksum_out) {
442 if (!copy(included_file, writefile)) {
445 << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
446 "into the temporary directory."),
447 from_utf8(included_file.absFilename())))
454 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
455 "latex" : "pdflatex";
456 if (isVerbatim(params_)) {
457 incfile = latex_path(incfile);
459 os << '\\' << from_ascii(params_.getCmdName()) << '{'
460 << from_utf8(incfile) << '}';
461 } else if (type(params_) == INPUT) {
462 runparams.exportdata->addExternalFile(tex_format, writefile,
465 // \input wants file with extension (default is .tex)
466 if (!isLyXFilename(included_file.absFilename())) {
467 incfile = latex_path(incfile);
469 os << '\\' << from_ascii(params_.getCmdName())
470 << '{' << from_utf8(incfile) << '}';
472 incfile = changeExtension(incfile, ".tex");
473 incfile = latex_path(incfile);
475 os << '\\' << from_ascii(params_.getCmdName())
476 << '{' << from_utf8(incfile) << '}';
479 runparams.exportdata->addExternalFile(tex_format, writefile,
482 // \include don't want extension and demands that the
483 // file really have .tex
484 incfile = changeExtension(incfile, string());
485 incfile = latex_path(incfile);
487 os << '\\' << from_ascii(params_.getCmdName()) << '{'
488 << from_utf8(incfile) << '}';
495 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
496 OutputParams const &) const
498 if (isVerbatim(params_)) {
499 // FIXME: We don't know the encoding of the file
500 docstring const str = from_utf8(
501 getFileContents(FileName(includedFilename(buffer, params_))));
503 // Return how many newlines we issued.
504 return int(lyx::count(str.begin(), str.end(), '\n'));
510 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
511 OutputParams const & runparams) const
513 string incfile = to_utf8(params_["filename"]);
515 // Do nothing if no file name has been specified
519 string const included_file = includedFilename(buffer, params_);
521 // write it to a file (so far the complete file)
522 string const exportfile = changeExtension(incfile, ".sgml");
523 DocFileName writefile(changeExtension(included_file, ".sgml"));
525 if (loadIfNeeded(buffer, params_)) {
526 Buffer * tmp = theBufferList().getBuffer(included_file);
528 string const mangled = writefile.mangledFilename();
529 writefile = makeAbsPath(mangled,
530 buffer.getMasterBuffer()->temppath());
534 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
535 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
536 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
538 tmp->makeDocBookFile(writefile, runparams, true);
541 runparams.exportdata->addExternalFile("docbook", writefile,
543 runparams.exportdata->addExternalFile("docbook-xml", writefile,
546 if (isVerbatim(params_)) {
547 os << "<inlinegraphic fileref=\""
548 << '&' << include_label << ';'
549 << "\" format=\"linespecific\">";
551 os << '&' << include_label << ';';
557 void InsetInclude::validate(LaTeXFeatures & features) const
559 string incfile(to_utf8(params_["filename"]));
562 Buffer const & buffer = features.buffer();
564 string const included_file = includedFilename(buffer, params_);
566 if (isLyXFilename(included_file))
567 writefile = changeExtension(included_file, ".sgml");
569 writefile = included_file;
571 if (!features.runparams().nice && !isVerbatim(params_)) {
572 incfile = DocFileName(writefile).mangledFilename();
573 writefile = makeAbsPath(incfile,
574 buffer.getMasterBuffer()->temppath());
577 features.includeFile(include_label, writefile);
579 if (isVerbatim(params_))
580 features.require("verbatim");
582 // Here we must do the fun stuff...
583 // Load the file in the include if it needs
585 if (loadIfNeeded(buffer, params_)) {
587 Buffer * const tmp = theBufferList().getBuffer(included_file);
589 // We must temporarily change features.buffer,
590 // otherwise it would always be the master buffer,
591 // and nested includes would not work.
592 features.setBuffer(*tmp);
593 tmp->validate(features);
594 features.setBuffer(buffer);
600 void InsetInclude::getLabelList(Buffer const & buffer,
601 std::vector<docstring> & list) const
603 if (loadIfNeeded(buffer, params_)) {
604 string const included_file = includedFilename(buffer, params_);
605 Buffer * tmp = theBufferList().getBuffer(included_file);
606 tmp->setParentName("");
607 tmp->getLabelList(list);
608 tmp->setParentName(parentFilename(buffer));
613 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
614 std::vector<std::pair<string,string> > & keys) const
616 if (loadIfNeeded(buffer, params_)) {
617 string const included_file = includedFilename(buffer, params_);
618 Buffer * tmp = theBufferList().getBuffer(included_file);
619 tmp->setParentName("");
620 tmp->fillWithBibKeys(keys);
621 tmp->setParentName(parentFilename(buffer));
626 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
628 Buffer * const tmp = getChildBuffer(buffer, params_);
630 tmp->setParentName("");
631 tmp->updateBibfilesCache();
632 tmp->setParentName(parentFilename(buffer));
637 std::vector<FileName> const &
638 InsetInclude::getBibfilesCache(Buffer const & buffer) const
640 Buffer * const tmp = getChildBuffer(buffer, params_);
642 tmp->setParentName("");
643 std::vector<FileName> const & cache = tmp->getBibfilesCache();
644 tmp->setParentName(parentFilename(buffer));
647 static std::vector<FileName> const empty;
652 bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
654 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
656 bool use_preview = false;
657 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
658 graphics::PreviewImage const * pimage =
659 preview_->getPreviewImage(*mi.base.bv->buffer());
660 use_preview = pimage && pimage->image();
664 preview_->metrics(mi, dim);
668 button_.update(getScreenLabel(*mi.base.bv->buffer()),
671 button_.metrics(mi, dim);
674 Box b(0, dim.wid, -dim.asc, dim.des);
677 bool const changed = dim_ != dim;
683 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
685 setPosCache(pi, x, y);
687 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
689 bool use_preview = false;
690 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
691 graphics::PreviewImage const * pimage =
692 preview_->getPreviewImage(*pi.base.bv->buffer());
693 use_preview = pimage && pimage->image();
697 preview_->draw(pi, x, y);
699 button_.draw(pi, x, y);
702 bool InsetInclude::display() const
704 return type(params_) != INPUT;
713 void InsetInclude::fileChanged() const
715 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
719 Buffer const & buffer = *buffer_ptr;
720 preview_->removePreview(buffer);
721 add_preview(*preview_.get(), *this, buffer);
722 preview_->startLoading(buffer);
728 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
730 string const included_file = includedFilename(buffer, params);
732 return type(params) == INPUT && params.preview() &&
733 isFileReadable(FileName(included_file));
737 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
740 OutputParams runparams;
741 runparams.flavor = OutputParams::LATEX;
742 inset.latex(buffer, os, runparams);
748 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
749 Buffer const & buffer)
751 InsetCommandParams const & params = inset.params();
752 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
753 preview_wanted(params, buffer)) {
754 renderer.setAbsFile(FileName(includedFilename(buffer, params)));
755 docstring const snippet = latex_string(inset, buffer);
756 renderer.addPreview(snippet, buffer);
763 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
765 Buffer const & buffer = ploader.buffer();
766 if (preview_wanted(params(), buffer)) {
767 preview_->setAbsFile(FileName(includedFilename(buffer, params())));
768 docstring const snippet = latex_string(*this, buffer);
769 preview_->addPreview(snippet, ploader);
774 void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
776 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
780 TocList const & childtoclist = childbuffer->tocBackend().tocs();
781 TocList::const_iterator it = childtoclist.begin();
782 TocList::const_iterator const end = childtoclist.end();
783 for(; it != end; ++it)
784 toclist[it->first].insert(toclist[it->first].end(),
785 it->second.begin(), it->second.end());
789 void InsetInclude::updateLabels(Buffer const & buffer) const
791 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
795 lyx::updateLabels(*childbuffer, true);
799 string const InsetIncludeMailer::name_("include");
801 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
806 string const InsetIncludeMailer::inset2string(Buffer const &) const
808 return params2string(inset_.params());
812 void InsetIncludeMailer::string2params(string const & in,
813 InsetCommandParams & params)
819 istringstream data(in);
825 if (!lex || name != name_)
826 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
828 // This is part of the inset proper that is usually swallowed
829 // by LyXText::readInset
832 if (!lex || id != "Include")
833 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
835 InsetInclude inset(params);
837 params = inset.params();
842 InsetIncludeMailer::params2string(InsetCommandParams const & params)
844 InsetInclude inset(params);
846 data << name_ << ' ';
848 data << "\\end_inset\n";