]> sigrok.org Git - libsigrok.git/blobdiff - bindings/cxx/enums.py
Fix various -Wundefined-var-template clang warnings.
[libsigrok.git] / bindings / cxx / enums.py
index 46a1472448d28734fbb0951bd3d5523a79b74405..3711334e74f740135a94f58ef70e78e7a8570268 100644 (file)
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ##
 
-import logging, warnings
-from pygccxml import parser, declarations
+from __future__ import print_function
+from xml.etree import ElementTree
 from collections import OrderedDict
 import sys, os, re
 
-class crapfilter(logging.Filter):
-    def filter(self, record):
-        if record.msg.find('GCCXML version') > -1:
-            return 0
-        return 1
-logger = logging.getLogger('pygccxml.cxx_parser').addFilter(crapfilter())
-warnings.filterwarnings('ignore', message="unable to find out array size from expression")
+index_file = sys.argv[1]
 
 # Get directory this script is in.
 dirname = os.path.dirname(os.path.realpath(__file__))
 
-# Parse GCCXML output to get declaration tree.
-decls = parser.parse_xml_file(
-    os.path.join(dirname, "libsigrok.xml"), parser.config_t())
-
-# Get global namespace from declaration tree.
-ns = declarations.get_global_namespace(decls)
+outdirname = "bindings"
+if not os.path.exists(os.path.join(outdirname, 'cxx/include/libsigrokcxx')):
+    os.makedirs(os.path.join(outdirname, 'cxx/include/libsigrokcxx'))
+if not os.path.exists(os.path.join(outdirname, 'swig')):
+    os.makedirs(os.path.join(outdirname, 'swig'))
 
 mapping = dict([
-    ('sr_loglevel', 'LogLevel'),
-    ('sr_packettype', 'PacketType'),
-    ('sr_mq', 'Quantity'),
-    ('sr_unit', 'Unit'),
-    ('sr_mqflag', 'QuantityFlag'),
-    ('sr_configkey', 'ConfigKey'),
-    ('sr_datatype', 'DataType'),
-    ('sr_channeltype', 'ChannelType'),
-    ('sr_trigger_matches', 'TriggerMatchType')])
-
-classes = OrderedDict()
+    ('sr_loglevel', ('LogLevel', 'Log verbosity level')),
+    ('sr_packettype', ('PacketType', 'Type of datafeed packet')),
+    ('sr_mq', ('Quantity', 'Measured quantity')),
+    ('sr_unit', ('Unit', 'Unit of measurement')),
+    ('sr_mqflag', ('QuantityFlag', 'Flag applied to measured quantity')),
+    ('sr_configkey', ('ConfigKey', 'Configuration key')),
+    ('sr_configcap', ('Capability', 'Configuration capability')),
+    ('sr_datatype', ('DataType', 'Configuration data type')),
+    ('sr_channeltype', ('ChannelType', 'Channel type')),
+    ('sr_trigger_matches', ('TriggerMatchType', 'Trigger match type')),
+    ('sr_output_flag', ('OutputFlag', 'Flag applied to output modules'))])
+
+index = ElementTree.parse(index_file)
 
 # Build mapping between class names and enumerations.
-for enum in ns.enumerations():
-    if enum.name in mapping:
-        classname = mapping[enum.name]
-        classes[classname] = enum
 
-header = open(os.path.join(dirname, 'include/libsigrok/enums.hpp'), 'w')
-code = open(os.path.join(dirname, 'enums.cpp'), 'w')
+classes = OrderedDict()
+
+for compound in index.findall('compound'):
+    if compound.attrib['kind'] != 'file':
+        continue
+    filename = os.path.join(
+        os.path.dirname(index_file),
+        '%s.xml' % compound.attrib['refid'])
+    doc = ElementTree.parse(filename)
+    for section in doc.find('compounddef').findall('sectiondef'):
+        if section.attrib["kind"] != 'enum':
+            continue
+        for member in section.findall('memberdef'):
+            if member.attrib["kind"] != 'enum':
+                continue
+            name = member.find('name').text
+            if name in mapping:
+                classes[member] = mapping[name]
+
+header = open(os.path.join(outdirname, 'cxx/include/libsigrokcxx/enums.hpp'), 'w')
+code = open(os.path.join(outdirname, 'cxx/enums.cpp'), 'w')
+swig = open(os.path.join(outdirname, 'swig/enums.i'), 'w')
 
 for file in (header, code):
-    print >> file, "/* Generated file - edit enums.py instead! */"
+    print("/* Generated file - edit enums.py instead! */", file=file)
+
+print("namespace sigrok {", file=header)
 
 # Template for beginning of class declaration and public members.
 header_public_template = """
-class SR_API {classname} : public EnumValue<enum {enumname}>
+template<> const SR_API std::map<const enum {enumname}, const {classname} * const> EnumValue<{classname}, enum {enumname}>::_values;
+
+/** {brief} */
+class SR_API {classname} : public EnumValue<{classname}, enum {enumname}>
 {{
 public:
-    static const {classname} *get(int id);
 """
 
 # Template for beginning of private members.
 header_private_template = """
-private:
-    static const std::map<enum {enumname}, const {classname} *> values;
-    {classname}(enum {enumname} id, const char name[]);
+protected:
+    {classname}(enum {enumname} id, const char name[]) : EnumValue(id, name) {{}}
 """
 
-# Template for class method definitions.
-code_template = """
-{classname}::{classname}(enum {enumname} id, const char name[]) :
-    EnumValue<enum {enumname}>(id, name)
-{{
-}}
+def get_text(node):
+    return str.join('\n\n',
+        [p.text.rstrip() for p in node.findall('para')])
 
-const {classname} *{classname}::get(int id)
-{{
-    return {classname}::values.at(static_cast<{enumname}>(id));
-}}
-"""
+for enum, (classname, classbrief) in classes.items():
 
-for classname, enum in classes.items():
+    enum_name = enum.find('name').text
+    members = enum.findall('enumvalue')
+    member_names = [m.find('name').text for m in members]
+    trimmed_names = [re.sub("^SR_[A-Z]+_", "", n) for n in member_names]
+    briefs = [get_text(m.find('briefdescription')) for m in members]
 
     # Begin class and public declarations
-    print >> header, header_public_template.format(
-        classname=classname, enumname=enum.name)
+    print(header_public_template.format(
+        brief=classbrief, classname=classname, enumname=enum_name), file=header)
 
     # Declare public pointers for each enum value
-    for name, value in enum.values:
-        trimmed_name = re.sub("^SR_[A-Z]+_", "", name)
-        print >> header, '\tstatic const %s * const %s;' % (classname, trimmed_name)
+    for trimmed_name, brief in zip(trimmed_names, briefs):
+        if brief:
+            print('\t/** %s */' % brief, file=header)
+        print('\tstatic const %s * const %s;' % (
+            classname, trimmed_name), file=header)
 
     # Declare additional methods if present
     filename = os.path.join(dirname, "%s_methods.hpp" % classname)
     if os.path.exists(filename):
-        print >> header, str.join('', open(filename).readlines())
+        print(str.join('', open(filename).readlines()), file=header)
 
     # Begin private declarations
-    print >> header, header_private_template.format(
-        classname=classname, enumname=enum.name)
+    print(header_private_template.format(
+        classname=classname, enumname=enum_name), file=header)
 
     # Declare private constants for each enum value
-    for name, value in enum.values:
-        trimmed_name = re.sub("^SR_[A-Z]+_", "", name)
-        print >> header, '\tstatic const %s _%s;' % (classname, trimmed_name)
+    for trimmed_name in trimmed_names:
+        print('\tstatic const %s _%s;' % (classname, trimmed_name), file=header)
 
     # End class declaration
-    print >> header, '};'
-
-    # Begin class code
-    print >> code, code_template.format(
-        classname=classname, enumname=enum.name)
+    print('};', file=header)
 
     # Define private constants for each enum value
-    for name, value in enum.values:
-        trimmed_name = re.sub("^SR_[A-Z]+_", "", name)
-        print >> code, 'const %s %s::_%s = %s(%s, "%s");' % (
-            classname, classname, trimmed_name, classname, name, trimmed_name)
+    for name, trimmed_name in zip(member_names, trimmed_names):
+        print('const %s %s::_%s = %s(%s, "%s");' % (
+            classname, classname, trimmed_name, classname, name, trimmed_name),
+            file=code)
 
     # Define public pointers for each enum value
-    for name, value in enum.values:
-        trimmed_name = re.sub("^SR_[A-Z]+_", "", name)
-        print >> code, 'const %s * const %s::%s = &%s::_%s;' % (
-            classname, classname, trimmed_name, classname, trimmed_name)
+    for trimmed_name in trimmed_names:
+        print('const %s * const %s::%s = &%s::_%s;' % (
+            classname, classname, trimmed_name, classname, trimmed_name),
+            file=code)
 
     # Define map of enum values to constants
-    print >> code, 'const std::map<enum %s, const %s *> %s::values = {' % (
-        enum.name, classname, classname)
-    for name, value in enum.values:
-        trimmed_name = re.sub("^SR_[A-Z]+_", "", name)
-        print >> code, '\t{%s, %s::%s},' % (name, classname, trimmed_name)
-    print >> code, '};'
+    print('template<> const SR_API std::map<const enum %s, const %s * const> EnumValue<%s, enum %s>::_values = {' % (
+        enum_name, classname, classname, enum_name), file=code)
+    for name, trimmed_name in zip(member_names, trimmed_names):
+        print('\t{%s, %s::%s},' % (name, classname, trimmed_name), file=code)
+    print('};', file=code)
 
     # Define additional methods if present
     filename = os.path.join(dirname, "%s_methods.cpp" % classname)
     if os.path.exists(filename):
-        print >> code, str.join('', open(filename).readlines())
+        print(str.join('', open(filename).readlines()), file=code)
+
+    # Map EnumValue::id() and EnumValue::name() as SWIG attributes.
+    print('%%attribute(sigrok::%s, int, id, id);' % classname, file=swig)
+    print('%%attributestring(sigrok::%s, std::string, name, name);' % classname,
+        file=swig)
+
+    # Instantiate EnumValue template for SWIG
+    print('%%template(EnumValue%s) sigrok::EnumValue<sigrok::%s, enum %s>;' % (
+        classname, classname, enum_name), file=swig)
+
+    # Apply any language-specific extras.
+    print('%%enumextras(%s);' % classname, file=swig)
+
+    # Declare additional attributes if present
+    filename = os.path.join(dirname, "%s_methods.i" % classname)
+    if os.path.exists(filename):
+        print(str.join('', open(filename).readlines()), file=swig)
+
+print("}", file=header)