Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 32x 1x 1x 21x 1x 626x 626x 626x 626x 626x 626x 626x 626x 626x 626x 626x 1x 164x 1x 14x 153x 14x 14x 6x 11x 1x 32x 81x 81x 81x 81x 1x 18x 18x 18x 1x 3x 3x 1x 62x 62x 62x 62x 62x 1x 6x 6x 1x 42x 42x 42x 42x 1x 26x 2x 2x 26x 26x 26x 62x 62x 62x 26x 1x 36x 2x 2x 36x 36x 36x 36x 1x 8x 7x 7x 1x 1x 8x 1x 2x 2x 2x 1x 134x 134x 134x 134x 134x 120x 14x 134x 14x 120x 134x 1x 77x 77x 77x 77x 77x 70x 7x 7x 77x 1x 120x 120x 2x 118x 120x 120x 120x 1x 70x 70x 70x 70x 70x 1x 18x 18x 18x 18x 18x 18x 18x 18x 18x 1x 9x 9x 9x 9x 9x 9x 9x 9x 9x 1x 217x 217x 217x 6x 6x 2x 4x 1x 134x 134x 1x 76x 76x 1x 7x 7x 2x 5x 1x 4x 1x 3x 1x 1x 1x 1x 2x 1x 1x 1x 1x 7x 6x 7x 1x 149x 134x 149x 1x 89x 76x 89x 1x 409x 409x 409x 409x 409x 409x 204x 205x 409x 409x 1x 593x 385x 385x 593x 593x 10x 593x 1x 340x 340x 340x 4x 4x 340x 223x 340x 4x 340x 1x 385x 383x 2x 2x 1x 1x 1x 1x 2x 2x 1x 593x 385x 593x 1x 340x 223x 340x 1x 14x 147x 147x 14x 81x 1x 77x 77x 77x 77x 31x 31x 77x 31x 31x 8x 8x 23x 3x 3x 20x 16x 16x 16x 16x 16x 16x 4x 4x 4x 31x 31x 31x 31x 77x 77x 31x 1x 48x 48x 48x 48x 17x 17x 48x 17x 7x 10x 1x 9x 8x 1x 1x 17x 17x 17x 17x 17x 17x 48x 48x 48x 48x 17x 7x 10x 1x 9x 8x 8x 8x 8x 8x 8x 1x 1x 17x 1x 2x 2x 1x 1x 1x 1x 53x 53x 53x 6x 6x 6x 47x 24x 24x 23x 21x 21x 21x 2x 2x 2x 2x 53x 2x 53x 1x 1x 33x 33x 22x 22x 22x 22x 22x 22x 22x 22x 22x 5x 5x 4x 22x 22x 2x 22x 22x 20x 11x 33x 13x 1x 5x 2x 3x 3x 5x 1x 1x 2x 1x 39x 39x 39x 39x 39x 39x 39x 39x 39x 1x 38x 39x 6x 33x 8x 25x 9x 16x 39x 23x 19x 19x 4x 4x 4x 4x 16x 16x 16x 16x 16x 39x 1x 38x 39x 39x 6x 1x 27x 27x 27x 27x 27x 27x 27x 27x 27x 1x 27x 27x 27x 9x 27x 27x 27x 27x 27x 5x 22x 27x 27x 27x 16x 14x 2x 2x 2x 11x 11x 11x 11x 27x 27x 2x 25x 3x 27x 27x 27x 27x 6x 27x 27x 1x 64x 28x 14x 14x 14x 14x 14x 14x 36x 36x 36x 36x 1x 32x 14x 7x 7x 7x 7x 7x 18x 18x 18x 18x 1x 26x 26x 20x 26x 26x 62x 62x 62x 62x 26x 26x 2x 24x 26x 1x 13x 13x 13x 31x 31x 31x 31x 13x 13x 1x 12x 13x 1x 36x 36x 18x 14x 18x 18x 18x 18x 18x 18x 18x 18x 1x 18x 18x 9x 9x 9x 9x 9x 9x 9x 9x 1x 10x 10x 1x 4x 4x 1x 1x | //========================================================================================
// Globals
//========================================================================================
var vm = require("vm");
const SmartBuffer = require("smart-buffer").SmartBuffer;
global.SmartBuffer = SmartBuffer;
var Context = require("./context").Context;
var PRIMITIVE_TYPES = {
UInt8: 1,
UInt16LE: 2,
UInt16BE: 2,
UInt32LE: 4,
UInt32BE: 4,
Int8: 1,
Int16LE: 2,
Int16BE: 2,
Int32LE: 4,
Int32BE: 4,
FloatLE: 4,
FloatBE: 4,
DoubleLE: 8,
DoubleBE: 8
};
var SPECIAL_TYPES = {
String: null,
Buffer: null,
Array: null,
Skip: null,
Choice: null,
Nest: null,
Bit: null
};
var aliasRegistry = {};
var FUNCTION_PREFIX = "___parser_";
var FUNCTION_ENCODE_PREFIX = "___encoder_";
var BIT_RANGE = [];
(function() {
var i;
for (i = 1; i <= 32; i++) {
BIT_RANGE.push(i);
}
})();
// Converts Parser's method names to internal type names
var NAME_MAP = {};
Object.keys(PRIMITIVE_TYPES)
.concat(Object.keys(SPECIAL_TYPES))
.forEach(function(type) {
NAME_MAP[type.toLowerCase()] = type;
});
//========================================================================================
// class Parser
//========================================================================================
//----------------------------------------------------------------------------------------
// constructor
//----------------------------------------------------------------------------------------
var Parser = function(opts) {
this.varName = "";
this.type = "";
this.options = {};
this.next = null;
this.head = null;
this.compiled = null;
this.endian = "be";
this.constructorFn = null;
this.alias = null;
this.smartBufferSize =
opts && typeof opts === "object" && opts.smartBufferSize
? opts.smartBufferSize
: 256;
this.encoderBitEndianess =
opts && typeof opts === "object" && opts.encoderBitEndianess
? opts.encoderBitEndianess
: false;
};
//----------------------------------------------------------------------------------------
// public methods
//----------------------------------------------------------------------------------------
Parser.start = function(opts) {
return new Parser(opts);
};
Object.keys(PRIMITIVE_TYPES).forEach(function(type) {
Parser.prototype[type.toLowerCase()] = function(varName, options) {
return this.setNextParser(type.toLowerCase(), varName, options);
};
var typeWithoutEndian = type.replace(/BE|LE/, "").toLowerCase();
if (!(typeWithoutEndian in Parser.prototype)) {
Parser.prototype[typeWithoutEndian] = function(varName, options) {
return this[typeWithoutEndian + this.endian](varName, options);
};
}
});
BIT_RANGE.forEach(function(i) {
Parser.prototype["bit" + i.toString()] = function(varName, options) {
Eif (!options) {
options = {};
}
options.length = i;
return this.setNextParser("bit", varName, options);
};
});
Parser.prototype.namely = function(alias) {
aliasRegistry[alias] = this;
this.alias = alias;
return this;
};
Parser.prototype.skip = function(length, options) {
Iif (options && options.assert) {
throw new Error("assert option on skip is not allowed.");
}
return this.setNextParser("skip", "", { length: length });
};
Parser.prototype.string = function(varName, options) {
Iif (!options.zeroTerminated && !options.length && !options.greedy) {
throw new Error(
"Neither length, zeroTerminated, nor greedy is defined for string."
);
}
Iif ((options.zeroTerminated || options.length) && options.greedy) {
throw new Error(
"greedy is mutually exclusive with length and zeroTerminated for string."
);
}
Iif (options.stripNull && !(options.length || options.greedy)) {
throw new Error(
"Length or greedy must be defined if stripNull is defined."
);
}
options.encoding = options.encoding || "utf8";
return this.setNextParser("string", varName, options);
};
Parser.prototype.buffer = function(varName, options) {
Iif (!options.length && !options.readUntil) {
throw new Error("Length nor readUntil is defined in buffer parser");
}
return this.setNextParser("buffer", varName, options);
};
Parser.prototype.array = function(varName, options) {
Iif (!options.readUntil && !options.length && !options.lengthInBytes) {
throw new Error("Length option of array is not defined.");
}
Iif (!options.type) {
throw new Error("Type option of array is not defined.");
}
Iif (
typeof options.type === "string" &&
!aliasRegistry[options.type] &&
Object.keys(PRIMITIVE_TYPES).indexOf(NAME_MAP[options.type]) < 0
) {
throw new Error(
'Specified primitive type "' + options.type + '" is not supported.'
);
}
return this.setNextParser("array", varName, options);
};
Parser.prototype.choice = function(varName, options) {
if (arguments.length == 1 && typeof varName === "object") {
options = varName;
varName = null;
}
Iif (!options.tag) {
throw new Error("Tag option of array is not defined.");
}
Iif (!options.choices) {
throw new Error("Choices option of array is not defined.");
}
Object.keys(options.choices).forEach(function(key) {
Iif (isNaN(parseInt(key, 10))) {
throw new Error("Key of choices must be a number.");
}
Iif (!options.choices[key]) {
throw new Error(
"Choice Case " + key + " of " + varName + " is not valid."
);
}
Iif (
typeof options.choices[key] === "string" &&
!aliasRegistry[options.choices[key]] &&
Object.keys(PRIMITIVE_TYPES).indexOf(NAME_MAP[options.choices[key]]) < 0
) {
throw new Error(
'Specified primitive type "' +
options.choices[key] +
'" is not supported.'
);
}
}, this);
return this.setNextParser("choice", varName, options);
};
Parser.prototype.nest = function(varName, options) {
if (arguments.length == 1 && typeof varName === "object") {
options = varName;
varName = null;
}
Iif (!options.type) {
throw new Error("Type option of nest is not defined.");
}
Iif (!(options.type instanceof Parser) && !aliasRegistry[options.type]) {
throw new Error("Type option of nest must be a Parser object.");
}
Iif (!(options.type instanceof Parser) && !varName) {
throw new Error(
"options.type must be a object if variable name is omitted."
);
}
return this.setNextParser("nest", varName, options);
};
Parser.prototype.endianess = function(endianess) {
switch (endianess.toLowerCase()) {
case "little":
this.endian = "le";
break;
case "big":
this.endian = "be";
break;
default:
throw new Error("Invalid endianess: " + endianess);
}
return this;
};
Parser.prototype.create = function(constructorFn) {
Iif (!(constructorFn instanceof Function)) {
throw new Error("Constructor must be a Function object.");
}
this.constructorFn = constructorFn;
return this;
};
Parser.prototype.getCode = function() {
var ctx = new Context();
ctx.pushCode("if (!Buffer.isBuffer(buffer)) {");
ctx.generateError('"argument buffer is not a Buffer object"');
ctx.pushCode("}");
if (!this.alias) {
this.addRawCode(ctx);
} else {
this.addAliasedCode(ctx);
}
if (this.alias) {
ctx.pushCode("return {0}(0).result;", FUNCTION_PREFIX + this.alias);
} else {
ctx.pushCode("return vars;");
}
return ctx.code;
};
Parser.prototype.getCodeEncode = function() {
var ctx = new Context();
ctx.pushCode("if (!obj || typeof obj !== 'object') {");
ctx.generateError('"argument obj is not an object"');
ctx.pushCode("}");
if (!this.alias) {
this.addRawCodeEncode(ctx);
} else {
this.addAliasedCodeEncode(ctx);
ctx.pushCode("return {0}(obj);", FUNCTION_ENCODE_PREFIX + this.alias);
}
return ctx.code;
};
Parser.prototype.addRawCode = function(ctx) {
ctx.pushCode("var offset = 0;");
if (this.constructorFn) {
ctx.pushCode("var vars = new constructorFn();");
} else {
ctx.pushCode("var vars = {};");
}
this.generate(ctx);
this.resolveReferences(ctx);
ctx.pushCode("return vars;");
};
Parser.prototype.addRawCodeEncode = function(ctx) {
ctx.pushCode("var vars = obj;");
ctx.pushCode(
"var smartBuffer = SmartBuffer.fromOptions({size: {0}, encoding: 'utf8'});",
this.smartBufferSize
);
this.generateEncode(ctx);
this.resolveReferences(ctx, "encode");
ctx.pushCode("return smartBuffer.toBuffer();");
};
Parser.prototype.addAliasedCode = function(ctx) {
ctx.pushCode("function {0}(offset) {", FUNCTION_PREFIX + this.alias);
Iif (this.constructorFn) {
ctx.pushCode("var vars = new constructorFn();");
} else {
ctx.pushCode("var vars = {};");
}
this.generate(ctx);
ctx.markResolved(this.alias);
this.resolveReferences(ctx);
ctx.pushCode("return { offset: offset, result: vars };");
ctx.pushCode("}");
return ctx;
};
Parser.prototype.addAliasedCodeEncode = function(ctx) {
ctx.pushCode("function {0}(obj) {", FUNCTION_ENCODE_PREFIX + this.alias);
ctx.pushCode("var vars = obj;");
ctx.pushCode(
"var smartBuffer = SmartBuffer.fromOptions({size: {0}, encoding: 'utf8'});",
this.smartBufferSize
);
this.generateEncode(ctx);
ctx.markResolved(this.alias);
this.resolveReferences(ctx, "encode");
ctx.pushCode("return smartBuffer.toBuffer();");
ctx.pushCode("}");
return ctx;
};
Parser.prototype.resolveReferences = function(ctx, encode) {
var references = ctx.getUnresolvedReferences();
ctx.markRequested(references);
references.forEach(function(alias) {
var parser = aliasRegistry[alias];
if (encode) {
parser.addAliasedCodeEncode(ctx);
} else {
parser.addAliasedCode(ctx);
}
});
};
Parser.prototype.compile = function() {
var src = "(function(buffer, constructorFn) { " + this.getCode() + " })";
this.compiled = vm.runInThisContext(src);
};
Parser.prototype.compileEncode = function() {
var src = "(function(obj) { " + this.getCodeEncode() + " })";
this.compiledEncode = vm.runInThisContext(src);
};
Parser.prototype.sizeOf = function() {
var size = NaN;
if (Object.keys(PRIMITIVE_TYPES).indexOf(this.type) >= 0) {
size = PRIMITIVE_TYPES[this.type];
// if this is a fixed length string
} else if (
this.type === "String" &&
typeof this.options.length === "number"
) {
size = this.options.length;
// if this is a fixed length buffer
} else if (
this.type === "Buffer" &&
typeof this.options.length === "number"
) {
size = this.options.length;
// if this is a fixed length array
} else if (this.type === "Array" && typeof this.options.length === "number") {
var elementSize = NaN;
Eif (typeof this.options.type === "string") {
elementSize = PRIMITIVE_TYPES[NAME_MAP[this.options.type]];
} else if (this.options.type instanceof Parser) {
elementSize = this.options.type.sizeOf();
}
size = this.options.length * elementSize;
// if this a skip
} else if (this.type === "Skip") {
size = this.options.length;
// if this is a nested parser
} else Iif (this.type === "Nest") {
size = this.options.type.sizeOf();
} else Eif (!this.type) {
size = 0;
}
if (this.next) {
size += this.next.sizeOf();
}
return size;
};
// Follow the parser chain till the root and start parsing from there
Parser.prototype.parse = function(buffer) {
if (!this.compiled) {
this.compile();
}
return this.compiled(buffer, this.constructorFn);
};
// Follow the parser chain till the root and start encoding from there
Parser.prototype.encode = function(obj) {
if (!this.compiledEncode) {
this.compileEncode();
}
return this.compiledEncode(obj);
};
//----------------------------------------------------------------------------------------
// private methods
//----------------------------------------------------------------------------------------
Parser.prototype.setNextParser = function(type, varName, options) {
var parser = new Parser();
parser.type = NAME_MAP[type];
parser.varName = varName;
parser.options = options || parser.options;
parser.endian = this.endian;
if (this.head) {
this.head.next = parser;
} else {
this.next = parser;
}
this.head = parser;
return this;
};
// Call code generator for this parser
Parser.prototype.generate = function(ctx) {
if (this.type) {
this["generate" + this.type](ctx);
this.generateAssert(ctx);
}
var varName = ctx.generateVariable(this.varName);
if (this.options.formatter) {
this.generateFormatter(ctx, varName, this.options.formatter);
}
return this.generateNext(ctx);
};
Parser.prototype.generateEncode = function(ctx) {
var varName = ctx.generateVariable(this.varName);
var savVarName = ctx.generateTmpVariable();
// Transform with the possibly provided encoder before encoding
if (this.options.encoder) {
// Save varName before applying encoder
ctx.pushCode("var {0} = {1};", savVarName, varName);
this.generateEncoder(ctx, varName, this.options.encoder);
}
if (this.type) {
this["generate_encode" + this.type](ctx);
}
if (this.options.encoder) {
// Restore varName after encoder transformation so that next parsers will
// have access to original field value (but not nested ones)
ctx.pushCode("{0} = {1};", varName, savVarName);
}
return this.generateEncodeNext(ctx);
};
Parser.prototype.generateAssert = function(ctx) {
if (!this.options.assert) {
return;
}
var varName = ctx.generateVariable(this.varName);
switch (typeof this.options.assert) {
case "function":
ctx.pushCode(
"if (!({0}).call(vars, {1})) {",
this.options.assert,
varName
);
break;
case "number":
ctx.pushCode("if ({0} !== {1}) {", this.options.assert, varName);
break;
case "string":
ctx.pushCode('if ("{0}" !== {1}) {', this.options.assert, varName);
break;
default:
throw new Error(
"Assert option supports only strings, numbers and assert functions."
);
}
ctx.generateError('"Assert error: {0} is " + {0}', varName);
ctx.pushCode("}");
};
// Recursively call code generators and append results
Parser.prototype.generateNext = function(ctx) {
if (this.next) {
ctx = this.next.generate(ctx);
}
return ctx;
};
// Recursively call code generators and append results
Parser.prototype.generateEncodeNext = function(ctx) {
if (this.next) {
ctx = this.next.generateEncode(ctx);
}
return ctx;
};
Object.keys(PRIMITIVE_TYPES).forEach(function(type) {
Parser.prototype["generate" + type] = function(ctx) {
ctx.pushCode(
"{0} = buffer.read{1}(offset);",
ctx.generateVariable(this.varName),
type
);
ctx.pushCode("offset += {0};", PRIMITIVE_TYPES[type]);
};
Parser.prototype["generate_encode" + type] = function(ctx) {
ctx.pushCode(
"smartBuffer.write{0}({1});",
type,
ctx.generateVariable(this.varName)
);
};
});
Parser.prototype.generateBit = function(ctx) {
// TODO find better method to handle nested bit fields
var parser = JSON.parse(JSON.stringify(this));
parser.varName = ctx.generateVariable(parser.varName);
ctx.bitFields.push(parser);
if (
!this.next ||
(this.next && ["Bit", "Nest"].indexOf(this.next.type) < 0)
) {
var sum = 0;
ctx.bitFields.forEach(function(parser) {
sum += parser.options.length;
});
var val = ctx.generateTmpVariable();
if (sum <= 8) {
ctx.pushCode("var {0} = buffer.readUInt8(offset);", val);
sum = 8;
} else if (sum <= 16) {
ctx.pushCode("var {0} = buffer.readUInt16BE(offset);", val);
sum = 16;
} else if (sum <= 24) {
var val1 = ctx.generateTmpVariable();
var val2 = ctx.generateTmpVariable();
ctx.pushCode("var {0} = buffer.readUInt16BE(offset);", val1);
ctx.pushCode("var {0} = buffer.readUInt8(offset + 2);", val2);
ctx.pushCode("var {2} = ({0} << 8) | {1};", val1, val2, val);
sum = 24;
} else Eif (sum <= 32) {
ctx.pushCode("var {0} = buffer.readUInt32BE(offset);", val);
sum = 32;
} else {
throw new Error(
"Currently, bit field sequence longer than 4-bytes is not supported."
);
}
ctx.pushCode("offset += {0};", sum / 8);
var bitOffset = 0;
var isBigEndian = this.endian === "be";
ctx.bitFields.forEach(function(parser) {
ctx.pushCode(
"{0} = {1} >> {2} & {3};",
parser.varName,
val,
isBigEndian ? sum - bitOffset - parser.options.length : bitOffset,
(1 << parser.options.length) - 1
);
bitOffset += parser.options.length;
});
ctx.bitFields = [];
}
};
Parser.prototype.generate_encodeBit = function(ctx) {
// TODO find better method to handle nested bit fields
var parser = JSON.parse(JSON.stringify(this));
parser.varName = ctx.generateVariable(parser.varName);
ctx.bitFields.push(parser);
if (
!this.next ||
(this.next && ["Bit", "Nest"].indexOf(this.next.type) < 0)
) {
var sum = 0;
ctx.bitFields.forEach(function(parser) {
sum += parser.options.length;
});
if (sum <= 8) {
sum = 8;
} else if (sum <= 16) {
sum = 16;
} else if (sum <= 24) {
sum = 24;
} else Eif (sum <= 32) {
sum = 32;
} else {
throw new Error(
"Currently, bit field sequence longer than 4-bytes is not supported."
);
}
var tmpVal = ctx.generateTmpVariable();
var boundVal = ctx.generateTmpVariable();
ctx.pushCode("var {0} = 0;", tmpVal);
ctx.pushCode("var {0} = 0;", boundVal);
var bitOffset = 0;
ctx.bitFields.forEach(function (parser) {
ctx.pushCode(
"{0} = ({1} & {2});",
boundVal,
parser.varName,
(1 << parser.options.length) -1
);
ctx.pushCode(
"{0} |= ({1} << {2});",
tmpVal,
boundVal,
this.encoderBitEndianess && this.endian === 'le' ? bitOffset : sum - bitOffset - parser.options.length
);
ctx.pushCode("{0} = {0} >>> 0;", tmpVal);
bitOffset += parser.options.length;
});
if (sum == 8) {
ctx.pushCode("smartBuffer.writeUInt8({0});", tmpVal);
} else if (sum == 16) {
ctx.pushCode("smartBuffer.writeUInt16BE({0});", tmpVal);
} else if (sum == 24) {
var val1 = ctx.generateTmpVariable();
var val2 = ctx.generateTmpVariable();
ctx.pushCode("var {0} = ({1} >>> 8);", val1, tmpVal);
ctx.pushCode("var {0} = ({1} & 0x0ff);", val2, tmpVal);
ctx.pushCode("smartBuffer.writeUInt16BE({0});", val1);
ctx.pushCode("smartBuffer.writeUInt8({0});", val2);
} else Eif (sum == 32) {
ctx.pushCode("smartBuffer.writeUInt32BE({0});", tmpVal);
}
ctx.bitFields = [];
}
};
Parser.prototype.generateSkip = function(ctx) {
var length = ctx.generateOption(this.options.length);
ctx.pushCode("offset += {0};", length);
};
Parser.prototype.generate_encodeSkip = function(ctx) {
var length = ctx.generateOption(this.options.length);
ctx.pushCode("smartBuffer.writeBuffer(Buffer.alloc({0}));", length);
};
Parser.prototype.generateString = function(ctx) {
var name = ctx.generateVariable(this.varName);
var start = ctx.generateTmpVariable();
if (this.options.length && this.options.zeroTerminated) {
ctx.pushCode("var {0} = offset;", start);
ctx.pushCode(
"while(buffer.readUInt8(offset++) !== 0 && offset - {0} < {1});",
start,
this.options.length
);
ctx.pushCode(
"{0} = buffer.toString('{1}', {2}, offset - {2} < {3} ? offset - 1 : offset);",
name,
this.options.encoding,
start,
this.options.length
);
} else if (this.options.length) {
ctx.pushCode(
"{0} = buffer.toString('{1}', offset, offset + {2});",
name,
this.options.encoding,
ctx.generateOption(this.options.length)
);
ctx.pushCode("offset += {0};", ctx.generateOption(this.options.length));
} else if (this.options.zeroTerminated) {
ctx.pushCode("var {0} = offset;", start);
ctx.pushCode("while(buffer.readUInt8(offset++) !== 0);");
ctx.pushCode(
"{0} = buffer.toString('{1}', {2}, offset - 1);",
name,
this.options.encoding,
start
);
} else Eif (this.options.greedy) {
ctx.pushCode("var {0} = offset;", start);
ctx.pushCode("while(buffer.length > offset++);");
ctx.pushCode(
"{0} = buffer.toString('{1}', {2}, offset);",
name,
this.options.encoding,
start
);
}
if (this.options.stripNull) {
ctx.pushCode("{0} = {0}.replace(/\\x00+$/g, '')", name);
}
if (this.options.trim) {
ctx.pushCode("{0} = {0}.trim()", name);
}
};
Parser.prototype.generate_encodeString = function(ctx) {
var name = ctx.generateVariable(this.varName);
// Get the length of string to encode
if (this.options.length) {
var optLength = ctx.generateOption(this.options.length);
// Encode the string to a temporary buffer
var tmpBuf = ctx.generateTmpVariable();
ctx.pushCode(
"var {0} = Buffer.from({1}, '{2}');",
tmpBuf,
name,
this.options.encoding
);
// Truncate the buffer to specified (Bytes) length
ctx.pushCode("{0} = {0}.slice(0, {1});", tmpBuf, optLength);
// Compute padding length
var padLen = ctx.generateTmpVariable();
ctx.pushCode("{0} = {1} - {2}.length;", padLen, optLength, tmpBuf);
var padCharVar = ctx.generateTmpVariable();
var padChar = " ";
if (this.options.padd && typeof this.options.padd === "string") {
var code = this.options.padd.charCodeAt(0);
if (code < 0x80) {
padChar = String.fromCharCode(code);
}
}
ctx.pushCode('{0} = "{1}";', padCharVar, padChar);
if (this.options.padding === "left") {
// Add heading padding spaces
ctx.pushCode(
"if ({0} > 0) {smartBuffer.writeString({1}.repeat({0}));}",
padLen,
padCharVar
);
}
// Copy the temporary string buffer to current smartBuffer
ctx.pushCode("smartBuffer.writeBuffer({0});", tmpBuf);
if (this.options.padding !== "left") {
// Add trailing padding spaces
ctx.pushCode(
"if ({0} > 0) {smartBuffer.writeString({1}.repeat({0}));}",
padLen,
padCharVar
);
}
} else {
ctx.pushCode(
"smartBuffer.writeString({0}, '{1}');",
name,
this.options.encoding
);
}
if (this.options.zeroTerminated) {
ctx.pushCode("smartBuffer.writeUInt8(0x00);");
}
};
Parser.prototype.generateBuffer = function(ctx) {
if (this.options.readUntil === "eof") {
ctx.pushCode(
"{0} = buffer.slice(offset);",
ctx.generateVariable(this.varName)
);
} else {
ctx.pushCode(
"{0} = buffer.slice(offset, offset + {1});",
ctx.generateVariable(this.varName),
ctx.generateOption(this.options.length)
);
ctx.pushCode("offset += {0};", ctx.generateOption(this.options.length));
}
if (this.options.clone) {
ctx.pushCode("{0} = Buffer.from({0});", ctx.generateVariable(this.varName));
}
};
Parser.prototype.generate_encodeBuffer = function(ctx) {
ctx.pushCode(
"smartBuffer.writeBuffer({0});",
ctx.generateVariable(this.varName)
);
};
Parser.prototype.generateArray = function(ctx) {
var length = ctx.generateOption(this.options.length);
var lengthInBytes = ctx.generateOption(this.options.lengthInBytes);
var type = this.options.type;
var counter = ctx.generateTmpVariable();
var lhs = ctx.generateVariable(this.varName);
var item = ctx.generateTmpVariable();
var key = this.options.key;
var isHash = typeof key === "string";
if (isHash) {
ctx.pushCode("{0} = {};", lhs);
} else {
ctx.pushCode("{0} = [];", lhs);
}
if (typeof this.options.readUntil === "function") {
ctx.pushCode("do {");
} else if (this.options.readUntil === "eof") {
ctx.pushCode("for (var {0} = 0; offset < buffer.length; {0}++) {", counter);
} else if (lengthInBytes !== undefined) {
ctx.pushCode(
"for (var {0} = offset; offset - {0} < {1}; ) {",
counter,
lengthInBytes
);
} else {
ctx.pushCode("for (var {0} = 0; {0} < {1}; {0}++) {", counter, length);
}
if (typeof type === "string") {
if (!aliasRegistry[type]) {
ctx.pushCode("var {0} = buffer.read{1}(offset);", item, NAME_MAP[type]);
ctx.pushCode("offset += {0};", PRIMITIVE_TYPES[NAME_MAP[type]]);
} else {
var tempVar = ctx.generateTmpVariable();
ctx.pushCode("var {0} = {1}(offset);", tempVar, FUNCTION_PREFIX + type);
ctx.pushCode("var {0} = {1}.result; offset = {1}.offset;", item, tempVar);
Eif (type !== this.alias) ctx.addReference(type);
}
} else Eif (type instanceof Parser) {
ctx.pushCode("var {0} = {};", item);
ctx.pushScope(item);
type.generate(ctx);
ctx.popScope();
}
if (isHash) {
ctx.pushCode("{0}[{2}.{1}] = {2};", lhs, key, item);
} else {
ctx.pushCode("{0}.push({1});", lhs, item);
}
ctx.pushCode("}");
if (typeof this.options.readUntil === "function") {
ctx.pushCode(
" while (!({0}).call(this, {1}, buffer.slice(offset)));",
this.options.readUntil,
item
);
}
};
Parser.prototype.generate_encodeArray = function(ctx) {
var length = ctx.generateOption(this.options.length);
var lengthInBytes = ctx.generateOption(this.options.lengthInBytes);
var type = this.options.type;
var name = ctx.generateVariable(this.varName);
var item = ctx.generateTmpVariable();
var itemCounter = ctx.generateTmpVariable();
var maxItems = ctx.generateTmpVariable();
var isHash = typeof this.options.key === "string";
if (isHash) {
ctx.generateError('"Encoding associative array not supported"');
}
ctx.pushCode("var {0} = 0;", maxItems);
// Get default array length (if defined)
ctx.pushCode("if({0}) {{1} = {0}.length;}", name, maxItems);
// Compute the desired count of array items to encode (min of array size and length option)
if (length !== undefined) {
ctx.pushCode("{0} = {0} > {1} ? {1} : {0};", maxItems, length);
}
// Save current encoding smartBuffer and allocate a new one
var savSmartBuffer = ctx.generateTmpVariable();
ctx.pushCode(
"var {0} = smartBuffer; smartBuffer = SmartBuffer.fromOptions({size: {1}, encoding: 'utf8'});",
savSmartBuffer,
this.smartBufferSize
);
ctx.pushCode("if({0} > 0) { ", maxItems);
ctx.pushCode("var {0} = 0;", itemCounter);
if (
typeof this.options.encodeUntil === "function" ||
typeof this.options.readUntil === "function"
) {
ctx.pushCode("do {");
} else {
ctx.pushCode("for ( ; {0} < {1}; ) {", itemCounter, maxItems);
}
ctx.pushCode("var {0} = {1}[{2}];", item, name, itemCounter);
ctx.pushCode("{0}++;", itemCounter);
if (typeof type === "string") {
if (!aliasRegistry[type]) {
ctx.pushCode("smartBuffer.write{0}({1});", NAME_MAP[type], item);
} else {
ctx.pushCode(
"smartBuffer.writeBuffer({0}({1}));",
FUNCTION_ENCODE_PREFIX + type,
item
);
Eif (type !== this.alias) {
ctx.addReference(type);
}
}
} else Eif (type instanceof Parser) {
ctx.pushScope(item);
type.generateEncode(ctx);
ctx.popScope();
}
ctx.pushCode("}"); // End of 'do {' or 'for(...) {'
if (typeof this.options.encodeUntil === "function") {
ctx.pushCode(
" while ({0} < {1} && !({2}).call(this, {3}, vars));",
itemCounter,
maxItems,
this.options.encodeUntil,
item
);
} else if (typeof this.options.readUntil === "function") {
ctx.pushCode(
" while ({0} < {1} && !({2}).call(this, {3}, {4}.toBuffer()));",
itemCounter,
maxItems,
this.options.readUntil,
item,
savSmartBuffer
);
}
ctx.pushCode("}"); // End of 'if(...) {'
var tmpBuffer = ctx.generateTmpVariable();
ctx.pushCode("var {0} = smartBuffer.toBuffer()", tmpBuffer);
if (lengthInBytes !== undefined) {
// Truncate the tmpBuffer so that it will respect the lengthInBytes option
ctx.pushCode("{0} = {0}.slice(0, {1});", tmpBuffer, lengthInBytes);
}
// Copy tmp Buffer to saved smartBuffer
ctx.pushCode("{0}.writeBuffer({1});", savSmartBuffer, tmpBuffer);
// Restore current smartBuffer
ctx.pushCode("smartBuffer = {0};", savSmartBuffer);
};
Parser.prototype.generateChoiceCase = function(ctx, varName, type) {
if (typeof type === "string") {
if (!aliasRegistry[type]) {
ctx.pushCode(
"{0} = buffer.read{1}(offset);",
ctx.generateVariable(this.varName),
NAME_MAP[type]
);
ctx.pushCode("offset += {0};", PRIMITIVE_TYPES[NAME_MAP[type]]);
} else {
var tempVar = ctx.generateTmpVariable();
ctx.pushCode("var {0} = {1}(offset);", tempVar, FUNCTION_PREFIX + type);
ctx.pushCode(
"{0} = {1}.result; offset = {1}.offset;",
ctx.generateVariable(this.varName),
tempVar
);
Eif (type !== this.alias) ctx.addReference(type);
}
} else Eif (type instanceof Parser) {
ctx.pushPath(varName);
type.generate(ctx);
ctx.popPath(varName);
}
};
Parser.prototype.generate_encodeChoiceCase = function(ctx, varName, type) {
if (typeof type === "string") {
if (!aliasRegistry[type]) {
ctx.pushCode(
"smartBuffer.write{0}({1});",
NAME_MAP[type],
ctx.generateVariable(this.varName)
);
} else {
var tempVar = ctx.generateTmpVariable();
ctx.pushCode(
"var {0} = {1}({2});",
tempVar,
FUNCTION_ENCODE_PREFIX + type,
ctx.generateVariable(this.varName)
);
ctx.pushCode("smartBuffer.writeBuffer({0});", tempVar);
Eif (type !== this.alias) ctx.addReference(type);
}
} else Eif (type instanceof Parser) {
ctx.pushPath(varName);
type.generateEncode(ctx);
ctx.popPath(varName);
}
};
Parser.prototype.generateChoice = function(ctx) {
var tag = ctx.generateOption(this.options.tag);
if (this.varName) {
ctx.pushCode("{0} = {};", ctx.generateVariable(this.varName));
}
ctx.pushCode("switch({0}) {", tag);
Object.keys(this.options.choices).forEach(function(tag) {
var type = this.options.choices[tag];
ctx.pushCode("case {0}:", tag);
this.generateChoiceCase(ctx, this.varName, type);
ctx.pushCode("break;");
}, this);
ctx.pushCode("default:");
if (this.options.defaultChoice) {
this.generateChoiceCase(ctx, this.varName, this.options.defaultChoice);
} else {
ctx.generateError('"Met undefined tag value " + {0} + " at choice"', tag);
}
ctx.pushCode("}");
};
Parser.prototype.generate_encodeChoice = function(ctx) {
var tag = ctx.generateOption(this.options.tag);
ctx.pushCode("switch({0}) {", tag);
Object.keys(this.options.choices).forEach(function(tag) {
var type = this.options.choices[tag];
ctx.pushCode("case {0}:", tag);
this.generate_encodeChoiceCase(ctx, this.varName, type);
ctx.pushCode("break;");
}, this);
ctx.pushCode("default:");
if (this.options.defaultChoice) {
this.generate_encodeChoiceCase(
ctx,
this.varName,
this.options.defaultChoice
);
} else {
ctx.generateError('"Met undefined tag value " + {0} + " at choice"', tag);
}
ctx.pushCode("}");
};
Parser.prototype.generateNest = function(ctx) {
var nestVar = ctx.generateVariable(this.varName);
if (this.options.type instanceof Parser) {
if (this.varName) {
ctx.pushCode("{0} = {};", nestVar);
}
ctx.pushPath(this.varName);
this.options.type.generate(ctx);
ctx.popPath(this.varName);
} else Eif (aliasRegistry[this.options.type]) {
var tempVar = ctx.generateTmpVariable();
ctx.pushCode(
"var {0} = {1}(offset);",
tempVar,
FUNCTION_PREFIX + this.options.type
);
ctx.pushCode("{0} = {1}.result; offset = {1}.offset;", nestVar, tempVar);
Eif (this.options.type !== this.alias) ctx.addReference(this.options.type);
}
};
Parser.prototype.generate_encodeNest = function(ctx) {
var nestVar = ctx.generateVariable(this.varName);
if (this.options.type instanceof Parser) {
ctx.pushPath(this.varName);
this.options.type.generateEncode(ctx);
ctx.popPath(this.varName);
} else Eif (aliasRegistry[this.options.type]) {
var tempVar = ctx.generateTmpVariable();
ctx.pushCode(
"var {0} = {1}({2});",
tempVar,
FUNCTION_ENCODE_PREFIX + this.options.type,
nestVar
);
ctx.pushCode("smartBuffer.writeBuffer({0});", tempVar);
Eif (this.options.type !== this.alias) ctx.addReference(this.options.type);
}
};
Parser.prototype.generateFormatter = function(ctx, varName, formatter) {
Eif (typeof formatter === "function") {
ctx.pushCode(
"{0} = ({1}).call(this, {0}, vars, buffer, offset);",
varName,
formatter
);
}
};
Parser.prototype.generateEncoder = function(ctx, varName, encoder) {
Eif (typeof encoder === "function") {
ctx.pushCode("{0} = ({1}).call(this, {0}, vars);", varName, encoder);
}
};
Parser.prototype.isInteger = function() {
return !!this.type.match(/U?Int[8|16|32][BE|LE]?|Bit\d+/);
};
//========================================================================================
// Exports
//========================================================================================
exports.Parser = Parser;
|