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