blob: f6920c0af6ee6e1f0137211376a5a08c9566b88a [file] [log] [blame]
Jani Nikulac56de1d2016-05-18 23:30:30 +03001# 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>
Jani Nikulaba350182016-05-31 18:09:12 +030026#
27# Please make sure this works on both python2 and python3.
28#
Jani Nikulac56de1d2016-05-18 23:30:30 +030029
30import os
31import subprocess
32import sys
Daniel Vetterd90368f2016-06-03 22:21:35 +020033import re
Jani Nikula03d35d92016-06-07 12:13:56 +030034import glob
Jani Nikulac56de1d2016-05-18 23:30:30 +030035
36from docutils import nodes, statemachine
Daniel Vetter16e161c2016-06-02 14:59:18 +020037from docutils.statemachine import ViewList
Jani Nikulac56de1d2016-05-18 23:30:30 +030038from docutils.parsers.rst import directives
39from sphinx.util.compat import Directive
Markus Heiserf42ddca2016-07-20 12:38:58 +020040from sphinx.ext.autodoc import AutodocReporter
Jani Nikulac56de1d2016-05-18 23:30:30 +030041
42class KernelDocDirective(Directive):
43 """Extract kernel-doc comments from the specified file"""
44 required_argument = 1
45 optional_arguments = 4
46 option_spec = {
47 'doc': directives.unchanged_required,
48 'functions': directives.unchanged_required,
Jani Nikula03d35d92016-06-07 12:13:56 +030049 'export': directives.unchanged,
50 'internal': directives.unchanged,
Jani Nikulac56de1d2016-05-18 23:30:30 +030051 }
52 has_content = False
53
54 def run(self):
55 env = self.state.document.settings.env
Daniel Vetterd90368f2016-06-03 22:21:35 +020056 cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
Jani Nikulac56de1d2016-05-18 23:30:30 +030057
58 filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
Jani Nikula03d35d92016-06-07 12:13:56 +030059 export_file_patterns = []
Jani Nikulac56de1d2016-05-18 23:30:30 +030060
61 # Tell sphinx of the dependency
62 env.note_dependency(os.path.abspath(filename))
63
64 tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
Jani Nikulac56de1d2016-05-18 23:30:30 +030065
66 # FIXME: make this nicer and more robust against errors
67 if 'export' in self.options:
68 cmd += ['-export']
Jani Nikula03d35d92016-06-07 12:13:56 +030069 export_file_patterns = str(self.options.get('export')).split()
Jani Nikulac56de1d2016-05-18 23:30:30 +030070 elif 'internal' in self.options:
71 cmd += ['-internal']
Jani Nikula03d35d92016-06-07 12:13:56 +030072 export_file_patterns = str(self.options.get('internal')).split()
Jani Nikulac56de1d2016-05-18 23:30:30 +030073 elif 'doc' in self.options:
74 cmd += ['-function', str(self.options.get('doc'))]
75 elif 'functions' in self.options:
Jani Nikula057de5c2016-06-08 10:25:40 +030076 for f in str(self.options.get('functions')).split():
Jani Nikulac56de1d2016-05-18 23:30:30 +030077 cmd += ['-function', f]
78
Jani Nikula03d35d92016-06-07 12:13:56 +030079 for pattern in export_file_patterns:
80 for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern):
81 env.note_dependency(os.path.abspath(f))
82 cmd += ['-export-file', f]
83
Jani Nikulac56de1d2016-05-18 23:30:30 +030084 cmd += [filename]
85
86 try:
87 env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
88
89 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
90 out, err = p.communicate()
91
Jani Nikulaba350182016-05-31 18:09:12 +030092 # python2 needs conversion to unicode.
93 # python3 with universal_newlines=True returns strings.
94 if sys.version_info.major < 3:
95 out, err = unicode(out, 'utf-8'), unicode(err, 'utf-8')
Jani Nikulac56de1d2016-05-18 23:30:30 +030096
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)
Daniel Vetterd90368f2016-06-03 22:21:35 +0200106 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:
Jani Nikula06173fe2016-06-08 13:38:28 +0300117 result.append(line, filename, lineoffset)
Daniel Vetterd90368f2016-06-03 22:21:35 +0200118 lineoffset += 1
Daniel Vetter16e161c2016-06-02 14:59:18 +0200119
120 node = nodes.section()
Markus Heiserf42ddca2016-07-20 12:38:58 +0200121 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
Daniel Vetter16e161c2016-06-02 14:59:18 +0200128
129 return node.children
130
Markus Heiserf42ddca2016-07-20 12:38:58 +0200131 except Exception as e: # pylint: disable=W0703
Jani Nikulac56de1d2016-05-18 23:30:30 +0300132 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)