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 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
|
import 'dart:collection';
import 'dart:convert';
import 'dart:math';
import 'dart:typed_data';
const int _sizeofUint8 = 1;
const int _sizeofUint16 = 2;
const int _sizeofUint32 = 4;
const int _sizeofUint64 = 8;
const int _sizeofInt8 = 1;
const int _sizeofInt16 = 2;
const int _sizeofInt32 = 4;
const int _sizeofInt64 = 8;
const int _sizeofFloat32 = 4;
const int _sizeofFloat64 = 8;
/// Callback used to invoke a struct builder's finish method.
///
/// This callback is used by other struct's `finish` methods to write the nested
/// struct's fields inline.
typedef StructBuilder = void Function();
/// Buffer with data and some context about it.
class BufferContext {
final ByteData _buffer;
ByteData get buffer => _buffer;
/// Create from a FlatBuffer represented by a list of bytes (uint8).
factory BufferContext.fromBytes(List<int> byteList) =>
BufferContext(byteList is Uint8List
? byteList.buffer.asByteData(byteList.offsetInBytes)
: ByteData.view(Uint8List.fromList(byteList).buffer));
/// Create from a FlatBuffer represented by ByteData.
BufferContext(this._buffer);
@pragma('vm:prefer-inline')
int derefObject(int offset) => offset + _getUint32(offset);
@pragma('vm:prefer-inline')
Uint8List _asUint8List(int offset, int length) =>
_buffer.buffer.asUint8List(_buffer.offsetInBytes + offset, length);
@pragma('vm:prefer-inline')
double _getFloat64(int offset) => _buffer.getFloat64(offset, Endian.little);
@pragma('vm:prefer-inline')
double _getFloat32(int offset) => _buffer.getFloat32(offset, Endian.little);
@pragma('vm:prefer-inline')
int _getInt64(int offset) => _buffer.getInt64(offset, Endian.little);
@pragma('vm:prefer-inline')
int _getInt32(int offset) => _buffer.getInt32(offset, Endian.little);
@pragma('vm:prefer-inline')
int _getInt16(int offset) => _buffer.getInt16(offset, Endian.little);
@pragma('vm:prefer-inline')
int _getInt8(int offset) => _buffer.getInt8(offset);
@pragma('vm:prefer-inline')
int _getUint64(int offset) => _buffer.getUint64(offset, Endian.little);
@pragma('vm:prefer-inline')
int _getUint32(int offset) => _buffer.getUint32(offset, Endian.little);
@pragma('vm:prefer-inline')
int _getUint16(int offset) => _buffer.getUint16(offset, Endian.little);
@pragma('vm:prefer-inline')
int _getUint8(int offset) => _buffer.getUint8(offset);
}
/// Interface implemented by the "object-api" classes (ending with "T").
abstract class Packable {
/// Serialize the object using the given builder, returning the offset.
int pack(Builder fbBuilder);
}
/// Class implemented by typed builders generated by flatc.
abstract class ObjectBuilder {
int? _firstOffset;
/// Can be used to write the data represented by this builder to the [Builder]
/// and reuse the offset created in multiple tables.
///
/// Note that this method assumes you call it using the same [Builder] instance
/// every time. The returned offset is only good for the [Builder] used in the
/// first call to this method.
int getOrCreateOffset(Builder fbBuilder) {
_firstOffset ??= finish(fbBuilder);
return _firstOffset!;
}
/// Writes the data in this helper to the [Builder].
int finish(Builder fbBuilder);
/// Convenience method that will create a new [Builder], [finish]es the data,
/// and returns the buffer as a [Uint8List] of bytes.
Uint8List toBytes();
}
/// Class that helps building flat buffers.
class Builder {
bool _finished = false;
final int initialSize;
/// The list of existing VTable(s).
final List<int> _vTables;
final bool deduplicateTables;
ByteData _buf;
final Allocator _allocator;
/// The maximum alignment that has been seen so far. If [_buf] has to be
/// reallocated in the future (to insert room at its start for more bytes) the
/// reallocation will need to be a multiple of this many bytes.
int _maxAlign = 1;
/// The number of bytes that have been written to the buffer so far. The
/// most recently written byte is this many bytes from the end of [_buf].
int _tail = 0;
/// The location of the end of the current table, measured in bytes from the
/// end of [_buf].
int _currentTableEndTail = 0;
_VTable? _currentVTable;
/// Map containing all strings that have been written so far. This allows us
/// to avoid duplicating strings.
///
/// Allocated only if `internStrings` is set to true on the constructor.
Map<String, int>? _strings;
/// Creates a new FlatBuffers Builder.
///
/// `initialSize` is the initial array size in bytes. The [Builder] will
/// automatically grow the array if/as needed. `internStrings`, if set to
/// true, will cause [writeString] to pool strings in the buffer so that
/// identical strings will always use the same offset in tables.
Builder({
this.initialSize = 1024,
bool internStrings = false,
Allocator allocator = const DefaultAllocator(),
this.deduplicateTables = true,
}) : _allocator = allocator,
_buf = allocator.allocate(initialSize),
_vTables = deduplicateTables ? [] : const [] {
if (internStrings) {
_strings = <String, int>{};
}
}
/// Calculate the finished buffer size (aligned).
@pragma('vm:prefer-inline')
int size() => _tail + ((-_tail) & (_maxAlign - 1));
/// Add the [field] with the given boolean [value]. The field is not added if
/// the [value] is equal to [def]. Booleans are stored as 8-bit fields with
/// `0` for `false` and `1` for `true`.
void addBool(int field, bool? value, [bool? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofUint8, 1);
_trackField(field);
_buf.setInt8(_buf.lengthInBytes - _tail, value ? 1 : 0);
}
}
/// Add the [field] with the given 32-bit signed integer [value]. The field is
/// not added if the [value] is equal to [def].
void addInt32(int field, int? value, [int? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofInt32, 1);
_trackField(field);
_setInt32AtTail(_tail, value);
}
}
/// Add the [field] with the given 32-bit signed integer [value]. The field is
/// not added if the [value] is equal to [def].
void addInt16(int field, int? value, [int? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofInt16, 1);
_trackField(field);
_setInt16AtTail(_tail, value);
}
}
/// Add the [field] with the given 8-bit signed integer [value]. The field is
/// not added if the [value] is equal to [def].
void addInt8(int field, int? value, [int? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofInt8, 1);
_trackField(field);
_setInt8AtTail(_tail, value);
}
}
void addStruct(int field, int offset) {
assert(_inVTable);
_trackField(field);
_currentVTable!.addField(field, offset);
}
/// Add the [field] referencing an object with the given [offset].
void addOffset(int field, int? offset) {
assert(_inVTable);
if (offset != null) {
_prepare(_sizeofUint32, 1);
_trackField(field);
_setUint32AtTail(_tail, _tail - offset);
}
}
/// Add the [field] with the given 32-bit unsigned integer [value]. The field
/// is not added if the [value] is equal to [def].
void addUint32(int field, int? value, [int? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofUint32, 1);
_trackField(field);
_setUint32AtTail(_tail, value);
}
}
/// Add the [field] with the given 32-bit unsigned integer [value]. The field
/// is not added if the [value] is equal to [def].
void addUint16(int field, int? value, [int? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofUint16, 1);
_trackField(field);
_setUint16AtTail(_tail, value);
}
}
/// Add the [field] with the given 8-bit unsigned integer [value]. The field
/// is not added if the [value] is equal to [def].
void addUint8(int field, int? value, [int? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofUint8, 1);
_trackField(field);
_setUint8AtTail(_tail, value);
}
}
/// Add the [field] with the given 32-bit float [value]. The field
/// is not added if the [value] is equal to [def].
void addFloat32(int field, double? value, [double? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofFloat32, 1);
_trackField(field);
_setFloat32AtTail(_tail, value);
}
}
/// Add the [field] with the given 64-bit double [value]. The field
/// is not added if the [value] is equal to [def].
void addFloat64(int field, double? value, [double? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofFloat64, 1);
_trackField(field);
_setFloat64AtTail(_tail, value);
}
}
/// Add the [field] with the given 64-bit unsigned integer [value]. The field
/// is not added if the [value] is equal to [def].
void addUint64(int field, int? value, [double? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofUint64, 1);
_trackField(field);
_setUint64AtTail(_tail, value);
}
}
/// Add the [field] with the given 64-bit unsigned integer [value]. The field
/// is not added if the [value] is equal to [def].
void addInt64(int field, int? value, [double? def]) {
assert(_inVTable);
if (value != null && value != def) {
_prepare(_sizeofInt64, 1);
_trackField(field);
_setInt64AtTail(_tail, value);
}
}
/// End the current table and return its offset.
int endTable() {
assert(_inVTable);
// Prepare for writing the VTable.
_prepare(_sizeofInt32, 1);
final tableTail = _tail;
// Prepare the size of the current table.
final currentVTable = _currentVTable!;
currentVTable.tableSize = tableTail - _currentTableEndTail;
// Prepare the VTable to use for the current table.
int? vTableTail;
{
currentVTable.computeFieldOffsets(tableTail);
// Try to find an existing compatible VTable.
if (deduplicateTables) {
// Search backward - more likely to have recently used one
for (var i = _vTables.length - 1; i >= 0; i--) {
final vt2Offset = _vTables[i];
final vt2Start = _buf.lengthInBytes - vt2Offset;
final vt2Size = _buf.getUint16(vt2Start, Endian.little);
if (currentVTable._vTableSize == vt2Size &&
currentVTable._offsetsMatch(vt2Start, _buf)) {
vTableTail = vt2Offset;
break;
}
}
}
// Write a new VTable.
if (vTableTail == null) {
_prepare(_sizeofUint16, _currentVTable!.numOfUint16);
vTableTail = _tail;
currentVTable.tail = vTableTail;
currentVTable.output(_buf, _buf.lengthInBytes - _tail);
if (deduplicateTables) _vTables.add(currentVTable.tail);
}
}
// Set the VTable offset.
_setInt32AtTail(tableTail, vTableTail - tableTail);
// Done with this table.
_currentVTable = null;
return tableTail;
}
/// Returns the finished buffer. You must call [finish] before accessing this.
@pragma('vm:prefer-inline')
Uint8List get buffer {
assert(_finished);
final finishedSize = size();
return _buf.buffer
.asUint8List(_buf.lengthInBytes - finishedSize, finishedSize);
}
/// Finish off the creation of the buffer. The given [offset] is used as the
/// root object offset, and usually references directly or indirectly every
/// written object. If [fileIdentifier] is specified (and not `null`), it is
/// interpreted as a 4-byte Latin-1 encoded string that should be placed at
/// bytes 4-7 of the file.
void finish(int offset, [String? fileIdentifier]) {
final sizeBeforePadding = size();
final requiredBytes = _sizeofUint32 * (fileIdentifier == null ? 1 : 2);
_prepare(max(requiredBytes, _maxAlign), 1);
final finishedSize = size();
_setUint32AtTail(finishedSize, finishedSize - offset);
if (fileIdentifier != null) {
for (var i = 0; i < 4; i++) {
_setUint8AtTail(
finishedSize - _sizeofUint32 - i, fileIdentifier.codeUnitAt(i));
}
}
// zero out the added padding
for (var i = sizeBeforePadding + 1;
i <= finishedSize - requiredBytes;
i++) {
_setUint8AtTail(i, 0);
}
_finished = true;
}
/// Writes a Float64 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putFloat64(double value) {
_prepare(_sizeofFloat64, 1);
_setFloat32AtTail(_tail, value);
}
/// Writes a Float32 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putFloat32(double value) {
_prepare(_sizeofFloat32, 1);
_setFloat32AtTail(_tail, value);
}
/// Writes a bool to the tail of the buffer after preparing space for it.
/// Bools are represented as a Uint8, with the value set to '1' for true, and '0' for false
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putBool(bool value) {
_prepare(_sizeofUint8, 1);
_buf.setInt8(_buf.lengthInBytes - _tail, value ? 1 : 0);
}
/// Writes a Int64 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putInt64(int value) {
_prepare(_sizeofInt64, 1);
_setInt64AtTail(_tail, value);
}
/// Writes a Uint32 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putInt32(int value) {
_prepare(_sizeofInt32, 1);
_setInt32AtTail(_tail, value);
}
/// Writes a Uint16 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putInt16(int value) {
_prepare(_sizeofInt16, 1);
_setInt16AtTail(_tail, value);
}
/// Writes a Uint8 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putInt8(int value) {
_prepare(_sizeofInt8, 1);
_buf.setInt8(_buf.lengthInBytes - _tail, value);
}
/// Writes a Uint64 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putUint64(int value) {
_prepare(_sizeofUint64, 1);
_setUint64AtTail(_tail, value);
}
/// Writes a Uint32 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putUint32(int value) {
_prepare(_sizeofUint32, 1);
_setUint32AtTail(_tail, value);
}
/// Writes a Uint16 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putUint16(int value) {
_prepare(_sizeofUint16, 1);
_setUint16AtTail(_tail, value);
}
/// Writes a Uint8 to the tail of the buffer after preparing space for it.
///
/// Updates the [offset] pointer. This method is intended for use when writing structs to the buffer.
void putUint8(int value) {
_prepare(_sizeofUint8, 1);
_buf.setUint8(_buf.lengthInBytes - _tail, value);
}
/// Reset the builder and make it ready for filling a new buffer.
void reset() {
_finished = false;
_maxAlign = 1;
_tail = 0;
_currentVTable = null;
if (deduplicateTables) _vTables.clear();
if (_strings != null) {
_strings = <String, int>{};
}
}
/// Start a new table. Must be finished with [endTable] invocation.
void startTable(int numFields) {
assert(!_inVTable); // Inline tables are not supported.
_currentVTable = _VTable(numFields);
_currentTableEndTail = _tail;
}
/// Finish a Struct vector. Most callers should preferto use [writeListOfStructs].
///
/// Most callers should prefer [writeListOfStructs].
int endStructVector(int count) {
putUint32(count);
return _tail;
}
/// Writes a list of Structs to the buffer, returning the offset
int writeListOfStructs(List<ObjectBuilder> structBuilders) {
assert(!_inVTable);
for (var i = structBuilders.length - 1; i >= 0; i--) {
structBuilders[i].finish(this);
}
return endStructVector(structBuilders.length);
}
/// Write the given list of [values].
int writeList(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint32, 1 + values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setUint32AtTail(tail, tail - value);
tail -= _sizeofUint32;
}
return result;
}
/// Write the given list of 64-bit float [values].
int writeListFloat64(List<double> values) {
assert(!_inVTable);
_prepare(_sizeofFloat64, values.length, additionalBytes: _sizeofUint32);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setFloat64AtTail(tail, value);
tail -= _sizeofFloat64;
}
return result;
}
/// Write the given list of 32-bit float [values].
int writeListFloat32(List<double> values) {
assert(!_inVTable);
_prepare(_sizeofFloat32, 1 + values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setFloat32AtTail(tail, value);
tail -= _sizeofFloat32;
}
return result;
}
/// Write the given list of signed 64-bit integer [values].
int writeListInt64(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofInt64, values.length, additionalBytes: _sizeofUint32);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setInt64AtTail(tail, value);
tail -= _sizeofInt64;
}
return result;
}
/// Write the given list of signed 64-bit integer [values].
int writeListUint64(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint64, values.length, additionalBytes: _sizeofUint32);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setUint64AtTail(tail, value);
tail -= _sizeofUint64;
}
return result;
}
/// Write the given list of signed 32-bit integer [values].
int writeListInt32(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint32, 1 + values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setInt32AtTail(tail, value);
tail -= _sizeofInt32;
}
return result;
}
/// Write the given list of unsigned 32-bit integer [values].
int writeListUint32(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint32, 1 + values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setUint32AtTail(tail, value);
tail -= _sizeofUint32;
}
return result;
}
/// Write the given list of signed 16-bit integer [values].
int writeListInt16(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint32, 1, additionalBytes: 2 * values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setInt16AtTail(tail, value);
tail -= _sizeofInt16;
}
return result;
}
/// Write the given list of unsigned 16-bit integer [values].
int writeListUint16(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint32, 1, additionalBytes: 2 * values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setUint16AtTail(tail, value);
tail -= _sizeofUint16;
}
return result;
}
/// Write the given list of bools as unsigend 8-bit integer [values].
int writeListBool(List<bool> values) {
return writeListUint8(values.map((b) => b ? 1 : 0).toList());
}
/// Write the given list of signed 8-bit integer [values].
int writeListInt8(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint32, 1, additionalBytes: values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setInt8AtTail(tail, value);
tail -= _sizeofUint8;
}
return result;
}
/// Write the given list of unsigned 8-bit integer [values].
int writeListUint8(List<int> values) {
assert(!_inVTable);
_prepare(_sizeofUint32, 1, additionalBytes: values.length);
final result = _tail;
var tail = _tail;
_setUint32AtTail(tail, values.length);
tail -= _sizeofUint32;
for (final value in values) {
_setUint8AtTail(tail, value);
tail -= _sizeofUint8;
}
return result;
}
/// Write the given string [value] and return its offset.
///
/// Dart strings are UTF-16 but must be stored as UTF-8 in FlatBuffers.
/// If the given string consists only of ASCII characters, you can indicate
/// enable [asciiOptimization]. In this mode, [writeString()] first tries to
/// copy the ASCII string directly to the output buffer and if that fails
/// (because there are no-ASCII characters in the string) it falls back and to
/// the default UTF-16 -> UTF-8 conversion (with slight performance penalty).
int writeString(String value, {bool asciiOptimization = false}) {
assert(!_inVTable);
if (_strings != null) {
return _strings!
.putIfAbsent(value, () => _writeString(value, asciiOptimization));
} else {
return _writeString(value, asciiOptimization);
}
}
int _writeString(String value, bool asciiOptimization) {
if (asciiOptimization) {
// [utf8.encode()] is slow (up to at least Dart SDK 2.13). If the given
// string is ASCII we can just write it directly, without any conversion.
final originalTail = _tail;
if (_tryWriteASCIIString(value)) return _tail;
// if non-ASCII: reset the output buffer position for [_writeUTFString()]
_tail = originalTail;
}
_writeUTFString(value);
return _tail;
}
// Try to write the string as ASCII, return false if there's a non-ascii char.
@pragma('vm:prefer-inline')
bool _tryWriteASCIIString(String value) {
_prepare(4, 1, additionalBytes: value.length + 1);
final length = value.length;
var offset = _buf.lengthInBytes - _tail + 4;
for (var i = 0; i < length; i++) {
// utf16 code unit, e.g. for '†' it's [0x20 0x20], which is 8224 decimal.
// ASCII characters go from 0x00 to 0x7F (which is 0 to 127 decimal).
final char = value.codeUnitAt(i);
if ((char & ~0x7F) != 0) {
return false;
}
_buf.setUint8(offset++, char);
}
_buf.setUint8(offset, 0); // trailing zero
_setUint32AtTail(_tail, value.length);
return true;
}
@pragma('vm:prefer-inline')
void _writeUTFString(String value) {
final bytes = utf8.encode(value) as Uint8List;
final length = bytes.length;
_prepare(4, 1, additionalBytes: length + 1);
_setUint32AtTail(_tail, length);
var offset = _buf.lengthInBytes - _tail + 4;
for (var i = 0; i < length; i++) {
_buf.setUint8(offset++, bytes[i]);
}
_buf.setUint8(offset, 0); // trailing zero
}
/// Used to assert whether a "Table" is currently being built.
///
/// If you hit `assert(!_inVTable())`, you're trying to add table fields
/// without starting a table with [Builder.startTable()].
///
/// If you hit `assert(_inVTable())`, you're trying to construct a
/// Table/Vector/String during the construction of its parent table,
/// between the MyTableBuilder and [Builder.endTable()].
/// Move the creation of these sub-objects to before the MyTableBuilder to
/// not get this assert.
@pragma('vm:prefer-inline')
bool get _inVTable => _currentVTable != null;
/// The number of bytes that have been written to the buffer so far. The
/// most recently written byte is this many bytes from the end of the buffer.
@pragma('vm:prefer-inline')
int get offset => _tail;
/// Zero-pads the buffer, which may be required for some struct layouts.
@pragma('vm:prefer-inline')
void pad(int howManyBytes) {
for (var i = 0; i < howManyBytes; i++) {
putUint8(0);
}
}
/// Prepare for writing the given `count` of scalars of the given `size`.
/// Additionally allocate the specified `additionalBytes`. Update the current
/// tail pointer to point at the allocated space.
@pragma('vm:prefer-inline')
void _prepare(int size, int count, {int additionalBytes = 0}) {
assert(!_finished);
// Update the alignment.
if (_maxAlign < size) {
_maxAlign = size;
}
// Prepare amount of required space.
final dataSize = size * count + additionalBytes;
final alignDelta = (-(_tail + dataSize)) & (size - 1);
final bufSize = alignDelta + dataSize;
// Ensure that we have the required amount of space.
{
final oldCapacity = _buf.lengthInBytes;
if (_tail + bufSize > oldCapacity) {
final desiredNewCapacity = (oldCapacity + bufSize) * 2;
var deltaCapacity = desiredNewCapacity - oldCapacity;
deltaCapacity += (-deltaCapacity) & (_maxAlign - 1);
final newCapacity = oldCapacity + deltaCapacity;
_buf = _allocator.resize(_buf, newCapacity, _tail, 0);
}
}
// zero out the added padding
for (var i = _tail + 1; i <= _tail + alignDelta; i++) {
_setUint8AtTail(i, 0);
}
// Update the tail pointer.
_tail += bufSize;
}
/// Record the offset of the given [field].
@pragma('vm:prefer-inline')
void _trackField(int field) => _currentVTable!.addField(field, _tail);
@pragma('vm:prefer-inline')
void _setFloat64AtTail(int tail, double x) =>
_buf.setFloat64(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setFloat32AtTail(int tail, double x) =>
_buf.setFloat32(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setUint64AtTail(int tail, int x) =>
_buf.setUint64(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setInt64AtTail(int tail, int x) =>
_buf.setInt64(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setInt32AtTail(int tail, int x) =>
_buf.setInt32(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setUint32AtTail(int tail, int x) =>
_buf.setUint32(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setInt16AtTail(int tail, int x) =>
_buf.setInt16(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setUint16AtTail(int tail, int x) =>
_buf.setUint16(_buf.lengthInBytes - tail, x, Endian.little);
@pragma('vm:prefer-inline')
void _setInt8AtTail(int tail, int x) =>
_buf.setInt8(_buf.lengthInBytes - tail, x);
@pragma('vm:prefer-inline')
void _setUint8AtTail(int tail, int x) =>
_buf.setUint8(_buf.lengthInBytes - tail, x);
}
/// Reader of lists of boolean values.
///
/// The returned unmodifiable lists lazily read values on access.
class BoolListReader extends Reader<List<bool>> {
const BoolListReader();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
@pragma('vm:prefer-inline')
List<bool> read(BufferContext bc, int offset) =>
_FbBoolList(bc, bc.derefObject(offset));
}
/// The reader of booleans.
class BoolReader extends Reader<bool> {
const BoolReader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint8;
@override
@pragma('vm:prefer-inline')
bool read(BufferContext bc, int offset) => bc._getInt8(offset) != 0;
}
/// The reader of lists of 64-bit float values.
///
/// The returned unmodifiable lists lazily read values on access.
class Float64ListReader extends Reader<List<double>> {
const Float64ListReader();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofFloat64;
@override
@pragma('vm:prefer-inline')
List<double> read(BufferContext bc, int offset) =>
_FbFloat64List(bc, bc.derefObject(offset));
}
class Float32ListReader extends Reader<List<double>> {
const Float32ListReader();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofFloat32;
@override
@pragma('vm:prefer-inline')
List<double> read(BufferContext bc, int offset) =>
_FbFloat32List(bc, bc.derefObject(offset));
}
class Float64Reader extends Reader<double> {
const Float64Reader();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofFloat64;
@override
@pragma('vm:prefer-inline')
double read(BufferContext bc, int offset) => bc._getFloat64(offset);
}
class Float32Reader extends Reader<double> {
const Float32Reader();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofFloat32;
@override
@pragma('vm:prefer-inline')
double read(BufferContext bc, int offset) => bc._getFloat32(offset);
}
class Int64Reader extends Reader<int> {
const Int64Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofInt64;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getInt64(offset);
}
/// The reader of signed 32-bit integers.
class Int32Reader extends Reader<int> {
const Int32Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofInt32;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getInt32(offset);
}
/// The reader of signed 32-bit integers.
class Int16Reader extends Reader<int> {
const Int16Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofInt16;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getInt16(offset);
}
/// The reader of 8-bit signed integers.
class Int8Reader extends Reader<int> {
const Int8Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofInt8;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getInt8(offset);
}
/// The reader of lists of objects. Lazy by default - see [lazy].
class ListReader<E> extends Reader<List<E>> {
final Reader<E> _elementReader;
/// Enables lazy reading of the list
///
/// If true, the returned unmodifiable list lazily reads objects on access.
/// Therefore, the underlying buffer must not change while accessing the list.
///
/// If false, reads the whole list immediately on access.
final bool lazy;
const ListReader(this._elementReader, {this.lazy = true});
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
List<E> read(BufferContext bc, int offset) {
final listOffset = bc.derefObject(offset);
return lazy
? _FbGenericList<E>(_elementReader, bc, listOffset)
: List<E>.generate(
bc.buffer.getUint32(listOffset, Endian.little),
(int index) => _elementReader.read(
bc, listOffset + size + _elementReader.size * index),
growable: true);
}
}
/// Object that can read a value at a [BufferContext].
abstract class Reader<T> {
const Reader();
/// The size of the value in bytes.
int get size;
/// Read the value at the given [offset] in [bc].
T read(BufferContext bc, int offset);
/// Read the value of the given [field] in the given [object].
@pragma('vm:prefer-inline')
T vTableGet(BufferContext object, int offset, int field, T defaultValue) {
final fieldOffset = _vTableFieldOffset(object, offset, field);
return fieldOffset == 0 ? defaultValue : read(object, offset + fieldOffset);
}
/// Read the value of the given [field] in the given [object].
@pragma('vm:prefer-inline')
T? vTableGetNullable(BufferContext object, int offset, int field) {
final fieldOffset = _vTableFieldOffset(object, offset, field);
return fieldOffset == 0 ? null : read(object, offset + fieldOffset);
}
@pragma('vm:prefer-inline')
int _vTableFieldOffset(BufferContext object, int offset, int field) {
final vTableSOffset = object._getInt32(offset);
final vTableOffset = offset - vTableSOffset;
final vTableSize = object._getUint16(vTableOffset);
if (field >= vTableSize) return 0;
return object._getUint16(vTableOffset + field);
}
}
/// The reader of string values.
class StringReader extends Reader<String> {
final bool asciiOptimization;
const StringReader({this.asciiOptimization = false}) : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
@pragma('vm:prefer-inline')
String read(BufferContext bc, int offset) {
final strOffset = bc.derefObject(offset);
final length = bc._getUint32(strOffset);
final bytes = bc._asUint8List(strOffset + _sizeofUint32, length);
if (asciiOptimization && _isLatin(bytes)) {
return String.fromCharCodes(bytes);
}
return utf8.decode(bytes);
}
@pragma('vm:prefer-inline')
static bool _isLatin(Uint8List bytes) {
final length = bytes.length;
for (var i = 0; i < length; i++) {
if (bytes[i] > 127) {
return false;
}
}
return true;
}
}
/// An abstract reader for structs.
abstract class StructReader<T> extends Reader<T> {
const StructReader();
/// Return the object at `offset`.
T createObject(BufferContext bc, int offset);
@override
T read(BufferContext bc, int offset) {
return createObject(bc, offset);
}
}
/// An abstract reader for tables.
abstract class TableReader<T> extends Reader<T> {
const TableReader();
@override
@pragma('vm:prefer-inline')
int get size => 4;
/// Return the object at [offset].
T createObject(BufferContext bc, int offset);
@override
T read(BufferContext bc, int offset) {
final objectOffset = bc.derefObject(offset);
return createObject(bc, objectOffset);
}
}
/// Reader of lists of unsigned 32-bit integer values.
///
/// The returned unmodifiable lists lazily read values on access.
class Uint32ListReader extends Reader<List<int>> {
const Uint32ListReader();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
@pragma('vm:prefer-inline')
List<int> read(BufferContext bc, int offset) =>
_FbUint32List(bc, bc.derefObject(offset));
}
/// The reader of unsigned 64-bit integers.
///
/// WARNING: May have compatibility issues with JavaScript
class Uint64Reader extends Reader<int> {
const Uint64Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint64;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getUint64(offset);
}
/// The reader of unsigned 32-bit integers.
class Uint32Reader extends Reader<int> {
const Uint32Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getUint32(offset);
}
/// Reader of lists of unsigned 32-bit integer values.
///
/// The returned unmodifiable lists lazily read values on access.
class Uint16ListReader extends Reader<List<int>> {
const Uint16ListReader();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
@pragma('vm:prefer-inline')
List<int> read(BufferContext bc, int offset) =>
_FbUint16List(bc, bc.derefObject(offset));
}
/// The reader of unsigned 32-bit integers.
class Uint16Reader extends Reader<int> {
const Uint16Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint16;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getUint16(offset);
}
/// Reader of unmodifiable binary data (a list of unsigned 8-bit integers).
class Uint8ListReader extends Reader<List<int>> {
/// Enables lazy reading of the list
///
/// If true, the returned unmodifiable list lazily reads bytes on access.
/// Therefore, the underlying buffer must not change while accessing the list.
///
/// If false, reads the whole list immediately as an Uint8List.
final bool lazy;
const Uint8ListReader({this.lazy = true});
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
@pragma('vm:prefer-inline')
List<int> read(BufferContext bc, int offset) {
final listOffset = bc.derefObject(offset);
if (lazy) return _FbUint8List(bc, listOffset);
final length = bc._getUint32(listOffset);
final result = Uint8List(length);
var pos = listOffset + _sizeofUint32;
for (var i = 0; i < length; i++, pos++) {
result[i] = bc._getUint8(pos);
}
return result;
}
}
/// The reader of unsigned 8-bit integers.
class Uint8Reader extends Reader<int> {
const Uint8Reader() : super();
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint8;
@override
@pragma('vm:prefer-inline')
int read(BufferContext bc, int offset) => bc._getUint8(offset);
}
/// Reader of unmodifiable binary data (a list of signed 8-bit integers).
class Int8ListReader extends Reader<List<int>> {
/// Enables lazy reading of the list
///
/// If true, the returned unmodifiable list lazily reads bytes on access.
/// Therefore, the underlying buffer must not change while accessing the list.
///
/// If false, reads the whole list immediately as an Uint8List.
final bool lazy;
const Int8ListReader({this.lazy = true});
@override
@pragma('vm:prefer-inline')
int get size => _sizeofUint32;
@override
@pragma('vm:prefer-inline')
List<int> read(BufferContext bc, int offset) {
final listOffset = bc.derefObject(offset);
if (lazy) return _FbUint8List(bc, listOffset);
final length = bc._getUint32(listOffset);
final result = Int8List(length);
var pos = listOffset + _sizeofUint32;
for (var i = 0; i < length; i++, pos++) {
result[i] = bc._getInt8(pos);
}
return result;
}
}
/// The list backed by 64-bit values - Uint64 length and Float64.
class _FbFloat64List extends _FbList<double> {
_FbFloat64List(BufferContext bc, int offset) : super(bc, offset);
@override
@pragma('vm:prefer-inline')
double operator [](int i) => bc._getFloat64(offset + 4 + 8 * i);
}
/// The list backed by 32-bit values - Float32.
class _FbFloat32List extends _FbList<double> {
_FbFloat32List(BufferContext bc, int offset) : super(bc, offset);
@override
@pragma('vm:prefer-inline')
double operator [](int i) => bc._getFloat32(offset + 4 + 4 * i);
}
/// List backed by a generic object which may have any size.
class _FbGenericList<E> extends _FbList<E> {
final Reader<E> elementReader;
List<E?>? _items;
_FbGenericList(this.elementReader, BufferContext bp, int offset)
: super(bp, offset);
@override
@pragma('vm:prefer-inline')
E operator [](int i) {
_items ??= List<E?>.filled(length, null);
var item = _items![i];
if (item == null) {
item = elementReader.read(bc, offset + 4 + elementReader.size * i);
_items![i] = item;
}
return item!;
}
}
/// The base class for immutable lists read from flat buffers.
abstract class _FbList<E> extends Object with ListMixin<E> implements List<E> {
final BufferContext bc;
final int offset;
int? _length;
_FbList(this.bc, this.offset);
@override
@pragma('vm:prefer-inline')
int get length => _length ??= bc._getUint32(offset);
@override
set length(int i) => throw StateError('Attempt to modify immutable list');
@override
void operator []=(int i, E e) =>
throw StateError('Attempt to modify immutable list');
}
/// List backed by 32-bit unsigned integers.
class _FbUint32List extends _FbList<int> {
_FbUint32List(BufferContext bc, int offset) : super(bc, offset);
@override
@pragma('vm:prefer-inline')
int operator [](int i) => bc._getUint32(offset + 4 + 4 * i);
}
/// List backed by 16-bit unsigned integers.
class _FbUint16List extends _FbList<int> {
_FbUint16List(BufferContext bc, int offset) : super(bc, offset);
@override
@pragma('vm:prefer-inline')
int operator [](int i) => bc._getUint16(offset + 4 + 2 * i);
}
/// List backed by 8-bit unsigned integers.
class _FbUint8List extends _FbList<int> {
_FbUint8List(BufferContext bc, int offset) : super(bc, offset);
@override
@pragma('vm:prefer-inline')
int operator [](int i) => bc._getUint8(offset + 4 + i);
}
/// List backed by 8-bit signed integers.
class _FbInt8List extends _FbList<int> {
_FbInt8List(BufferContext bc, int offset) : super(bc, offset);
@override
@pragma('vm:prefer-inline')
int operator [](int i) => bc._getInt8(offset + 4 + i);
}
/// List backed by 8-bit unsigned integers.
class _FbBoolList extends _FbList<bool> {
_FbBoolList(BufferContext bc, int offset) : super(bc, offset);
@override
@pragma('vm:prefer-inline')
bool operator [](int i) => bc._getUint8(offset + 4 + i) == 1 ? true : false;
}
/// Class that describes the structure of a table.
class _VTable {
static const int _metadataLength = 4;
final int numFields;
// Note: fieldOffsets start as "tail offsets" and are then transformed by
// [computeFieldOffsets()] to actual offsets when a table is finished.
final Uint32List fieldOffsets;
bool offsetsComputed = false;
_VTable(this.numFields) : fieldOffsets = Uint32List(numFields);
/// The size of the table that uses this VTable.
int tableSize = 0;
/// The tail of this VTable. It is used to share the same VTable between
/// multiple tables of identical structure.
int tail = 0;
int get _vTableSize => numOfUint16 * _sizeofUint16;
int get numOfUint16 => 1 + 1 + numFields;
@pragma('vm:prefer-inline')
void addField(int field, int offset) {
assert(!offsetsComputed);
assert(offset > 0); // it's impossible for field to start at the buffer end
assert(offset <= 4294967295); // uint32 max
fieldOffsets[field] = offset;
}
@pragma('vm:prefer-inline')
bool _offsetsMatch(int vt2Start, ByteData buf) {
assert(offsetsComputed);
for (var i = 0; i < numFields; i++) {
if (fieldOffsets[i] !=
buf.getUint16(vt2Start + _metadataLength + (2 * i), Endian.little)) {
return false;
}
}
return true;
}
/// Fill the [fieldOffsets] field.
@pragma('vm:prefer-inline')
void computeFieldOffsets(int tableTail) {
assert(!offsetsComputed);
offsetsComputed = true;
for (var i = 0; i < numFields; i++) {
if (fieldOffsets[i] != 0) {
fieldOffsets[i] = tableTail - fieldOffsets[i];
}
}
}
/// Outputs this VTable to [buf], which is is expected to be aligned to 16-bit
/// and have at least [numOfUint16] 16-bit words available.
@pragma('vm:prefer-inline')
void output(ByteData buf, int bufOffset) {
assert(offsetsComputed);
// VTable size.
buf.setUint16(bufOffset, numOfUint16 * 2, Endian.little);
bufOffset += 2;
// Table size.
buf.setUint16(bufOffset, tableSize, Endian.little);
bufOffset += 2;
// Field offsets.
for (var i = 0; i < numFields; i++) {
buf.setUint16(bufOffset, fieldOffsets[i], Endian.little);
bufOffset += 2;
}
}
}
/// The interface that [Builder] uses to allocate buffers for encoding.
abstract class Allocator {
const Allocator();
/// Allocate a [ByteData] buffer of a given size.
ByteData allocate(int size);
/// Free the given [ByteData] buffer previously allocated by [allocate].
void deallocate(ByteData data);
/// Reallocate [newSize] bytes of memory, replacing the old [oldData]. This
/// grows downwards, and is intended specifically for use with [Builder].
/// Params [inUseBack] and [inUseFront] indicate how much of [oldData] is
/// actually in use at each end, and needs to be copied.
ByteData resize(
ByteData oldData, int newSize, int inUseBack, int inUseFront) {
final newData = allocate(newSize);
_copyDownward(oldData, newData, inUseBack, inUseFront);
deallocate(oldData);
return newData;
}
/// Called by [resize] to copy memory from [oldData] to [newData]. Only
/// memory of size [inUseFront] and [inUseBack] will be copied from the front
/// and back of the old memory allocation.
void _copyDownward(
ByteData oldData, ByteData newData, int inUseBack, int inUseFront) {
if (inUseBack != 0) {
newData.buffer.asUint8List().setAll(
newData.lengthInBytes - inUseBack,
oldData.buffer.asUint8List().getRange(
oldData.lengthInBytes - inUseBack, oldData.lengthInBytes));
}
if (inUseFront != 0) {
newData.buffer
.asUint8List()
.setAll(0, oldData.buffer.asUint8List().getRange(0, inUseFront));
}
}
}
class DefaultAllocator extends Allocator {
const DefaultAllocator();
@override
ByteData allocate(int size) => ByteData(size);
@override
void deallocate(ByteData data) {
// nothing to do, it's garbage-collected
}
}
|