bee/parser/annotator.go

package beeParser

import (
	"encoding/json"
	"strings"
)

// field formatter by annotation
type Annotator struct{}

func isWhitespace(ch byte) bool { return ch == ' ' || ch == '\t' || ch == '\r' }

func handleHeadWhitespace(s string) string {
	i := 0
	for i < len(s) && isWhitespace(s[i]) {
		i++
	}
	return s[i:]
}

func handleTailWhitespace(s string) string {
	i := len(s)
	for i > 0 && isWhitespace(s[i-1]) {
		i--
	}
	return s[0:i]
}

//handle value to remove head and tail space.
func handleWhitespaceValues(values []string) []string {
	res := make([]string, 0)
	for _, v := range values {
		v = handleHeadWhitespace(v)
		v = handleTailWhitespace(v)
		res = append(res, v)
	}
	return res
}

//parse annotation to generate array with key and values
//start with "@" as a key-value pair,key and values are separated by a space,wrap to distinguish values.
func (a *Annotator) Annotate(comment string) []map[string]interface{} {
	results := make([]map[string]interface{}, 0)
	//split annotation with '@'
	lines := strings.Split(comment, "@")
	//skip first line whitespace
	for _, line := range lines[1:] {
		kvs := strings.Split(line, " ")
		key := kvs[0]
		values := strings.Split(strings.TrimSpace(line[len(kvs[0]):]), "\n")
		annotation := make(map[string]interface{})
		annotation[key] = handleWhitespaceValues(values)
		results = append(results, annotation)
	}
	return results
}

//parse annotation to json
func (a *Annotator) AnnotateToJson(comment string) (string, error) {
	if comment == "" {
		return "", nil
	}
	annotate := a.Annotate(comment)
	if len(annotate) == 0 {
		return "", nil
	}
	result, err := json.MarshalIndent(annotate, "", "  ")
	return string(result), err
}

func (a *Annotator) Format(field *StructField) string {
	f, _ := a.AnnotateToJson(field.Doc)
	return f
}