parse

Documentation

Index

• Variables
• func Dependency(input string) (string, []string, error)
• func InferFieldType(field interface{}) types.OptionType
• func LegacyUnmarshalTagFormat(field reflect.StructField) (*types.TagConfig, error)
• func PatternValue(input string) (*types.PatternValue, error)
• func PatternValues(input string) ([]types.PatternValue, error)
• func Split(s string) ([]string, error)
• func TypeOfFlagFromString(s string) types.OptionType
• func UnmarshalTagFormat(tag string, field reflect.StructField) (*types.TagConfig, error)
• type DefaultState
  • func NewState(args []string) *DefaultState
  • func (s *DefaultState) Advance() bool
  • func (s *DefaultState) ArgAt(pos int) (string, error)
  • func (s *DefaultState) Args() []string
  • func (s *DefaultState) CurrentArg() string
  • func (s *DefaultState) CurrentPos() int
  • func (s *DefaultState) InsertArgsAt(pos int, newArgs ...string)
  • func (s *DefaultState) Len() int
  • func (s *DefaultState) Peek() string
  • func (s *DefaultState) ReplaceArgs(newArgs ...string)
  • func (s *DefaultState) SetPos(pos int)
  • func (s *DefaultState) SkipCurrent()
• type DependencyMap
  • func Dependencies(input string) (DependencyMap, error)
• type PositionData
  • func Position(input string) (*PositionData, error)
• type State

Variables

var ErrInvalidPosition = errors.New("invalid position")

ErrInvalidPosition is an error that occurs when an invalid position is accessed

Functions

func Dependency

func Dependency(input string) (string, []string, error)

Dependency parses a single dependency entry using the same dependency format rules as Dependencies.

func InferFieldType

func InferFieldType(field interface{}) types.OptionType

func LegacyUnmarshalTagFormat

func LegacyUnmarshalTagFormat(field reflect.StructField) (*types.TagConfig, error)

func PatternValue

func PatternValue(input string) (*types.PatternValue, error)

PatternValue parses a pattern value in format {pattern:xyz,desc:abc}

Escape sequences:

• Special characters: \, -> , (comma) \: -> : (colon) \{ -> { (left brace) \} -> } (right brace) \ -> ' ' (space)

• Quotes: \" -> " (double quote) \' -> ' (single quote)

• Backslashes: \\ -> \ (single backslash) \\\ -> \\ (escaped backslash followed by char)

Examples:

{pattern:a\,b,desc:Values a\, b}     -> pattern="a,b" desc="Values a, b"
{pattern:C:\\Windows,desc:Path}      -> pattern="C:\Windows" desc="Path"
{pattern:\w+\:\d+,desc:Key\: Value}  -> pattern="w+:d+" desc="Key: Value"

func PatternValues

func PatternValues(input string) ([]types.PatternValue, error)

PatternValues parses multiple pattern values

func Split

func Split(s string) ([]string, error)

Split splits a command string into arguments

func TypeOfFlagFromString

func TypeOfFlagFromString(s string) types.OptionType

TypeOfFlagFromString converts a string to a types.OptionType

func UnmarshalTagFormat

func UnmarshalTagFormat(tag string, field reflect.StructField) (*types.TagConfig, error)

Types

type DefaultState

type DefaultState struct {
	// contains filtered or unexported fields
}

DefaultState is the default implementation of the State interface

func NewState

func NewState(args []string) *DefaultState

NewState creates a new State instance with the given argument list

func (*DefaultState) Advance

func (s *DefaultState) Advance() bool

Advance advances to the next argument, returning true if successful

func (*DefaultState) ArgAt

func (s *DefaultState) ArgAt(pos int) (string, error)

ArgAt returns the argument at a specific position

func (*DefaultState) Args

func (s *DefaultState) Args() []string

Args returns the entire argument list

func (*DefaultState) CurrentArg

func (s *DefaultState) CurrentArg() string

CurrentArg returns the current argument

func (*DefaultState) CurrentPos

func (s *DefaultState) CurrentPos() int

CurrentPos returns the current position in the argument list

func (*DefaultState) InsertArgsAt

func (s *DefaultState) InsertArgsAt(pos int, newArgs ...string)

InsertArgsAt inserts new arguments at a specific position

func (*DefaultState) Len

func (s *DefaultState) Len() int

Len returns the length of the argument list

func (*DefaultState) Peek

func (s *DefaultState) Peek() string

Peek returns the next argument without advancing the current position

func (*DefaultState) ReplaceArgs

func (s *DefaultState) ReplaceArgs(newArgs ...string)

ReplaceArgs replaces the entire argument list with new arguments

func (*DefaultState) SetPos

func (s *DefaultState) SetPos(pos int)

SetPos sets the current position in the argument list

func (*DefaultState) SkipCurrent

func (s *DefaultState) SkipCurrent()

SkipCurrent advances the current position to the next argument

type DependencyMap

type DependencyMap map[string][]string

DependencyMap maps flag names to their allowed values empty slice means any value is acceptable

func Dependencies

func Dependencies(input string) (DependencyMap, error)

Dependencies parses multiple dependency entries in format {flag:a,value:1},{flag:b,values:[1,2]} using the dependency format rules defined above.

type PositionData

type PositionData struct {
	Index int // Sequential index for positional argument
}

PositionData represents a parsed position configuration

func Position

func Position(input string) (*PositionData, error)

Position parses a position tag value in both formats: - New format: "N" (just the number) - Legacy format: "{idx:N}"

type State

type State interface {
	CurrentPos() int                         // Get the current position
	SetPos(pos int)                          // Set the current position
	SkipCurrent()                            // Skip the current argument
	Args() []string                          // Get the entire argument list
	InsertArgsAt(pos int, newArgs ...string) // Insert new arguments at a specific position
	ReplaceArgs(newArgs ...string)           // Replace the entire argument list
	CurrentArg() string                      // Get the current argument
	Peek() string                            // Peek at the next argument
	Advance() bool                           // New method for advancing to the next argument
	Len() int                                // Gets the length of the argument list
}

State represents the current state of the argument parser