+/**
+ * \file insetinclude.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#include <config.h>
-#include <cstdlib>
-
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include FORMS_H_LOCATION
#include "insetinclude.h"
-#include "filedlg.h"
+
#include "buffer.h"
+#include "buffer_funcs.h"
#include "bufferlist.h"
+#include "bufferparams.h"
+#include "BufferView.h"
+#include "cursor.h"
#include "debug.h"
-#include "support/filetools.h"
-#include "lyxrc.h"
-#include "LyXView.h"
-#include "LaTeXFeatures.h"
-#include "lyx_gui_misc.h" // CancelCloseBoxCB
+#include "dispatchresult.h"
+#include "exporter.h"
+#include "funcrequest.h"
+#include "FuncStatus.h"
#include "gettext.h"
-#include "include_form.h"
-#include "support/FileInfo.h"
-#include "layout.h"
-#include "lyxfunc.h"
+#include "LaTeXFeatures.h"
+#include "lyx_main.h"
+#include "lyxrc.h"
+#include "lyxlex.h"
+#include "metricsinfo.h"
+#include "outputparams.h"
+#include "TocBackend.h"
+
+#include "frontends/Alert.h"
+#include "frontends/Painter.h"
+
+#include "graphics/PreviewImage.h"
+#include "graphics/PreviewLoader.h"
+
+#include "insets/render_preview.h"
+
+#include "support/filetools.h"
+#include "support/lstrings.h" // contains
+#include "support/lyxalgo.h"
+#include "support/lyxlib.h"
+#include "support/convert.h"
+
+#include <boost/bind.hpp>
+#include <boost/filesystem/operations.hpp>
+
+
+namespace lyx {
+
+using support::addName;
+using support::absolutePath;
+using support::bformat;
+using support::changeExtension;
+using support::contains;
+using support::copy;
+using support::DocFileName;
+using support::FileName;
+using support::getFileContents;
+using support::isFileReadable;
+using support::isLyXFilename;
+using support::latex_path;
+using support::makeAbsPath;
+using support::makeDisplayPath;
+using support::makeRelPath;
+using support::onlyFilename;
+using support::onlyPath;
+using support::subst;
+using support::sum;
-using std::ostream;
using std::endl;
-using std::vector;
-using std::pair;
-
-extern BufferView * current_view;
-
-extern BufferList bufferlist;
-
-
-FD_include * create_form_include(void)
-{
- FL_OBJECT * obj;
- FD_include * fdui = (FD_include *) fl_calloc(1, sizeof(FD_include));
-
- fdui->include = fl_bgn_form(FL_NO_BOX, 340, 210);
- obj = fl_add_box(FL_UP_BOX, 0, 0, 340, 210, "");
- obj = fl_add_frame(FL_ENGRAVED_FRAME, 10, 70, 160, 90, "");
- fdui->browsebt = obj = fl_add_button(FL_NORMAL_BUTTON, 230, 30, 100, 30, idex(_("Browse|#B")));
- fl_set_button_shortcut(obj, scex(_("Browse|#B")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_callback(obj, include_cb, 0);
- fdui->flag1 = obj = fl_add_checkbutton(FL_PUSH_BUTTON, 180, 70, 150, 30, idex(_("Don't typeset|#D")));
- fl_set_button_shortcut(obj, scex(_("Don't typeset|#D")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- obj = fl_add_button(FL_RETURN_BUTTON, 120, 170, 100, 30, _("OK"));
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_callback(obj, include_cb, 1);
- obj = fl_add_button(FL_NORMAL_BUTTON, 230, 170, 100, 30, idex(_("Cancel|^[")));
- fl_set_button_shortcut(obj, scex(_("Cancel|^[")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_callback(obj, include_cb, 2);
- obj = fl_add_button(FL_NORMAL_BUTTON, 230, 130, 100, 30, idex(_("Load|#L")));
- fl_set_button_shortcut(obj, scex(_("Load|#L")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_callback(obj, include_cb, 5);
- fdui->input = obj = fl_add_input(FL_NORMAL_INPUT, 10, 30, 210, 30, idex(_("File name:|#F")));
- fl_set_input_shortcut(obj, scex(_("File name:|#F")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_lalign(obj, FL_ALIGN_TOP_LEFT);
- fdui->flag41 = obj = fl_add_checkbutton(FL_PUSH_BUTTON, 180, 100, 150, 30, idex(_("Visible space|#s")));
- fl_set_button_shortcut(obj, scex(_("Visible space|#s")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
-
- fdui->include_grp = fl_bgn_group();
- fdui->flag4 = obj = fl_add_checkbutton(FL_RADIO_BUTTON, 10, 130, 160, 30, idex(_("Verbatim|#V")));
- fl_set_button_shortcut(obj, scex(_("Verbatim|#V")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_callback(obj, include_cb, 10);
- fdui->flag2 = obj = fl_add_checkbutton(FL_RADIO_BUTTON, 10, 100, 160, 30, idex(_("Use input|#i")));
- fl_set_button_shortcut(obj, scex(_("Use input|#i")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_callback(obj, include_cb, 11);
- fdui->flag3 = obj = fl_add_checkbutton(FL_RADIO_BUTTON, 10, 70, 160, 30, idex(_("Use include|#U")));
- fl_set_button_shortcut(obj, scex(_("Use include|#U")), 1);
- fl_set_object_lsize(obj, FL_NORMAL_SIZE);
- fl_set_object_callback(obj, include_cb, 11);
- fl_end_group();
-
- fl_end_form();
-
- //fdui->include->fdui = fdui;
-
- return fdui;
-}
-/*---------------------------------------*/
-
-
-FD_include * form = 0;
-
-extern "C"
-void include_cb(FL_OBJECT *, long arg)
-{
-
- InsetInclude * inset = static_cast<InsetInclude*>(form->include->u_vdata);
- switch (arg) {
- case 0:
- {
- // Should browsing too be disabled in RO-mode?
- LyXFileDlg fileDlg;
- string const mpath = OnlyPath(inset->getMasterFilename());
- string ext;
-
- if (fl_get_button(form->flag2)) // Use Input Button
- ext = "*.tex";
- else if (fl_get_button(form->flag4)) // Verbatim all files
- ext = "*";
- else
- ext = "*.lyx";
- // launches dialog
- fileDlg.SetButton(0, _("Documents"), lyxrc.document_path);
-
- // Use by default the master's path
- string const filename =
- fileDlg.Select(_("Select Child Document"),
- mpath, ext,
- inset->getContents());
- XFlush(fl_get_display());
-
- // check selected filename
- if (!filename.empty()) {
- string const filename2 = MakeRelPath(filename,
- mpath);
- if (prefixIs(filename2, ".."))
- fl_set_input(form->input,
- filename.c_str());
- else
- fl_set_input(form->input,
- filename2.c_str());
- }
+using std::string;
+using std::auto_ptr;
+using std::istringstream;
+using std::ostream;
+using std::ostringstream;
+
+namespace Alert = frontend::Alert;
+namespace fs = boost::filesystem;
+
+
+namespace {
+
+docstring const uniqueID()
+{
+ static unsigned int seed = 1000;
+ return "file" + convert<docstring>(++seed);
+}
+
+} // namespace anon
+
+
+InsetInclude::InsetInclude(InsetCommandParams const & p)
+ : params_(p), include_label(uniqueID()),
+ preview_(new RenderMonitoredPreview(this)),
+ set_label_(false)
+{
+ preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
+}
+
+
+InsetInclude::InsetInclude(InsetInclude const & other)
+ : InsetOld(other),
+ params_(other.params_),
+ include_label(other.include_label),
+ preview_(new RenderMonitoredPreview(this)),
+ set_label_(false)
+{
+ preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
+}
+
+
+InsetInclude::~InsetInclude()
+{
+ InsetIncludeMailer(*this).hideDialog();
+}
+
+
+void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd)
+{
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY: {
+ InsetCommandParams p("include");
+ InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p);
+ if (!p.getCmdName().empty()) {
+ set(p, cur.buffer());
+ cur.buffer().updateBibfilesCache();
+ } else
+ cur.noUpdate();
break;
}
- case 1:
- if (!current_view->buffer()->isReadonly()) {
- inset->setContents(fl_get_input(form->input));
- // don't typeset
- inset->setNoLoad(fl_get_button(form->flag1));
- if (fl_get_button(form->flag2))
- inset->setInput();
- else if (fl_get_button(form->flag3))
- inset->setInclude();
- else if (fl_get_button(form->flag4)) {
- inset->setVerb();
- inset->setVisibleSpace(fl_get_button(form->flag41));
- }
-
- fl_hide_form(form->include);
- current_view->updateInset(inset, true);
- break;
- } // fall through
-
- case 2:
- fl_hide_form(form->include);
+ case LFUN_INSET_DIALOG_UPDATE:
+ InsetIncludeMailer(*this).updateDialog(&cur.bv());
+ break;
+
+ case LFUN_MOUSE_RELEASE:
+ InsetIncludeMailer(*this).showDialog(&cur.bv());
+ break;
+
+ default:
+ InsetBase::doDispatch(cur, cmd);
break;
- case 5:
- if (!current_view->buffer()->isReadonly()) {
- inset->setContents(fl_get_input(form->input));
- inset->setNoLoad(fl_get_button(form->flag1));
- if (fl_get_button(form->flag2))
- inset->setInput();
- else if (fl_get_button(form->flag3))
- inset->setInclude();
- else if (fl_get_button(form->flag4)) {
- inset->setVerb();
- inset->setVisibleSpace(fl_get_button(form->flag41));
- }
-
- fl_hide_form(form->include);
- current_view->updateInset(inset, true);
- current_view->owner()->getLyXFunc()->Dispatch(LFUN_CHILDOPEN, inset->getContents());
- }
- break;
-
- case 10:
- fl_activate_object(form->flag41);
- fl_set_object_lcol(form->flag41, FL_BLACK);
- break;
- case 11:
- fl_deactivate_object(form->flag41);
- fl_set_object_lcol(form->flag41, FL_INACTIVE);
- fl_set_button(form->flag41, 0);
- break;
}
}
-static inline
-string unique_id() {
- static unsigned int seed = 1000;
+bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
+{
+ switch (cmd.action) {
- std::ostringstream ost;
- ost << "file" << ++seed;
+ case LFUN_INSET_MODIFY:
+ case LFUN_INSET_DIALOG_UPDATE:
+ flag.enabled(true);
+ return true;
- // Needed if we use lyxstring.
- return ost.str().c_str();
+ default:
+ return InsetBase::getStatus(cur, cmd, flag);
+ }
}
-InsetInclude::InsetInclude(InsetCommandParams const & p, Buffer const & bf)
- : InsetCommand(p), master(&bf)
+InsetCommandParams const & InsetInclude::params() const
{
- flag = InsetInclude::INCLUDE;
- noload = false;
- include_label = unique_id();
+ return params_;
}
-InsetInclude::~InsetInclude()
+namespace {
+
+/// the type of inclusion
+enum Types {
+ INCLUDE = 0,
+ VERB = 1,
+ INPUT = 2,
+ VERBAST = 3
+};
+
+
+Types type(InsetCommandParams const & params)
{
- if (form && form->include->u_vdata == this) {
- // this inset is in the popup so hide the popup
- // and remove the reference to this inset. ARRae
- if (form->include) {
- if (form->include->visible) {
- fl_hide_form(form->include);
- }
- fl_free_form(form->include);
- }
- fl_free(form);
- form = 0;
- }
+ string const command_name = params.getCmdName();
+
+ if (command_name == "input")
+ return INPUT;
+ if (command_name == "verbatiminput")
+ return VERB;
+ if (command_name == "verbatiminput*")
+ return VERBAST;
+ return INCLUDE;
}
-Inset * InsetInclude::Clone(Buffer const & buffer) const
-{
- InsetInclude * ii = new InsetInclude (params(), buffer);
- ii->setNoLoad(isNoLoad());
- // By default, the newly created inset is of `include' type,
- // so we do not test this case.
- if (isInput())
- ii->setInput();
- else if (isVerb()) {
- ii->setVerb();
- ii->setVisibleSpace(isVerbVisibleSpace());
- }
- return ii;
+bool isVerbatim(InsetCommandParams const & params)
+{
+ string const command_name = params.getCmdName();
+ return command_name == "verbatiminput" ||
+ command_name == "verbatiminput*";
}
-void InsetInclude::Edit(BufferView * bv, int, int, unsigned int)
+string const masterFilename(Buffer const & buffer)
{
- if (bv->buffer()->isReadonly())
- WarnReadonly(bv->buffer()->fileName());
+ return buffer.getMasterBuffer()->fileName();
+}
- if (!form) {
- form = create_form_include();
- fl_set_form_atclose(form->include, CancelCloseBoxCB, 0);
- }
- form->include->u_vdata = this;
-
- fl_set_input(form->input, getContents().c_str());
- fl_set_button(form->flag1, int(isNoLoad()));
- fl_set_button(form->flag2, int(isInput()));
- fl_set_button(form->flag3, int(isInclude()));
- fl_set_button(form->flag4, int(isVerb()));
- if (isVerb())
- fl_set_button(form->flag41, int(isVerbVisibleSpace()));
- else {
- fl_set_button(form->flag41, 0);
- fl_deactivate_object(form->flag41);
- fl_set_object_lcol(form->flag41, FL_INACTIVE);
- }
-
- if (form->include->visible) {
- fl_raise_form(form->include);
- } else {
- fl_show_form(form->include,
- FL_PLACE_MOUSE | FL_FREE_SIZE, FL_TRANSIENT,
- _("Include"));
- }
+
+string const parentFilename(Buffer const & buffer)
+{
+ return buffer.fileName();
}
-void InsetInclude::Write(Buffer const *, ostream & os) const
+FileName const includedFilename(Buffer const & buffer,
+ InsetCommandParams const & params)
{
- os << "Include " << getCommand() << "\n";
+ return makeAbsPath(to_utf8(params["filename"]),
+ onlyPath(parentFilename(buffer)));
}
-void InsetInclude::Read(Buffer const * buf, LyXLex & lex)
+void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
+
+} // namespace anon
+
+
+void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
{
- InsetCommand::Read(buf, lex);
-
- if (getCmdName() == "include")
- setInclude();
- else if (getCmdName() == "input")
- setInput();
- else if (contains(getCmdName(), "verbatim")) {
- setVerb();
- if (getCmdName() == "verbatiminput*")
- setVisibleSpace(true);
- }
+ params_ = p;
+ set_label_ = false;
+
+ if (preview_->monitoring())
+ preview_->stopMonitoring();
+
+ if (type(params_) == INPUT)
+ add_preview(*preview_, *this, buffer);
}
-bool InsetInclude::display() const
+auto_ptr<InsetBase> InsetInclude::doClone() const
{
- return !isInput();
+ return auto_ptr<InsetBase>(new InsetInclude(*this));
}
-string const InsetInclude::getScreenLabel() const
+void InsetInclude::write(Buffer const &, ostream & os) const
{
- string temp;
- if (isInput())
- temp += _("Input");
- else if (isVerb()) {
- temp += _("Verbatim Input");
- if (isVerbVisibleSpace()) temp += '*';
- } else temp += _("Include");
- temp += ": ";
-
- if (getContents().empty()) {
- temp+= "???";
- } else {
- temp+= getContents();
+ write(os);
+}
+
+
+void InsetInclude::write(ostream & os) const
+{
+ os << "Include " << to_utf8(params_.getCommand()) << '\n'
+ << "preview " << convert<string>(params_.preview()) << '\n';
+}
+
+
+void InsetInclude::read(Buffer const &, LyXLex & lex)
+{
+ read(lex);
+}
+
+
+void InsetInclude::read(LyXLex & lex)
+{
+ if (lex.isOK()) {
+ lex.next();
+ string const command = lex.getString();
+ params_.scanCommand(command);
+ }
+ string token;
+ while (lex.isOK()) {
+ lex.next();
+ token = lex.getString();
+ if (token == "\\end_inset")
+ break;
+ if (token == "preview") {
+ lex.next();
+ params_.preview(lex.getBool());
+ } else
+ lex.printError("Unknown parameter name `$$Token' for command " + params_.getCmdName());
+ }
+ if (token != "\\end_inset") {
+ lex.printError("Missing \\end_inset at this point. "
+ "Read: `$$Token'");
}
- return temp;
}
-string const InsetInclude::getFileName() const
+docstring const InsetInclude::getScreenLabel(Buffer const &) const
{
- return MakeAbsPath(getContents(),
- OnlyPath(getMasterFilename()));
+ docstring temp;
+
+ switch (type(params_)) {
+ case INPUT:
+ temp += _("Input");
+ break;
+ case VERB:
+ temp += _("Verbatim Input");
+ break;
+ case VERBAST:
+ temp += _("Verbatim Input*");
+ break;
+ case INCLUDE:
+ temp += _("Include");
+ break;
+ }
+
+ temp += ": ";
+
+ if (params_["filename"].empty())
+ temp += "???";
+ else
+ temp += from_utf8(onlyFilename(to_utf8(params_["filename"])));
+
+ return temp;
}
-string const InsetInclude::getMasterFilename() const
+namespace {
+
+/// return the child buffer if the file is a LyX doc and is loaded
+Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
{
- return master->fileName();
+ if (isVerbatim(params))
+ return 0;
+
+ string const included_file = includedFilename(buffer, params).absFilename();
+ if (!isLyXFilename(included_file))
+ return 0;
+
+ return theBufferList().getBuffer(included_file);
}
-bool InsetInclude::loadIfNeeded() const
+/// return true if the file is or got loaded.
+bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
{
- if (isNoLoad() || isVerb()) return false;
- if (!IsLyXFilename(getFileName())) return false;
-
- if (bufferlist.exists(getFileName())) return true;
-
- // the readonly flag can/will be wrong, not anymore I think.
- FileInfo finfo(getFileName());
- bool const ro = !finfo.writable();
- return bufferlist.readFile(getFileName(), ro) != 0;
+ if (isVerbatim(params))
+ return false;
+
+ FileName const included_file = includedFilename(buffer, params);
+ if (!isLyXFilename(included_file.absFilename()))
+ return false;
+
+ Buffer * buf = theBufferList().getBuffer(included_file.absFilename());
+ if (!buf) {
+ // the readonly flag can/will be wrong, not anymore I think.
+ if (!fs::exists(included_file.toFilesystemEncoding()))
+ return false;
+ buf = theBufferList().newBuffer(included_file.absFilename());
+ if (!loadLyXFile(buf, included_file))
+ return false;
+ }
+ if (buf)
+ buf->setParentName(parentFilename(buffer));
+ return buf != 0;
}
-int InsetInclude::Latex(Buffer const * buffer, ostream & os,
- bool /*fragile*/, bool /*fs*/) const
+} // namespace anon
+
+
+int InsetInclude::latex(Buffer const & buffer, odocstream & os,
+ OutputParams const & runparams) const
{
- string incfile(getContents());
-
+ string incfile(to_utf8(params_["filename"]));
+
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
-
- if (loadIfNeeded()) {
- Buffer * tmp = bufferlist.getBuffer(getFileName());
-
- if (tmp->params.textclass != buffer->params.textclass) {
- lyxerr << "ERROR: Cannot handle include file `"
- << MakeDisplayPath(getFileName())
- << "' which has textclass `"
- << textclasslist.NameOfClass(tmp->params.textclass)
- << "' instead of `"
- << textclasslist.NameOfClass(buffer->params.textclass)
- << "'." << endl;
- return 0;
+
+ FileName const included_file(includedFilename(buffer, params_));
+ Buffer const * const m_buffer = buffer.getMasterBuffer();
+
+ // if incfile is relative, make it relative to the master
+ // buffer directory.
+ if (!absolutePath(incfile)) {
+ incfile = makeRelPath(included_file.absFilename(),
+ m_buffer->filePath());
+ }
+
+ // write it to a file (so far the complete file)
+ string const exportfile = changeExtension(incfile, ".tex");
+ string const mangled = DocFileName(changeExtension(included_file.absFilename(),
+ ".tex")).mangledFilename();
+ FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
+
+ if (!runparams.nice)
+ incfile = mangled;
+ lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+ lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
+ lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
+
+ if (runparams.inComment || runparams.dryrun)
+ // Don't try to load or copy the file
+ ;
+ else if (loadIfNeeded(buffer, params_)) {
+ Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
+
+ if (tmp->params().textclass != m_buffer->params().textclass) {
+ // FIXME UNICODE
+ docstring text = bformat(_("Included file `%1$s'\n"
+ "has textclass `%2$s'\n"
+ "while parent file has textclass `%3$s'."),
+ makeDisplayPath(included_file.absFilename()),
+ from_utf8(tmp->params().getLyXTextClass().name()),
+ from_utf8(m_buffer->params().getLyXTextClass().name()));
+ Alert::warning(_("Different textclasses"), text);
+ //return 0;
}
-
- // write it to a file (so far the complete file)
- string writefile = ChangeExtension(getFileName(), ".tex");
- if (!buffer->tmppath.empty()
- && !buffer->niceFile) {
- incfile = subst(incfile, '/','@');
-#ifdef __EMX__
- incfile = subst(incfile, ':', '$');
+
+ tmp->markDepClean(m_buffer->temppath());
+
+#ifdef WITH_WARNINGS
+#warning handle non existing files
+#warning Second argument is irrelevant!
+// since only_body is true, makeLaTeXFile will not look at second
+// argument. Should we set it to string(), or should makeLaTeXFile
+// make use of it somehow? (JMarc 20031002)
#endif
- writefile = AddName(buffer->tmppath, incfile);
- } else
- writefile = getFileName();
- writefile = ChangeExtension(writefile, ".tex");
- lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
- lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
- tmp->markDepClean(buffer->tmppath);
-
tmp->makeLaTeXFile(writefile,
- OnlyPath(getMasterFilename()),
- buffer->niceFile, true);
- }
+ onlyPath(masterFilename(buffer)),
+ runparams, false);
+ } else {
+ // Copy the file to the temp dir, so that .aux files etc.
+ // are not created in the original dir. Files included by
+ // this file will be found via input@path, see ../buffer.C.
+ unsigned long const checksum_in = sum(included_file);
+ unsigned long const checksum_out = sum(writefile);
+
+ if (checksum_in != checksum_out) {
+ if (!copy(included_file, writefile)) {
+ // FIXME UNICODE
+ lyxerr[Debug::LATEX]
+ << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
+ "into the temporary directory."),
+ from_utf8(included_file.absFilename())))
+ << endl;
+ return 0;
+ }
+ }
+ }
+
+ string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
+ "latex" : "pdflatex";
+ if (isVerbatim(params_)) {
+ incfile = latex_path(incfile);
+ // FIXME UNICODE
+ os << '\\' << from_ascii(params_.getCmdName()) << '{'
+ << from_utf8(incfile) << '}';
+ } else if (type(params_) == INPUT) {
+ runparams.exportdata->addExternalFile(tex_format, writefile,
+ exportfile);
- if (isVerb()) {
- os << '\\' << getCmdName() << '{' << incfile << '}';
- } else if (isInput()) {
// \input wants file with extension (default is .tex)
- if (!IsLyXFilename(getFileName())) {
- os << '\\' << getCmdName() << '{' << incfile << '}';
+ if (!isLyXFilename(included_file.absFilename())) {
+ incfile = latex_path(incfile);
+ // FIXME UNICODE
+ os << '\\' << from_ascii(params_.getCmdName())
+ << '{' << from_utf8(incfile) << '}';
} else {
- os << '\\' << getCmdName() << '{'
- << ChangeExtension(incfile, ".tex")
- << '}';
+ incfile = changeExtension(incfile, ".tex");
+ incfile = latex_path(incfile);
+ // FIXME UNICODE
+ os << '\\' << from_ascii(params_.getCmdName())
+ << '{' << from_utf8(incfile) << '}';
}
} else {
+ runparams.exportdata->addExternalFile(tex_format, writefile,
+ exportfile);
+
// \include don't want extension and demands that the
// file really have .tex
- os << '\\' << getCmdName() << '{'
- << ChangeExtension(incfile, string())
- << '}';
+ incfile = changeExtension(incfile, string());
+ incfile = latex_path(incfile);
+ // FIXME UNICODE
+ os << '\\' << from_ascii(params_.getCmdName()) << '{'
+ << from_utf8(incfile) << '}';
}
return 0;
}
-int InsetInclude::Ascii(Buffer const *, std::ostream & os, int) const
+int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
+ OutputParams const &) const
{
- if (isVerb())
- os << GetFileContents(getFileName());
+ if (isVerbatim(params_)) {
+ // FIXME: We don't know the encoding of the file
+ docstring const str = from_utf8(
+ getFileContents(includedFilename(buffer, params_)));
+ os << str;
+ // Return how many newlines we issued.
+ return int(lyx::count(str.begin(), str.end(), '\n'));
+ }
return 0;
}
-int InsetInclude::Linuxdoc(Buffer const * buffer, ostream & os) const
+int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
+ OutputParams const & runparams) const
{
- string incfile(getContents());
-
+ string incfile = to_utf8(params_["filename"]);
+
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
-
- if (loadIfNeeded()) {
- Buffer * tmp = bufferlist.getBuffer(getFileName());
-
- // write it to a file (so far the complete file)
- string writefile = ChangeExtension(getFileName(), ".sgml");
- if (!buffer->tmppath.empty() && !buffer->niceFile) {
- incfile = subst(incfile, '/','@');
- writefile = AddName(buffer->tmppath, incfile);
- } else
- writefile = getFileName();
- if (IsLyXFilename(getFileName()))
- writefile = ChangeExtension(writefile, ".sgml");
+ string const included_file = includedFilename(buffer, params_).absFilename();
+
+ // write it to a file (so far the complete file)
+ string const exportfile = changeExtension(incfile, ".sgml");
+ DocFileName writefile(changeExtension(included_file, ".sgml"));
+
+ if (loadIfNeeded(buffer, params_)) {
+ Buffer * tmp = theBufferList().getBuffer(included_file);
+
+ string const mangled = writefile.mangledFilename();
+ writefile = makeAbsPath(mangled,
+ buffer.getMasterBuffer()->temppath());
+ if (!runparams.nice)
+ incfile = mangled;
lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+ lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
- tmp->makeLinuxDocFile(writefile, buffer->niceFile, true);
- }
-
- if (isVerb()) {
- os << "<inlinegraphic fileref=\"" << '&' << include_label << ';'
- << "\" format=\"linespecific\">"
- << "</inlinegraphic>";
- } else
- os << '&' << include_label << ';';
-
- return 0;
-}
+ tmp->makeDocBookFile(writefile, runparams, true);
+ }
-int InsetInclude::DocBook(Buffer const * buffer, ostream & os) const
-{
- string incfile(getContents());
+ runparams.exportdata->addExternalFile("docbook", writefile,
+ exportfile);
+ runparams.exportdata->addExternalFile("docbook-xml", writefile,
+ exportfile);
- // Do nothing if no file name has been specified
- if (incfile.empty())
- return 0;
-
- if (loadIfNeeded()) {
- Buffer * tmp = bufferlist.getBuffer(getFileName());
-
- // write it to a file (so far the complete file)
- string writefile = ChangeExtension(getFileName(), ".sgml");
- if (!buffer->tmppath.empty() && !buffer->niceFile) {
- incfile = subst(incfile, '/','@');
- writefile = AddName(buffer->tmppath, incfile);
- } else
- writefile = getFileName();
- if (IsLyXFilename(getFileName()))
- writefile = ChangeExtension(writefile, ".sgml");
+ if (isVerbatim(params_)) {
+ os << "<inlinegraphic fileref=\""
+ << '&' << include_label << ';'
+ << "\" format=\"linespecific\">";
+ } else
+ os << '&' << include_label << ';';
- lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
- lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
- tmp->makeDocBookFile(writefile, buffer->niceFile, true);
- }
-
- if (isVerb()) {
- os << "<inlinegraphic fileref=\"" << '&' << include_label << ';'
- << "\" format=\"linespecific\">"
- << "</inlinegraphic>";
- } else
- os << '&' << include_label << ';';
-
return 0;
}
-void InsetInclude::Validate(LaTeXFeatures & features) const
+void InsetInclude::validate(LaTeXFeatures & features) const
{
+ string incfile(to_utf8(params_["filename"]));
+ string writefile;
- string incfile(getContents());
- string writefile; // = ChangeExtension(getFileName(), ".sgml");
+ Buffer const & buffer = features.buffer();
- if (!master->tmppath.empty() && !master->niceFile) {
- incfile = subst(incfile, '/','@');
- writefile = AddName(master->tmppath, incfile);
- } else
- writefile = getFileName();
- // Use the relative path.
- //writefile = incfile;
+ string const included_file = includedFilename(buffer, params_).absFilename();
- if (IsLyXFilename(getFileName()))
- writefile = ChangeExtension(writefile, ".sgml");
+ if (isLyXFilename(included_file))
+ writefile = changeExtension(included_file, ".sgml");
+ else
+ writefile = included_file;
- features.IncludedFiles[include_label] = writefile;
+ if (!features.runparams().nice && !isVerbatim(params_)) {
+ incfile = DocFileName(writefile).mangledFilename();
+ writefile = makeAbsPath(incfile,
+ buffer.getMasterBuffer()->temppath()).absFilename();
+ }
- if (isVerb())
- features.verbatim = true;
+ features.includeFile(include_label, writefile);
+
+ if (isVerbatim(params_))
+ features.require("verbatim");
// Here we must do the fun stuff...
// Load the file in the include if it needs
// to be loaded:
- if (loadIfNeeded()) {
+ if (loadIfNeeded(buffer, params_)) {
// a file got loaded
- Buffer * tmp = bufferlist.getBuffer(getFileName());
- tmp->validate(features);
+ Buffer * const tmp = theBufferList().getBuffer(included_file);
+ if (tmp) {
+ // We must temporarily change features.buffer,
+ // otherwise it would always be the master buffer,
+ // and nested includes would not work.
+ features.setBuffer(*tmp);
+ tmp->validate(features);
+ features.setBuffer(buffer);
+ }
}
}
-vector<string> const InsetInclude::getLabelList() const
+void InsetInclude::getLabelList(Buffer const & buffer,
+ std::vector<docstring> & list) const
{
- vector<string> l;
+ if (loadIfNeeded(buffer, params_)) {
+ string const included_file = includedFilename(buffer, params_).absFilename();
+ Buffer * tmp = theBufferList().getBuffer(included_file);
+ tmp->setParentName("");
+ tmp->getLabelList(list);
+ tmp->setParentName(parentFilename(buffer));
+ }
+}
- if (loadIfNeeded()) {
- Buffer * tmp = bufferlist.getBuffer(getFileName());
- tmp->setParentName("");
- l = tmp->getLabelList();
- tmp->setParentName(getMasterFilename());
+
+void InsetInclude::fillWithBibKeys(Buffer const & buffer,
+ std::vector<std::pair<string, docstring> > & keys) const
+{
+ if (loadIfNeeded(buffer, params_)) {
+ string const included_file = includedFilename(buffer, params_).absFilename();
+ Buffer * tmp = theBufferList().getBuffer(included_file);
+ tmp->setParentName("");
+ tmp->fillWithBibKeys(keys);
+ tmp->setParentName(parentFilename(buffer));
}
+}
+
- return l;
+void InsetInclude::updateBibfilesCache(Buffer const & buffer)
+{
+ Buffer * const tmp = getChildBuffer(buffer, params_);
+ if (tmp) {
+ tmp->setParentName("");
+ tmp->updateBibfilesCache();
+ tmp->setParentName(parentFilename(buffer));
+ }
}
-vector<pair<string,string> > const InsetInclude::getKeys() const
+std::vector<FileName> const &
+InsetInclude::getBibfilesCache(Buffer const & buffer) const
{
- vector<pair<string,string> > keys;
-
- if (loadIfNeeded()) {
- Buffer * tmp = bufferlist.getBuffer(getFileName());
- tmp->setParentName("");
- keys = tmp->getBibkeyList();
- tmp->setParentName(getMasterFilename());
+ Buffer * const tmp = getChildBuffer(buffer, params_);
+ if (tmp) {
+ tmp->setParentName("");
+ std::vector<FileName> const & cache = tmp->getBibfilesCache();
+ tmp->setParentName(parentFilename(buffer));
+ return cache;
}
-
- return keys;
+ static std::vector<FileName> const empty;
+ return empty;
}
+
+
+bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
+{
+ BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
+
+ bool use_preview = false;
+ if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
+ graphics::PreviewImage const * pimage =
+ preview_->getPreviewImage(*mi.base.bv->buffer());
+ use_preview = pimage && pimage->image();
+ }
+
+ if (use_preview) {
+ preview_->metrics(mi, dim);
+ } else {
+ if (!set_label_) {
+ set_label_ = true;
+ button_.update(getScreenLabel(*mi.base.bv->buffer()),
+ true);
+ }
+ button_.metrics(mi, dim);
+ }
+
+ Box b(0, dim.wid, -dim.asc, dim.des);
+ button_.setBox(b);
+
+ bool const changed = dim_ != dim;
+ dim_ = dim;
+ return changed;
+}
+
+
+void InsetInclude::draw(PainterInfo & pi, int x, int y) const
+{
+ setPosCache(pi, x, y);
+
+ BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
+
+ bool use_preview = false;
+ if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
+ graphics::PreviewImage const * pimage =
+ preview_->getPreviewImage(*pi.base.bv->buffer());
+ use_preview = pimage && pimage->image();
+ }
+
+ if (use_preview)
+ preview_->draw(pi, x, y);
+ else
+ button_.draw(pi, x, y);
+}
+
+bool InsetInclude::display() const
+{
+ return type(params_) != INPUT;
+}
+
+
+
+//
+// preview stuff
+//
+
+void InsetInclude::fileChanged() const
+{
+ Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
+ if (!buffer_ptr)
+ return;
+
+ Buffer const & buffer = *buffer_ptr;
+ preview_->removePreview(buffer);
+ add_preview(*preview_.get(), *this, buffer);
+ preview_->startLoading(buffer);
+}
+
+
+namespace {
+
+bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
+{
+ FileName const included_file = includedFilename(buffer, params);
+
+ return type(params) == INPUT && params.preview() &&
+ isFileReadable(included_file);
+}
+
+
+docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
+{
+ odocstringstream os;
+ OutputParams runparams;
+ runparams.flavor = OutputParams::LATEX;
+ inset.latex(buffer, os, runparams);
+
+ return os.str();
+}
+
+
+void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
+ Buffer const & buffer)
+{
+ InsetCommandParams const & params = inset.params();
+ if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
+ preview_wanted(params, buffer)) {
+ renderer.setAbsFile(includedFilename(buffer, params));
+ docstring const snippet = latex_string(inset, buffer);
+ renderer.addPreview(snippet, buffer);
+ }
+}
+
+} // namespace anon
+
+
+void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
+{
+ Buffer const & buffer = ploader.buffer();
+ if (preview_wanted(params(), buffer)) {
+ preview_->setAbsFile(includedFilename(buffer, params()));
+ docstring const snippet = latex_string(*this, buffer);
+ preview_->addPreview(snippet, ploader);
+ }
+}
+
+
+void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
+{
+ Buffer const * const childbuffer = getChildBuffer(buffer, params_);
+ if (!childbuffer)
+ return;
+
+ TocList const & childtoclist = childbuffer->tocBackend().tocs();
+ TocList::const_iterator it = childtoclist.begin();
+ TocList::const_iterator const end = childtoclist.end();
+ for(; it != end; ++it)
+ toclist[it->first].insert(toclist[it->first].end(),
+ it->second.begin(), it->second.end());
+}
+
+
+void InsetInclude::updateLabels(Buffer const & buffer) const
+{
+ Buffer const * const childbuffer = getChildBuffer(buffer, params_);
+ if (!childbuffer)
+ return;
+
+ lyx::updateLabels(*childbuffer, true);
+}
+
+
+string const InsetIncludeMailer::name_("include");
+
+InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
+ : inset_(inset)
+{}
+
+
+string const InsetIncludeMailer::inset2string(Buffer const &) const
+{
+ return params2string(inset_.params());
+}
+
+
+void InsetIncludeMailer::string2params(string const & in,
+ InsetCommandParams & params)
+{
+ params.clear();
+ if (in.empty())
+ return;
+
+ istringstream data(in);
+ LyXLex lex(0,0);
+ lex.setStream(data);
+
+ string name;
+ lex >> name;
+ if (!lex || name != name_)
+ return print_mailer_error("InsetIncludeMailer", in, 1, name_);
+
+ // This is part of the inset proper that is usually swallowed
+ // by LyXText::readInset
+ string id;
+ lex >> id;
+ if (!lex || id != "Include")
+ return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
+
+ InsetInclude inset(params);
+ inset.read(lex);
+ params = inset.params();
+}
+
+
+string const
+InsetIncludeMailer::params2string(InsetCommandParams const & params)
+{
+ InsetInclude inset(params);
+ ostringstream data;
+ data << name_ << ' ';
+ inset.write(data);
+ data << "\\end_inset\n";
+ return data.str();
+}
+
+
+} // namespace lyx