Inheritance diagram for Ntp.Common.IO.Option:

Public Member Functions
string[]	GetNames ()

string[]	GetValueSeparators ()

void	Invoke (OptionContext c)

override string	ToString ()

Protected Member Functions
	Option (string prototype, string description)

	Option (string prototype, string description, int maxValueCount)

	Option (string prototype, string description, int maxValueCount, bool hidden)

abstract void	OnParseComplete (OptionContext c)

Static Protected Member Functions
static T	Parse< T > (string value, OptionContext c)

Properties
string	Description `[get]`

bool	Hidden `[get]`

int	MaxValueCount `[get]`

string[]	Names `[get]`

OptionValueType	OptionValueType `[get]`

string	Prototype `[get]`

string[]	ValueSeparators `[get, private set]`

Private Member Functions
OptionValueType	ParsePrototype ()

Static Private Member Functions
static void	AddSeparators (string name, int end, ICollection< string > seps)

Static Private Attributes
static readonly char[]	NameTerminator = {'=', ':'}

Detailed Description

Definition at line 450 of file Options.cs.

Constructor & Destructor Documentation

Ntp.Common.IO.Option.Option	(	string	prototype,
		string	description
	)

inlineprotected

Definition at line 452 of file Options.cs.

             : this(prototype, description, 1, false)
         {
         }

Ntp.Common.IO.Option.Option	(	string	prototype,
		string	description,
		int	maxValueCount
	)

inlineprotected

Definition at line 457 of file Options.cs.

             : this(prototype, description, maxValueCount, false)
         {
         }

Ntp.Common.IO.Option.Option	(	string	prototype,
		string	description,
		int	maxValueCount,
		bool	hidden
	)

inlineprotected

Definition at line 463 of file Options.cs.

         {
             if (prototype == null)
                 throw new ArgumentNullException(nameof(prototype));
             if (prototype.Length == 0)
                 throw new ArgumentException("Cannot be the empty string.", nameof(prototype));
             if (maxValueCount < 0)
                 throw new ArgumentOutOfRangeException(nameof(maxValueCount));
 
             Prototype = prototype;
             Description = description;
             MaxValueCount = maxValueCount;
             Names = this is OptionSet.Category
                 // append GetHashCode() so that "duplicate" categories have distinct
                 // names, e.g. adding multiple "" categories should be valid.
                 // ReSharper disable once VirtualMemberCallInConstructor
                 ? new[] {prototype + GetHashCode()}
                 : prototype.Split('|');
 
             if (this is OptionSet.Category)
                 return;
 
             OptionValueType = ParsePrototype();
             Hidden = hidden;
 
             if (MaxValueCount == 0 && OptionValueType != OptionValueType.None)
                 throw new ArgumentException(
                     "Cannot provide maxValueCount of 0 for OptionValueType.Required or " +
                     "OptionValueType.Optional.",
                     nameof(maxValueCount));
 
             if (OptionValueType == OptionValueType.None && maxValueCount > 1)
                 throw new ArgumentException(
                     $"Cannot provide maxValueCount of {maxValueCount} for OptionValueType.None.",
                     nameof(maxValueCount));
 
             if (Array.IndexOf(Names, "<>") >= 0 &&
                 ((Names.Length == 1 && OptionValueType != OptionValueType.None) ||
                  (Names.Length > 1 && MaxValueCount > 1)))
                 throw new ArgumentException(
                     "The default option handler '<>' cannot require values.",
                     nameof(prototype));
         }

Member Function Documentation

static void Ntp.Common.IO.Option.AddSeparators	(	string	name,
		int	end,
		ICollection< string >	seps
	)

inlinestaticprivate

Definition at line 582 of file Options.cs.

         {
             var start = -1;
             for (var i = end + 1; i < name.Length; ++i)
             {
                 switch (name[i])
                 {
                     case '{':
                         if (start != -1)
                             throw new ArgumentException($"Ill-formed name/value separator found in \"{name}\".");
                         start = i + 1;
                         break;
                     case '}':
                         if (start == -1)
                             throw new ArgumentException($"Ill-formed name/value separator found in \"{name}\".");
                         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($"Ill-formed name/value separator found in \"{name}\".");
         }

string [] Ntp.Common.IO.Option.GetNames ( )

inline

Definition at line 523 of file Options.cs.

         {
             return (string[]) Names.Clone();
         }

string [] Ntp.Common.IO.Option.GetValueSeparators ( )

inline

Definition at line 528 of file Options.cs.

         {
             if (ValueSeparators == null)
                 return new string[0];
             return (string[]) ValueSeparators.Clone();
         }

void Ntp.Common.IO.Option.Invoke ( OptionContext c )

inline

Definition at line 535 of file Options.cs.

References Ntp.Common.IO.OptionValueCollection.Clear(), Ntp.Common.IO.OptionContext.Option, Ntp.Common.IO.OptionContext.OptionName, and Ntp.Common.IO.OptionContext.OptionValues.

Referenced by Ntp.Common.IO.OptionSet.Invoke(), Ntp.Common.IO.OptionSet.Parse(), and Ntp.Common.IO.OptionSet.Unprocessed().

         {
             OnParseComplete(c);
             c.OptionName = null;
             c.Option = null;
             c.OptionValues.Clear();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

abstract void Ntp.Common.IO.Option.OnParseComplete ( OptionContext c )

protectedpure virtual

Implemented in Ntp.Common.IO.OptionSet.ActionOption< TKey, TValue >, Ntp.Common.IO.OptionSet.ActionOption< TKey, TValue >, Ntp.Common.IO.OptionSet.ActionOption< TKey, TValue >, and Ntp.Common.IO.OptionSet.Category.

static T Ntp.Common.IO.Option.Parse< T >	(	string	value,
		OptionContext	c
	)

inlinestaticprotected

Definition at line 550 of file Options.cs.

References e, Ntp.Common.IO.OptionSet.MessageLocalizer, Ntp.Common.IO.OptionContext.OptionName, and Ntp.Common.IO.OptionContext.OptionSet.

         {
             var tt = typeof(T);
             var ti = tt;
 
             var nullable =
                 ti.IsValueType &&
                 ti.IsGenericType &&
                 !ti.IsGenericTypeDefinition &&
                 ti.GetGenericTypeDefinition() == typeof(Nullable<>);
 
             var targetType = nullable ? tt.GetGenericArguments()[0] : tt;
             var t = default(T);
             try
             {
                 if (value != null)
                 {
                     var conv = TypeDescriptor.GetConverter(targetType);
                     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, targetType.Name, c.OptionName),
                     c.OptionName, e);
             }
             return t;
         }

OptionValueType Ntp.Common.IO.Option.ParsePrototype ( )

inlineprivate

Definition at line 611 of file Options.cs.

         {
             var type = '\0';
             var seps = new List<string>();
 
             for (var i = 0; i < Names.Length; ++i)
             {
                 var name = Names[i];
                 if (name.Length == 0)
                     throw new ArgumentException("Empty option names are not supported.");
 
                 var 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($"Conflicting option types: '{type}' vs. '{name[end]}'.");
                 AddSeparators(name, end, seps);
             }
 
             if (type == '\0')
                 return OptionValueType.None;
 
             if (MaxValueCount <= 1 && seps.Count != 0)
                 throw new ArgumentException(
                     $"Cannot provide key/value separators for Options taking {MaxValueCount} value(s).");
 
             if (MaxValueCount > 1)
             {
                 if (seps.Count == 0)
                     ValueSeparators = new[] {":", "="};
                 else if (seps.Count == 1 && seps[0].Length == 0)
                     ValueSeparators = null;
                 else
                     ValueSeparators = seps.ToArray();
             }
 
             return type == '=' ? OptionValueType.Required : OptionValueType.Optional;
         }

override string Ntp.Common.IO.Option.ToString ( )

inline

Definition at line 543 of file Options.cs.

         {
             return Prototype;
         }

Member Data Documentation

readonly char [] Ntp.Common.IO.Option.NameTerminator = {'=', ':'}

staticprivate

Definition at line 507 of file Options.cs.

Property Documentation

string Ntp.Common.IO.Option.Description

get

Definition at line 511 of file Options.cs.

Referenced by Ntp.Common.IO.OptionSet.WriteOptionPrototype().

bool Ntp.Common.IO.Option.Hidden

get

Definition at line 517 of file Options.cs.

int Ntp.Common.IO.Option.MaxValueCount

get

Definition at line 515 of file Options.cs.

Referenced by Ntp.Common.IO.OptionSet.WriteOptionPrototype().

string [] Ntp.Common.IO.Option.Names

getpackage

Definition at line 519 of file Options.cs.

Referenced by Ntp.Common.IO.OptionSet.AddImpl(), Ntp.Common.IO.OptionSet.GetKeyForItem(), and Ntp.Common.IO.OptionSet.WriteOptionPrototype().

OptionValueType Ntp.Common.IO.Option.OptionValueType

get

Definition at line 513 of file Options.cs.

Referenced by Ntp.Common.IO.OptionSet.WriteOptionPrototype().

string Ntp.Common.IO.Option.Prototype

get

Definition at line 509 of file Options.cs.

string [] Ntp.Common.IO.Option.ValueSeparators

getprivate setpackage

Definition at line 521 of file Options.cs.

Referenced by Ntp.Common.IO.OptionSet.WriteOptionPrototype().

The documentation for this class was generated from the following file:

Ntp.Common/IO/Options.cs

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Private Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation