1""" 2QAPI domain extension. 3""" 4 5from __future__ import annotations 6 7from typing import ( 8 TYPE_CHECKING, 9 AbstractSet, 10 Any, 11 Dict, 12 Iterable, 13 List, 14 NamedTuple, 15 Optional, 16 Tuple, 17 cast, 18) 19 20from docutils import nodes 21from docutils.parsers.rst import directives 22 23from compat import KeywordNode, SpaceNode 24from sphinx import addnodes 25from sphinx.addnodes import desc_signature, pending_xref 26from sphinx.directives import ObjectDescription 27from sphinx.domains import ( 28 Domain, 29 Index, 30 IndexEntry, 31 ObjType, 32) 33from sphinx.locale import _, __ 34from sphinx.roles import XRefRole 35from sphinx.util import logging 36from sphinx.util.docfields import Field, GroupedField, TypedField 37from sphinx.util.nodes import make_id, make_refnode 38 39 40if TYPE_CHECKING: 41 from docutils.nodes import Element, Node 42 43 from sphinx.application import Sphinx 44 from sphinx.builders import Builder 45 from sphinx.environment import BuildEnvironment 46 from sphinx.util.typing import OptionSpec 47 48logger = logging.getLogger(__name__) 49 50 51class ObjectEntry(NamedTuple): 52 docname: str 53 node_id: str 54 objtype: str 55 aliased: bool 56 57 58class QAPIXRefRole(XRefRole): 59 60 def process_link( 61 self, 62 env: BuildEnvironment, 63 refnode: Element, 64 has_explicit_title: bool, 65 title: str, 66 target: str, 67 ) -> tuple[str, str]: 68 refnode["qapi:module"] = env.ref_context.get("qapi:module") 69 70 # Cross-references that begin with a tilde adjust the title to 71 # only show the reference without a leading module, even if one 72 # was provided. This is a Sphinx-standard syntax; give it 73 # priority over QAPI-specific type markup below. 74 hide_module = False 75 if target.startswith("~"): 76 hide_module = True 77 target = target[1:] 78 79 # Type names that end with "?" are considered optional 80 # arguments and should be documented as such, but it's not 81 # part of the xref itself. 82 if target.endswith("?"): 83 refnode["qapi:optional"] = True 84 target = target[:-1] 85 86 # Type names wrapped in brackets denote lists. strip the 87 # brackets and remember to add them back later. 88 if target.startswith("[") and target.endswith("]"): 89 refnode["qapi:array"] = True 90 target = target[1:-1] 91 92 if has_explicit_title: 93 # Don't mess with the title at all if it was explicitly set. 94 # Explicit title syntax for references is e.g. 95 # :qapi:type:`target <explicit title>` 96 # and this explicit title overrides everything else here. 97 return title, target 98 99 title = target 100 if hide_module: 101 title = target.split(".")[-1] 102 103 return title, target 104 105 106# Alias for the return of handle_signature(), which is used in several places. 107# (In the Python domain, this is Tuple[str, str] instead.) 108Signature = str 109 110 111class QAPIDescription(ObjectDescription[Signature]): 112 """ 113 Generic QAPI description. 114 115 This is meant to be an abstract class, not instantiated 116 directly. This class handles the abstract details of indexing, the 117 TOC, and reference targets for QAPI descriptions. 118 """ 119 120 def handle_signature(self, sig: str, signode: desc_signature) -> Signature: 121 # Do nothing. The return value here is the "name" of the entity 122 # being documented; for QAPI, this is the same as the 123 # "signature", which is just a name. 124 125 # Normally this method must also populate signode with nodes to 126 # render the signature; here we do nothing instead - the 127 # subclasses will handle this. 128 return sig 129 130 def get_index_text(self, name: Signature) -> Tuple[str, str]: 131 """Return the text for the index entry of the object.""" 132 133 # NB: this is used for the global index, not the QAPI index. 134 return ("single", f"{name} (QMP {self.objtype})") 135 136 def add_target_and_index( 137 self, name: Signature, sig: str, signode: desc_signature 138 ) -> None: 139 # name is the return value of handle_signature. 140 # sig is the original, raw text argument to handle_signature. 141 # For QAPI, these are identical, currently. 142 143 assert self.objtype 144 145 # If we're documenting a module, don't include the module as 146 # part of the FQN. 147 modname = "" 148 if self.objtype != "module": 149 modname = self.options.get( 150 "module", self.env.ref_context.get("qapi:module") 151 ) 152 fullname = (modname + "." if modname else "") + name 153 154 node_id = make_id( 155 self.env, self.state.document, self.objtype, fullname 156 ) 157 signode["ids"].append(node_id) 158 159 self.state.document.note_explicit_target(signode) 160 domain = cast(QAPIDomain, self.env.get_domain("qapi")) 161 domain.note_object(fullname, self.objtype, node_id, location=signode) 162 163 if "no-index-entry" not in self.options: 164 arity, indextext = self.get_index_text(name) 165 assert self.indexnode is not None 166 if indextext: 167 self.indexnode["entries"].append( 168 (arity, indextext, node_id, "", None) 169 ) 170 171 def _object_hierarchy_parts( 172 self, sig_node: desc_signature 173 ) -> Tuple[str, ...]: 174 if "fullname" not in sig_node: 175 return () 176 modname = sig_node.get("module") 177 fullname = sig_node["fullname"] 178 179 if modname: 180 return (modname, *fullname.split(".")) 181 182 return tuple(fullname.split(".")) 183 184 def _toc_entry_name(self, sig_node: desc_signature) -> str: 185 # This controls the name in the TOC and on the sidebar. 186 187 # This is the return type of _object_hierarchy_parts(). 188 toc_parts = cast(Tuple[str, ...], sig_node.get("_toc_parts", ())) 189 if not toc_parts: 190 return "" 191 192 config = self.env.app.config 193 *parents, name = toc_parts 194 if config.toc_object_entries_show_parents == "domain": 195 return sig_node.get("fullname", name) 196 if config.toc_object_entries_show_parents == "hide": 197 return name 198 if config.toc_object_entries_show_parents == "all": 199 return ".".join(parents + [name]) 200 return "" 201 202 203class QAPIObject(QAPIDescription): 204 """ 205 Description of a generic QAPI object. 206 207 It's not used directly, but is instead subclassed by specific directives. 208 """ 209 210 # Inherit some standard options from Sphinx's ObjectDescription 211 option_spec: OptionSpec = ( # type:ignore[misc] 212 ObjectDescription.option_spec.copy() 213 ) 214 option_spec.update( 215 { 216 # Borrowed from the Python domain: 217 "module": directives.unchanged, # Override contextual module name 218 # These are QAPI originals: 219 "since": directives.unchanged, 220 } 221 ) 222 223 doc_field_types = [ 224 # :feat name: descr 225 GroupedField( 226 "feature", 227 label=_("Features"), 228 names=("feat",), 229 can_collapse=False, 230 ), 231 ] 232 233 def get_signature_prefix(self) -> List[nodes.Node]: 234 """Return a prefix to put before the object name in the signature.""" 235 assert self.objtype 236 return [ 237 KeywordNode("", self.objtype.title()), 238 SpaceNode(" "), 239 ] 240 241 def get_signature_suffix(self) -> List[nodes.Node]: 242 """Return a suffix to put after the object name in the signature.""" 243 ret: List[nodes.Node] = [] 244 245 if "since" in self.options: 246 ret += [ 247 SpaceNode(" "), 248 addnodes.desc_sig_element( 249 "", f"(Since: {self.options['since']})" 250 ), 251 ] 252 253 return ret 254 255 def handle_signature(self, sig: str, signode: desc_signature) -> Signature: 256 """ 257 Transform a QAPI definition name into RST nodes. 258 259 This method was originally intended for handling function 260 signatures. In the QAPI domain, however, we only pass the 261 definition name as the directive argument and handle everything 262 else in the content body with field lists. 263 264 As such, the only argument here is "sig", which is just the QAPI 265 definition name. 266 """ 267 modname = self.options.get( 268 "module", self.env.ref_context.get("qapi:module") 269 ) 270 271 signode["fullname"] = sig 272 signode["module"] = modname 273 sig_prefix = self.get_signature_prefix() 274 if sig_prefix: 275 signode += addnodes.desc_annotation( 276 str(sig_prefix), "", *sig_prefix 277 ) 278 signode += addnodes.desc_name(sig, sig) 279 signode += self.get_signature_suffix() 280 281 return sig 282 283 284class QAPICommand(QAPIObject): 285 """Description of a QAPI Command.""" 286 287 doc_field_types = QAPIObject.doc_field_types.copy() 288 doc_field_types.extend( 289 [ 290 # :arg TypeName ArgName: descr 291 TypedField( 292 "argument", 293 label=_("Arguments"), 294 names=("arg",), 295 can_collapse=False, 296 ), 297 # :error: descr 298 Field( 299 "error", 300 label=_("Errors"), 301 names=("error", "errors"), 302 has_arg=False, 303 ), 304 ] 305 ) 306 307 308class QAPIModule(QAPIDescription): 309 """ 310 Directive to mark description of a new module. 311 312 This directive doesn't generate any special formatting, and is just 313 a pass-through for the content body. Named section titles are 314 allowed in the content body. 315 316 Use this directive to create entries for the QAPI module in the 317 global index and the QAPI index; as well as to associate subsequent 318 definitions with the module they are defined in for purposes of 319 search and QAPI index organization. 320 321 :arg: The name of the module. 322 :opt no-index: Don't add cross-reference targets or index entries. 323 :opt no-typesetting: Don't render the content body (but preserve any 324 cross-reference target IDs in the squelched output.) 325 326 Example:: 327 328 .. qapi:module:: block-core 329 :no-index: 330 :no-typesetting: 331 332 Lorem ipsum, dolor sit amet ... 333 """ 334 335 def run(self) -> List[Node]: 336 modname = self.arguments[0].strip() 337 self.env.ref_context["qapi:module"] = modname 338 ret = super().run() 339 340 # ObjectDescription always creates a visible signature bar. We 341 # want module items to be "invisible", however. 342 343 # Extract the content body of the directive: 344 assert isinstance(ret[-1], addnodes.desc) 345 desc_node = ret.pop(-1) 346 assert isinstance(desc_node.children[1], addnodes.desc_content) 347 ret.extend(desc_node.children[1].children) 348 349 # Re-home node_ids so anchor refs still work: 350 node_ids: List[str] 351 if node_ids := [ 352 node_id 353 for el in desc_node.children[0].traverse(nodes.Element) 354 for node_id in cast(List[str], el.get("ids", ())) 355 ]: 356 target_node = nodes.target(ids=node_ids) 357 ret.insert(1, target_node) 358 359 return ret 360 361 362class QAPIIndex(Index): 363 """ 364 Index subclass to provide the QAPI definition index. 365 """ 366 367 # pylint: disable=too-few-public-methods 368 369 name = "index" 370 localname = _("QAPI Index") 371 shortname = _("QAPI Index") 372 373 def generate( 374 self, 375 docnames: Optional[Iterable[str]] = None, 376 ) -> Tuple[List[Tuple[str, List[IndexEntry]]], bool]: 377 assert isinstance(self.domain, QAPIDomain) 378 content: Dict[str, List[IndexEntry]] = {} 379 collapse = False 380 381 # list of all object (name, ObjectEntry) pairs, sorted by name 382 # (ignoring the module) 383 objects = sorted( 384 self.domain.objects.items(), 385 key=lambda x: x[0].split(".")[-1].lower(), 386 ) 387 388 for objname, obj in objects: 389 if docnames and obj.docname not in docnames: 390 continue 391 392 # Strip the module name out: 393 objname = objname.split(".")[-1] 394 395 # Add an alphabetical entry: 396 entries = content.setdefault(objname[0].upper(), []) 397 entries.append( 398 IndexEntry( 399 objname, 0, obj.docname, obj.node_id, obj.objtype, "", "" 400 ) 401 ) 402 403 # Add a categorical entry: 404 category = obj.objtype.title() + "s" 405 entries = content.setdefault(category, []) 406 entries.append( 407 IndexEntry(objname, 0, obj.docname, obj.node_id, "", "", "") 408 ) 409 410 # alphabetically sort categories; type names first, ABC entries last. 411 sorted_content = sorted( 412 content.items(), 413 key=lambda x: (len(x[0]) == 1, x[0]), 414 ) 415 return sorted_content, collapse 416 417 418class QAPIDomain(Domain): 419 """QAPI language domain.""" 420 421 name = "qapi" 422 label = "QAPI" 423 424 # This table associates cross-reference object types (key) with an 425 # ObjType instance, which defines the valid cross-reference roles 426 # for each object type. 427 object_types: Dict[str, ObjType] = { 428 "module": ObjType(_("module"), "mod", "any"), 429 "command": ObjType(_("command"), "cmd", "any"), 430 } 431 432 # Each of these provides a rST directive, 433 # e.g. .. qapi:module:: block-core 434 directives = { 435 "module": QAPIModule, 436 "command": QAPICommand, 437 } 438 439 # These are all cross-reference roles; e.g. 440 # :qapi:cmd:`query-block`. The keys correlate to the names used in 441 # the object_types table values above. 442 roles = { 443 "mod": QAPIXRefRole(), 444 "cmd": QAPIXRefRole(), 445 "any": QAPIXRefRole(), # reference *any* type of QAPI object. 446 } 447 448 # Moved into the data property at runtime; 449 # this is the internal index of reference-able objects. 450 initial_data: Dict[str, Dict[str, Tuple[Any]]] = { 451 "objects": {}, # fullname -> ObjectEntry 452 } 453 454 # Index pages to generate; each entry is an Index class. 455 indices = [ 456 QAPIIndex, 457 ] 458 459 @property 460 def objects(self) -> Dict[str, ObjectEntry]: 461 ret = self.data.setdefault("objects", {}) 462 return ret # type: ignore[no-any-return] 463 464 def note_object( 465 self, 466 name: str, 467 objtype: str, 468 node_id: str, 469 aliased: bool = False, 470 location: Any = None, 471 ) -> None: 472 """Note a QAPI object for cross reference.""" 473 if name in self.objects: 474 other = self.objects[name] 475 if other.aliased and aliased is False: 476 # The original definition found. Override it! 477 pass 478 elif other.aliased is False and aliased: 479 # The original definition is already registered. 480 return 481 else: 482 # duplicated 483 logger.warning( 484 __( 485 "duplicate object description of %s, " 486 "other instance in %s, use :no-index: for one of them" 487 ), 488 name, 489 other.docname, 490 location=location, 491 ) 492 self.objects[name] = ObjectEntry( 493 self.env.docname, node_id, objtype, aliased 494 ) 495 496 def clear_doc(self, docname: str) -> None: 497 for fullname, obj in list(self.objects.items()): 498 if obj.docname == docname: 499 del self.objects[fullname] 500 501 def merge_domaindata( 502 self, docnames: AbstractSet[str], otherdata: Dict[str, Any] 503 ) -> None: 504 for fullname, obj in otherdata["objects"].items(): 505 if obj.docname in docnames: 506 # Sphinx's own python domain doesn't appear to bother to 507 # check for collisions. Assert they don't happen and 508 # we'll fix it if/when the case arises. 509 assert fullname not in self.objects, ( 510 "bug - collision on merge?" 511 f" {fullname=} {obj=} {self.objects[fullname]=}" 512 ) 513 self.objects[fullname] = obj 514 515 def find_obj( 516 self, modname: str, name: str, typ: Optional[str] 517 ) -> list[tuple[str, ObjectEntry]]: 518 """ 519 Find a QAPI object for "name", perhaps using the given module. 520 521 Returns a list of (name, object entry) tuples. 522 523 :param modname: The current module context (if any!) 524 under which we are searching. 525 :param name: The name of the x-ref to resolve; 526 may or may not include a leading module. 527 :param type: The role name of the x-ref we're resolving, if provided. 528 (This is absent for "any" lookups.) 529 """ 530 if not name: 531 return [] 532 533 names: list[str] = [] 534 matches: list[tuple[str, ObjectEntry]] = [] 535 536 fullname = name 537 if "." in fullname: 538 # We're searching for a fully qualified reference; 539 # ignore the contextual module. 540 pass 541 elif modname: 542 # We're searching for something from somewhere; 543 # try searching the current module first. 544 # e.g. :qapi:cmd:`query-block` or `query-block` is being searched. 545 fullname = f"{modname}.{name}" 546 547 if typ is None: 548 # type isn't specified, this is a generic xref. 549 # search *all* qapi-specific object types. 550 objtypes: List[str] = list(self.object_types) 551 else: 552 # type is specified and will be a role (e.g. obj, mod, cmd) 553 # convert this to eligible object types (e.g. command, module) 554 # using the QAPIDomain.object_types table. 555 objtypes = self.objtypes_for_role(typ, []) 556 557 if name in self.objects and self.objects[name].objtype in objtypes: 558 names = [name] 559 elif ( 560 fullname in self.objects 561 and self.objects[fullname].objtype in objtypes 562 ): 563 names = [fullname] 564 else: 565 # exact match wasn't found; e.g. we are searching for 566 # `query-block` from a different (or no) module. 567 searchname = "." + name 568 names = [ 569 oname 570 for oname in self.objects 571 if oname.endswith(searchname) 572 and self.objects[oname].objtype in objtypes 573 ] 574 575 matches = [(oname, self.objects[oname]) for oname in names] 576 if len(matches) > 1: 577 matches = [m for m in matches if not m[1].aliased] 578 return matches 579 580 def resolve_xref( 581 self, 582 env: BuildEnvironment, 583 fromdocname: str, 584 builder: Builder, 585 typ: str, 586 target: str, 587 node: pending_xref, 588 contnode: Element, 589 ) -> nodes.reference | None: 590 modname = node.get("qapi:module") 591 matches = self.find_obj(modname, target, typ) 592 593 if not matches: 594 return None 595 596 if len(matches) > 1: 597 logger.warning( 598 __("more than one target found for cross-reference %r: %s"), 599 target, 600 ", ".join(match[0] for match in matches), 601 type="ref", 602 subtype="qapi", 603 location=node, 604 ) 605 606 name, obj = matches[0] 607 return make_refnode( 608 builder, fromdocname, obj.docname, obj.node_id, contnode, name 609 ) 610 611 def resolve_any_xref( 612 self, 613 env: BuildEnvironment, 614 fromdocname: str, 615 builder: Builder, 616 target: str, 617 node: pending_xref, 618 contnode: Element, 619 ) -> List[Tuple[str, nodes.reference]]: 620 results: List[Tuple[str, nodes.reference]] = [] 621 matches = self.find_obj(node.get("qapi:module"), target, None) 622 for name, obj in matches: 623 rolename = self.role_for_objtype(obj.objtype) 624 assert rolename is not None 625 role = f"qapi:{rolename}" 626 refnode = make_refnode( 627 builder, fromdocname, obj.docname, obj.node_id, contnode, name 628 ) 629 results.append((role, refnode)) 630 return results 631 632 633def setup(app: Sphinx) -> Dict[str, Any]: 634 app.setup_extension("sphinx.directives") 635 app.add_domain(QAPIDomain) 636 637 return { 638 "version": "1.0", 639 "env_version": 1, 640 "parallel_read_safe": True, 641 "parallel_write_safe": True, 642 } 643