bindings/cxx/enums.py

   1 ##
   2 ## This file is part of the libsigrok project.
   3 ##
   4 ## Copyright (C) 2014 Martin Ling <martin-sigrok@earth.li>
   5 ##
   6 ## This program is free software: you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation, either version 3 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 from __future__ import print_function
  21 from xml.etree import ElementTree
  22 from collections import OrderedDict
  23 import sys, os, re
  24
  25 index_file = sys.argv[1]
  26
  27 # Get directory this script is in.
  28 dirname = os.path.dirname(os.path.realpath(__file__))
  29
  30 outdirname = "bindings/cxx"
  31 if not os.path.exists(os.path.join(outdirname, 'include/libsigrok')):
  32     os.makedirs(os.path.join(outdirname, 'include/libsigrok'))
  33
  34 mapping = dict([
  35     ('sr_loglevel', ('LogLevel', 'Log verbosity level')),
  36     ('sr_packettype', ('PacketType', 'Type of datafeed packet')),
  37     ('sr_mq', ('Quantity', 'Measured quantity')),
  38     ('sr_unit', ('Unit', 'Unit of measurement')),
  39     ('sr_mqflag', ('QuantityFlag', 'Flag applied to measured quantity')),
  40     ('sr_configkey', ('ConfigKey', 'Configuration key')),
  41     ('sr_datatype', ('DataType', 'Configuration data type')),
  42     ('sr_channeltype', ('ChannelType', 'Channel type')),
  43     ('sr_trigger_matches', ('TriggerMatchType', 'Trigger match type'))])
  44
  45 index = ElementTree.parse(index_file)
  46
  47 # Build mapping between class names and enumerations.
  48
  49 classes = OrderedDict()
  50
  51 for compound in index.findall('compound'):
  52     if compound.attrib['kind'] != 'file':
  53         continue
  54     filename = os.path.join(
  55         os.path.dirname(index_file),
  56         '%s.xml' % compound.attrib['refid'])
  57     doc = ElementTree.parse(filename)
  58     for section in doc.find('compounddef').findall('sectiondef'):
  59         if section.attrib["kind"] != 'enum':
  60             continue
  61         for member in section.findall('memberdef'):
  62             if member.attrib["kind"] != 'enum':
  63                 continue
  64             name = member.find('name').text
  65             if name in mapping:
  66                 classes[member] = mapping[name]
  67
  68 header = open(os.path.join(outdirname, 'include/libsigrok/enums.hpp'), 'w')
  69 code = open(os.path.join(outdirname, 'enums.cpp'), 'w')
  70 swig = open(os.path.join(dirname, '../swig/enums.i'), 'w')
  71
  72 for file in (header, code):
  73     print("/* Generated file - edit enums.py instead! */", file=file)
  74
  75 # Template for beginning of class declaration and public members.
  76 header_public_template = """
  77 /** {brief} */
  78 class SR_API {classname} : public EnumValue<{classname}, enum {enumname}>
  79 {{
  80 public:
  81 """
  82
  83 # Template for beginning of private members.
  84 header_private_template = """
  85 protected:
  86     {classname}(enum {enumname} id, const char name[]) : EnumValue(id, name) {{}}
  87 """
  88
  89 def get_text(node):
  90     return str.join('\n\n',
  91         [p.text.rstrip() for p in node.findall('para')])
  92
  93 for enum, (classname, classbrief) in classes.items():
  94
  95     enum_name = enum.find('name').text
  96     members = enum.findall('enumvalue')
  97     member_names = [m.find('name').text for m in members]
  98     trimmed_names = [re.sub("^SR_[A-Z]+_", "", n) for n in member_names]
  99     briefs = [get_text(m.find('briefdescription')) for m in members]
 100
 101     # Begin class and public declarations
 102     print(header_public_template.format(
 103         brief=classbrief, classname=classname, enumname=enum_name), file=header)
 104
 105     # Declare public pointers for each enum value
 106     for trimmed_name, brief in zip(trimmed_names, briefs):
 107         if brief:
 108             print('\t/** %s */' % brief, file=header)
 109         print('\tstatic const %s * const %s;' % (
 110             classname, trimmed_name), file=header)
 111
 112     # Declare additional methods if present
 113     filename = os.path.join(dirname, "%s_methods.hpp" % classname)
 114     if os.path.exists(filename):
 115         print(str.join('', open(filename).readlines()), file=header)
 116
 117     # Begin private declarations
 118     print(header_private_template.format(
 119         classname=classname, enumname=enum_name), file=header)
 120
 121     # Declare private constants for each enum value
 122     for trimmed_name in trimmed_names:
 123         print('\tstatic const %s _%s;' % (classname, trimmed_name), file=header)
 124
 125     # End class declaration
 126     print('};', file=header)
 127
 128     # Define private constants for each enum value
 129     for name, trimmed_name in zip(member_names, trimmed_names):
 130         print('const %s %s::_%s = %s(%s, "%s");' % (
 131             classname, classname, trimmed_name, classname, name, trimmed_name),
 132             file=code)
 133
 134     # Define public pointers for each enum value
 135     for trimmed_name in trimmed_names:
 136         print('const %s * const %s::%s = &%s::_%s;' % (
 137             classname, classname, trimmed_name, classname, trimmed_name),
 138             file=code)
 139
 140     # Define map of enum values to constants
 141     print('template<> const std::map<const enum %s, const %s * const> EnumValue<%s, enum %s>::_values = {' % (
 142         enum_name, classname, classname, enum_name), file=code)
 143     for name, trimmed_name in zip(member_names, trimmed_names):
 144         print('\t{%s, %s::%s},' % (name, classname, trimmed_name), file=code)
 145     print('};', file=code)
 146
 147     # Define additional methods if present
 148     filename = os.path.join(dirname, "%s_methods.cpp" % classname)
 149     if os.path.exists(filename):
 150         print(str.join('', open(filename).readlines()), file=code)
 151
 152     # Map EnumValue::id() and EnumValue::name() as SWIG attributes.
 153     print('%%attribute(sigrok::%s, int, id, id);' % classname, file=swig)
 154     print('%%attributestring(sigrok::%s, std::string, name, name);' % classname,
 155         file=swig)
 156
 157     # Instantiate EnumValue template for SWIG
 158     print('%%template(EnumValue%s) sigrok::EnumValue<sigrok::%s, enum %s>;' % (
 159         classname, classname, enum_name), file=swig)
 160
 161     # Apply any language-specific extras.
 162     print('%%enumextras(%s);' % classname, file=swig)
 163
 164     # Declare additional attributes if present
 165     filename = os.path.join(dirname, "%s_methods.i" % classname)
 166     if os.path.exists(filename):
 167         print(str.join('', open(filename).readlines()), file=swig)