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"
34 #include "frontends/Alert.h"
35 #include "frontends/Painter.h"
37 #include "graphics/PreviewImage.h"
38 #include "graphics/PreviewLoader.h"
40 #include "insets/render_preview.h"
42 #include "support/filename.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>
52 #include "support/std_ostream.h"
59 using support::addName;
60 using support::absolutePath;
61 using support::bformat;
62 using support::changeExtension;
63 using support::contains;
65 using support::FileName;
66 using support::getFileContents;
67 using support::isFileReadable;
68 using support::isLyXFilename;
69 using support::latex_path;
70 using support::makeAbsPath;
71 using support::makeDisplayPath;
72 using support::makeRelPath;
73 using support::onlyFilename;
74 using support::onlyPath;
81 using std::istringstream;
83 using std::ostringstream;
85 namespace Alert = frontend::Alert;
86 namespace fs = boost::filesystem;
91 docstring const uniqueID()
93 static unsigned int seed = 1000;
94 return "file" + convert<docstring>(++seed);
100 InsetInclude::InsetInclude(InsetCommandParams const & p)
101 : params_(p), include_label(uniqueID()),
102 preview_(new RenderMonitoredPreview(this)),
105 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
109 InsetInclude::InsetInclude(InsetInclude const & other)
111 params_(other.params_),
112 include_label(other.include_label),
113 preview_(new RenderMonitoredPreview(this)),
116 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
120 InsetInclude::~InsetInclude()
122 InsetIncludeMailer(*this).hideDialog();
126 void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd)
128 switch (cmd.action) {
130 case LFUN_INSET_MODIFY: {
131 InsetCommandParams p("include");
132 InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p);
133 if (!p.getCmdName().empty()) {
134 set(p, cur.buffer());
135 cur.buffer().updateBibfilesCache();
141 case LFUN_INSET_DIALOG_UPDATE:
142 InsetIncludeMailer(*this).updateDialog(&cur.bv());
145 case LFUN_MOUSE_RELEASE:
146 InsetIncludeMailer(*this).showDialog(&cur.bv());
150 InsetBase::doDispatch(cur, cmd);
156 bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd,
157 FuncStatus & flag) const
159 switch (cmd.action) {
161 case LFUN_INSET_MODIFY:
162 case LFUN_INSET_DIALOG_UPDATE:
167 return InsetBase::getStatus(cur, cmd, flag);
172 InsetCommandParams const & InsetInclude::params() const
180 /// the type of inclusion
189 Types type(InsetCommandParams const & params)
191 string const command_name = params.getCmdName();
193 if (command_name == "input")
195 if (command_name == "verbatiminput")
197 if (command_name == "verbatiminput*")
203 bool isVerbatim(InsetCommandParams const & params)
205 string const command_name = params.getCmdName();
206 return command_name == "verbatiminput" ||
207 command_name == "verbatiminput*";
211 string const masterFilename(Buffer const & buffer)
213 return buffer.getMasterBuffer()->fileName();
217 string const parentFilename(Buffer const & buffer)
219 return buffer.fileName();
223 string const includedFilename(Buffer const & buffer,
224 InsetCommandParams const & params)
226 return makeAbsPath(to_utf8(params["filename"]),
227 onlyPath(parentFilename(buffer)));
231 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
236 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
241 if (preview_->monitoring())
242 preview_->stopMonitoring();
244 if (type(params_) == INPUT)
245 add_preview(*preview_, *this, buffer);
249 auto_ptr<InsetBase> InsetInclude::doClone() const
251 return auto_ptr<InsetBase>(new InsetInclude(*this));
255 void InsetInclude::write(Buffer const &, ostream & os) const
261 void InsetInclude::write(ostream & os) const
263 os << "Include " << to_utf8(params_.getCommand()) << '\n'
264 << "preview " << convert<string>(params_.preview()) << '\n';
268 void InsetInclude::read(Buffer const &, LyXLex & lex)
274 void InsetInclude::read(LyXLex & lex)
280 docstring const InsetInclude::getScreenLabel(Buffer const &) const
284 switch (type(params_)) {
289 temp += _("Verbatim Input");
292 temp += _("Verbatim Input*");
295 temp += _("Include");
301 if (params_["filename"].empty())
304 // FIXME: We don't know the encoding of the filename
305 temp += from_ascii(onlyFilename(to_utf8(params_["filename"])));
313 /// return the child buffer if the file is a LyX doc and is loaded
314 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
316 if (isVerbatim(params))
319 string const included_file = includedFilename(buffer, params);
320 if (!isLyXFilename(included_file))
323 return theBufferList().getBuffer(included_file);
327 /// return true if the file is or got loaded.
328 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
330 if (isVerbatim(params))
333 string const included_file = includedFilename(buffer, params);
334 if (!isLyXFilename(included_file))
337 Buffer * buf = theBufferList().getBuffer(included_file);
339 // the readonly flag can/will be wrong, not anymore I think.
340 if (!fs::exists(included_file))
342 buf = theBufferList().newBuffer(included_file);
343 if (!loadLyXFile(buf, included_file))
347 buf->setParentName(parentFilename(buffer));
355 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
356 OutputParams const & runparams) const
358 string incfile(to_utf8(params_["filename"]));
360 // Do nothing if no file name has been specified
364 string const included_file = includedFilename(buffer, params_);
365 Buffer const * const m_buffer = buffer.getMasterBuffer();
367 // if incfile is relative, make it relative to the master
369 if (!absolutePath(incfile)) {
370 incfile = makeRelPath(included_file,
371 m_buffer->filePath());
374 // write it to a file (so far the complete file)
375 string const exportfile = changeExtension(incfile, ".tex");
376 string const mangled = FileName(changeExtension(included_file,
377 ".tex")).mangledFilename();
378 string const writefile = makeAbsPath(mangled, m_buffer->temppath());
382 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
383 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
384 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
386 if (runparams.inComment || runparams.dryrun)
387 // Don't try to load or copy the file
389 else if (loadIfNeeded(buffer, params_)) {
390 Buffer * tmp = theBufferList().getBuffer(included_file);
392 if (tmp->params().textclass != m_buffer->params().textclass) {
394 docstring text = bformat(_("Included file `%1$s'\n"
395 "has textclass `%2$s'\n"
396 "while parent file has textclass `%3$s'."),
397 makeDisplayPath(included_file),
398 from_utf8(tmp->params().getLyXTextClass().name()),
399 from_utf8(m_buffer->params().getLyXTextClass().name()));
400 Alert::warning(_("Different textclasses"), text);
404 tmp->markDepClean(m_buffer->temppath());
407 #warning handle non existing files
408 #warning Second argument is irrelevant!
409 // since only_body is true, makeLaTeXFile will not look at second
410 // argument. Should we set it to string(), or should makeLaTeXFile
411 // make use of it somehow? (JMarc 20031002)
413 tmp->makeLaTeXFile(writefile,
414 onlyPath(masterFilename(buffer)),
417 // Copy the file to the temp dir, so that .aux files etc.
418 // are not created in the original dir. Files included by
419 // this file will be found via input@path, see ../buffer.C.
420 unsigned long const checksum_in = sum(included_file);
421 unsigned long const checksum_out = sum(writefile);
423 if (checksum_in != checksum_out) {
424 if (!copy(included_file, writefile)) {
427 << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
428 "into the temporary directory."),
429 from_utf8(included_file)))
436 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
437 "latex" : "pdflatex";
438 if (isVerbatim(params_)) {
439 incfile = latex_path(incfile);
441 os << '\\' << from_ascii(params_.getCmdName()) << '{'
442 << from_utf8(incfile) << '}';
443 } else if (type(params_) == INPUT) {
444 runparams.exportdata->addExternalFile(tex_format, writefile,
447 // \input wants file with extension (default is .tex)
448 if (!isLyXFilename(included_file)) {
449 incfile = latex_path(incfile);
451 os << '\\' << from_ascii(params_.getCmdName())
452 << '{' << from_utf8(incfile) << '}';
454 incfile = changeExtension(incfile, ".tex");
455 incfile = latex_path(incfile);
457 os << '\\' << from_ascii(params_.getCmdName())
458 << '{' << from_utf8(incfile) << '}';
461 runparams.exportdata->addExternalFile(tex_format, writefile,
464 // \include don't want extension and demands that the
465 // file really have .tex
466 incfile = changeExtension(incfile, string());
467 incfile = latex_path(incfile);
469 os << '\\' << from_ascii(params_.getCmdName()) << '{'
470 << from_utf8(incfile) << '}';
477 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
478 OutputParams const &) const
480 if (isVerbatim(params_)) {
481 // FIXME: We don't know the encoding of the file
482 docstring const str = from_utf8(
483 getFileContents(includedFilename(buffer, params_)));
485 // Return how many newlines we issued.
486 return int(lyx::count(str.begin(), str.end(), '\n'));
492 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
493 OutputParams const & runparams) const
495 string incfile = to_utf8(params_["filename"]);
497 // Do nothing if no file name has been specified
501 string const included_file = includedFilename(buffer, params_);
503 // write it to a file (so far the complete file)
504 string const exportfile = changeExtension(incfile, ".sgml");
505 string writefile = changeExtension(included_file, ".sgml");
507 if (loadIfNeeded(buffer, params_)) {
508 Buffer * tmp = theBufferList().getBuffer(included_file);
510 string const mangled = FileName(writefile).mangledFilename();
511 writefile = makeAbsPath(mangled,
512 buffer.getMasterBuffer()->temppath());
516 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
517 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
518 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
520 tmp->makeDocBookFile(writefile, runparams, true);
523 runparams.exportdata->addExternalFile("docbook", writefile,
525 runparams.exportdata->addExternalFile("docbook-xml", writefile,
529 if (isVerbatim(params_)) {
530 os << "<inlinegraphic fileref=\""
531 << '&' << include_label << ';'
532 << "\" format=\"linespecific\">";
534 os << '&' << include_label << ';';
540 void InsetInclude::validate(LaTeXFeatures & features) const
542 string incfile(to_utf8(params_["filename"]));
545 Buffer const & buffer = features.buffer();
547 string const included_file = includedFilename(buffer, params_);
549 if (isLyXFilename(included_file))
550 writefile = changeExtension(included_file, ".sgml");
552 writefile = included_file;
554 if (!features.runparams().nice && !isVerbatim(params_)) {
555 incfile = FileName(writefile).mangledFilename();
556 writefile = makeAbsPath(incfile,
557 buffer.getMasterBuffer()->temppath());
560 features.includeFile(include_label, writefile);
562 if (isVerbatim(params_))
563 features.require("verbatim");
565 // Here we must do the fun stuff...
566 // Load the file in the include if it needs
568 if (loadIfNeeded(buffer, params_)) {
570 Buffer * const tmp = theBufferList().getBuffer(included_file);
572 // We must temporarily change features.buffer,
573 // otherwise it would always be the master buffer,
574 // and nested includes would not work.
575 features.setBuffer(*tmp);
576 tmp->validate(features);
577 features.setBuffer(buffer);
583 void InsetInclude::getLabelList(Buffer const & buffer,
584 std::vector<docstring> & list) const
586 if (loadIfNeeded(buffer, params_)) {
587 string const included_file = includedFilename(buffer, params_);
588 Buffer * tmp = theBufferList().getBuffer(included_file);
589 tmp->setParentName("");
590 tmp->getLabelList(list);
591 tmp->setParentName(parentFilename(buffer));
596 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
597 std::vector<std::pair<string,string> > & keys) const
599 if (loadIfNeeded(buffer, params_)) {
600 string const included_file = includedFilename(buffer, params_);
601 Buffer * tmp = theBufferList().getBuffer(included_file);
602 tmp->setParentName("");
603 tmp->fillWithBibKeys(keys);
604 tmp->setParentName(parentFilename(buffer));
609 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
611 Buffer * const tmp = getChildBuffer(buffer, params_);
613 tmp->setParentName("");
614 tmp->updateBibfilesCache();
615 tmp->setParentName(parentFilename(buffer));
620 std::vector<string> const &
621 InsetInclude::getBibfilesCache(Buffer const & buffer) const
623 Buffer * const tmp = getChildBuffer(buffer, params_);
625 tmp->setParentName("");
626 std::vector<string> const & cache = tmp->getBibfilesCache();
627 tmp->setParentName(parentFilename(buffer));
630 static std::vector<string> const empty;
635 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
637 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
639 bool use_preview = false;
640 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
641 graphics::PreviewImage const * pimage =
642 preview_->getPreviewImage(*mi.base.bv->buffer());
643 use_preview = pimage && pimage->image();
647 preview_->metrics(mi, dim);
651 button_.update(getScreenLabel(*mi.base.bv->buffer()),
654 button_.metrics(mi, dim);
657 Box b(0, dim.wid, -dim.asc, dim.des);
664 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
666 setPosCache(pi, x, y);
668 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
670 bool use_preview = false;
671 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
672 graphics::PreviewImage const * pimage =
673 preview_->getPreviewImage(*pi.base.bv->buffer());
674 use_preview = pimage && pimage->image();
678 preview_->draw(pi, x, y);
680 button_.draw(pi, x, y);
683 bool InsetInclude::display() const
685 return type(params_) != INPUT;
694 void InsetInclude::fileChanged() const
696 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
700 Buffer const & buffer = *buffer_ptr;
701 preview_->removePreview(buffer);
702 add_preview(*preview_.get(), *this, buffer);
703 preview_->startLoading(buffer);
709 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
711 string const included_file = includedFilename(buffer, params);
713 return type(params) == INPUT && params.preview() &&
714 isFileReadable(included_file);
718 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
721 OutputParams runparams;
722 runparams.flavor = OutputParams::LATEX;
723 inset.latex(buffer, os, runparams);
729 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
730 Buffer const & buffer)
732 InsetCommandParams const & params = inset.params();
733 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
734 preview_wanted(params, buffer)) {
735 renderer.setAbsFile(includedFilename(buffer, params));
736 docstring const snippet = latex_string(inset, buffer);
737 renderer.addPreview(snippet, buffer);
744 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
746 Buffer const & buffer = ploader.buffer();
747 if (preview_wanted(params(), buffer)) {
748 preview_->setAbsFile(includedFilename(buffer, params()));
749 docstring const snippet = latex_string(*this, buffer);
750 preview_->addPreview(snippet, ploader);
755 string const InsetIncludeMailer::name_("include");
757 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
762 string const InsetIncludeMailer::inset2string(Buffer const &) const
764 return params2string(inset_.params());
768 void InsetIncludeMailer::string2params(string const & in,
769 InsetCommandParams & params)
775 istringstream data(in);
781 if (!lex || name != name_)
782 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
784 // This is part of the inset proper that is usually swallowed
785 // by LyXText::readInset
788 if (!lex || id != "Include")
789 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
791 InsetInclude inset(params);
793 params = inset.params();
798 InsetIncludeMailer::params2string(InsetCommandParams const & params)
800 InsetInclude inset(params);
802 data << name_ << ' ';
804 data << "\\end_inset\n";