data

Documentation

Index

• func DocMatchStringIndex(pkg string, links PatternList) (idx int)
• func RegexpForPattern(pattern string, allowDollar EnumDollar, maxDollar int) (*regexp.Regexp, int, []int, error)
• func TypeFormat(t PkgType) string
• func TypeLetter(t PkgType) rune
• type EnumDollar
• type Pattern
• type PatternGroup
• type PatternList
  • func NewSimplePatternList(patterns []string, key string) (PatternList, error)
  • func (pl PatternList) MatchString(s string, dollars []string) (atAll, full bool)
  • func (pl PatternList) MatchStringIndex(s string, dollars []string) (idx int, full bool)
  • func (pl PatternList) String() string
• type PatternMap
  • func (pm *PatternMap) HasKeyValue(key, strictKey, value, strictValue string) (hasKey, hasValue bool)
  • func (pm *PatternMap) String() string
• type PkgType

Functions

func DocMatchStringIndex

func DocMatchStringIndex(pkg string, links PatternList) (idx int)

DocMatchStringIndex matches pkg in links and returns its index. Only full matches are returned. If pkg doesn't match, pkg+"/" is tried. -1 is returned for no match.

func RegexpForPattern

func RegexpForPattern(pattern string, allowDollar EnumDollar, maxDollar int,
) (*regexp.Regexp, int, []int, error)

RegexpForPattern converts the given pattern including wildcards and variables into a proper regular expression that can be used for matching.

func TypeFormat

func TypeFormat(t PkgType) string

TypeFormat returns the formatting string associated with package type t ("", "_", "`" or "**").

func TypeLetter

func TypeLetter(t PkgType) rune

TypeLetter returns the type letter associated with package type t ('S', 'T', 'D' or 'G').

Types

type EnumDollar

type EnumDollar int

EnumDollar is an enumeration type for how to hanlde dollars ('$') in patterns.

const (
	EnumDollarNone  EnumDollar = iota // '$' isn't allowed at all
	EnumDollarStar                    // '$' has to be followed by one or two '*'
	EnumDollarDigit                   // '$' has to be followed by a single digit (1-9)
)

internal enum for '$' handling in patterns

type Pattern

type Pattern struct {
	Pattern    string
	Regexp     *regexp.Regexp
	DollarIdxs []int
}

Pattern combines the original pattern string with a compiled regular expression ready for efficient evaluation.

type PatternGroup

type PatternGroup struct {
	Left  Pattern
	Right PatternList
}

type PatternList

type PatternList []Pattern

PatternList is a slice of the Pattern type.

func NewSimplePatternList

func NewSimplePatternList(patterns []string, key string) (PatternList, error)

NewSimplePatternList returns a PatternList initialized from the given patterns. An error is returned if a pattern isn't valid.

func (PatternList) MatchString

func (pl PatternList) MatchString(s string, dollars []string) (atAll, full bool)

MatchString returns true if any of the patterns in the pattern list matches the given string including its dollars and false otherwise. If the full string is matched full will be true and false otherwise.

func (PatternList) MatchStringIndex

func (pl PatternList) MatchStringIndex(s string, dollars []string) (idx int, full bool)

MatchStringIndex returns the index of the pattern in the list that matches the given string and an indicator if it was a full match.

func (PatternList) String

func (pl PatternList) String() string

String implements Stringer and returns the list of patterns, or "..." if no patterns have been added.

type PatternMap

type PatternMap map[string]PatternGroup

PatternMap is a map from a single pattern to a list of patterns.

func (*PatternMap) HasKeyValue

func (pm *PatternMap) HasKeyValue(key, strictKey, value, strictValue string) (hasKey, hasValue bool)

HasKeyValue checks if this pattern map contains the given key value pair. The strict versions are checked first (1. strictKey+strictValue, 2. strictKey+value, 3. key+strictValue, 4. key+value).

func (*PatternMap) String

func (pm *PatternMap) String() string

String implements Stringer and returns the map of patterns, or "....." if it is empty. The stringer methods are tested in the config package: TestParseAndStringers

type PkgType

type PkgType int

PkgType can be one of: Standard, Tool, DB or God

const (
	TypeStandard PkgType = iota
	TypeTool
	TypeDB
	TypeGod
)

Enum of package types: Standard, Tool, DB and God