X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetListingsParams.cpp;h=f37566138f86635502bf162ccba3290dc709a0b1;hb=239b9919ffe28338d789e6dc9122228f77ab77a7;hp=e4e674821964658d1eb3d5a2f59ddba3c383c7b4;hpb=276f6fcde5e31b0dbf5eae9799a2f695079c6bd4;p=lyx.git diff --git a/src/insets/InsetListingsParams.cpp b/src/insets/InsetListingsParams.cpp index e4e6748219..f37566138f 100644 --- a/src/insets/InsetListingsParams.cpp +++ b/src/insets/InsetListingsParams.cpp @@ -9,39 +9,24 @@ */ #include +#include #include "InsetListingsParams.h" -#include "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 #include -using std::map; -using std::vector; -using std::ostream; -using std::string; -using std::exception; +using namespace std; +using namespace lyx::support; -namespace lyx -{ - -using support::bformat; -using support::trim; -using support::rtrim; -using support::subst; -using support::isStrInt; -using support::prefixIs; -using support::suffixIs; -using support::getVectorFromString; -using lyx::support::contains; +namespace lyx { namespace { @@ -50,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 }; @@ -108,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: @@ -130,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: @@ -172,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()) @@ -194,7 +203,7 @@ docstring ListingsParam::validate(string const & par) const lists.push_back(v); // good, find the string - if (std::find(lists.begin(), lists.end(), par2) != lists.end()) { + if (find(lists.begin(), lists.end(), par2) != lists.end()) { if (unclosed) return _("Unbalanced braces!"); return docstring(); @@ -214,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: @@ -232,6 +243,7 @@ docstring ListingsParam::validate(string const & par) const return _("Unbalanced braces!"); return docstring(); } + return docstring(); } @@ -245,7 +257,7 @@ char const * allowed_languages = "[Sharp]C\nC++\n[ANSI]C++\n[GNU]C++\n[ISO]C++\n[Visual]C++\nCaml\n" "[light]Caml\n[Objective]Caml\nClean\nCobol\n[1974]Cobol\n[1985]Cobol\n" "[ibm]Cobol\nComal 80\ncommand.com\n[WinXP]command.com\nComsol\ncsh\n" - "Delphi\nEiffel\nElan\nEuphoria\nFortran\n[77]Fortran\n[90]Fortran\n" + "Delphi\nEiffel\nElan\nerlang\nEuphoria\nFortran\n[77]Fortran\n[90]Fortran\n" "[95]Fortran\nGCL\nGnuplot\nHaskell\nHTML\nIDL\n[CORBA]IDL\ninform\n" "Java\n[AspectJ]Java\nJVMIS\nksh\nLingo\nLisp\n[Auto]Lisp\nLogo\n" "make\n[gnu]make\nMathematica\n[1.0]Mathematica\n[3.0]Mathematica\n" @@ -270,15 +282,13 @@ class ParValidator public: ParValidator(); - /// \return the associated \c ListingsParam. - /// \warning an \c invalidParamexception will be thrown - /// if the key is not found. - ListingsParam const & param(string const & key) const; + /// validate a parameter for a given name. + /// return an error message if \c par is an invalid parameter. + docstring validate(string const & name, string const & par) const; - /// validate a parameter for a given key. - /// \warning an \c invalidParam exception will be thrown if - /// \c par is an invalid parameter. - ListingsParam const & validate(string const & key, string const & par) const; + /// return the onoff status of a parameter \c key, if \c key is not found + /// return false + bool onoff(string const & key) const; private: /// key is the name of the parameter @@ -306,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"] = @@ -319,6 +329,8 @@ ParValidator::ParValidator() ListingsParam("", false, INTEGER, "", empty_hint); all_params_["lastline"] = ListingsParam("", false, INTEGER, "", empty_hint); + all_params_["linerange"] = + ListingsParam("", false, ALL, "", empty_hint); all_params_["showlines"] = ListingsParam("", false, TRUEFALSE, "", empty_hint); all_params_["emptylines"] = @@ -431,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"] = @@ -444,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"] = @@ -506,11 +520,9 @@ ParValidator::ParValidator() ListingsParam("", false, ALL, "", empty_hint); all_params_["escapeinside"] = ListingsParam("", false, ALL, "", empty_hint); - all_params_["escepeinside"] = - ListingsParam("", false, ALL, "", empty_hint); - all_params_["escepebegin"] = + all_params_["escapebegin"] = ListingsParam("", false, ALL, "", empty_hint); - all_params_["escepeend"] = + all_params_["escapeend"] = ListingsParam("", false, ALL, "", empty_hint); all_params_["fancyvrb"] = ListingsParam("", false, TRUEFALSE, "", empty_hint); @@ -578,24 +590,55 @@ ParValidator::ParValidator() ListingsParam("", false, ALL, "", empty_hint); all_params_["podcomment"] = ListingsParam("", false, ALL, "", empty_hint); + // the following are experimental listings features + all_params_["procnamekeys"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["moreprocnamekeys"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["deleteprocnamekeys"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["procnamestyle"] = + ListingsParam("", false, ALL, "", style_hint); + all_params_["indexprocnames"] = + ListingsParam("", false, TRUEFALSE, "", empty_hint); + all_params_["hyperref"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["morehyperref"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["deletehyperref"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["hyperanchor"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["hyperlink"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["literate"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["lgrindef"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["rangebeginprefix"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["rangebeginsuffix"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["rangeendprefix"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["rangeendsuffix"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["rangeprefix"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["rangesuffix"] = + ListingsParam("", false, ALL, "", empty_hint); + all_params_["includerangemarker"] = + ListingsParam("", false, TRUEFALSE, "", empty_hint); + all_params_["multicols"] = + ListingsParam("", false, INTEGER, "", empty_hint); } -ListingsParam const & ParValidator::validate(string const & key, +docstring ParValidator::validate(string const & name, string const & par) const -{ - ListingsParam const & lparam = param(key); - docstring s = lparam.validate(par); - if (!s.empty()) - throw invalidParam(bformat(_("Parameter %1$s: "), from_utf8(key)) + s); - return lparam; -} - - -ListingsParam const & ParValidator::param(string const & name) const { if (name.empty()) - throw invalidParam(_("Invalid (empty) listing parameter name.")); + return _("Invalid (empty) listing parameter name."); if (name[0] == '?') { string suffix = trim(string(name, 1)); @@ -610,39 +653,61 @@ ListingsParam const & ParValidator::param(string const & name) const } } if (suffix.empty()) - throw invalidParam(bformat( - _("Available listing parameters are %1$s"), from_ascii(param_names))); + return bformat( + _("Available listing parameters are %1$s"), from_ascii(param_names)); else - throw invalidParam(bformat( + return bformat( _("Available listings parameters containing string \"%1$s\" are %2$s"), - from_utf8(suffix), from_utf8(param_names))); + from_utf8(suffix), from_utf8(param_names)); } // locate name in parameter table ListingsParams::const_iterator it = all_params_.find(name); - if (it != all_params_.end()) - return it->second; - - // otherwise, produce a meaningful error message. - string matching_names; - ListingsParams::const_iterator end = all_params_.end(); - for (it = all_params_.begin(); it != end; ++it) { - if (prefixIs(it->first, name)) { - if (!matching_names.empty()) - matching_names += ", "; - matching_names += it->first; + if (it != all_params_.end()) { + docstring msg = it->second.validate(par); + if (msg.empty()) + return msg; + else + return bformat(_("Parameter %1$s: "), from_utf8(name)) + msg; + } else { + // otherwise, produce a meaningful error message. + string matching_names; + ListingsParams::const_iterator end = all_params_.end(); + for (it = all_params_.begin(); it != end; ++it) { + if (prefixIs(it->first, name)) { + if (!matching_names.empty()) + matching_names += ", "; + matching_names += it->first; + } } + if (matching_names.empty()) + return bformat(_("Unknown listing parameter name: %1$s"), + from_utf8(name)); + else + return bformat(_("Parameters starting with '%1$s': %2$s"), + from_utf8(name), from_utf8(matching_names)); } - if (matching_names.empty()) - throw invalidParam(bformat(_("Unknown listing parameter name: %1$s"), - from_utf8(name))); + // this stifles a warning but upsets coverity + // coverity[UNREACHABLE] + return docstring(); +} + + +bool ParValidator::onoff(string const & name) const +{ + // locate name in parameter table + ListingsParams::const_iterator it = all_params_.find(name); + if (it != all_params_.end()) + return it->second.onoff_; else - throw invalidParam(bformat(_("Parameters starting with '%1$s': %2$s"), - from_utf8(name), from_utf8(matching_names))); + return false; } } // namespace anon. +// define a global ParValidator +ParValidator * par_validator = 0; + InsetListingsParams::InsetListingsParams() : inline_(false), params_(), status_(InsetCollapsable::Open) { @@ -671,10 +736,9 @@ void InsetListingsParams::write(ostream & os) const void InsetListingsParams::read(Lexer & lex) { lex >> inline_; - int s; + int s = InsetCollapsable::Collapsed; lex >> s; - if (lex) - status_ = static_cast(s); + status_ = static_cast(s); string par; lex >> par; fromEncodedString(par); @@ -684,11 +748,11 @@ void InsetListingsParams::read(Lexer & lex) string InsetListingsParams::params(string const & sep) const { string par; - for (map::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 @@ -698,41 +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; - static ParValidator par_validator; - - // exception may be thown. - ListingsParam const & lparam = par_validator.validate(key, value); // 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 (lparam.onoff_ && (value == "false" || value == "{false}")) - params_[keyname] = string(); + if (!par_validator) + par_validator = new ParValidator; + if (par_validator->onoff(key) && (value == "false" || value == "{false}")) + 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)); } } @@ -760,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]; @@ -820,16 +906,34 @@ 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::const_iterator it = params_.find(param); - return (it == params_.end()) ? string() : it->second; + string par = getValue(param); + if (prefixIs(par, "{") && suffixIs(par, "}")) + return par.substr(1, par.size() - 2); + else + return par; } +docstring InsetListingsParams::validate() const +{ + docstring msg; + if (!par_validator) + 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; + } + return msg; +} + } // namespace lyx