Loading...
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 os
31import subprocess
32import sys
33import re
34import glob
35
36from docutils import nodes, statemachine
37from docutils.statemachine import ViewList
38from docutils.parsers.rst import directives
39from sphinx.util.compat import 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_required,
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 for f in str(self.options.get('functions')).split():
79 cmd += ['-function', f]
80
81 for pattern in export_file_patterns:
82 for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
83 env.note_dependency(os.path.abspath(f))
84 cmd += ['-export-file', f]
85
86 cmd += [filename]
87
88 try:
89 env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
90
91 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
92 out, err = p.communicate()
93
94 # python2 needs conversion to unicode.
95 # python3 with universal_newlines=True returns strings.
96 if sys.version_info.major < 3:
97 out, err = unicode(out, 'utf-8'), unicode(err, 'utf-8')
98
99 if p.returncode != 0:
100 sys.stderr.write(err)
101
102 env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
103 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
104 elif env.config.kerneldoc_verbosity > 0:
105 sys.stderr.write(err)
106
107 lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
108 result = ViewList()
109
110 lineoffset = 0;
111 line_regex = re.compile("^#define LINENO ([0-9]+)$")
112 for line in lines:
113 match = line_regex.search(line)
114 if match:
115 # sphinx counts lines from 0
116 lineoffset = int(match.group(1)) - 1
117 # we must eat our comments since the upset the markup
118 else:
119 result.append(line, filename, lineoffset)
120 lineoffset += 1
121
122 node = nodes.section()
123 buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
124 self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
125 self.state.memo.title_styles, self.state.memo.section_level = [], 0
126 try:
127 self.state.nested_parse(result, 0, node, match_titles=1)
128 finally:
129 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = buf
130
131 return node.children
132
133 except Exception as e: # pylint: disable=W0703
134 env.app.warn('kernel-doc \'%s\' processing failed with: %s' %
135 (" ".join(cmd), str(e)))
136 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
137
138def setup(app):
139 app.add_config_value('kerneldoc_bin', None, 'env')
140 app.add_config_value('kerneldoc_srctree', None, 'env')
141 app.add_config_value('kerneldoc_verbosity', 1, 'env')
142
143 app.add_directive('kernel-doc', KernelDocDirective)
144
145 return dict(
146 version = __version__,
147 parallel_read_safe = True,
148 parallel_write_safe = True
149 )
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_required,
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 for f in str(self.options.get('functions')).split():
79 cmd += ['-function', f]
80
81 for pattern in export_file_patterns:
82 for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
83 env.note_dependency(os.path.abspath(f))
84 cmd += ['-export-file', f]
85
86 cmd += [filename]
87
88 try:
89 env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
90
91 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
92 out, err = p.communicate()
93
94 out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
95
96 if p.returncode != 0:
97 sys.stderr.write(err)
98
99 env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
100 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
101 elif env.config.kerneldoc_verbosity > 0:
102 sys.stderr.write(err)
103
104 lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
105 result = ViewList()
106
107 lineoffset = 0;
108 line_regex = re.compile("^#define LINENO ([0-9]+)$")
109 for line in lines:
110 match = line_regex.search(line)
111 if match:
112 # sphinx counts lines from 0
113 lineoffset = int(match.group(1)) - 1
114 # we must eat our comments since the upset the markup
115 else:
116 result.append(line, filename, lineoffset)
117 lineoffset += 1
118
119 node = nodes.section()
120 buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
121 self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter)
122 self.state.memo.title_styles, self.state.memo.section_level = [], 0
123 try:
124 self.state.nested_parse(result, 0, node, match_titles=1)
125 finally:
126 self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = buf
127
128 return node.children
129
130 except Exception as e: # pylint: disable=W0703
131 env.app.warn('kernel-doc \'%s\' processing failed with: %s' %
132 (" ".join(cmd), str(e)))
133 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
134
135def setup(app):
136 app.add_config_value('kerneldoc_bin', None, 'env')
137 app.add_config_value('kerneldoc_srctree', None, 'env')
138 app.add_config_value('kerneldoc_verbosity', 1, 'env')
139
140 app.add_directive('kernel-doc', KernelDocDirective)
141
142 return dict(
143 version = __version__,
144 parallel_read_safe = True,
145 parallel_write_safe = True
146 )