223 lines
7.8 KiB
Python
223 lines
7.8 KiB
Python
# useful references:
|
|
# https://www.sphinx-doc.org/en/master/extdev/appapi.html
|
|
# https://www.sphinx-doc.org/en/master/development/tutorials/recipe.html
|
|
# https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#rst-directives
|
|
|
|
import logging
|
|
import os
|
|
from typing import List, Optional, Type
|
|
|
|
import docutils.nodes as nodes
|
|
from docutils.nodes import Node
|
|
import docutils.parsers.rst.directives as rst_directives
|
|
import sphinx
|
|
import sphinx.addnodes as addnodes
|
|
import sphinx.directives
|
|
from sphinx.util.docutils import SphinxDirective
|
|
from sphinx.util.nodes import process_index_entry
|
|
|
|
import dfhack.util
|
|
|
|
|
|
|
|
logger = sphinx.util.logging.getLogger(__name__)
|
|
|
|
|
|
def get_label_class(builder: sphinx.builders.Builder) -> Type[nodes.Inline]:
|
|
if builder.format == 'text':
|
|
return nodes.inline
|
|
else:
|
|
return nodes.strong
|
|
|
|
def make_labeled_paragraph(label: Optional[str]=None, content: Optional[str]=None,
|
|
label_class=nodes.strong, content_class=nodes.inline) -> nodes.paragraph:
|
|
p = nodes.paragraph('', '')
|
|
if label is not None:
|
|
p += [
|
|
label_class('', '{}:'.format(label)),
|
|
nodes.inline('', ' '),
|
|
]
|
|
if content is not None:
|
|
p += content_class('', content)
|
|
return p
|
|
|
|
def make_summary(builder: sphinx.builders.Builder, summary: str) -> nodes.paragraph:
|
|
para = nodes.paragraph('', '')
|
|
if builder.format == 'text':
|
|
# It might be clearer to block indent instead of just indenting the
|
|
# first line, but this is clearer than nothing.
|
|
para += nodes.inline(text=' ')
|
|
para += nodes.inline(text=summary)
|
|
return para
|
|
|
|
def make_index(directive: SphinxDirective, name: str, summary: str) -> List[Node]:
|
|
targetid = 'index-%s' % directive.env.new_serialno('index')
|
|
targetnode = nodes.target('', '', ids=[targetid])
|
|
directive.state.document.note_explicit_target(targetnode)
|
|
indexnode = addnodes.index()
|
|
indexnode['entries'] = []
|
|
indexnode['inline'] = False
|
|
directive.set_source_info(indexnode)
|
|
entry_text = 'single: {}; {}'.format(name, summary)
|
|
indexnode['entries'].extend(process_index_entry(entry_text, targetnode['ids'][0]))
|
|
return [indexnode, targetnode]
|
|
|
|
_KEYBINDS = {}
|
|
_KEYBINDS_RENDERED = set() # commands whose keybindings have been rendered
|
|
|
|
def scan_keybinds(root, files, keybindings):
|
|
"""Add keybindings in the specified files to the
|
|
given keybindings dict.
|
|
"""
|
|
for file in files:
|
|
with open(os.path.join(root, file)) as f:
|
|
lines = [l.replace('keybinding add', '').strip() for l in f.readlines()
|
|
if l.startswith('keybinding add')]
|
|
for k in lines:
|
|
first, command = k.split(' ', 1)
|
|
bind, context = (first.split('@') + [''])[:2]
|
|
if ' ' not in command:
|
|
command = command.replace('"', '')
|
|
tool = command.split(' ')[0].replace('"', '')
|
|
keybindings[tool] = keybindings.get(tool, []) + [
|
|
(command, bind.split('-'), context)]
|
|
|
|
def scan_all_keybinds(root_dir):
|
|
"""Get the implemented keybinds, and return a dict of
|
|
{tool: [(full_command, keybinding, context), ...]}.
|
|
"""
|
|
keybindings = dict()
|
|
for root, _, files in os.walk(root_dir):
|
|
scan_keybinds(root, files, keybindings)
|
|
return keybindings
|
|
|
|
|
|
def render_dfhack_keybind(command, builder: sphinx.builders.Builder) -> List[nodes.paragraph]:
|
|
_KEYBINDS_RENDERED.add(command)
|
|
out = []
|
|
if command not in _KEYBINDS:
|
|
return out
|
|
for keycmd, key, ctx in _KEYBINDS[command]:
|
|
n = make_labeled_paragraph('Keybinding', label_class=get_label_class(builder))
|
|
for k in key:
|
|
if builder.format == 'text':
|
|
k = '[{}]'.format(k)
|
|
n += nodes.inline(k, k, classes=['kbd'])
|
|
if keycmd != command:
|
|
n += nodes.inline(' -> ', ' -> ')
|
|
n += nodes.literal(keycmd, keycmd, classes=['guilabel'])
|
|
if ctx:
|
|
n += nodes.inline(' in ', ' in ')
|
|
n += nodes.literal(ctx, ctx)
|
|
out.append(n)
|
|
return out
|
|
|
|
|
|
def check_missing_keybinds():
|
|
# FIXME: _KEYBINDS_RENDERED is empty in the parent process under parallel builds
|
|
# consider moving to a sphinx Domain to solve this properly
|
|
for missing_command in sorted(set(_KEYBINDS.keys()) - _KEYBINDS_RENDERED):
|
|
logger.warning('Undocumented keybindings for command: %s', missing_command)
|
|
|
|
|
|
class DFHackToolDirectiveBase(sphinx.directives.ObjectDescription):
|
|
has_content = False
|
|
required_arguments = 0
|
|
optional_arguments = 1
|
|
|
|
def get_name_or_docname(self):
|
|
if self.arguments:
|
|
return self.arguments[0]
|
|
else:
|
|
parts = self.env.docname.split('/')
|
|
if 'tools' in parts:
|
|
return '/'.join(parts[parts.index('tools') + 1:])
|
|
else:
|
|
return parts[-1]
|
|
|
|
@staticmethod
|
|
def wrap_box(*children: List[nodes.Node]) -> nodes.Admonition:
|
|
return nodes.topic('', *children, classes=['dfhack-tool-summary'])
|
|
|
|
def make_labeled_paragraph(self, *args, **kwargs):
|
|
# convenience wrapper to set label_class to the desired builder-specific node type
|
|
kwargs.setdefault('label_class', get_label_class(self.env.app.builder))
|
|
return make_labeled_paragraph(*args, **kwargs)
|
|
|
|
def render_content(self) -> List[nodes.Node]:
|
|
raise NotImplementedError
|
|
|
|
def run(self):
|
|
return [self.wrap_box(*self.render_content())]
|
|
|
|
|
|
class DFHackToolDirective(DFHackToolDirectiveBase):
|
|
option_spec = {
|
|
'tags': dfhack.util.directive_arg_str_list,
|
|
'no-command': rst_directives.flag,
|
|
'summary': rst_directives.unchanged,
|
|
}
|
|
|
|
def render_content(self) -> List[nodes.Node]:
|
|
tag_paragraph = self.make_labeled_paragraph('Tags')
|
|
for tag in self.options.get('tags', []):
|
|
tag_paragraph += [
|
|
addnodes.pending_xref(tag, nodes.inline(text=tag), **{
|
|
'reftype': 'ref',
|
|
'refdomain': 'std',
|
|
'reftarget': 'tag/' + tag,
|
|
'refexplicit': False,
|
|
'refwarn': True,
|
|
}),
|
|
nodes.inline(text=' | '),
|
|
]
|
|
tag_paragraph.pop()
|
|
|
|
ret_nodes = [tag_paragraph]
|
|
if 'no-command' in self.options:
|
|
ret_nodes += make_index(self, self.get_name_or_docname() + ' (plugin)', self.options.get('summary', ''))
|
|
ret_nodes += [make_summary(self.env.app.builder, self.options.get('summary', ''))]
|
|
return ret_nodes
|
|
|
|
def run(self):
|
|
out = DFHackToolDirectiveBase.run(self)
|
|
if 'no-command' not in self.options:
|
|
out += [self.wrap_box(*DFHackCommandDirective.render_content(self))]
|
|
return out
|
|
|
|
|
|
class DFHackCommandDirective(DFHackToolDirectiveBase):
|
|
option_spec = {
|
|
'summary': rst_directives.unchanged_required,
|
|
}
|
|
|
|
def render_content(self) -> List[nodes.Node]:
|
|
command = self.get_name_or_docname()
|
|
ret_nodes = [self.make_labeled_paragraph('Command', command, content_class=nodes.literal)]
|
|
ret_nodes += make_index(self, command, self.options.get('summary', ''))
|
|
ret_nodes += [
|
|
make_summary(self.env.app.builder, self.options.get('summary', '')),
|
|
*render_dfhack_keybind(command, builder=self.env.app.builder),
|
|
]
|
|
return ret_nodes
|
|
|
|
|
|
def register(app):
|
|
app.add_directive('dfhack-tool', DFHackToolDirective)
|
|
app.add_directive('dfhack-command', DFHackCommandDirective)
|
|
|
|
_KEYBINDS.update(scan_all_keybinds(os.path.join(dfhack.util.DFHACK_ROOT, 'data', 'init')))
|
|
|
|
|
|
def setup(app):
|
|
app.connect('builder-inited', register)
|
|
|
|
# TODO: re-enable once detection is corrected
|
|
# app.connect('build-finished', lambda *_: check_missing_keybinds())
|
|
|
|
return {
|
|
'version': '0.1',
|
|
'parallel_read_safe': True,
|
|
'parallel_write_safe': True,
|
|
}
|