]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommandParams.cpp
InsetBox.cpp: only shaded boxes can have multiple paragraphs when there is no inner box
[lyx.git] / src / insets / InsetCommandParams.cpp
index b803e188240c1fa1fa8aa38d9603e1828720ab66..a0cbd6e785be498fdc71b2ec85d1d54b55fc3245 100644 (file)
 #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"
@@ -35,7 +39,7 @@
 #include "support/gettext.h"
 #include "support/lstrings.h"
 
-#include <boost/assert.hpp>
+#include "support/lassert.h"
 
 using namespace std;
 using namespace lyx::support;
@@ -43,34 +47,67 @@ using namespace lyx::support;
 
 namespace lyx {
 
+/// 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)
-       : name_(s), type_(t)
+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
-           || type_ == ParamInfo::LATEX_KV_OPTIONAL;
-}
-
-
-bool ParamInfo::ParamData::isKeyValArg() const
-{
-       return type_ == ParamInfo::LATEX_KV_REQUIRED 
-           || type_ == ParamInfo::LATEX_KV_OPTIONAL;
+       return type_ == ParamInfo::LATEX_OPTIONAL;
 }
 
 
 bool ParamInfo::ParamData::operator==(ParamInfo::ParamData const & rhs) const
 {
-       return name() == rhs.name() && type() == rhs.type();
+       return name() == rhs.name() && type() == rhs.type()
+               && handling() == rhs.handling();
 }
 
 
@@ -80,15 +117,16 @@ bool ParamInfo::hasParam(std::string const & name) const
        const_iterator last = end();
        for (; it != last; ++it) {
                if (it->name() == name)
-                       return !it->isKeyValArg();
+                       return true;
        }
        return false;
 }
 
 
-void ParamInfo::add(std::string const & name, ParamType type)
+void ParamInfo::add(std::string const & name, ParamType type,
+                   ParamHandling handling)
 { 
-       info_.push_back(ParamData(name, type)); 
+       info_.push_back(ParamData(name, type, handling)); 
 }
 
 
@@ -103,7 +141,7 @@ bool ParamInfo::operator==(ParamInfo const & rhs) const
 ParamInfo::ParamData const & 
        ParamInfo::operator[](std::string const & name) const
 {
-       BOOST_ASSERT(hasParam(name));
+       LASSERT(hasParam(name), /**/);
        const_iterator it = begin();
        const_iterator last = end();
        for (; it != last; ++it) {
@@ -137,49 +175,14 @@ InsetCommandParams::InsetCommandParams(InsetCode code,
 }
 
 
-ParamInfo 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 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);
-       }
-       static const ParamInfo pi;
-       return pi; // to silence the warning
-}
-
-
 std::string InsetCommandParams::insetType() const
 {
        return insetName(insetCode_);
 }
 
 
-string InsetCommandParams::getDefaultCmd(InsetCode code) {
+string InsetCommandParams::getDefaultCmd(InsetCode code)
+{
        switch (code) {
                case BIBITEM_CODE: 
                        return InsetBibitem::defaultCommand();
@@ -206,14 +209,13 @@ string InsetCommandParams::getDefaultCmd(InsetCode code) {
                case TOC_CODE:
                        return InsetTOC::defaultCommand();
                default:
-                       BOOST_ASSERT(false);
+                       LASSERT(false, /**/);
        }
        return string(); // silence the warning
 }
 
 
-bool InsetCommandParams::isCompatibleCommand(
-               InsetCode code, string const & s)
+bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
 {
        switch (code) {
                case BIBITEM_CODE: 
@@ -241,7 +243,7 @@ bool InsetCommandParams::isCompatibleCommand(
                case TOC_CODE:
                        return InsetTOC::isCompatibleCommand(s);
                default:
-                       BOOST_ASSERT(false);
+                       LASSERT(false, /**/);
        }
        return false; // silence the warning
 }
@@ -249,7 +251,7 @@ bool InsetCommandParams::isCompatibleCommand(
 
 void InsetCommandParams::setCmdName(string const & name)
 {
-       if (!isCompatibleCommand(insetCode_, cmdName_)){
+       if (!isCompatibleCommand(insetCode_, name)) {
                LYXERR0("InsetCommand: Incompatible command name " << 
                                name << ".");
                throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
@@ -263,30 +265,12 @@ void InsetCommandParams::setCmdName(string const & name)
 
 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("InsetCommandParams: Attempt to change type of inset.");
-                       throw ExceptionMessage(WarningException, _("InsetCommandParams Error: "),
-                                        _("Attempt to change type of parameters."));
-               }
-       }
-
-       if (lex.isOK()) {
-               lex.next();
-               string const test = lex.getString();
-               if (test != "LatexCommand") {
-                       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("InsetCommandParams: Incompatible command name " + cmdName_ + ".");
+       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."));
        }
@@ -318,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));
        }
 }
 
@@ -345,43 +329,19 @@ void InsetCommandParams::write(ostream & os) const
 }
 
 
-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);
+       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::LATEX_KEY:
                case ParamInfo::LYX_INTERNAL:
                        break;
 
                case ParamInfo::LATEX_REQUIRED:
-               case ParamInfo::LATEX_KV_REQUIRED:
                        return false;
 
                case ParamInfo::LATEX_OPTIONAL: {
@@ -392,19 +352,52 @@ bool InsetCommandParams::writeEmptyOptional(ParamInfo::const_iterator ci) const
                        break;
                }
 
-               case ParamInfo::LATEX_KV_OPTIONAL: {
-                       docstring data = makeKeyValArgument();
-                       if (!data.empty())
-                               return true;
-                       break;
-               }
                } //end switch
        }
        return false;
 }
 
 
-docstring const InsetCommandParams::getCommand() const
+
+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;
@@ -413,23 +406,19 @@ docstring const InsetCommandParams::getCommand() const
        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];
+                       docstring const & data =
+                               prepareCommand(runparams, (*this)[name], it->handling());
                        s += '{' + data + '}';
                        noparam = false;
                        break;
                }
-               case ParamInfo::LATEX_KV_REQUIRED: {
-                       s += "{" + makeKeyValArgument() + "}";
-                       noparam = false;
-                       break;
-               }
                case ParamInfo::LATEX_OPTIONAL: {
-                       docstring const & data = (*this)[name];
+                       docstring const & data =
+                               prepareCommand(runparams, (*this)[name], it->handling());
                        if (!data.empty()) {
                                s += '[' + data + ']';
                                noparam = false;
@@ -439,17 +428,6 @@ docstring const InsetCommandParams::getCommand() const
                        }
                        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)
@@ -460,13 +438,14 @@ docstring const InsetCommandParams::getCommand() const
 }
 
 
-docstring const InsetCommandParams::getFirstNonOptParam() const
+docstring InsetCommandParams::getFirstNonOptParam() const
 {
        ParamInfo::const_iterator it = 
                find_if(info_.begin(), info_.end(), 
                        not1(mem_fun_ref(&ParamInfo::ParamData::isOptional)));
-       if (it == info_.end())
-               BOOST_ASSERT(false);
+       if (it == info_.end()) {
+               LASSERT(false, return docstring());
+       }
        return (*this)[it->name()];
 }
 
@@ -474,7 +453,7 @@ docstring const InsetCommandParams::getFirstNonOptParam() const
 docstring const & InsetCommandParams::operator[](string const & name) const
 {
        static const docstring dummy; //so we don't return a ref to temporary
-       BOOST_ASSERT(info_.hasParam(name));
+       LASSERT(info_.hasParam(name), return dummy);
        ParamMap::const_iterator data = params_.find(name);
        if (data == params_.end() || data->second.empty())
                return dummy;
@@ -484,7 +463,7 @@ docstring const & InsetCommandParams::operator[](string const & name) const
 
 docstring & InsetCommandParams::operator[](string const & name)
 {
-       BOOST_ASSERT(info_.hasParam(name));
+       LASSERT(info_.hasParam(name), /**/);
        return params_[name];
 }
 
@@ -495,19 +474,17 @@ void InsetCommandParams::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);
 }