log

type Context interface {
	//clear context content
	Clear()

	//finally output function.
	Z()

	//get log level of context.
	Level() int
	//set log level to context. just available before any assemble function.
	SetLevel(level int)

	//add a temporay prefix in current log message util Z().
	Pre(prefix string) Context

	//formatted key-value message field.
	FS(key string, val string) Context  //string value
	FI(key string, val int64) Context   //integer value
	FU(key string, val uint64) Context  //unsigned integer value
	FD(key string, val float64) Context //double-float value
	FX(key string, val uint64) Context  //hex value

	//formatted key-value message custommed field.
	FT(key string, val FmtField) Context

	//add a message string.
	P(msg string) Context
	//add a message string with format string and args.
	PF(format string, args ...interface{}) Context
}

type ContextAllowTar interface {
	Context

	//add a target in current log message util Z().
	Tar(t Target) ContextAllowTar
	//only use this target in current log message util Z().
	UniTar(t Target) Context
}

type ContextBase struct {
	//common config info from handler
	Common *HandlerCommon
	// contains filtered or unexported fields
}

type ContextBaseAssembleFunc func(*ContextBase) string

type ContextNil struct {
}

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

type FFArrFloat64 []float64

type FFArrInt64 []int64

type FFArrString []string

type FFArrUint64 []uint64

type FFMapStringFloat64 map[string]float64

type FFMapStringInt64 map[string]int64

type FFMapStringString map[string]string

type FFMapStringUint64 map[string]uint64

type FmtField interface {
	//assemble field content as line with seperator
	AssembleAsLineSeperator(*strings.Builder, *HandlerCommon)
	//assemble field content as json string
	AssembleAsJSON(*strings.Builder, *HandlerCommon)
}

type FuncTimeFmt func(*strings.Builder, time.Time)

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

type HandlerCommon struct {
	//seperator char between message field.
	Sep string
	//seperator char in format message field.
	SepFmt string

	//time format function bond with handler.
	TimeFmt FuncTimeFmt

	//outputting target list.
	Targets []Target

	//prefixes
	Prefixes [][2]string
	//prefix string cache
	PrefixStr string

	//switch of code line outputting
	BCodeLine bool

	//switch of JSON assemble using
	UseJSONAssemble bool
}

type HandlerConfig struct {
	//log level
	Level int `json:"level,omitempty"`

	//seperator char between message field
	Seperator string `json:"seperator,omitempty"`
	//seperator char in format message field
	FmtSeperator string `json:"fmt_seperator,omitempty"`

	//switch of code line outputting
	BCodeLine bool `json:"b_code_line,omitempty"`

	//switch of assemble message using JSON
	BUseJSONAssemble bool `json:"b_use_json_assemble,omitempty"`

	//size of idle context instance in handler context pool
	ContextPoolSize int
}

type Logger interface {
	//start logging message
	Ctx() ContextAllowTar

	//start logging message with specify log level
	TRC() ContextAllowTar
	DBG() ContextAllowTar
	INF() ContextAllowTar
	WAR() ContextAllowTar
	ERR() ContextAllowTar
	FAT() ContextAllowTar
}

type LoggerHandler interface {
	//LoggerHandler is a superset of Logger.
	Logger

	//clone a new LoggerHandler instance with same configuration.
	//context will not be clone.
	Clone() LoggerHandler

	//bind time format function.
	//time format function is used to format time "now" for outputting log message.
	//if param f is nil, log message have no time string.
	BindTimeFmt(f FuncTimeFmt)

	//set seperator of log format. default seperator is "|".
	SetSeperator(sep string)

	//get current log level
	Level() int
	//set log level for handler.
	SetLevel(l int)

	//add a output target to handler.
	AddTarget(t Target)
	//del a output target from handler.
	DelTarget(name string)

	//add a prefix.
	//every prefix string will be joined to every log message.
	//param key is a inner identifier. only param value will be joined to message.
	AddPrefix(key, val string)
	//delete a prefix by key.
	DelPrefix(key string)

	//switch whether outputting code line in log message.
	SwitchCodeLine(b bool)

	//switch whether use json to assemble log message.
	SwitchJSONAssemble(b bool)

	//release log handler resources
	Release()
}

type RotateConfig struct {
	Dir    string
	Prefix string
	Ext    string

	//seconds
	RotateDuring int64

	//bytes
	RotateSize int64
}

type Target interface {
	//name of target.
	Name() string

	//using count of target
	IncrUsing()

	//check whether target need ignore a log message.
	//param l is log level.
	IsIgnore(l int) bool

	//output message
	Put(msg string)

	//close target resources
	Close()
}

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

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

type TargetStdout struct {
}