This repository contains the code for my port of the GNU getopt functionality found on most Unix-like systems.
getopt.net is written entirely in C# and is a "cleanroom port"; although not necessary it made the project that much more fun :)
There are several methods of installing and using getopt.net in your project.
- Add the repository as a submodule, checkout a tag and include it as a project reference in your solution
- Use the NuGet package manager:
install-package getopt.net-bsd
Note the-bsd
ending which shows the license used and not system requirements! getopt.net was already in use :(
--long-opts
--long-opts=with_options
--long-opts with_options
-ShortOpTs
-ShortsWithOpTi0n5
-s with_opts
/h
(short opts)/long-opts
/hxcfsdf
(GNU-style short opts!)/long-opts:with-win-style-args
/long-opts with-args-separated-by-space
/long-opts=with-posix-separator
/fmyfile
(short opts with parameters!)
-myoption
-myoption=argument
-myoption:argument
(AllowWindowsConvention must also be enabled!)-myoption argument
-myoption
argument
-s
-S value
-S
value
-tMxSvalue
Some applications, such as GCC, allow passing of paramfile arguments. A paramfile is a line-separated text file which contains one option (and argument) per line. Each line of the paramfile is parsed as if it were passed to getopt.net directly.
Syntax:
myapp @/path/to/paramfile
:
denotes a required argument!
;
denotes an optional argument!
If none of the above is present after a character in ShortOpts
, then no argument is required.
getopt.ShortOpts = "abC:dE:f:GhIjkLmnop:q:r;";
If getopt.ShortOpts
is prefixed by a +
, or the environment variable POSIXLY_CORRECT
is set, then getopt.net will stop processing more options as soon when the first non-option string is found.
If getopt.ShortOpts
is prefixed by a -
, then each non-option string will be treated as if it were the argument to an option with the value 1
.
getopt.Options = new[] {
new Option { Name = "help", ArgumentType = ArgumentType.None, Value = 'h' }, // brace-initialiser
new Option("config", ArgumentType.Required, 'c'), // standard constructor
new Option("version", ArgumentType.Optional, 'v')
};
Most developers will have experienced this at some point when using getopt
; you added an option to your long opts, but forgot it in your shortopt string.
getopt.net improves this behaviour and will check the Options
array to see if the option you've provided is there.
getopt.net can be configured to not throw exceptions if that's your thing.
Just set the IgnoreXXX
options to true
, and getopt.net will ignore bad user input!
If IgnoreInvalidOptions
is enabled, entering an unknown option won't throw an exception, but instead a !
will be returned.
If IgnoreMissingArguments
is enabled, forgetting to add a required argument won't thow an exception either! Instead, ?
will be returned.
The exceptions do contain more info, however.
For a more detailled description of using getopt.net, please consult the Wiki.
using getopt.net;
static void Main(string[] args) {
var getopt = new Getopt {
Options = new[] {
new Option("help", ArgumentType.None, 'h'),
new Option("version", ArgumentType.None, 'v'),
// or, alternatively
new Option { Name = "config", ArgumentType.Required, 'c' }
},
ShortOpts = "hvc:",
AppArgs = args, // REQUIRED
OnlyShortOpts = false,
// AllowWindowsConventions = true, // enable this for Windows-style options
// other options here
};
int opt = 0;
// GetNextOpt may throw exceptions, depending on your settings!
while ((opt = getopt.GetNextOpt(out var optArg)) != -1) {
switch (opt) {
case 'h':
// print help or something
break;
//
}
}
}
Imports getopt.net
module Program
Dim _progOptions() As [Option] = {
New [Option]("help", ArgumentType.None, "h"c),
New [Option]("version", ArgumentType.None, "v"c),
New [Option]("file", ArgumentType.Required, "f"c)
}
Dim _progShortOptions As String = "hvf:"
sub Main(args as string())
Dim getopt = New GetOpt With {
.AppArgs = args,
.Options = _progOptions,
.ShortOpts = _progShortOptions,
' .AllowWindowsConventions = true ' enable me for Windows-style options!
}
Dim optChar = 0
Dim optArg As String = Nothing
Dim fileToRead As String = Nothing
While optChar <> -1
optChar = getopt.GetNextOpt(optArg)
Select Case optChar
Case Convert.ToInt32("h"c)
' do something
Return
Case Convert.ToInt32("v"c)
' do something else
Return
Case Convert.ToInt32("f"c)
' do something with optArg
End Select
End While
end sub
end module
If you encounter a bug, please add a GitHub Issue and/or create a fork of the project and create a pull request.