* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
+ * \author Richard Heck (conversion to InsetCommand)
*
* Full author contact details are available in file CREDITS.
*/
#include "MetricsInfo.h"
#include "OutputParams.h"
#include "TocBackend.h"
+#include "TextClass.h"
#include "frontends/alert.h"
#include "frontends/Painter.h"
#include "insets/RenderPreview.h"
#include "insets/InsetListingsParams.h"
+#include "support/docstream.h"
#include "support/filetools.h"
#include "support/lstrings.h" // contains
#include "support/lyxalgo.h"
using support::isValidLaTeXFilename;
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::endl;
using std::find;
using std::string;
using std::istringstream;
}
+/// the type of inclusion
+enum Types {
+ INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
+};
+
+
+Types type(std::string const & s)
+{
+ if (s == "input")
+ return INPUT;
+ if (s == "verbatiminput")
+ return VERB;
+ if (s == "verbatiminput*")
+ return VERBAST;
+ if (s == "lstinputlisting")
+ return LISTINGS;
+ if (s == "include")
+ return INCLUDE;
+ return NONE;
+}
+
+
+Types type(InsetCommandParams const & params)
+{
+ return type(params.getCmdName());
+}
+
+
bool isListings(InsetCommandParams const & params)
{
- return params.getCmdName() == "lstinputlisting";
+ return type(params) == LISTINGS;
+}
+
+
+bool isVerbatim(InsetCommandParams const & params)
+{
+ Types const t = type(params);
+ return t == VERB || t == VERBAST;
+}
+
+
+bool isInputOrInclude(InsetCommandParams const & params)
+{
+ Types const t = type(params);
+ return t == INPUT || t == INCLUDE;
}
} // namespace anon
InsetInclude::InsetInclude(InsetCommandParams const & p)
- : params_(p), include_label(uniqueID()),
- preview_(new RenderMonitoredPreview(this)),
- set_label_(false)
+ : InsetCommand(p, "include"), include_label(uniqueID()),
+ preview_(new RenderMonitoredPreview(this)), set_label_(false)
{
preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
}
InsetInclude::InsetInclude(InsetInclude const & other)
- : Inset(other),
- params_(other.params_),
- include_label(other.include_label),
- preview_(new RenderMonitoredPreview(this)),
- set_label_(false)
+ : InsetCommand(other), include_label(other.include_label),
+ preview_(new RenderMonitoredPreview(this)), set_label_(false)
{
preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
}
-InsetInclude::~InsetInclude()
+CommandInfo const * InsetInclude::findInfo(std::string const & /* cmdName */)
{
- InsetIncludeMailer(*this).hideDialog();
+ // This is only correct for the case of listings, but it'll do for now.
+ // In the other cases, this second parameter should just be empty.
+ static const char * const paramnames[] = {"filename", "lstparams", ""};
+ static const bool isoptional[] = {false, true};
+ static const CommandInfo info = {2, paramnames, isoptional};
+ return &info;
+}
+
+
+bool InsetInclude::isCompatibleCommand(std::string const & s)
+{
+ return type(s) != NONE;
}
case LFUN_INSET_MODIFY: {
InsetCommandParams p(INCLUDE_CODE);
- InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p);
+ InsetCommandMailer::string2params("include", to_utf8(cmd.argument()), p);
if (!p.getCmdName().empty()) {
if (isListings(p)){
- InsetListingsParams par_old(params().getOptions());
- InsetListingsParams par_new(p.getOptions());
+ InsetListingsParams par_old(to_utf8(params()["lstparams"]));
+ InsetListingsParams par_new(to_utf8(p["lstparams"]));
if (par_old.getParamValue("label") !=
par_new.getParamValue("label")
&& !par_new.getParamValue("label").empty())
break;
}
- case LFUN_INSET_DIALOG_UPDATE:
- InsetIncludeMailer(*this).updateDialog(&cur.bv());
- break;
-
- case LFUN_MOUSE_RELEASE:
- if (!cur.selection())
- InsetIncludeMailer(*this).showDialog(&cur.bv());
- break;
-
+ //pass everything else up the chain
default:
- Inset::doDispatch(cur, cmd);
+ InsetCommand::doDispatch(cur, cmd);
break;
}
}
-bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
- FuncStatus & flag) const
-{
- switch (cmd.action) {
-
- case LFUN_INSET_MODIFY:
- case LFUN_INSET_DIALOG_UPDATE:
- flag.enabled(true);
- return true;
-
- default:
- return Inset::getStatus(cur, cmd, flag);
- }
-}
-
-
-InsetCommandParams const & InsetInclude::params() const
-{
- return params_;
-}
-
-
namespace {
-/// the type of inclusion
-enum Types {
- INCLUDE = 0,
- VERB = 1,
- INPUT = 2,
- VERBAST = 3,
- LISTINGS = 4,
-};
-
-
-Types type(InsetCommandParams const & params)
-{
- string const command_name = params.getCmdName();
-
- if (command_name == "input")
- return INPUT;
- if (command_name == "verbatiminput")
- return VERB;
- if (command_name == "verbatiminput*")
- return VERBAST;
- if (command_name == "lstinputlisting")
- return LISTINGS;
- return INCLUDE;
-}
-
-
-bool isVerbatim(InsetCommandParams const & params)
-{
- string const command_name = params.getCmdName();
- return command_name == "verbatiminput" ||
- command_name == "verbatiminput*";
-}
-
-
-bool isInputOrInclude(InsetCommandParams const & params)
-{
- Types const t = type(params);
- return (t == INPUT) || (t == INCLUDE);
-}
-
-
-string const masterFilename(Buffer const & buffer)
+FileName const masterFileName(Buffer const & buffer)
{
- return buffer.masterBuffer()->absFileName();
+ return buffer.masterBuffer()->fileName();
}
InsetCommandParams const & params)
{
return makeAbsPath(to_utf8(params["filename"]),
- onlyPath(parentFilename(buffer)));
+ onlyPath(parentFilename(buffer)));
}
void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
{
- params_ = p;
+ setParams(p);
set_label_ = false;
if (preview_->monitoring())
preview_->stopMonitoring();
- if (type(params_) == INPUT)
+ if (type(params()) == INPUT)
add_preview(*preview_, *this, buffer);
}
}
-void InsetInclude::write(Buffer const &, ostream & os) const
-{
- 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 &, Lexer & lex)
-{
- read(lex);
-}
-
-
-void InsetInclude::read(Lexer & lex)
-{
- if (lex.isOK()) {
- lex.eatLine();
- 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'");
- }
-}
-
-
docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
{
docstring temp;
- switch (type(params_)) {
+ switch (type(params())) {
case INPUT:
temp = buf.B_("Input");
break;
case INCLUDE:
temp = buf.B_("Include");
break;
- case LISTINGS: {
+ case LISTINGS:
temp = listings_label_;
- }
+ break;
+ case NONE:
+ BOOST_ASSERT(false);
}
temp += ": ";
- if (params_["filename"].empty())
+ if (params()["filename"].empty())
temp += "???";
else
- temp += from_utf8(onlyFilename(to_utf8(params_["filename"])));
+ temp += from_utf8(onlyFilename(to_utf8(params()["filename"])));
return temp;
}
return 0;
child = theBufferList().newBuffer(included_file.absFilename());
- if (!loadLyXFile(child, included_file)) {
+ if (!child->loadLyXFile(included_file)) {
//close the buffer we just opened
theBufferList().close(child, false);
return 0;
int InsetInclude::latex(Buffer const & buffer, odocstream & os,
OutputParams const & runparams) const
{
- string incfile(to_utf8(params_["filename"]));
+ string incfile(to_utf8(params()["filename"]));
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
- FileName const included_file = includedFilename(buffer, params_);
+ FileName const included_file = includedFilename(buffer, params());
//Check we're not trying to include ourselves.
//FIXME RECURSIVE INCLUDE
//This isn't sufficient, as the inclusion could be downstream.
//But it'll have to do for now.
- if (isInputOrInclude(params_) &&
+ if (isInputOrInclude(params()) &&
buffer.absFileName() == included_file.absFilename())
{
Alert::error(_("Recursive input"),
"when running the exported file through LaTeX: ") +
from_utf8(incfile));
}
- LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
- LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
- LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
+ LYXERR(Debug::LATEX, "incfile:" << incfile);
+ LYXERR(Debug::LATEX, "exportfile:" << exportfile);
+ LYXERR(Debug::LATEX, "writefile:" << writefile);
if (runparams.inComment || runparams.dryrun) {
//Don't try to load or copy the file if we're
//in a comment or doing a dryrun
- } else if (isInputOrInclude(params_) &&
+ } else if (isInputOrInclude(params()) &&
isLyXFilename(included_file.absFilename())) {
//if it's a LyX file and we're inputting or including,
//try to load it so we can write the associated latex
- if (!loadIfNeeded(buffer, params_))
+ if (!loadIfNeeded(buffer, params()))
return false;
Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
docstring text = bformat(_("Included file `%1$s'\n"
"has textclass `%2$s'\n"
"while parent file has textclass `%3$s'."),
- makeDisplayPath(included_file.absFilename()),
+ included_file.displayName(),
from_utf8(tmp->params().getTextClass().name()),
from_utf8(masterBuffer->params().getTextClass().name()));
Alert::warning(_("Different textclasses"), text);
docstring text = bformat(_("Included file `%1$s'\n"
"uses module `%2$s'\n"
"which is not used in parent file."),
- makeDisplayPath(included_file.absFilename()), from_utf8(module));
+ included_file.displayName(), from_utf8(module));
Alert::warning(_("Module not found"), text);
}
}
Encoding const * const oldEnc = runparams.encoding;
runparams.encoding = &tmp->params().encoding();
tmp->makeLaTeXFile(writefile,
- onlyPath(masterFilename(buffer)),
+ masterFileName(buffer).onlyPath(),
runparams, false);
runparams.encoding = oldEnc;
} else {
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"
+ 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;
+ from_utf8(included_file.absFilename()))));
return 0;
}
}
string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
"latex" : "pdflatex";
- if (isVerbatim(params_)) {
+ if (isVerbatim(params())) {
incfile = latex_path(incfile);
// FIXME UNICODE
- os << '\\' << from_ascii(params_.getCmdName()) << '{'
+ os << '\\' << from_ascii(params().getCmdName()) << '{'
<< from_utf8(incfile) << '}';
- } else if (type(params_) == INPUT) {
+ } else if (type(params()) == INPUT) {
runparams.exportdata->addExternalFile(tex_format, writefile,
exportfile);
if (!isLyXFilename(included_file.absFilename())) {
incfile = latex_path(incfile);
// FIXME UNICODE
- os << '\\' << from_ascii(params_.getCmdName())
+ os << '\\' << from_ascii(params().getCmdName())
<< '{' << from_utf8(incfile) << '}';
} else {
incfile = changeExtension(incfile, ".tex");
incfile = latex_path(incfile);
// FIXME UNICODE
- os << '\\' << from_ascii(params_.getCmdName())
+ os << '\\' << from_ascii(params().getCmdName())
<< '{' << from_utf8(incfile) << '}';
}
- } else if (type(params_) == LISTINGS) {
- os << '\\' << from_ascii(params_.getCmdName());
- string opt = params_.getOptions();
+ } else if (type(params()) == LISTINGS) {
+ os << '\\' << from_ascii(params().getCmdName());
+ string const opt = to_utf8(params()["lstparams"]);
// opt is set in QInclude dialog and should have passed validation.
InsetListingsParams params(opt);
if (!params.params().empty())
incfile = changeExtension(incfile, string());
incfile = latex_path(incfile);
// FIXME UNICODE
- os << '\\' << from_ascii(params_.getCmdName()) << '{'
+ os << '\\' << from_ascii(params().getCmdName()) << '{'
<< from_utf8(incfile) << '}';
}
int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
OutputParams const &) const
{
- if (isVerbatim(params_) || isListings(params_)) {
+ if (isVerbatim(params()) || isListings(params())) {
os << '[' << getScreenLabel(buffer) << '\n';
// FIXME: We don't know the encoding of the file
docstring const str =
- from_utf8(includedFilename(buffer, params_).fileContents());
+ from_utf8(includedFilename(buffer, params()).fileContents());
os << str;
os << "\n]";
return PLAINTEXT_NEWLINE + 1; // one char on a separate line
int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
OutputParams const & runparams) const
{
- string incfile = to_utf8(params_["filename"]);
+ string incfile = to_utf8(params()["filename"]);
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
- string const included_file = includedFilename(buffer, params_).absFilename();
+ string const included_file = includedFilename(buffer, params()).absFilename();
//Check we're not trying to include ourselves.
//FIXME RECURSIVE INCLUDE
string const exportfile = changeExtension(incfile, ".sgml");
DocFileName writefile(changeExtension(included_file, ".sgml"));
- if (loadIfNeeded(buffer, params_)) {
+ if (loadIfNeeded(buffer, params())) {
Buffer * tmp = theBufferList().getBuffer(included_file);
string const mangled = writefile.mangledFilename();
if (!runparams.nice)
incfile = mangled;
- LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
- LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
- LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
+ LYXERR(Debug::LATEX, "incfile:" << incfile);
+ LYXERR(Debug::LATEX, "exportfile:" << exportfile);
+ LYXERR(Debug::LATEX, "writefile:" << writefile);
tmp->makeDocBookFile(writefile, runparams, true);
}
runparams.exportdata->addExternalFile("docbook-xml", writefile,
exportfile);
- if (isVerbatim(params_) || isListings(params_)) {
+ if (isVerbatim(params()) || isListings(params())) {
os << "<inlinegraphic fileref=\""
<< '&' << include_label << ';'
<< "\" format=\"linespecific\">";
void InsetInclude::validate(LaTeXFeatures & features) const
{
- string incfile(to_utf8(params_["filename"]));
+ string incfile = to_utf8(params()["filename"]);
string writefile;
Buffer const & buffer = features.buffer();
- string const included_file = includedFilename(buffer, params_).absFilename();
+ string const included_file = includedFilename(buffer, params()).absFilename();
if (isLyXFilename(included_file))
writefile = changeExtension(included_file, ".sgml");
else
writefile = included_file;
- if (!features.runparams().nice && !isVerbatim(params_) && !isListings(params_)) {
+ if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
incfile = DocFileName(writefile).mangledFilename();
writefile = makeAbsPath(incfile,
buffer.masterBuffer()->temppath()).absFilename();
features.includeFile(include_label, writefile);
- if (isVerbatim(params_))
+ if (isVerbatim(params()))
features.require("verbatim");
- else if (isListings(params_))
+ else if (isListings(params()))
features.require("listings");
// Here we must do the fun stuff...
// Load the file in the include if it needs
// to be loaded:
- if (loadIfNeeded(buffer, params_)) {
+ if (loadIfNeeded(buffer, params())) {
// a file got loaded
Buffer * const tmp = theBufferList().getBuffer(included_file);
// make sure the buffer isn't us
void InsetInclude::getLabelList(Buffer const & buffer,
std::vector<docstring> & list) const
{
- if (isListings(params_)) {
- InsetListingsParams params(params_.getOptions());
- string label = params.getParamValue("label");
+ if (isListings(params())) {
+ InsetListingsParams p(to_utf8(params()["lstparams"]));
+ string label = p.getParamValue("label");
if (!label.empty())
list.push_back(from_utf8(label));
}
- else if (loadIfNeeded(buffer, params_)) {
- string const included_file = includedFilename(buffer, params_).absFilename();
+ else if (loadIfNeeded(buffer, params())) {
+ string const included_file = includedFilename(buffer, params()).absFilename();
Buffer * tmp = theBufferList().getBuffer(included_file);
tmp->setParentName("");
tmp->getLabelList(list);
void InsetInclude::fillWithBibKeys(Buffer const & buffer,
BiblioInfo & keys, InsetIterator const & /*di*/) const
{
- if (loadIfNeeded(buffer, params_)) {
- string const included_file = includedFilename(buffer, params_).absFilename();
+ if (loadIfNeeded(buffer, params())) {
+ string const included_file = includedFilename(buffer, params()).absFilename();
Buffer * tmp = theBufferList().getBuffer(included_file);
//FIXME This is kind of a dirty hack and should be made reasonable.
tmp->setParentName("");
void InsetInclude::updateBibfilesCache(Buffer const & buffer)
{
- Buffer * const tmp = getChildBuffer(buffer, params_);
+ Buffer * const tmp = getChildBuffer(buffer, params());
if (tmp) {
tmp->setParentName("");
tmp->updateBibfilesCache();
std::vector<FileName> const &
InsetInclude::getBibfilesCache(Buffer const & buffer) const
{
- Buffer * const tmp = getChildBuffer(buffer, params_);
+ Buffer * const tmp = getChildBuffer(buffer, params());
if (tmp) {
tmp->setParentName("");
std::vector<FileName> const & cache = tmp->getBibfilesCache();
Inset::DisplayType InsetInclude::display() const
{
- return type(params_) == INPUT ? Inline : AlignCenter;
+ return type(params()) == INPUT ? Inline : AlignCenter;
}
void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer,
ParConstIterator const & pit) const
{
- if (isListings(params_)) {
- InsetListingsParams params(params_.getOptions());
- string caption = params.getParamValue("caption");
+ if (isListings(params())) {
+ InsetListingsParams p(to_utf8(params()["lstparams"]));
+ string caption = p.getParamValue("caption");
if (caption.empty())
return;
Toc & toc = toclist["listing"];
toc.push_back(TocItem(pit, 0, str));
return;
}
- Buffer const * const childbuffer = getChildBuffer(buffer, params_);
+ Buffer const * const childbuffer = getChildBuffer(buffer, params());
if (!childbuffer)
return;
void InsetInclude::updateLabels(Buffer const & buffer, ParIterator const &)
{
- Buffer const * const childbuffer = getChildBuffer(buffer, params_);
+ Buffer const * const childbuffer = getChildBuffer(buffer, params());
if (childbuffer)
lyx::updateLabels(*childbuffer, true);
- else if (isListings(params_)) {
- InsetListingsParams const par = params_.getOptions();
+ else if (isListings(params())) {
+ InsetListingsParams const par(to_utf8(params()["lstparams"]));
if (par.getParamValue("caption").empty())
listings_label_.clear();
else {
EmbeddedFiles & files) const
{
// include and input are temprarily not considered.
- if (isVerbatim(params_) || isListings(params_))
- files.registerFile(includedFilename(buffer, params_).absFilename(),
+ if (isVerbatim(params()) || isListings(params()))
+ files.registerFile(includedFilename(buffer, params()).absFilename(),
false, this);
}
-
-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);
- Lexer 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 Text::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