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