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 xml.etree import ElementTree
  21 from collections import OrderedDict
  22 import sys, os, re
  23
  24 index_file = sys.argv[1]
  25
  26 # Get directory this script is in.
  27 dirname = os.path.dirname(os.path.realpath(__file__))
  28
  29 outdirname = "bindings/cxx"
  30 if not os.path.exists(os.path.join(outdirname, 'include/libsigrok')):
  31     os.makedirs(os.path.join(outdirname, 'include/libsigrok'))
  32
  33 mapping = dict([
  34     ('sr_loglevel', ('LogLevel', 'Log verbosity level')),
  35     ('sr_packettype', ('PacketType', 'Type of datafeed packet')),
  36     ('sr_mq', ('Quantity', 'Measured quantity')),
  37     ('sr_unit', ('Unit', 'Unit of measurement')),
  38     ('sr_mqflag', ('QuantityFlag', 'Flag applied to measured quantity')),
  39     ('sr_configkey', ('ConfigKey', 'Configuration key')),
  40     ('sr_datatype', ('DataType', 'Configuration data type')),
  41     ('sr_channeltype', ('ChannelType', 'Channel type')),
  42     ('sr_trigger_matches', ('TriggerMatchType', 'Trigger match type'))])
  43
  44 index = ElementTree.parse(index_file)
  45
  46 # Build mapping between class names and enumerations.
  47
  48 classes = OrderedDict()
  49
  50 for compound in index.findall('compound'):
  51     if compound.attrib['kind'] != 'file':
  52         continue
  53     filename = os.path.join(
  54         os.path.dirname(index_file),
  55         '%s.xml' % compound.attrib['refid'])
  56     doc = ElementTree.parse(filename)
  57     for section in doc.find('compounddef').findall('sectiondef'):
  58         if section.attrib["kind"] != 'enum':
  59             continue
  60         for member in section.findall('memberdef'):
  61             if member.attrib["kind"] != 'enum':
  62                 continue
  63             name = member.find('name').text
  64             if name in mapping:
  65                 classes[member] = mapping[name]
  66
  67 header = open(os.path.join(outdirname, 'include/libsigrok/enums.hpp'), 'w')
  68 code = open(os.path.join(outdirname, 'enums.cpp'), 'w')
  69 swig = open(os.path.join(outdirname, '../swig/enums.i'), 'w')
  70
  71 for file in (header, code):
  72     print >> file, "/* Generated file - edit enums.py instead! */"
  73
  74 # Template for beginning of class declaration and public members.
  75 header_public_template = """
  76 /** {brief} */
  77 class SR_API {classname} : public EnumValue<{classname}, enum {enumname}>
  78 {{
  79 public:
  80 """
  81
  82 # Template for beginning of private members.
  83 header_private_template = """
  84 protected:
  85     {classname}(enum {enumname} id, const char name[]) : EnumValue(id, name) {{}}
  86 """
  87
  88 def get_text(node):
  89     return str.join('\n\n',
  90         [p.text.rstrip() for p in node.findall('para')])
  91
  92 for enum, (classname, classbrief) in classes.items():
  93
  94     enum_name = enum.find('name').text
  95     members = enum.findall('enumvalue')
  96     member_names = [m.find('name').text for m in members]
  97     trimmed_names = [re.sub("^SR_[A-Z]+_", "", n) for n in member_names]
  98     briefs = [get_text(m.find('briefdescription')) for m in members]
  99
 100     # Begin class and public declarations
 101     print >> header, header_public_template.format(
 102         brief=classbrief, classname=classname, enumname=enum_name)
 103
 104     # Declare public pointers for each enum value
 105     for trimmed_name, brief in zip(trimmed_names, briefs):
 106         if brief:
 107             print >> header, '\t/** %s */' % brief
 108         print >> header, '\tstatic const %s * const %s;' % (
 109             classname, trimmed_name)
 110
 111     # Declare additional methods if present
 112     filename = os.path.join(dirname, "%s_methods.hpp" % classname)
 113     if os.path.exists(filename):
 114         print >> header, str.join('', open(filename).readlines())
 115
 116     # Begin private declarations
 117     print >> header, header_private_template.format(
 118         classname=classname, enumname=enum_name)
 119
 120     # Declare private constants for each enum value
 121     for trimmed_name in trimmed_names:
 122         print >> header, '\tstatic const %s _%s;' % (classname, trimmed_name)
 123
 124     # End class declaration
 125     print >> header, '};'
 126
 127     # Define private constants for each enum value
 128     for name, trimmed_name in zip(member_names, trimmed_names):
 129         print >> code, 'const %s %s::_%s = %s(%s, "%s");' % (
 130             classname, classname, trimmed_name, classname, name, trimmed_name)
 131
 132     # Define public pointers for each enum value
 133     for trimmed_name in trimmed_names:
 134         print >> code, 'const %s * const %s::%s = &%s::_%s;' % (
 135             classname, classname, trimmed_name, classname, trimmed_name)
 136
 137     # Define map of enum values to constants
 138     print >> code, 'template<> const std::map<const enum %s, const %s * const> EnumValue<%s, enum %s>::_values = {' % (
 139         enum_name, classname, classname, enum_name)
 140     for name, trimmed_name in zip(member_names, trimmed_names):
 141         print >> code, '\t{%s, %s::%s},' % (name, classname, trimmed_name)
 142     print >> code, '};'
 143
 144     # Define additional methods if present
 145     filename = os.path.join(dirname, "%s_methods.cpp" % classname)
 146     if os.path.exists(filename):
 147         print >> code, str.join('', open(filename).readlines())
 148
 149     # Map EnumValue::id() and EnumValue::name() as SWIG attributes.
 150     print >> swig, '%%attribute(sigrok::%s, int, id, id);' % classname
 151     print >> swig, '%%attributestring(sigrok::%s, std::string, name, name);' % classname
 152
 153     # Instantiate EnumValue template for SWIG
 154     print >> swig, '%%template(EnumValue%s) sigrok::EnumValue<sigrok::%s, enum %s>;' % (
 155         classname, classname, enum_name)
 156
 157     # Apply any language-specific extras.
 158     print >> swig, '%%enumextras(%s);' % classname
 159
 160     # Declare additional attributes if present
 161     filename = os.path.join(dirname, "%s_methods.i" % classname)
 162     if os.path.exists(filename):
 163         print >> swig, str.join('', open(filename).readlines())