X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCommandParams.cpp;h=90fe6cca8ad813cd38ac067f29b1e13ee25610ff;hb=06254d11dfdf670fab3548dc2a2674e7a261262c;hp=24f2de9112227e1027ed03999f9379d9982e1a71;hpb=c8d00ed1272cd489041bed2115081008b6a26489;p=lyx.git

diff --git a/src/insets/InsetCommandParams.cpp b/src/insets/InsetCommandParams.cpp
index 24f2de9112..90fe6cca8a 100644
--- a/src/insets/InsetCommandParams.cpp
+++ b/src/insets/InsetCommandParams.cpp
@@ -5,6 +5,7 @@
  *
  * \author Angus Leeming
  * \author Georg Baum
+ * \author Richard Heck
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -13,166 +14,180 @@
 
 #include "InsetCommandParams.h"
 
-#include "debug.h"
-#include "gettext.h"
-#include "lyxlex.h"
+#include "InsetBibitem.h"
+#include "InsetBibtex.h"
+#include "InsetCitation.h"
+#include "InsetFloatList.h"
+#include "InsetHFill.h"
+#include "InsetHyperlink.h"
+#include "InsetInclude.h"
+#include "InsetIndex.h"
+#include "InsetLabel.h"
+#include "InsetNomencl.h"
+#include "InsetRef.h"
+#include "InsetTOC.h"
+
+#include "support/debug.h"
+#include "support/gettext.h"
+#include "Lexer.h"
 
 #include "support/ExceptionMessage.h"
 #include "support/lstrings.h"
+#include "support/docstream.h"
 
 #include <boost/assert.hpp>
 
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::findToken;
 
-using std::string;
-using std::endl;
-using std::ostream;
-
-using support::ExceptionMessage;
-using support::WarningException;
-
-InsetCommandParams::InsetCommandParams(string const & name)
-	: name_(name), preview_(false)
+InsetCommandParams::InsetCommandParams(InsetCode code)
+	: insetCode_(code), preview_(false)
 {
-	info_ = findInfo(name);
+	cmdName_ = getDefaultCmd(code);
+	info_ = findInfo(code, cmdName_);
 	BOOST_ASSERT(info_);
 	params_.resize(info_->n);
 }
 
 
-InsetCommandParams::CommandInfo const *
-InsetCommandParams::findInfo(std::string const & name)
+InsetCommandParams::InsetCommandParams(InsetCode code,
+	string const & cmdName)
+	: insetCode_(code), cmdName_(cmdName), preview_(false)
 {
-	// No parameter may be named "preview", because that is a required
-	// flag for all commands.
-
-	// InsetBibitem
-	if (name == "bibitem") {
-		static const char * const paramnames[] = {"label", "key", ""};
-		static const bool isoptional[] = {true, false};
-		static const CommandInfo info = {2, paramnames, isoptional};
-		return &info;
-	}
-
-	// InsetBibtex
-	if (name == "bibtex") {
-		static const char * const paramnames[] =
-				{"options", "btprint", "bibfiles", ""};
-		static const bool isoptional[] = {true, true, false};
-		static const CommandInfo info = {3, paramnames, isoptional};
-		return &info;
-	}
-
-	// InsetCitation
-	// FIXME: Use is_possible_cite_command() in
-	// src/frontends/controllers/biblio.C, see comment in src/factory.C.
-	if (name == "cite" || name == "citet" || name == "citep" || name == "citealt" ||
-	    name == "citealp" || name == "citeauthor" || name == "citeyear" ||
-	    name == "citeyearpar" || name == "citet*" || name == "citep*" ||
-	    name == "citealt*" || name == "citealp*" ||
-	    name == "citeauthor*" || name == "Citet" || name == "Citep" ||
-	    name == "Citealt" || name == "Citealp" || name == "Citeauthor" ||
-	    name == "Citet*" || name == "Citep*" || name == "Citealt*" ||
-	    name == "Citealp*" || name == "Citeauthor*" ||
-	    name == "citefield" || name == "citetitle" || name == "cite*") {
-		// 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;
-	}
-
-	// InsetFloatlist
-	if (name == "floatlist") {
-		static const char * const paramnames[] = {"type", ""};
-		static const bool isoptional[] = {false};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
-	}
-
-	// InsetHfill
-	if (name == "hfill") {
-		static const char * const paramnames[] = {""};
-		static const CommandInfo info = {0, paramnames, 0};
-		return &info;
-	}
+	info_ = findInfo(code, cmdName);
+	BOOST_ASSERT(info_);
+	params_.resize(info_->n);
+}
 
-	// InsetInclude
-	if (name == "include" || name == "input" || name == "verbatiminput" ||
-	    name == "verbatiminput*") {
-		static const char * const paramnames[] = {"filename", ""};
-		static const bool isoptional[] = {false};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
-	}
 
-	// InsetIndex, InsetPrintIndex, InsetLabel
-	if (name == "index" || name == "printindex" || name == "label") {
-		static const char * const paramnames[] = {"name", ""};
-		static const bool isoptional[] = {false};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
+CommandInfo const * InsetCommandParams::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 HFILL_CODE:
+		return InsetHFill::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:
+		BOOST_ASSERT(false);
 	}
+	return 0;
+}
 
-	// InsetNomencl
-	if (name == "nomenclature") {
-		static const char * const paramnames[] = {"prefix", "symbol", "description", ""};
-		static const bool isoptional[] = {true, false, false};
-		static const CommandInfo info = {3, paramnames, isoptional};
-		return &info;
-	}
 
-	// InsetPrintNomencl
-	if (name == "printnomenclature") {
-		static const char * const paramnames[] = {"labelwidth", ""};
-		static const bool isoptional[] = {true};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
+string InsetCommandParams::getDefaultCmd(InsetCode 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 HFILL_CODE:
+			return InsetHFill::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:
+			BOOST_ASSERT(false);
 	}
+	return string(); //silence the warning
+}
 
-	// InsetRef
-	if (name == "eqref" || name == "pageref" || name == "vpageref" ||
-	    name == "vref" || name == "prettyref" || name == "ref") {
-		static const char * const paramnames[] =
-				{"name", "reference", ""};
-		static const bool isoptional[] = {true, false};
-		static const CommandInfo info = {2, paramnames, isoptional};
-		return &info;
-	}
 
-	// InsetTOC
-	if (name == "tableofcontents") {
-		static const char * const paramnames[] = {"type", ""};
-		static const bool isoptional[] = {false};
-		static const CommandInfo info = {1, paramnames, isoptional};
-		return &info;
-	}
-
-	// InsetUrl
-	if (name == "htmlurl" || name == "url") {
-		static const char * const paramnames[] =
-				{"name", "target", ""};
-		static const bool isoptional[] = {true, false};
-		static const CommandInfo info = {2, paramnames, isoptional};
-		return &info;
+bool InsetCommandParams::isCompatibleCommand(
+		InsetCode code, string const & s)
+{
+	switch (code) {
+		case BIBITEM_CODE: 
+			return InsetBibitem::isCompatibleCommand(s);
+		case BIBTEX_CODE:
+			return InsetBibtex::isCompatibleCommand(s);
+		case CITE_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_PRINT_CODE:
+			return InsetPrintIndex::isCompatibleCommand(s);
+		case LABEL_CODE:
+			return InsetLabel::isCompatibleCommand(s);
+		case NOMENCL_CODE:
+			return InsetNomencl::isCompatibleCommand(s);
+		case NOMENCL_PRINT_CODE:
+			return InsetPrintNomencl::isCompatibleCommand(s);
+		case REF_CODE:
+			return InsetRef::isCompatibleCommand(s);
+		case TOC_CODE:
+			return InsetTOC::isCompatibleCommand(s);
+		default:
+			BOOST_ASSERT(false);
 	}
-
-	return 0;
+	return false; //silence the warning
 }
 
 
 void InsetCommandParams::setCmdName(string const & name)
 {
-	name_ = name;
-	CommandInfo const * const info = findInfo(name);
-	BOOST_ASSERT(info);
+	if (!isCompatibleCommand(insetCode_, cmdName_)){
+		LYXERR0("InsetCommand: Incompatible command name " << 
+				name << ".");
+		throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
+		                       from_utf8("Incompatible command name."));
+	}
+
+	cmdName_ = name;
+	CommandInfo const * const info = findInfo(insetCode_, cmdName_);
+	if (!info) {
+		LYXERR0("Command '" << name << "' is not compatible with a '" <<
+			insetType() << "' inset.");
+		return;
+	}
 	ParamVector params(info->n);
 	// Overtake parameters with the same name
 	for (size_t i = 0; i < info_->n; ++i) {
@@ -181,102 +196,53 @@ void InsetCommandParams::setCmdName(string const & name)
 			params[j] = params_[i];
 	}
 	info_ = info;
-	std::swap(params, params_);
+	swap(params, params_);
 }
 
 
-void InsetCommandParams::scanCommand(string const & cmd)
+void InsetCommandParams::read(Lexer & lex)
 {
-	string tcmdname, toptions, tsecoptions, tcontents;
-
-	if (cmd.empty()) return;
-
-	enum { WS, CMDNAME, OPTION, SECOPTION, CONTENT } state = WS;
-
-	// Used to handle things like \command[foo[bar]]{foo{bar}}
-	int nestdepth = 0;
-
-	for (string::size_type i = 0; i < cmd.length(); ++i) {
-		char const c = cmd[i];
-		if ((state == CMDNAME && c == ' ') ||
-		    (state == CMDNAME && c == '[') ||
-		    (state == CMDNAME && c == '{')) {
-			state = WS;
-		}
-		if ((state == OPTION  && c == ']') ||
-		    (state == SECOPTION  && c == ']') ||
-		    (state == CONTENT && c == '}')) {
-			if (nestdepth == 0) {
-				state = WS;
-			} else {
-				--nestdepth;
-			}
-		}
-		if ((state == OPTION  && c == '[') ||
-		    (state == SECOPTION  && c == '[') ||
-		    (state == CONTENT && c == '{')) {
-			++nestdepth;
-		}
-		switch (state) {
-		case CMDNAME:	tcmdname += c; break;
-		case OPTION:	toptions += c; break;
-		case SECOPTION:	tsecoptions += c; break;
-		case CONTENT:	tcontents += c; break;
-		case WS: {
-			char const b = i? cmd[i-1]: 0;
-			if (c == '\\') {
-				state = CMDNAME;
-			} else if (c == '[' && b != ']') {
-				state = OPTION;
-				nestdepth = 0; // Just to be sure
-			} else if (c == '[' && b == ']') {
-				state = SECOPTION;
-				nestdepth = 0; // Just to be sure
-			} else if (c == '{') {
-				state = CONTENT;
-				nestdepth = 0; // Just to be sure
-			}
-			break;
-		}
+	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."));
 		}
 	}
 
-	// Don't mess with this.
-	if (!tcmdname.empty())  setCmdName(tcmdname);
-	if (!toptions.empty())  setOptions(toptions);
-	if (!tsecoptions.empty())  setSecOptions(tsecoptions);
-	if (!tcontents.empty()) setContents(tcontents);
-
-	LYXERR(Debug::PARSER) << "Command <" <<  cmd
-		<< "> == <" << to_utf8(getCommand())
-		<< "> == <" << getCmdName()
-		<< '|' << getContents()
-		<< '|' << getOptions()
-		<< '|' << getSecOptions() << '>' << endl;
-}
-
-
-void InsetCommandParams::read(LyXLex & lex)
-{
 	if (lex.isOK()) {
 		lex.next();
-		name_ = lex.getString();
-		info_ = findInfo(name_);
-		if (!info_) {
-			lex.printError("InsetCommand: Unknown inset name `$$Token'");
-			throw ExceptionMessage(WarningException,
-				_("Unknown inset name: "),
-				from_utf8(name_));
+		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();
+	if (!isCompatibleCommand(insetCode_, cmdName_)){
+		lex.printError("InsetCommand: Incompatible command name " + cmdName_ + ".");
+		throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
+		                       from_utf8("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()) {
 		lex.next();
 		token = lex.getString();
 		if (token == "\\end_inset")
 			break;
-		// FIXME Why is preview_ read but not written?
 		if (token == "preview") {
 			lex.next();
 			preview_ = lex.getBool();
@@ -287,9 +253,9 @@ void InsetCommandParams::read(LyXLex & lex)
 			lex.next(true);
 			params_[i] = lex.getDocString();
 		} else {
-			lex.printError("Unknown parameter name `$$Token' for command " + name_);
+			lex.printError("Unknown parameter name `$$Token' for command " + cmdName_);
 			throw ExceptionMessage(WarningException,
-				_("Inset Command: ") + from_ascii(name_),
+				_("Inset Command: ") + from_ascii(cmdName_),
 				_("Unknown parameter name: ") + from_utf8(token));
 		}
 	}
@@ -305,19 +271,22 @@ void InsetCommandParams::read(LyXLex & lex)
 
 void InsetCommandParams::write(ostream & os) const
 {
-	os << "LatexCommand " << name_ << '\n';
+	os << "CommandInset " << insetType() << '\n';
+	os << "LatexCommand " << cmdName_ << '\n';
+	if (preview_)
+		os << "preview true\n";
 	for (size_t i = 0; i < info_->n; ++i)
 		if (!params_[i].empty())
 			// FIXME UNICODE
 			os << info_->paramnames[i] << ' '
-			   << LyXLex::quoteString(to_utf8(params_[i]))
+			   << Lexer::quoteString(to_utf8(params_[i]))
 			   << '\n';
 }
 
 
 docstring const InsetCommandParams::getCommand() const
 {
-	docstring s = '\\' + from_ascii(name_);
+	docstring s = '\\' + from_ascii(cmdName_);
 	bool noparam = true;
 	for (size_t i = 0; i < info_->n; ++i) {
 		if (info_->optional[i]) {
@@ -351,82 +320,13 @@ docstring const InsetCommandParams::getCommand() const
 }
 
 
-std::string const InsetCommandParams::getOptions() const
-{
-	for (size_t i = 0; i < info_->n; ++i)
-		if (info_->optional[i])
-			return to_utf8(params_[i]);
-	lyxerr << "Programming error: get nonexisting option in "
-	       << name_ << " inset." << endl;; 
-	return string();
-}
-
-
-std::string const InsetCommandParams::getSecOptions() const
-{
-	bool first = true;
-	for (size_t i = 0; i < info_->n; ++i)
-		if (info_->optional[i]) {
-			if (first)
-				first = false;
-			else
-				return to_utf8(params_[i]);
-		}
-	// Happens in InsetCitation
-	lyxerr << "Programming error: get nonexisting second option in "
-	       << name_ << " inset." << endl;; 
-	return string();
-}
-
-
-std::string const InsetCommandParams::getContents() const
+docstring const InsetCommandParams::getFirstNonOptParam() const
 {
 	for (size_t i = 0; i < info_->n; ++i)
 		if (!info_->optional[i])
-			return to_utf8(params_[i]);
-	BOOST_ASSERT(false);
-	return string();
-}
-
-
-void InsetCommandParams::setOptions(std::string const & o)
-{
-	for (size_t i = 0; i < info_->n; ++i)
-		if (info_->optional[i]) {
-			params_[i] = from_utf8(o);
-			return;
-		}
-	lyxerr << "Programming error: set nonexisting option in "
-	       << name_ << " inset." << endl;; 
-}
-
-
-void InsetCommandParams::setSecOptions(std::string const & s)
-{
-	bool first = true;
-	for (size_t i = 0; i < info_->n; ++i)
-		if (info_->optional[i]) {
-			if (first)
-				first = false;
-			else {
-				params_[i] = from_utf8(s);
-				return;
-			}
-		}
-	// Happens in InsetCitation
-	lyxerr << "Programming error: set nonexisting second option in "
-	       << name_ << " inset." << endl;; 
-}
-
-
-void InsetCommandParams::setContents(std::string const & c)
-{
-	for (size_t i = 0; i < info_->n; ++i)
-		if (!info_->optional[i]) {
-			params_[i] = from_utf8(c);
-			return;
-		}
+			return params_[i];
 	BOOST_ASSERT(false);
+	return docstring();
 }
 
 
@@ -456,7 +356,8 @@ void InsetCommandParams::clear()
 bool operator==(InsetCommandParams const & o1,
 		InsetCommandParams const & o2)
 {
-	return o1.name_ == o2.name_ &&
+	return o1.insetCode_ == o2.insetCode_ &&
+	       o1.cmdName_ == o2.cmdName_ &&
 	       o1.info_ == o2.info_ &&
 	       o1.params_ == o2.params_ &&
 	       o1.preview_ == o2.preview_;