README
¶
cmdl
About
Package cmdl provides functions to parse command line arguments. It is published on https://github.com/vbsw/cmdl and https://gitlab.com/vbsw/cmdl.
Copyright
Copyright 2020, 2021, Vitali Baumtrok (vbsw@mailbox.org).
cmdl is distributed under the Boost Software License, version 1.0. (See accompanying file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)
cmdl is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Boost Software License for more details.
Usage
Example A
package main
import (
"fmt"
"github.com/vbsw/cmdl"
)
func main() {
cl := cmdl.New()
if cl.NewParam().Parse("--help", "-h").Available() {
fmt.Println("valid parameters are -h or -v.")
} else if cl.NewParam().Parse("--version", "-v").Available() {
fmt.Println("version 1.0.0")
} else {
unparsedArgs := cl.UnparsedArgs()
if len(unparsedArgs) == 1 {
fmt.Println("error: unknown parameter", unparsedArgs[0])
} else if len(unparsedArgs) > 1 {
fmt.Println("error: too many arguments")
}
}
}
Example B
package main
import (
"fmt"
"github.com/vbsw/cmdl"
)
func main() {
start := "0"
end := "0"
cl := cmdl.New()
asgOp := cmdl.NewAsgOp(false, false, "=")
paramStart := cl.NewParam().ParsePairs(asgOp, "start")
paramEnd := cl.NewParam().ParsePairs(asgOp, "end")
if paramStart.Available() {
start = paramStart.Values()[0]
end = start
}
if paramEnd.Available() {
end = paramEnd.Values()[0]
}
fmt.Println("processing from", start, "to", end)
}
Command line:
$ ./test start=1 end=10
$ processing from 1 to 10
References
Documentation
¶
Overview ¶
Package cmdl provides functions to parse command line arguments.
Index ¶
- type AssignmentOperator
- type CommandLine
- type Parameter
- func (param *Parameter) Add(key, value string)
- func (param *Parameter) Available() bool
- func (param *Parameter) Count() int
- func (param *Parameter) Keys() []string
- func (param *Parameter) Parse(keys ...string) *Parameter
- func (param *Parameter) ParsePairs(asgOps *AssignmentOperator, keys ...string) *Parameter
- func (param *Parameter) Values() []string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssignmentOperator ¶
type AssignmentOperator struct {
// contains filtered or unexported fields
}
AssignmentOperator represents the operator between key and value in argument.
func NewAsgOp ¶
func NewAsgOp(blankAllowed, emptyAllowed bool, ops ...string) *AssignmentOperator
NewAsgOp creates and returns a new instance of AssignmentOperator.
func (*AssignmentOperator) MatchingOp ¶
func (asgOps *AssignmentOperator) MatchingOp(str string) (bool, string)
MatchingOp returns true and matching operator, if str starts with assignment operator.
type CommandLine ¶
type CommandLine struct {
// contains filtered or unexported fields
}
CommandLine holds command line arguments.
func NewFrom ¶
func NewFrom(args []string) *CommandLine
NewFrom creates and returns a new instance of CommandLine.
func (*CommandLine) Args ¶
func (cl *CommandLine) Args() []string
Args returns command line arguments.
func (*CommandLine) NewParam ¶
func (cl *CommandLine) NewParam() *Parameter
NewParam creates and returns a new instance of Parameter.
func (*CommandLine) UnparsedArgs ¶
func (cl *CommandLine) UnparsedArgs() []string
UnparsedArgs returns unparsed arguments.
type Parameter ¶
type Parameter struct {
// contains filtered or unexported fields
}
Parameter represents a parsed argument from command line.
func (*Parameter) ParsePairs ¶
func (param *Parameter) ParsePairs(asgOps *AssignmentOperator, keys ...string) *Parameter
ParsePairs searches for keys in command line.
Source Files