Documentation/sphinx/cdomain.py

1 # -*- coding: utf-8; mode: python -*-
7     Replacement for the sphinx c-domain.
14     * Moved the *duplicate C object description* warnings for function
18     * Add option 'name' to the "c:function:" directive.  With option 'name' the
19       ref-name of a function can be modified. E.g.::
21           .. c:function:: int ioctl( int fd, int request )
24       The func-name (e.g. ioctl) remains in the output but the ref-name changed
25       from 'ioctl' to 'VIDIOC_LOG_STATUS'. The function is referenced by::
30      * Handle signatures of function-like macros well. Don't try to deduce
31        arguments types of function-like macros.
56 # - Store the namespace if ".. c:namespace::" tag is found
68 # Handle c:macro for function-style declaration
72     return ".. c:function:: " + match.group(1) + ' ' + match.group(2)
76 # backward-compatibility with Sphinx < 3.0
78 RE_ctype = re.compile(r'^\s*..\s*c:(struct|union|enum|enumerator|alias)::\s*(.*)$')
85 # backward-compatibility with Sphinx < 3.0
87 RE_ctype_refs = re.compile(r':c:(var|struct|union|enum|enumerator)::`([^\`]+)`')
99 # Parse Sphinx 3.x C markups, replacing them by backward-compatible ones
129     app.connect('source-read', c_markups)
152         u"""Handles signatures of function-like macros.
154         If the objtype is 'function' and the the signature ``sig`` is a
155         function-like macro, the name of the macro is returned. Otherwise
160         if not self.objtype == 'function':
181         # This is a function-like macro, it's arguments are typeless!
188             # separate by non-breaking space in the output
207             if self.objtype == 'function':
229                 if self.objtype == 'function':
241 …             # https://github.com/sphinx-doc/sphinx/commit/e6a5a3a92e938fcd75866b4227db9e0524d58f7c
254         'function': CObject,