Documentation/sphinx/cdomain.py

1 # -*- coding: utf-8; mode: python -*-
7     Replacement for the sphinx c-domain.
16       the config values for ``nitpick`` and ``nitpick_ignore``.
19       ref-name of a function can be modified. E.g.::
24       The func-name (e.g. ioctl) remains in the output but the ref-name changed
30      * Handle signatures of function-like macros well. Don't try to deduce
31        arguments types of function-like macros.
44 import re
53 # - Store the namespace if ".. c:namespace::" tag is found
55 RE_namespace = re.compile(r'^\s*..\s*c:namespace::\s*(\S+)\s*$')
65 # Handle c:macro for function-style declaration
67 RE_macro = re.compile(r'^\s*..\s*c:macro::\s*(\S+)\s+(\S.*)\s*$')
73 # backward-compatibility with Sphinx < 3.0
75 RE_ctype = re.compile(r'^\s*..\s*c:(struct|union|enum|enumerator|alias)::\s*(.*)$')
82 # backward-compatibility with Sphinx < 3.0
84 RE_ctype_refs = re.compile(r':c:(var|struct|union|enum|enumerator)::`([^\`]+)`')
91 RE_expr = re.compile(r':c:(expr|texpr):`([^\`]+)`')
96 # Parse Sphinx 3.x C markups, replacing them by backward-compatible ones
113             n = n[:m.start()] + markup_func[m.re](m) + n[m.end():]
126     app.connect('source-read', c_markups)
145         """Handles signatures of function-like macros.
148         function-like macro, the name of the macro is returned. Otherwise
174         # This is a function-like macro, its arguments are typeless!
181             # separate by non-breaking space in the output
221             if (name in inv and self.env.config.nitpicky):
223                     if ('c:func', name) not in self.env.config.nitpick_ignore: