]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetListingsParams.cpp
Merge branch 'master' into biblatex2
[lyx.git] / src / insets / InsetListingsParams.cpp
index 1204853f3d5356e7b22532885454b7fca290fcef..f37566138f86635502bf162ccba3290dc709a0b1 100644 (file)
 
 #include "InsetListingsParams.h"
 
-#include "support/gettext.h"
 #include "Length.h"
 #include "Lexer.h"
 
+#include "support/convert.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 #include "support/textutils.h"
-#include "support/convert.h"
-
-#include <boost/assert.hpp>
 
 #include <sstream>
 
@@ -37,8 +35,9 @@ enum param_type {
        TRUEFALSE, // accept 'true' or 'false'
        INTEGER, // accept an integer
        LENGTH,  // accept a latex length
+       SKIP,    // accept a skip or a length
        ONEOF,  // accept one of a few values
-       SUBSETOF, // accept a string composed of given characters
+       SUBSETOF // accept a string composed of given characters
 };
 
 
@@ -95,18 +94,27 @@ private:
 };
 
 
+char const * allowed_skips = "\\smallskipamount,\\medskipamount,\\bigskipamount";
+
+
 docstring ListingsParam::validate(string const & par) const
 {
        bool unclosed = false;
        string par2 = par;
        // braces are allowed
-       if (prefixIs(par, "{") && suffixIs(par, "}"))
+       if (prefixIs(par, "{") && suffixIs(par, "}") && !suffixIs(par, "\\}"))  
                par2 = par.substr(1, par.size() - 2);
-       else if (prefixIs(par, "{")) {
-               par2 = par.substr(1);
-               unclosed = true;
-       }
 
+       // check for unmatched braces
+       int braces = 0;
+       for (size_t i = 0; i < par2.size(); ++i) {
+               if (par2[i] == '{' && (i == 0 || par2[i-1] != '\\'))
+                       ++braces;
+               else if (par2[i] == '}' && (i == 0 || par2[i-1] != '\\'))
+                       --braces;
+       }
+       unclosed = braces != 0;
+       
        switch (type_) {
 
        case ALL:
@@ -117,7 +125,7 @@ docstring ListingsParam::validate(string const & par) const
                                return _("A value is expected.");
                }
                if (unclosed)
-                               return _("Unbalanced braces!");
+                       return _("Unbalanced braces!");
                return docstring();
 
        case TRUEFALSE:
@@ -159,6 +167,20 @@ docstring ListingsParam::validate(string const & par) const
                        return _("Unbalanced braces!");
                return docstring();
 
+       case SKIP:
+               if (par2.empty() && !onoff_) {
+                       if (!hint_.empty())
+                               return hint_;
+                       else
+                               return bformat(_("Please specify a LaTeX length expression or a skip amount (%1$s)"),
+                                              from_ascii(subst(allowed_skips, ",", ", ")));
+               }
+               if (!isValidLength(par2) && tokenPos(allowed_skips, ',', par2) == -1)
+                       return _("Not a valid LaTeX length expression or skip amount.");
+               if (unclosed)
+                       return _("Unbalanced braces!");
+               return docstring();
+
        case ONEOF: {
                if (par2.empty() && !onoff_) {
                        if (!hint_.empty())
@@ -201,6 +223,8 @@ docstring ListingsParam::validate(string const & par) const
                        return bformat(_("Try one of %1$s."), from_utf8(info_));
                else
                        return bformat(_("I guess you mean %1$s."), from_utf8(matching_names));
+               // this stifles a warning but upsets coverity
+               // coverity[UNREACHABLE]
                return docstring();
        }
        case SUBSETOF:
@@ -292,11 +316,11 @@ ParValidator::ParValidator()
        all_params_["floatplacement"] =
                ListingsParam("tbp", false, SUBSETOF, "tbp", empty_hint);
        all_params_["aboveskip"] =
-               ListingsParam("\\medskipamount", false, LENGTH, "", empty_hint);
+               ListingsParam("\\medskipamount", false, SKIP, "", empty_hint);
        all_params_["belowskip"] =
-               ListingsParam("\\medskipamount", false, LENGTH, "", empty_hint);
+               ListingsParam("\\medskipamount", false, SKIP, "", empty_hint);
        all_params_["lineskip"] =
-               ListingsParam("", false, LENGTH, "", empty_hint);
+               ListingsParam("", false, SKIP, "", empty_hint);
        all_params_["boxpos"] =
                ListingsParam("", false, SUBSETOF, "bct", empty_hint);
        all_params_["print"] =
@@ -419,9 +443,9 @@ ParValidator::ParValidator()
        all_params_["captionpos"] =
                ListingsParam("", false, SUBSETOF, "tb", empty_hint);
        all_params_["abovecaptionskip"] =
-               ListingsParam("", false, LENGTH, "", empty_hint);
+               ListingsParam("", false, SKIP, "", empty_hint);
        all_params_["belowcaptionskip"] =
-               ListingsParam("", false, LENGTH, "", empty_hint);
+               ListingsParam("", false, SKIP, "", empty_hint);
        all_params_["linewidth"] =
                ListingsParam("", false, LENGTH, "", empty_hint);
        all_params_["xleftmargin"] =
@@ -432,6 +456,8 @@ ParValidator::ParValidator()
                ListingsParam("", false, TRUEFALSE, "", empty_hint);
        all_params_["breaklines"] =
                ListingsParam("", false, TRUEFALSE, "", empty_hint);
+       all_params_["breakatwhitespace"] =
+               ListingsParam("", false, TRUEFALSE, "", empty_hint);
        all_params_["prebreak"] =
                ListingsParam("", false, ALL, "", empty_hint);
        all_params_["postbreak"] =
@@ -494,11 +520,9 @@ ParValidator::ParValidator()
                ListingsParam("", false, ALL, "", empty_hint);
        all_params_["escapeinside"] =
                ListingsParam("", false, ALL, "", empty_hint);
-       all_params_["escepeinside"] =
+       all_params_["escapebegin"] =
                ListingsParam("", false, ALL, "", empty_hint);
-       all_params_["escepebegin"] =
-               ListingsParam("", false, ALL, "", empty_hint);
-       all_params_["escepeend"] =
+       all_params_["escapeend"] =
                ListingsParam("", false, ALL, "", empty_hint);
        all_params_["fancyvrb"] =
                ListingsParam("", false, TRUEFALSE, "", empty_hint);
@@ -663,6 +687,8 @@ docstring ParValidator::validate(string const & name,
                        return bformat(_("Parameters starting with '%1$s': %2$s"),
                                                                from_utf8(name), from_utf8(matching_names));
        }
+       // this stifles a warning but upsets coverity
+       // coverity[UNREACHABLE]
        return docstring();
 }
 
@@ -710,7 +736,7 @@ void InsetListingsParams::write(ostream & os) const
 void InsetListingsParams::read(Lexer & lex)
 {
        lex >> inline_;
-       int s = Inset::Collapsed;
+       int s = InsetCollapsable::Collapsed;
        lex >> s;
        status_ = static_cast<InsetCollapsable::CollapseStatus>(s);
        string par;
@@ -722,11 +748,11 @@ void InsetListingsParams::read(Lexer & lex)
 string InsetListingsParams::params(string const & sep) const
 {
        string par;
-       for (map<string, string>::const_iterator it = params_.begin();
-               it != params_.end(); ++it) {
+       keyValuePair::const_iterator it = params_.begin();
+       for (; it != params_.end(); ++it) {
                if (!par.empty())
                        par += sep;
-               // key=value,key=value1 is stored in params_ as key=value,key_=value1. 
+               // key=value,key=value1 is stored in params_ as key=value,key_=value1.
                if (it->second.empty())
                        par += rtrim(it->first, "_");
                else
@@ -736,39 +762,62 @@ string InsetListingsParams::params(string const & sep) const
 }
 
 
-void InsetListingsParams::addParam(string const & key, string const & value)
+bool InsetListingsParams::hasParam(string const & key) const
+{
+       keyValuePair::const_iterator it = params_.begin();
+       for (; it != params_.end(); ++it) {
+               if (it->first == key)
+                       return true;
+       }
+       return false;
+}
+
+
+string InsetListingsParams::getValue(string const & key) const
+{
+       keyValuePair::const_iterator it = params_.begin();
+       for (; it != params_.end(); ++it) {
+               if (it->first == key)
+                       return it->second;
+       }
+       return string();
+}
+
+
+void InsetListingsParams::addParam(string const & key, 
+               string const & value, bool replace)
 {
        if (key.empty())
                return;
 
        // duplicate parameters!
        string keyname = key;
-       if (params_.find(key) != params_.end())
+       if (!replace && hasParam(key))
                // key=value,key=value1 is allowed in listings
                // use key_, key__, key___ etc to avoid name conflict
-               while (params_.find(keyname += '_') != params_.end()) { }
+               while (hasParam(keyname += '_')) { }
        // check onoff flag
        // onoff parameter with value false
        if (!par_validator)
-               par_validator = new ParValidator();
+               par_validator = new ParValidator;
        if (par_validator->onoff(key) && (value == "false" || value == "{false}"))
-               params_[keyname] = string();
+               params_.push_back(make_pair(keyname, string()));
        // if the parameter is surrounded with {}, good
        else if (prefixIs(value, "{") && suffixIs(value, "}"))
-               params_[keyname] = value;
+               params_.push_back(make_pair(keyname, value));
        // otherwise, check if {} is needed. Add {} to all values with
        // non-ascii/number characters, just to be safe
        else {
                bool has_special_char = false;
                for (size_t i = 0; i < value.size(); ++i)
-                       if (!isAlphaASCII(value[i]) && !isDigit(value[i])) {
+                       if (!isAlnumASCII(value[i])) {
                                has_special_char = true;
                                break;
                        }
                if (has_special_char)
-                       params_[keyname] = "{" + value + "}";
+                       params_.push_back(make_pair(keyname, "{" + value + "}"));
                else
-                       params_[keyname] = value;
+                       params_.push_back(make_pair(keyname, value));
        }
 }
 
@@ -796,11 +845,12 @@ void InsetListingsParams::addParams(string const & par)
                } else if (par[i] == '=' && braces == 0) {
                        isValue = true;
                        continue;
-               } else if (par[i] == '{' && par[i - 1] == '=')
-                       braces ++;
-               else if (par[i] == '}'
-                       && (i == par.size() - 1 || par[i + 1] == ',' || par[i + 1] == '\n'))
-                       braces --;
+               } else if (par[i] == '{' && i > 0 && par[i-1] != '\\')
+                       // don't count a brace in first position
+                       ++braces;
+               else if (par[i] == '}' && i != par.size() - 1 
+                        && (i == 0 || (i > 0 && par[i-1] != '\\')))
+                       --braces;
 
                if (isValue)
                        value += par[i];
@@ -856,15 +906,13 @@ void InsetListingsParams::fromEncodedString(string const & in)
 
 bool InsetListingsParams::isFloat() const
 {
-       return params_.find("float") != params_.end();
+       return hasParam("float");
 }
 
 
 string InsetListingsParams::getParamValue(string const & param) const
 {
-       // is this parameter defined?
-       map<string, string>::const_iterator it = params_.find(param);
-       string par = (it == params_.end()) ? string() : it->second;
+       string par = getValue(param);
        if (prefixIs(par, "{") && suffixIs(par, "}"))
                return par.substr(1, par.size() - 2);
        else
@@ -876,10 +924,12 @@ docstring InsetListingsParams::validate() const
 {
        docstring msg;
        if (!par_validator)
-               par_validator = new ParValidator();
-       for (map<string, string>::const_iterator it = params_.begin();
-               it != params_.end(); ++it) {
-               msg = par_validator->validate(it->first, it->second);
+               par_validator = new ParValidator;
+       // return msg for first key=value pair which is incomplete or has an error
+       keyValuePair::const_iterator it = params_.begin();
+       for (; it != params_.end(); ++it) {
+               // key trimmed
+               msg = par_validator->validate(rtrim(it->first, "_"), it->second);
                if (!msg.empty())
                        return msg;
        }