2021-08-30 19:45:06 +02:00
package json
import (
"context"
"io"
2022-07-16 11:43:41 +02:00
"os"
2021-08-30 19:45:06 +02:00
"unsafe"
"github.com/goccy/go-json/internal/encoder"
"github.com/goccy/go-json/internal/encoder/vm"
"github.com/goccy/go-json/internal/encoder/vm_color"
"github.com/goccy/go-json/internal/encoder/vm_color_indent"
"github.com/goccy/go-json/internal/encoder/vm_indent"
)
// An Encoder writes JSON values to an output stream.
type Encoder struct {
w io . Writer
enabledIndent bool
enabledHTMLEscape bool
prefix string
indentStr string
}
// NewEncoder returns a new encoder that writes to w.
func NewEncoder ( w io . Writer ) * Encoder {
return & Encoder { w : w , enabledHTMLEscape : true }
}
// Encode writes the JSON encoding of v to the stream, followed by a newline character.
//
// See the documentation for Marshal for details about the conversion of Go values to JSON.
func ( e * Encoder ) Encode ( v interface { } ) error {
return e . EncodeWithOption ( v )
}
// EncodeWithOption call Encode with EncodeOption.
func ( e * Encoder ) EncodeWithOption ( v interface { } , optFuncs ... EncodeOptionFunc ) error {
ctx := encoder . TakeRuntimeContext ( )
ctx . Option . Flag = 0
err := e . encodeWithOption ( ctx , v , optFuncs ... )
encoder . ReleaseRuntimeContext ( ctx )
return err
}
// EncodeContext call Encode with context.Context and EncodeOption.
func ( e * Encoder ) EncodeContext ( ctx context . Context , v interface { } , optFuncs ... EncodeOptionFunc ) error {
rctx := encoder . TakeRuntimeContext ( )
rctx . Option . Flag = 0
rctx . Option . Flag |= encoder . ContextOption
rctx . Option . Context = ctx
2024-08-19 03:34:22 +02:00
err := e . encodeWithOption ( rctx , v , optFuncs ... ) //nolint: contextcheck
2021-08-30 19:45:06 +02:00
encoder . ReleaseRuntimeContext ( rctx )
return err
}
func ( e * Encoder ) encodeWithOption ( ctx * encoder . RuntimeContext , v interface { } , optFuncs ... EncodeOptionFunc ) error {
if e . enabledHTMLEscape {
ctx . Option . Flag |= encoder . HTMLEscapeOption
}
2022-03-26 12:13:52 +01:00
ctx . Option . Flag |= encoder . NormalizeUTF8Option
2022-07-16 11:43:41 +02:00
ctx . Option . DebugOut = os . Stdout
2021-08-30 19:45:06 +02:00
for _ , optFunc := range optFuncs {
optFunc ( ctx . Option )
}
var (
buf [ ] byte
err error
)
if e . enabledIndent {
buf , err = encodeIndent ( ctx , v , e . prefix , e . indentStr )
} else {
buf , err = encode ( ctx , v )
}
if err != nil {
return err
}
if e . enabledIndent {
buf = buf [ : len ( buf ) - 2 ]
} else {
buf = buf [ : len ( buf ) - 1 ]
}
buf = append ( buf , '\n' )
if _ , err := e . w . Write ( buf ) ; err != nil {
return err
}
return nil
}
// SetEscapeHTML specifies whether problematic HTML characters should be escaped inside JSON quoted strings.
// The default behavior is to escape &, <, and > to \u0026, \u003c, and \u003e to avoid certain safety problems that can arise when embedding JSON in HTML.
//
// In non-HTML settings where the escaping interferes with the readability of the output, SetEscapeHTML(false) disables this behavior.
func ( e * Encoder ) SetEscapeHTML ( on bool ) {
e . enabledHTMLEscape = on
}
// SetIndent instructs the encoder to format each subsequent encoded value as if indented by the package-level function Indent(dst, src, prefix, indent).
// Calling SetIndent("", "") disables indentation.
func ( e * Encoder ) SetIndent ( prefix , indent string ) {
if prefix == "" && indent == "" {
e . enabledIndent = false
return
}
e . prefix = prefix
e . indentStr = indent
e . enabledIndent = true
}
func marshalContext ( ctx context . Context , v interface { } , optFuncs ... EncodeOptionFunc ) ( [ ] byte , error ) {
rctx := encoder . TakeRuntimeContext ( )
rctx . Option . Flag = 0
2022-03-26 12:13:52 +01:00
rctx . Option . Flag = encoder . HTMLEscapeOption | encoder . NormalizeUTF8Option | encoder . ContextOption
2021-08-30 19:45:06 +02:00
rctx . Option . Context = ctx
for _ , optFunc := range optFuncs {
optFunc ( rctx . Option )
}
2024-08-19 03:34:22 +02:00
buf , err := encode ( rctx , v ) //nolint: contextcheck
2021-08-30 19:45:06 +02:00
if err != nil {
encoder . ReleaseRuntimeContext ( rctx )
return nil , err
}
// this line exists to escape call of `runtime.makeslicecopy` .
// if use `make([]byte, len(buf)-1)` and `copy(copied, buf)`,
// dst buffer size and src buffer size are differrent.
// in this case, compiler uses `runtime.makeslicecopy`, but it is slow.
buf = buf [ : len ( buf ) - 1 ]
copied := make ( [ ] byte , len ( buf ) )
copy ( copied , buf )
encoder . ReleaseRuntimeContext ( rctx )
return copied , nil
}
func marshal ( v interface { } , optFuncs ... EncodeOptionFunc ) ( [ ] byte , error ) {
ctx := encoder . TakeRuntimeContext ( )
ctx . Option . Flag = 0
2022-03-26 12:13:52 +01:00
ctx . Option . Flag |= ( encoder . HTMLEscapeOption | encoder . NormalizeUTF8Option )
2021-08-30 19:45:06 +02:00
for _ , optFunc := range optFuncs {
optFunc ( ctx . Option )
}
buf , err := encode ( ctx , v )
if err != nil {
encoder . ReleaseRuntimeContext ( ctx )
return nil , err
}
// this line exists to escape call of `runtime.makeslicecopy` .
// if use `make([]byte, len(buf)-1)` and `copy(copied, buf)`,
// dst buffer size and src buffer size are differrent.
// in this case, compiler uses `runtime.makeslicecopy`, but it is slow.
buf = buf [ : len ( buf ) - 1 ]
copied := make ( [ ] byte , len ( buf ) )
copy ( copied , buf )
encoder . ReleaseRuntimeContext ( ctx )
return copied , nil
}
func marshalNoEscape ( v interface { } ) ( [ ] byte , error ) {
ctx := encoder . TakeRuntimeContext ( )
ctx . Option . Flag = 0
2022-03-26 12:13:52 +01:00
ctx . Option . Flag |= ( encoder . HTMLEscapeOption | encoder . NormalizeUTF8Option )
2021-08-30 19:45:06 +02:00
buf , err := encodeNoEscape ( ctx , v )
if err != nil {
encoder . ReleaseRuntimeContext ( ctx )
return nil , err
}
// this line exists to escape call of `runtime.makeslicecopy` .
// if use `make([]byte, len(buf)-1)` and `copy(copied, buf)`,
// dst buffer size and src buffer size are differrent.
// in this case, compiler uses `runtime.makeslicecopy`, but it is slow.
buf = buf [ : len ( buf ) - 1 ]
copied := make ( [ ] byte , len ( buf ) )
copy ( copied , buf )
encoder . ReleaseRuntimeContext ( ctx )
return copied , nil
}
func marshalIndent ( v interface { } , prefix , indent string , optFuncs ... EncodeOptionFunc ) ( [ ] byte , error ) {
ctx := encoder . TakeRuntimeContext ( )
ctx . Option . Flag = 0
2022-03-26 12:13:52 +01:00
ctx . Option . Flag |= ( encoder . HTMLEscapeOption | encoder . NormalizeUTF8Option | encoder . IndentOption )
2021-08-30 19:45:06 +02:00
for _ , optFunc := range optFuncs {
optFunc ( ctx . Option )
}
buf , err := encodeIndent ( ctx , v , prefix , indent )
if err != nil {
encoder . ReleaseRuntimeContext ( ctx )
return nil , err
}
buf = buf [ : len ( buf ) - 2 ]
copied := make ( [ ] byte , len ( buf ) )
copy ( copied , buf )
encoder . ReleaseRuntimeContext ( ctx )
return copied , nil
}
func encode ( ctx * encoder . RuntimeContext , v interface { } ) ( [ ] byte , error ) {
b := ctx . Buf [ : 0 ]
if v == nil {
b = encoder . AppendNull ( ctx , b )
b = encoder . AppendComma ( ctx , b )
return b , nil
}
header := ( * emptyInterface ) ( unsafe . Pointer ( & v ) )
typ := header . typ
typeptr := uintptr ( unsafe . Pointer ( typ ) )
2022-03-26 12:13:52 +01:00
codeSet , err := encoder . CompileToGetCodeSet ( ctx , typeptr )
2021-08-30 19:45:06 +02:00
if err != nil {
return nil , err
}
p := uintptr ( header . ptr )
ctx . Init ( p , codeSet . CodeLength )
ctx . KeepRefs = append ( ctx . KeepRefs , header . ptr )
buf , err := encodeRunCode ( ctx , b , codeSet )
if err != nil {
return nil , err
}
ctx . Buf = buf
return buf , nil
}
func encodeNoEscape ( ctx * encoder . RuntimeContext , v interface { } ) ( [ ] byte , error ) {
b := ctx . Buf [ : 0 ]
if v == nil {
b = encoder . AppendNull ( ctx , b )
b = encoder . AppendComma ( ctx , b )
return b , nil
}
header := ( * emptyInterface ) ( unsafe . Pointer ( & v ) )
typ := header . typ
typeptr := uintptr ( unsafe . Pointer ( typ ) )
2022-03-26 12:13:52 +01:00
codeSet , err := encoder . CompileToGetCodeSet ( ctx , typeptr )
2021-08-30 19:45:06 +02:00
if err != nil {
return nil , err
}
p := uintptr ( header . ptr )
ctx . Init ( p , codeSet . CodeLength )
buf , err := encodeRunCode ( ctx , b , codeSet )
if err != nil {
return nil , err
}
ctx . Buf = buf
return buf , nil
}
func encodeIndent ( ctx * encoder . RuntimeContext , v interface { } , prefix , indent string ) ( [ ] byte , error ) {
b := ctx . Buf [ : 0 ]
if v == nil {
b = encoder . AppendNull ( ctx , b )
b = encoder . AppendCommaIndent ( ctx , b )
return b , nil
}
header := ( * emptyInterface ) ( unsafe . Pointer ( & v ) )
typ := header . typ
typeptr := uintptr ( unsafe . Pointer ( typ ) )
2022-03-26 12:13:52 +01:00
codeSet , err := encoder . CompileToGetCodeSet ( ctx , typeptr )
2021-08-30 19:45:06 +02:00
if err != nil {
return nil , err
}
p := uintptr ( header . ptr )
ctx . Init ( p , codeSet . CodeLength )
buf , err := encodeRunIndentCode ( ctx , b , codeSet , prefix , indent )
ctx . KeepRefs = append ( ctx . KeepRefs , header . ptr )
if err != nil {
return nil , err
}
ctx . Buf = buf
return buf , nil
}
func encodeRunCode ( ctx * encoder . RuntimeContext , b [ ] byte , codeSet * encoder . OpcodeSet ) ( [ ] byte , error ) {
if ( ctx . Option . Flag & encoder . DebugOption ) != 0 {
if ( ctx . Option . Flag & encoder . ColorizeOption ) != 0 {
return vm_color . DebugRun ( ctx , b , codeSet )
}
return vm . DebugRun ( ctx , b , codeSet )
}
if ( ctx . Option . Flag & encoder . ColorizeOption ) != 0 {
return vm_color . Run ( ctx , b , codeSet )
}
return vm . Run ( ctx , b , codeSet )
}
func encodeRunIndentCode ( ctx * encoder . RuntimeContext , b [ ] byte , codeSet * encoder . OpcodeSet , prefix , indent string ) ( [ ] byte , error ) {
ctx . Prefix = [ ] byte ( prefix )
ctx . IndentStr = [ ] byte ( indent )
if ( ctx . Option . Flag & encoder . DebugOption ) != 0 {
if ( ctx . Option . Flag & encoder . ColorizeOption ) != 0 {
return vm_color_indent . DebugRun ( ctx , b , codeSet )
}
return vm_indent . DebugRun ( ctx , b , codeSet )
}
if ( ctx . Option . Flag & encoder . ColorizeOption ) != 0 {
return vm_color_indent . Run ( ctx , b , codeSet )
}
return vm_indent . Run ( ctx , b , codeSet )
}