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.
75 lines
3.0 KiB
75 lines
3.0 KiB
8 months ago
|
from breathe.finder import ItemFinder, stack
|
||
|
|
from breathe.renderer.filter import Filter, FilterFactory
|
||
|
|
from breathe.parser import DoxygenCompoundParser
|
||
|
|
|
||
|
|
from sphinx.application import Sphinx
|
||
|
|
|
||
|
|
from typing import Any, List
|
||
|
|
|
||
|
|
|
||
|
|
class DoxygenTypeSubItemFinder(ItemFinder):
|
||
|
|
def filter_(self, ancestors, filter_: Filter, matches) -> None:
|
||
|
|
"""Find nodes which match the filter. Doesn't test this node, only its children"""
|
||
|
|
|
||
|
|
compounds = self.data_object.get_compound()
|
||
|
|
node_stack = stack(self.data_object, ancestors)
|
||
|
|
for compound in compounds:
|
||
|
|
compound_finder = self.item_finder_factory.create_finder(compound)
|
||
|
|
compound_finder.filter_(node_stack, filter_, matches)
|
||
|
|
|
||
|
|
|
||
|
|
class CompoundTypeSubItemFinder(ItemFinder):
|
||
|
|
def __init__(self, app: Sphinx, compound_parser: DoxygenCompoundParser, *args):
|
||
|
|
super().__init__(*args)
|
||
|
|
|
||
|
|
self.filter_factory = FilterFactory(app)
|
||
|
|
self.compound_parser = compound_parser
|
||
|
|
|
||
|
|
def filter_(self, ancestors, filter_: Filter, matches) -> None:
|
||
|
|
"""Finds nodes which match the filter and continues checks to children
|
||
|
|
|
||
|
|
Requires parsing the xml files referenced by the children for which we use the compound
|
||
|
|
parser and continue at the top level of that pretending that this node is the parent of the
|
||
|
|
top level node of the compound file.
|
||
|
|
"""
|
||
|
|
|
||
|
|
node_stack = stack(self.data_object, ancestors)
|
||
|
|
|
||
|
|
# Match against compound object
|
||
|
|
if filter_.allow(node_stack):
|
||
|
|
matches.append(node_stack)
|
||
|
|
|
||
|
|
# Descend to member children
|
||
|
|
members = self.data_object.get_member()
|
||
|
|
# TODO: find a more precise type for the Doxygen nodes
|
||
|
|
member_matches: List[Any] = []
|
||
|
|
for member in members:
|
||
|
|
member_finder = self.item_finder_factory.create_finder(member)
|
||
|
|
member_finder.filter_(node_stack, filter_, member_matches)
|
||
|
|
|
||
|
|
# If there are members in this compound that match the criteria
|
||
|
|
# then load up the file for this compound and get the member data objects
|
||
|
|
if member_matches:
|
||
|
|
file_data = self.compound_parser.parse(self.data_object.refid)
|
||
|
|
finder = self.item_finder_factory.create_finder(file_data)
|
||
|
|
|
||
|
|
for member_stack in member_matches:
|
||
|
|
ref_filter = self.filter_factory.create_id_filter(
|
||
|
|
"memberdef", member_stack[0].refid
|
||
|
|
)
|
||
|
|
finder.filter_(node_stack, ref_filter, matches)
|
||
|
|
else:
|
||
|
|
# Read in the xml file referenced by the compound and descend into that as well
|
||
|
|
file_data = self.compound_parser.parse(self.data_object.refid)
|
||
|
|
finder = self.item_finder_factory.create_finder(file_data)
|
||
|
|
finder.filter_(node_stack, filter_, matches)
|
||
|
|
|
||
|
|
|
||
|
|
class MemberTypeSubItemFinder(ItemFinder):
|
||
|
|
def filter_(self, ancestors, filter_: Filter, matches) -> None:
|
||
|
|
node_stack = stack(self.data_object, ancestors)
|
||
|
|
|
||
|
|
# Match against member object
|
||
|
|
if filter_.allow(node_stack):
|
||
|
|
matches.append(node_stack)
|