Last active
April 26, 2016 16:53
-
-
Save jsmarble/8d90828b11dc4fd3724c89b148e1d0ca to your computer and use it in GitHub Desktop.
argument-parser
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
public class Argument | |
{ | |
public Argument(string prefix) | |
: this(prefix, null) | |
{ | |
} | |
public Argument(string prefix, IEnumerable<string> values) | |
{ | |
this.Values = new List<string>(); | |
this.Prefix = prefix; | |
if (values != null) | |
this.Values.AddRange(values); | |
} | |
public string Prefix { get; private set; } | |
public List<string> Values { get; private set; } | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
public class ArgumentList : List<Argument> | |
{ | |
public ArgumentList() | |
{ | |
} | |
public ArgumentList(IEnumerable<Argument> collection) : base(collection) | |
{ | |
} | |
public List<Argument> Find(params string[] prefixes) | |
{ | |
return this.Where(x => prefixes.Contains(x.Prefix, StringComparer.CurrentCultureIgnoreCase)).ToList(); | |
} | |
public string GetValue(params string[] prefixes) | |
{ | |
return Find(prefixes).FirstOrDefault()?.Values.FirstOrDefault(); | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
public class ArgumentParser | |
{ | |
public static readonly char[] ArgumentPrefixes; | |
static ArgumentParser() | |
{ | |
ArgumentParser.ArgumentPrefixes = BuildArgumentPrefixes(); | |
} | |
public ArgumentList Parse(string[] args) | |
{ | |
ArgumentList results = new ArgumentList(); | |
Argument currentArg = null; | |
Argument blankArg = new Argument(""); | |
foreach (string arg in args) | |
{ | |
if (ValueIsArgPrefix(arg)) | |
{ | |
var a = arg.TrimStart(ArgumentParser.ArgumentPrefixes); | |
currentArg = results.Find(a).FirstOrDefault(); | |
if (currentArg == null) | |
{ | |
currentArg = new Argument(a); | |
results.Add(currentArg); | |
} | |
} | |
else | |
{ | |
Argument a = currentArg ?? blankArg; | |
a.Values.Add(arg); | |
currentArg = null; | |
} | |
} | |
if (blankArg.Values.Count > 0) | |
results.Add(blankArg); | |
return results; | |
} | |
private static bool ValueIsArgPrefix(string value) | |
{ | |
if (string.IsNullOrEmpty(value)) | |
return false; | |
return ArgumentParser.ArgumentPrefixes.Any(c => value[0] == c); | |
} | |
private static char[] BuildArgumentPrefixes() | |
{ | |
return new char[] { '-', '/' }; | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Argument Parser
Description
A set of C# classes for intelligently parsing command line arguments into a usable collection of arguments and values.
Usage
ArgumentParser
The main class used is
ArgumentParser
. Instantiate an instance ofArgumentParser
then call theParse()
function, passing instring[] args
. The result of the function is anArgumentList
object, containingArgument
objects representing the arguments passed. TheArgumentParser
combines arguments with the same prefixes and aggregates the values.ArgumentParser
will also include a "blank" argument, containing the values that were not prefixed with an argument, if any exist.ArgumentParser
supports arguments using either-
or/
prefixes for arguments. It also supports--
with full argument names. Arguments may be specified without any values as well.Examples
Arguments:
"--user bob -p"
Result (visualized in JSON):
[ {"prefix":"user", "values": [ "bob" ]}, {"prefix":"p", "values": []} ]
Arguments:
"-a sha1 File1.txt -a sha256 File2.txt -o output.txt"
Result (visualized in JSON):
[ {"prefix":"a", "values": [ "sha1", "sha256" ]}, {"prefix":"o", "values": [ "output.txt" ]}, {"prefix":"", "values": [ "File1.txt", "File2.txt" ]} ]
ArgumentList
ArgumentList also contains a
Find()
method to help find arguments. It supports passing multiple argument and will return an ArgumentList with just the desired arguments. Omit the argument prefix for the desired arguments.Examples
License
MIT License
Copyright (c) [2016] [jsmarble]
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.