Function nilabilityFromCommentGroup

annotation/map.go:281–349

from a CommentGroup return a nilabilitySet of which identifiers are known annotated nilable

(group *ast.CommentGroup)

// from a CommentGroup return a nilabilitySet of which identifiers are known annotated nilable
func nilabilityFromCommentGroup(group *ast.CommentGroup) nilabilitySet {
	set := make(nilabilitySet)
	// in each of the following utility functions, isFinalVal=true because literally read annotations
	// are considered final
	markNilable := func(s string) {
		if v, ok := set[s]; ok {
			set[s] = v.makeNilable(true)
		} else {
			set[s] = EmptyVal.makeNilable(true)
		}
	}
	markDeepNilable := func(s string) {
		if v, ok := set[s]; ok {
			set[s] = v.makeDeepNilable(true)
		} else {
			set[s] = EmptyVal.makeDeepNilable(true)
		}
	}
	markNonNil := func(s string) {
		if v, ok := set[s]; ok {
			set[s] = v.makeNonNil(true)
		} else {
			set[s] = EmptyVal.makeNonNil(true)
		}
	}
	markDeepNonNil := func(s string) {
		if v, ok := set[s]; ok {
			set[s] = v.makeDeepNonNil(true)
		} else {
			set[s] = EmptyVal.makeDeepNonNil(true)
		}
	}

	if group != nil {
		for _, comment := range group.List {
			for _, seqMatch := range seqRegex.FindAllStringSubmatch(comment.Text, -1) {

				deepFunc, shallowFunc := markDeepNonNil, markNonNil
				if seqMatch[1] == nilableKeyword {
					deepFunc, shallowFunc = markDeepNilable, markNilable
				}

				for match := range strings.SplitSeq(seqMatch[2], sep) {
					match = strings.TrimSpace(match)
					n := len(match)

					if n >= 2 && match[0] == '*' {
						deepFunc(match[1:])
						continue
					}

					if n >= 3 && match[n-2:] == "[]" {
						deepFunc(match[:n-2])
						continue
					}

					if n >= 3 && match[:2] == "<-" {
						deepFunc(match[2:])