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 import glob
  35
  36 from docutils import nodes, statemachine
  37 from docutils.statemachine import ViewList
  38 from docutils.parsers.rst import directives
  39 from sphinx.util.compat import Directive
  40 from sphinx.ext.autodoc import AutodocReporter
  41
  42 class KernelDocDirective(Directive):
  43     """Extract kernel-doc comments from the specified file"""
  44     required_argument = 1
  45     optional_arguments = 4
  46     option_spec = {
  47         'doc': directives.unchanged_required,
  48         'functions': directives.unchanged_required,
  49         'export': directives.unchanged,
  50         'internal': directives.unchanged,
  51     }
  52     has_content = False
  53
  54     def run(self):
  55         env = self.state.document.settings.env
  56         cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
  57
  58         filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
  59         export_file_patterns = []
  60
  61         # Tell sphinx of the dependency
  62         env.note_dependency(os.path.abspath(filename))
  63
  64         tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
  65
  66         # FIXME: make this nicer and more robust against errors
  67         if 'export' in self.options:
  68             cmd += ['-export']
  69             export_file_patterns = str(self.options.get('export')).split()
  70         elif 'internal' in self.options:
  71             cmd += ['-internal']
  72             export_file_patterns = str(self.options.get('internal')).split()
  73         elif 'doc' in self.options:
  74             cmd += ['-function', str(self.options.get('doc'))]
  75         elif 'functions' in self.options:
  76             for f in str(self.options.get('functions')).split():
  77                 cmd += ['-function', f]
  78
  79         for pattern in export_file_patterns:
  80             for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
  81                 env.note_dependency(os.path.abspath(f))
  82                 cmd += ['-export-file', f]
  83
  84         cmd += [filename]
  85
  86         try:
  87             env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
  88
  89             p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
  90             out, err = p.communicate()
  91
  92             # python2 needs conversion to unicode.
  93             # python3 with universal_newlines=True returns strings.
  94             if sys.version_info.major < 3:
  95                 out, err = unicode(out, 'utf-8'), unicode(err, 'utf-8')
  96
  97             if p.returncode != 0:
  98                 sys.stderr.write(err)
  99
 100                 env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
 101                 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 102             elif env.config.kerneldoc_verbosity > 0:
 103                 sys.stderr.write(err)
 104
 105             lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
 106             result = ViewList()
 107
 108             lineoffset = 0;
 109             line_regex = re.compile("^#define LINENO ([0-9]+)$")
 110             for line in lines:
 111                 match = line_regex.search(line)
 112                 if match:
 113                     # sphinx counts lines from 0
 114                     lineoffset = int(match.group(1)) - 1
 115                     # we must eat our comments since the upset the markup
 116                 else:
 117                     result.append(line, filename, lineoffset)
 118                     lineoffset += 1
 119
 120             node = nodes.section()
 121             buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
 122             self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
 123             self.state.memo.title_styles, self.state.memo.section_level = [], 0
 124             try:
 125                 self.state.nested_parse(result, 0, node, match_titles=1)
 126             finally:
 127                 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = buf
 128
 129             return node.children
 130
 131         except Exception as e:  # pylint: disable=W0703
 132             env.app.warn('kernel-doc \'%s\' processing failed with: %s' %
 133                          (" ".join(cmd), str(e)))
 134             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 135
 136 def setup(app):
 137     app.add_config_value('kerneldoc_bin', None, 'env')
 138     app.add_config_value('kerneldoc_srctree', None, 'env')
 139     app.add_config_value('kerneldoc_verbosity', 1, 'env')
 140
 141     app.add_directive('kernel-doc', KernelDocDirective)