Method Parse

parse_doc/argparse.go:318–361

(context parseContext)

}

func (argparseParser) Parse(context parseContext) (res *parseResult, err error) {
	usageStartIndex := context.text.FindFirstLine("usage:")
	if usageStartIndex < 0 {
		err = fmt.Errorf("cannot find usage")
		return
	}
	if usageStartIndex != 0 {
		err = fmt.Errorf("usage is not at the beginning, doesn't look like argparse")
	}

	usageEndIndex := context.text.ParagraphEnd(usageStartIndex)
	usageLexer := makeUsageLexer(context.text.lines[usageStartIndex:usageEndIndex])

	usage, err := parseArgparseUsage(&usageLexer)
	if err != nil {
		err = fmt.Errorf("error parsing usage: %v", err)
		return
	}

	if filepath.Base(usage.applicationName) != filepath.Base(context.args[0]) {
		err = fmt.Errorf("application in usage doesn't match provided application")
		return
	}

	result := &parseResult{}
	for start := 0; start < len(context.text.lines); {
		par := context.text.FindIndentedParagraph("arguments:", start)
		if par == nil {
			break
		}
		start = par.lineEnd
		if len(par.children) == 0 {
			continue
		}
		switch {
		case tryParseFlagsParagraph(par, &usage, result):
		case tryParseNamedPositionalParagraph(par, &usage, result):
		case tryParseUnnamedPositionalParagraph(par, &usage, result):
		}
	}

	res = result
	return
}