Blame vendor/gopkg.in/yaml.v2/encode.go

Packit 63bb0d
package yaml
Packit 63bb0d
Packit 63bb0d
import (
Packit 63bb0d
	"encoding"
Packit 63bb0d
	"fmt"
Packit 63bb0d
	"io"
Packit 63bb0d
	"reflect"
Packit 63bb0d
	"regexp"
Packit 63bb0d
	"sort"
Packit 63bb0d
	"strconv"
Packit 63bb0d
	"strings"
Packit 63bb0d
	"time"
Packit 63bb0d
	"unicode/utf8"
Packit 63bb0d
)
Packit 63bb0d
Packit 63bb0d
// jsonNumber is the interface of the encoding/json.Number datatype.
Packit 63bb0d
// Repeating the interface here avoids a dependency on encoding/json, and also
Packit 63bb0d
// supports other libraries like jsoniter, which use a similar datatype with
Packit 63bb0d
// the same interface. Detecting this interface is useful when dealing with
Packit 63bb0d
// structures containing json.Number, which is a string under the hood. The
Packit 63bb0d
// encoder should prefer the use of Int64(), Float64() and string(), in that
Packit 63bb0d
// order, when encoding this type.
Packit 63bb0d
type jsonNumber interface {
Packit 63bb0d
	Float64() (float64, error)
Packit 63bb0d
	Int64() (int64, error)
Packit 63bb0d
	String() string
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
type encoder struct {
Packit 63bb0d
	emitter yaml_emitter_t
Packit 63bb0d
	event   yaml_event_t
Packit 63bb0d
	out     []byte
Packit 63bb0d
	flow    bool
Packit 63bb0d
	// doneInit holds whether the initial stream_start_event has been
Packit 63bb0d
	// emitted.
Packit 63bb0d
	doneInit bool
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func newEncoder() *encoder {
Packit 63bb0d
	e := &encoder{}
Packit 63bb0d
	yaml_emitter_initialize(&e.emitter)
Packit 63bb0d
	yaml_emitter_set_output_string(&e.emitter, &e.out)
Packit 63bb0d
	yaml_emitter_set_unicode(&e.emitter, true)
Packit 63bb0d
	return e
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func newEncoderWithWriter(w io.Writer) *encoder {
Packit 63bb0d
	e := &encoder{}
Packit 63bb0d
	yaml_emitter_initialize(&e.emitter)
Packit 63bb0d
	yaml_emitter_set_output_writer(&e.emitter, w)
Packit 63bb0d
	yaml_emitter_set_unicode(&e.emitter, true)
Packit 63bb0d
	return e
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) init() {
Packit 63bb0d
	if e.doneInit {
Packit 63bb0d
		return
Packit 63bb0d
	}
Packit 63bb0d
	yaml_stream_start_event_initialize(&e.event, yaml_UTF8_ENCODING)
Packit 63bb0d
	e.emit()
Packit 63bb0d
	e.doneInit = true
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) finish() {
Packit 63bb0d
	e.emitter.open_ended = false
Packit 63bb0d
	yaml_stream_end_event_initialize(&e.event)
Packit 63bb0d
	e.emit()
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) destroy() {
Packit 63bb0d
	yaml_emitter_delete(&e.emitter)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) emit() {
Packit 63bb0d
	// This will internally delete the e.event value.
Packit 63bb0d
	e.must(yaml_emitter_emit(&e.emitter, &e.event))
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) must(ok bool) {
Packit 63bb0d
	if !ok {
Packit 63bb0d
		msg := e.emitter.problem
Packit 63bb0d
		if msg == "" {
Packit 63bb0d
			msg = "unknown problem generating YAML content"
Packit 63bb0d
		}
Packit 63bb0d
		failf("%s", msg)
Packit 63bb0d
	}
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) marshalDoc(tag string, in reflect.Value) {
Packit 63bb0d
	e.init()
Packit 63bb0d
	yaml_document_start_event_initialize(&e.event, nil, nil, true)
Packit 63bb0d
	e.emit()
Packit 63bb0d
	e.marshal(tag, in)
Packit 63bb0d
	yaml_document_end_event_initialize(&e.event, true)
Packit 63bb0d
	e.emit()
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) marshal(tag string, in reflect.Value) {
Packit 63bb0d
	if !in.IsValid() || in.Kind() == reflect.Ptr && in.IsNil() {
Packit 63bb0d
		e.nilv()
Packit 63bb0d
		return
Packit 63bb0d
	}
Packit 63bb0d
	iface := in.Interface()
Packit 63bb0d
	switch m := iface.(type) {
Packit 63bb0d
	case jsonNumber:
Packit 63bb0d
		integer, err := m.Int64()
Packit 63bb0d
		if err == nil {
Packit 63bb0d
			// In this case the json.Number is a valid int64
Packit 63bb0d
			in = reflect.ValueOf(integer)
Packit 63bb0d
			break
Packit 63bb0d
		}
Packit 63bb0d
		float, err := m.Float64()
Packit 63bb0d
		if err == nil {
Packit 63bb0d
			// In this case the json.Number is a valid float64
Packit 63bb0d
			in = reflect.ValueOf(float)
Packit 63bb0d
			break
Packit 63bb0d
		}
Packit 63bb0d
		// fallback case - no number could be obtained
Packit 63bb0d
		in = reflect.ValueOf(m.String())
Packit 63bb0d
	case time.Time, *time.Time:
Packit 63bb0d
		// Although time.Time implements TextMarshaler,
Packit 63bb0d
		// we don't want to treat it as a string for YAML
Packit 63bb0d
		// purposes because YAML has special support for
Packit 63bb0d
		// timestamps.
Packit 63bb0d
	case Marshaler:
Packit 63bb0d
		v, err := m.MarshalYAML()
Packit 63bb0d
		if err != nil {
Packit 63bb0d
			fail(err)
Packit 63bb0d
		}
Packit 63bb0d
		if v == nil {
Packit 63bb0d
			e.nilv()
Packit 63bb0d
			return
Packit 63bb0d
		}
Packit 63bb0d
		in = reflect.ValueOf(v)
Packit 63bb0d
	case encoding.TextMarshaler:
Packit 63bb0d
		text, err := m.MarshalText()
Packit 63bb0d
		if err != nil {
Packit 63bb0d
			fail(err)
Packit 63bb0d
		}
Packit 63bb0d
		in = reflect.ValueOf(string(text))
Packit 63bb0d
	case nil:
Packit 63bb0d
		e.nilv()
Packit 63bb0d
		return
Packit 63bb0d
	}
Packit 63bb0d
	switch in.Kind() {
Packit 63bb0d
	case reflect.Interface:
Packit 63bb0d
		e.marshal(tag, in.Elem())
Packit 63bb0d
	case reflect.Map:
Packit 63bb0d
		e.mapv(tag, in)
Packit 63bb0d
	case reflect.Ptr:
Packit 63bb0d
		if in.Type() == ptrTimeType {
Packit 63bb0d
			e.timev(tag, in.Elem())
Packit 63bb0d
		} else {
Packit 63bb0d
			e.marshal(tag, in.Elem())
Packit 63bb0d
		}
Packit 63bb0d
	case reflect.Struct:
Packit 63bb0d
		if in.Type() == timeType {
Packit 63bb0d
			e.timev(tag, in)
Packit 63bb0d
		} else {
Packit 63bb0d
			e.structv(tag, in)
Packit 63bb0d
		}
Packit 63bb0d
	case reflect.Slice, reflect.Array:
Packit 63bb0d
		if in.Type().Elem() == mapItemType {
Packit 63bb0d
			e.itemsv(tag, in)
Packit 63bb0d
		} else {
Packit 63bb0d
			e.slicev(tag, in)
Packit 63bb0d
		}
Packit 63bb0d
	case reflect.String:
Packit 63bb0d
		e.stringv(tag, in)
Packit 63bb0d
	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
Packit 63bb0d
		if in.Type() == durationType {
Packit 63bb0d
			e.stringv(tag, reflect.ValueOf(iface.(time.Duration).String()))
Packit 63bb0d
		} else {
Packit 63bb0d
			e.intv(tag, in)
Packit 63bb0d
		}
Packit 63bb0d
	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
Packit 63bb0d
		e.uintv(tag, in)
Packit 63bb0d
	case reflect.Float32, reflect.Float64:
Packit 63bb0d
		e.floatv(tag, in)
Packit 63bb0d
	case reflect.Bool:
Packit 63bb0d
		e.boolv(tag, in)
Packit 63bb0d
	default:
Packit 63bb0d
		panic("cannot marshal type: " + in.Type().String())
Packit 63bb0d
	}
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) mapv(tag string, in reflect.Value) {
Packit 63bb0d
	e.mappingv(tag, func() {
Packit 63bb0d
		keys := keyList(in.MapKeys())
Packit 63bb0d
		sort.Sort(keys)
Packit 63bb0d
		for _, k := range keys {
Packit 63bb0d
			e.marshal("", k)
Packit 63bb0d
			e.marshal("", in.MapIndex(k))
Packit 63bb0d
		}
Packit 63bb0d
	})
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) itemsv(tag string, in reflect.Value) {
Packit 63bb0d
	e.mappingv(tag, func() {
Packit 63bb0d
		slice := in.Convert(reflect.TypeOf([]MapItem{})).Interface().([]MapItem)
Packit 63bb0d
		for _, item := range slice {
Packit 63bb0d
			e.marshal("", reflect.ValueOf(item.Key))
Packit 63bb0d
			e.marshal("", reflect.ValueOf(item.Value))
Packit 63bb0d
		}
Packit 63bb0d
	})
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) structv(tag string, in reflect.Value) {
Packit 63bb0d
	sinfo, err := getStructInfo(in.Type())
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		panic(err)
Packit 63bb0d
	}
Packit 63bb0d
	e.mappingv(tag, func() {
Packit 63bb0d
		for _, info := range sinfo.FieldsList {
Packit 63bb0d
			var value reflect.Value
Packit 63bb0d
			if info.Inline == nil {
Packit 63bb0d
				value = in.Field(info.Num)
Packit 63bb0d
			} else {
Packit 63bb0d
				value = in.FieldByIndex(info.Inline)
Packit 63bb0d
			}
Packit 63bb0d
			if info.OmitEmpty && isZero(value) {
Packit 63bb0d
				continue
Packit 63bb0d
			}
Packit 63bb0d
			e.marshal("", reflect.ValueOf(info.Key))
Packit 63bb0d
			e.flow = info.Flow
Packit 63bb0d
			e.marshal("", value)
Packit 63bb0d
		}
Packit 63bb0d
		if sinfo.InlineMap >= 0 {
Packit 63bb0d
			m := in.Field(sinfo.InlineMap)
Packit 63bb0d
			if m.Len() > 0 {
Packit 63bb0d
				e.flow = false
Packit 63bb0d
				keys := keyList(m.MapKeys())
Packit 63bb0d
				sort.Sort(keys)
Packit 63bb0d
				for _, k := range keys {
Packit 63bb0d
					if _, found := sinfo.FieldsMap[k.String()]; found {
Packit 63bb0d
						panic(fmt.Sprintf("Can't have key %q in inlined map; conflicts with struct field", k.String()))
Packit 63bb0d
					}
Packit 63bb0d
					e.marshal("", k)
Packit 63bb0d
					e.flow = false
Packit 63bb0d
					e.marshal("", m.MapIndex(k))
Packit 63bb0d
				}
Packit 63bb0d
			}
Packit 63bb0d
		}
Packit 63bb0d
	})
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) mappingv(tag string, f func()) {
Packit 63bb0d
	implicit := tag == ""
Packit 63bb0d
	style := yaml_BLOCK_MAPPING_STYLE
Packit 63bb0d
	if e.flow {
Packit 63bb0d
		e.flow = false
Packit 63bb0d
		style = yaml_FLOW_MAPPING_STYLE
Packit 63bb0d
	}
Packit 63bb0d
	yaml_mapping_start_event_initialize(&e.event, nil, []byte(tag), implicit, style)
Packit 63bb0d
	e.emit()
Packit 63bb0d
	f()
Packit 63bb0d
	yaml_mapping_end_event_initialize(&e.event)
Packit 63bb0d
	e.emit()
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) slicev(tag string, in reflect.Value) {
Packit 63bb0d
	implicit := tag == ""
Packit 63bb0d
	style := yaml_BLOCK_SEQUENCE_STYLE
Packit 63bb0d
	if e.flow {
Packit 63bb0d
		e.flow = false
Packit 63bb0d
		style = yaml_FLOW_SEQUENCE_STYLE
Packit 63bb0d
	}
Packit 63bb0d
	e.must(yaml_sequence_start_event_initialize(&e.event, nil, []byte(tag), implicit, style))
Packit 63bb0d
	e.emit()
Packit 63bb0d
	n := in.Len()
Packit 63bb0d
	for i := 0; i < n; i++ {
Packit 63bb0d
		e.marshal("", in.Index(i))
Packit 63bb0d
	}
Packit 63bb0d
	e.must(yaml_sequence_end_event_initialize(&e.event))
Packit 63bb0d
	e.emit()
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// isBase60 returns whether s is in base 60 notation as defined in YAML 1.1.
Packit 63bb0d
//
Packit 63bb0d
// The base 60 float notation in YAML 1.1 is a terrible idea and is unsupported
Packit 63bb0d
// in YAML 1.2 and by this package, but these should be marshalled quoted for
Packit 63bb0d
// the time being for compatibility with other parsers.
Packit 63bb0d
func isBase60Float(s string) (result bool) {
Packit 63bb0d
	// Fast path.
Packit 63bb0d
	if s == "" {
Packit 63bb0d
		return false
Packit 63bb0d
	}
Packit 63bb0d
	c := s[0]
Packit 63bb0d
	if !(c == '+' || c == '-' || c >= '0' && c <= '9') || strings.IndexByte(s, ':') < 0 {
Packit 63bb0d
		return false
Packit 63bb0d
	}
Packit 63bb0d
	// Do the full match.
Packit 63bb0d
	return base60float.MatchString(s)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// From http://yaml.org/type/float.html, except the regular expression there
Packit 63bb0d
// is bogus. In practice parsers do not enforce the "\.[0-9_]*" suffix.
Packit 63bb0d
var base60float = regexp.MustCompile(`^[-+]?[0-9][0-9_]*(?::[0-5]?[0-9])+(?:\.[0-9_]*)?$`)
Packit 63bb0d
Packit 63bb0d
func (e *encoder) stringv(tag string, in reflect.Value) {
Packit 63bb0d
	var style yaml_scalar_style_t
Packit 63bb0d
	s := in.String()
Packit 63bb0d
	canUsePlain := true
Packit 63bb0d
	switch {
Packit 63bb0d
	case !utf8.ValidString(s):
Packit 63bb0d
		if tag == yaml_BINARY_TAG {
Packit 63bb0d
			failf("explicitly tagged !!binary data must be base64-encoded")
Packit 63bb0d
		}
Packit 63bb0d
		if tag != "" {
Packit 63bb0d
			failf("cannot marshal invalid UTF-8 data as %s", shortTag(tag))
Packit 63bb0d
		}
Packit 63bb0d
		// It can't be encoded directly as YAML so use a binary tag
Packit 63bb0d
		// and encode it as base64.
Packit 63bb0d
		tag = yaml_BINARY_TAG
Packit 63bb0d
		s = encodeBase64(s)
Packit 63bb0d
	case tag == "":
Packit 63bb0d
		// Check to see if it would resolve to a specific
Packit 63bb0d
		// tag when encoded unquoted. If it doesn't,
Packit 63bb0d
		// there's no need to quote it.
Packit 63bb0d
		rtag, _ := resolve("", s)
Packit 63bb0d
		canUsePlain = rtag == yaml_STR_TAG && !isBase60Float(s)
Packit 63bb0d
	}
Packit 63bb0d
	// Note: it's possible for user code to emit invalid YAML
Packit 63bb0d
	// if they explicitly specify a tag and a string containing
Packit 63bb0d
	// text that's incompatible with that tag.
Packit 63bb0d
	switch {
Packit 63bb0d
	case strings.Contains(s, "\n"):
Packit 63bb0d
		style = yaml_LITERAL_SCALAR_STYLE
Packit 63bb0d
	case canUsePlain:
Packit 63bb0d
		style = yaml_PLAIN_SCALAR_STYLE
Packit 63bb0d
	default:
Packit 63bb0d
		style = yaml_DOUBLE_QUOTED_SCALAR_STYLE
Packit 63bb0d
	}
Packit 63bb0d
	e.emitScalar(s, "", tag, style)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) boolv(tag string, in reflect.Value) {
Packit 63bb0d
	var s string
Packit 63bb0d
	if in.Bool() {
Packit 63bb0d
		s = "true"
Packit 63bb0d
	} else {
Packit 63bb0d
		s = "false"
Packit 63bb0d
	}
Packit 63bb0d
	e.emitScalar(s, "", tag, yaml_PLAIN_SCALAR_STYLE)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) intv(tag string, in reflect.Value) {
Packit 63bb0d
	s := strconv.FormatInt(in.Int(), 10)
Packit 63bb0d
	e.emitScalar(s, "", tag, yaml_PLAIN_SCALAR_STYLE)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) uintv(tag string, in reflect.Value) {
Packit 63bb0d
	s := strconv.FormatUint(in.Uint(), 10)
Packit 63bb0d
	e.emitScalar(s, "", tag, yaml_PLAIN_SCALAR_STYLE)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) timev(tag string, in reflect.Value) {
Packit 63bb0d
	t := in.Interface().(time.Time)
Packit 63bb0d
	s := t.Format(time.RFC3339Nano)
Packit 63bb0d
	e.emitScalar(s, "", tag, yaml_PLAIN_SCALAR_STYLE)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) floatv(tag string, in reflect.Value) {
Packit 63bb0d
	// Issue #352: When formatting, use the precision of the underlying value
Packit 63bb0d
	precision := 64
Packit 63bb0d
	if in.Kind() == reflect.Float32 {
Packit 63bb0d
		precision = 32
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	s := strconv.FormatFloat(in.Float(), 'g', -1, precision)
Packit 63bb0d
	switch s {
Packit 63bb0d
	case "+Inf":
Packit 63bb0d
		s = ".inf"
Packit 63bb0d
	case "-Inf":
Packit 63bb0d
		s = "-.inf"
Packit 63bb0d
	case "NaN":
Packit 63bb0d
		s = ".nan"
Packit 63bb0d
	}
Packit 63bb0d
	e.emitScalar(s, "", tag, yaml_PLAIN_SCALAR_STYLE)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) nilv() {
Packit 63bb0d
	e.emitScalar("null", "", "", yaml_PLAIN_SCALAR_STYLE)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (e *encoder) emitScalar(value, anchor, tag string, style yaml_scalar_style_t) {
Packit 63bb0d
	implicit := tag == ""
Packit 63bb0d
	e.must(yaml_scalar_event_initialize(&e.event, []byte(anchor), []byte(tag), []byte(value), implicit, implicit, style))
Packit 63bb0d
	e.emit()
Packit 63bb0d
}