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
40import sphinx
41from sphinx.util.docutils import switch_source_input
42from sphinx.util import logging
43
44__version__  = '1.0'
45
46class KernelDocDirective(Directive):
47    """Extract kernel-doc comments from the specified file"""
48    required_argument = 1
49    optional_arguments = 4
50    option_spec = {
51        'doc': directives.unchanged_required,
52        'export': directives.unchanged,
53        'internal': directives.unchanged,
54        'identifiers': directives.unchanged,
55        'no-identifiers': directives.unchanged,
56        'functions': directives.unchanged,
57    }
58    has_content = False
59    logger = logging.getLogger('kerneldoc')
60
61    def run(self):
62        env = self.state.document.settings.env
63        cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
64
65        filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
66        export_file_patterns = []
67
68        # Tell sphinx of the dependency
69        env.note_dependency(os.path.abspath(filename))
70
71        tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
72
73        # 'function' is an alias of 'identifiers'
74        if 'functions' in self.options:
75            self.options['identifiers'] = self.options.get('functions')
76
77        # FIXME: make this nicer and more robust against errors
78        if 'export' in self.options:
79            cmd += ['-export']
80            export_file_patterns = str(self.options.get('export')).split()
81        elif 'internal' in self.options:
82            cmd += ['-internal']
83            export_file_patterns = str(self.options.get('internal')).split()
84        elif 'doc' in self.options:
85            cmd += ['-function', str(self.options.get('doc'))]
86        elif 'identifiers' in self.options:
87            identifiers = self.options.get('identifiers').split()
88            if identifiers:
89                for i in identifiers:
90                    cmd += ['-function', i]
91            else:
92                cmd += ['-no-doc-sections']
93
94        if 'no-identifiers' in self.options:
95            no_identifiers = self.options.get('no-identifiers').split()
96            if no_identifiers:
97                for i in no_identifiers:
98                    cmd += ['-nosymbol', i]
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            self.logger.verbose("calling kernel-doc '%s'" % (" ".join(cmd)))
109
110            p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
111            out, err = p.communicate()
112
113            out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
114
115            if p.returncode != 0:
116                sys.stderr.write(err)
117
118                self.logger.warning("kernel-doc '%s' failed with return code %d"
119                                    % (" ".join(cmd), p.returncode))
120                return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
121            elif env.config.kerneldoc_verbosity > 0:
122                sys.stderr.write(err)
123
124            lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
125            result = ViewList()
126
127            lineoffset = 0;
128            line_regex = re.compile(r"^\.\. LINENO ([0-9]+)$")
129            for line in lines:
130                match = line_regex.search(line)
131                if match:
132                    # sphinx counts lines from 0
133                    lineoffset = int(match.group(1)) - 1
134                    # we must eat our comments since the upset the markup
135                else:
136                    doc = str(env.srcdir) + "/" + env.docname + ":" + str(self.lineno)
137                    result.append(line, doc + ": " + 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            self.logger.warning("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        with switch_source_input(self.state, result):
152            self.state.nested_parse(result, 0, node, match_titles=1)
153
154def setup(app):
155    app.add_config_value('kerneldoc_bin', None, 'env')
156    app.add_config_value('kerneldoc_srctree', None, 'env')
157    app.add_config_value('kerneldoc_verbosity', 1, 'env')
158
159    app.add_directive('kernel-doc', KernelDocDirective)
160
161    return dict(
162        version = __version__,
163        parallel_read_safe = True,
164        parallel_write_safe = True
165    )
166