+ return docstring();
+}
+
+
+/// languages and language/dialect combinations
+char const * allowed_languages =
+ "no language\nABAP\n[R/2 4.3]ABAP\n[R/2 5.0]ABAP\n[R/3 3.1]ABAP\n"
+ "[R/3 4.6C]ABAP\n[R/3 6.10]ABAP\nACSL\nAda\n[2005]Ada\n[83]Ada\n"
+ "[95]Ada\nALGOL\n[60]ALGOL\n[68]ALGOL\nAssembler\n"
+ "[Motorola68k]Assembler\n[x86masm]Assembler\nAwk\n[gnu]Awk\n[POSIX]Awk\n"
+ "bash\nBasic\n[Visual]Basic\nC\n[ANSI]C\n[Handel]C\n[Objective]C\n"
+ "[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\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"
+ "[5.2]Mathematica\nMatlab\nMercury\nMetaPost\nMiranda\nMizar\nML\n"
+ "Modula-2\nMuPAD\nNASTRAN\nOberon-2\nOCL\n[decorative]OCL\n[OMG]OCL\n"
+ "Octave\nOz\nPascal\n[Borland6]Pascal\n[Standard]Pascal\n[XSC]Pascal\n"
+ "Perl\nPHP\nPL/I\nPlasm\nPostScript\nPOV\nProlog\nPromela\nPSTricks\n"
+ "Python\nR\nReduce\nRexx\nRSL\nRuby\nS\n[PLUS]S\nSAS\nScilab\nsh\n"
+ "SHELXL\nSimula\n[67]Simula\n[CII]Simula\n[DEC]Simula\n[IBM]Simula\n"
+ "SPARQL\nSQL\ntcl\n[tk]tcl\nTeX\n[AlLaTeX]TeX\n[common]TeX\n[LaTeX]TeX\n"
+ "[plain]TeX\n[primitive]TeX\nVBScript\nVerilog\nVHDL\n[AMS]VHDL\nVRML\n"
+ "[97]VRML\nXML\nXSLT";
+
+
+/// ListingsParam Validator.
+/// This class is aimed to be a singleton which is instantiated in
+/// \c InsetListingsParams::addParam().
+// FIXME: transfer this validator to the frontend.
+// FIXME: avoid the use of exception.
+class ParValidator
+{
+public:
+ ParValidator();
+
+ /// 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;
+
+ /// 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
+ typedef map<string, ListingsParam> ListingsParams;
+ ListingsParams all_params_;
+};
+
+
+ParValidator::ParValidator()
+{
+ docstring const empty_hint;
+ docstring const style_hint = _("Use \\footnotesize, \\small, \\itshape, "
+ "\\ttfamily or something like that");
+ docstring const frame_hint = _("none, leftline, topline, bottomline, lines, "
+ "single, shadowbox or subset of trblTRBL");
+ docstring const frameround_hint = _("Enter four letters (either t = round "
+ "or f = square) for top right, bottom "
+ "right, bottom left and top left corner.");
+ docstring const color_hint = _("Enter something like \\color{white}");
+
+ /// options copied from page 26 of listings manual
+ // FIXME: add default parameters ... (which is not used now)
+ all_params_["float"] =
+ ListingsParam("false", true, SUBSETOF, "*tbph", empty_hint);
+ all_params_["floatplacement"] =
+ ListingsParam("tbp", false, SUBSETOF, "tbp", empty_hint);
+ all_params_["aboveskip"] =
+ ListingsParam("\\medskipamount", false, SKIP, "", empty_hint);
+ all_params_["belowskip"] =
+ ListingsParam("\\medskipamount", false, SKIP, "", empty_hint);
+ all_params_["lineskip"] =
+ ListingsParam("", false, SKIP, "", empty_hint);
+ all_params_["boxpos"] =
+ ListingsParam("", false, SUBSETOF, "bct", empty_hint);
+ all_params_["print"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["firstline"] =
+ 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"] =
+ ListingsParam("", false, ALL, "", _(
+ "Expect a number with an optional * before it"));
+ all_params_["gobble"] =
+ ListingsParam("", false, INTEGER, "", empty_hint);
+ all_params_["style"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["language"] =
+ ListingsParam("", false, ONEOF, allowed_languages, empty_hint);
+ all_params_["alsolanguage"] =
+ ListingsParam("", false, ONEOF, allowed_languages, empty_hint);
+ all_params_["defaultdialect"] =
+ ListingsParam("", false, ONEOF, allowed_languages, empty_hint);
+ all_params_["printpod"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["usekeywordsintag"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["tagstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["markfirstintag"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["makemacrouse"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["basicstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["identifierstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["commentstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["stringstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["keywordstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["ndkeywordstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["classoffset"] =
+ ListingsParam("", false, INTEGER, "", empty_hint);
+ all_params_["texcsstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["directivestyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["emph"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["moreemph"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deleteemph"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["emphstyle"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["delim"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["moredelim"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletedelim"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["extendedchars"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["inputencoding"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["upquote"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["tabsize"] =
+ ListingsParam("", false, INTEGER, "", empty_hint);
+ all_params_["showtabs"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["tab"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["showspaces"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["showstringspaces"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["formfeed"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["numbers"] =
+ ListingsParam("", false, ONEOF, "none\nleft\nright", empty_hint);
+ all_params_["stepnumber"] =
+ ListingsParam("", false, INTEGER, "", empty_hint);
+ all_params_["numberfirstline"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["numberstyle"] =
+ ListingsParam("", false, ALL, "", style_hint);
+ all_params_["numbersep"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["numberblanklines"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["firstnumber"] =
+ ListingsParam("", false, ALL, "", _("auto, last or a number"));
+ all_params_["name"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["thelstnumber"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["title"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ // this option is not handled in the parameter box
+ all_params_["caption"] =
+ ListingsParam("", false, ALL, "", _(
+ "This parameter should not be entered here. Please use the caption "
+ "edit box (when using the child document dialog) or "
+ "menu Insert->Caption (when defining a listing inset)"));
+ // this option is not handled in the parameter box
+ all_params_["label"] =
+ ListingsParam("", false, ALL, "",_(
+ "This parameter should not be entered here. Please use the label "
+ "edit box (when using the child document dialog) or "
+ "menu Insert->Label (when defining a listing inset)"));
+ all_params_["nolol"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["captionpos"] =
+ ListingsParam("", false, SUBSETOF, "tb", empty_hint);
+ all_params_["abovecaptionskip"] =
+ ListingsParam("", false, SKIP, "", empty_hint);
+ all_params_["belowcaptionskip"] =
+ ListingsParam("", false, SKIP, "", empty_hint);
+ all_params_["linewidth"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["xleftmargin"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["xrightmargin"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["resetmargins"] =
+ 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"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["breakindent"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["breakautoindent"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["frame"] =
+ ListingsParam("", false, ALL, "", frame_hint);
+ all_params_["frameround"] =
+ ListingsParam("", false, SUBSETOF, "tf", frameround_hint);
+ all_params_["framesep"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["rulesep"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["framerule"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["framexleftmargin"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["framexrightmargin"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["framextopmargin"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["framexbottommargin"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["backgroundcolor"] =
+ ListingsParam("", false, ALL, "", color_hint );
+ all_params_["rulecolor"] =
+ ListingsParam("", false, ALL, "", color_hint );
+ all_params_["fillcolor"] =
+ ListingsParam("", false, ALL, "", color_hint );
+ all_params_["rulesepcolor"] =
+ ListingsParam("", false, ALL, "", color_hint );
+ all_params_["frameshape"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["index"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["moreindex"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deleteindex"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["indexstyle"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["columns"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["flexiblecolumns"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["keepspaces"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["basewidth"] =
+ ListingsParam("", false, LENGTH, "", empty_hint);
+ all_params_["fontadjust"] =
+ ListingsParam("", true, TRUEFALSE, "", empty_hint);
+ all_params_["texcl"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["mathescape"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["escapechar"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["escapeinside"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["escapebegin"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["escapeend"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["fancyvrb"] =
+ ListingsParam("", false, TRUEFALSE, "", empty_hint);
+ all_params_["fvcmdparams"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["morefvcmdparams"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["keywordsprefix"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["keywords"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["morekeywords"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletekeywords"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["ndkeywords"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["morendkeywords"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletendkeywords"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["texcs"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["moretexcs"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletetexcs"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["directives"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["moredirectives"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletedirectives"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["sensitive"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["alsoletter"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["alsodigit"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["alsoother"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["otherkeywords"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["tag"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["string"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["morestring"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletestring"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["comment"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["morecomment"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletecomment"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["keywordcomment"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["morekeywordcomment"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["deletekeywordcomment"] =
+ ListingsParam("", false, ALL, "", empty_hint);
+ all_params_["keywordcommentsemicolon"] =
+ 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);
+}
+
+
+docstring ParValidator::validate(string const & name,
+ string const & par) const
+{
+ if (name.empty())
+ return _("Invalid (empty) listing parameter name.");
+
+ if (name[0] == '?') {
+ string suffix = trim(string(name, 1));
+ string param_names;
+ ListingsParams::const_iterator it = all_params_.begin();
+ ListingsParams::const_iterator end = all_params_.end();
+ for (; it != end; ++it) {
+ if (suffix.empty() || contains(it->first, suffix)) {
+ if (!param_names.empty())
+ param_names += ", ";
+ param_names += it->first;
+ }
+ }
+ if (suffix.empty())
+ return bformat(
+ _("Available listing parameters are %1$s"), from_ascii(param_names));
+ else
+ return bformat(
+ _("Available listings parameters containing string \"%1$s\" are %2$s"),
+ 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()) {
+ 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));