]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommandParams.cpp
Fix commented out code
[lyx.git] / src / insets / InsetCommandParams.cpp
index 79e3bd795b826f939a9a114af25da8dc42b96546..1f7d32110810fe3e18ed6aee8680e75c4dac11d0 100644 (file)
@@ -20,6 +20,7 @@
 #include "InsetBibitem.h"
 #include "InsetBibtex.h"
 #include "InsetCitation.h"
+#include "InsetCounter.h"
 #include "InsetFloatList.h"
 #include "InsetHyperlink.h"
 #include "InsetInclude.h"
@@ -63,6 +64,8 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
                return InsetBibtex::findInfo(cmdName);
        case CITE_CODE:
                return InsetCitation::findInfo(cmdName);
+       case COUNTER_CODE:
+               return InsetCounter::findInfo(cmdName);
        case FLOAT_LIST_CODE:
                return InsetFloatList::findInfo(cmdName);
        case HYPERLINK_CODE:
@@ -99,8 +102,10 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
 /////////////////////////////////////////////////////////////////////
 
 ParamInfo::ParamData::ParamData(std::string const & s, ParamType t,
-                               ParamHandling h)
-       : name_(s), type_(t), handling_(h)
+                                ParamHandling h, bool ignore,
+                                docstring default_value)
+       : name_(s), type_(t), handling_(h), ignore_(ignore),
+         default_value_(default_value)
 {}
 
 
@@ -130,9 +135,10 @@ bool ParamInfo::hasParam(std::string const & name) const
 
 
 void ParamInfo::add(std::string const & name, ParamType type,
-                   ParamHandling handling)
-{ 
-       info_.push_back(ParamData(name, type, handling)); 
+                    ParamHandling handling, bool ignoreval,
+                    docstring default_value)
+{
+       info_.push_back(ParamData(name, type, handling, ignoreval, default_value));
 }
 
 
@@ -144,7 +150,7 @@ bool ParamInfo::operator==(ParamInfo const & rhs) const
 }
 
 
-ParamInfo::ParamData const & 
+ParamInfo::ParamData const &
        ParamInfo::operator[](std::string const & name) const
 {
        const_iterator it = begin();
@@ -192,12 +198,14 @@ std::string InsetCommandParams::insetType() const
 string InsetCommandParams::getDefaultCmd(InsetCode code)
 {
        switch (code) {
-               case BIBITEM_CODE: 
+               case BIBITEM_CODE:
                        return InsetBibitem::defaultCommand();
                case BIBTEX_CODE:
                        return InsetBibtex::defaultCommand();
                case CITE_CODE:
                        return InsetCitation::defaultCommand();
+               case COUNTER_CODE:
+                       return InsetCounter::defaultCommand();
                case FLOAT_LIST_CODE:
                        return InsetFloatList::defaultCommand();
                case HYPERLINK_CODE:
@@ -229,12 +237,14 @@ string InsetCommandParams::getDefaultCmd(InsetCode code)
 bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
 {
        switch (code) {
-               case BIBITEM_CODE: 
+               case BIBITEM_CODE:
                        return InsetBibitem::isCompatibleCommand(s);
                case BIBTEX_CODE:
                        return InsetBibtex::isCompatibleCommand(s);
                case CITE_CODE:
                        return InsetCitation::isCompatibleCommand(s);
+               case COUNTER_CODE:
+                       return InsetCounter::isCompatibleCommand(s);
                case FLOAT_LIST_CODE:
                        return InsetFloatList::isCompatibleCommand(s);
                case HYPERLINK_CODE:
@@ -266,7 +276,7 @@ bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
 void InsetCommandParams::setCmdName(string const & name)
 {
        if (!isCompatibleCommand(insetCode_, name)) {
-               LYXERR0("InsetCommand: Incompatible command name " << 
+               LYXERR0("InsetCommand: Incompatible command name " <<
                                name << ".");
                throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
                                       _("Incompatible command name."));
@@ -279,7 +289,7 @@ void InsetCommandParams::setCmdName(string const & name)
 
 void InsetCommandParams::read(Lexer & lex)
 {
-       Read(lex, 0);
+       Read(lex, nullptr);
 }
 
 
@@ -296,7 +306,12 @@ void InsetCommandParams::Read(Lexer & lex, Buffer const * buffer)
        }
 
        info_ = findInfo(insetCode_, cmdName_);
-       
+
+       for (ParamInfo::ParamData const & param : info_)
+               if (param.ignore()) {
+                       params_[param.name()] = param.defaultValue();
+               }
+
        string token;
        while (lex.isOK()) {
                lex.next();
@@ -348,7 +363,7 @@ void InsetCommandParams::Read(Lexer & lex, Buffer const * buffer)
 
 void InsetCommandParams::write(ostream & os) const
 {
-       Write(os, 0);
+       Write(os, nullptr);
 }
 
 
@@ -361,6 +376,8 @@ void InsetCommandParams::Write(ostream & os, Buffer const * buffer) const
        ParamInfo::const_iterator it  = info_.begin();
        ParamInfo::const_iterator end = info_.end();
        for (; it != end; ++it) {
+               if (it->ignore())
+                       continue;
                string const & name = it->name();
                string data = to_utf8((*this)[name]);
                if (!data.empty()) {
@@ -423,30 +440,118 @@ docstring InsetCommandParams::prepareCommand(OutputParams const & runparams,
                                             ParamInfo::ParamHandling handling) const
 {
        docstring result;
-       switch (handling) {
-       case ParamInfo::HANDLING_LATEXIFY: {
+       bool ltrimmed = false;
+       // Trimming can be done on top of any of the other handlings
+       // We check this here since handling might be changed below.
+       if (handling & ParamInfo::HANDLING_LTRIM) {
+               // this is used if no other handling is done
+               result = command;
+               ltrimmed = true;
+       }
+       if (handling & ParamInfo::HANDLING_LATEXIFY
+           || handling & ParamInfo::HANDLING_INDEX_ESCAPE)
+               if ((*this)["literal"] == "true")
+                       handling = ParamInfo::HANDLING_NONE;
+
+       // LATEXIFY, ESCAPE and NONE are mutually exclusive
+       if (handling & ParamInfo::HANDLING_LATEXIFY) {
+               // First handle backslash
+               result = subst(command, from_ascii("\\"), from_ascii("\\textbackslash{}"));
+               // Then get LaTeX macros
                pair<docstring, docstring> command_latexed =
-                       runparams.encoding->latexString(command, runparams.dryrun);
+                       runparams.encoding->latexString(result, runparams.dryrun);
                result = command_latexed.first;
                if (!command_latexed.second.empty()) {
-                       // issue a warning about omitted characters
+                       // 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()), command_latexed.second));
                }
-               break;
+               // Now escape special commands
+               static docstring const backslash = from_ascii("\\");
+               int const nchars_escape = 8;
+               static char_type const chars_escape[nchars_escape] = {
+                       '&', '_', '$', '%', '#', '^', '{', '}'};
+
+               if (!result.empty()) {
+                       int previous;
+                       // The characters in chars_name[] need to be changed to a command when
+                       // they are LaTeXified.
+                       for (int k = 0; k < nchars_escape; k++)
+                               for (size_t i = 0, pos;
+                                       (pos = result.find(chars_escape[k], i)) != string::npos;
+                                       i = pos + 2) {
+                                               //(Only) \\^ needs to be terminated
+                                               docstring const term = (k == 5) ? from_ascii("{}") : docstring();
+                                               if (pos == 0)
+                                                       previous = 0;
+                                               else
+                                                       previous = pos - 1;
+                                               // only if not already escaped
+                                               if (result[previous] != '\\')
+                                                       result.replace(pos, 1, backslash + chars_escape[k] + term);
+                               }
+               }
        }
-       case ParamInfo::HANDLING_ESCAPE:
+       else if (handling & ParamInfo::HANDLING_ESCAPE)
                result = escape(command);
-               break;
-       case ParamInfo::HANDLING_NONE:
-               result = command;
-               break;
-       } // switch
+       else if (handling & ParamInfo::HANDLING_NONE) {
+               // we can only output characters covered by the current
+               // encoding!
+               docstring uncodable;
+               for (size_type i = 0 ; i < command.size() ; ++i) {
+                       char_type c = command[i];
+                       try {
+                               if (runparams.encoding->encodable(c))
+                                       result += c;
+                               else if (runparams.dryrun) {
+                                       result += "<" + _("LyX Warning: ")
+                                          + _("uncodable character") + " '";
+                                       result += docstring(1, c);
+                                       result += "'>";
+                               } else
+                                       uncodable += c;
+                       } catch (EncodingException & /* e */) {
+                               if (runparams.dryrun) {
+                                       result += "<" + _("LyX Warning: ")
+                                          + _("uncodable character") + " '";
+                                       result += docstring(1, c);
+                                       result += "'>";
+                               } else
+                                       uncodable += c;
+                       }
+               }
+               if (!uncodable.empty() && !runparams.silent) {
+                       // issue a warning about omitted characters
+                       // FIXME: should be passed to the error dialog
+                       frontend::Alert::warning(_("Uncodable characters in inset"),
+                               bformat(_("The following characters in one of the insets are\n"
+                                         "not representable in the current encoding and have been omitted: %1$s.\n"
+                                         "Unchecking 'Literal' in the respective inset dialog might help."),
+                               uncodable));
+               }
+       }
+       // INDEX_ESCAPE is independent of the others
+       if (handling & ParamInfo::HANDLING_INDEX_ESCAPE) {
+               // Now escape special commands
+               static docstring const quote = from_ascii("\"");
+               int const nchars_escape = 4;
+               static char_type const chars_escape[nchars_escape] = { '"', '@', '|', '!' };
+
+               if (!result.empty()) {
+                       // The characters in chars_name[] need to be changed to a command when
+                       // they are LaTeXified.
+                       for (int k = 0; k < nchars_escape; k++)
+                               for (size_t i = 0, pos;
+                                       (pos = result.find(chars_escape[k], i)) != string::npos;
+                                       i = pos + 2)
+                                               result.replace(pos, 1, quote + chars_escape[k]);
+               }
+       }
 
-       return result;
+       return ltrimmed ? ltrim(result) : result;
 }
 
 
@@ -470,17 +575,17 @@ docstring InsetCommandParams::getCommand(OutputParams const & runparams) const
                        break;
                }
                case ParamInfo::LATEX_OPTIONAL: {
-                       docstring const data =
+                       docstring data =
                                prepareCommand(runparams, (*this)[name], it->handling());
                        if (!data.empty()) {
-                               s += '[' + data + ']';
+                               s += '[' + protectArgument(data) + ']';
                                noparam = false;
                        } else if (writeEmptyOptional(it)) {
                                        s += "[]";
                                        noparam = false;
                        }
                        break;
-               } 
+               }
                } //end switch
        }
        if (noparam)
@@ -493,8 +598,8 @@ docstring InsetCommandParams::getCommand(OutputParams const & runparams) const
 
 docstring InsetCommandParams::getFirstNonOptParam() const
 {
-       ParamInfo::const_iterator it = 
-               find_if(info_.begin(), info_.end(), 
+       ParamInfo::const_iterator it =
+               find_if(info_.begin(), info_.end(),
                        not1(mem_fun_ref(&ParamInfo::ParamData::isOptional)));
        LASSERT(it != info_.end(), return docstring());
        return (*this)[it->name()];
@@ -508,6 +613,9 @@ docstring const & InsetCommandParams::operator[](string const & name) const
        ParamMap::const_iterator data = params_.find(name);
        if (data == params_.end() || data->second.empty())
                return dummy;
+       ParamInfo::ParamData const & param = info_[name];
+       if (param.ignore())
+               return param.defaultValue();
        return data->second;
 }
 
@@ -516,6 +624,9 @@ docstring & InsetCommandParams::operator[](string const & name)
 {
        LATTEST(info_.hasParam(name));
        // this will add the name in release mode
+       ParamInfo::ParamData const & param = info_[name];
+       if (param.ignore())
+               params_[name] = param.defaultValue();
        return params_[name];
 }
 
@@ -523,6 +634,7 @@ docstring & InsetCommandParams::operator[](string const & name)
 void InsetCommandParams::clear()
 {
        params_.clear();
+       preview(false);
 }