mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
829a5150da
Specifically, support for the following has been added: * rvalue reference for *this * volatile * override keyword support Additionally support for '= default' and '= delete' has been added. Several tests have also been added to test_cpp_domain.py to insure that these features actually work.
158 lines
4.8 KiB
Python
158 lines
4.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
test_cpp_domain
|
|
~~~~~~~~~~~~~~~
|
|
|
|
Tests the C++ Domain
|
|
|
|
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
from util import raises
|
|
|
|
from sphinx.domains.cpp import DefinitionParser, DefinitionError
|
|
|
|
|
|
def parse(name, string):
|
|
return getattr(DefinitionParser(string), 'parse_' + name)()
|
|
|
|
|
|
def test_type_definitions():
|
|
rv = parse('member_object', ' const std::string & name = 42')
|
|
assert unicode(rv) == 'const std::string& name = 42'
|
|
|
|
rv = parse('member_object', ' const std::string & name leftover')
|
|
assert unicode(rv) == 'const std::string& name'
|
|
|
|
rv = parse('member_object', ' const std::string & name [n] leftover')
|
|
assert unicode(rv) == 'const std::string& name[n]'
|
|
|
|
rv = parse('member_object', 'const std::vector< unsigned int, long> &name')
|
|
assert unicode(rv) == 'const std::vector<unsigned int, long>& name'
|
|
|
|
x = 'std::vector<std::pair<std::string, int>>& module::test(register ' \
|
|
'foo, bar, std::string baz="foobar, blah, bleh") const = 0'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'module::myclass::operator std::vector<std::string>()'
|
|
assert unicode(parse('function', x)) == x
|
|
x = 'explicit module::myclass::foo::foo()'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int printf(const char* fmt, ...)'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int foo(const unsigned int j)'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int foo(const unsigned int const j)'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int foo(const int* const ptr)'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'std::vector<std::pair<std::string, long long>> module::blah'
|
|
assert unicode(parse('type_object', x)) == x
|
|
|
|
assert unicode(parse('type_object', 'long long int foo')) == 'long long foo'
|
|
|
|
x = 'void operator()(const boost::array<VertexID, 2>& v) const'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'void operator()(const boost::array<VertexID, 2, "foo, bar">& v) const'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::MyClass(MyClass::MyClass&&)'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'constexpr int get_value()'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'static constexpr int get_value()'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int get_value() const noexcept'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int get_value() const noexcept = delete'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::MyClass(MyClass::MyClass&&) = default'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::a_virtual_function() const override'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::a_member_function() volatile'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::a_member_function() const volatile'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::a_member_function() &&'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::a_member_function() &'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'MyClass::a_member_function() const &'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int main(int argc, char* argv[][])'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'std::vector<std::pair<std::string, int>>& module::test(register ' \
|
|
'foo, bar[n], std::string baz="foobar, blah, bleh") const = 0'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'module::myclass foo[n]'
|
|
assert unicode(parse('member_object', x)) == x
|
|
|
|
x = 'int foo(Foo f=Foo(double(), std::make_pair(int(2), double(3.4))))'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int foo(A a=x(a))'
|
|
assert unicode(parse('function', x)) == x
|
|
|
|
x = 'int foo(B b=x(a)'
|
|
raises(DefinitionError, parse, 'function', x)
|
|
|
|
x = 'int foo)C c=x(a))'
|
|
raises(DefinitionError, parse, 'function', x)
|
|
|
|
x = 'int foo(D d=x(a'
|
|
raises(DefinitionError, parse, 'function', x)
|
|
|
|
|
|
def test_bases():
|
|
x = 'A'
|
|
assert unicode(parse('class', x)) == x
|
|
|
|
x = 'A : B'
|
|
assert unicode(parse('class', x)) == x
|
|
|
|
x = 'A : private B'
|
|
assert unicode(parse('class', x)) == 'A : B'
|
|
|
|
x = 'A : public B'
|
|
assert unicode(parse('class', x)) == x
|
|
|
|
x = 'A : B, C'
|
|
assert unicode(parse('class', x)) == x
|
|
|
|
x = 'A : B, protected C, D'
|
|
assert unicode(parse('class', x)) == x
|
|
|
|
|
|
def test_operators():
|
|
x = parse('function', 'void operator new [ ] ()')
|
|
assert unicode(x) == 'void operator new[]()'
|
|
|
|
x = parse('function', 'void operator delete ()')
|
|
assert unicode(x) == 'void operator delete()'
|
|
|
|
for op in '*-+=/%!':
|
|
x = parse('function', 'void operator %s ()' % op)
|
|
assert unicode(x) == 'void operator%s()' % op
|