bireader 1.0.19 → 1.0.20

package/README.md

@@ -420,12 +420,14 @@ Common functions for setup, movement, manipulation and math shared by both.
   <tr>
     <td>Name</td>
     <td>delete(startOffset, endOffset, consume)</td>
-    <td align="center" rowspan="2">Start byte of data (default 0), end byte of data (default current byte position), move byte position to after data read (default false)</td>
-    <td rowspan="2">Removes and returns data. <br><b>Note:</b> Errors on strict mode</td>
+    <td align="center">Start byte of data (default 0), end byte of data (default current byte position), move byte position to after data read (default false)</td>
+    <td >Removes and returns data. <br><b>Note:</b> Errors on strict mode</td>
   </tr>
   <tr>
-    <td>Alias</td>
-    <td>clip(startOffset, endOffset, consume)</td>
+    <td>Preset</td>
+    <td>clip()<br>trim()</td>
+    <td align="center">None</td>
+    <td >Removes data after the current byte position and returns data. <br><b>Note:</b> Errors on strict mode</td>
   </tr>
   <tr>
     <td>Name</td>
@@ -507,7 +509,7 @@ Common functions for setup, movement, manipulation and math shared by both.
   <tr>
     <td>Name</td>
     <td>xorThis(<b>xorKey</b>, length, consume)
-    <td align="center"><b>Byte value, string, Uint8Array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for Uint8Array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td align="center"><b>Byte value, string, Uint8Array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
     <td>XOR data <b>Note:</b> Will loop if operation length is longer than supplied key.</td>
   </tr>
   <tr>
@@ -519,31 +521,31 @@ Common functions for setup, movement, manipulation and math shared by both.
   <tr>
     <td>Name</td>
     <td>orThis(<b>orKey</b>, length, consume)
-    <td align="center"><b>Byte value, string, Uint8Array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for Uint8Array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td align="center"><b>Byte value, string, Uint8Array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
     <td>OR data <b>Note:</b> Will loop if operation length is longer than supplied key.</td>
   </tr>
   <tr>
     <td>Name</td>
     <td>and(<b>andKey</b>, startOffset, endOffset, consume)
-    <td align="center"><b>Byte value, string, Uint8Array or Buffer</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
     <td >AND data <b>Note:</b> Will loop if operation length is longer than supplied key.</td>
   </tr>
   <tr>
     <td>Name</td>
     <td>andThis(<b>andKey</b>, length, consume)
-    <td align="center"><b>Byte value, string, Uint8Array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for Uint8Array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
     <td>AND data <b>Note:</b> Will loop if operation length is longer than supplied key.</td>
   </tr>
   <tr>
     <td>Name</td>
-    <td>add(<b>shiftValue</b>, startOffset, endOffset, consume)
-    <td align="center"><b>Value</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
-    <td >Add value to data (per byte)</td>
+    <td>add(<b>addKey</b>, startOffset, endOffset, consume)
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td >Add value to data (per byte). <b>Note:</b> Will loop if operation length is longer than supplied key.</td>
   </tr>
   <tr>
     <td>Name</td>
-    <td>addThis(<b>shiftValue</b>, length, consume)
-    <td align="center"><b>Value</b>, length of bytes starting at current byte (default 1), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td>addThis(<b>addKey</b>, length, consume)
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
     <td>Add value to data (per byte)</td>
   </tr>
   <tr>
@@ -560,26 +562,26 @@ Common functions for setup, movement, manipulation and math shared by both.
   </tr>
   <tr>
     <td>Name</td>
-    <td>lShift(<b>shiftValue</b>, startOffset, endOffset, consume)
-    <td align="center"><b>Value</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
-    <td >Left shift data (per byte)</td>
+    <td>lShift(<b>shiftKey</b>, startOffset, endOffset, consume)
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td >Left shift data (per byte). <b>Note:</b> Will loop if operation length is longer than supplied key.</td>
   </tr>
   <tr>
     <td>Name</td>
-    <td>lShiftThis(<b>shiftValue</b>, length, consume)
-    <td align="center"><b>Value</b>, length of bytes starting at current byte (default 1), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td>lShiftThis(<b>shiftKey</b>, length, consume)
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
     <td>Left shift data (per byte)</td>
   </tr>
   <tr>
     <td>Name</td>
-    <td>rShift(<b>shiftValue</b>, startOffset, endOffset, consume)
-    <td align="center"><b>Value</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
-    <td >Right shift data (per byte)</td>
+    <td>rShift(<b>shiftKey</b>, startOffset, endOffset, consume)
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, byte position to start (default current position), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td >Right shift data (per byte). <b>Note:</b> Will loop if operation length is longer than supplied key.</td>
   </tr>
   <tr>
     <td>Name</td>
-    <td>rShiftThis(<b>shiftValue</b>, length, consume)
-    <td align="center"><b>Value</b>, length of bytes starting at current byte (default 1), byte position to end (default end of data), move byte position to after operation (default false)</td>
+    <td>rShiftThis(<b>shiftKey</b>, length, consume)
+    <td align="center"><b>Byte value, string, number array or Buffer</b>, length of bytes starting at current byte (repeats when longer, default 1 byte for byte value, string length or end of data for string, array length or end of data for array or Buffer), byte position to end (default end of data), move byte position to after operation (default false)</td>
     <td>Right shift data (per byte)</td>
   </tr>
 </tbody>

package/lib/cjs/src/common.js

@@ -112,9 +112,11 @@ function remove(_this, startOffset, endOffset, consume, remove, fillValue) {
     if (consume == true) {
         if (remove != true) {
             _this.offset = new_offset;
+            _this.bitoffset = 0;
         }
         else {
             _this.offset = new_start;
+            _this.bitoffset = 0;
         }
     }
     return data_removed;
@@ -170,6 +172,7 @@ function addData(_this, data, consume, offset, repalce) {
     }
     if (consume) {
         _this.offset = needed_size;
+        _this.bitoffset = 0;
     }
 }
 exports.addData = addData;
@@ -356,7 +359,7 @@ function hexDump(_this, options) {
     console.log(rows.join("\n"));
 }
 exports.hexDump = hexDump;
-function AND(_this, xor_key, start, end, consume) {
+function AND(_this, and_key, start, end, consume) {
     const input = _this.data;
     if ((end || 0) > _this.size) {
         if (_this.strict == false) {
@@ -367,27 +370,29 @@ function AND(_this, xor_key, start, end, consume) {
             throw new Error("\x1b[33m[Strict mode]\x1b[0m: End offset outside of data: endOffset" + (end || 0) + " of " + _this.size);
         }
     }
-    if (typeof xor_key == "number") {
+    if (typeof and_key == "number") {
         for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
-            input[i] = input[i] & (xor_key & 0xff);
+            input[i] = input[i] & (and_key & 0xff);
             if (consume) {
                 _this.offset = i;
+                _this.bitoffset = 0;
             }
         }
     }
     else {
-        if (_this.isBufferOrUint8Array(xor_key)) {
+        if (_this.isBufferOrUint8Array(and_key)) {
             let number = -1;
             for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
-                if (number != xor_key.length - 1) {
+                if (number != and_key.length - 1) {
                     number = number + 1;
                 }
                 else {
                     number = 0;
                 }
-                input[i] = input[i] & xor_key[number];
+                input[i] = input[i] & and_key[number];
                 if (consume) {
                     _this.offset = i;
+                    _this.bitoffset = 0;
                 }
             }
         }
@@ -397,7 +402,7 @@ function AND(_this, xor_key, start, end, consume) {
     }
 }
 exports.AND = AND;
-function OR(_this, xor_key, start, end, consume) {
+function OR(_this, or_key, start, end, consume) {
     const input = _this.data;
     if ((end || 0) > _this.size) {
         if (_this.strict == false) {
@@ -408,27 +413,29 @@ function OR(_this, xor_key, start, end, consume) {
             throw new Error("\x1b[33m[Strict mode]\x1b[0m: End offset outside of data: endOffset" + (end || 0) + " of " + _this.size);
         }
     }
-    if (typeof xor_key == "number") {
+    if (typeof or_key == "number") {
         for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
-            input[i] = input[i] | (xor_key & 0xff);
+            input[i] = input[i] | (or_key & 0xff);
             if (consume) {
                 _this.offset = i;
+                _this.bitoffset = 0;
             }
         }
     }
     else {
-        if (_this.isBufferOrUint8Array(xor_key)) {
+        if (_this.isBufferOrUint8Array(or_key)) {
             let number = -1;
             for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
-                if (number != xor_key.length - 1) {
+                if (number != or_key.length - 1) {
                     number = number + 1;
                 }
                 else {
                     number = 0;
                 }
-                input[i] = input[i] | xor_key[number];
+                input[i] = input[i] | or_key[number];
                 if (consume) {
                     _this.offset = i;
+                    _this.bitoffset = 0;
                 }
             }
         }
@@ -454,6 +461,7 @@ function XOR(_this, xor_key, start, end, consume) {
             input[i] = input[i] ^ (xor_key & 0xff);
             if (consume) {
                 _this.offset = i;
+                _this.bitoffset = 0;
             }
         }
     }
@@ -470,6 +478,7 @@ function XOR(_this, xor_key, start, end, consume) {
                 input[i] = input[i] ^ xor_key[number];
                 if (consume) {
                     _this.offset = i;
+                    _this.bitoffset = 0;
                 }
             }
         }
@@ -493,11 +502,13 @@ function NOT(_this, start, end, consume) {
         _this.data[i] = ~_this.data[i];
         if (consume) {
             _this.offset = i;
+            _this.bitoffset = 0;
         }
     }
 }
 exports.NOT = NOT;
-function LSHIFT(_this, value, start, end, consume) {
+function LSHIFT(_this, shift_key, start, end, consume) {
+    const input = _this.data;
     if ((end || 0) > _this.size) {
         if (_this.strict == false) {
             _this.extendArray((end || 0) - _this.size);
@@ -507,15 +518,40 @@ function LSHIFT(_this, value, start, end, consume) {
             throw new Error("\x1b[33m[Strict mode]\x1b[0m: End offset outside of data: endOffset" + (end || 0) + " of " + _this.size);
         }
     }
-    for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
-        _this.data[i] = _this.data[i] << value;
-        if (consume) {
-            _this.offset = i;
+    if (typeof shift_key == "number") {
+        for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
+            input[i] = input[i] << shift_key;
+            if (consume) {
+                _this.offset = i;
+                _this.bitoffset = 0;
+            }
+        }
+    }
+    else {
+        if (_this.isBufferOrUint8Array(shift_key)) {
+            let number = -1;
+            for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
+                if (number != shift_key.length - 1) {
+                    number = number + 1;
+                }
+                else {
+                    number = 0;
+                }
+                input[i] = input[i] << shift_key[number];
+                if (consume) {
+                    _this.offset = i;
+                    _this.bitoffset = 0;
+                }
+            }
+        }
+        else {
+            throw new Error("XOR key must be a byte value, string, Uint8Array or Buffer");
         }
     }
 }
 exports.LSHIFT = LSHIFT;
-function RSHIFT(_this, value, start, end, consume) {
+function RSHIFT(_this, shift_key, start, end, consume) {
+    const input = _this.data;
     if ((end || 0) > _this.size) {
         if (_this.strict == false) {
             _this.extendArray((end || 0) - _this.size);
@@ -525,15 +561,40 @@ function RSHIFT(_this, value, start, end, consume) {
             throw new Error("\x1b[33m[Strict mode]\x1b[0m: End offset outside of data: endOffset" + (end || 0) + " of " + _this.size);
         }
     }
-    for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
-        _this.data[i] = _this.data[i] >> value;
-        if (consume) {
-            _this.offset = i;
+    if (typeof shift_key == "number") {
+        for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
+            input[i] = input[i] >> shift_key;
+            if (consume) {
+                _this.offset = i;
+                _this.bitoffset = 0;
+            }
+        }
+    }
+    else {
+        if (_this.isBufferOrUint8Array(shift_key)) {
+            let number = -1;
+            for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
+                if (number != shift_key.length - 1) {
+                    number = number + 1;
+                }
+                else {
+                    number = 0;
+                }
+                input[i] = input[i] >> shift_key[number];
+                if (consume) {
+                    _this.offset = i;
+                    _this.bitoffset = 0;
+                }
+            }
+        }
+        else {
+            throw new Error("XOR key must be a byte value, string, Uint8Array or Buffer");
         }
     }
 }
 exports.RSHIFT = RSHIFT;
-function ADD(_this, value, start, end, consume) {
+function ADD(_this, add_key, start, end, consume) {
+    const input = _this.data;
     if ((end || 0) > _this.size) {
         if (_this.strict == false) {
             _this.extendArray((end || 0) - _this.size);
@@ -543,10 +604,34 @@ function ADD(_this, value, start, end, consume) {
             throw new Error("\x1b[33m[Strict mode]\x1b[0m: End offset outside of data: endOffset" + (end || 0) + " of " + _this.size);
         }
     }
-    for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
-        _this.data[i] += value;
-        if (consume) {
-            _this.offset = i;
+    if (typeof add_key == "number") {
+        for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
+            input[i] = input[i] + add_key;
+            if (consume) {
+                _this.offset = i;
+                _this.bitoffset = 0;
+            }
+        }
+    }
+    else {
+        if (_this.isBufferOrUint8Array(add_key)) {
+            let number = -1;
+            for (let i = (start || 0); i < Math.min(end || _this.size, _this.size); i++) {
+                if (number != add_key.length - 1) {
+                    number = number + 1;
+                }
+                else {
+                    number = 0;
+                }
+                input[i] = input[i] + add_key[number];
+                if (consume) {
+                    _this.offset = i;
+                    _this.bitoffset = 0;
+                }
+            }
+        }
+        else {
+            throw new Error("XOR key must be a byte value, string, Uint8Array or Buffer");
         }
     }
 }
@@ -675,12 +760,14 @@ function wbyte(_this, value, unsigned) {
     }
     _this.data[_this.offset] = (unsigned == undefined || unsigned == false) ? value : value & 0xFF;
     _this.offset += 1;
+    _this.bitoffset = 0;
 }
 exports.wbyte = wbyte;
 function rbyte(_this, unsigned) {
     _this.check_size(1);
     var read = _this.data[_this.offset];
     _this.offset += 1;
+    _this.bitoffset = 0;
     if (unsigned == true) {
         return read & 0xFF;
     }
@@ -714,6 +801,7 @@ function wint16(_this, value, unsigned, endian) {
         _this.data[_this.offset + 1] = (unsigned == undefined || unsigned == false) ? value : value & 0xff;
     }
     _this.offset += 2;
+    _this.bitoffset = 0;
 }
 exports.wint16 = wint16;
 function rint16(_this, unsigned, endian) {
@@ -726,6 +814,7 @@ function rint16(_this, unsigned, endian) {
         read = (_this.data[_this.offset] << 8) | _this.data[_this.offset + 1];
     }
     _this.offset += 2;
+    _this.bitoffset = 0;
     if (unsigned == undefined || unsigned == false) {
         return read & 0x8000 ? -(0x10000 - read) : read;
     }
@@ -762,6 +851,8 @@ function rhalffloat(_this, endian) {
         // Normalized number
         floatValue = (sign === 0 ? 1 : -1) * Math.pow(2, exponent - 15) * (1 + fraction / 0x0400);
     }
+    _this.offset += 2;
+    _this.bitoffset = 0;
     return floatValue;
 }
 exports.rhalffloat = rhalffloat;
@@ -806,6 +897,7 @@ function whalffloat(_this, value, endian) {
         _this.data[_this.offset + 1] = halfFloatBits & 0xFF;
     }
     _this.offset += 2;
+    _this.bitoffset = 0;
 }
 exports.whalffloat = whalffloat;
 function wint32(_this, value, unsigned, endian) {
@@ -837,6 +929,7 @@ function wint32(_this, value, unsigned, endian) {
         _this.data[_this.offset + 3] = (unsigned == undefined || unsigned == false) ? value : value & 0xFF;
     }
     _this.offset += 4;
+    _this.bitoffset = 0;
 }
 exports.wint32 = wint32;
 function rint32(_this, unsigned, endian) {
@@ -849,6 +942,7 @@ function rint32(_this, unsigned, endian) {
         read = (_this.data[_this.offset] << 24) | (_this.data[_this.offset + 1] << 16) | (_this.data[_this.offset + 2] << 8) | _this.data[_this.offset + 3];
     }
     _this.offset += 4;
+    _this.bitoffset = 0;
     if (unsigned == undefined || unsigned == false) {
         return read;
     }
@@ -879,6 +973,8 @@ function rfloat(_this, endian) {
         // Normalized number
         floatValue = Math.pow(-1, isNegative) * Math.pow(2, exponent - 127) * (1 + fraction / Math.pow(2, 23));
     }
+    _this.offset += 4;
+    _this.bitoffset = 0;
     return floatValue;
 }
 exports.rfloat = rfloat;
@@ -902,6 +998,7 @@ function wfloat(_this, value, endian) {
         shift += 8;
     }
     _this.offset += 4;
+    _this.bitoffset = 0;
 }
 exports.wfloat = wfloat;
 function rint64(_this, unsigned, endian) {
@@ -917,10 +1014,6 @@ function rint64(_this, unsigned, endian) {
             if (value & (BigInt(1) << BigInt(63))) {
                 value -= BigInt(1) << BigInt(64);
             }
-            return value;
-        }
-        else {
-            return value;
         }
     }
     else {
@@ -932,12 +1025,11 @@ function rint64(_this, unsigned, endian) {
             if (value & (BigInt(1) << BigInt(63))) {
                 value -= BigInt(1) << BigInt(64);
             }
-            return value;
-        }
-        else {
-            return value;
         }
     }
+    _this.offset += 8;
+    _this.bitoffset = 0;
+    return value;
 }
 exports.rint64 = rint64;
 function wint64(_this, value, unsigned, endian) {
@@ -992,6 +1084,7 @@ function wint64(_this, value, unsigned, endian) {
         }
     }
     _this.offset += 8;
+    _this.bitoffset = 0;
 }
 exports.wint64 = wint64;
 function wdfloat(_this, value, endian) {
@@ -1015,6 +1108,7 @@ function wdfloat(_this, value, endian) {
         }
     }
     _this.offset += 8;
+    _this.bitoffset = 0;
 }
 exports.wdfloat = wdfloat;
 function rdfloat(_this, endian) {
@@ -1045,6 +1139,8 @@ function rdfloat(_this, endian) {
         // Normalized number
         floatValue = (sign == 0n ? 1 : -1) * Math.pow(2, exponent) * (1 + fraction);
     }
+    _this.offset += 8;
+    _this.bitoffset = 0;
     return floatValue;
 }
 exports.rdfloat = rdfloat;
@@ -1225,6 +1321,7 @@ function wstring(_this, string, options) {
             }
         }
         _this.offset += totalLength;
+        _this.bitoffset = 0;
     }
     else if (stringType == 'pascal' || stringType == 'wide-pascal') {
         if (encoding == undefined) {
@@ -1290,6 +1387,7 @@ function wstring(_this, string, options) {
             }
         }
         _this.offset += totalLength;
+        _this.bitoffset = 0;
     }
     else {
         throw new Error('Unsupported string type: ' + stringType);