bindings/swig/doc.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 import sys, os
  23
  24 language, input_file = sys.argv[1:]
  25 input_dir = os.path.dirname(input_file)
  26
  27 index = ElementTree.parse(input_file)
  28
  29 def get_text(node):
  30     paras = node.findall('para')
  31     return str.join('\n\n', [p.text.rstrip() for p in paras if p.text])
  32
  33 for compound in index.findall('compound'):
  34     if compound.attrib['kind'] != 'class':
  35         continue
  36     class_name = compound.find('name').text
  37     if not class_name.startswith('sigrok::'):
  38         continue
  39     trimmed_name = class_name.split('::')[1]
  40     doc = ElementTree.parse("%s/%s.xml" % (input_dir, compound.attrib['refid']))
  41     cls = doc.find('compounddef')
  42     brief = get_text(cls.find('briefdescription'))
  43     if brief:
  44         if language == 'python':
  45             print('%%feature("docstring") %s "%s";' % (class_name, brief))
  46         elif language == 'java':
  47             print('%%typemap(javaclassmodifiers) %s "/** %s */\npublic class"' % (
  48             class_name, brief))
  49     constants = []
  50     for section in cls.findall('sectiondef'):
  51         kind = section.attrib['kind']
  52         if kind not in ('public-func', 'public-static-attrib'):
  53             continue
  54         for member in section.findall('memberdef'):
  55             member_name = member.find('name').text
  56             brief = get_text(member.find('briefdescription')).replace('"', '\\"')
  57             parameters = {}
  58             for para in member.find('detaileddescription').findall('para'):
  59                 paramlist = para.find('parameterlist')
  60                 if paramlist is not None:
  61                     for param in paramlist.findall('parameteritem'):
  62                         namelist = param.find('parameternamelist')
  63                         name = namelist.find('parametername').text
  64                         description = get_text(param.find('parameterdescription'))
  65                         if description:
  66                             parameters[name] = description
  67             if brief:
  68                 if language == 'python' and kind == 'public-func':
  69                     print(str.join('\n', [
  70                         '%%feature("docstring") %s::%s "%s' % (
  71                             class_name, member_name, brief)] + [
  72                         '@param %s %s' % (name, desc)
  73                             for name, desc in parameters.items()]) + '";')
  74                 elif language == 'java' and kind == 'public-func':
  75                         print(str.join('\n', [
  76                             '%%javamethodmodifiers %s::%s "/** %s' % (
  77                                 class_name, member_name, brief)] + [
  78                             '   * @param %s %s' % (name, desc)
  79                                 for name, desc in parameters.items()])
  80                                     + ' */\npublic"')
  81                 elif kind == 'public-static-attrib':
  82                     constants.append((member_name, brief))
  83     if language == 'java' and constants:
  84         print('%%typemap(javacode) %s %%{' % class_name)
  85         for member_name, brief in constants:
  86             print('  /** %s */\n  public static final %s %s = new %s(classesJNI.%s_%s_get(), false);\n' % (
  87                 brief, trimmed_name, member_name, trimmed_name,
  88                 trimmed_name, member_name))
  89         print('%}')
  90     elif language == 'python' and constants:
  91         print('%%extend %s {\n%%pythoncode %%{' % class_name)
  92         for member_name, brief in constants:
  93             print('    ## @brief %s\n    %s = None' % (brief, member_name))
  94         print('%}\n}')