X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCommandParams.cpp;h=a0cbd6e785be498fdc71b2ec85d1d54b55fc3245;hb=142caff8336c54627606c09d3ce5bb7de7a8adb6;hp=5ac876a43824a58cf7cc8081dfc724944a965107;hpb=2f4d0ae27ed43f639c75ad8b42abcfe920604eeb;p=lyx.git

diff --git a/src/insets/InsetCommandParams.cpp b/src/insets/InsetCommandParams.cpp
index 5ac876a438..a0cbd6e785 100644
--- a/src/insets/InsetCommandParams.cpp
+++ b/src/insets/InsetCommandParams.cpp
@@ -5,34 +5,158 @@
  *
  * \author Angus Leeming
  * \author Georg Baum
+ * \author Richard Heck
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
+#include <algorithm>
 
 #include "InsetCommandParams.h"
 
-#include "debug.h"
-#include "gettext.h"
+#include "InsetBibitem.h"
+#include "InsetBibtex.h"
+#include "InsetCitation.h"
+#include "InsetFloatList.h"
+#include "InsetHyperlink.h"
+#include "InsetInclude.h"
+#include "InsetIndex.h"
+#include "InsetLabel.h"
+#include "InsetNomencl.h"
+#include "InsetRef.h"
+#include "InsetTOC.h"
+
+#include "Encoding.h"
 #include "Lexer.h"
+#include "OutputParams.h"
 
+#include "frontends/alert.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>
+#include "support/lassert.h"
+
+using namespace std;
+using namespace lyx::support;
 
 
 namespace lyx {
 
-using support::findToken;
+/// Get information for \p code and command \p cmdName.
+/// Returns 0 if the combination is not known.  [FIXME: 0?]
+/// Don't call this without first making sure the command name is
+/// acceptable to the inset.
+static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
+{
+	switch (code) {
+	case BIBITEM_CODE:
+		return InsetBibitem::findInfo(cmdName);
+	case BIBTEX_CODE:
+		return InsetBibtex::findInfo(cmdName);
+	case CITE_CODE:
+		return InsetCitation::findInfo(cmdName);
+	case FLOAT_LIST_CODE:
+		return InsetFloatList::findInfo(cmdName);
+	case HYPERLINK_CODE:
+		return InsetHyperlink::findInfo(cmdName);
+	case INCLUDE_CODE:
+		return InsetInclude::findInfo(cmdName);
+	case INDEX_PRINT_CODE:
+		return InsetPrintIndex::findInfo(cmdName);
+	case LABEL_CODE:
+		return InsetLabel::findInfo(cmdName);
+	case NOMENCL_CODE:
+		return InsetNomencl::findInfo(cmdName);
+	case NOMENCL_PRINT_CODE:
+		return InsetPrintNomencl::findInfo(cmdName);
+	case REF_CODE:
+		return InsetRef::findInfo(cmdName);
+	case TOC_CODE:
+		return InsetTOC::findInfo(cmdName);
+	default:
+		LASSERT(false, /**/);
+	}
+	static const ParamInfo pi;
+	return pi; // to silence the warning
+}
+
+
+/////////////////////////////////////////////////////////////////////
+//
+// ParamInfo::ParamData
+//
+/////////////////////////////////////////////////////////////////////
+
+ParamInfo::ParamData::ParamData(std::string const & s, ParamType t,
+				ParamHandling h)
+	: name_(s), type_(t), handling_(h)
+{}
+
+
+bool ParamInfo::ParamData::isOptional() const
+{
+	return type_ == ParamInfo::LATEX_OPTIONAL;
+}
 
-using std::string;
-using std::endl;
-using std::ostream;
 
-using support::ExceptionMessage;
-using support::WarningException;
+bool ParamInfo::ParamData::operator==(ParamInfo::ParamData const & rhs) const
+{
+	return name() == rhs.name() && type() == rhs.type()
+		&& handling() == rhs.handling();
+}
+
+
+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 true;
+	}
+	return false;
+}
+
+
+void ParamInfo::add(std::string const & name, ParamType type,
+		    ParamHandling handling)
+{ 
+	info_.push_back(ParamData(name, type, handling)); 
+}
+
+
+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
+{
+	LASSERT(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
+//
+/////////////////////////////////////////////////////////////////////
 
 
 InsetCommandParams::InsetCommandParams(InsetCode code)
@@ -40,8 +164,6 @@ InsetCommandParams::InsetCommandParams(InsetCode code)
 {
 	cmdName_ = getDefaultCmd(code);
 	info_ = findInfo(code, cmdName_);
-	BOOST_ASSERT(info_);
-	params_.resize(info_->n);
 }
 
 
@@ -50,218 +172,110 @@ InsetCommandParams::InsetCommandParams(InsetCode code,
 	: insetCode_(code), cmdName_(cmdName), preview_(false)
 {
 	info_ = findInfo(code, cmdName);
-	BOOST_ASSERT(info_);
-	params_.resize(info_->n);
 }
 
 
-//FIXME This should go into the Insets themselves...so they will tell
-//us what parameters they want.
-//Should this just vanish in favor of the two arg version, or is there
-//a reason to use it in some cases? What should happen in the single
-//arg case, then? Maybe use the default? or leave that up to the inset?
-InsetCommandParams::CommandInfo const *
-	InsetCommandParams::findInfo(InsetCode code)
+std::string InsetCommandParams::insetType() const
 {
-	// No parameter may be named "preview", because that is a required
-	// flag for all commands.
-
-	switch (code) {
-	case BIBITEM_CODE: {
-		static const char * const paramnames[] = {"label", "key", ""};
-		static const bool isoptional[] = {true, false};
-		static const CommandInfo info = {2, paramnames, isoptional};
-		return &info;
-	}
-	case BIBTEX_CODE: {
-		static const char * const paramnames[] =
-				{"options", "btprint", "bibfiles", ""};
-		static const bool isoptional[] = {true, true, false};
-		static const CommandInfo info = {3, paramnames, isoptional};
-		return &info;
-	}
-	case CITE_CODE: {
-		// standard cite does only take one argument if jurabib is
-		// not used, but jurabib extends this to two arguments, so
-		// we have to allow both here. InsetCitation takes care that
-		// LaTeX output is nevertheless correct.
-		static const char * const paramnames[] =
-				{"after", "before", "key", ""};
-		static const bool isoptional[] = {true, true, false};
-		static const CommandInfo info = {3, paramnames, isoptional};
-		return &info;
-	}
-	case FLOAT_LIST_CODE: {
-		static const char * const paramnames[] = {"type", ""};
-		static const bool isoptional[] = {false};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
-	}
-	case HFILL_CODE: {
-		static const char * const paramnames[] = {""};
-		static const CommandInfo info = {0, paramnames, 0};
-		return &info;
-	}
-	case HYPERLINK_CODE: {
-		static const char * const paramnames[] =
-				{"name", "target", ""};
-		static const bool isoptional[] = {true, false};
-		static const CommandInfo info = {2, paramnames, isoptional};
-		return &info;
-	}
-	case INCLUDE_CODE: {
-		//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;
-	}
-	case INDEX_CODE: 
-	case INDEX_PRINT_CODE:
-	case LABEL_CODE: {
-		static const char * const paramnames[] = {"name", ""};
-		static const bool isoptional[] = {false};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
-	}
-	case NOMENCL_CODE: {
-		static const char * const paramnames[] = {"prefix", "symbol", "description", ""};
-		static const bool isoptional[] = {true, false, false};
-		static const CommandInfo info = {3, paramnames, isoptional};
-		return &info;
-	}
-	case NOMENCL_PRINT_CODE: {
-		static const char * const paramnames[] = {"labelwidth", ""};
-		static const bool isoptional[] = {true};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
-	}
-	case REF_CODE: {
-		static const char * const paramnames[] =
-				{"name", "reference", ""};
-		static const bool isoptional[] = {true, false};
-		static const CommandInfo info = {2, paramnames, isoptional};
-		return &info;
-	}
-	case TOC_CODE: {
-		static const char * const paramnames[] = {"type", ""};
-		static const bool isoptional[] = {false};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
-	}
-	default:
-		BOOST_ASSERT(false);
-	}
-	return 0;
+	return insetName(insetCode_);
 }
 
 
-//FIXME Will eventually call a static method, etc.
-InsetCommandParams::CommandInfo const *
-		InsetCommandParams::findInfo(InsetCode code,
-		                             std::string const &/* cmdName*/)
+string InsetCommandParams::getDefaultCmd(InsetCode code)
 {
-	return findInfo(code);
+	switch (code) {
+		case BIBITEM_CODE: 
+			return InsetBibitem::defaultCommand();
+		case BIBTEX_CODE:
+			return InsetBibtex::defaultCommand();
+		case CITE_CODE:
+			return InsetCitation::defaultCommand();
+		case FLOAT_LIST_CODE:
+			return InsetFloatList::defaultCommand();
+		case HYPERLINK_CODE:
+			return InsetHyperlink::defaultCommand();
+		case INCLUDE_CODE:
+			return InsetInclude::defaultCommand();
+		case INDEX_PRINT_CODE:
+			return InsetPrintIndex::defaultCommand();
+		case LABEL_CODE:
+			return InsetLabel::defaultCommand();
+		case NOMENCL_CODE:
+			return InsetNomencl::defaultCommand();
+		case NOMENCL_PRINT_CODE:
+			return InsetPrintNomencl::defaultCommand();
+		case REF_CODE:
+			return InsetRef::defaultCommand();
+		case TOC_CODE:
+			return InsetTOC::defaultCommand();
+		default:
+			LASSERT(false, /**/);
+	}
+	return string(); // silence the warning
 }
 
 
-//FIXME Should call InsetBibitem::getDefaultCmd(), eg
-std::string InsetCommandParams::getDefaultCmd(InsetCode code) {
+bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
+{
 	switch (code) {
 		case BIBITEM_CODE: 
-			return "bibitem";
+			return InsetBibitem::isCompatibleCommand(s);
 		case BIBTEX_CODE:
-			return "bibtex"; //this is an unused dummy
+			return InsetBibtex::isCompatibleCommand(s);
 		case CITE_CODE:
-			return "cite";
+			return InsetCitation::isCompatibleCommand(s);
 		case FLOAT_LIST_CODE:
-			return "listoftables";
-		case HFILL_CODE:
-			return "hfill";
+			return InsetFloatList::isCompatibleCommand(s);
 		case HYPERLINK_CODE:
-			return "href";
+			return InsetHyperlink::isCompatibleCommand(s);
 		case INCLUDE_CODE:
-			return "include";
-		case INDEX_CODE: 
-			return "index";
+			return InsetInclude::isCompatibleCommand(s);
 		case INDEX_PRINT_CODE:
-			return "printindex";
+			return InsetPrintIndex::isCompatibleCommand(s);
 		case LABEL_CODE:
-			return "label";
+			return InsetLabel::isCompatibleCommand(s);
 		case NOMENCL_CODE:
-			return "nomenclature";
+			return InsetNomencl::isCompatibleCommand(s);
 		case NOMENCL_PRINT_CODE:
-			return "printnomenclature";
+			return InsetPrintNomencl::isCompatibleCommand(s);
 		case REF_CODE:
-			return "ref";
+			return InsetRef::isCompatibleCommand(s);
 		case TOC_CODE:
-			return "tableofcontents";
+			return InsetTOC::isCompatibleCommand(s);
 		default:
-			BOOST_ASSERT(false);
+			LASSERT(false, /**/);
 	}
-	return "";
+	return false; // silence the warning
 }
 
 
 void InsetCommandParams::setCmdName(string const & name)
 {
-	//FIXME Check command compatibility
-	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];
+	if (!isCompatibleCommand(insetCode_, name)) {
+		LYXERR0("InsetCommand: Incompatible command name " << 
+				name << ".");
+		throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
+		                       _("Incompatible command name."));
 	}
-	info_ = info;
-	std::swap(params, params_);
+
+	cmdName_ = name;
+	info_ = findInfo(insetCode_, cmdName_);
 }
 
 
 void InsetCommandParams::read(Lexer & lex)
 {
-	if (lex.isOK()) {
-		lex.next();
-		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.setContext("InsetCommandParams::read");
+	lex >> insetName(insetCode_).c_str();
+	lex >> "LatexCommand";
+	lex >> cmdName_;
+	if (!isCompatibleCommand(insetCode_, cmdName_)) {
+		lex.printError("Incompatible command name " + cmdName_ + ".");
+		throw ExceptionMessage(WarningException, _("InsetCommandParams Error: "),
+		                       _("Incompatible command name."));
 	}
 
-	if (lex.isOK()) {
-		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.next();
-	cmdName_ = lex.getString();
-	//FIXME
-	//check that this command is ok with the inset...
-	//so that'll be some kind of static call, depending 
-	//upon what insetType_ is.
-	//it's possible that should go into InsetCommand.cpp,
-	//or maybe it's a standalone function.
 	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()) {
@@ -274,14 +288,13 @@ void InsetCommandParams::read(Lexer & lex)
 			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));
 		}
 	}
@@ -289,8 +302,8 @@ void InsetCommandParams::read(Lexer & lex)
 		lex.printError("Missing \\end_inset at this point. "
 			       "Read: `$$Token'");
 		throw ExceptionMessage(WarningException,
-			_("Missing \\end_inset at this point."),
-			from_utf8(token));
+			_("InsetCommandParams Error: "),
+			_("Missing \\end_inset at this point: ") + from_utf8(token));
 	}
 }
 
@@ -301,42 +314,121 @@ void InsetCommandParams::write(ostream & os) const
 	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 const InsetCommandParams::getCommand() const
+bool InsetCommandParams::writeEmptyOptional(ParamInfo::const_iterator ci) const
+{
+	if (!ci->isOptional()) {
+		LASSERT(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::LYX_INTERNAL:
+			break;
+
+		case ParamInfo::LATEX_REQUIRED:
+			return false;
+
+		case ParamInfo::LATEX_OPTIONAL: {
+			std::string const & name = ci->name();
+			docstring const & data = (*this)[name];
+			if (!data.empty())
+				return true;
+			break;
+		}
+
+		} //end switch
+	}
+	return false;
+}
+
+
+
+docstring InsetCommandParams::prepareCommand(OutputParams const & runparams,
+					     docstring const & command,
+					     ParamInfo::ParamHandling handling) const
+{
+	docstring result;
+	if (handling == ParamInfo::HANDLING_LATEXIFY) {
+		docstring uncodable;
+		for (size_t n = 0; n < command.size(); ++n) {
+			try {
+				result += runparams.encoding->latexChar(command[n]);
+			} catch (EncodingException & /* e */) {
+				LYXERR0("Uncodable character in command inset!");
+				if (runparams.dryrun) {
+					result += "<" + _("LyX Warning: ")
+						+ _("uncodable character") + " '";
+					result += docstring(1, command[n]);
+					result += "'>";
+				} else
+					uncodable += command[n];
+			}
+		}
+		if (!uncodable.empty()) {
+			// issue a warning about omitted characters
+			// FIXME: should be passed to the error dialog
+			frontend::Alert::warning(_("Uncodable characters"),
+				bformat(_("The following characters that are used in the inset %1$s are not\n"
+					  "representable in the current encoding and therefore have been omitted:\n%2$s."),
+					from_utf8(insetType()), uncodable));
+		}
+	} else if (handling == ParamInfo::HANDLING_ESCAPE)
+		result = escape(command);
+	else
+		result = command;
+
+	return result;
+}
+
+
+docstring InsetCommandParams::getCommand(OutputParams const & runparams) const
 {
 	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] + ']';
-				noparam = false;
-			}
-		} 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::LYX_INTERNAL:
+			break;
+
+		case ParamInfo::LATEX_REQUIRED: {
+			docstring const & data =
+				prepareCommand(runparams, (*this)[name], it->handling());
+			s += '{' + data + '}';
 			noparam = false;
+			break;
 		}
+		case ParamInfo::LATEX_OPTIONAL: {
+			docstring const & data =
+				prepareCommand(runparams, (*this)[name], it->handling());
+			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
@@ -346,52 +438,53 @@ docstring const InsetCommandParams::getCommand() const
 }
 
 
-docstring const InsetCommandParams::getFirstNonOptParam() const
+docstring 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()) {
+		LASSERT(false, return docstring());
+	}
+	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
+	LASSERT(info_.hasParam(name), return dummy);
+	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];
+	LASSERT(info_.hasParam(name), /**/);
+	return params_[name];
 }
 
 
 void InsetCommandParams::clear()
 {
-	for (size_t i = 0; i < info_->n; ++i)
-		params_[i].clear();
+	params_.clear();
 }
 
 
-bool operator==(InsetCommandParams const & o1,
-		InsetCommandParams const & o2)
+bool operator==(InsetCommandParams const & o1, InsetCommandParams const & o2)
 {
-	return o1.insetCode_ == o2.insetCode_ &&
-	       o1.cmdName_ == o2.cmdName_ &&
-	       o1.info_ == o2.info_ &&
-	       o1.params_ == o2.params_ &&
-	       o1.preview_ == o2.preview_;
+	return o1.insetCode_ == o2.insetCode_
+		&& o1.cmdName_ == o2.cmdName_
+		&& o1.info_ == o2.info_
+		&& o1.params_ == o2.params_
+		&& o1.preview_ == o2.preview_;
 }
 
 
-bool operator!=(InsetCommandParams const & o1,
-		InsetCommandParams const & o2)
+bool operator!=(InsetCommandParams const & o1, InsetCommandParams const & o2)
 {
 	return !(o1 == o2);
 }