IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1705 from jakobandersen/cpp-declspecs-on-right

Browse Source 
C++, fix #1689
This commit is contained in:
Georg Brandl 2015-02-04 06:37:13 +01:00
commit 3068f6c7f1
2 changed files with 100 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

159
sphinx/domains/cpp.py
View File

@ -688,11 +688,8 @@ class ASTParametersQualifiers(ASTBase):
_add_text(signode, '= ' + text_type(self.initializer))
class ASTDeclSpecs(ASTBase):
def __init__(self, outer, visibility, storage, inline, virtual, explicit,
constexpr, volatile, const, trailing):
self.outer = outer
self.visibility = visibility
class ASTDeclSpecsSimple(ASTBase):
def __init__(self, storage, inline, virtual, explicit, constexpr, volatile, const):
self.storage = storage
self.inline = inline
self.virtual = virtual
@ -700,31 +697,9 @@ class ASTDeclSpecs(ASTBase):
self.constexpr = constexpr
self.volatile = volatile
self.const = const
self.trailingTypeSpec = trailing
@property
def name(self):
return self.trailingTypeSpec.name
def get_id(self):
res = []
if self.volatile:
res.append('V')
if self.const:
res.append('K')
res.append(self.trailingTypeSpec.get_id())
return u''.join(res)
def _print_visibility(self):
return (self.visibility and
not (
self.outer in ('type', 'member', 'function') and
self.visibility == 'public'))
def __unicode__(self):
res = []
if self._print_visibility():
res.append(self.visibility)
if self.storage:
res.append(self.storage)
if self.inline:
@ -739,21 +714,13 @@ class ASTDeclSpecs(ASTBase):
res.append('volatile')
if self.const:
res.append('const')
if self.trailingTypeSpec:
res.append(text_type(self.trailingTypeSpec))
return u' '.join(res)
def describe_signature(self, signode, mode, env):
_verify_description_mode(mode)
modifiers = []
def describe_signature(self, modifiers):
def _add(modifiers, text):
if len(modifiers) > 0:
modifiers.append(nodes.Text(' '))
modifiers.append(addnodes.desc_annotation(text, text))
if self._print_visibility():
_add(modifiers, self.visibility)
if self.storage:
_add(modifiers, self.storage)
if self.inline:
@ -768,13 +735,79 @@ class ASTDeclSpecs(ASTBase):
_add(modifiers, 'volatile')
if self.const:
_add(modifiers, 'const')
class ASTDeclSpecs(ASTBase):
def __init__(self, outer, visibility, leftSpecs, rightSpecs, trailing):
self.outer = outer
self.visibility = visibility
self.leftSpecs = leftSpecs
self.rightSpecs = rightSpecs
self.trailingTypeSpec = trailing
@property
def name(self):
return self.trailingTypeSpec.name
def get_id(self):
res = []
if self.leftSpecs.volatile or self.rightSpecs.volatile:
res.append('V')
if self.leftSpecs.const or self.rightSpecs.volatile:
res.append('K')
res.append(self.trailingTypeSpec.get_id())
return u''.join(res)
def _print_visibility(self):
return (self.visibility and
not (
self.outer in ('type', 'member', 'function') and
self.visibility == 'public'))
def __unicode__(self):
res = []
if self._print_visibility():
res.append(self.visibility)
l = text_type(self.leftSpecs)
if len(l) > 0:
if len(res) > 0:
res.append(" ")
res.append(l)
if self.trailingTypeSpec:
if len(res) > 0:
res.append(" ")
res.append(text_type(self.trailingTypeSpec))
r = text_type(self.rightSpecs)
if len(r) > 0:
if len(res) > 0:
res.append(" ")
res.append(r)
return "".join(res)
def describe_signature(self, signode, mode, env):
_verify_description_mode(mode)
modifiers = []
def _add(modifiers, text):
if len(modifiers) > 0:
modifiers.append(nodes.Text(' '))
modifiers.append(addnodes.desc_annotation(text, text))
if self._print_visibility():
_add(modifiers, self.visibility)
self.leftSpecs.describe_signature(modifiers)
for m in modifiers:
signode += m
if self.trailingTypeSpec:
if len(modifiers) > 0:
signode += nodes.Text(' ')
self.trailingTypeSpec.describe_signature(signode, mode, env)
modifiers = []
self.rightSpecs.describe_signature(modifiers)
if len(modifiers) > 0:
signode += nodes.Text(' ')
for m in modifiers:
signode += m
class ASTPtrOpPtr(ASTBase):
def __init__(self, volatile, const):
@ -952,7 +985,6 @@ class ASTType(ASTBase):
signode += nodes.Text(' ')
self.decl.describe_signature(signode, mode, env)
class ASTTypeWithInit(ASTBase):
def __init__(self, type, init):
self.objectType = None
@ -1337,20 +1369,8 @@ class DefinitionParser(object):
args, volatile, const, refQual, exceptionSpec, override, final,
initializer)
def _parse_decl_specs(self, outer, typed=True):
"""
visibility storage-class-specifier function-specifier "constexpr"
"volatile" "const" trailing-type-specifier
storage-class-specifier -> "static" (only for member_object and
function_object)
function-specifier -> "inline" | "virtual" | "explicit" (only for
function_object)
"constexpr" (only for member_object and function_object)
"""
visibility = None
def _parse_decl_specs_simple(self, outer, typed):
"""Just parse the simple ones."""
storage = None
inline = None
virtual = None
@ -1358,12 +1378,6 @@ class DefinitionParser(object):
constexpr = None
volatile = None
const = None
if outer:
self.skip_ws()
if self.match(_visibility_re):
visibility = self.matched_text
while 1: # accept any permutation of a subset of some decl-specs
self.skip_ws()
if not storage:
@ -1409,14 +1423,37 @@ class DefinitionParser(object):
if const:
continue
break
return ASTDeclSpecsSimple(storage, inline, virtual, explicit, constexpr,
volatile, const)
def _parse_decl_specs(self, outer, typed=True):
"""
visibility storage-class-specifier function-specifier "constexpr"
"volatile" "const" trailing-type-specifier
storage-class-specifier -> "static" (only for member_object and
function_object)
function-specifier -> "inline" | "virtual" | "explicit" (only for
function_object)
"constexpr" (only for member_object and function_object)
"""
visibility = None
leftSepcs = None
rightSpecs = None
if outer:
self.skip_ws()
if self.match(_visibility_re):
visibility = self.matched_text
leftSpecs = self._parse_decl_specs_simple(outer, typed)
if typed:
trailing = self._parse_trailing_type_spec()
rightSpecs = self._parse_decl_specs_simple(outer, typed)
else:
trailing = None
return ASTDeclSpecs(
outer, visibility, storage, inline, virtual, explicit, constexpr,
volatile, const, trailing)
return ASTDeclSpecs(outer, visibility, leftSpecs, rightSpecs, trailing)
def _parse_declerator(self, named, paramMode=None, typed=True):
if paramMode:

2
tests/test_domain_cpp.py
View File

@ -62,6 +62,8 @@ def test_type_definitions():
check("type",
"public MyContainer::const_iterator",
"MyContainer::const_iterator")
# test decl specs on right
check("type", "bool const b")
check('member',
' const std::string & name = 42',