dapper

type Annotator func(Value) string

type Config struct {
	// Annotators is a set of functions that can annotate values with additional
	// information, regardless of whether the value is rendered by a filter or
	// the default rendering logic.
	Annotators []Annotator

	// Filters is the set of filters to apply when formatting values.
	//
	// Filters are applied in the order they are provided. If any filter renders
	// output all subsequent filters and the default rendering logic are
	// skipped. Any annotations are still applied.
	Filters []Filter

	// RenderPackagePaths, when true, causes the printer to render the
	// fully-qualified package path when rendering type names.
	RenderPackagePaths bool

	// RenderUnexportedStructFields, when true, causes the printer to render
	// unexported struct fields.
	RenderUnexportedStructFields bool
	// contains filtered or unexported fields
}

type Filter func(r Renderer, v Value)

type Option func(*Config)

type Printer struct {
	// contains filtered or unexported fields
}

type Renderer interface {
	io.Writer

	Config() Config

	FormatType(Value) string
	WriteType(Value)

	WriteValue(Value)
	FormatValue(Value) string

	Indent()
	Outdent()
	Print(format string, args ...any)

	WithModifiedConfig(func(*Config)) Renderer
}

type Stringer interface {
	DapperString() string
}

type Value struct {
	// Value is the value to be formatted.
	Value reflect.Value

	// DynamicType is the value's type.
	DynamicType reflect.Type

	// StaticType is the type of the "variable" that the value is stored in,
	// which may not be the same as its dynamic type.
	//
	// For example, when formatting the values within a slice of "any"
	// containing integers, such as []any{1, 2, 3}, the DynamicType will be
	// "int", but the static type will be "any".
	StaticType reflect.Type

	// IsAmbiguousDynamicType is true if the value's dynamic type is not clear from
	// the context of what has already been rendered.
	IsAmbiguousDynamicType bool

	// IsAmbiguousStaticType is true if the value's static type is not clear from
	// the context of what has already been rendered.
	IsAmbiguousStaticType bool

	// IsUnexported is true if this value was obtained from an unexported struct
	// field. If so, it is not possible to extract the underlying value.
	IsUnexported bool
}