*/
#include <config.h>
+#include <algorithm>
#include "InsetCommandParams.h"
#include "InsetBibtex.h"
#include "InsetCitation.h"
#include "InsetFloatList.h"
-#include "InsetHFill.h"
#include "InsetHyperlink.h"
#include "InsetInclude.h"
#include "InsetIndex.h"
#include "InsetRef.h"
#include "InsetTOC.h"
-#include "debug.h"
-#include "gettext.h"
#include "Lexer.h"
+#include "support/debug.h"
+#include "support/docstream.h"
#include "support/ExceptionMessage.h"
+#include "support/gettext.h"
#include "support/lstrings.h"
#include <boost/assert.hpp>
+using namespace std;
+using namespace lyx::support;
+
namespace lyx {
-using support::findToken;
+/////////////////////////////////////////////////////////////////////
+//
+// ParamInfo::ParamData
+//
+/////////////////////////////////////////////////////////////////////
+
+ParamInfo::ParamData::ParamData(std::string const & s, ParamType t)
+ : name_(s), type_(t)
+{}
+
+
+bool ParamInfo::ParamData::isOptional() const
+{
+ return type_ == ParamInfo::LATEX_OPTIONAL
+ || type_ == ParamInfo::LATEX_KV_OPTIONAL;
+}
+
+
+bool ParamInfo::ParamData::isKeyValArg() const
+{
+ return type_ == ParamInfo::LATEX_KV_REQUIRED
+ || type_ == ParamInfo::LATEX_KV_OPTIONAL;
+}
+
-using std::string;
-using std::endl;
-using std::ostream;
+bool ParamInfo::ParamData::operator==(ParamInfo::ParamData const & rhs) const
+{
+ return name() == rhs.name() && type() == rhs.type();
+}
+
+
+bool ParamInfo::hasParam(std::string const & name) const
+{
+ const_iterator it = begin();
+ const_iterator last = end();
+ for (; it != last; ++it) {
+ if (it->name() == name)
+ return !it->isKeyValArg();
+ }
+ return false;
+}
+
+
+void ParamInfo::add(std::string const & name, ParamType type)
+{
+ info_.push_back(ParamData(name, type));
+}
+
+
+bool ParamInfo::operator==(ParamInfo const & rhs) const
+{
+ if (size() != rhs.size())
+ return false;
+ return equal(begin(), end(), rhs.begin());
+}
+
+
+ParamInfo::ParamData const &
+ ParamInfo::operator[](std::string const & name) const
+{
+ BOOST_ASSERT(hasParam(name));
+ const_iterator it = begin();
+ const_iterator last = end();
+ for (; it != last; ++it) {
+ if (it->name() == name)
+ return *it;
+ }
+ return *it; // silence warning
+}
+
+
+/////////////////////////////////////////////////////////////////////
+//
+// InsetCommandParams
+//
+/////////////////////////////////////////////////////////////////////
-using support::ExceptionMessage;
-using support::WarningException;
InsetCommandParams::InsetCommandParams(InsetCode code)
: insetCode_(code), preview_(false)
{
cmdName_ = getDefaultCmd(code);
info_ = findInfo(code, cmdName_);
- BOOST_ASSERT(info_);
- params_.resize(info_->n);
}
: insetCode_(code), cmdName_(cmdName), preview_(false)
{
info_ = findInfo(code, cmdName);
- BOOST_ASSERT(info_);
- params_.resize(info_->n);
}
-CommandInfo const * InsetCommandParams::findInfo(
- InsetCode code, std::string const & cmdName)
+ParamInfo const & InsetCommandParams::findInfo(
+ InsetCode code, string const & cmdName)
{
switch (code) {
case BIBITEM_CODE:
return InsetCitation::findInfo(cmdName);
case FLOAT_LIST_CODE:
return InsetFloatList::findInfo(cmdName);
- case HFILL_CODE:
- return InsetHFill::findInfo(cmdName);
case HYPERLINK_CODE:
return InsetHyperlink::findInfo(cmdName);
case INCLUDE_CODE:
return InsetInclude::findInfo(cmdName);
- case INDEX_CODE:
- return InsetIndex::findInfo(cmdName);
case INDEX_PRINT_CODE:
return InsetPrintIndex::findInfo(cmdName);
case LABEL_CODE:
default:
BOOST_ASSERT(false);
}
- return 0;
+ static const ParamInfo pi;
+ return pi; // to silence the warning
+}
+
+
+std::string InsetCommandParams::insetType() const
+{
+ return insetName(insetCode_);
}
-std::string InsetCommandParams::getDefaultCmd(InsetCode code) {
+string InsetCommandParams::getDefaultCmd(InsetCode code) {
switch (code) {
case BIBITEM_CODE:
return InsetBibitem::defaultCommand();
return InsetCitation::defaultCommand();
case FLOAT_LIST_CODE:
return InsetFloatList::defaultCommand();
- case HFILL_CODE:
- return InsetHFill::defaultCommand();
case HYPERLINK_CODE:
return InsetHyperlink::defaultCommand();
case INCLUDE_CODE:
return InsetInclude::defaultCommand();
- case INDEX_CODE:
- return InsetIndex::defaultCommand();
case INDEX_PRINT_CODE:
return InsetPrintIndex::defaultCommand();
case LABEL_CODE:
default:
BOOST_ASSERT(false);
}
- return string(); //silence the warning
+ return string(); // silence the warning
}
bool InsetCommandParams::isCompatibleCommand(
- InsetCode code, std::string const & s)
+ InsetCode code, string const & s)
{
switch (code) {
case BIBITEM_CODE:
return InsetCitation::isCompatibleCommand(s);
case FLOAT_LIST_CODE:
return InsetFloatList::isCompatibleCommand(s);
- case HFILL_CODE:
- return InsetHFill::isCompatibleCommand(s);
case HYPERLINK_CODE:
return InsetHyperlink::isCompatibleCommand(s);
case INCLUDE_CODE:
return InsetInclude::isCompatibleCommand(s);
- case INDEX_CODE:
- return InsetIndex::isCompatibleCommand(s);
case INDEX_PRINT_CODE:
return InsetPrintIndex::isCompatibleCommand(s);
case LABEL_CODE:
default:
BOOST_ASSERT(false);
}
- return false; //silence the warning
+ return false; // silence the warning
}
void InsetCommandParams::setCmdName(string const & name)
{
if (!isCompatibleCommand(insetCode_, cmdName_)){
- lyxerr << "InsetCommand: Incompatible command name " <<
- name << "." << std::endl;
+ LYXERR0("InsetCommand: Incompatible command name " <<
+ name << ".");
throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
- from_utf8("Incompatible command name."));
+ _("Incompatible command name."));
}
cmdName_ = name;
- CommandInfo const * const info = findInfo(insetCode_, cmdName_);
- if (!info) {
- lyxerr << "Command '" << name << "' is not compatible with a '" <<
- insetType() << "' inset." << std::endl;
- return;
- }
- ParamVector params(info->n);
- // Overtake parameters with the same name
- for (size_t i = 0; i < info_->n; ++i) {
- int j = findToken(info->paramnames, info_->paramnames[i]);
- if (j >= 0)
- params[j] = params_[i];
- }
- info_ = info;
- std::swap(params, params_);
+ info_ = findInfo(insetCode_, cmdName_);
}
string const insetType = lex.getString();
InsetCode const code = insetCode(insetType);
if (code != insetCode_) {
- lex.printError("InsetCommand: Attempt to change type of parameters.");
- throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
- from_utf8("Attempt to change type of parameters."));
+ lex.printError("InsetCommandParams: Attempt to change type of inset.");
+ throw ExceptionMessage(WarningException, _("InsetCommandParams Error: "),
+ _("Attempt to change type of parameters."));
}
}
lex.next();
string const test = lex.getString();
if (test != "LatexCommand") {
- lex.printError("InsetCommand: no LatexCommand line found.");
- throw ExceptionMessage(WarningException, _("InsetCommand error:"),
- from_utf8("Can't find LatexCommand line."));
+ lex.printError("InsetCommandParams: No LatexCommand line found.");
+ throw ExceptionMessage(WarningException, _("InsetCommandParams error: "),
+ _("Can't find LatexCommand line."));
}
}
lex.next();
cmdName_ = lex.getString();
if (!isCompatibleCommand(insetCode_, cmdName_)){
- lex.printError("InsetCommand: Incompatible command name " + cmdName_ + ".");
- throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
- from_utf8("Incompatible command name."));
+ lex.printError("InsetCommandParams: Incompatible command name " + cmdName_ + ".");
+ throw ExceptionMessage(WarningException, _("InsetCommandParams Error: "),
+ _("Incompatible command name."));
}
info_ = findInfo(insetCode_, cmdName_);
- if (!info_) {
- lex.printError("InsetCommand: Unknown inset name `$$Token'");
- throw ExceptionMessage(WarningException,
- _("Unknown inset name: "), from_utf8(insetType()));
- }
string token;
while (lex.isOK()) {
preview_ = lex.getBool();
continue;
}
- int const i = findToken(info_->paramnames, token);
- if (i >= 0) {
+ if (info_.hasParam(token)) {
lex.next(true);
- params_[i] = lex.getDocString();
+ params_[token] = lex.getDocString();
} else {
lex.printError("Unknown parameter name `$$Token' for command " + cmdName_);
throw ExceptionMessage(WarningException,
- _("Inset Command: ") + from_ascii(cmdName_),
+ _("InsetCommandParams: ") + from_ascii(cmdName_),
_("Unknown parameter name: ") + from_utf8(token));
}
}
os << "LatexCommand " << cmdName_ << '\n';
if (preview_)
os << "preview true\n";
- for (size_t i = 0; i < info_->n; ++i)
- if (!params_[i].empty())
+ ParamInfo::const_iterator it = info_.begin();
+ ParamInfo::const_iterator end = info_.end();
+ for (; it != end; ++it) {
+ std::string const & name = it->name();
+ docstring const & data = (*this)[name];
+ if (!data.empty()) {
// FIXME UNICODE
- os << info_->paramnames[i] << ' '
- << Lexer::quoteString(to_utf8(params_[i]))
+ os << name << ' '
+ << Lexer::quoteString(to_utf8(data))
<< '\n';
+ }
+ }
+}
+
+
+docstring InsetCommandParams::makeKeyValArgument() const
+{
+ odocstringstream os;
+ bool didone = false;
+ ParamInfo::const_iterator it = info_.begin();
+ ParamInfo::const_iterator end = info_.end();
+ for (; it != end; ++it) {
+ if (!it->isKey())
+ continue;
+ string const & name = it->name();
+ docstring const & data = (*this)[name];
+ if (data.empty())
+ continue;
+ if (didone)
+ os << ",";
+ else
+ didone = true;
+ os << from_utf8(name) << "=" << data;
+ }
+ return os.str();
+}
+
+
+bool InsetCommandParams::writeEmptyOptional(ParamInfo::const_iterator ci) const
+{
+ if (!ci->isOptional())
+ BOOST_ASSERT(false);
+ ++ci; // we want to start with the next one
+ ParamInfo::const_iterator end = info_.end();
+ for (; ci != end; ++ci) {
+ switch (ci->type()) {
+ case ParamInfo::LATEX_KEY:
+ case ParamInfo::LYX_INTERNAL:
+ break;
+
+ case ParamInfo::LATEX_REQUIRED:
+ case ParamInfo::LATEX_KV_REQUIRED:
+ return false;
+
+ case ParamInfo::LATEX_OPTIONAL: {
+ std::string const & name = ci->name();
+ docstring const & data = (*this)[name];
+ if (!data.empty())
+ return true;
+ break;
+ }
+
+ case ParamInfo::LATEX_KV_OPTIONAL: {
+ docstring data = makeKeyValArgument();
+ if (!data.empty())
+ return true;
+ break;
+ }
+ } //end switch
+ }
+ return false;
}
{
docstring s = '\\' + from_ascii(cmdName_);
bool noparam = true;
- for (size_t i = 0; i < info_->n; ++i) {
- if (info_->optional[i]) {
- if (params_[i].empty()) {
- // We need to write this parameter even if
- // it is empty if nonempty optional parameters
- // follow before the next required parameter.
- for (size_t j = i + 1; j < info_->n; ++j) {
- if (!info_->optional[j])
- break;
- if (!params_[j].empty()) {
- s += "[]";
- noparam = false;
- break;
- }
- }
- } else {
- s += '[' + params_[i] + ']';
+ ParamInfo::const_iterator it = info_.begin();
+ ParamInfo::const_iterator end = info_.end();
+ for (; it != end; ++it) {
+ std::string const & name = it->name();
+ switch (it->type()) {
+ case ParamInfo::LATEX_KEY:
+ case ParamInfo::LYX_INTERNAL:
+ break;
+
+ case ParamInfo::LATEX_REQUIRED: {
+ docstring const & data = (*this)[name];
+ s += '{' + data + '}';
+ noparam = false;
+ break;
+ }
+ case ParamInfo::LATEX_KV_REQUIRED: {
+ s += "{" + makeKeyValArgument() + "}";
+ noparam = false;
+ break;
+ }
+ case ParamInfo::LATEX_OPTIONAL: {
+ docstring const & data = (*this)[name];
+ if (!data.empty()) {
+ s += '[' + data + ']';
noparam = false;
+ } else if (writeEmptyOptional(it)) {
+ s += "[]";
+ noparam = false;
}
- } else {
- s += '{' + params_[i] + '}';
- noparam = false;
+ break;
+ }
+ case ParamInfo::LATEX_KV_OPTIONAL: {
+ docstring data = makeKeyValArgument();
+ if (!data.empty()) {
+ s += '[' + data + ']';
+ noparam = false;
+ } else if (writeEmptyOptional(it)) {
+ s += "[]";
+ noparam = false;
+ }
+ break;
}
+ } //end switch
}
if (noparam)
// Make sure that following stuff does not change the
docstring const InsetCommandParams::getFirstNonOptParam() const
{
- for (size_t i = 0; i < info_->n; ++i)
- if (!info_->optional[i])
- return params_[i];
- BOOST_ASSERT(false);
- return docstring();
+ ParamInfo::const_iterator it =
+ find_if(info_.begin(), info_.end(),
+ not1(mem_fun_ref(&ParamInfo::ParamData::isOptional)));
+ if (it == info_.end())
+ BOOST_ASSERT(false);
+ return (*this)[it->name()];
}
docstring const & InsetCommandParams::operator[](string const & name) const
{
- int const i = findToken(info_->paramnames, name);
- BOOST_ASSERT(i >= 0);
- return params_[i];
+ static const docstring dummy; //so we don't return a ref to temporary
+ BOOST_ASSERT(info_.hasParam(name));
+ ParamMap::const_iterator data = params_.find(name);
+ if (data == params_.end() || data->second.empty())
+ return dummy;
+ return data->second;
}
docstring & InsetCommandParams::operator[](string const & name)
{
- int const i = findToken(info_->paramnames, name);
- BOOST_ASSERT(i >= 0);
- return params_[i];
+ BOOST_ASSERT(info_.hasParam(name));
+ return params_[name];
}
void InsetCommandParams::clear()
{
- for (size_t i = 0; i < info_->n; ++i)
- params_[i].clear();
+ params_.clear();
}
projects / lyx.git / blobdiff