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
  70 for file in (header, code):
  71     print >> file, "/* Generated file - edit enums.py instead! */"
  72
  73 # Template for beginning of class declaration and public members.
  74 header_public_template = """
  75 /** {brief} */
  76 class SR_API {classname} : public EnumValue<enum {enumname}>
  77 {{
  78 public:
  79     static const {classname} *get(int id);
  80 """
  81
  82 # Template for beginning of private members.
  83 header_private_template = """
  84 private:
  85     static const std::map<enum {enumname}, const {classname} *> values;
  86     {classname}(enum {enumname} id, const char name[]);
  87 """
  88
  89 # Template for class method definitions.
  90 code_template = """
  91 {classname}::{classname}(enum {enumname} id, const char name[]) :
  92     EnumValue<enum {enumname}>(id, name)
  93 {{
  94 }}
  95
  96 const {classname} *{classname}::get(int id)
  97 {{
  98     return {classname}::values.at(static_cast<{enumname}>(id));
  99 }}
 100 """
 101
 102 def get_text(node):
 103     return str.join('\n\n',
 104         [p.text.rstrip() for p in node.findall('para')])
 105
 106 for enum, (classname, classbrief) in classes.items():
 107
 108     enum_name = enum.find('name').text
 109     members = enum.findall('enumvalue')
 110     member_names = [m.find('name').text for m in members]
 111     trimmed_names = [re.sub("^SR_[A-Z]+_", "", n) for n in member_names]
 112     briefs = [get_text(m.find('briefdescription')) for m in members]
 113
 114     # Begin class and public declarations
 115     print >> header, header_public_template.format(
 116         brief=classbrief, classname=classname, enumname=enum_name)
 117
 118     # Declare public pointers for each enum value
 119     for trimmed_name, brief in zip(trimmed_names, briefs):
 120         if brief:
 121             print >> header, '\t/** %s */' % brief
 122         print >> header, '\tstatic const %s * const %s;' % (
 123             classname, trimmed_name)
 124
 125     # Declare additional methods if present
 126     filename = os.path.join(dirname, "%s_methods.hpp" % classname)
 127     if os.path.exists(filename):
 128         print >> header, str.join('', open(filename).readlines())
 129
 130     # Begin private declarations
 131     print >> header, header_private_template.format(
 132         classname=classname, enumname=enum_name)
 133
 134     # Declare private constants for each enum value
 135     for trimmed_name in trimmed_names:
 136         print >> header, '\tstatic const %s _%s;' % (classname, trimmed_name)
 137
 138     # End class declaration
 139     print >> header, '};'
 140
 141     # Begin class code
 142     print >> code, code_template.format(
 143         classname=classname, enumname=enum_name)
 144
 145     # Define private constants for each enum value
 146     for name, trimmed_name in zip(member_names, trimmed_names):
 147         print >> code, 'const %s %s::_%s = %s(%s, "%s");' % (
 148             classname, classname, trimmed_name, classname, name, trimmed_name)
 149
 150     # Define public pointers for each enum value
 151     for trimmed_name in trimmed_names:
 152         print >> code, 'const %s * const %s::%s = &%s::_%s;' % (
 153             classname, classname, trimmed_name, classname, trimmed_name)
 154
 155     # Define map of enum values to constants
 156     print >> code, 'const std::map<enum %s, const %s *> %s::values = {' % (
 157         enum_name, classname, classname)
 158     for name, trimmed_name in zip(member_names, trimmed_names):
 159         print >> code, '\t{%s, %s::%s},' % (name, classname, trimmed_name)
 160     print >> code, '};'
 161
 162     # Define additional methods if present
 163     filename = os.path.join(dirname, "%s_methods.cpp" % classname)
 164     if os.path.exists(filename):
 165         print >> code, str.join('', open(filename).readlines())