]>
Commit | Line | Data |
---|---|---|
c56de1db JN |
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> | |
ba350185 JN |
26 | # |
27 | # Please make sure this works on both python2 and python3. | |
28 | # | |
c56de1db | 29 | |
86c0f046 | 30 | import codecs |
c56de1db JN |
31 | import os |
32 | import subprocess | |
33 | import sys | |
d90368f2 | 34 | import re |
03d35d9e | 35 | import glob |
c56de1db JN |
36 | |
37 | from docutils import nodes, statemachine | |
16e161c8 | 38 | from docutils.statemachine import ViewList |
ff690eee | 39 | from docutils.parsers.rst import directives, Directive |
2404dad1 JC |
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 | |
c56de1db | 51 | |
096ea522 JC |
52 | import kernellog |
53 | ||
b62b9d81 MH |
54 | __version__ = '1.0' |
55 | ||
c56de1db JN |
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, | |
03d35d9e JN |
62 | 'export': directives.unchanged, |
63 | 'internal': directives.unchanged, | |
36bc683d | 64 | 'identifiers': directives.unchanged, |
2791f47d | 65 | 'no-identifiers': directives.unchanged, |
36bc683d | 66 | 'functions': directives.unchanged, |
c56de1db JN |
67 | } |
68 | has_content = False | |
69 | ||
70 | def run(self): | |
71 | env = self.state.document.settings.env | |
d90368f2 | 72 | cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno'] |
c56de1db | 73 | |
93351d41 MCC |
74 | # Pass the version string to kernel-doc, as it needs to use a different |
75 | # dialect, depending what the C domain supports for each specific | |
76 | # Sphinx versions | |
77 | cmd += ['-sphinx-version', sphinx.__version__] | |
78 | ||
c56de1db | 79 | filename = env.config.kerneldoc_srctree + '/' + self.arguments[0] |
03d35d9e | 80 | export_file_patterns = [] |
c56de1db JN |
81 | |
82 | # Tell sphinx of the dependency | |
83 | env.note_dependency(os.path.abspath(filename)) | |
84 | ||
85 | tab_width = self.options.get('tab-width', self.state.document.settings.tab_width) | |
c56de1db | 86 | |
36bc683d CD |
87 | # 'function' is an alias of 'identifiers' |
88 | if 'functions' in self.options: | |
89 | self.options['identifiers'] = self.options.get('functions') | |
90 | ||
c56de1db JN |
91 | # FIXME: make this nicer and more robust against errors |
92 | if 'export' in self.options: | |
93 | cmd += ['-export'] | |
03d35d9e | 94 | export_file_patterns = str(self.options.get('export')).split() |
c56de1db JN |
95 | elif 'internal' in self.options: |
96 | cmd += ['-internal'] | |
03d35d9e | 97 | export_file_patterns = str(self.options.get('internal')).split() |
c56de1db JN |
98 | elif 'doc' in self.options: |
99 | cmd += ['-function', str(self.options.get('doc'))] | |
36bc683d CD |
100 | elif 'identifiers' in self.options: |
101 | identifiers = self.options.get('identifiers').split() | |
102 | if identifiers: | |
103 | for i in identifiers: | |
104 | cmd += ['-function', i] | |
f2e86036 MR |
105 | else: |
106 | cmd += ['-no-doc-sections'] | |
c56de1db | 107 | |
2791f47d MCC |
108 | if 'no-identifiers' in self.options: |
109 | no_identifiers = self.options.get('no-identifiers').split() | |
110 | if no_identifiers: | |
111 | for i in no_identifiers: | |
112 | cmd += ['-nosymbol', i] | |
113 | ||
03d35d9e JN |
114 | for pattern in export_file_patterns: |
115 | for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern): | |
116 | env.note_dependency(os.path.abspath(f)) | |
117 | cmd += ['-export-file', f] | |
118 | ||
c56de1db JN |
119 | cmd += [filename] |
120 | ||
121 | try: | |
096ea522 JC |
122 | kernellog.verbose(env.app, |
123 | 'calling kernel-doc \'%s\'' % (" ".join(cmd))) | |
c56de1db | 124 | |
86c0f046 | 125 | p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
c56de1db JN |
126 | out, err = p.communicate() |
127 | ||
86c0f046 | 128 | out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8') |
c56de1db JN |
129 | |
130 | if p.returncode != 0: | |
131 | sys.stderr.write(err) | |
132 | ||
096ea522 JC |
133 | kernellog.warn(env.app, |
134 | 'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode)) | |
c56de1db JN |
135 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] |
136 | elif env.config.kerneldoc_verbosity > 0: | |
137 | sys.stderr.write(err) | |
138 | ||
139 | lines = statemachine.string2lines(out, tab_width, convert_whitespace=True) | |
d90368f2 DV |
140 | result = ViewList() |
141 | ||
142 | lineoffset = 0; | |
143 | line_regex = re.compile("^#define LINENO ([0-9]+)$") | |
144 | for line in lines: | |
145 | match = line_regex.search(line) | |
146 | if match: | |
147 | # sphinx counts lines from 0 | |
148 | lineoffset = int(match.group(1)) - 1 | |
149 | # we must eat our comments since the upset the markup | |
150 | else: | |
91fc6d8a MCC |
151 | doc = env.srcdir + "/" + env.docname + ":" + str(self.lineno) |
152 | result.append(line, doc + ": " + filename, lineoffset) | |
d90368f2 | 153 | lineoffset += 1 |
16e161c8 DV |
154 | |
155 | node = nodes.section() | |
2404dad1 | 156 | self.do_parse(result, node) |
16e161c8 DV |
157 | |
158 | return node.children | |
159 | ||
f42ddca7 | 160 | except Exception as e: # pylint: disable=W0703 |
096ea522 JC |
161 | kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' % |
162 | (" ".join(cmd), str(e))) | |
c56de1db JN |
163 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] |
164 | ||
2404dad1 JC |
165 | def do_parse(self, result, node): |
166 | if Use_SSI: | |
167 | with switch_source_input(self.state, result): | |
168 | self.state.nested_parse(result, 0, node, match_titles=1) | |
169 | else: | |
170 | save = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter | |
171 | self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter) | |
172 | self.state.memo.title_styles, self.state.memo.section_level = [], 0 | |
173 | try: | |
174 | self.state.nested_parse(result, 0, node, match_titles=1) | |
175 | finally: | |
176 | self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = save | |
177 | ||
178 | ||
c56de1db JN |
179 | def setup(app): |
180 | app.add_config_value('kerneldoc_bin', None, 'env') | |
181 | app.add_config_value('kerneldoc_srctree', None, 'env') | |
182 | app.add_config_value('kerneldoc_verbosity', 1, 'env') | |
183 | ||
184 | app.add_directive('kernel-doc', KernelDocDirective) | |
b62b9d81 MH |
185 | |
186 | return dict( | |
187 | version = __version__, | |
188 | parallel_read_safe = True, | |
189 | parallel_write_safe = True | |
190 | ) |