The validation mechanism of InsetListingsParams is great but is not
flexible to handle unrecognized parameters introduced, e.g., by a new
version of the listings.
The attached patch allows users to input arbitrary parameters by
prefixing it with a '@' sign. @ will be removed in latex output, but
reserved in lyx files.
Please test.
Bo
Index: src/insets/InsetListingsParams.h
===================================================================
--- src/insets/InsetListingsParams.h (revision 18709)
+++ src/insets/InsetListingsParams.h (working copy)
@@ -35,7 +35,9 @@
void read(Lexer &);
/// valid parameter string
- std::string params(std::string const & sep=",") const;
+ /// \param valid_key whether or not strip leading @, which is
+ /// used to bypass validator
+ std::string params(std::string const & sep=",", bool valid_key=false) const;
/// add key=value to params_
void addParam(std::string const & key, std::string const & value);
Index: src/insets/InsetListings.cpp
===================================================================
--- src/insets/InsetListings.cpp (revision 18709)
+++ src/insets/InsetListings.cpp (working copy)
@@ -131,7 +131,7 @@
int InsetListings::latex(Buffer const & buf, odocstream & os,
OutputParams const & runparams) const
{
- string param_string = params().params();
+ string param_string = params().params(",", true);
// NOTE: I use {} to quote text, which is an experimental feature
// of the listings package (see page 25 of the manual)
int lines = 0;
Index: src/insets/InsetListingsParams.cpp
===================================================================
--- src/insets/InsetListingsParams.cpp (revision 18709)
+++ src/insets/InsetListingsParams.cpp (working copy)
@@ -35,6 +35,7 @@
using support::bformat;
using support::trim;
+using support::ltrim;
using support::rtrim;
using support::subst;
using support::isStrInt;
@@ -123,7 +124,7 @@
switch (type_) {
case ALL:
- if (par2.empty() && !onoff_) {
+ if (par2.empty() && !onoff_ && hint_ != _("Bypass validation")) {
if (!hint_.empty())
return hint_;
else
@@ -301,6 +302,12 @@
/// 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"] =
@@ -620,6 +627,10 @@
from_utf8(suffix), from_utf8(param_names)));
}
+ // do not validate keys starting with @
+ if (prefixIs(name, "@"))
+ return all_params_.find("@")->second;
+
// locate name in parameter table
ListingsParams::const_iterator it = all_params_.find(name);
if (it != all_params_.end())
@@ -636,7 +647,7 @@
}
}
if (matching_names.empty())
- throw invalidParam(bformat(_("Unknown listing parameter name: %1$s"),
+ throw invalidParam(bformat(_("Unknown listing parameter name: %1$s. Prefix this parameter with @ to bypass validation."),
from_utf8(name)));
else
throw invalidParam(bformat(_("Parameters starting with '%1$s': %2$s"),
@@ -683,7 +694,7 @@
}
-string InsetListingsParams::params(string const & sep) const
+string InsetListingsParams::params(string const & sep, bool valid_key) const
{
string par;
for (map<string, string>::const_iterator it = params_.begin();
@@ -691,10 +702,16 @@
if (!par.empty())
par += sep;
// key=value,key=value1 is stored in params_ as key=value,key_=value1.
+ // @key=value is returned as key=value
+ string key = rtrim(it->first, "_");
+ // remove prefix @ which is used to forcefully pass parameters that
+ // can not pass validation
+ if (valid_key)
+ key = ltrim(key, "@");
if (it->second.empty())
- par += rtrim(it->first, "_");
+ par += key;
else
- par += rtrim(it->first, "_") + '=' + it->second;
+ par += key + '=' + it->second;
}
return par;
}
