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 #
  42 # AutodocReporter is only good up to Sphinx 1.7
  43 #
  44 import sphinx
  45
  46 Use_SSI = sphinx.__version__[:3] >= '1.7'
  47 if Use_SSI:
  48     from sphinx.util.docutils import switch_source_input
  49 else:
  50     from sphinx.ext.autodoc import AutodocReporter
  51
  52 import kernellog
  53
  54 __version__  = '1.0'
  55
  56 class KernelDocDirective(Directive):
  57     """Extract kernel-doc comments from the specified file"""
  58     required_argument = 1
  59     optional_arguments = 4
  60     option_spec = {
  61         'doc': directives.unchanged_required,
  62         'functions': directives.unchanged,
  63         'export': directives.unchanged,
  64         'internal': directives.unchanged,
  65     }
  66     has_content = False
  67
  68     def run(self):
  69         env = self.state.document.settings.env
  70         cmd = env.config.kerneldoc_bin + ['-rst', '-enable-lineno']
  71
  72         filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
  73         export_file_patterns = []
  74
  75         # Tell sphinx of the dependency
  76         env.note_dependency(os.path.abspath(filename))
  77
  78         # Disabled temporarily while scripts/kernel-doc is updated
  79         return []
  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             kernellog.verbose(env.app,
 109                               'calling kernel-doc \'%s\'' % (" ".join(cmd)))
 110
 111             p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 112             out, err = p.communicate()
 113
 114             out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
 115
 116             if p.returncode != 0:
 117                 sys.stderr.write(err)
 118
 119                 kernellog.warn(env.app,
 120                                'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
 121                 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 122             elif env.config.kerneldoc_verbosity > 0:
 123                 sys.stderr.write(err)
 124
 125             lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
 126             result = ViewList()
 127
 128             lineoffset = 0;
 129             line_regex = re.compile("^#define LINENO ([0-9]+)$")
 130             for line in lines:
 131                 match = line_regex.search(line)
 132                 if match:
 133                     # sphinx counts lines from 0
 134                     lineoffset = int(match.group(1)) - 1
 135                     # we must eat our comments since the upset the markup
 136                 else:
 137                     result.append(line, filename, lineoffset)
 138                     lineoffset += 1
 139
 140             node = nodes.section()
 141             self.do_parse(result, node)
 142
 143             return node.children
 144
 145         except Exception as e:  # pylint: disable=W0703
 146             kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' %
 147                            (" ".join(cmd), str(e)))
 148             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 149
 150     def do_parse(self, result, node):
 151         if Use_SSI:
 152             with switch_source_input(self.state, result):
 153                 self.state.nested_parse(result, 0, node, match_titles=1)
 154         else:
 155             save = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
 156             self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
 157             self.state.memo.title_styles, self.state.memo.section_level = [], 0
 158             try:
 159                 self.state.nested_parse(result, 0, node, match_titles=1)
 160             finally:
 161                 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = save
 162
 163
 164 def setup(app):
 165     app.add_config_value('kerneldoc_bin', None, 'env')
 166     app.add_config_value('kerneldoc_srctree', None, 'env')
 167     app.add_config_value('kerneldoc_verbosity', 1, 'env')
 168
 169     app.add_directive('kernel-doc', KernelDocDirective)
 170
 171     return dict(
 172         version = __version__,
 173         parallel_read_safe = True,
 174         parallel_write_safe = True
 175     )