lib/encoder: move definitions here and remove uint casts

fs/encodings/encodings.go

@@ -9,23 +9,13 @@ import (
 	"github.com/rclone/rclone/lib/encoder"
 )
 
-// Base only encodes the zero byte and slash
-const Base = encoder.MultiEncoder(
-	encoder.EncodeZero |
-		encoder.EncodeSlash |
-		encoder.EncodeDot)
-
-// Display is the internal encoding for logging and output
-const Display = encoder.Standard
-
 // LocalUnix is the encoding used by the local backend for non windows platforms
-const LocalUnix = Base
+const LocalUnix = encoder.Base
 
 // LocalMacOS is the encoding used by the local backend for macOS
 //
 // macOS can't store invalid UTF-8, it converts them into %XX encoding
-const LocalMacOS = encoder.MultiEncoder(
+const LocalMacOS = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeInvalidUtf8)
 
 // LocalWindows is the encoding used by the local backend for windows platforms
@@ -48,8 +38,7 @@ const LocalMacOS = encoder.MultiEncoder(
 // Also encode invalid UTF-8 bytes as Go can't convert them to UTF-16.
 //
 // https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a-file#naming-conventions
-const LocalWindows = encoder.MultiEncoder(
+const LocalWindows = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeWin |
 	encoder.EncodeBackSlash |
 	encoder.EncodeCtl |
@@ -60,8 +49,7 @@ const LocalWindows = encoder.MultiEncoder(
 // AmazonCloudDrive is the encoding used by the amazonclouddrive backend
 //
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
-const AmazonCloudDrive = encoder.MultiEncoder(
+const AmazonCloudDrive = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeInvalidUtf8)
 
 // B2 is the encoding used by the b2 backend
@@ -69,8 +57,7 @@ const AmazonCloudDrive = encoder.MultiEncoder(
 // See: https://www.backblaze.com/b2/docs/files.html
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
 // FIXME: allow /, but not leading, trailing or double
-const B2 = encoder.MultiEncoder(
+const B2 = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeInvalidUtf8)
 
@@ -83,8 +70,7 @@ const B2 = encoder.MultiEncoder(
 //
 // Testing revealed names with leading spaces work fine.
 // Also encode invalid UTF-8 bytes as json doesn't handle them properly.
-const Box = encoder.MultiEncoder(
+const Box = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeRightSpace |
 	encoder.EncodeInvalidUtf8)
@@ -93,8 +79,7 @@ const Box = encoder.MultiEncoder(
 //
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
 // Don't encode / as it's a valid name character in drive.
-const Drive = encoder.MultiEncoder(
+const Drive = (encoder.EncodeInvalidUtf8)
-	encoder.EncodeInvalidUtf8)
 
 // Dropbox is the encoding used by the dropbox backend
 //
@@ -102,16 +87,14 @@ const Drive = encoder.MultiEncoder(
 // as invalid characters.
 // Testing revealed names with trailing spaces and the DEL character don't work.
 // Also encode invalid UTF-8 bytes as json doesn't handle them properly.
-const Dropbox = encoder.MultiEncoder(
+const Dropbox = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeDel |
 	encoder.EncodeRightSpace |
 	encoder.EncodeInvalidUtf8)
 
 // GoogleCloudStorage is the encoding used by the googlecloudstorage backend
-const GoogleCloudStorage = encoder.MultiEncoder(
+const GoogleCloudStorage = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeCrLf |
 	encoder.EncodeInvalidUtf8)
 
@@ -120,24 +103,21 @@ const GoogleCloudStorage = encoder.MultiEncoder(
 // Encode invalid UTF-8 bytes as xml doesn't handle them properly.
 //
 // Also: '*', '/', ':', '<', '>', '?', '\"', '\x00', '|'
-const JottaCloud = encoder.MultiEncoder(
+const JottaCloud = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeWin | // :?"*<>|
 	encoder.EncodeInvalidUtf8)
 
 // Koofr is the encoding used by the koofr backend
 //
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
-const Koofr = encoder.MultiEncoder(
+const Koofr = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeInvalidUtf8)
 
 // Mailru is the encoding used by the mailru backend
 //
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
-const Mailru = encoder.MultiEncoder(
+const Mailru = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeWin | // :?"*<>|
 	encoder.EncodeBackSlash |
 	encoder.EncodeInvalidUtf8)
@@ -145,8 +125,7 @@ const Mailru = encoder.MultiEncoder(
 // Mega is the encoding used by the mega backend
 //
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
-const Mega = encoder.MultiEncoder(
+const Mega = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeInvalidUtf8)
 
 // OneDrive is the encoding used by the onedrive backend
@@ -184,8 +163,7 @@ const Mega = encoder.MultiEncoder(
 // the same rules as the Windows naming conventions.
 //
 // https://docs.microsoft.com/en-us/onedrive/developer/rest-api/concepts/addressing-driveitems?view=odsp-graph-online#path-encoding
-const OneDrive = encoder.MultiEncoder(
+const OneDrive = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeHashPercent |
 	encoder.EncodeLeftSpace |
@@ -218,8 +196,7 @@ const OneDrive = encoder.MultiEncoder(
 // Also encode invalid UTF-8 bytes as json doesn't handle them properly.
 //
 // https://www.opendrive.com/wp-content/uploads/guides/OpenDrive_API_guide.pdf
-const OpenDrive = encoder.MultiEncoder(
+const OpenDrive = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeWin |
 	encoder.EncodeLeftCrLfHtVt |
 	encoder.EncodeRightCrLfHtVt |
@@ -231,8 +208,7 @@ const OpenDrive = encoder.MultiEncoder(
 // PremiumizeMe is the encoding used by the premiumizeme backend
 //
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
-const PremiumizeMe = encoder.MultiEncoder(
+const PremiumizeMe = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeDoubleQuote |
 	encoder.EncodeInvalidUtf8)
@@ -242,8 +218,7 @@ const PremiumizeMe = encoder.MultiEncoder(
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
 //
 // TODO: Investigate Unicode simplification (＼ gets converted to \ server-side)
-const Pcloud = encoder.MultiEncoder(
+const Pcloud = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeInvalidUtf8)
 
@@ -252,8 +227,7 @@ const Pcloud = encoder.MultiEncoder(
 // Note that \ is renamed to -
 //
 // Encode invalid UTF-8 bytes as json doesn't handle them properly.
-const Putio = encoder.MultiEncoder(
+const Putio = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeInvalidUtf8)
 
@@ -270,8 +244,7 @@ const Putio = encoder.MultiEncoder(
 // 		'`':  '｀', // FULLWIDTH GRAVE ACCENT
 //
 // Leading space and trailing space
-const Fichier = encoder.MultiEncoder(
+const Fichier = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeBackSlash |
 	encoder.EncodeSingleQuote |
 	encoder.EncodeBackQuote |
@@ -289,8 +262,7 @@ const Fichier = encoder.MultiEncoder(
 //
 // proftpd can't handle '*' in file names
 // pureftpd can't handle '[', ']' or '*'
-const FTP = encoder.MultiEncoder(
+const FTP = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeRightSpace)
 
 // S3 is the encoding used by the s3 backend
@@ -305,19 +277,16 @@ const FTP = encoder.MultiEncoder(
 // - doubled / encoding
 // - trailing / encoding
 // so that AWS keys are always valid file names
-const S3 = encoder.MultiEncoder(
+const S3 = (encoder.EncodeInvalidUtf8 |
-	encoder.EncodeInvalidUtf8 |
 	encoder.EncodeSlash |
 	encoder.EncodeDot)
 
 // Swift is the encoding used by the swift backend
-const Swift = encoder.MultiEncoder(
+const Swift = (encoder.EncodeInvalidUtf8 |
-	encoder.EncodeInvalidUtf8 |
 	encoder.EncodeSlash)
 
 // AzureBlob is the encoding used by the azureblob backend
-const AzureBlob = encoder.MultiEncoder(
+const AzureBlob = (encoder.EncodeInvalidUtf8 |
-	encoder.EncodeInvalidUtf8 |
 	encoder.EncodeSlash |
 	encoder.EncodeCtl |
 	encoder.EncodeDel |
@@ -325,14 +294,12 @@ const AzureBlob = encoder.MultiEncoder(
 	encoder.EncodeRightPeriod)
 
 // QingStor is the encoding used by the qingstor backend
-const QingStor = encoder.MultiEncoder(
+const QingStor = (encoder.EncodeInvalidUtf8 |
-	encoder.EncodeInvalidUtf8 |
 	encoder.EncodeCtl |
 	encoder.EncodeSlash)
 
 // Sharefile is the encoding used by the sharefile backend
-const Sharefile = encoder.MultiEncoder(
+const Sharefile = (encoder.Base |
-	uint(Base) |
 	encoder.EncodeWin | // :?"*<>|
 	encoder.EncodeBackSlash | // \
 	encoder.EncodeCtl |
@@ -346,17 +313,16 @@ const Sharefile = encoder.MultiEncoder(
 //
 // Of the control characters \t \n \r are allowed
 // it doesn't seem worth making an exception for this
-const Yandex = encoder.MultiEncoder(
+const Yandex = (encoder.Display |
-	uint(Display) |
 	encoder.EncodeInvalidUtf8)
 
 // ByName returns the encoder for a give backend name or nil
 func ByName(name string) encoder.Encoder {
 	switch strings.ToLower(name) {
 	case "base":
-		return Base
+		return encoder.Base
 	case "display":
-		return Display
+		return encoder.Display
 	case "amazonclouddrive":
 		return AmazonCloudDrive
 	case "azureblob":

lib/encoder/encoder.go

@@ -37,8 +37,8 @@ const (
 
 // Possible flags for the MultiEncoder
 const (
-	EncodeZero          uint = 0         // NUL(0x00)
+	EncodeZero          MultiEncoder = 0         // NUL(0x00)
-	EncodeSlash         uint = 1 << iota // /
+	EncodeSlash         MultiEncoder = 1 << iota // /
 	EncodeLtGt                                   // <>
 	EncodeDoubleQuote                            // "
 	EncodeSingleQuote                            // '
@@ -70,8 +70,8 @@ const (
 )
 
 // Has returns true if flag is contained in mask
-func (mask MultiEncoder) Has(flag uint) bool {
+func (mask MultiEncoder) Has(flag MultiEncoder) bool {
-	return uint(mask)&flag != 0
+	return mask&flag != 0
 }
 
 // Encoder can transform names to and from the original and translated version.

lib/encoder/encoder_test.go

@@ -19,7 +19,7 @@ var (
 
 func TestEncodeString(t *testing.T) {
 	for _, test := range []struct {
-		mask uint
+		mask MultiEncoder
 		want string
 	}{
 		{0, "None"},
@@ -31,7 +31,7 @@ func TestEncodeString(t *testing.T) {
 		{EncodeSlash | EncodeDollar | EncodeColon, "Slash,Dollar,Colon"},
 		{EncodeSlash | (1 << 31), "Slash,0x80000000"},
 	} {
-		got := MultiEncoder(test.mask).String()
+		got := test.mask.String()
 		assert.Equal(t, test.want, got)
 	}
 
@@ -40,7 +40,7 @@ func TestEncodeString(t *testing.T) {
 func TestEncodeSet(t *testing.T) {
 	for _, test := range []struct {
 		in      string
-		want    uint
+		want    MultiEncoder
 		wantErr bool
 	}{
 		{"", 0, true},
@@ -58,20 +58,20 @@ func TestEncodeSet(t *testing.T) {
 		var got MultiEncoder
 		err := got.Set(test.in)
 		assert.Equal(t, test.wantErr, err != nil, err)
-		assert.Equal(t, MultiEncoder(test.want), got, test.in)
+		assert.Equal(t, test.want, got, test.in)
 	}
 
 }
 
 type testCase struct {
-	mask uint
+	mask MultiEncoder
 	in   string
 	out  string
 }
 
 func TestEncodeSingleMask(t *testing.T) {
 	for i, tc := range testCasesSingle {
-		e := MultiEncoder(tc.mask)
+		e := tc.mask
 		t.Run(strconv.FormatInt(int64(i), 10), func(t *testing.T) {
 			got := e.Encode(tc.in)
 			if got != tc.out {
@@ -87,7 +87,7 @@ func TestEncodeSingleMask(t *testing.T) {
 
 func TestEncodeSingleMaskEdge(t *testing.T) {
 	for i, tc := range testCasesSingleEdge {
-		e := MultiEncoder(tc.mask)
+		e := tc.mask
 		t.Run(strconv.FormatInt(int64(i), 10), func(t *testing.T) {
 			got := e.Encode(tc.in)
 			if got != tc.out {
@@ -103,7 +103,7 @@ func TestEncodeSingleMaskEdge(t *testing.T) {
 
 func TestEncodeDoubleMaskEdge(t *testing.T) {
 	for i, tc := range testCasesDoubleEdge {
-		e := MultiEncoder(tc.mask)
+		e := tc.mask
 		t.Run(strconv.FormatInt(int64(i), 10), func(t *testing.T) {
 			got := e.Encode(tc.in)
 			if got != tc.out {
@@ -161,7 +161,7 @@ func TestEncodeInvalidUnicode(t *testing.T) {
 			out:  "a\xBF＼\xFEb",
 		},
 	} {
-		e := MultiEncoder(tc.mask)
+		e := tc.mask
 		t.Run(strconv.FormatInt(int64(i), 10), func(t *testing.T) {
 			got := e.Encode(tc.in)
 			if got != tc.out {
@@ -203,7 +203,7 @@ func TestEncodeDot(t *testing.T) {
 			out:  ". .",
 		},
 	} {
-		e := MultiEncoder(tc.mask)
+		e := tc.mask
 		t.Run(strconv.FormatInt(int64(i), 10), func(t *testing.T) {
 			got := e.Encode(tc.in)
 			if got != tc.out {
@@ -245,7 +245,7 @@ func TestDecodeHalf(t *testing.T) {
 			out:  "a‛B\\‛Eg",
 		},
 	} {
-		e := MultiEncoder(tc.mask)
+		e := tc.mask
 		t.Run(strconv.FormatInt(int64(i), 10), func(t *testing.T) {
 			got := e.Decode(tc.in)
 			if got != tc.out {
@@ -255,8 +255,7 @@ func TestDecodeHalf(t *testing.T) {
 	}
 }
 
-const oneDrive = MultiEncoder(
+const oneDrive = (Standard |
-	uint(Standard) |
 	EncodeWin |
 	EncodeBackSlash |
 	EncodeHashPercent |

lib/encoder/internal/gen/main.go

@@ -20,7 +20,7 @@ const (
 )
 
 type mapping struct {
-	mask     uint
+	mask     encoder.MultiEncoder
 	src, dst []rune
 }
 type stringPair struct {
@@ -36,7 +36,7 @@ package encoder
 `
 
 var maskBits = []struct {
-	mask uint
+	mask encoder.MultiEncoder
 	name string
 }{
 	{encoder.EncodeZero, "EncodeZero"},
@@ -68,7 +68,7 @@ var maskBits = []struct {
 }
 
 type edge struct {
-	mask    uint
+	mask    encoder.MultiEncoder
 	name    string
 	edge    int
 	orig    []rune
@@ -429,7 +429,7 @@ func fatalW(_ int, err error) func(...interface{}) {
 	return func(s ...interface{}) {}
 }
 
-func invalidMask(mask uint) bool {
+func invalidMask(mask encoder.MultiEncoder) bool {
 	return mask&(encoder.EncodeCtl|encoder.EncodeCrLf) != 0 && mask&(encoder.EncodeLeftCrLfHtVt|encoder.EncodeRightCrLfHtVt) != 0
 }
 
@@ -445,7 +445,7 @@ func runeRange(l, h rune) []rune {
 	return out
 }
 
-func getMapping(mask uint) mapping {
+func getMapping(mask encoder.MultiEncoder) mapping {
 	for _, m := range allMappings {
 		if m.mask == mask {
 			return m

lib/encoder/standard.go

@@ -7,9 +7,16 @@ package encoder
 // List of replaced characters:
 //     (0x00)  -> '␀' // SYMBOL FOR NULL
 //   / (slash) -> '／' // FULLWIDTH SOLIDUS
-const Standard = MultiEncoder(
+const Standard = (EncodeZero |
-	EncodeZero |
 	EncodeSlash |
 	EncodeCtl |
 	EncodeDel |
 	EncodeDot)
+
+// Base only encodes the zero byte and slash
+const Base = (EncodeZero |
+	EncodeSlash |
+	EncodeDot)
+
+// Display is the internal encoding for logging and output
+const Display = Standard