Repository navigation
Expand file tree
/
Copy pathgcmd_parser.go
More file actions
224 lines (201 loc) · 6.19 KB
/
Copy pathgcmd_parser.go
File metadata and controls
224 lines (201 loc) · 6.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
// Copyright 2019 gf Author(https://github.com/gogf/gf). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
//
package gcmd
import (
"encoding/json"
"fmt"
"os"
"strings"
"github.com/gogf/gf/text/gstr"
"errors"
"github.com/gogf/gf/container/gvar"
"github.com/gogf/gf/text/gregex"
)
// Parser for arguments.
type Parser struct {
strict bool // Whether stops parsing and returns error if invalid option passed.
parsedArgs []string // As name described.
parsedOptions map[string]string // As name described.
passedOptions map[string]bool // User passed supported options.
supportedOptions map[string]bool // Option [option name : need argument].
commandFuncMap map[string]func() // Command function map for function handler.
}
// Parse creates and returns a new Parser with os.Args and supported options.
//
// Note that the parameter <supportedOptions> is as [option name: need argument], which means
// the value item of <supportedOptions> indicates whether corresponding option name needs argument or not.
//
// The optional parameter <strict> specifies whether stops parsing and returns error if invalid option passed.
func Parse(supportedOptions map[string]bool, strict ...bool) (*Parser, error) {
return ParseWithArgs(os.Args, supportedOptions, strict...)
}
// ParseWithArgs creates and returns a new Parser with given arguments and supported options.
//
// Note that the parameter <supportedOptions> is as [option name: need argument], which means
// the value item of <supportedOptions> indicates whether corresponding option name needs argument or not.
//
// The optional parameter <strict> specifies whether stops parsing and returns error if invalid option passed.
func ParseWithArgs(args []string, supportedOptions map[string]bool, strict ...bool) (*Parser, error) {
strictParsing := false
if len(strict) > 0 {
strictParsing = strict[0]
}
parser := &Parser{
strict: strictParsing,
parsedArgs: make([]string, 0),
parsedOptions: make(map[string]string),
passedOptions: supportedOptions,
supportedOptions: make(map[string]bool),
commandFuncMap: make(map[string]func()),
}
for name, needArgument := range supportedOptions {
for _, v := range strings.Split(name, ",") {
parser.supportedOptions[strings.TrimSpace(v)] = needArgument
}
}
for i := 0; i < len(args); {
if option := parser.parseOption(args[i]); option != "" {
array, _ := gregex.MatchString(`^(.+?)=(.+)$`, option)
if len(array) == 3 {
if parser.isOptionValid(array[1]) {
parser.setOptionValue(array[1], array[2])
}
} else {
if parser.isOptionValid(option) {
if parser.isOptionNeedArgument(option) {
if i < len(args)-1 {
parser.setOptionValue(option, args[i+1])
i += 2
continue
}
} else {
parser.setOptionValue(option, "")
i++
continue
}
} else {
// Multiple options?
if array := parser.parseMultiOption(option); len(array) > 0 {
for _, v := range array {
parser.setOptionValue(v, "")
}
i++
continue
} else if parser.strict {
return nil, errors.New(fmt.Sprintf(`invalid option '%s'`, args[i]))
}
}
}
} else {
parser.parsedArgs = append(parser.parsedArgs, args[i])
}
i++
}
return parser, nil
}
// parseMultiOption parses option to multiple valid options like: --dav.
// It returns nil if given option is not multi-option.
func (p *Parser) parseMultiOption(option string) []string {
for i := 1; i <= len(option); i++ {
s := option[:i]
if p.isOptionValid(s) && !p.isOptionNeedArgument(s) {
if i == len(option) {
return []string{s}
}
array := p.parseMultiOption(option[i:])
if len(array) == 0 {
return nil
}
return append(array, s)
}
}
return nil
}
func (p *Parser) parseOption(argument string) string {
array, _ := gregex.MatchString(`^\-{1,2}(.+)$`, argument)
if len(array) == 2 {
return array[1]
}
return ""
}
func (p *Parser) isOptionValid(name string) bool {
_, ok := p.supportedOptions[name]
return ok
}
func (p *Parser) isOptionNeedArgument(name string) bool {
return p.supportedOptions[name]
}
// setOptionValue sets the option value for name and according alias.
func (p *Parser) setOptionValue(name, value string) {
for optionName, _ := range p.passedOptions {
array := gstr.SplitAndTrim(optionName, ",")
for _, v := range array {
if strings.EqualFold(v, name) {
for _, v := range array {
p.parsedOptions[v] = value
}
return
}
}
}
}
// GetOpt returns the option value named <name>.
func (p *Parser) GetOpt(name string, def ...string) string {
if v, ok := p.parsedOptions[name]; o
67F1
k {
return v
}
if len(def) > 0 {
return def[0]
}
return ""
}
// GetOptVar returns the option value named <name> as *gvar.Var.
func (p *Parser) GetOptVar(name string, def ...interface{}) *gvar.Var {
if p.ContainsOpt(name) {
return gvar.New(p.GetOpt(name))
}
if len(def) > 0 {
return gvar.New(def[0])
}
return gvar.New(nil)
}
// GetOptAll returns all parsed options.
func (p *Parser) GetOptAll() map[string]string {
return p.parsedOptions
}
// ContainsOpt checks whether option named <name> exist in the arguments.
func (p *Parser) ContainsOpt(name string) bool {
_, ok := p.parsedOptions[name]
return ok
}
// GetArg returns the argument at <index>.
func (p *Parser) GetArg(index int, def ...string) string {
if index < len(p.parsedArgs) {
return p.parsedArgs[index]
}
if len(def) > 0 {
return def[0]
}
return ""
}
// GetArgVar returns the argument at <index> as *gvar.Var.
func (p *Parser) GetArgVar(index int, def ...string) *gvar.Var {
return gvar.New(p.GetArg(index, def...))
}
// GetArgAll returns all parsed arguments.
func (p *Parser) GetArgAll() []string {
return p.parsedArgs
}
// MarshalJSON implements the interface MarshalJSON for json.Marshal.
func (p *Parser) MarshalJSON() ([]byte, error) {
return json.Marshal(map[string]interface{}{
"parsedArgs": p.parsedArgs,
"parsedOptions": p.parsedOptions,
"passedOptions": p.passedOptions,
"supportedOptions": p.supportedOptions,
})
}