formatter

type BufferFormatter interface {
	// FormatRecord should take the data from the record and format it as needed, storing it in the returned buffer.
	FormatRecord(context.Context, time.Time, slogx.Level, uintptr, string, []slog.Attr) (*slogx.Buffer, error)
}

type ColorBufferFormatter interface {
	BufferFormatter

	// IsColorized should return whether or not the formatter uses colorized output.
	IsColorized() bool
}

type ConsoleFormatterOptions struct {
	// AttrFormatter is the middleware formatting function to call to format any attribute.
	//
	// Attribute values should be resolved by the handler before formatting. Any value returned by the formatter should
	// be resolved prior to return.
	//
	// If nil, attributes are simply printed unchanged as key=value.
	AttrFormatter FormatAttrFn

	// EnableColor determines whether or not to enable colorized output.
	EnableColor bool

	// IgnoreAttrs is a list of regular expressions to use for matching attributes which should not be printed.
	//
	// Note that this only applies to attributes and not defined parts like the level, message, source or time. If you
	// want to ignore those, simply leave them out of the PartOrder array.
	//
	// If any regular expression does not compile, it is simply ignored.
	IgnoreAttrs []string

	// LevelFormatter is the middleware formatting function to call to format the level.
	//
	// If nil, the level is printed using FormatLevelValueDefault().
	LevelFormatter FormatLevelValueFn

	// MessageFormatter is the middlware formatting function to call to format the message.
	//
	// If nil, the message is printed as-is.
	MessageFormatter FormatMessageValueFn

	// PartOrder is the order in which to print the various parts of the message.
	//
	// The following values are valid for the string:
	// ConsoleFormatterAttrPart - specific attribute to print; use a single period (.) to separate group name from
	//                            attribute name if the attribute is nested within a group
	// ConsoleFormatterAttrRegexPart - attributes matching the regular expression to print; use an escaped period (\.)
	//                                 to separate group name from attribute name if the attribute is nested within a
	//                                 group; if the regex does not compile, it is ignored
	// ConsoleFormatterAttrsPart - all attributes
	// ConsoleFormatterLevelPart - the log level of the message from the record as a string
	// ConsoleFormatterMessagePart - the message from the record
	// ConsoleFormatterSourcePart - the location at which the message was logged
	// ConsoleFormatterTimePart - the time of the message from the record
	//
	// If any other string is specified other than those above, it is simply printed as-is.
	//
	// If an attribute is specified but not present in the record, it is ignored.
	//
	// By default the format will be "TimePart LevelPart SourcePart > MessagePart AttrsPart".
	PartOrder []ConsoleFormatterPart

	// PartSeparator is how to separate the parts when they're being printed. Must be at least 1 character.
	//
	// By default, a space is used.
	PartSeparator string

	// SortAttributes determines whether or not to sort attributes in the output.
	//
	// Note that this *only* affects the output for ConsoleFormatterAttrsPart.
	SortAttributes bool

	// SourceFormatter is the middleware formatting function to call to format the source code location where the record
	// was created.
	//
	// If nil, the source code location is printed using FormatSourceValueDefault().
	SourceFormatter FormatSourceValueFn

	// SpecificAttrFormatter is the middleware formatting function to call to format a specific attribute.
	//
	// The key for the map corresponds to the name of the specific attribute to format. If an attribute is nested within
	// a group, use a single period (.) to designate the group and attribute (eg: GROUP.ATTRIBUTE). Nested groups use
	// the same format (eg: GROUP1.GROUP2.ATTRIBUTE).
	//
	// Attribute values should be resolved by the handler before formatting. Any value returned by the formatter should
	// be resolved prior to return.
	//
	// If nil or if the attribute does not exist in the map, the default is to fall back to the AttrFormatter function.
	SpecificAttrFormatter map[string]FormatAttrFn

	// TimeFormatter is the middleware formatting function to call to the time of the record.
	//
	// If nil, the time is printed using FormatTimeValueDefault().
	TimeFormatter FormatTimeValueFn

	// UniqueAttributesOnly indicates whether or not to only print unique attributes.
	//
	// If multiple attributes are present within the same group with the same key name, only the latest attribute
	// will be printed.
	//
	// For example:
	//   logger := logger.With(slog.String("k1", "v1"))
	//   logger.Warn("this is a warning message", slog.String("k1", "v2"))
	//
	// If this value is true and the code above is used, only {"k1":"v2"} would be shown as an attribute.
	//
	// The only exception to this rule is that attributes which are not nested and overlap with the time, level, source
	// or message keys will be ignored as time, level, source and message are core parts of the output.
	UniqueAttributesOnly bool
}

type ConsoleFormatterPart string

type FormatAttrFn func(context.Context, slog.Leveler, string, string, slog.Value) (string, slog.Value, error)

type FormatLevelValueFn func(context.Context, slog.Leveler) (string, error)

type FormatMessageValueFn func(context.Context, slog.Leveler, string) (string, error)

type FormatSourceValueFn func(context.Context, slog.Leveler, uintptr) (string, error)

type FormatTimeValueFn func(context.Context, slog.Leveler, time.Time) (string, error)

type JSONFormatterOptions struct {
	// AttrFormatter is the middleware formatting function to call to format any attribute.
	//
	// Attribute values should be resolved by the handler before formatting. Any value returned by the formatter should
	// be resolved prior to return.
	//
	// If nil, attributes remain unchanged.
	AttrFormatter FormatAttrFn

	// IgnoreAttrs is a list of regular expressions to use for matching attributes which should not be printed.
	//
	// Note that this only applies to attributes and not defined parts of the record such as time, level and the
	// message itself as they are always printed. Likewise, if NestedAttributes is true, the NestedAttributeAttr
	// is always printed and if IncludeSource is true, the source is always printed.
	//
	// If any regular expression does not compile, it is simply ignored.
	IgnoreAttrs []string

	// IncludeSource determines whether or not to include the source code location of the record in the output.
	IncludeSource bool

	// LevelAttr is the name of the JSON attribute to use for the level.
	//
	// If empty, defaults to JSONFormatterLevelAttr.
	LevelAttr string

	// LevelFormatter is the middleware formatting function to call to format the level.
	//
	// If nil, the level is printed using FormatLevelValueDefault().
	LevelFormatter FormatLevelValueFn

	// MessageAttr is the name of the JSON attribute to use for the message.
	//
	// If empty, defaults to JSONFormatterMessageAttr.
	MessageAttr string

	// MessageFormatter is the middlware formatting function to call to format the message.
	//
	// If nil, the message is printed as-is.
	MessageFormatter FormatMessageValueFn

	// NestAttributes indicates whether or not to nest the record's attributes under their own key in the JSON output.
	//
	// If true, the NestedAttributeAttr will always be part of the output even if it is empty.
	NestAttributes bool

	// NetstedAttributeAttr is the name of the JSON attribute to use if nesting attributes.
	//
	// If empty, defaults to JSONFormatterNestedAttributeAttr.
	NestedAttributeAttr string

	// SortAttrs indicates whether or not to sort attributes in the output.
	//
	// Note that this *only* affects attributes and not the time, message, source or level.
	SortAttrs bool

	// SourceAttr is the name of the JSON attribute to use for the source code location.
	//
	// If empty, defaults to JSONFormatterSourceAttr.
	SourceAttr string

	// SourceFormatter is the middleware formatting function to call to format the source code location where the record
	// was created.
	//
	// If nil, the source code location is printed using FormatSourceValueDefault().
	SourceFormatter FormatSourceValueFn

	// SpecificAttrFormatter is the middleware formatting function to call to format a specific attribute.
	//
	// The key for the map corresponds to the name of the specific attribute to format. If an attribute is nested within
	// a group, use a single period (.) to designate the group and attribute (eg: GROUP.ATTRIBUTE). Nested groups use
	// the same format (eg: GROUP1.GROUP2.ATTRIBUTE).
	//
	// Attribute values should be resolved by the handler before formatting. Any value returned by the formatter should
	// be resolved prior to return.
	//
	// If nil or if the attribute does not exist in the map, the default is to fall back to the AttrFormatter function.
	SpecificAttrFormatter map[string]FormatAttrFn

	// TimeAttr is the name of the JSON attribute to use for the time of the record.
	//
	// If empty, defaults to JSONFormatterTimeAttr.
	TimeAttr string

	// TimeFormatter is the middleware formatting function to call to the time of the record.
	//
	// If nil, the time is printed using FormatTimeValueDefault().
	TimeFormatter FormatTimeValueFn
}