]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommandParams.cpp
Better TOC output for XHTML, per Rob and Pavel.
[lyx.git] / src / insets / InsetCommandParams.cpp
index caf6b72b9f0548120b6380fb694aecea6de735d2..bb4882874af1b0220dba13776023ab8e34f1250e 100644 (file)
 #include "InsetInclude.h"
 #include "InsetIndex.h"
 #include "InsetLabel.h"
+#include "InsetLine.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"
@@ -35,7 +40,7 @@
 #include "support/gettext.h"
 #include "support/lstrings.h"
 
-#include <boost/assert.hpp>
+#include "support/lassert.h"
 
 using namespace std;
 using namespace lyx::support;
@@ -55,7 +60,7 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
        case BIBTEX_CODE:
                return InsetBibtex::findInfo(cmdName);
        case CITE_CODE:
-               return InsetCitation::findInfo(cmdName);        
+               return InsetCitation::findInfo(cmdName);
        case FLOAT_LIST_CODE:
                return InsetFloatList::findInfo(cmdName);
        case HYPERLINK_CODE:
@@ -65,7 +70,9 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
        case INDEX_PRINT_CODE:
                return InsetPrintIndex::findInfo(cmdName);
        case LABEL_CODE:
-               return InsetLabel::findInfo(cmdName);   
+               return InsetLabel::findInfo(cmdName);
+       case LINE_CODE:
+               return InsetLine::findInfo(cmdName);
        case NOMENCL_CODE:
                return InsetNomencl::findInfo(cmdName);
        case NOMENCL_PRINT_CODE:
@@ -75,9 +82,9 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
        case TOC_CODE:
                return InsetTOC::findInfo(cmdName);
        default:
-               BOOST_ASSERT(false);
+               LASSERT(false, /**/);
        }
-       static const ParamInfo pi;
+       static ParamInfo pi;
        return pi; // to silence the warning
 }
 
@@ -88,8 +95,9 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
 //
 /////////////////////////////////////////////////////////////////////
 
-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)
 {}
 
 
@@ -101,7 +109,8 @@ bool ParamInfo::ParamData::isOptional() const
 
 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();
 }
 
 
@@ -117,9 +126,10 @@ bool ParamInfo::hasParam(std::string const & name) const
 }
 
 
-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)); 
 }
 
 
@@ -134,7 +144,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) {
@@ -193,6 +203,8 @@ string InsetCommandParams::getDefaultCmd(InsetCode code)
                        return InsetPrintIndex::defaultCommand();
                case LABEL_CODE:
                        return InsetLabel::defaultCommand();
+               case LINE_CODE:
+                       return InsetLine::defaultCommand();
                case NOMENCL_CODE:
                        return InsetNomencl::defaultCommand();
                case NOMENCL_PRINT_CODE:
@@ -202,7 +214,7 @@ string InsetCommandParams::getDefaultCmd(InsetCode code)
                case TOC_CODE:
                        return InsetTOC::defaultCommand();
                default:
-                       BOOST_ASSERT(false);
+                       LASSERT(false, /**/);
        }
        return string(); // silence the warning
 }
@@ -227,6 +239,8 @@ bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
                        return InsetPrintIndex::isCompatibleCommand(s);
                case LABEL_CODE:
                        return InsetLabel::isCompatibleCommand(s);
+               case LINE_CODE:
+                       return InsetLine::isCompatibleCommand(s);
                case NOMENCL_CODE:
                        return InsetNomencl::isCompatibleCommand(s);
                case NOMENCL_PRINT_CODE:
@@ -236,7 +250,7 @@ bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
                case TOC_CODE:
                        return InsetTOC::isCompatibleCommand(s);
                default:
-                       BOOST_ASSERT(false);
+                       LASSERT(false, /**/);
        }
        return false; // silence the warning
 }
@@ -244,7 +258,7 @@ bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
 
 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: "),
@@ -295,8 +309,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));
        }
 }
 
@@ -324,8 +338,9 @@ void InsetCommandParams::write(ostream & os) const
 
 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) {
@@ -350,7 +365,59 @@ bool InsetCommandParams::writeEmptyOptional(ParamInfo::const_iterator ci) const
 }
 
 
-docstring InsetCommandParams::getCommand() const
+docstring InsetCommandParams::prepareCommand(OutputParams const & runparams,
+                                            docstring const & command,
+                                            ParamInfo::ParamHandling handling) const
+{
+       docstring result;
+       switch (handling) {
+       case ParamInfo::HANDLING_LATEXIFY: {
+               docstring uncodable;
+               for (size_t n = 0; n < command.size(); ++n) {
+                       try {
+                               char_type const c = command[n];
+                               docstring const latex = runparams.encoding->latexChar(c);
+                               result += latex;
+                               if (latex.length() > 1 && latex[latex.length() - 1] != '}') {
+                                       // Prevent eating of a following
+                                       // space or command corruption by
+                                       // following characters
+                                       result +=  "{}";
+                               }
+                       } 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));
+               }
+               break;
+       } 
+       case ParamInfo::HANDLING_ESCAPE:
+               result = escape(command);
+               break;
+       case ParamInfo::HANDLING_NONE:
+               result = command;
+               break;
+       } // switch
+
+       return result;
+}
+
+
+docstring InsetCommandParams::getCommand(OutputParams const & runparams) const
 {
        docstring s = '\\' + from_ascii(cmdName_);
        bool noparam = true;
@@ -363,13 +430,15 @@ docstring InsetCommandParams::getCommand() const
                        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_OPTIONAL: {
-                       docstring const & data = (*this)[name];
+                       docstring const data =
+                               prepareCommand(runparams, (*this)[name], it->handling());
                        if (!data.empty()) {
                                s += '[' + data + ']';
                                noparam = false;
@@ -394,8 +463,9 @@ 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()];
 }
 
@@ -403,7 +473,7 @@ docstring 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;
@@ -413,7 +483,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];
 }