Files
open62541/tools/generate_statuscode_descriptions.py
2026-07-18 09:45:45 +02:00

106 lines
3.1 KiB
Python
Executable File

#!/usr/bin/env python3
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('statuscodes', help='path/to/Opc.Ua.StatusCodes.csv')
parser.add_argument('outfile', help='outfile w/o extension')
args = parser.parse_args()
rows = []
with open(args.statuscodes, encoding='utf8') as f:
lines = f.readlines()
for l in lines:
rows.append(tuple(l.strip().split(',')))
fh = open(args.outfile + ".h", "w", encoding='utf8')
fc = open(args.outfile + ".c", "w", encoding='utf8')
def printh(string):
print(string, end='\n', file=fh)
def printc(string):
print(string, end='\n', file=fc)
#########################
# Print the header file #
#########################
printh('''/** .. _statuscodes:
*
* StatusCodes
* ===========
*
* StatusCodes are extensively used in the OPC UA protocol and in the open62541
* API. They are represented by the :ref:`statuscode` data type. The following
* definitions are autogenerated from the ``Opc.Ua.StatusCodes.csv`` file provided
* with the OPC UA standard. */
/* These StatusCodes are manually generated. */
#define UA_STATUSCODE_INFOTYPE_DATAVALUE ((UA_StatusCode) 0x00000400)
#define UA_STATUSCODE_INFOBITS_OVERFLOW ((UA_StatusCode) 0x00000080)
#define UA_STATUSCODE_SEMANTICSCHANGED ((UA_StatusCode) 0x00004000)
''')
for row in rows:
printh("/* {} */\n#define UA_STATUSCODE_{} ((UA_StatusCode) {})\n".format(row[2][1:-1], row[0].upper(), row[1]))
printh('''/* Depending on the version of the schema, the following might be already defined: */
#ifndef UA_STATUSCODE_GOOD
# define UA_STATUSCODE_GOOD ((UA_StatusCode) 0x00000000)
#endif
#ifndef UA_STATUSCODE_UNCERTAIN
# define UA_STATUSCODE_UNCERTAIN ((UA_StatusCode) 0x40000000)
#endif
#ifndef UA_STATUSCODE_BAD
# define UA_STATUSCODE_BAD ((UA_StatusCode) 0x80000000)
#endif
''')
#########################
# Print the source file #
#########################
count = 2 + len(rows)
printc('''/**********************************
* Autogenerated -- do not modify *
**********************************/
#include <open62541/types.h>
typedef struct {
UA_StatusCode code;
const char *name;
} UA_StatusCodeName;
#ifndef UA_ENABLE_STATUSCODE_DESCRIPTIONS
static const char * emptyStatusCodeName = "";
const char * UA_StatusCode_name(UA_StatusCode code) {
return emptyStatusCodeName;
}
#else
static const size_t statusCodeDescriptionsSize = %i;
static const UA_StatusCodeName statusCodeDescriptions[%i] = {
{UA_STATUSCODE_GOOD, \"Good\"},''' % (count, count))
for row in rows:
printc(" {{UA_STATUSCODE_{}, \"{}\"}},".format(row[0].upper(), row[0]))
printc(''' {0xffffffff, "Unknown StatusCode"}
};
const char * UA_StatusCode_name(UA_StatusCode code) {
for (size_t i = 0; i < statusCodeDescriptionsSize; ++i) {
if (UA_StatusCode_isEqualTop(statusCodeDescriptions[i].code,code))
return statusCodeDescriptions[i].name;
}
return statusCodeDescriptions[statusCodeDescriptionsSize-1].name;
}
#endif''')
fc.close()
fh.close()