lab.nexedi.com/kirr/go123@v0.0.0-20240207185015-8299741fa871/xfmt/python.go

// Copyright (C) 2017-2019  Nexedi SA and Contributors.
//                          Kirill Smelkov <kirr@nexedi.com>
//
// This program is free software: you can Use, Study, Modify and Redistribute
// it under the terms of the GNU General Public License version 3, or (at your
// option) any later version, as published by the Free Software Foundation.
//
// You can also Link and Combine this program with other software covered by
// the terms of any of the Free Software licenses or any of the Open Source
// Initiative approved licenses and Convey the resulting work. Corresponding
// source of such a combination shall include the source code for all other
// software used.
//
// This program is distributed WITHOUT ANY WARRANTY; without even the implied
// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
// See COPYING file for full licensing terms.
// See https://www.nexedi.com/licensing for rationale and options.

// quoting by Python rules

package xfmt

import (
	"strconv"
	"unicode/utf8"

	"lab.nexedi.com/kirr/go123/mem"
	"lab.nexedi.com/kirr/go123/xbytes"
)

// AppendQuotePy appends to buf Python quoting of s.
func AppendQuotePy(buf []byte, s string) []byte {
	return AppendQuotePyBytes(buf, mem.Bytes(s))
}

// AppendQuotePyBytes appends to buf Python quoting of b.
func AppendQuotePyBytes(buf, b []byte) []byte {
	// smartquotes: choose ' or " as quoting character
	// https://github.com/python/cpython/blob/v2.7.13-116-g1aa1803b3d/Objects/stringobject.c#L947
	quote := byte('\'')
	if xbytes.ContainsByte(b, '\'') && !xbytes.ContainsByte(b, '"') {
		quote = '"'
	}

	buf = append(buf, quote)

	for i := 0; i < len(b); {
		c := b[i]
		switch {
		// fast path - ASCII only - trying to avoid UTF-8 decoding
		case c < utf8.RuneSelf:
			switch {
				case c == '\\' || c == quote:
					buf = append(buf, '\\', c)

				case ' ' <= c && c <= '\x7e':
					// printable ASCII
					buf = append(buf, c)


				// below: non-printable ASCII

				// NOTE python converts to \<letter> only \t \n \r  (not e.g. \v)
				// https://github.com/python/cpython/blob/v2.7.13-116-g1aa1803b3d/Objects/stringobject.c#L963
				case c == '\t':
					buf = append(buf, `\t`...)
				case c == '\n':
					buf = append(buf, `\n`...)
				case c == '\r':
					buf = append(buf, `\r`...)

				default:
					// NOTE c < ' ' or c == '\x7f' (the only non-printable ASCII character > space) here
					// we already converted to \<letter> what python represents as such above
					// everything else goes in numeric byte escapes
					buf = append(buf, '\\', 'x', hexdigits[c>>4], hexdigits[c&0xf])
			}

			i++

		// slow path - full UTF-8 decoding
		default:
			r, size := utf8.DecodeRune(b[i:])
			isize := i + size

			switch {
			case r == utf8.RuneError:
				// decode error - just emit raw byte as escaped
				buf = append(buf, '\\', 'x', hexdigits[c>>4], hexdigits[c&0xf])

			case strconv.IsPrint(r):
				// printable utf-8 characters go as is
				buf = append(buf, b[i:isize]...)

			default:
				// everything else goes in numeric byte escapes
				for j := i; j < isize; j++ {
					buf = append(buf, '\\', 'x', hexdigits[b[j]>>4], hexdigits[b[j]&0xf])
				}
			}

			i = isize
		}
	}

	buf = append(buf, quote)
	return buf
}


// Qpy appends string quoted as Python would do.
func (b *Buffer) Qpy(s string) *Buffer {
	*b = AppendQuotePy(*b, s)
	return b
}

// Qpyb appends []byte quoted as Python would do.
func (b *Buffer) Qpyb(x []byte) *Buffer {
	*b = AppendQuotePyBytes(*b, x)
	return b
}

// TODO Qpyc?

// Qpycb appends byte quoted as Python would do for a single-character string.
func (b *Buffer) Qpycb(c byte) *Buffer {
	*b = AppendQuotePyBytes(*b, []byte{c})	// does not escape
	return b
}