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