/
variant.ts
1043 lines (897 loc) · 32.8 KB
/
variant.ts
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
/**
* @module node-opcua-variant
*/
import * as _ from "underscore";
import { assert } from "node-opcua-assert";
import {
coerceInt64,
coerceUInt64,
decodeUInt32,
decodeUInt8,
encodeUInt32,
encodeUInt8,
isValidBoolean,
isValidByteString,
isValidInt16,
isValidInt32,
isValidInt64,
isValidInt8,
isValidNodeId,
isValidUInt16,
isValidUInt32,
isValidUInt64,
isValidUInt8
} from "node-opcua-basic-types";
import { LocalizedText, QualifiedName } from "node-opcua-data-model";
import {
BaseUAObject,
buildStructuredType,
findBuiltInType,
initialize_field,
initialize_field_array,
registerSpecialVariantEncoder,
StructuredTypeSchema
} from "node-opcua-factory";
import * as utils from "node-opcua-utils";
import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
import { ExtensionObject } from "node-opcua-extension-object";
import { _enumerationDataType, DataType } from "./DataType_enum";
import { _enumerationVariantArrayType, VariantArrayType } from "./VariantArrayType_enum";
// tslint:disable:no-bitwise
const schemaVariant: StructuredTypeSchema = buildStructuredType({
baseType: "BaseUAObject",
fields: [{
defaultValue: () => DataType.Null,
documentation: "the variant type.",
fieldType: "DataType",
name: "dataType",
}, {
defaultValue: VariantArrayType.Scalar,
fieldType: "VariantArrayType",
name: "arrayType",
}, {
defaultValue: null,
fieldType: "Any",
name: "value",
}, {
defaultValue: null,
documentation: "the matrix dimensions",
fieldType: "UInt32",
isArray: true,
name: "dimensions",
}],
name: "Variant",
});
function _coerceVariant(variantLike: any): Variant {
const value = (variantLike instanceof Variant) ? variantLike : new Variant(variantLike);
assert(value instanceof Variant);
return value;
}
export interface VariantOptions {
dataType?: DataType | string;
arrayType?: VariantArrayType | string;
value?: any;
dimensions?: number[] | null;
}
export class Variant extends BaseUAObject {
public static schema = schemaVariant;
public static coerce = _coerceVariant;
public dataType: DataType;
public arrayType: VariantArrayType;
public value: any;
public dimensions: number[] | null;
constructor(options?: VariantOptions) {
super();
options = constructHook(options) as any;
options = options ? options : {};
this.dataType = DataType.Null;
this.arrayType = VariantArrayType.Scalar;
const schema = schemaVariant;
/**
* the variant type.
* @property dataType
* @type {DataType}
* @default 0
*/
this.setDataType(initialize_field(schema.fields[0], options.dataType));
/**
* @property arrayType
* @type {VariantArrayType}
* @default 0
*/
this.setArrayType(initialize_field(schema.fields[1], options.arrayType));
/**
* @property value
* @default null
*/
this.value = initialize_field(schema.fields[2], options.value);
/**
* the matrix dimensions
* @property dimensions
* @type {UInt32[]}
* @default null
*/
this.dimensions = initialize_field_array(
schema.fields[3],
options.dimensions
);
if ( options.dataType === DataType.ExtensionObject) {
if (this.arrayType === VariantArrayType.Scalar) {
/* istanbul ignore next */
if (this.value && !(this.value instanceof ExtensionObject)) {
throw new Error("A variant with DataType.ExtensionObject must have a ExtensionObject value");
}
} else {
for (const e of this.value) {
/* istanbul ignore next */
if (e && !(e instanceof ExtensionObject)) {
throw new Error("A variant with DataType.ExtensionObject must have a ExtensionObject value");
}
}
}
}
}
// Define Enumeration setters
public setDataType(value: any) {
const coercedValue = _enumerationDataType.get(value);
/* istanbul ignore next */
if (coercedValue === undefined || coercedValue === null) {
throw new Error("value cannot be coerced to DataType: " + value);
}
this.dataType = coercedValue.value as DataType;
}
public setArrayType(value: any) {
const coercedValue = _enumerationVariantArrayType.get(value);
/* istanbul ignore next */
if (coercedValue === undefined || coercedValue === null) {
throw new Error("value cannot be coerced to VariantArrayType: " + value);
}
this.arrayType = coercedValue.value as VariantArrayType;
}
public encode(stream: OutputBinaryStream) {
encodeVariant(this, stream);
}
public decode(stream: BinaryStream) {
internalDecodeVariant(this, stream);
}
public decodeDebug(stream: BinaryStream, options: any) {
decodeDebugVariant(this, stream, options);
}
public toString(): string {
return variantToString(this);
}
public isValid(): boolean {
return isValidVariant(this.arrayType, this.dataType, this.value, this.dimensions);
}
public clone(): Variant {
return new Variant(this);
}
}
Variant.prototype.schema = schemaVariant;
export type VariantLike = VariantOptions | Variant;
function variantToString(self: Variant, options?: any) {
function toString(value: any): string {
switch (self.dataType) {
case DataType.ByteString:
return value ? "0x" + value.toString("hex") : "<null>";
case DataType.Boolean:
return value.toString();
case DataType.DateTime:
return value ? (value.toISOString ? value.toISOString() : value.toString()) : "<null>";
default:
return value ? value.toString(options) : "0";
}
}
function f(value: any) {
if (value === undefined || (value === null && typeof value === "object")) {
return "<null>";
}
return toString(value);
}
let data = VariantArrayType[self.arrayType];
if (self.dimensions && self.dimensions.length > 0) {
data += "[ " + self.dimensions.join(",") + " ]";
}
data += "<" + DataType[self.dataType] + ">";
if (self.arrayType === VariantArrayType.Scalar) {
data += ", value: " + f(self.value);
} else if ((self.arrayType === VariantArrayType.Array) || (self.arrayType === VariantArrayType.Matrix)) {
if (!self.value) {
data += ", null";
} else {
const a = [];
assert(_.isArray(self.value) || (self.value.buffer instanceof ArrayBuffer));
for (let i = 0; i < Math.min(10, self.value.length); i++) {
a[i] = self.value[i];
}
if (self.value.length > 10) {
a.push("...");
}
data += ", l= " + self.value.length + ", value=[" + a.map(f).join(",") + "]";
}
}
return "Variant(" + data + ")";
}
/***
* @private
*/
export const VARIANT_ARRAY_MASK = 0x80;
/***
* @private
*/
export const VARIANT_ARRAY_DIMENSIONS_MASK = 0x40;
/***
* @private
*/
export const VARIANT_TYPE_MASK = 0x3f;
/***
* @private
*/
export function encodeVariant(variant: Variant, stream: OutputBinaryStream): void {
let encodingByte = variant.dataType;
if (variant.arrayType === VariantArrayType.Array || variant.arrayType === VariantArrayType.Matrix) {
encodingByte |= VARIANT_ARRAY_MASK;
}
if (variant.dimensions) {
assert(variant.arrayType === VariantArrayType.Matrix);
assert(variant.dimensions.length >= 1);
encodingByte |= VARIANT_ARRAY_DIMENSIONS_MASK;
}
encodeUInt8(encodingByte, stream);
if (variant.arrayType === VariantArrayType.Array || variant.arrayType === VariantArrayType.Matrix) {
encodeVariantArray(variant.dataType, stream, variant.value);
} else {
const encode = get_encoder(variant.dataType);
encode(variant.value, stream);
}
if ((encodingByte & VARIANT_ARRAY_DIMENSIONS_MASK) === VARIANT_ARRAY_DIMENSIONS_MASK && variant.dimensions) {
encodeDimension(variant.dimensions, stream);
}
}
/***
* @private
*/
function decodeDebugVariant(self: Variant, stream: BinaryStream, options: any): void {
const tracer = options.tracer;
const encodingByte = decodeUInt8(stream);
const isArray = ((encodingByte & VARIANT_ARRAY_MASK) === VARIANT_ARRAY_MASK);
const hasDimension = ((encodingByte & VARIANT_ARRAY_DIMENSIONS_MASK) === VARIANT_ARRAY_DIMENSIONS_MASK);
self.dataType = (encodingByte & VARIANT_TYPE_MASK) as DataType;
tracer.dump("dataType: ", self.dataType);
tracer.dump("isArray: ", isArray ? "true" : "false");
tracer.dump("dimension: ", hasDimension);
const decode = findBuiltInType(DataType[self.dataType]).decode;
/* istanbul ignore next */
if (!decode) {
throw new Error("Variant.decode : cannot find decoder for type " + DataType[self.dataType]);
}
const cursorBefore = stream.length;
if (isArray) {
self.arrayType = hasDimension ? VariantArrayType.Matrix : VariantArrayType.Array;
_decodeVariantArrayDebug(stream, decode, tracer, self.dataType);
} else {
self.arrayType = VariantArrayType.Scalar;
self.value = decode(stream);
tracer.trace("member", "Variant", self.value, cursorBefore, stream.length, DataType[self.dataType]);
}
// ArrayDimensions
// Int32[]
// The length of each dimension.
// This field is only present if the array dimensions flag is set in the encoding mask.
// The lower rank dimensions appear first in the array.
// All dimensions shall be specified and shall be greater than zero.
// If ArrayDimensions are inconsistent with the ArrayLength then the decoder shall
// stop and raise a BadDecodingError.
if (hasDimension) {
self.dimensions = decodeDimension(stream);
const verification = calculate_product(self.dimensions);
}
}
function internalDecodeVariant(self: Variant, stream: BinaryStream) {
const encodingByte = decodeUInt8(stream);
const isArray: boolean = ((encodingByte & VARIANT_ARRAY_MASK) === VARIANT_ARRAY_MASK);
const hasDimension: boolean = ((encodingByte & VARIANT_ARRAY_DIMENSIONS_MASK) === VARIANT_ARRAY_DIMENSIONS_MASK);
self.dataType = (encodingByte & VARIANT_TYPE_MASK) as DataType;
if (isArray) {
self.arrayType = hasDimension ? VariantArrayType.Matrix : VariantArrayType.Array;
self.value = decodeVariantArray(self.dataType, stream);
} else {
self.arrayType = VariantArrayType.Scalar;
const decode = get_decoder(self.dataType);
self.value = decode(stream);
}
if (hasDimension) {
self.dimensions = decodeDimension(stream);
const verification = calculate_product(self.dimensions);
/* istanbul ignore next */
if (verification !== self.value.length) {
throw new Error("BadDecodingError");
}
}
}
/***
* @private
*/
export function decodeVariant(stream: BinaryStream): Variant {
const value = new Variant({});
value.decode(stream);
return value;
}
function constructHook(options: any): any {
options = options || {};
let isArrayTypeUnspecified = (options.arrayType === undefined);
if (options.constructor.name === "Variant") {
const opts = {
arrayType: options.arrayType,
dataType: options.dataType,
dimensions: options.dimensions,
value: options.value,
};
if (opts.dataType === DataType.ExtensionObject) {
if (opts.arrayType === VariantArrayType.Scalar) {
if (opts.value && opts.value.constructor) {
opts.value = new opts.value.constructor(opts.value);
}
} else {
opts.value = opts.value.map( (e: any) => {
if (e && e.constructor) {
return new e.constructor(e);
}
return null;
});
}
} else if (opts.arrayType !== VariantArrayType.Scalar) {
opts.value = coerceVariantArray(options.dataType, options.value);
}
return opts;
}
assert(options);
options.dataType = options.dataType || DataType.Null;
// dataType could be a string
if (typeof options.dataType === "string") {
const d = findBuiltInType(options.dataType);
/* istanbul ignore next */
if (!d) {
throw new Error("Cannot find data type buildIn");
}
const t = _enumerationDataType.get(d.name);
/* istanbul ignore next */
if (t === null) {
throw new Error("DataType: invalid " + options.dataType);
}
options.dataType = t.value as DataType;
}
// array type could be a string
if (typeof options.arrayType === "string") {
const at = VariantArrayType[options.arrayType];
/* istanbul ignore next */
if (utils.isNullOrUndefined(at)) {
throw new Error("ArrayType: invalid " + options.arrayType);
}
options.arrayType = at;
}
if (isArrayTypeUnspecified && _.isArray(options.value)) {
// when using UInt64 ou Int64 arrayType must be specified , as automatic detection cannot be made
/* istanbul ignore next */
if ((options.dataType === DataType.UInt64 || options.dataType === DataType.Int64)) {
// we do nothing here ....
throw new Error("Variant#constructor : when using UInt64 ou Int64" +
" arrayType must be specified , as automatic detection cannot be made");
} else {
options.arrayType = VariantArrayType.Array;
isArrayTypeUnspecified = false;
}
}
if (options.arrayType !== VariantArrayType.Scalar && !isArrayTypeUnspecified) {
assert(options.arrayType === VariantArrayType.Array || options.arrayType === VariantArrayType.Matrix);
/* istanbul ignore else */
if (options.arrayType === VariantArrayType.Array) {
options.value = options.value || [];
const value1 = coerceVariantArray(options.dataType, options.value);
assert(value1 !== options.value);
options.value = value1;
} else {
assert(options.arrayType === VariantArrayType.Matrix);
options.value = options.value || [];
options.value = coerceVariantArray(options.dataType, options.value);
/* istanbul ignore next */
if (!options.dimensions) {
throw new Error("Matrix Variant : missing dimensions");
}
/* istanbul ignore next */
if (options.value.length !== calculate_product(options.dimensions)) {
throw new Error("Matrix Variant : invalid value size");
}
}
} else {
assert(options.arrayType === VariantArrayType.Scalar || options.arrayType === undefined);
options.arrayType = VariantArrayType.Scalar;
const tmp = options.value;
// scalar
options.value = coerceVariantType(options.dataType, options.value);
/* istanbul ignore next */
if (!isValidVariant(options.arrayType, options.dataType, options.value, null)) {
throw new Error("Invalid variant arrayType: " + options.arrayType.toString() +
" dataType: " + options.dataType.toString() + " value:" + options.value);
}
}
if (options.dimensions) {
assert(options.arrayType === VariantArrayType.Matrix, "dimension can only provided if variant is a matrix");
}
return options;
}
function calculate_product(array: number[] | null): number {
/* istanbul ignore next */
if (!array) {
return 0;
}
return array.reduce((n: number, p: number) => n * p, 1);
}
function get_encoder(dataType: DataType) {
const dataTypeAsString = DataType[dataType];
const encode = findBuiltInType(dataTypeAsString).encode;
/* istanbul ignore next */
if (!encode) {
throw new Error("Cannot find encode function for dataType " + dataTypeAsString);
}
return encode;
}
function get_decoder(dataType: DataType) {
const dataTypeAsString = DataType[dataType];
const decode = findBuiltInType(dataTypeAsString).decode;
/* istanbul ignore next */
if (!decode) {
throw new Error("Variant.decode : cannot find decoder for type " + dataTypeAsString);
}
return decode;
}
const displayWarning = true;
/***
* @private
*/
export type BufferedArray2 =
Float32Array
| Float64Array
| Int8Array
| Int16Array
| Int32Array
| Uint8Array
| Uint16Array
| Uint32Array ;
interface BufferedArrayConstructor {
BYTES_PER_ELEMENT: number;
new(buffer: any): any;
}
function convertTo(dataType: DataType, arrayTypeConstructor: BufferedArrayConstructor | null, value: any) {
if (arrayTypeConstructor && value instanceof arrayTypeConstructor) {
const newArray = new value.constructor(value.length); // deep copy
/* istanbul ignore if */
if (newArray instanceof Buffer) {
// required for nodejs 4.x
value.copy(newArray);
} else {
newArray.set(value);
}
return newArray;
}
const coerceFunc = coerceVariantType.bind(null, dataType);
const n = value.length;
const newArr: any = arrayTypeConstructor ? new arrayTypeConstructor(n) : new Array(n);
for (let i = 0; i < n; i++) {
newArr[i] = coerceFunc(value[i]);
}
// istanbul ignore next
if (arrayTypeConstructor && displayWarning && n > 10) {
// tslint:disable-next-line:no-console
console.log("Warning ! an array containing " + DataType[dataType] +
" elements has been provided as a generic array. ");
// tslint:disable-next-line:no-console
console.log(" This is inefficient as every array value will " +
"have to be coerced and verified against the expected type");
// tslint:disable-next-line:no-console
console.log(" It is highly recommended that you use a " +
" typed array ", arrayTypeConstructor.constructor.name, " instead");
}
return newArr;
}
interface DataTypeHelper {
coerce: (value: any) => any;
encode: (stream: OutputBinaryStream, value: any) => void;
decode: (stream: BinaryStream) => any;
}
const typedArrayHelpers: { [key: string]: DataTypeHelper } = {};
function _getHelper(dataType: DataType) {
return typedArrayHelpers[DataType[dataType]];
}
function coerceVariantArray(dataType: DataType, value: any) {
const helper = _getHelper(dataType);
if (helper) {
return helper.coerce(value);
} else {
return convertTo(dataType, null, value);
}
}
function encodeTypedArray(arrayTypeConstructor: BufferedArrayConstructor, stream: OutputBinaryStream, value: any) {
assert(value instanceof arrayTypeConstructor);
assert(value.buffer instanceof ArrayBuffer);
encodeUInt32(value.length, stream);
stream.writeArrayBuffer(value.buffer, value.byteOffset, value.byteLength);
}
function encodeGeneralArray(dataType: DataType, stream: OutputBinaryStream, value: any) {
const arr = value || [];
assert(arr instanceof Array);
assert(_.isFinite(arr.length));
encodeUInt32(arr.length, stream);
const encode = get_encoder(dataType);
let i;
const n = arr.length;
for (i = 0; i < n; i++) {
encode(arr[i], stream);
}
}
function encodeVariantArray(dataType: DataType, stream: OutputBinaryStream, value: any) {
if (value.buffer) {
try {
return _getHelper(dataType).encode(stream, value);
} catch (err) {
/* istanbul ignore next */
// tslint:disable-next-line:no-console
console.log("encodeVariantArray error : DATATYPE", dataType, "\nvalue", value.length);
}
}
return encodeGeneralArray(dataType, stream, value);
}
function decodeTypedArray(arrayTypeConstructor: BufferedArrayConstructor, stream: BinaryStream) {
const length = decodeUInt32(stream);
/* istanbul ignore next */
if (length === 0xFFFFFFFF) {
return null;
}
const byteLength = length * arrayTypeConstructor.BYTES_PER_ELEMENT;
const arr = stream.readArrayBuffer(byteLength);
const value = new arrayTypeConstructor(arr.buffer);
assert(value.length === length);
return value;
}
function decodeGeneralArray(dataType: DataType, stream: BinaryStream) {
const length = decodeUInt32(stream);
/* istanbul ignore next */
if (length === 0xFFFFFFFF) {
return null;
}
const decode = get_decoder(dataType);
const arr = [];
for (let i = 0; i < length; i++) {
arr.push(decode(stream));
}
return arr;
}
function decodeVariantArray(dataType: DataType, stream: BinaryStream) {
const helper = _getHelper(dataType);
if (helper) {
return helper.decode(stream);
} else {
return decodeGeneralArray(dataType, stream);
}
}
function _declareTypeArrayHelper(dataType: DataType, typedArrayConstructor: any) {
typedArrayHelpers[DataType[dataType]] = {
coerce: convertTo.bind(null, dataType, typedArrayConstructor),
decode: decodeTypedArray.bind(null, typedArrayConstructor),
encode: encodeTypedArray.bind(null, typedArrayConstructor),
};
}
_declareTypeArrayHelper(DataType.Float, Float32Array);
_declareTypeArrayHelper(DataType.Double, Float64Array);
_declareTypeArrayHelper(DataType.SByte, Int8Array);
_declareTypeArrayHelper(DataType.Byte, Uint8Array);
_declareTypeArrayHelper(DataType.Int16, Int16Array);
_declareTypeArrayHelper(DataType.Int32, Int32Array);
_declareTypeArrayHelper(DataType.UInt16, Uint16Array);
_declareTypeArrayHelper(DataType.UInt32, Uint32Array);
function _decodeVariantArrayDebug(stream: BinaryStream, decode: any, tracer: any, dataType: DataType) {
let cursorBefore = stream.length;
const length = decodeUInt32(stream);
let i;
let element;
tracer.trace("start_array", "Variant", length, cursorBefore, stream.length);
const n1 = Math.min(10, length);
// display a maximum of 10 elements
for (i = 0; i < n1; i++) {
tracer.trace("start_element", "", i);
cursorBefore = stream.length;
element = decode(stream);
// arr.push(element);
tracer.trace("member", "Variant", element, cursorBefore, stream.length, DataType[dataType]);
tracer.trace("end_element", "", i);
}
// keep reading
if (length >= n1) {
for (i = n1; i < length; i++) {
decode(stream);
}
tracer.trace("start_element", "", n1);
tracer.trace("member", "Variant", "...", cursorBefore, stream.length, DataType[dataType]);
tracer.trace("end_element", "", n1);
}
tracer.trace("end_array", "Variant", stream.length);
}
function decodeDimension(stream: BinaryStream) {
return decodeGeneralArray(DataType.UInt32, stream);
}
function encodeDimension(dimensions: number[], stream: OutputBinaryStream) {
return encodeGeneralArray(DataType.UInt32, stream, dimensions);
}
function isEnumerationItem(value: any): boolean {
return (value instanceof Object && (value.hasOwnProperty("value")) && value.hasOwnProperty("key"));
}
export function coerceVariantType(dataType: DataType, value: any): any {
/* eslint max-statements: ["error",1000], complexity: ["error",1000]*/
if (value === undefined) {
value = null;
}
if (isEnumerationItem(value)) {
// OPCUA Specification 1.0.3 5.8.2 encoding rules for various dataType:
// [...]Enumeration are always encoded as Int32 on the wire [...]
/* istanbul ignore next */
if (dataType !== DataType.Int32) {
throw new Error("expecting DataType.Int32 for enumeration values ;" +
" got DataType." + dataType.toString() + " instead");
}
}
switch (dataType) {
case DataType.Null:
value = null;
break;
case DataType.LocalizedText:
if (!value || !value.schema || value.schema !== LocalizedText.schema) {
value = new LocalizedText(value);
}
break;
case DataType.QualifiedName:
if (!value || !value.schema || value.schema !== QualifiedName.schema) {
value = new QualifiedName(value);
}
break;
case DataType.Int16:
case DataType.UInt16:
case DataType.Int32:
case DataType.UInt32:
assert(value !== undefined);
if (isEnumerationItem(value)) {
// value is a enumeration of some sort
value = value.value;
} else {
value = parseInt(value, 10);
}
/* istanbul ignore next */
if (!_.isFinite(value)) {
// xx console.log("xxx ", value, ttt);
throw new Error("expecting a number " + value);
}
break;
case DataType.UInt64:
value = coerceUInt64(value);
break;
case DataType.Int64:
value = coerceInt64(value);
break;
case DataType.ExtensionObject:
break;
case DataType.DateTime:
assert(value === null || value instanceof Date);
break;
case DataType.String:
assert(typeof value === "string" || value === null);
break;
case DataType.ByteString:
value = (typeof value === "string") ? Buffer.from(value) : value;
// istanbul ignore next
if (!(value === null || value instanceof Buffer)) {
throw new Error("ByteString should be null or a Buffer");
}
assert(value === null || value instanceof Buffer);
break;
default:
assert(dataType !== undefined && dataType !== null, "Invalid DataType");
break;
case DataType.NodeId:
break;
}
return value;
}
function isValidScalarVariant(dataType: DataType, value: any): boolean {
assert(value === null
|| DataType.Int64 === dataType
|| DataType.ByteString === dataType
|| DataType.UInt64 === dataType
|| !(value instanceof Array));
assert(value === null || !(value instanceof Int32Array));
assert(value === null || !(value instanceof Uint32Array));
switch (dataType) {
case DataType.NodeId:
return isValidNodeId(value);
case DataType.String:
return typeof value === "string" || utils.isNullOrUndefined(value);
case DataType.Int64:
return isValidInt64(value);
case DataType.UInt64:
return isValidUInt64(value);
case DataType.UInt32:
return isValidUInt32(value);
case DataType.Int32:
return isValidInt32(value);
case DataType.UInt16:
return isValidUInt16(value);
case DataType.Int16:
return isValidInt16(value);
case DataType.Byte:
return isValidUInt8(value);
case DataType.SByte:
return isValidInt8(value);
case DataType.Boolean:
return isValidBoolean(value);
case DataType.ByteString:
return isValidByteString(value);
default:
return true;
}
}
function isValidArrayVariant(dataType: DataType, value: any): boolean {
if (dataType === DataType.Float && value instanceof Float32Array) {
return true;
} else if (dataType === DataType.Double && value instanceof Float64Array) {
return true;
} else if (dataType === DataType.SByte && (value instanceof Int8Array)) {
return true;
} else if (dataType === DataType.Byte && (value instanceof Buffer || value instanceof Uint8Array)) {
return true;
} else if (dataType === DataType.Int16 && value instanceof Int16Array) {
return true;
} else if (dataType === DataType.Int32 && value instanceof Int32Array) {
return true;
} else if (dataType === DataType.UInt16 && value instanceof Uint16Array) {
return true;
} else if (dataType === DataType.UInt32 && value instanceof Uint32Array) {
return true;
}
// array values can be store in Buffer, Float32Array
assert(_.isArray(value));
for (const valueItem of value) {
if (!isValidScalarVariant(dataType, valueItem)) {
return false;
}
}
return true;
}
/*istanbul ignore next*/
function isValidMatrixVariant(dataType: DataType, value: any, dimensions: number[]| null) {
if (!dimensions) {
return false;
}
if (!isValidArrayVariant(dataType, value)) {
return false;
}
return true;
}
export function isValidVariant(
arrayType: VariantArrayType,
dataType: DataType,
value: any, dimensions?: number[] | null): boolean {
switch (arrayType) {
case VariantArrayType.Scalar:
return isValidScalarVariant(dataType, value);
case VariantArrayType.Array:
return isValidArrayVariant(dataType, value);
default:
assert(arrayType === VariantArrayType.Matrix);
return isValidMatrixVariant(dataType, value, dimensions!);
}
}
export function buildVariantArray(dataType: DataType, nbElements: number, defaultValue: any) {
let value;
switch (dataType) {
case DataType.Float:
value = new Float32Array(nbElements);
break;
case DataType.Double:
value = new Float64Array(nbElements);
break;
case DataType.UInt32:
value = new Uint32Array(nbElements);
break;
case DataType.Int32:
value = new Int32Array(nbElements);
break;
case DataType.UInt16:
value = new Uint16Array(nbElements);
break;
case DataType.Int16:
value = new Int16Array(nbElements);
break;
case DataType.Byte:
value = new Uint8Array(nbElements);
break;
case DataType.SByte:
value = new Int8Array(nbElements);
break;
default:
value = new Array(nbElements);
}
if (defaultValue !== undefined) {
for (let i = 0; i < nbElements; i++) {
value[i] = defaultValue;
}
}
return value;
}
// old version of nodejs do not provide a Buffer#equals test
const oldNodeVersion = (process.versions.node && process.versions.node.substring(0, 1) === "0");
function __check_same_array(arr1: any, arr2: any) {
if (!arr1 || !arr2) {
return !arr1 && !arr2;
}
if (arr1.length !== arr2.length) {
return false;
}
if (arr1.length === 0 && 0 === arr2.length) {
return true;
}
if (!oldNodeVersion && arr1.buffer) {
// v1 and v2 are TypedArray (such as Int32Array...)
// this is the most efficient way to compare 2 buffers but it doesn't work with node <= 0.12
assert(arr2.buffer);
// compare byte by byte
const b1 = Buffer.from(arr1.buffer, arr1.byteOffset, arr1.byteLength);
const b2 = Buffer.from(arr2.buffer, arr2.byteOffset, arr2.byteLength);
return b1.equals(b2);
}
const n = arr1.length;
for (let i = 0; i < n; i++) {
if (!_.isEqual(arr1[i], arr2[i])) {
return false;
}
}
return true;
}
/***