Permalink
Fetching contributors…
Cannot retrieve contributors at this time
1598 lines (1434 sloc) 47.8 KB
//
// Options.cs
//
// Authors:
// Jonathan Pryor <jpryor@novell.com>
//
// Copyright (C) 2008 Novell (http://www.novell.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
// Compile With:
// gmcs -debug+ -d:TEST -r:System.Core Options.cs
// gmcs -debug+ -d:LINQ -d:TEST -r:System.Core Options.cs
//
// A Getopt::Long-inspired option parsing library for C#.
//
// NDesk.Options.OptionSet is built upon a key/value table, where the
// key is a option format string and the value is an Action<string>
// delegate that is invoked when the format string is matched.
//
// Option format strings:
// BNF Grammar: ( name [=:]? ) ( '|' name [=:]? )+
//
// Each '|'-delimited name is an alias for the associated action. If the
// format string ends in a '=', it has a required value. If the format
// string ends in a ':', it has an optional value. If neither '=' or ':'
// is present, no value is supported.
//
// Options are extracted either from the current option by looking for
// the option name followed by an '=' or ':', or is taken from the
// following option IFF:
// - The current option does not contain a '=' or a ':'
// - The following option is not a registered named option
//
// The `name' used in the option format string does NOT include any leading
// option indicator, such as '-', '--', or '/'. All three of these are
// permitted/required on any named option.
//
// Option bundling is permitted so long as:
// - '-' is used to start the option group
// - all of the bundled options do not require values
// - all of the bundled options are a single character
//
// This allows specifying '-a -b -c' as '-abc'.
//
// Option processing is disabled by specifying "--". All options after "--"
// are returned by OptionSet.Parse() unchanged and unprocessed.
//
// Unprocessed options are returned from OptionSet.Parse().
//
// Examples:
// int verbose = 0;
// OptionSet p = new OptionSet ()
// .Add ("v", v => ++verbose)
// .Add ("name=|value=", v => Console.WriteLine (v));
// p.Parse (new string[]{"-v", "--v", "/v", "-name=A", "/name", "B", "extra"});
//
// The above would parse the argument string array, and would invoke the
// lambda expression three times, setting `verbose' to 3 when complete.
// It would also print out "A" and "B" to standard output.
// The returned array would contain the string "extra".
//
// C# 3.0 collection initializers are supported:
// var p = new OptionSet () {
// { "h|?|help", v => ShowHelp () },
// };
//
// System.ComponentModel.TypeConverter is also supported, allowing the use of
// custom data types in the callback type; TypeConverter.ConvertFromString()
// is used to convert the value option to an instance of the specified
// type:
//
// var p = new OptionSet () {
// { "foo=", (Foo f) => Console.WriteLine (f.ToString ()) },
// };
//
// Random other tidbits:
// - Boolean options (those w/o '=' or ':' in the option format string)
// are explicitly enabled if they are followed with '+', and explicitly
// disabled if they are followed with '-':
// string a = null;
// var p = new OptionSet () {
// { "a", s => a = s },
// };
// p.Parse (new string[]{"-a"}); // sets v != null
// p.Parse (new string[]{"-a+"}); // sets v != null
// p.Parse (new string[]{"-a-"}); // sets v == null
//
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Globalization;
using System.IO;
using System.Runtime.Serialization;
using System.Text.RegularExpressions;
#if LINQ
using System.Linq;
#endif
#if TEST
using NDesk.Options;
#endif
namespace NDesk.Options {
public class OptionValueCollection : IList, IList<string> {
List<string> values = new List<string> ();
OptionContext c;
internal OptionValueCollection (OptionContext c)
{
this.c = c;
}
#region ICollection
void ICollection.CopyTo (Array array, int index) {(values as ICollection).CopyTo (array, index);}
bool ICollection.IsSynchronized {get {return (values as ICollection).IsSynchronized;}}
object ICollection.SyncRoot {get {return (values as ICollection).SyncRoot;}}
#endregion
#region ICollection<T>
public void Add (string item) {values.Add (item);}
public void Clear () {values.Clear ();}
public bool Contains (string item) {return values.Contains (item);}
public void CopyTo (string[] array, int arrayIndex) {values.CopyTo (array, arrayIndex);}
public bool Remove (string item) {return values.Remove (item);}
public int Count {get {return values.Count;}}
public bool IsReadOnly {get {return false;}}
#endregion
#region IEnumerable
IEnumerator IEnumerable.GetEnumerator () {return values.GetEnumerator ();}
#endregion
#region IEnumerable<T>
public IEnumerator<string> GetEnumerator () {return values.GetEnumerator ();}
#endregion
#region IList
int IList.Add (object value) {return (values as IList).Add (value);}
bool IList.Contains (object value) {return (values as IList).Contains (value);}
int IList.IndexOf (object value) {return (values as IList).IndexOf (value);}
void IList.Insert (int index, object value) {(values as IList).Insert (index, value);}
void IList.Remove (object value) {(values as IList).Remove (value);}
void IList.RemoveAt (int index) {(values as IList).RemoveAt (index);}
bool IList.IsFixedSize {get {return false;}}
object IList.this [int index] {get {return this [index];} set {(values as IList)[index] = value;}}
#endregion
#region IList<T>
public int IndexOf (string item) {return values.IndexOf (item);}
public void Insert (int index, string item) {values.Insert (index, item);}
public void RemoveAt (int index) {values.RemoveAt (index);}
private void AssertValid (int index)
{
if (c.Option == null)
throw new InvalidOperationException ("OptionContext.Option is null.");
if (index >= c.Option.MaxValueCount)
throw new ArgumentOutOfRangeException ("index");
if (c.Option.OptionValueType == OptionValueType.Required &&
index >= values.Count)
throw new OptionException (string.Format (
c.OptionSet.MessageLocalizer ("Missing required value for option '{0}'."), c.OptionName),
c.OptionName);
}
public string this [int index] {
get {
AssertValid (index);
return index >= values.Count ? null : values [index];
}
set {
values [index] = value;
}
}
#endregion
public List<string> ToList ()
{
return new List<string> (values);
}
public string[] ToArray ()
{
return values.ToArray ();
}
public override string ToString ()
{
return string.Join (", ", values.ToArray ());
}
}
public class OptionContext {
public OptionContext (OptionSet set)
{
OptionValues = new OptionValueCollection (this);
OptionSet = set;
}
public Option Option { get; set; }
public string OptionName { get; set; }
public int OptionIndex { get; set; }
public OptionSet OptionSet { get; private set; }
public OptionValueCollection OptionValues { get; private set; }
}
public enum OptionValueType {
None,
Optional,
Required,
}
public abstract class Option {
string prototype, description;
string[] names;
OptionValueType type;
int count;
string[] separators;
protected Option (string prototype, string description)
: this (prototype, description, 1)
{
}
protected Option (string prototype, string description, int maxValueCount)
{
if (prototype == null)
throw new ArgumentNullException ("prototype");
if (prototype.Length == 0)
throw new ArgumentException ("Cannot be the empty string.", "prototype");
if (maxValueCount < 0)
throw new ArgumentOutOfRangeException ("maxValueCount");
this.prototype = prototype;
this.names = prototype.Split ('|');
this.description = description;
this.count = maxValueCount;
this.type = ParsePrototype ();
if (this.count == 0 && type != OptionValueType.None)
throw new ArgumentException (
"Cannot provide maxValueCount of 0 for OptionValueType.Required or " +
"OptionValueType.Optional.",
"maxValueCount");
if (this.type == OptionValueType.None && maxValueCount > 1)
throw new ArgumentException (
string.Format ("Cannot provide maxValueCount of {0} for OptionValueType.None.", maxValueCount),
"maxValueCount");
}
public string Prototype {get {return prototype;}}
public string Description {get {return description;}}
public OptionValueType OptionValueType {get {return type;}}
public int MaxValueCount {get {return count;}}
public string[] GetNames ()
{
return (string[]) names.Clone ();
}
public string[] GetValueSeparators ()
{
if (separators == null)
return new string [0];
return (string[]) separators.Clone ();
}
protected static T Parse<T> (string value, OptionContext c)
{
TypeConverter conv = TypeDescriptor.GetConverter (typeof (T));
T t = default (T);
try {
if (value != null)
t = (T) conv.ConvertFromString (value);
}
catch (Exception e) {
throw new OptionException (
string.Format (
c.OptionSet.MessageLocalizer ("Could not convert string `{0}' to type {1} for option `{2}'."),
value, typeof (T).Name, c.OptionName),
c.OptionName, e);
}
return t;
}
internal string[] Names {get {return names;}}
internal string[] ValueSeparators {get {return separators;}}
static readonly char[] NameTerminator = new char[]{'=', ':'};
private OptionValueType ParsePrototype ()
{
char type = '\0';
List<string> seps = new List<string> ();
for (int i = 0; i < names.Length; ++i) {
string name = names [i];
if (name.Length == 0)
throw new ArgumentException ("Empty option names are not supported.", "prototype");
int end = name.IndexOfAny (NameTerminator);
if (end == -1)
continue;
names [i] = name.Substring (0, end);
if (type == '\0' || type == name [end])
type = name [end];
else
throw new ArgumentException (
string.Format ("Conflicting option types: '{0}' vs. '{1}'.", type, name [end]),
"prototype");
AddSeparators (name, end, seps);
}
if (type == '\0')
return OptionValueType.None;
if (count <= 1 && seps.Count != 0)
throw new ArgumentException (
string.Format ("Cannot provide key/value separators for Options taking {0} value(s).", count),
"prototype");
if (count > 1) {
if (seps.Count == 0)
this.separators = new string[]{":", "="};
else if (seps.Count == 1 && seps [0].Length == 0)
this.separators = null;
else
this.separators = seps.ToArray ();
}
return type == '=' ? OptionValueType.Required : OptionValueType.Optional;
}
private void AddSeparators (string name, int end, List<string> seps)
{
int start = -1;
for (int i = end+1; i < name.Length; ++i) {
switch (name [i]) {
case '{':
if (start != -1)
throw new ArgumentException (
string.Format ("Ill-formed name/value separator found in \"{0}\".", name),
"prototype");
start = i+1;
break;
case '}':
if (start == -1)
throw new ArgumentException (
string.Format ("Ill-formed name/value separator found in \"{0}\".", name),
"prototype");
seps.Add (name.Substring (start, i-start));
start = -1;
break;
default:
if (start == -1)
seps.Add (name [i].ToString ());
break;
}
}
if (start != -1)
throw new ArgumentException (
string.Format ("Ill-formed name/value separator found in \"{0}\".", name),
"prototype");
}
public void Invoke (OptionContext c)
{
OnParseComplete (c);
c.OptionName = null;
c.Option = null;
c.OptionValues.Clear ();
}
protected abstract void OnParseComplete (OptionContext c);
public override string ToString ()
{
return Prototype;
}
}
[Serializable]
public class OptionException : Exception {
private string option;
public OptionException (string message, string optionName)
: base (message)
{
this.option = optionName;
}
public OptionException (string message, string optionName, Exception innerException)
: base (message, innerException)
{
this.option = optionName;
}
protected OptionException (SerializationInfo info, StreamingContext context)
: base (info, context)
{
this.option = info.GetString ("OptionName");
}
public string OptionName {
get {return this.option;}
}
public override void GetObjectData (SerializationInfo info, StreamingContext context)
{
base.GetObjectData (info, context);
info.AddValue ("OptionName", option);
}
}
public delegate void OptionAction<TKey, TValue> (TKey key, TValue value);
public class OptionSet : Collection<Option>
{
public OptionSet ()
: this (f => f)
{
}
public OptionSet (Converter<string, string> localizer)
{
this.localizer = localizer;
}
Dictionary<string, Option> options = new Dictionary<string, Option> ();
Converter<string, string> localizer;
public Converter<string, string> MessageLocalizer {
get {return localizer;}
}
protected Option GetOptionForName (string option)
{
if (option == null)
throw new ArgumentNullException ("option");
Option v;
if (options.TryGetValue (option, out v))
return v;
return null;
}
protected override void ClearItems ()
{
this.options.Clear ();
}
protected override void InsertItem (int index, Option item)
{
AddImpl (item);
base.InsertItem (index, item);
}
protected override void RemoveItem (int index)
{
Option p = Items [index];
foreach (string name in p.Names) {
this.options.Remove (name);
}
base.RemoveItem (index);
}
protected override void SetItem (int index, Option item)
{
RemoveItem (index);
Add (item);
base.SetItem (index, item);
}
private void AddImpl (Option option)
{
if (option == null)
throw new ArgumentNullException ("option");
List<string> added = new List<string> ();
try {
foreach (string name in option.Names) {
this.options.Add (name, option);
}
}
catch (Exception) {
foreach (string name in added)
this.options.Remove (name);
throw;
}
}
public new OptionSet Add (Option option)
{
base.Add (option);
return this;
}
class ActionOption : Option {
Action<OptionValueCollection> action;
public ActionOption (string prototype, string description, int count, Action<OptionValueCollection> action)
: base (prototype, description, count)
{
if (action == null)
throw new ArgumentNullException ("action");
this.action = action;
}
protected override void OnParseComplete (OptionContext c)
{
action (c.OptionValues);
}
}
public OptionSet Add (string prototype, Action<string> action)
{
return Add (prototype, null, action);
}
public OptionSet Add (string prototype, string description, Action<string> action)
{
if (action == null)
throw new ArgumentNullException ("action");
Option p = new ActionOption (prototype, description, 1, v => action (v [0]));
base.Add (p);
return this;
}
public OptionSet Add (string prototype, OptionAction<string, string> action)
{
return Add (prototype, null, action);
}
public OptionSet Add (string prototype, string description, OptionAction<string, string> action)
{
if (action == null)
throw new ArgumentNullException ("action");
Option p = new ActionOption (prototype, description, 2, (v) => action (v [0], v [1]));
base.Add (p);
return this;
}
class ActionOption<T> : Option {
Action<T> action;
public ActionOption (string prototype, string description, Action<T> action)
: base (prototype, description, 1)
{
if (action == null)
throw new ArgumentNullException ("action");
this.action = action;
}
protected override void OnParseComplete (OptionContext c)
{
action (Parse<T> (c.OptionValues [0], c));
}
}
class ActionOption<TKey, TValue> : Option {
OptionAction<TKey, TValue> action;
public ActionOption (string prototype, string description, OptionAction<TKey, TValue> action)
: base (prototype, description, 2)
{
if (action == null)
throw new ArgumentNullException ("action");
this.action = action;
}
protected override void OnParseComplete (OptionContext c)
{
action (
Parse<TKey> (c.OptionValues [0], c),
Parse<TValue> (c.OptionValues [1], c));
}
}
public OptionSet Add<T> (string prototype, Action<T> action)
{
return Add (prototype, null, action);
}
public OptionSet Add<T> (string prototype, string description, Action<T> action)
{
return Add (new ActionOption<T> (prototype, description, action));
}
public OptionSet Add<TKey, TValue> (string prototype, OptionAction<TKey, TValue> action)
{
return Add (prototype, null, action);
}
public OptionSet Add<TKey, TValue> (string prototype, string description, OptionAction<TKey, TValue> action)
{
return Add (new ActionOption<TKey, TValue> (prototype, description, action));
}
protected virtual OptionContext CreateOptionContext ()
{
return new OptionContext (this);
}
#if LINQ
public List<string> Parse (IEnumerable<string> arguments)
{
bool process = true;
OptionContext c = CreateOptionContext ();
c.OptionIndex = -1;
var unprocessed =
from argument in arguments
where ++c.OptionIndex >= 0 && process
? argument == "--"
? (process = false)
: !Parse (argument, c)
: true
select argument;
List<string> r = unprocessed.ToList ();
if (c.Option != null)
c.Option.Invoke (c);
return r;
}
#else
public List<string> Parse (IEnumerable<string> arguments)
{
OptionContext c = CreateOptionContext ();
c.OptionIndex = -1;
bool process = true;
List<string> unprocessed = new List<string> ();
foreach (string argument in arguments) {
++c.OptionIndex;
if (argument == "--") {
process = false;
continue;
}
if (!process) {
unprocessed.Add (argument);
continue;
}
if (!Parse (argument, c))
unprocessed.Add (argument);
}
if (c.Option != null)
c.Option.Invoke (c);
return unprocessed;
}
#endif
private readonly Regex ValueOption = new Regex (
@"^(?<flag>--|-|/)(?<name>[^:=]+)((?<sep>[:=])(?<value>.*))?$");
protected bool GetOptionParts (string argument, out string flag, out string name, out string sep, out string value)
{
if (argument == null)
throw new ArgumentNullException ("argument");
flag = name = sep = value = null;
Match m = ValueOption.Match (argument);
if (!m.Success) {
return false;
}
flag = m.Groups ["flag"].Value;
name = m.Groups ["name"].Value;
if (m.Groups ["sep"].Success && m.Groups ["value"].Success) {
sep = m.Groups ["sep"].Value;
value = m.Groups ["value"].Value;
}
return true;
}
protected virtual bool Parse (string argument, OptionContext c)
{
if (c.Option != null) {
ParseValue (argument, c);
return true;
}
string f, n, s, v;
if (!GetOptionParts (argument, out f, out n, out s, out v))
return false;
Option p;
if (this.options.TryGetValue (n, out p)) {
c.OptionName = f + n;
c.Option = p;
switch (p.OptionValueType) {
case OptionValueType.None:
c.OptionValues.Add (n);
c.Option.Invoke (c);
break;
case OptionValueType.Optional:
case OptionValueType.Required:
ParseValue (v, c);
break;
}
return true;
}
// no match; is it a bool option?
if (ParseBool (argument, n, c))
return true;
// is it a bundled option?
if (ParseBundledValue (f, string.Concat (n + s + v), c))
return true;
return false;
}
private void ParseValue (string option, OptionContext c)
{
if (option != null)
foreach (var o in c.Option.ValueSeparators != null
? option.Split (c.Option.ValueSeparators, StringSplitOptions.None)
: new string[]{option}) {
c.OptionValues.Add (o);
}
if (c.OptionValues.Count == c.Option.MaxValueCount ||
c.Option.OptionValueType == OptionValueType.Optional)
c.Option.Invoke (c);
else if (c.OptionValues.Count > c.Option.MaxValueCount) {
throw new OptionException (localizer (string.Format (
"Error: Found {0} option values when expecting {1}.",
c.OptionValues.Count, c.Option.MaxValueCount)),
c.OptionName);
}
}
private bool ParseBool (string option, string n, OptionContext c)
{
Option p;
if (n.Length >= 1 && (n [n.Length-1] == '+' || n [n.Length-1] == '-') &&
this.options.TryGetValue (n.Substring (0, n.Length-1), out p)) {
string v = n [n.Length-1] == '+' ? option : null;
c.OptionName = option;
c.Option = p;
c.OptionValues.Add (v);
p.Invoke (c);
return true;
}
return false;
}
private bool ParseBundledValue (string f, string n, OptionContext c)
{
if (f != "-")
return false;
for (int i = 0; i < n.Length; ++i) {
Option p;
string opt = f + n [i].ToString ();
if (!this.options.TryGetValue (n [i].ToString (), out p)) {
if (i == 0)
return false;
throw new OptionException (string.Format (localizer (
"Cannot bundle unregistered option '{0}'."), opt), opt);
}
switch (p.OptionValueType) {
case OptionValueType.None:
Invoke (c, opt, n, p);
break;
case OptionValueType.Optional:
case OptionValueType.Required: {
string v = n.Substring (i+1);
c.Option = p;
c.OptionName = opt;
ParseValue (v.Length != 0 ? v : null, c);
return true;
}
default:
throw new InvalidOperationException ("Unknown OptionValueType: " + p.OptionValueType);
}
}
return true;
}
private void Invoke (OptionContext c, string name, string value, Option option)
{
c.OptionName = name;
c.Option = option;
c.OptionValues.Add (value);
option.Invoke (c);
}
private const int OptionWidth = 29;
public void WriteOptionDescriptions (TextWriter o)
{
foreach (Option p in this) {
List<string> names = new List<string> (p.Names);
int written = 0;
if (names [0].Length == 1) {
Write (o, ref written, " -");
Write (o, ref written, names [0]);
}
else {
Write (o, ref written, " --");
Write (o, ref written, names [0]);
}
for (int i = 1; i < names.Count; ++i) {
Write (o, ref written, ", ");
Write (o, ref written, names [i].Length == 1 ? "-" : "--");
Write (o, ref written, names [i]);
}
if (p.OptionValueType == OptionValueType.Optional ||
p.OptionValueType == OptionValueType.Required) {
if (p.OptionValueType == OptionValueType.Optional) {
Write (o, ref written, localizer ("["));
}
Write (o, ref written, localizer ("=VALUE"));
if (p.MaxValueCount > 1)
Write (o, ref written, localizer ("1"));
string[] seps = p.ValueSeparators;
for (int c = 1; c < p.MaxValueCount; ++c) {
Write (o, ref written, localizer (
seps != null && seps.Length > 0 ? seps [0] : " "));
Write (o, ref written, localizer ("VALUE" + (c+1)));
}
if (p.OptionValueType == OptionValueType.Optional) {
Write (o, ref written, localizer ("]"));
}
}
if (written < OptionWidth)
o.Write (new string (' ', OptionWidth - written));
else {
o.WriteLine ();
o.Write (new string (' ', OptionWidth));
}
o.WriteLine (localizer (p.Description));
}
}
static void Write (TextWriter o, ref int n, string s)
{
n += s.Length;
o.Write (s);
}
}
}
#if TEST
namespace Tests.NDesk.Options {
using System.Linq;
class FooConverter : TypeConverter {
public override bool CanConvertFrom (ITypeDescriptorContext context, Type sourceType)
{
if (sourceType == typeof (string))
return true;
return base.CanConvertFrom (context, sourceType);
}
public override object ConvertFrom (ITypeDescriptorContext context,
CultureInfo culture, object value)
{
string v = value as string;
if (v != null) {
switch (v) {
case "A": return Foo.A;
case "B": return Foo.B;
}
}
return base.ConvertFrom (context, culture, value);
}
}
[TypeConverter (typeof(FooConverter))]
class Foo {
public static readonly Foo A = new Foo ("A");
public static readonly Foo B = new Foo ("B");
string s;
Foo (string s) { this.s = s; }
public override string ToString () {return s;}
}
class Test {
public static void Main (string[] args)
{
var tests = new Dictionary<string, Action> () {
{ "boolean", () => CheckBoolean () },
{ "bundled-val", () => CheckBundledValue () },
{ "bundling", () => CheckOptionBundling () },
{ "c-key/value", () => CheckCustomKeyValue () },
{ "context", () => CheckOptionContext () },
{ "derived-type", () => CheckDerivedType () },
{ "descriptions", () => CheckWriteOptionDescriptions () },
{ "exceptions", () => CheckExceptions () },
{ "halt", () => CheckHaltProcessing () },
{ "key/value", () => CheckKeyValue () },
{ "localization", () => CheckLocalization () },
{ "many", () => CheckMany () },
{ "optional", () => CheckOptional () },
{ "option-parts", () => CheckOptionParts () },
{ "required", () => CheckRequired () },
};
bool run = true;
bool help = false;
var p = new OptionSet () {
{ "t|test=",
"Run the specified test. Valid tests:\n" + new string (' ', 32) +
string.Join ("\n" + new string (' ', 32), tests.Keys.OrderBy (s => s).ToArray ()),
v => { run = false; Console.WriteLine (v); tests [v] (); } },
{ "h|?|help", "Show this message and exit", (v) => help = v != null },
};
p.Parse (args);
if (help) {
Console.WriteLine ("usage: Options.exe [OPTION]+\n");
Console.WriteLine ("Options unit test program.");
Console.WriteLine ("Valid options include:");
p.WriteOptionDescriptions (Console.Out);
} else if (run) {
foreach (Action a in tests.Values)
a ();
}
}
static IEnumerable<string> _ (params string[] a)
{
return a;
}
static void CheckBundledValue ()
{
var defines = new List<string> ();
var libs = new List<string> ();
bool debug = false;
var p = new OptionSet () {
{ "D|define=", v => defines.Add (v) },
{ "L|library:", v => libs.Add (v) },
{ "Debug", v => debug = v != null },
{ "E", v => { /* ignore */ } },
};
p.Parse (_("-DNAME", "-D", "NAME2", "-Debug", "-L/foo", "-L", "/bar", "-EDNAME3"));
Assert (defines.Count, 3);
Assert (defines [0], "NAME");
Assert (defines [1], "NAME2");
Assert (defines [2], "NAME3");
Assert (debug, true);
Assert (libs.Count, 2);
Assert (libs [0], "/foo");
Assert (libs [1], null);
AssertException (typeof(OptionException),
"Cannot bundle unregistered option '-V'.",
p, v => { v.Parse (_("-EVALUENOTSUP")); });
}
static void CheckRequired ()
{
string a = null;
int n = 0;
OptionSet p = new OptionSet () {
{ "a=", v => a = v },
{ "n=", (int v) => n = v },
};
List<string> extra = p.Parse (_("a", "-a", "s", "-n=42", "n"));
Assert (extra.Count, 2);
Assert (extra [0], "a");
Assert (extra [1], "n");
Assert (a, "s");
Assert (n, 42);
extra = p.Parse (_("-a="));
Assert (extra.Count, 0);
Assert (a, "");
}
static void CheckOptional ()
{
string a = null;
int n = -1;
Foo f = null;
OptionSet p = new OptionSet () {
{ "a:", v => a = v },
{ "n:", (int v) => n = v },
{ "f:", (Foo v) => f = v },
};
p.Parse (_("-a=s"));
Assert (a, "s");
p.Parse (_("-a"));
Assert (a, null);
p.Parse (_("-a="));
Assert (a, "");
p.Parse (_("-f", "A"));
Assert (f, null);
p.Parse (_("-f"));
Assert (f, null);
p.Parse (_("-f=A"));
Assert (f, Foo.A);
f = null;
p.Parse (_("-fA"));
Assert (f, Foo.A);
p.Parse (_("-n42"));
Assert (n, 42);
p.Parse (_("-n", "42"));
Assert (n, 0);
p.Parse (_("-n=42"));
Assert (n, 42);
p.Parse (_("-n"));
Assert (n, 0);
}
static void CheckBoolean ()
{
bool a = false;
OptionSet p = new OptionSet () {
{ "a", v => a = v != null },
};
p.Parse (_("-a"));
Assert (a, true);
p.Parse (_("-a+"));
Assert (a, true);
p.Parse (_("-a-"));
Assert (a, false);
}
static void CheckMany ()
{
int a = -1, b = -1;
string av = null, bv = null;
Foo f = null;
int help = 0;
int verbose = 0;
OptionSet p = new OptionSet () {
{ "a=", v => { a = 1; av = v; } },
{ "b", "desc", v => {b = 2; bv = v;} },
{ "f=", (Foo v) => f = v },
{ "v", v => { ++verbose; } },
{ "h|?|help", (v) => { switch (v) {
case "h": help |= 0x1; break;
case "?": help |= 0x2; break;
case "help": help |= 0x4; break;
} } },
};
List<string> e = p.Parse (new string[]{"foo", "-v", "-a=42", "/b-",
"-a", "64", "bar", "--f", "B", "/h", "-?", "--help", "-v"});
Assert (e.Count, 2);
Assert (e[0], "foo");
Assert (e[1], "bar");
Assert (a, 1);
Assert (av, "64");
Assert (b, 2);
Assert (bv, null);
Assert (verbose, 2);
Assert (help, 0x7);
Assert (f, Foo.B);
}
static void Assert<T>(T actual, T expected)
{
if (!object.Equals (actual, expected))
throw new InvalidOperationException (
string.Format ("Assertion failed: \"{0}\" != \"{1}\"",
actual == null ? "<null>" : actual.ToString (),
expected == null ? "<null>" : expected.ToString ()));
}
class DefaultOption : Option {
public DefaultOption (string prototypes, string description)
: base (prototypes, description)
{
}
public DefaultOption (string prototypes, string description, int c)
: base (prototypes, description, c)
{
}
protected override void OnParseComplete (OptionContext c)
{
throw new NotImplementedException ();
}
}
static void CheckExceptions ()
{
string a = null;
var p = new OptionSet () {
{ "a=", v => a = v },
{ "b", v => { } },
{ "c", v => { } },
{ "n=", (int v) => { } },
{ "f=", (Foo v) => { } },
};
// missing argument
AssertException (typeof(OptionException),
"Missing required value for option '-a'.",
p, v => { v.Parse (_("-a")); });
// another named option while expecting one -- follow Getopt::Long
AssertException (null, null,
p, v => { v.Parse (_("-a", "-a")); });
Assert (a, "-a");
// no exception when an unregistered named option follows.
AssertException (null, null,
p, v => { v.Parse (_("-a", "-b")); });
Assert (a, "-b");
AssertException (typeof(ArgumentNullException),
"Argument cannot be null.\nParameter name: option",
p, v => { v.Add (null); });
// bad type
AssertException (typeof(OptionException),
"Could not convert string `value' to type Int32 for option `-n'.",
p, v => { v.Parse (_("-n", "value")); });
AssertException (typeof(OptionException),
"Could not convert string `invalid' to type Foo for option `--f'.",
p, v => { v.Parse (_("--f", "invalid")); });
// try to bundle with an option requiring a value
AssertException (typeof(OptionException),
"Cannot bundle unregistered option '-z'.",
p, v => { v.Parse (_("-cz", "extra")); });
AssertException (typeof(ArgumentNullException),
"Argument cannot be null.\nParameter name: prototype",
p, v => { new DefaultOption (null, null); });
AssertException (typeof(ArgumentException),
"Cannot be the empty string.\nParameter name: prototype",
p, v => { new DefaultOption ("", null); });
AssertException (typeof(ArgumentException),
"Empty option names are not supported.\nParameter name: prototype",
p, v => { new DefaultOption ("a|b||c=", null); });
AssertException (typeof(ArgumentException),
"Conflicting option types: '=' vs. ':'.\nParameter name: prototype",
p, v => { new DefaultOption ("a=|b:", null); });
AssertException (typeof(ArgumentNullException),
"Argument cannot be null.\nParameter name: action",
p, v => { v.Add ("foo", (Action<string>) null); });
AssertException (typeof(ArgumentException),
"Cannot provide maxValueCount of 2 for OptionValueType.None.\nParameter name: maxValueCount",
p, v => { v.Add ("foo", (k, val) => {/* ignore */}); });
AssertException (typeof(ArgumentOutOfRangeException),
"Argument is out of range.\nParameter name: maxValueCount",
p, v => { new DefaultOption ("a", null, -1); });
AssertException (typeof(ArgumentException),
"Cannot provide maxValueCount of 0 for OptionValueType.Required or " +
"OptionValueType.Optional.\nParameter name: maxValueCount",
p, v => { new DefaultOption ("a=", null, 0); });
AssertException (typeof(ArgumentException),
"Ill-formed name/value separator found in \"a={\".\nParameter name: prototype",
p, v => { new DefaultOption ("a={", null); });
AssertException (typeof(ArgumentException),
"Ill-formed name/value separator found in \"a=}\".\nParameter name: prototype",
p, v => { new DefaultOption ("a=}", null); });
AssertException (typeof(ArgumentException),
"Ill-formed name/value separator found in \"a={{}}\".\nParameter name: prototype",
p, v => { new DefaultOption ("a={{}}", null); });
AssertException (typeof(ArgumentException),
"Ill-formed name/value separator found in \"a={}}\".\nParameter name: prototype",
p, v => { new DefaultOption ("a={}}", null); });
AssertException (typeof(ArgumentException),
"Ill-formed name/value separator found in \"a={}{\".\nParameter name: prototype",
p, v => { new DefaultOption ("a={}{", null); });
AssertException (typeof(ArgumentException),
"Cannot provide key/value separators for Options taking 1 value(s).\nParameter name: prototype",
p, v => { new DefaultOption ("a==", null); });
AssertException (typeof(ArgumentException),
"Cannot provide key/value separators for Options taking 1 value(s).\nParameter name: prototype",
p, v => { new DefaultOption ("a={}", null); });
AssertException (typeof(ArgumentException),
"Cannot provide key/value separators for Options taking 1 value(s).\nParameter name: prototype",
p, v => { new DefaultOption ("a=+-*/", null); });
AssertException (null, null,
p, v => { new DefaultOption ("a", null, 0); });
AssertException (null, null,
p, v => { new DefaultOption ("a", null, 0); });
AssertException (null, null,
p, v => {
var d = new DefaultOption ("a", null);
Assert (d.GetValueSeparators ().Length, 0);
});
AssertException (null, null,
p, v => {
var d = new DefaultOption ("a=", null, 1);
string[] s = d.GetValueSeparators ();
Assert (s.Length, 0);
});
AssertException (null, null,
p, v => {
var d = new DefaultOption ("a=", null, 2);
string[] s = d.GetValueSeparators ();
Assert (s.Length, 2);
Assert (s [0], ":");
Assert (s [1], "=");
});
AssertException (null, null,
p, v => {
var d = new DefaultOption ("a={}", null, 2);
string[] s = d.GetValueSeparators ();
Assert (s.Length, 0);
});
AssertException (null, null,
p, v => {
var d = new DefaultOption ("a={-->}{=>}", null, 2);
string[] s = d.GetValueSeparators ();
Assert (s.Length, 2);
Assert (s [0], "-->");
Assert (s [1], "=>");
});
AssertException (null, null,
p, v => {
var d = new DefaultOption ("a=+-*/", null, 2);
string[] s = d.GetValueSeparators ();
Assert (s.Length, 4);
Assert (s [0], "+");
Assert (s [1], "-");
Assert (s [2], "*");
Assert (s [3], "/");
});
OptionContext c = new OptionContext (p);
AssertException (typeof(InvalidOperationException),
"OptionContext.Option is null.",
c, v => { string ignore = v.OptionValues [0]; });
c.Option = p [0];
AssertException (typeof(ArgumentOutOfRangeException),
"Argument is out of range.\nParameter name: index",
c, v => { string ignore = v.OptionValues [2]; });
c.OptionName = "-a";
AssertException (typeof(OptionException),
"Missing required value for option '-a'.",
c, v => { string ignore = v.OptionValues [0]; });
}
static void AssertException<T> (Type exception, string message, T a, Action<T> action)
{
Type actualType = null;
string stack = null;
string actualMessage = null;
try {
action (a);
}
catch (Exception e) {
actualType = e.GetType ();
actualMessage = e.Message;
if (!object.Equals (actualType, exception))
stack = e.ToString ();
}
if (!object.Equals (actualType, exception)) {
throw new InvalidOperationException (
string.Format ("Assertion failed: Expected Exception Type {0}, got {1}.\n" +
"Actual Exception: {2}", exception, actualType, stack));
}
if (!object.Equals (actualMessage, message))
throw new InvalidOperationException (
string.Format ("Assertion failed:\n\tExpected: {0}\n\t Actual: {1}",
message, actualMessage));
}
static void CheckWriteOptionDescriptions ()
{
var p = new OptionSet () {
{ "p|indicator-style=", "append / indicator to directories", v => {} },
{ "color:", "controls color info", v => {} },
{ "rk=", "required key/value option", (k, v) => {} },
{ "ok:", "optional key/value option", (k, v) => {} },
{ "h|?|help", "show help text", v => {} },
{ "version", "output version information and exit", v => {} },
};
StringWriter expected = new StringWriter ();
expected.WriteLine (" -p, --indicator-style=VALUE");
expected.WriteLine (" append / indicator to directories");
expected.WriteLine (" --color[=VALUE] controls color info");
expected.WriteLine (" --rk=VALUE1:VALUE2 required key/value option");
expected.WriteLine (" --ok[=VALUE1:VALUE2] optional key/value option");
expected.WriteLine (" -h, -?, --help show help text");
expected.WriteLine (" --version output version information and exit");
StringWriter actual = new StringWriter ();
p.WriteOptionDescriptions (actual);
Assert (actual.ToString (), expected.ToString ());
}
static void CheckOptionBundling ()
{
string a, b, c, f;
a = b = c = f = null;
var p = new OptionSet () {
{ "a", v => a = "a" },
{ "b", v => b = "b" },
{ "c", v => c = "c" },
{ "f=", v => f = v },
};
List<string> extra = p.Parse (_ ("-abcf", "foo", "bar"));
Assert (extra.Count, 1);
Assert (extra [0], "bar");
Assert (a, "a");
Assert (b, "b");
Assert (c, "c");
Assert (f, "foo");
}
static void CheckHaltProcessing ()
{
var p = new OptionSet () {
{ "a", v => {} },
{ "b", v => {} },
};
List<string> e = p.Parse (_ ("-a", "-b", "--", "-a", "-b"));
Assert (e.Count, 2);
Assert (e [0], "-a");
Assert (e [1], "-b");
}
static void CheckKeyValue ()
{
var a = new Dictionary<string, string> ();
var b = new Dictionary<int, char> ();
var p = new OptionSet () {
{ "a=", (k,v) => a.Add (k, v) },
{ "b=", (int k, char v) => b.Add (k, v) },
{ "c:", (k, v) => {if (k != null) a.Add (k, v);} },
{ "d={=>}{-->}", (k, v) => a.Add (k, v) },
{ "e={}", (k, v) => a.Add (k, v) },
{ "f=+/", (k, v) => a.Add (k, v) },
};
p.Parse (_("-a", "A", "B", "-a", "C", "D", "-a=E=F", "-a:G:H", "-aI=J", "-b", "1", "a", "-b", "2", "b"));
AssertDictionary (a,
"A", "B",
"C", "D",
"E", "F",
"G", "H",
"I", "J");
AssertDictionary (b,
"1", "a",
"2", "b");
a.Clear ();
p.Parse (_("-c"));
Assert (a.Count, 0);
p.Parse (_("-c", "a"));
Assert (a.Count, 0);
p.Parse (_("-ca"));
AssertDictionary (a, "a", null);
a.Clear ();
p.Parse (_("-ca=b"));
AssertDictionary (a, "a", "b");
a.Clear ();
p.Parse (_("-dA=>B", "-d", "C-->D", "-d:E", "F", "-d", "G", "H", "-dJ-->K"));
AssertDictionary (a,
"A", "B",
"C", "D",
"E", "F",
"G", "H",
"J", "K");
a.Clear ();
p.Parse (_("-eA=B", "-eC=D", "-eE", "F", "-e:G", "H"));
AssertDictionary (a,
"A=B", "-eC=D",
"E", "F",
"G", "H");
a.Clear ();
p.Parse (_("-f1/2", "-f=3/4", "-f:5+6", "-f7", "8", "-f9=10", "-f11=12"));
AssertDictionary (a,
"1", "2",
"3", "4",
"5", "6",
"7", "8",
"9=10", "-f11=12");
}
static void AssertDictionary<TKey, TValue> (Dictionary<TKey, TValue> dict, params string[] set)
{
TypeConverter k = TypeDescriptor.GetConverter (typeof (TKey));
TypeConverter v = TypeDescriptor.GetConverter (typeof (TValue));
Assert (dict.Count, set.Length / 2);
for (int i = 0; i < set.Length; i += 2) {
TKey key = (TKey) k.ConvertFromString (set [i]);
Assert (dict.ContainsKey (key), true);
if (set [i+1] == null)
Assert (dict [key], default (TValue));
else
Assert (dict [key], (TValue) v.ConvertFromString (set [i+1]));
}
}
class CustomOption : Option {
Action<OptionValueCollection> action;
public CustomOption (string p, string d, int c, Action<OptionValueCollection> a)
: base (p, d, c)
{
this.action = a;
}
protected override void OnParseComplete (OptionContext c)
{
action (c.OptionValues);
}
}
static void CheckCustomKeyValue ()
{
var a = new Dictionary<string, string> ();
var b = new Dictionary<string, string[]> ();
var p = new OptionSet () {
new CustomOption ("a==:", null, 2, v => a.Add (v [0], v [1])),
new CustomOption ("b==:", null, 3, v => b.Add (v [0], new string[]{v [1], v [2]})),
};
p.Parse (_("-a=b=c", "-a=d", "e", "-a:f=g", "-a:h:i", "-a", "j=k", "-a", "l:m"));
Assert (a.Count, 6);
Assert (a ["b"], "c");
Assert (a ["d"], "e");
Assert (a ["f"], "g");
Assert (a ["h"], "i");
Assert (a ["j"], "k");
Assert (a ["l"], "m");
AssertException (typeof(OptionException),
"Missing required value for option '-a'.",
p, v => {v.Parse (_("-a=b"));});
p.Parse (_("-b", "a", "b", "c", "-b:d:e:f", "-b=g=h:i", "-b:j=k:l"));
Assert (b.Count, 4);
Assert (b ["a"][0], "b");
Assert (b ["a"][1], "c");
Assert (b ["d"][0], "e");
Assert (b ["d"][1], "f");
Assert (b ["g"][0], "h");
Assert (b ["g"][1], "i");
Assert (b ["j"][0], "k");
Assert (b ["j"][1], "l");
}
static void CheckLocalization ()
{
var p = new OptionSet (f => "hello!") {
{ "n=", (int v) => { } },
};
AssertException (typeof(OptionException), "hello!",
p, v => { v.Parse (_("-n=value")); });
StringWriter expected = new StringWriter ();
expected.WriteLine (" -nhello! hello!");
StringWriter actual = new StringWriter ();
p.WriteOptionDescriptions (actual);
Assert (actual.ToString (), expected.ToString ());
}
class CiOptionSet : OptionSet {
protected override void InsertItem (int index, Option item)
{
if (item.Prototype.ToLower () != item.Prototype)
throw new ArgumentException ("prototypes must be null!");
base.InsertItem (index, item);
}
protected override bool Parse (string option, OptionContext c)
{
if (c.Option != null)
return base.Parse (option, c);
string f, n, s, v;
if (!GetOptionParts (option, out f, out n, out s, out v)) {
return base.Parse (option, c);
}
return base.Parse (f + n.ToLower () + (v != null && s != null ? s + v : ""), c);
}
public new Option GetOptionForName (string n)
{
return base.GetOptionForName (n);
}
public void CheckOptionParts (string option, bool er, string ef, string en, string es, string ev)
{
string f, n, s, v;
bool r = GetOptionParts (option, out f, out n, out s, out v);
Assert (r, er);
Assert (f, ef);
Assert (n, en);
Assert (s, es);
Assert (v, ev);
}
}
static void CheckDerivedType ()
{
bool help = false;
var p = new CiOptionSet () {
{ "h|help", v => help = v != null },
};
p.Parse (_("-H"));
Assert (help, true);
help = false;
p.Parse (_("-HELP"));
Assert (help, true);
Assert (p.GetOptionForName ("h"), p [0]);
Assert (p.GetOptionForName ("help"), p [0]);
Assert (p.GetOptionForName ("invalid"), null);
AssertException (typeof(ArgumentException), "prototypes must be null!",
p, v => { v.Add ("N|NUM=", (int n) => {}); });
AssertException (typeof(ArgumentNullException),
"Argument cannot be null.\nParameter name: option",
p, v => { v.GetOptionForName (null); });
}
static void CheckOptionParts ()
{
var p = new CiOptionSet ();
p.CheckOptionParts ("A", false, null, null, null, null);
p.CheckOptionParts ("A=B", false, null, null, null, null);
p.CheckOptionParts ("-A=B", true, "-", "A", "=", "B");
p.CheckOptionParts ("-A:B", true, "-", "A", ":", "B");
p.CheckOptionParts ("--A=B", true, "--", "A", "=", "B");
p.CheckOptionParts ("--A:B", true, "--", "A", ":", "B");
p.CheckOptionParts ("/A=B", true, "/", "A", "=", "B");
p.CheckOptionParts ("/A:B", true, "/", "A", ":", "B");
p.CheckOptionParts ("-A=B=C", true, "-", "A", "=", "B=C");
p.CheckOptionParts ("-A:B=C", true, "-", "A", ":", "B=C");
p.CheckOptionParts ("-A:B:C", true, "-", "A", ":", "B:C");
p.CheckOptionParts ("--A=B=C", true, "--", "A", "=", "B=C");
p.CheckOptionParts ("--A:B=C", true, "--", "A", ":", "B=C");
p.CheckOptionParts ("--A:B:C", true, "--", "A", ":", "B:C");
p.CheckOptionParts ("/A=B=C", true, "/", "A", "=", "B=C");
p.CheckOptionParts ("/A:B=C", true, "/", "A", ":", "B=C");
p.CheckOptionParts ("/A:B:C", true, "/", "A", ":", "B:C");
p.CheckOptionParts ("-AB=C", true, "-", "AB", "=", "C");
p.CheckOptionParts ("-AB:C", true, "-", "AB", ":", "C");
}
class ContextCheckerOption : Option {
string eName, eValue;
int index;
public ContextCheckerOption (string p, string d, string eName, string eValue, int index)
: base (p, d)
{
this.eName = eName;
this.eValue = eValue;
this.index = index;
}
protected override void OnParseComplete (OptionContext c)
{
Assert (c.OptionValues.Count, 1);
Assert (c.OptionValues [0], eValue);
Assert (c.OptionName, eName);
Assert (c.OptionIndex, index);
Assert (c.Option, this);
Assert (c.Option.Description, base.Description);
}
}
static void CheckOptionContext ()
{
var p = new OptionSet () {
new ContextCheckerOption ("a=", "a desc", "/a", "a-val", 1),
new ContextCheckerOption ("b", "b desc", "--b+", "--b+", 2),
new ContextCheckerOption ("c=", "c desc", "--c", "C", 3),
new ContextCheckerOption ("d", "d desc", "/d-", null, 4),
};
Assert (p.Count, 4);
p.Parse (_("/a", "a-val", "--b+", "--c=C", "/d-"));
}
}
}
#endif