x/box-o-sand
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

arghing #1

Merged
meatballhat merged 23 commits from arghing into main 2022-06-06 22:44:25 +00:00
Conversation 0 Commits 23 Files Changed 18 +223 -105
5 changed files with 223 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit b2e61cd0d2 - Show all commits

4
argh/README.md Normal file
View File

@ -0,0 +1,4 @@
# argh command line parser
> NOTE: much of this is lifted from
> https://blog.gopheracademy.com/advent-2014/parsers-lexers/

31
argh/argh.go
View File

@ -1,35 +1,46 @@
package argh package argh
import ( import (
"fmt"
"log" "log"
"os" "os"
"path/filepath"
"runtime"
) )
// NOTE: much of this is lifted from
// https://blog.gopheracademy.com/advent-2014/parsers-lexers/
var ( var (
tracingEnabled = os.Getenv("ARGH_TRACING") == "enabled" tracingEnabled = os.Getenv("ARGH_TRACING") == "enabled"
traceLogger *log.Logger
) )
func init() {
if !tracingEnabled {
return
}
traceLogger = log.New(os.Stderr, "ARGH TRACING: ", 0)
}
type Argh struct { type Argh struct {
ParseTree *ParseTree `json:"parse_tree"` ParseTree *ParseTree `json:"parse_tree"`
} }
func (a *Argh) AST() []TypedNode { func (a *Argh) TypedAST() []TypedNode {
return a.ParseTree.toAST() return a.ParseTree.typedAST()
} }
/* func (a *Argh) AST() []Node {
func (a *Argh) String() string { return a.ParseTree.ast()
return a.ParseTree.String()
} }
*/
func tracef(format string, v ...any) { func tracef(format string, v ...any) {
if !tracingEnabled { if !tracingEnabled {
return return
} }
log.Printf(format, v...) if _, file, line, ok := runtime.Caller(2); ok {
format = fmt.Sprintf("%v:%v ", filepath.Base(file), line) + format
}
traceLogger.Printf(format, v...)
} }

49
argh/parse_tree.go
View File

@ -6,7 +6,7 @@ type ParseTree struct {
Nodes []Node `json:"nodes"` Nodes []Node `json:"nodes"`
} }
func (pt *ParseTree) toAST() []TypedNode { func (pt *ParseTree) typedAST() []TypedNode {
ret := []TypedNode{} ret := []TypedNode{}
for _, node := range pt.Nodes { for _, node := range pt.Nodes {
@ -30,6 +30,32 @@ func (pt *ParseTree) toAST() []TypedNode {
return ret return ret
} }
func (pt *ParseTree) ast() []Node {
ret := []Node{}
for _, node := range pt.Nodes {
if _, ok := node.(ArgDelimiter); ok {
continue
}
if _, ok := node.(StopFlag); ok {
continue
}
if v, ok := node.(Statement); ok {
for _, subNode := range v.Nodes {
ret = append(ret, subNode)
}
continue
}
ret = append(ret, node)
}
return ret
}
type Node interface{} type Node interface{}
type TypedNode struct { type TypedNode struct {
@ -38,45 +64,32 @@ type TypedNode struct {
} }
type Args struct { type Args struct {
Pos int `json:"pos"`
Nodes []Node `json:"nodes"` Nodes []Node `json:"nodes"`
} }
type Statement struct { type Statement struct {
Pos int `json:"pos"`
Nodes []Node `json:"nodes"` Nodes []Node `json:"nodes"`
} }
type Program struct { type Program struct {
Pos int `json:"pos"`
Name string `json:"name"` Name string `json:"name"`
} }
type Ident struct { type Ident struct {
Pos int `json:"pos"`
Literal string `json:"literal"` Literal string `json:"literal"`
} }
type Command struct { type Command struct {
Pos int `json:"pos"` Name string `json:"name"`
Name string `json:"name"`
Nodes []Node `json:"nodes"`
} }
type Flag struct { type Flag struct {
Pos int `json:"pos"`
Name string `json:"name"` Name string `json:"name"`
Value *string `json:"value,omitempty"` Value *string `json:"value,omitempty"`
} }
type StdinFlag struct { type StdinFlag struct{}
Pos int `json:"pos"`
}
type StopFlag struct { type StopFlag struct{}
Pos int `json:"pos"`
}
type ArgDelimiter struct { type ArgDelimiter struct{}
Pos int `json:"pos"`
}

26
argh/parser.go
View File

@ -131,43 +131,47 @@ func (p *Parser) nodify() (Node, error) {
switch tok { switch tok {
case IDENT: case IDENT:
if len(p.nodes) == 0 { if len(p.nodes) == 0 {
return Program{Name: lit, Pos: pos - len(lit)}, nil return Program{Name: lit}, nil
} }
return Ident{Literal: lit, Pos: pos - len(lit)}, nil
if _, ok := p.commands[lit]; ok {
return Command{Name: lit}, nil
}
return Ident{Literal: lit}, nil
case ARG_DELIMITER: case ARG_DELIMITER:
return ArgDelimiter{Pos: pos - 1}, nil return ArgDelimiter{}, nil
case COMPOUND_SHORT_FLAG: case COMPOUND_SHORT_FLAG:
flagNodes := []Node{} flagNodes := []Node{}
for i, r := range lit[1:] { for _, r := range lit[1:] {
flagNodes = append( flagNodes = append(
flagNodes, flagNodes,
Flag{ Flag{
Pos: pos + i + 1,
Name: string(r), Name: string(r),
}, },
) )
} }
return Statement{Pos: pos, Nodes: flagNodes}, nil return Statement{Nodes: flagNodes}, nil
case SHORT_FLAG: case SHORT_FLAG:
flagName := string(lit[1:]) flagName := string(lit[1:])
if _, ok := p.valueFlags[flagName]; ok { if _, ok := p.valueFlags[flagName]; ok {
return p.scanValueFlag(flagName, pos) return p.scanValueFlag(flagName, pos)
} }
return Flag{Name: flagName, Pos: pos - len(flagName) - 1}, nil return Flag{Name: flagName}, nil
case LONG_FLAG: case LONG_FLAG:
flagName := string(lit[2:]) flagName := string(lit[2:])
if _, ok := p.valueFlags[flagName]; ok { if _, ok := p.valueFlags[flagName]; ok {
return p.scanValueFlag(flagName, pos) return p.scanValueFlag(flagName, pos)
} }
return Flag{Name: flagName, Pos: pos - len(flagName) - 2}, nil return Flag{Name: flagName}, nil
default: default:
} }
return Ident{Literal: lit, Pos: pos - len(lit)}, nil return Ident{Literal: lit}, nil
} }
func (p *Parser) scanValueFlag(flagName string, pos int) (Node, error) { func (p *Parser) scanValueFlag(flagName string, pos int) (Node, error) {
@ -178,9 +182,7 @@ func (p *Parser) scanValueFlag(flagName string, pos int) (Node, error) {
return nil, err return nil, err
} }
flagSepLen := len("--") + 1 return Flag{Name: flagName, Value: ptr(lit)}, nil
return Flag{Name: flagName, Pos: pos - len(lit) - flagSepLen, Value: ptr(lit)}, nil
} }
func (p *Parser) scanIdent() (string, error) { func (p *Parser) scanIdent() (string, error) {

218
argh/parser_test.go
View File

@ -13,39 +13,41 @@ func ptr[T any](v T) *T {
func TestParser(t *testing.T) { func TestParser(t *testing.T) {
for _, tc := range []struct { for _, tc := range []struct {
name string name string
args []string args []string
cfg *argh.ParserConfig cfg *argh.ParserConfig
expected *argh.Argh expPT []argh.Node
expectedErr error expAST []argh.Node
skip bool expErr error
skip bool
}{ }{
{ {
name: "bare", name: "bare",
args: []string{"pizzas"}, args: []string{"pizzas"},
expected: &argh.Argh{ expPT: []argh.Node{
ParseTree: &argh.ParseTree{ argh.Program{Name: "pizzas"},
Nodes: []argh.Node{ },
argh.Program{Name: "pizzas"}, expAST: []argh.Node{
}, argh.Program{Name: "pizzas"},
},
}, },
}, },
{ {
name: "long value-less flags", name: "long value-less flags",
args: []string{"pizzas", "--tasty", "--fresh", "--super-hot-right-now"}, args: []string{"pizzas", "--tasty", "--fresh", "--super-hot-right-now"},
expected: &argh.Argh{ expPT: []argh.Node{
ParseTree: &argh.ParseTree{ argh.Program{Name: "pizzas"},
Nodes: []argh.Node{ argh.ArgDelimiter{},
argh.Program{Name: "pizzas", Pos: 0}, argh.Flag{Name: "tasty"},
argh.ArgDelimiter{Pos: 6}, argh.ArgDelimiter{},
argh.Flag{Name: "tasty", Pos: 7}, argh.Flag{Name: "fresh"},
argh.ArgDelimiter{Pos: 14}, argh.ArgDelimiter{},
argh.Flag{Name: "fresh", Pos: 15}, argh.Flag{Name: "super-hot-right-now"},
argh.ArgDelimiter{Pos: 22}, },
argh.Flag{Name: "super-hot-right-now", Pos: 23}, expAST: []argh.Node{
}, argh.Program{Name: "pizzas"},
}, argh.Flag{Name: "tasty"},
argh.Flag{Name: "fresh"},
argh.Flag{Name: "super-hot-right-now"},
}, },
}, },
{ {
@ -55,65 +57,151 @@ func TestParser(t *testing.T) {
Commands: []string{}, Commands: []string{},
ValueFlags: []string{"fresh"}, ValueFlags: []string{"fresh"},
}, },
expected: &argh.Argh{ expPT: []argh.Node{
ParseTree: &argh.ParseTree{ argh.Program{Name: "pizzas"},
Nodes: []argh.Node{ argh.ArgDelimiter{},
argh.Program{Name: "pizzas", Pos: 0}, argh.Flag{Name: "tasty"},
argh.ArgDelimiter{Pos: 6}, argh.ArgDelimiter{},
argh.Flag{Name: "tasty", Pos: 7}, argh.Flag{Name: "fresh", Value: ptr("soon")},
argh.ArgDelimiter{Pos: 14}, argh.ArgDelimiter{},
argh.Flag{Name: "fresh", Pos: 15, Value: ptr("soon")}, argh.Flag{Name: "super-hot-right-now"},
argh.ArgDelimiter{Pos: 27}, },
argh.Flag{Name: "super-hot-right-now", Pos: 28}, expAST: []argh.Node{
}, argh.Program{Name: "pizzas"},
}, argh.Flag{Name: "tasty"},
argh.Flag{Name: "fresh", Value: ptr("soon")},
argh.Flag{Name: "super-hot-right-now"},
}, },
}, },
{ {
skip: true, name: "short value-less flags",
args: []string{"pizzas", "-t", "-f", "-s"},
name: "typical", expPT: []argh.Node{
argh.Program{Name: "pizzas"},
argh.ArgDelimiter{},
argh.Flag{Name: "t"},
argh.ArgDelimiter{},
argh.Flag{Name: "f"},
argh.ArgDelimiter{},
argh.Flag{Name: "s"},
},
expAST: []argh.Node{
argh.Program{Name: "pizzas"},
argh.Flag{Name: "t"},
argh.Flag{Name: "f"},
argh.Flag{Name: "s"},
},
},
{
name: "compound short flags",
args: []string{"pizzas", "-aca", "-blol"},
expPT: []argh.Node{
argh.Program{Name: "pizzas"},
argh.ArgDelimiter{},
argh.Statement{
Nodes: []argh.Node{
argh.Flag{Name: "a"},
argh.Flag{Name: "c"},
argh.Flag{Name: "a"},
},
},
argh.ArgDelimiter{},
argh.Statement{
Nodes: []argh.Node{
argh.Flag{Name: "b"},
argh.Flag{Name: "l"},
argh.Flag{Name: "o"},
argh.Flag{Name: "l"},
},
},
},
expAST: []argh.Node{
argh.Program{Name: "pizzas"},
argh.Flag{Name: "a"},
argh.Flag{Name: "c"},
argh.Flag{Name: "a"},
argh.Flag{Name: "b"},
argh.Flag{Name: "l"},
argh.Flag{Name: "o"},
argh.Flag{Name: "l"},
},
},
{
name: "mixed long short value flags",
args: []string{"pizzas", "-a", "--ca", "-b", "1312", "-lol"}, args: []string{"pizzas", "-a", "--ca", "-b", "1312", "-lol"},
cfg: &argh.ParserConfig{ cfg: &argh.ParserConfig{
Commands: []string{}, Commands: []string{},
ValueFlags: []string{"b"}, ValueFlags: []string{"b"},
}, },
expected: &argh.Argh{ expPT: []argh.Node{
ParseTree: &argh.ParseTree{ argh.Program{Name: "pizzas"},
argh.ArgDelimiter{},
argh.Flag{Name: "a"},
argh.ArgDelimiter{},
argh.Flag{Name: "ca"},
argh.ArgDelimiter{},
argh.Flag{Name: "b", Value: ptr("1312")},
argh.ArgDelimiter{},
argh.Statement{
Nodes: []argh.Node{ Nodes: []argh.Node{
argh.Program{Name: "pizzas", Pos: 0}, argh.Flag{Name: "l"},
argh.ArgDelimiter{Pos: 6}, argh.Flag{Name: "o"},
argh.Flag{Name: "a", Pos: 7}, argh.Flag{Name: "l"},
argh.ArgDelimiter{Pos: 9},
argh.Flag{Name: "ca", Pos: 10},
argh.ArgDelimiter{Pos: 14},
argh.Flag{Name: "b", Pos: 15, Value: ptr("1312")},
argh.ArgDelimiter{Pos: 22},
argh.Statement{
Pos: 23,
Nodes: []argh.Node{
argh.Flag{Name: "l", Pos: 29},
argh.Flag{Name: "o", Pos: 30},
argh.Flag{Name: "l", Pos: 31},
},
},
}, },
}, },
}, },
expAST: []argh.Node{
argh.Program{Name: "pizzas"},
argh.Flag{Name: "a"},
argh.Flag{Name: "ca"},
argh.Flag{Name: "b", Value: ptr("1312")},
argh.Flag{Name: "l"},
argh.Flag{Name: "o"},
argh.Flag{Name: "l"},
},
},
{
name: "commands",
args: []string{"pizzas", "fly", "fry"},
cfg: &argh.ParserConfig{
Commands: []string{"fly", "fry"},
ValueFlags: []string{},
},
expPT: []argh.Node{
argh.Program{Name: "pizzas"},
argh.ArgDelimiter{},
argh.Command{Name: "fly"},
argh.ArgDelimiter{},
argh.Command{Name: "fry"},
},
}, },
} { } {
if tc.skip { if tc.skip {
continue continue
} }
t.Run(tc.name, func(ct *testing.T) { if tc.expPT != nil {
actual, err := argh.ParseArgs(tc.args, tc.cfg) t.Run(tc.name+" parse tree", func(ct *testing.T) {
if err != nil { actual, err := argh.ParseArgs(tc.args, tc.cfg)
assert.ErrorIs(ct, err, tc.expectedErr) if err != nil {
return assert.ErrorIs(ct, err, tc.expErr)
} return
}
assert.Equal(ct, tc.expected, actual) assert.Equal(ct, tc.expPT, actual.ParseTree.Nodes)
}) })
}
if tc.expAST != nil {
t.Run(tc.name+" ast", func(ct *testing.T) {
actual, err := argh.ParseArgs(tc.args, tc.cfg)
if err != nil {
assert.ErrorIs(ct, err, tc.expErr)
return
}
assert.Equal(ct, tc.expAST, actual.AST())
})
}
} }
} }