@microtronics/studio-cli 0.3.5 → 0.4.1

package/out/dde/fileGenerators/xml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../../../src/dde/fileGenerators/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,OAAO,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;AAOlC,MAAM,WAAW,QAAQ;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAGD,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,UAwLjD;AAgBD;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,OAoB5E"}

package/out/dde/fileGenerators/xml.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateXMLFromMap = generateXMLFromMap;
+exports.patchValueWithArrayInfo = patchValueWithArrayInfo;
+const coreDefinitions_1 = require("../coreDefinitions");
+var TransferDirection = coreDefinitions_1.DDE_Core.TransferDirection;
+var parseXMLValueWithRelation = coreDefinitions_1.DDE_Core.parseXMLValueWithRelation;
+var parseXMLBitmask = coreDefinitions_1.DDE_Core.parseXMLBitmask;
+var parseXMLDefaultValue = coreDefinitions_1.DDE_Core.parseXMLDefaultValue;
+var fieldTypeDefinitions = coreDefinitions_1.DDE_Core.fieldTypeDefinitions;
+// eslint-disable-next-line sonarjs/cognitive-complexity
+function generateXMLFromMap(ddeMap) {
+    const indent = '';
+    const xml_ = [];
+    function xml(s, condition = true) {
+        if (!condition) {
+            return;
+        }
+        if (Array.isArray(s)) {
+            xml_.push.apply(xml_, s);
+            return;
+        }
+        xml_.push(indent + s);
+    }
+    function xmlAttr(attribute, val) {
+        if (attribute === 'mergeofs') {
+            return;
+        }
+        xml(`${attribute}=${val}`);
+    }
+    xml('// DDE STRUCTURE created by Microtronics Studio');
+    const rm2mraw = 'source=rm2mraw';
+    for (const [containerName, containerDefinition] of Object.entries(ddeMap.containers)) {
+        if (containerName.startsWith('histdata') &&
+            containerDefinition.transferDirection !== TransferDirection.deviceOnly) {
+            xml('<split>');
+            xml(rm2mraw);
+            xml('target=' + containerName);
+            xml('key=0' + containerName.substr(-1, 1));
+            xml('</split>');
+        }
+        xml('<table>');
+        xmlAttr('name', containerName); // output container-name as very first line (mandatory!)
+        xmlAttr('alias', containerDefinition.title);
+        xmlAttr('title', containerDefinition.title.replace('_', ' '));
+        const containerAttributes = {};
+        // enforce container's direction - 'up','up+','down','down+','both','both+'
+        // .upload/.download are reserved container attributes (already claimed during parsing)
+        if ([
+            TransferDirection.none,
+            TransferDirection.backendOnly,
+            TransferDirection.deviceOnly,
+            TransferDirection.down,
+            TransferDirection.downPlus
+        ].includes(containerDefinition.transferDirection)) {
+            // containerAttributes['upload'] = '0';
+            xmlAttr('upload', '0');
+        }
+        if ([
+            TransferDirection.none,
+            TransferDirection.backendOnly,
+            TransferDirection.deviceOnly,
+            TransferDirection.up,
+            TransferDirection.upPlus
+        ].includes(containerDefinition.transferDirection)) {
+            // containerAttributes['download'] = '0';
+            xmlAttr('download', '0');
+        }
+        // set edit=99 on upward containers to reject write access via API
+        if ([TransferDirection.up, TransferDirection.upPlus].includes(containerDefinition.transferDirection)) {
+            // containerAttributes['edit'] = '99';
+            xmlAttr('edit', '99');
+        }
+        //insert fields:
+        for (const field of containerDefinition.fields) {
+            if (field.type === 'shadow') {
+                continue;
+            }
+            const patchedField = patchFieldWithArrayInfo(field);
+            const typeDefinition = fieldTypeDefinitions[patchedField.type];
+            // build the field title:
+            let fieldTitle = parseXMLValueWithRelation('title', patchedField, ddeMap) || patchedField.name;
+            // only add the library prefix if the attribute is not referenced
+            if (!fieldTitle.startsWith('%') && patchedField.library) {
+                fieldTitle = `${patchedField.library}: ${fieldTitle}`;
+            }
+            const xmlField = {
+                title: fieldTitle,
+                alias: patchedField.name,
+                index: field.index,
+                ...containerAttributes
+            };
+            xmlField.byteofs = `${patchedField.byteOffset}`;
+            // add xml attributes based on field type
+            for (const [attribute, value] of Object.entries(typeDefinition.xml)) {
+                //@ts-ignore
+                xmlField[attribute] = value;
+            }
+            if (Object.hasOwn(typeDefinition, 'xmlOut')) {
+                typeDefinition.xmlOut(xmlField, patchedField, ddeMap);
+            }
+            // additional attributes from the dde
+            xmlField.units = parseXMLValueWithRelation('unit', patchedField, ddeMap);
+            xmlField.chmode = parseXMLValueWithRelation('channelMode', patchedField, ddeMap);
+            // warn and alarm thresholds
+            xmlField.ialarm_high = parseXMLValueWithRelation('chartAlarmHigh', patchedField, ddeMap);
+            xmlField.ialarm_low = parseXMLValueWithRelation('chartAlarmLow', patchedField, ddeMap);
+            xmlField.iwarn_high = parseXMLValueWithRelation('chartWarningHigh', patchedField, ddeMap);
+            xmlField.iwarn_low = parseXMLValueWithRelation('chartWarningLow', patchedField, ddeMap);
+            xmlField.hysterese = parseXMLValueWithRelation('chartHysteresis', patchedField, ddeMap);
+            xmlField.itrigger = parseXMLValueWithRelation('chartTriggerThreshold', patchedField, ddeMap);
+            xmlField.itriggerus = parseXMLValueWithRelation('chartTriggerRelation', patchedField, ddeMap);
+            xmlField.setpoint = parseXMLValueWithRelation('chartSetPoint', patchedField, ddeMap);
+            xmlField.bitmask = parseXMLBitmask(patchedField);
+            // process field as hex
+            if (patchedField.hex) {
+                xmlField.editmask = '%HEX%';
+            }
+            if (patchedField.readPermission) {
+                xmlField.view = patchedField.readPermission;
+            }
+            if (patchedField.writePermission) {
+                xmlField.edit = patchedField.writePermission;
+            }
+            if (patchedField.defaultValue !== undefined) {
+                xmlField.default = parseXMLDefaultValue(patchedField);
+            }
+            if (patchedField.utilsTransferInterval === true) {
+                xmlField.param0 = '%FFFF0005%transfer_interval';
+            }
+            xml('<field>');
+            if (patchedField.library) {
+                xml(`// declared by ${patchedField.library} library`, true);
+            }
+            for (const [attribute, value] of Object.entries(xmlField)) {
+                // if (attribute === 'byteofs') {
+                // 	xml(`// patching byte offset due to removed field`);
+                // }
+                if (value !== undefined) {
+                    xmlAttr(attribute, `${value}`);
+                }
+            }
+            xml('</field>');
+        }
+        // end of container
+        if (!['alerts', 'applog'].includes(containerName)) {
+            xml('</table>');
+            xml('// ' + containerDefinition.size + ' bytes total size');
+        }
+    }
+    // insert alerts stream
+    xml('<split>');
+    xml(rm2mraw);
+    xml('target=alarm0');
+    xml('key=20'); // implicit hex!
+    xml('</split>');
+    // insert applog stream
+    xml('<split>');
+    xml(rm2mraw);
+    xml('target=applog0');
+    xml('key=28'); // implicit hex!
+    xml('</split>');
+    return xml_.join('\n');
+}
+function patchFieldWithArrayInfo(ddeField) {
+    const clonedField = structuredClone(ddeField);
+    const arrayIndex = ddeField.arrayRef?.index;
+    if (arrayIndex === undefined) {
+        return clonedField;
+    }
+    // eslint-disable-next-line prefer-const
+    for (let [attribute, value] of Object.entries(clonedField)) {
+        // @ts-ignore
+        clonedField[attribute] = patchValueWithArrayInfo(value, arrayIndex);
+    }
+    return clonedField;
+}
+/**
+ * Parse and resolve any {index} or {index+X} within the given value
+ * @param valueToPatch
+ * @param arrayIndex
+ */
+function patchValueWithArrayInfo(valueToPatch, arrayIndex) {
+    // look for these phrases in attribute strings: "<a>i+<b>", "<a>o+<b>", "<a>n+<b>" (or "<a>i", "<a>o", "<a>n")
+    const valueNTHS = `${valueToPatch}`.match(/\{\d*(index)(\+\d*)?}/g);
+    if (valueNTHS) {
+        let patchedValue = valueToPatch;
+        valueNTHS.forEach((nth) => {
+            // normalize & parse "(xn+y)" string
+            const normalizedNTH = nth.replace(/\+0$/, '');
+            const scope = normalizedNTH.match(/index/)?.[0];
+            if (scope) {
+                const stepOffset = normalizedNTH.slice(1, -1).split(scope)[1];
+                const offset = parseInt(stepOffset) || 0;
+                // reassign the patched value
+                patchedValue = patchedValue.replace(nth, `${arrayIndex + offset}`);
+            }
+        });
+        return patchedValue;
+    }
+    else {
+        return valueToPatch;
+    }
+}
+//# sourceMappingURL=xml.js.map

package/out/dde/yamlDdePreCompiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yamlDdePreCompiler.d.ts","sourceRoot":"","sources":["../../src/dde/yamlDdePreCompiler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAI7C,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;AAqBlC,yBAAiB,eAAe,CAAC;IAChC,MAAa,WAAW;QAMtB,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,YAAY;QACpB,OAAO,CAAC,UAAU;QAPnB,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAmC;QAC1E,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAiC;QACpE,OAAO,CAAC,eAAe,CAA0B;QACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiB;oBAEnC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAC3B,YAAY,EAAE,QAAQ,CAAC,WAAW,EAAE,EACpC,UAAU,EAAE,GAAG;QAGxB;;WAEG;QACI,cAAc,IAAI,WAAW,CAAC,IAAI,EAAE;QAW3C,OAAO,KAAK,eAAe,GAoB1B;QAED,OAAO,CAAC,6BAA6B;QAS9B,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG;YAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;YAAC,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,CAAA;SAAE;QAW9G;;;;;WAKG;QACI,aAAa,CACnB,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,GAClB;YAAE,SAAS,EAAE,OAAO,CAAC;YAAC,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,CAAA;SAAE;QA+B1D,OAAO,CAAC,gBAAgB;QAgKxB,OAAO,CAAC,2BAA2B;QA4CnC,OAAO,CAAC,qBAAqB;QAuB7B,OAAO,CAAC,yBAAyB;QAWjC,OAAO,CAAC,mBAAmB;QA8D3B,OAAO,CAAC,iBAAiB;QA6CzB,OAAO,CAAC,oBAAoB;QAG5B,OAAO,CAAC,2BAA2B;QAuBnC,OAAO,CAAC,cAAc;QAUtB,OAAO,CAAC,gBAAgB;QAexB,OAAO,CAAC,sBAAsB;QAY9B,OAAO,CAAC,wBAAwB;QAsBhC,OAAO,CAAC,uBAAuB;QA2D/B,OAAO,CAAC,yBAAyB;QA6CjC,OAAO,CAAC,iBAAiB;QAwCzB,OAAO,CAAC,oBAAoB;QAwB5B,OAAO,CAAC,yBAAyB;QAyDjC,OAAO,CAAC,sBAAsB;QAe9B,OAAO,CAAC,cAAc;QAmBtB,OAAO,CAAC,UAAU;QA8ClB,OAAO,CAAC,0BAA0B;QAIlC,OAAO,CAAC,4BAA4B;QAMpC,OAAO,CAAC,mBAAmB;QAS3B,OAAO,CAAC,UAAU;QAiClB,OAAO,CAAC,2BAA2B;QAqEnC,OAAO,CAAC,gCAAgC;QAyBxC,OAAO,CAAC,oBAAoB;QAmB5B,OAAO,CAAC,oBAAoB;KAI5B;CACD"}