89 lines
3.0 KiB
Python
89 lines
3.0 KiB
Python
|
|
||
|
|
from ..renderer.rst.doxygen.base import RenderContext
|
||
|
|
from ..renderer.rst.doxygen import format_parser_error
|
||
|
|
from ..parser import ParserError, FileIOError
|
||
|
|
|
||
|
|
from docutils import nodes
|
||
|
|
from docutils.parsers import rst
|
||
|
|
|
||
|
|
|
||
|
|
class WarningHandler(object):
|
||
|
|
|
||
|
|
def __init__(self, state, context):
|
||
|
|
self.state = state
|
||
|
|
self.context = context
|
||
|
|
|
||
|
|
def warn(self, raw_text, rendered_nodes=None):
|
||
|
|
raw_text = self.format(raw_text)
|
||
|
|
if rendered_nodes is None:
|
||
|
|
rendered_nodes = [nodes.paragraph("", "", nodes.Text(raw_text))]
|
||
|
|
return [
|
||
|
|
nodes.warning("", *rendered_nodes),
|
||
|
|
self.state.document.reporter.warning(raw_text, line=self.context['lineno'])
|
||
|
|
]
|
||
|
|
|
||
|
|
def format(self, text):
|
||
|
|
return text.format(**self.context)
|
||
|
|
|
||
|
|
|
||
|
|
def create_warning(project_info, state, lineno, **kwargs):
|
||
|
|
|
||
|
|
tail = ''
|
||
|
|
if project_info:
|
||
|
|
tail = 'in doxygen xml output for project "{project}" from directory: {path}'.format(
|
||
|
|
project=project_info.name(),
|
||
|
|
path=project_info.project_path()
|
||
|
|
)
|
||
|
|
|
||
|
|
context = dict(
|
||
|
|
lineno=lineno,
|
||
|
|
tail=tail,
|
||
|
|
**kwargs
|
||
|
|
)
|
||
|
|
|
||
|
|
return WarningHandler(state, context)
|
||
|
|
|
||
|
|
|
||
|
|
class BaseDirective(rst.Directive):
|
||
|
|
|
||
|
|
def __init__(self, root_data_object, renderer_factory_creator_constructor, finder_factory,
|
||
|
|
project_info_factory, filter_factory, target_handler_factory, parser_factory, *args):
|
||
|
|
rst.Directive.__init__(self, *args)
|
||
|
|
self.directive_args = list(args) # Convert tuple to list to allow modification.
|
||
|
|
|
||
|
|
self.root_data_object = root_data_object
|
||
|
|
self.renderer_factory_creator_constructor = renderer_factory_creator_constructor
|
||
|
|
self.finder_factory = finder_factory
|
||
|
|
self.project_info_factory = project_info_factory
|
||
|
|
self.filter_factory = filter_factory
|
||
|
|
self.target_handler_factory = target_handler_factory
|
||
|
|
self.parser_factory = parser_factory
|
||
|
|
|
||
|
|
def render(self, node_stack, project_info, options, filter_, target_handler, mask_factory):
|
||
|
|
"Standard render process used by subclasses"
|
||
|
|
|
||
|
|
renderer_factory_creator = self.renderer_factory_creator_constructor.create_factory_creator(
|
||
|
|
project_info,
|
||
|
|
self.state.document,
|
||
|
|
options,
|
||
|
|
target_handler
|
||
|
|
)
|
||
|
|
|
||
|
|
try:
|
||
|
|
renderer_factory = renderer_factory_creator.create_factory(
|
||
|
|
node_stack,
|
||
|
|
self.state,
|
||
|
|
self.state.document,
|
||
|
|
filter_,
|
||
|
|
target_handler,
|
||
|
|
)
|
||
|
|
except ParserError as e:
|
||
|
|
return format_parser_error("doxygenclass", e.error, e.filename, self.state,
|
||
|
|
self.lineno, True)
|
||
|
|
except FileIOError as e:
|
||
|
|
return format_parser_error("doxygenclass", e.error, e.filename, self.state, self.lineno)
|
||
|
|
|
||
|
|
context = RenderContext(node_stack, mask_factory, self.directive_args)
|
||
|
|
object_renderer = renderer_factory.create_renderer(context)
|
||
|
|
return object_renderer.render()
|