You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
77 lines
2.5 KiB
77 lines
2.5 KiB
8 months ago
|
from breathe.directives import BaseDirective
|
||
|
|
from breathe.file_state_cache import MTimeError
|
||
|
|
from breathe.project import ProjectError
|
||
|
|
from breathe.renderer.mask import NullMaskFactory
|
||
|
|
from breathe.renderer.target import create_target_handler
|
||
|
|
|
||
|
|
from docutils.nodes import Node
|
||
|
|
from docutils.parsers.rst.directives import unchanged_required, unchanged, flag
|
||
|
|
|
||
|
|
from typing import Any, List
|
||
|
|
|
||
|
|
|
||
|
|
class _DoxygenClassLikeDirective(BaseDirective):
|
||
|
|
required_arguments = 1
|
||
|
|
optional_arguments = 0
|
||
|
|
final_argument_whitespace = True
|
||
|
|
option_spec = {
|
||
|
|
"path": unchanged_required,
|
||
|
|
"project": unchanged_required,
|
||
|
|
"members": unchanged,
|
||
|
|
"membergroups": unchanged_required,
|
||
|
|
"members-only": flag,
|
||
|
|
"protected-members": flag,
|
||
|
|
"private-members": flag,
|
||
|
|
"undoc-members": flag,
|
||
|
|
"show": unchanged_required,
|
||
|
|
"outline": flag,
|
||
|
|
"no-link": flag,
|
||
|
|
"allow-dot-graphs": flag,
|
||
|
|
}
|
||
|
|
has_content = False
|
||
|
|
|
||
|
|
def run(self) -> List[Node]:
|
||
|
|
name = self.arguments[0]
|
||
|
|
|
||
|
|
try:
|
||
|
|
project_info = self.project_info_factory.create_project_info(self.options)
|
||
|
|
except ProjectError as e:
|
||
|
|
warning = self.create_warning(None, kind=self.kind)
|
||
|
|
return warning.warn("doxygen{kind}: %s" % e)
|
||
|
|
|
||
|
|
try:
|
||
|
|
finder = self.finder_factory.create_finder(project_info)
|
||
|
|
except MTimeError as e:
|
||
|
|
warning = self.create_warning(None, kind=self.kind)
|
||
|
|
return warning.warn("doxygen{kind}: %s" % e)
|
||
|
|
|
||
|
|
finder_filter = self.filter_factory.create_compound_finder_filter(name, self.kind)
|
||
|
|
|
||
|
|
# TODO: find a more specific type for the Doxygen nodes
|
||
|
|
matches: List[Any] = []
|
||
|
|
finder.filter_(finder_filter, matches)
|
||
|
|
|
||
|
|
if len(matches) == 0:
|
||
|
|
warning = self.create_warning(project_info, name=name, kind=self.kind)
|
||
|
|
return warning.warn('doxygen{kind}: Cannot find class "{name}" {tail}')
|
||
|
|
|
||
|
|
target_handler = create_target_handler(self.options, project_info, self.state.document)
|
||
|
|
filter_ = self.filter_factory.create_class_filter(name, self.options)
|
||
|
|
|
||
|
|
mask_factory = NullMaskFactory()
|
||
|
|
return self.render(
|
||
|
|
matches[0], project_info, filter_, target_handler, mask_factory, self.directive_args
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class DoxygenClassDirective(_DoxygenClassLikeDirective):
|
||
|
|
kind = "class"
|
||
|
|
|
||
|
|
|
||
|
|
class DoxygenStructDirective(_DoxygenClassLikeDirective):
|
||
|
|
kind = "struct"
|
||
|
|
|
||
|
|
|
||
|
|
class DoxygenInterfaceDirective(_DoxygenClassLikeDirective):
|
||
|
|
kind = "interface"
|