This repository was archived by the owner on Apr 24, 2024. It is now read-only.
forked from IronLanguages/ironpython3
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_codecs.cs
More file actions
977 lines (801 loc) · 46.5 KB
/
_codecs.cs
File metadata and controls
977 lines (801 loc) · 46.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information.
#pragma warning disable SYSLIB0001 // UTF-7 code paths are obsolete in .NET 5
#nullable enable
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Runtime.Versioning;
using System.Text;
using IronPython.Runtime;
using IronPython.Runtime.Exceptions;
using IronPython.Runtime.Operations;
using Microsoft.Scripting.Runtime;
using DisallowNullAttribute = System.Diagnostics.CodeAnalysis.DisallowNullAttribute;
[assembly: PythonModule("_codecs", typeof(IronPython.Modules.PythonCodecs))]
namespace IronPython.Modules {
public static class PythonCodecs {
public const string __doc__ = "Provides access to various codecs (ASCII, UTF7, UTF8, etc...)";
internal const int EncoderIndex = 0;
internal const int DecoderIndex = 1;
internal const int StreamReaderIndex = 2;
internal const int StreamWriterIndex = 3;
public static PythonTuple lookup(CodeContext/*!*/ context, [NotNone] string encoding)
=> PythonOps.LookupEncoding(context, encoding);
[LightThrowing]
public static object lookup_error(CodeContext/*!*/ context, [NotNone] string name)
=> PythonOps.LookupEncodingError(context, name);
public static void register(CodeContext/*!*/ context, object? search_function)
=> PythonOps.RegisterEncoding(context, search_function);
public static void register_error(CodeContext/*!*/ context, [NotNone] string name, object? handler)
=> PythonOps.RegisterEncodingError(context, name, handler);
#region ASCII Encoding
public static PythonTuple ascii_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null) {
using var buffer = input.GetBuffer();
return DoDecode(context, "ascii", Encoding.ASCII, buffer, errors).ToPythonTuple();
}
public static PythonTuple ascii_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "ascii", Encoding.ASCII, input, errors).ToPythonTuple();
#endregion
#region Charmap Encoding
/// <summary>
/// Creates an optimized encoding mapping that can be consumed by an optimized version of charmap_encode/charmap_decode.
/// </summary>
public static EncodingMap charmap_build([NotNone] string decoding_table) {
if (decoding_table.Length == 0) {
throw PythonOps.TypeError("charmap_build expected non-empty string");
}
return new EncodingMap(decoding_table, compileForDecoding: false, compileForEncoding: true);
}
/// <summary>
/// Encodes the input string with the specified optimized encoding map.
/// </summary>
public static PythonTuple charmap_encode(CodeContext context, [NotNone] string input, string? errors, [NotNone] EncodingMap map) {
return DoEncode(context, "charmap", new EncodingMapEncoding(map), input, errors).ToPythonTuple();
}
public static PythonTuple charmap_encode(CodeContext context, [NotNone] string input, string? errors = null, IDictionary<object, object>? map = null) {
if (map != null) {
return DoEncode(context, "charmap", new CharmapEncoding(map), input, errors).ToPythonTuple();
} else {
return latin_1_encode(context, input, errors);
}
}
/// <summary>
/// Decodes the input string using the provided string mapping.
/// </summary>
public static PythonTuple charmap_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors, [NotNone] string map) {
EncodingMap em = new EncodingMap(map, compileForDecoding: true, compileForEncoding: false);
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "charmap", new EncodingMapEncoding(em), buffer, errors).ToPythonTuple();
}
public static PythonTuple charmap_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, IDictionary<object, object>? map = null) {
if (map != null) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "charmap", new CharmapEncoding(map), buffer, errors).ToPythonTuple();
} else {
return latin_1_decode(context, input, errors);
}
}
#endregion
#region Generic Encoding
public static object decode(CodeContext/*!*/ context, object? obj, [NotNone, DisallowNull] string? encoding = null!, [NotNone] string errors = "strict") {
if (encoding == null) {
PythonContext lc = context.LanguageContext;
if (obj is IBufferProtocol bp) {
using IPythonBuffer buffer = bp.GetBuffer();
return StringOps.DoDecode(context, buffer, errors, lc.GetDefaultEncodingName(), lc.DefaultEncoding);
} else {
throw PythonOps.TypeError("expected bytes-like object, got {0}", PythonOps.GetPythonTypeName(obj));
}
} else {
object? decoder = lookup(context, encoding)[DecoderIndex];
if (!PythonOps.IsCallable(context, decoder)) {
throw PythonOps.TypeError("decoding with '{0}' codec failed; decoder must be callable ('{1}' object is not callable)", encoding, PythonOps.GetPythonTypeName(decoder));
}
return PythonOps.GetIndex(context, PythonCalls.Call(context, decoder, obj, errors), 0);
}
}
public static object encode(CodeContext/*!*/ context, object? obj, [NotNone, DisallowNull] string? encoding = null!, [NotNone] string errors = "strict") {
if (encoding == null) {
if (obj is string str) {
PythonContext lc = context.LanguageContext;
return StringOps.DoEncode(context, str, errors, lc.GetDefaultEncodingName(), lc.DefaultEncoding, includePreamble: true);
} else {
throw PythonOps.TypeError("expected str, got {0}", PythonOps.GetPythonTypeName(obj));
}
} else {
object? encoder = lookup(context, encoding)[EncoderIndex];
if (!PythonOps.IsCallable(context, encoder)) {
throw PythonOps.TypeError("encoding with '{0}' codec failed; encoder must be callable ('{1}' object is not callable)", encoding, PythonOps.GetPythonTypeName(encoder));
}
return PythonOps.GetIndex(context, PythonCalls.Call(context, encoder, obj, errors), 0);
}
}
#endregion
#region Escape Encoding
public static PythonTuple escape_decode(CodeContext/*!*/ context, [NotNone] string data, string? errors = null)
=> escape_decode(StringOps.DoEncodeUtf8(context, data), errors);
public static PythonTuple escape_decode([NotNone] IBufferProtocol data, string? errors = null) {
using IPythonBuffer buffer = data.GetBuffer();
var span = buffer.AsReadOnlySpan();
var res = LiteralParser.ParseBytes(span, isRaw: false, isAscii: false, normalizeLineEndings: false, getErrorHandler(errors));
return PythonTuple.MakeTuple(Bytes.Make(res.ToArray()), span.Length);
static LiteralParser.ParseBytesErrorHandler<byte>? getErrorHandler(string? errors) {
if (errors == null) return default;
Func<int, IReadOnlyList<byte>?>? eh = null;
return delegate (in ReadOnlySpan<byte> data, int start, int end, string message) {
eh ??= errors switch
{
"strict" => idx => throw PythonOps.ValueError(@"invalid \x escape at position {0}", idx),
"replace" => idx => _replacementMarker ??= new[] { (byte)'?' },
"ignore" => idx => null,
_ => idx => throw PythonOps.ValueError("decoding error; unknown error handling code: " + errors),
};
return eh(start);
};
}
}
[DisallowNull]
private static byte[]? _replacementMarker;
public static PythonTuple/*!*/ escape_encode([NotNone] Bytes data, string? errors = null) {
using IPythonBuffer buffer = ((IBufferProtocol)data).GetBuffer();
var span = buffer.AsReadOnlySpan();
var result = new List<byte>(span.Length);
for (int i = 0; i < span.Length; i++) {
byte b = span[i];
switch (b) {
case (byte)'\n': result.Add((byte)'\\'); result.Add((byte)'n'); break;
case (byte)'\r': result.Add((byte)'\\'); result.Add((byte)'r'); break;
case (byte)'\t': result.Add((byte)'\\'); result.Add((byte)'t'); break;
case (byte)'\\': result.Add((byte)'\\'); result.Add((byte)'\\'); break;
case (byte)'\'': result.Add((byte)'\\'); result.Add((byte)'\''); break;
default:
if (b < 0x20 || b >= 0x7f) {
result.AddRange($"\\x{b:x2}".Select(c => unchecked((byte)c)));
} else {
result.Add(b);
}
break;
}
}
return PythonTuple.MakeTuple(Bytes.Make(result.ToArray()), span.Length);
}
#endregion
#region Latin-1 Functions
public static PythonTuple latin_1_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "latin-1", StringOps.Latin1Encoding, buffer, errors).ToPythonTuple();
}
public static PythonTuple latin_1_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "latin-1", StringOps.Latin1Encoding, input, errors).ToPythonTuple();
#endregion
#region MBCS Functions
[SupportedOSPlatform("windows"), PythonHidden(PlatformsAttribute.PlatformFamily.Unix)]
public static PythonTuple mbcs_decode(CodeContext/*!*/ context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "mbcs", StringOps.CodecsInfo.MbcsEncoding, buffer, errors).ToPythonTuple();
}
[SupportedOSPlatform("windows"), PythonHidden(PlatformsAttribute.PlatformFamily.Unix)]
public static PythonTuple mbcs_encode(CodeContext/*!*/ context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "mbcs", StringOps.CodecsInfo.MbcsEncoding, input, errors).ToPythonTuple();
#endregion
#region Code Page Functions
[SupportedOSPlatform("windows"), PythonHidden(PlatformsAttribute.PlatformFamily.Unix)]
public static PythonTuple code_page_decode(CodeContext context, int codepage, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
// TODO: Use Win32 API MultiByteToWideChar https://docs.microsoft.com/en-us/windows/win32/api/stringapiset/nf-stringapiset-multibytetowidechar
string encodingName = $"cp{codepage}";
Encoding encoding = Encoding.GetEncoding(codepage);
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, encodingName, encoding, buffer, errors).ToPythonTuple();
}
[SupportedOSPlatform("windows"), PythonHidden(PlatformsAttribute.PlatformFamily.Unix)]
public static PythonTuple code_page_encode(CodeContext context, int codepage, [NotNone] string input, string? errors = null) {
// TODO: Use Win32 API WideCharToMultiByte https://docs.microsoft.com/en-us/windows/win32/api/stringapiset/nf-stringapiset-widechartomultibyte
string encodingName = $"cp{codepage}";
Encoding encoding = Encoding.GetEncoding(codepage);
return DoEncode(context, encodingName, encoding, input, errors, includePreamble: true).ToPythonTuple();
}
#endregion
#region Raw Unicode Escape Encoding Functions
public static PythonTuple raw_unicode_escape_decode(CodeContext/*!*/ context, [NotNone] string input, string? errors = null) {
// Encoding with UTF-8 is probably a bug or at least a mistake, as it mutilates non-ASCII characters,
// but this is what CPython does. Probably encoding with "raw-unicode-escape" would be more reasonable.
return raw_unicode_escape_decode(context, StringOps.DoEncodeUtf8(context, input), errors);
}
public static PythonTuple raw_unicode_escape_decode(CodeContext/*!*/ context, [NotNone] IBufferProtocol input, string? errors = null) {
using IPythonBuffer buffer = input.GetBuffer();
return PythonTuple.MakeTuple(
StringOps.DoDecode(context, buffer, errors, "raw-unicode-escape", StringOps.CodecsInfo.RawUnicodeEscapeEncoding),
buffer.NumBytes()
);
}
public static PythonTuple raw_unicode_escape_encode(CodeContext/*!*/ context, [NotNone] string input, string? errors = null) {
return PythonTuple.MakeTuple(
StringOps.DoEncode(context, input, errors, "raw-unicode-escape", StringOps.CodecsInfo.RawUnicodeEscapeEncoding, includePreamble: false),
input.Length
);
}
#endregion
#region Unicode Escape Encoding Functions
public static PythonTuple unicode_escape_decode(CodeContext/*!*/ context, [NotNone] string input, string? errors = null) {
// Encoding with UTF-8 is probably a bug or at least a mistake, as it mutilates non-ASCII characters,
// but this is what CPython does. Probably encoding with "unicode-escape" would be more reasonable.
return unicode_escape_decode(context, StringOps.DoEncodeUtf8(context, input), errors);
}
public static PythonTuple unicode_escape_decode(CodeContext/*!*/ context, [NotNone] IBufferProtocol input, string? errors = null) {
using IPythonBuffer buffer = input.GetBuffer();
return PythonTuple.MakeTuple(
StringOps.DoDecode(context, buffer, errors, "unicode-escape", StringOps.CodecsInfo.UnicodeEscapeEncoding),
buffer.NumBytes()
);
}
public static PythonTuple unicode_escape_encode(CodeContext/*!*/ context, [NotNone] string input, string? errors = null) {
return PythonTuple.MakeTuple(
StringOps.DoEncode(context, input, errors, "unicode-escape", StringOps.CodecsInfo.UnicodeEscapeEncoding, includePreamble: false),
input.Length
);
}
#endregion
#region Readbuffer Functions
public static PythonTuple readbuffer_encode(CodeContext/*!*/ context, [NotNone] string input, string? errors = null)
=> readbuffer_encode(StringOps.DoEncodeUtf8(context, input), errors);
public static PythonTuple readbuffer_encode([NotNone] IBufferProtocol input, string? errors = null) {
using IPythonBuffer buffer = input.GetBuffer();
var bytes = Bytes.Make(buffer.AsReadOnlySpan().ToArray());
return PythonTuple.MakeTuple(bytes, bytes.Count);
}
#endregion
#region Unicode Internal Encoding Functions
public static PythonTuple unicode_internal_decode(CodeContext context, [NotNone] string input, string? errors = null) {
PythonOps.Warn(context, PythonExceptions.DeprecationWarning, "unicode_internal codec has been deprecated");
return PythonTuple.MakeTuple(input, input.Length);
}
public static PythonTuple unicode_internal_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null) {
PythonOps.Warn(context, PythonExceptions.DeprecationWarning, "unicode_internal codec has been deprecated");
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "unicode-internal", Encoding.Unicode, buffer, errors).ToPythonTuple();
}
public static PythonTuple unicode_internal_encode(CodeContext context, [NotNone] string input, string? errors = null) {
PythonOps.Warn(context, PythonExceptions.DeprecationWarning, "unicode_internal codec has been deprecated");
return DoEncode(context, "unicode-internal", Encoding.Unicode, input, errors, false).ToPythonTuple();
}
public static PythonTuple unicode_internal_encode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null) {
PythonOps.Warn(context, PythonExceptions.DeprecationWarning, "unicode_internal codec has been deprecated");
using IPythonBuffer buffer = input.GetBuffer();
var bytes = Bytes.Make(buffer.AsReadOnlySpan().ToArray());
return PythonTuple.MakeTuple(bytes, bytes.Count);
}
#endregion
#region Utf-16 Functions
public static PythonTuple utf_16_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
PythonTuple res = utf_16_ex_decode(context, input, errors, 0, final);
return PythonTuple.MakeTuple(res[0], res[1]);
}
public static PythonTuple utf_16_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-16", Utf16LeBomEncoding, input, errors, true).ToPythonTuple();
public static PythonTuple utf_16_ex_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, int byteorder = 0, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
var span = buffer.AsReadOnlySpan();
Tuple<string, int> res;
if (byteorder != 0) {
res = (byteorder > 0) ?
DoDecode(context, "utf-16-be", Utf16BeEncoding, buffer, errors, NumEligibleUtf16Bytes(span, final, false))
:
DoDecode(context, "utf-16-le", Utf16LeEncoding, buffer, errors, NumEligibleUtf16Bytes(span, final, true));
} else {
byteorder = Utf16DetectByteorder(span);
res = (byteorder > 0) ?
DoDecode(context, "utf-16-be", Utf16BeBomEncoding, buffer, errors, NumEligibleUtf16Bytes(span, final, false))
:
DoDecode(context, "utf-16-le", Utf16LeBomEncoding, buffer, errors, NumEligibleUtf16Bytes(span, final, true));
}
return PythonTuple.MakeTuple(res.Item1, res.Item2, byteorder);
}
private static int Utf16DetectByteorder(ReadOnlySpan<byte> input) {
if (input.StartsWith(BOM_UTF16_LE)) return -1;
if (input.StartsWith(BOM_UTF16_BE)) return 1;
return 0;
}
private static int NumEligibleUtf16Bytes(ReadOnlySpan<byte> input, bool final, bool isLE) {
int numBytes = input.Length;
if (!final) {
numBytes -= numBytes % 2;
if (numBytes >= 2 && (input[numBytes - (isLE ? 1 : 2)] & 0xFC) == 0xD8) { // high surrogate
numBytes -= 2;
}
}
return numBytes;
}
#endregion
#region Utf-16-LE Functions
private static Encoding Utf16LeEncoding => _utf16LeEncoding ??= new UnicodeEncoding(bigEndian: false, byteOrderMark: false);
[DisallowNull] private static Encoding? _utf16LeEncoding;
private static Encoding Utf16LeBomEncoding => Encoding.Unicode; // same as new UnicodeEncoding(bigEndian: false, byteOrderMark: true);
private static byte[] BOM_UTF16_LE => _bom_utf16_le ??= Utf16LeBomEncoding.GetPreamble();
[DisallowNull] private static byte[]? _bom_utf16_le;
public static PythonTuple utf_16_le_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "utf-16-le", Utf16LeEncoding, buffer, errors, NumEligibleUtf16Bytes(buffer.AsReadOnlySpan(), final, isLE: true)).ToPythonTuple();
}
public static PythonTuple utf_16_le_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-16-le", Utf16LeEncoding, input, errors).ToPythonTuple();
#endregion
#region Utf-16-BE Functions
private static Encoding Utf16BeEncoding => _utf16BeEncoding ??= new UnicodeEncoding(bigEndian: true, byteOrderMark: false);
[DisallowNull] private static Encoding? _utf16BeEncoding;
private static Encoding Utf16BeBomEncoding => Encoding.BigEndianUnicode; // same as new UnicodeEncoding(bigEndian: true, byteOrderMark: true);
private static byte[] BOM_UTF16_BE => _bom_utf16_be ??= Utf16BeBomEncoding.GetPreamble();
[DisallowNull] private static byte[]? _bom_utf16_be;
public static PythonTuple utf_16_be_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "utf-16-be", Utf16BeEncoding, buffer, errors, NumEligibleUtf16Bytes(buffer.AsReadOnlySpan(), final, isLE: false)).ToPythonTuple();
}
public static PythonTuple utf_16_be_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-16-be", Utf16BeEncoding, input, errors).ToPythonTuple();
#endregion
#region Utf-7 Functions
public static PythonTuple utf_7_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "utf-7", Encoding.UTF7, buffer, errors, NumEligibleUtf7Bytes(buffer.AsReadOnlySpan(), final)).ToPythonTuple();
}
public static PythonTuple utf_7_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-7", Encoding.UTF7, input, errors).ToPythonTuple();
private static int NumEligibleUtf7Bytes(ReadOnlySpan<byte> input, bool final) {
int numBytes = input.Length;
if (!final) {
int blockStart = -1;
for (int i = 0; i < numBytes; i++) {
byte b = input[i];
if (blockStart < 0 && b == '+') {
blockStart = i;
} else if (blockStart >= 0 && !b.IsLetter() && !b.IsDigit() && b != '+' && b != '/' && !b.IsWhiteSpace()) {
blockStart = -1;
}
}
if (blockStart >= 0) numBytes = blockStart;
}
return numBytes;
}
#endregion
#region Utf-8 Functions
private static Encoding Utf8Encoding => _utf8Encoding ??= new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
[DisallowNull] private static Encoding? _utf8Encoding;
public static PythonTuple utf_8_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "utf-8", Utf8Encoding, buffer, errors, NumEligibleUtf8Bytes(buffer.AsReadOnlySpan(), final)).ToPythonTuple();
}
public static PythonTuple utf_8_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-8", Encoding.UTF8, input, errors).ToPythonTuple();
private static int NumEligibleUtf8Bytes(ReadOnlySpan<byte> input, bool final) {
int numBytes = input.Length;
if (!final) {
// scan for incomplete but valid sequence at the end
for (int i = 1; i < 4; i++) { // 4 is the max length of a valid sequence
int pos = numBytes - i;
if (pos < 0) break;
byte b = input[pos];
if ((b & 0b10000000) == 0) return numBytes; // ASCII
if ((b & 0b11000000) == 0b11000000) { // start byte
if ((b | 0b00011111) == 0b11011111 && i < 2) return pos; // 2-byte seq start
if ((b | 0b00001111) == 0b11101111 && i < 3) return pos; // 3-byte seq start
if ((b | 0b00000111) == 0b11110111) { // 4-byte seq start
if (b < 0b11110100) return pos; // chars up to U+FFFFF
if ((b == 0b11110100) && (i == 1 || input[numBytes - i + 1] < 0x90)) return pos; // U+100000 to U+10FFFF
}
return numBytes; // invalid sequence or valid but complete
}
// else continuation byte (0b10xxxxxx) hence continue scanning
}
}
return numBytes;
}
#endregion
#region Utf-32 Functions
public static PythonTuple utf_32_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
PythonTuple res = utf_32_ex_decode(context, input, errors, 0, final);
return PythonTuple.MakeTuple(res[0], res[1]);
}
public static PythonTuple utf_32_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-32", Utf32LeBomEncoding, input, errors, includePreamble: true).ToPythonTuple();
public static PythonTuple utf_32_ex_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, int byteorder = 0, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
var span = buffer.AsReadOnlySpan();
int numBytes = NumEligibleUtf32Bytes(span, final);
Tuple<string, int> res;
if (byteorder != 0) {
res = (byteorder > 0) ?
DoDecode(context, "utf-32-be", Utf32BeEncoding, buffer, errors, numBytes)
:
DoDecode(context, "utf-32-le", Utf32LeEncoding, buffer, errors, numBytes);
} else {
byteorder = Utf32DetectByteorder(span);
res = (byteorder > 0) ?
DoDecode(context, "utf-32-be", Utf32BeBomEncoding, buffer, errors, numBytes)
:
DoDecode(context, "utf-32-le", Utf32LeBomEncoding, buffer, errors, numBytes);
}
return PythonTuple.MakeTuple(res.Item1, res.Item2, byteorder);
}
private static int Utf32DetectByteorder(ReadOnlySpan<byte> input) {
if (input.StartsWith(BOM_UTF32_LE)) return -1;
if (input.StartsWith(BOM_UTF32_BE)) return 1;
return 0;
}
private static int NumEligibleUtf32Bytes(ReadOnlySpan<byte> input, bool final) {
int numBytes = input.Length;
if (!final) numBytes -= numBytes % 4;
return numBytes;
}
#endregion
#region Utf-32-LE Functions
private static Encoding Utf32LeEncoding => _utf32LeEncoding ??= new UTF32Encoding(bigEndian: false, byteOrderMark: false);
[DisallowNull] private static Encoding? _utf32LeEncoding;
private static Encoding Utf32LeBomEncoding => Encoding.UTF32; // same as new UTF32Encoding(bigEndian: false, byteOrderMark: true);
private static byte[] BOM_UTF32_LE => _bom_utf32_le ??= Utf32LeBomEncoding.GetPreamble();
[DisallowNull] private static byte[]? _bom_utf32_le;
public static PythonTuple utf_32_le_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "utf-32-le", Utf32LeEncoding, buffer, errors, NumEligibleUtf32Bytes(buffer.AsReadOnlySpan(), final)).ToPythonTuple();
}
public static PythonTuple utf_32_le_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-32-le", Utf32LeEncoding, input, errors).ToPythonTuple();
#endregion
#region Utf-32-BE Functions
private static Encoding Utf32BeEncoding => _utf32BeEncoding ??= new UTF32Encoding(bigEndian: true, byteOrderMark: false);
[DisallowNull] private static Encoding? _utf32BeEncoding;
private static Encoding Utf32BeBomEncoding => _utf32BeBomEncoding ??= new UTF32Encoding(bigEndian: true, byteOrderMark: true);
[DisallowNull] private static Encoding? _utf32BeBomEncoding;
private static byte[] BOM_UTF32_BE => _bom_utf32_be ??= Utf32BeBomEncoding.GetPreamble();
[DisallowNull] private static byte[]? _bom_utf32_be;
public static PythonTuple utf_32_be_decode(CodeContext context, [NotNone] IBufferProtocol input, string? errors = null, bool final = false) {
using IPythonBuffer buffer = input.GetBuffer();
return DoDecode(context, "utf-32-be", Utf32BeEncoding, buffer, errors, NumEligibleUtf32Bytes(buffer.AsReadOnlySpan(), final)).ToPythonTuple();
}
public static PythonTuple utf_32_be_encode(CodeContext context, [NotNone] string input, string? errors = null)
=> DoEncode(context, "utf-32-be", Utf32BeEncoding, input, errors).ToPythonTuple();
#endregion
#region Private implementation
private static Tuple<string, int> DoDecode(CodeContext context, string encodingName, Encoding encoding, IPythonBuffer input, string? errors, int numBytes = -1) {
var decoded = StringOps.DoDecode(context, input, errors, encodingName, encoding, numBytes);
return Tuple.Create(decoded, numBytes >= 0 ? numBytes : input.NumBytes());
}
private static Tuple<Bytes, int> DoEncode(CodeContext context, string encodingName, Encoding encoding, string input, string? errors, bool includePreamble = false) {
var res = StringOps.DoEncode(context, input, errors, encodingName, encoding, includePreamble);
return Tuple.Create(res, input.Length);
}
#endregion
}
/// <summary>
/// Optimized encoding mapping that can be consumed by charmap_encode/EncodingMapEncoding.
/// </summary>
[PythonHidden]
public class EncodingMap {
private readonly string _smap;
[DisallowNull] private Dictionary<byte, int>? _dmap;
[DisallowNull] private Dictionary<int, byte>? _emap;
internal EncodingMap(string stringMap, bool compileForDecoding, bool compileForEncoding) {
_smap = stringMap;
if (compileForDecoding) CompileDecodingMap();
if (compileForEncoding) CompileEncodingMap();
}
private void CompileEncodingMap() {
if (_emap == null) {
_emap = new Dictionary<int, byte>(Math.Min(_smap.Length, 256));
for (int i = 0, cp = 0; i < _smap.Length && cp < 256; i++, cp++) {
if (char.IsHighSurrogate(_smap[i]) && i < _smap.Length - 1 && char.IsLowSurrogate(_smap[i + 1])) {
_emap[char.ConvertToUtf32(_smap[i], _smap[i + 1])] = unchecked((byte)cp);
i++;
} else if (_smap[i] != '\uFFFE') {
_emap[_smap[i]] = unchecked((byte)cp);
}
}
}
}
private void CompileDecodingMap() {
// scan for a surrogate pair
bool spFound = false;
for (int i = 0; i < _smap.Length && !spFound; i++) {
spFound = char.IsHighSurrogate(_smap[i]) && i < _smap.Length - 1 && char.IsLowSurrogate(_smap[i + 1]);
}
if (spFound) {
_dmap = new Dictionary<byte, int>(Math.Min(_smap.Length, 256));
for (int i = 0, cp = 0; i < _smap.Length && cp < 256; i++, cp++) {
if (char.IsHighSurrogate(_smap[i]) && i < _smap.Length - 1 && char.IsLowSurrogate(_smap[i + 1])) {
_dmap[unchecked((byte)cp)] = char.ConvertToUtf32(_smap[i], _smap[i + 1]);
i++;
} else if (_smap[i] != '\uFFFE') {
_dmap[unchecked((byte)cp)] = _smap[i];
}
}
}
}
public bool TryGetCharValue(byte b, out int val) {
if (_dmap != null) {
return _dmap.TryGetValue(b, out val);
} else if (b < _smap.Length) {
val = _smap[b];
return val != '\uFFFE';
} else {
val = '\0';
return false;
}
}
public bool TryGetByteValue(int c, out byte val) {
CompileEncodingMap();
if (_emap != null) {
return _emap.TryGetValue(c, out val);
} else {
val = 0;
return false;
}
}
}
/// <remarks>
/// This implementation is not suitable for incremental encoding.
/// </remarks>
internal class EncodingMapEncoding : Encoding {
private readonly EncodingMap _map;
public EncodingMapEncoding(EncodingMap map) {
_map = map;
}
public override string EncodingName => "charmap";
public override int GetByteCount(char[] chars, int index, int count)
=> GetBytes(chars, index, count, null, 0);
public override int GetBytes(char[] chars, int charIndex, int charCount, byte[]? bytes, int byteIndex) {
if (chars == null) throw new ArgumentNullException(nameof(chars));
int charEnd = charIndex + charCount;
int byteStart = byteIndex;
EncoderFallbackBuffer? efb = null;
while (charIndex < charEnd) {
int codepoint;
char c = chars[charIndex];
int nextIndex = charIndex + 1;
if (char.IsHighSurrogate(c) && nextIndex < charEnd && char.IsLowSurrogate(chars[nextIndex])) {
codepoint = char.ConvertToUtf32(c, chars[nextIndex++]);
} else {
codepoint = c;
}
if (!_map.TryGetByteValue(codepoint, out byte val)) {
efb ??= EncoderFallback.CreateFallbackBuffer();
try {
if (efb.Fallback(c, charIndex)) {
while (efb.Remaining != 0) {
c = efb.GetNextChar();
int fbCodepoint = c;
if (char.IsHighSurrogate(c) && efb.Remaining != 0) {
char d = efb.GetNextChar();
if (char.IsLowSurrogate(d)) {
fbCodepoint = char.ConvertToUtf32(c, d);
} else {
efb.MovePrevious();
}
}
if (!_map.TryGetByteValue(fbCodepoint, out val)) {
throw new EncoderFallbackException(); // no recursive fallback
}
if (bytes != null) bytes[byteIndex] = val;
byteIndex++;
}
}
} catch (EncoderFallbackException) {
throw PythonOps.UnicodeEncodeError(EncodingName, new string(chars), charIndex, charIndex + 1, "character maps to <undefined>");
}
} else {
if (bytes != null) bytes[byteIndex] = val;
byteIndex++;
}
charIndex = nextIndex;
}
return byteIndex - byteStart;
}
public override int GetCharCount(byte[] bytes, int index, int count)
=> GetChars(bytes, index, count, null, 0);
public override int GetChars(byte[] bytes, int byteIndex, int byteCount, char[]? chars, int charIndex) {
if (bytes == null) throw new ArgumentNullException(nameof(bytes));
int byteEnd = byteIndex + byteCount;
int charStart = charIndex;
DecoderFallbackBuffer? dfb = null;
while (byteIndex < byteEnd) {
byte b = bytes[byteIndex];
if (!_map.TryGetCharValue(b, out int val)) {
dfb ??= DecoderFallback.CreateFallbackBuffer();
byte[] bytesUnknown = new[] { b };
try {
if (dfb.Fallback(bytesUnknown, byteIndex)) {
while (dfb.Remaining != 0) {
char c = dfb.GetNextChar();
if (chars != null) {
chars[charIndex] = c;
}
charIndex++;
}
}
} catch (DecoderFallbackException) {
throw PythonOps.UnicodeDecodeError("character maps to <undefined>", bytesUnknown, byteIndex);
}
} else {
if (val >= 0x10000) {
string s32 = char.ConvertFromUtf32(val);
if (chars != null) {
chars[charIndex] = s32[0];
chars[charIndex + 1] = s32[1];
}
charIndex += 2;
} else {
if (chars != null) chars[charIndex] = unchecked((char)val);
charIndex++;
}
}
byteIndex++;
}
return charIndex - charStart;
}
public override int GetMaxByteCount(int charCount) {
return charCount;
}
public override int GetMaxCharCount(int byteCount) {
return byteCount * 2; // account for surrogate pairs
}
}
/// <remarks>
/// This implementation is not suitable for incremental encoding.
/// </remarks>
internal class CharmapEncoding : Encoding {
private readonly IDictionary<object, object> _map;
private int _maxEncodingReplacementLength;
private int _maxDecodingReplacementLength;
public CharmapEncoding(IDictionary<object, object> map) {
_map = map;
}
public override string EncodingName => "charmap";
public override int GetByteCount(char[] chars, int index, int count)
=> GetBytes(chars, index, count, null, 0);
public override int GetBytes(char[] chars, int charIndex, int charCount, byte[]? bytes, int byteIndex) {
if (chars == null) throw new ArgumentNullException(nameof(chars));
int charEnd = charIndex + charCount;
int byteStart = byteIndex;
EncoderFallbackBuffer? efb = null;
while (charIndex < charEnd) {
object charObj;
char c = chars[charIndex];
int nextIndex = charIndex + 1;
if (char.IsHighSurrogate(c) && nextIndex < charEnd && char.IsLowSurrogate(chars[nextIndex])) {
charObj = ScriptingRuntimeHelpers.Int32ToObject(char.ConvertToUtf32(c, chars[nextIndex++]));
} else {
charObj = ScriptingRuntimeHelpers.Int32ToObject(c);
}
if (!_map.TryGetValue(charObj, out object? val) || val == null) {
efb ??= EncoderFallback.CreateFallbackBuffer();
try {
for (int idx = charIndex; idx < nextIndex; idx++) {
if (efb.Fallback(chars[idx], idx)) {
while (efb.Remaining != 0) {
c = efb.GetNextChar();
object fbCharObj = ScriptingRuntimeHelpers.Int32ToObject(c);
if (char.IsHighSurrogate(c) && efb.Remaining != 0) {
char d = efb.GetNextChar();
if (char.IsLowSurrogate(d)) {
fbCharObj = ScriptingRuntimeHelpers.Int32ToObject(char.ConvertToUtf32(c, d));
} else {
efb.MovePrevious();
}
}
if (!_map.TryGetValue(fbCharObj, out val) || val == null) {
throw new EncoderFallbackException(); // no recursive fallback
}
byteIndex += ProcessEncodingReplacementValue(val, bytes, byteIndex);
}
}
}
} catch (EncoderFallbackException) {
throw PythonOps.UnicodeEncodeError(EncodingName, new string(chars), charIndex, nextIndex, "character maps to <undefined>");
}
charIndex = nextIndex;
} else {
byteIndex += ProcessEncodingReplacementValue(val, bytes, byteIndex);
charIndex = nextIndex;
}
}
return byteIndex - byteStart;
}
private static int ProcessEncodingReplacementValue(object replacement, byte[]? bytes, int byteIndex) {
Debug.Assert(replacement != null);
switch (replacement) {
case IList<byte> b:
if (bytes != null) {
for (int i = 0; i < b.Count; i++, byteIndex++) {
bytes[byteIndex] = b[i];
}
}
return b.Count;
case int n:
if (n < 0 || n > 0xFF) throw PythonOps.TypeError("character mapping must be in range(256)");
if (bytes != null) {
bytes[byteIndex] = unchecked((byte)n);
}
return 1;
default:
throw PythonOps.TypeError("character mapping must return integer, bytes or None, not {0}", PythonOps.GetPythonTypeName(replacement));
}
}
public override int GetCharCount(byte[] bytes, int index, int count)
=> GetChars(bytes, index, count, null, 0);
public override int GetChars(byte[] bytes, int byteIndex, int byteCount, char[]? chars, int charIndex) {
if (bytes == null) throw new ArgumentNullException(nameof(bytes));
int byteEnd = byteIndex + byteCount;
int charStart = charIndex;
DecoderFallbackBuffer? dfb = null;
while (byteIndex < byteEnd) {
byte b = bytes[byteIndex++];
object byteObj = ScriptingRuntimeHelpers.Int32ToObject(b);
if (_map.TryGetValue(byteObj, out object? val) && val != null) {
if (val is string s) {
if (s.Length == 0 || s[0] != '\uFFFE') {
for (int i = 0; i < s.Length; i++) {
if (chars != null) chars[charIndex] = s[i];
charIndex++;
}
continue;
}
} else if (val is int n) {
if (n < 0 || n > 0x10FFFF) {
throw PythonOps.TypeError("character mapping must be in range(0x110000)");
} else if (n > 0xFFFF) {
var sp = char.ConvertFromUtf32(n);
if (chars != null) chars[charIndex] = sp[0];
charIndex++;
if (chars != null) chars[charIndex] = sp[1];
charIndex++;
continue;
} else if (n != 0xFFFE) {
if (chars != null) chars[charIndex] = unchecked((char)n);
charIndex++;
continue;
}
} else {
throw PythonOps.TypeError("character mapping must return integer, None or str, not {0}", PythonOps.GetPythonTypeName(val));
}
}
// byte unhandled, try fallback
dfb ??= DecoderFallback.CreateFallbackBuffer();
byte[] bytesUnknown = new[] { b };
try {
if (dfb.Fallback(bytesUnknown, byteIndex - 1)) {
while (dfb.Remaining != 0) {
char c = dfb.GetNextChar();
if (chars != null) chars[charIndex] = c;
charIndex++;
}
}
} catch (DecoderFallbackException) {
throw PythonOps.UnicodeDecodeError("character maps to <undefined>", bytesUnknown, byteIndex - 1);
}
}
return charIndex - charStart;
}
public override int GetMaxByteCount(int charCount) {
if (_maxEncodingReplacementLength == 0) {
_maxEncodingReplacementLength = 1;
foreach (object val in _map.Values) {
if (val is IList<byte> b && b.Count > _maxEncodingReplacementLength) {
_maxEncodingReplacementLength = b.Count;
}
}
}
return charCount * _maxEncodingReplacementLength;
}
public override int GetMaxCharCount(int byteCount) {
if (_maxDecodingReplacementLength == 0) {
_maxDecodingReplacementLength = 2; // surrogate pair for codepoint
foreach (object val in _map.Values) {
if (val is string s && s.Length > _maxDecodingReplacementLength) {
_maxDecodingReplacementLength = s.Length;
};
}
}
return byteCount * _maxDecodingReplacementLength;
}
}
}