Documentation/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         tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
  79
  80         # FIXME: make this nicer and more robust against errors
  81         if 'export' in self.options:
  82             cmd += ['-export']
  83             export_file_patterns = str(self.options.get('export')).split()
  84         elif 'internal' in self.options:
  85             cmd += ['-internal']
  86             export_file_patterns = str(self.options.get('internal')).split()
  87         elif 'doc' in self.options:
  88             cmd += ['-function', str(self.options.get('doc'))]
  89         elif 'functions' in self.options:
  90             functions = self.options.get('functions').split()
  91             if functions:
  92                 for f in functions:
  93                     cmd += ['-function', f]
  94             else:
  95                 cmd += ['-no-doc-sections']
  96
  97         for pattern in export_file_patterns:
  98             for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
  99                 env.note_dependency(os.path.abspath(f))
 100                 cmd += ['-export-file', f]
 101
 102         cmd += [filename]
 103
 104         try:
 105             kernellog.verbose(env.app,
 106                               'calling kernel-doc \'%s\'' % (" ".join(cmd)))
 107
 108             p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 109             out, err = p.communicate()
 110
 111             out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
 112
 113             if p.returncode != 0:
 114                 sys.stderr.write(err)
 115
 116                 kernellog.warn(env.app,
 117                                'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
 118                 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 119             elif env.config.kerneldoc_verbosity > 0:
 120                 sys.stderr.write(err)
 121
 122             lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
 123             result = ViewList()
 124
 125             lineoffset = 0;
 126             line_regex = re.compile("^#define LINENO ([0-9]+)$")
 127             for line in lines:
 128                 match = line_regex.search(line)
 129                 if match:
 130                     # sphinx counts lines from 0
 131                     lineoffset = int(match.group(1)) - 1
 132                     # we must eat our comments since the upset the markup
 133                 else:
 134                     result.append(line, filename, lineoffset)
 135                     lineoffset += 1
 136
 137             node = nodes.section()
 138             self.do_parse(result, node)
 139
 140             return node.children
 141
 142         except Exception as e:  # pylint: disable=W0703
 143             kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' %
 144                            (" ".join(cmd), str(e)))
 145             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 146
 147     def do_parse(self, result, node):
 148         if Use_SSI:
 149             with switch_source_input(self.state, result):
 150                 self.state.nested_parse(result, 0, node, match_titles=1)
 151         else:
 152             save = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
 153             self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
 154             self.state.memo.title_styles, self.state.memo.section_level = [], 0
 155             try:
 156                 self.state.nested_parse(result, 0, node, match_titles=1)
 157             finally:
 158                 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = save
 159
 160
 161 def setup(app):
 162     app.add_config_value('kerneldoc_bin', None, 'env')
 163     app.add_config_value('kerneldoc_srctree', None, 'env')
 164     app.add_config_value('kerneldoc_verbosity', 1, 'env')
 165
 166     app.add_directive('kernel-doc', KernelDocDirective)
 167
 168     return dict(
 169         version = __version__,
 170         parallel_read_safe = True,
 171         parallel_write_safe = True
 172     )