using std::string;
using std::exception;
-namespace lyx
-{
+namespace lyx {
using support::bformat;
using support::trim;
-using support::ltrim;
using support::rtrim;
using support::subst;
using support::isStrInt;
switch (type_) {
case ALL:
- if (par2.empty() && !onoff_ && hint_ != _("Bypass validation")) {
+ if (par2.empty() && !onoff_) {
if (!hint_.empty())
return hint_;
else
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
/// options copied from page 26 of listings manual
// FIXME: add default parameters ... (which is not used now)
-
- // special ListingsParam returned for parameters starting with @
- // which helps them bypass validation.
- all_params_["@"] =
- ListingsParam("", false, ALL, "", _("Bypass validation"));
-
all_params_["float"] =
ListingsParam("false", true, SUBSETOF, "*tbph", empty_hint);
all_params_["floatplacement"] =
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));
}
}
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));
}
- // do not validate keys starting with @
- if (name[0] == '@')
- return all_params_.find("@")->second;
-
// 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. "
- "Prefix this parameter with @ to bypass validation."),
- from_utf8(name)));
+ 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 = NULL;
+
InsetListingsParams::InsetListingsParams()
: inline_(false), params_(), status_(InsetCollapsable::Open)
{
}
-string InsetListingsParams::params(string const & sep, bool valid_key) const
+string InsetListingsParams::params(string const & sep) const
{
string par;
for (map<string, string>::const_iterator it = params_.begin();
if (!par.empty())
par += sep;
// key=value,key=value1 is stored in params_ as key=value,key_=value1.
- string key = rtrim(it->first, "_");
- // remove prefix @ which is used by a parameter to bypass validation
- if (valid_key)
- key = ltrim(key, "@");
if (it->second.empty())
- par += key;
+ par += rtrim(it->first, "_");
else
- par += key + '=' + it->second;
+ par += rtrim(it->first, "_") + '=' + it->second;
}
return par;
}
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())
while (params_.find(keyname += '_') != params_.end());
// check onoff flag
// onoff parameter with value false
- if (lparam.onoff_ && (value == "false" || value == "{false}"))
+ if (!par_validator)
+ par_validator = new ParValidator();
+ if (par_validator->onoff(key) && (value == "false" || value == "{false}"))
params_[keyname] = string();
// if the parameter is surrounded with {}, good
else if (prefixIs(value, "{") && suffixIs(value, "}"))
}
+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);
+ if (!msg.empty())
+ return msg;
+ }
+ return msg;
+}
+
} // namespace lyx