Documentation/sphinx/kernel-doc.py

   1 # coding=utf-8
   2 #
   3 # Copyright © 2016 Intel Corporation
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a
   6 # copy of this software and associated documentation files (the "Software"),
   7 # to deal in the Software without restriction, including without limitation
   8 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9 # and/or sell copies of the Software, and to permit persons to whom the
  10 # Software is furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice (including the next
  13 # paragraph) shall be included in all copies or substantial portions of the
  14 # Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  22 # IN THE SOFTWARE.
  23 #
  24 # Authors:
  25 #    Jani Nikula <jani.nikula@intel.com>
  26 #
  27 # Please make sure this works on both python2 and python3.
  28 #
  29
  30 import os
  31 import subprocess
  32 import sys
  33 import re
  34
  35 from docutils import nodes, statemachine
  36 from docutils.statemachine import ViewList
  37 from docutils.parsers.rst import directives
  38 from sphinx.util.compat import Directive
  39
  40 class KernelDocDirective(Directive):
  41     """Extract kernel-doc comments from the specified file"""
  42     required_argument = 1
  43     optional_arguments = 4
  44     option_spec = {
  45         'doc': directives.unchanged_required,
  46         'functions': directives.unchanged_required,
  47         'export': directives.flag,
  48         'internal': directives.flag,
  49     }
  50     has_content = False
  51
  52     def run(self):
  53         env = self.state.document.settings.env
  54         cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
  55
  56         filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
  57
  58         # Tell sphinx of the dependency
  59         env.note_dependency(os.path.abspath(filename))
  60
  61         tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
  62         source = filename
  63
  64         # FIXME: make this nicer and more robust against errors
  65         if 'export' in self.options:
  66             cmd += ['-export']
  67         elif 'internal' in self.options:
  68             cmd += ['-internal']
  69         elif 'doc' in self.options:
  70             cmd += ['-function', str(self.options.get('doc'))]
  71         elif 'functions' in self.options:
  72             for f in str(self.options.get('functions')).split(' '):
  73                 cmd += ['-function', f]
  74
  75         cmd += [filename]
  76
  77         try:
  78             env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
  79
  80             p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
  81             out, err = p.communicate()
  82
  83             # python2 needs conversion to unicode.
  84             # python3 with universal_newlines=True returns strings.
  85             if sys.version_info.major < 3:
  86                 out, err = unicode(out, 'utf-8'), unicode(err, 'utf-8')
  87
  88             if p.returncode != 0:
  89                 sys.stderr.write(err)
  90
  91                 env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
  92                 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
  93             elif env.config.kerneldoc_verbosity > 0:
  94                 sys.stderr.write(err)
  95
  96             lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
  97             result = ViewList()
  98
  99             lineoffset = 0;
 100             line_regex = re.compile("^#define LINENO ([0-9]+)$")
 101             for line in lines:
 102                 match = line_regex.search(line)
 103                 if match:
 104                     # sphinx counts lines from 0
 105                     lineoffset = int(match.group(1)) - 1
 106                     # we must eat our comments since the upset the markup
 107                 else:
 108                     result.append(line, source, lineoffset)
 109                     lineoffset += 1
 110
 111             node = nodes.section()
 112             node.document = self.state.document
 113             self.state.nested_parse(result, self.content_offset, node)
 114
 115             return node.children
 116
 117         except Exception as e:
 118             env.app.warn('kernel-doc \'%s\' processing failed with: %s' %
 119                          (" ".join(cmd), str(e)))
 120             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 121
 122 def setup(app):
 123     app.add_config_value('kerneldoc_bin', None, 'env')
 124     app.add_config_value('kerneldoc_srctree', None, 'env')
 125     app.add_config_value('kerneldoc_verbosity', 1, 'env')
 126
 127     app.add_directive('kernel-doc', KernelDocDirective)