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