bindings: Remove 'get_' prefix from all accessors.

[libsigrok.git] / bindings / cxx / enums.py

diff --git a/bindings/cxx/enums.py b/bindings/cxx/enums.py
index bdf12bf64e6cf89f662d395da92b3766cc99878c..e942058cc3fb11e7b3748cd301d398d042e1cf98 100644 (file)
--- a/bindings/cxx/enums.py
+++ b/bindings/cxx/enums.py
@@ -26,16 +26,20 @@ index_file = sys.argv[1]
 # Get directory this script is in.
 dirname = os.path.dirname(os.path.realpath(__file__))
 
+outdirname = "bindings/cxx"
+if not os.path.exists(os.path.join(outdirname, 'include/libsigrok')):
+    os.makedirs(os.path.join(outdirname, 'include/libsigrok'))
+
 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')])
+    ('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_datatype', ('DataType', 'Configuration data type')),
+    ('sr_channeltype', ('ChannelType', 'Channel type')),
+    ('sr_trigger_matches', ('TriggerMatchType', 'Trigger match type'))])
 
 index = ElementTree.parse(index_file)
 
@@ -60,14 +64,15 @@ for compound in index.findall('compound'):
             if name in mapping:
                 classes[member] = mapping[name]
 
-header = open(os.path.join(dirname, 'include/libsigrok/enums.hpp'), 'w')
-code = open(os.path.join(dirname, 'enums.cpp'), 'w')
+header = open(os.path.join(outdirname, 'include/libsigrok/enums.hpp'), 'w')
+code = open(os.path.join(outdirname, 'enums.cpp'), 'w')
 
 for file in (header, code):
     print >> file, "/* Generated file - edit enums.py instead! */"
 
 # Template for beginning of class declaration and public members.
 header_public_template = """
+/** {brief} */
 class SR_API {classname} : public EnumValue<enum {enumname}>
 {{
 public:
@@ -77,7 +82,7 @@ public:
 # Template for beginning of private members.
 header_private_template = """
 private:
-    static const std::map<enum {enumname}, const {classname} *> values;
+    static const std::map<enum {enumname}, const {classname} *> _values;
     {classname}(enum {enumname} id, const char name[]);
 """
 
@@ -90,22 +95,30 @@ code_template = """
 
 const {classname} *{classname}::get(int id)
 {{
-    return {classname}::values.at(static_cast<{enumname}>(id));
+    return {classname}::_values.at(static_cast<{enumname}>(id));
 }}
 """
 
-for enum, classname in classes.items():
+def get_text(node):
+    return str.join('\n\n',
+        [p.text.rstrip() for p in node.findall('para')])
+
+for enum, (classname, classbrief) in classes.items():
 
     enum_name = enum.find('name').text
-    member_names = [m.find('name').text for m in enum.findall('enumvalue')]
+    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)
+        brief=classbrief, classname=classname, enumname=enum_name)
 
     # Declare public pointers for each enum value
-    for trimmed_name in trimmed_names:
+    for trimmed_name, brief in zip(trimmed_names, briefs):
+        if brief:
+            print >> header, '\t/** %s */' % brief
         print >> header, '\tstatic const %s * const %s;' % (
             classname, trimmed_name)
 
@@ -140,7 +153,7 @@ for enum, classname in classes.items():
             classname, classname, trimmed_name, classname, trimmed_name)
 
     # Define map of enum values to constants
-    print >> code, 'const std::map<enum %s, const %s *> %s::values = {' % (
+    print >> code, 'const std::map<enum %s, const %s *> %s::_values = {' % (
         enum_name, classname, classname)
     for name, trimmed_name in zip(member_names, trimmed_names):
         print >> code, '\t{%s, %s::%s},' % (name, classname, trimmed_name)