Compare commits
9
Commits
d1b8884554
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
45addc5822 | ||
|
|
be34abc683 | ||
|
|
b3d9634a91 | ||
|
|
c04b004f9c | ||
|
|
2fa8bf4024 | ||
|
|
a8c2df53c2 | ||
|
|
e7b877cbad | ||
|
|
1210cc5a4c | ||
|
|
45610c07f4 |
+19
@@ -0,0 +1,19 @@
|
|||||||
|
# zlib License
|
||||||
|
|
||||||
|
(C) 2026 Simon Kellet
|
||||||
|
|
||||||
|
This software is provided 'as-is', without any express or implied
|
||||||
|
warranty. In no event will the authors be held liable for any damages
|
||||||
|
arising from the use of this software.
|
||||||
|
|
||||||
|
Permission is granted to anyone to use this software for any purpose,
|
||||||
|
including commercial applications, and to alter it and redistribute it
|
||||||
|
freely, subject to the following restrictions:
|
||||||
|
|
||||||
|
1. The origin of this software must not be misrepresented; you must not
|
||||||
|
claim that you wrote the original software. If you use this software
|
||||||
|
in a product, an acknowledgment in the product documentation would be
|
||||||
|
appreciated but is not required.
|
||||||
|
2. Altered source versions must be plainly marked as such, and must not be
|
||||||
|
misrepresented as being the original software.
|
||||||
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
@@ -19,8 +19,7 @@ This a very simple implementation of Go-like flags in Odin
|
|||||||
|
|
||||||
fleg.parse_flags()
|
fleg.parse_flags()
|
||||||
```
|
```
|
||||||
|
You can also marks flags as **required**. These will still be parsed, however will hault the application until they are passed:
|
||||||
You can also marks flags as **required"**. These will still be parsed, however will hault the application until they are passed:
|
|
||||||
|
|
||||||
```odin
|
```odin
|
||||||
import "fleg"
|
import "fleg"
|
||||||
@@ -29,14 +28,14 @@ You can also marks flags as **required"**. These will still be parsed, however w
|
|||||||
fleg.parse_flags()
|
fleg.parse_flags()
|
||||||
```
|
```
|
||||||
|
|
||||||
***Supports: bool, int, string, f32***
|
|
||||||
|
|
||||||
And on the command line, you pass flags like so:
|
And on the command line, you pass flags like so:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./<program name> -isNumber=45 -isRunning=false ......
|
./<program name> -isNumber=45 -isRunning=false ......
|
||||||
```
|
```
|
||||||
|
|
||||||
|
***Supports: bool, int, string, f32 and f64***
|
||||||
|
|
||||||
## Help flag:
|
## Help flag:
|
||||||
|
|
||||||
The package also contains a help context menu. This comes default and can be called like so (**Note:** You can also use "-h" or "--help"):
|
The package also contains a help context menu. This comes default and can be called like so (**Note:** You can also use "-h" or "--help"):
|
||||||
@@ -93,6 +92,10 @@ If needed, you are able to setup a custom allocator like so:
|
|||||||
defer fleg.destroy() //clean up flags
|
defer fleg.destroy() //clean up flags
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Mirror
|
||||||
|
|
||||||
|
This repo is being developed on Gitea [here](https://git.simonkellet.xyz/simonkellet/odin-flags). The Github ([here](https://github.com/simonkellet404/odin-flags)) is a mirror.
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
* More type support
|
* More type support
|
||||||
|
|||||||
+88
-13
@@ -33,14 +33,18 @@ FORCE_HELP_ON_EMPTY_ARGS := false
|
|||||||
FLAG_START_CHAR := "-"
|
FLAG_START_CHAR := "-"
|
||||||
FLAG_SEP_CHAR := "="
|
FLAG_SEP_CHAR := "="
|
||||||
|
|
||||||
|
@(private)
|
||||||
Flag_Value_Ptr :: union {
|
Flag_Value_Ptr :: union {
|
||||||
^bool,
|
^bool,
|
||||||
^int,
|
^int,
|
||||||
|
^i32,
|
||||||
|
^i64,
|
||||||
^string,
|
^string,
|
||||||
^f32,
|
^f32,
|
||||||
^f64,
|
^f64,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@(private)
|
||||||
Flag :: struct {
|
Flag :: struct {
|
||||||
name: string,
|
name: string,
|
||||||
value: Flag_Value_Ptr,
|
value: Flag_Value_Ptr,
|
||||||
@@ -50,9 +54,11 @@ Flag :: struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Global dynamic array of Flags
|
// Global dynamic array of Flags
|
||||||
|
@(private)
|
||||||
all_flags: [dynamic]Flag
|
all_flags: [dynamic]Flag
|
||||||
|
|
||||||
// runtime allocator for the flags
|
// runtime allocator for the flags
|
||||||
|
@(private)
|
||||||
flag_allocator: runtime.Allocator
|
flag_allocator: runtime.Allocator
|
||||||
|
|
||||||
// sck: Used to create a customer allocator
|
// sck: Used to create a customer allocator
|
||||||
@@ -64,82 +70,130 @@ init_custom_allocator :: proc(allocator: runtime.Allocator) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
destroy :: proc() {
|
destroy :: proc() {
|
||||||
|
free_all(flag_allocator)
|
||||||
delete(all_flags)
|
delete(all_flags)
|
||||||
all_flags = {} // sck: needed?
|
all_flags = {}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@(private)
|
||||||
print_flags :: proc() {
|
print_flags :: proc() {
|
||||||
for f in all_flags {
|
for f in all_flags {
|
||||||
fmt.printfln("%s: %s (required=%v)", f.name, f.usage, f.required)
|
fmt.printfln("%s: %s (required=%v)", f.name, f.usage, f.required)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@(private)
|
||||||
print_flag_format :: proc(){
|
print_flag_format :: proc(){
|
||||||
fmt.printfln("Want %s<flag>%s<value>\n", FLAG_START_CHAR, FLAG_SEP_CHAR)
|
fmt.printfln("Want %s<flag>%s<value>\n", FLAG_START_CHAR, FLAG_SEP_CHAR)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@(private)
|
||||||
print_usage :: proc() {
|
print_usage :: proc() {
|
||||||
fmt.println("\tUsage: ")
|
fmt.println("\tUsage: ")
|
||||||
fmt.println("\n\tFlag format for this program:")
|
fmt.println("\n\tFlag format for this program:")
|
||||||
fmt.printfln("\t%s<flag>%s<value>\n", FLAG_START_CHAR, FLAG_SEP_CHAR)
|
fmt.printfln("\t%s<flag>%s<value>\n", FLAG_START_CHAR, FLAG_SEP_CHAR)
|
||||||
|
|
||||||
for f in all_flags {
|
for f in all_flags {
|
||||||
|
req_msg: string
|
||||||
|
if f.required { req_msg = " (required)"}
|
||||||
switch v in f.value {
|
switch v in f.value {
|
||||||
case ^bool:
|
case ^bool:
|
||||||
fmt.printfln("\t%s%s:\n\t\t%s (default: %v)\n", FLAG_START_CHAR, f.name, f.usage, v^)
|
fmt.printfln("\t%s%s:\n\t\t%s (default: %v)%s\n", FLAG_START_CHAR, f.name, f.usage, v^, req_msg)
|
||||||
case ^int:
|
case ^int:
|
||||||
fmt.printfln("\t%s%s:\n\t\t%s (default: %d)\n", FLAG_START_CHAR, f.name, f.usage, v^)
|
fmt.printfln("\t%s%s:\n\t\t%s (default: %d)%s\n", FLAG_START_CHAR, f.name, f.usage, v^, req_msg)
|
||||||
|
case ^i32:
|
||||||
|
fmt.printfln("\t%s%s:\n\t\t%s (default: %d)%s\n", FLAG_START_CHAR, f.name, f.usage, v^, req_msg)
|
||||||
|
case ^i64:
|
||||||
|
fmt.printfln("\t%s%s:\n\t\t%s (default: %d)%s\n", FLAG_START_CHAR, f.name, f.usage, v^, req_msg)
|
||||||
case ^string:
|
case ^string:
|
||||||
fmt.printfln("\t%s%s:\n\t\t%s (default: %s)\n", FLAG_START_CHAR, f.name, f.usage, v^)
|
fmt.printfln("\t%s%s:\n\t\t%s (default: %s)%s\n", FLAG_START_CHAR, f.name, f.usage, v^, req_msg)
|
||||||
case ^f32:
|
case ^f32:
|
||||||
fmt.printfln("\t%s%s:\n\t\t%s (default: %f)\n", FLAG_START_CHAR, f.name, f.usage, v^)
|
fmt.printfln("\t%s%s:\n\t\t%s (default: %f)%s\n", FLAG_START_CHAR, f.name, f.usage, v^, req_msg)
|
||||||
case ^f64:
|
case ^f64:
|
||||||
fmt.printfln("\t%s%s:\n\t\t%s (default: %f)\n", FLAG_START_CHAR, f.name, f.usage, v^)
|
fmt.printfln("\t%s%s:\n\t\t%s (default: %f)%s\n", FLAG_START_CHAR, f.name, f.usage, v^, req_msg)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
BoolVar :: proc(ptr: ^bool, name: string, default: bool, usage: string, required := false) {
|
BoolVar :: proc(ptr: ^bool, name: string, default: bool, usage: string, required := false) {
|
||||||
|
if ptr == nil {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR]: Invalid usage of BoolVar: got nil for 'ptr' value!")
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
ptr^ = default
|
ptr^ = default
|
||||||
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
||||||
}
|
}
|
||||||
|
|
||||||
IntVar :: proc(ptr: ^int, name: string, default: int, usage: string, required := false) {
|
IntVar :: proc(ptr: ^int, name: string, default: int, usage: string, required := false) {
|
||||||
|
if ptr == nil {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR]: Invalid usage of IntVar: got nil for 'ptr' value!")
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
|
ptr^ = default
|
||||||
|
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
||||||
|
}
|
||||||
|
|
||||||
|
Int32Var :: proc(ptr: ^i32, name: string, default: i32, usage: string, required := false) {
|
||||||
|
if ptr == nil {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR]: Invalid usage of Int32Var: got nil for 'ptr' value!")
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
|
ptr^ = default
|
||||||
|
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
||||||
|
}
|
||||||
|
|
||||||
|
Int64Var :: proc(ptr: ^i64, name: string, default: i64, usage: string, required := false) {
|
||||||
|
if ptr == nil {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR]: Invalid usage of Int32Var: got nil for 'ptr' value!")
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
ptr^ = default
|
ptr^ = default
|
||||||
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
||||||
}
|
}
|
||||||
|
|
||||||
StringVar :: proc(ptr: ^string, name: string, default: string, usage: string, required := false) {
|
StringVar :: proc(ptr: ^string, name: string, default: string, usage: string, required := false) {
|
||||||
|
if ptr == nil {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR]: Invalid usage of StringVar: got nil for 'ptr' value!")
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
ptr^ = default
|
ptr^ = default
|
||||||
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
||||||
}
|
}
|
||||||
|
|
||||||
Float32Var :: proc(ptr: ^f32, name: string, default: f32, usage: string, required := false) {
|
Float32Var :: proc(ptr: ^f32, name: string, default: f32, usage: string, required := false) {
|
||||||
|
if ptr == nil {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR]: Invalid usage of Float32Var: got nil for 'ptr' value!")
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
ptr^ = default
|
ptr^ = default
|
||||||
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
||||||
}
|
}
|
||||||
|
|
||||||
Float64Var :: proc(ptr: ^f64, name: string, default: f64, usage: string, required := false) {
|
Float64Var :: proc(ptr: ^f64, name: string, default: f64, usage: string, required := false) {
|
||||||
|
if ptr == nil {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR]: Invalid usage of Float64Var: got nil for 'ptr' value!")
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
ptr^ = default
|
ptr^ = default
|
||||||
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
append(&all_flags, Flag{name = name, value = ptr, usage = usage, required = required})
|
||||||
}
|
}
|
||||||
|
|
||||||
parse_flags :: proc() {
|
parse_flags :: proc() {
|
||||||
defer destroy()
|
|
||||||
// sck: We cannot have the start and seperator formats being the same
|
// sck: We cannot have the start and seperator formats being the same
|
||||||
if FLAG_START_CHAR == FLAG_SEP_CHAR {
|
if FLAG_START_CHAR == FLAG_SEP_CHAR {
|
||||||
fmt.println("[ERROR]: FLAG_START_CHAR and FLAG_SEP_CHAR cannot be the same!")
|
fmt.fprintfln(os.stderr, "[ERROR]: FLAG_START_CHAR and FLAG_SEP_CHAR cannot be the same!")
|
||||||
fmt.printfln("\t FLAG_START_CHAR= \"%s\"\t FLAG_SEP_CHAR= \"%s\"", FLAG_START_CHAR, FLAG_SEP_CHAR)
|
fmt.printfln("\t FLAG_START_CHAR= \"%s\"\t FLAG_SEP_CHAR= \"%s\"", FLAG_START_CHAR, FLAG_SEP_CHAR)
|
||||||
os.exit(1)
|
os.exit(1)
|
||||||
}
|
}
|
||||||
if len(os.args) < 2 && FORCE_HELP_ON_EMPTY_ARGS {print_usage()}
|
if len(os.args) < 2 && FORCE_HELP_ON_EMPTY_ARGS {print_usage()}
|
||||||
|
|
||||||
// sck: skip the first arg
|
// skip the first arg (1:)
|
||||||
for &a in os.args[1:] {
|
for &a in os.args[1:] {
|
||||||
if a == "-h" || a == "-help" || a == "--help" {print_usage(); os.exit(0)}
|
if a == "-h" || a == "-help" || a == "--help" {print_usage(); os.exit(0)}
|
||||||
// sck: if the user has a custom flag format, copy that to the help flag too.
|
// sck: if the user has a custom flag format, copy that to the help flag too.
|
||||||
if a == fmt.aprintf("%s%s", FLAG_START_CHAR, "help", allocator = flag_allocator) {print_usage(); os.exit(0)}
|
if a == fmt.aprintf("%s%s", FLAG_START_CHAR, "help", allocator = context.temp_allocator) {print_usage(); os.exit(0)}
|
||||||
if a == fmt.aprintf("%s%s", FLAG_START_CHAR, "h", allocator = flag_allocator) {print_usage(); os.exit(0)}
|
if a == fmt.aprintf("%s%s", FLAG_START_CHAR, "h", allocator = context.temp_allocator) {print_usage(); os.exit(0)}
|
||||||
|
defer free_all(context.temp_allocator) //clean up!
|
||||||
|
|
||||||
// Begin parsing flags...
|
// Begin parsing flags...
|
||||||
for &f in all_flags {
|
for &f in all_flags {
|
||||||
@@ -184,6 +238,26 @@ parse_flags :: proc() {
|
|||||||
}
|
}
|
||||||
v^ = parsed
|
v^ = parsed
|
||||||
|
|
||||||
|
case ^i32:
|
||||||
|
if value == "" {break}
|
||||||
|
parsed, ok := strconv.parse_int(value)
|
||||||
|
if !ok {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR] Failed to parse flag %s: got %T, wanted int",
|
||||||
|
f.name, value)
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
|
v^ = cast(i32)parsed
|
||||||
|
|
||||||
|
case ^i64:
|
||||||
|
if value == "" {break}
|
||||||
|
parsed, ok := strconv.parse_i64(value)
|
||||||
|
if !ok {
|
||||||
|
fmt.fprintfln(os.stderr, "[ERROR] Failed to parse flag %s: got %T, wanted int",
|
||||||
|
f.name, value)
|
||||||
|
os.exit(1)
|
||||||
|
}
|
||||||
|
v^ = parsed
|
||||||
|
|
||||||
case ^string:
|
case ^string:
|
||||||
if value == "" {break}
|
if value == "" {break}
|
||||||
// TODO: validate string?
|
// TODO: validate string?
|
||||||
@@ -215,8 +289,9 @@ parse_flags :: proc() {
|
|||||||
|
|
||||||
for f in all_flags {
|
for f in all_flags {
|
||||||
if f.required && !f.parsed {
|
if f.required && !f.parsed {
|
||||||
fmt.fprintfln(os.stderr, "[ERROR] Missing required flag: %s%s", FLAG_START_CHAR, f.name)
|
// sck: INFO or ERROR?
|
||||||
print_usage()
|
fmt.fprintfln(os.stderr, "[INFO] Missing required flag: %s%s", FLAG_START_CHAR, f.name)
|
||||||
|
if !FORCE_HELP_ON_EMPTY_ARGS {fmt.fprintfln(os.stderr, "use -help or -h to view all flags")}
|
||||||
os.exit(1)
|
os.exit(1)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user