docs/sphinx/kerneldoc.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 codecs
  31 import os
  32 import subprocess
  33 import sys
  34 import re
  35 import glob
  36
  37 from docutils import nodes, statemachine
  38 from docutils.statemachine import ViewList
  39 from docutils.parsers.rst import directives, Directive
  40
  41 import sphinx
  42 from sphinx.util import logging
  43 from sphinx.util.docutils import switch_source_input
  44
  45
  46 __version__  = '1.0'
  47 logger = logging.getLogger('kerneldoc')
  48
  49
  50 class KernelDocDirective(Directive):
  51     """Extract kernel-doc comments from the specified file"""
  52     required_argument = 1
  53     optional_arguments = 4
  54     option_spec = {
  55         'doc': directives.unchanged_required,
  56         'functions': directives.unchanged,
  57         'export': directives.unchanged,
  58         'internal': directives.unchanged,
  59     }
  60     has_content = False
  61
  62     def run(self):
  63         env = self.state.document.settings.env
  64         cmd = env.config.kerneldoc_bin + ['-rst', '-enable-lineno']
  65
  66         # Pass the version string to kernel-doc, as it needs to use a different
  67         # dialect, depending what the C domain supports for each specific
  68         # Sphinx versions
  69         cmd += ['-sphinx-version', sphinx.__version__]
  70
  71         # Pass through the warnings-as-errors flag
  72         if env.config.kerneldoc_werror:
  73             cmd += ['-Werror']
  74
  75         filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
  76         export_file_patterns = []
  77
  78         # Tell sphinx of the dependency
  79         env.note_dependency(os.path.abspath(filename))
  80
  81         tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
  82
  83         # FIXME: make this nicer and more robust against errors
  84         if 'export' in self.options:
  85             cmd += ['-export']
  86             export_file_patterns = str(self.options.get('export')).split()
  87         elif 'internal' in self.options:
  88             cmd += ['-internal']
  89             export_file_patterns = str(self.options.get('internal')).split()
  90         elif 'doc' in self.options:
  91             cmd += ['-function', str(self.options.get('doc'))]
  92         elif 'functions' in self.options:
  93             functions = self.options.get('functions').split()
  94             if functions:
  95                 for f in functions:
  96                     cmd += ['-function', f]
  97             else:
  98                 cmd += ['-no-doc-sections']
  99
 100         for pattern in export_file_patterns:
 101             for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
 102                 env.note_dependency(os.path.abspath(f))
 103                 cmd += ['-export-file', f]
 104
 105         cmd += [filename]
 106
 107         try:
 108             logger.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
 109
 110             p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 111             out, err = p.communicate()
 112
 113             out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
 114
 115             if p.returncode != 0:
 116                 sys.stderr.write(err)
 117
 118                 logger.warning(
 119                     'kernel-doc \'%s\' failed with return code %d' %
 120                     (" ".join(cmd), p.returncode)
 121                 )
 122                 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 123             elif env.config.kerneldoc_verbosity > 0:
 124                 sys.stderr.write(err)
 125
 126             lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
 127             result = ViewList()
 128
 129             lineoffset = 0;
 130             line_regex = re.compile("^#define LINENO ([0-9]+)$")
 131             for line in lines:
 132                 match = line_regex.search(line)
 133                 if match:
 134                     # sphinx counts lines from 0
 135                     lineoffset = int(match.group(1)) - 1
 136                     # we must eat our comments since the upset the markup
 137                 else:
 138                     result.append(line, filename, lineoffset)
 139                     lineoffset += 1
 140
 141             node = nodes.section()
 142             self.do_parse(result, node)
 143
 144             return node.children
 145
 146         except Exception as e:  # pylint: disable=W0703
 147             logger.warning('kernel-doc \'%s\' processing failed with: %s' %
 148                            (" ".join(cmd), str(e)))
 149             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 150
 151     def do_parse(self, result, node):
 152         with switch_source_input(self.state, result):
 153             self.state.nested_parse(result, 0, node, match_titles=1)
 154
 155
 156 def setup(app):
 157     app.add_config_value('kerneldoc_bin', None, 'env')
 158     app.add_config_value('kerneldoc_srctree', None, 'env')
 159     app.add_config_value('kerneldoc_verbosity', 1, 'env')
 160     app.add_config_value('kerneldoc_werror', 0, 'env')
 161
 162     app.add_directive('kernel-doc', KernelDocDirective)
 163
 164     return dict(
 165         version = __version__,
 166         parallel_read_safe = True,
 167         parallel_write_safe = True
 168     )