Merge remote-tracking branch 'remotes/cohuck-gitlab/tags/s390x-20210121' into staging
[qemu.git] / docs / sphinx / kerneldoc.py
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 #
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
51
52 import kernellog
53
54 __version__ = '1.0'
55
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,
62 'functions': directives.unchanged,
63 'export': directives.unchanged,
64 'internal': directives.unchanged,
65 }
66 has_content = False
67
68 def run(self):
69 env = self.state.document.settings.env
70 cmd = env.config.kerneldoc_bin + ['-rst', '-enable-lineno']
71
72 # Pass the version string to kernel-doc, as it needs to use a different
73 # dialect, depending what the C domain supports for each specific
74 # Sphinx versions
75 cmd += ['-sphinx-version', sphinx.__version__]
76
77 filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
78 export_file_patterns = []
79
80 # Tell sphinx of the dependency
81 env.note_dependency(os.path.abspath(filename))
82
83 tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
84
85 # FIXME: make this nicer and more robust against errors
86 if 'export' in self.options:
87 cmd += ['-export']
88 export_file_patterns = str(self.options.get('export')).split()
89 elif 'internal' in self.options:
90 cmd += ['-internal']
91 export_file_patterns = str(self.options.get('internal')).split()
92 elif 'doc' in self.options:
93 cmd += ['-function', str(self.options.get('doc'))]
94 elif 'functions' in self.options:
95 functions = self.options.get('functions').split()
96 if functions:
97 for f in functions:
98 cmd += ['-function', f]
99 else:
100 cmd += ['-no-doc-sections']
101
102 for pattern in export_file_patterns:
103 for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
104 env.note_dependency(os.path.abspath(f))
105 cmd += ['-export-file', f]
106
107 cmd += [filename]
108
109 try:
110 kernellog.verbose(env.app,
111 'calling kernel-doc \'%s\'' % (" ".join(cmd)))
112
113 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
114 out, err = p.communicate()
115
116 out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
117
118 if p.returncode != 0:
119 sys.stderr.write(err)
120
121 kernellog.warn(env.app,
122 'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
123 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
124 elif env.config.kerneldoc_verbosity > 0:
125 sys.stderr.write(err)
126
127 lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
128 result = ViewList()
129
130 lineoffset = 0;
131 line_regex = re.compile("^#define LINENO ([0-9]+)$")
132 for line in lines:
133 match = line_regex.search(line)
134 if match:
135 # sphinx counts lines from 0
136 lineoffset = int(match.group(1)) - 1
137 # we must eat our comments since the upset the markup
138 else:
139 result.append(line, filename, lineoffset)
140 lineoffset += 1
141
142 node = nodes.section()
143 self.do_parse(result, node)
144
145 return node.children
146
147 except Exception as e: # pylint: disable=W0703
148 kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' %
149 (" ".join(cmd), str(e)))
150 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
151
152 def do_parse(self, result, node):
153 if Use_SSI:
154 with switch_source_input(self.state, result):
155 self.state.nested_parse(result, 0, node, match_titles=1)
156 else:
157 save = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
158 self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
159 self.state.memo.title_styles, self.state.memo.section_level = [], 0
160 try:
161 self.state.nested_parse(result, 0, node, match_titles=1)
162 finally:
163 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = save
164
165
166 def setup(app):
167 app.add_config_value('kerneldoc_bin', None, 'env')
168 app.add_config_value('kerneldoc_srctree', None, 'env')
169 app.add_config_value('kerneldoc_verbosity', 1, 'env')
170
171 app.add_directive('kernel-doc', KernelDocDirective)
172
173 return dict(
174 version = __version__,
175 parallel_read_safe = True,
176 parallel_write_safe = True
177 )