From nobody Fri Apr 4 23:28:31 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1741146516; cv=none; d=zohomail.com; s=zohoarc; b=ftuRXjo0HUAm5MUqEAJCOm8x+QWdvb9cItCuHKiirtlzABdaF+dh7qXZwro/Cefo9PrJoZ09tGvPxZmwzUuFfr+SI5/7as/8ZsSKvq/ZSbvLmwzhoz1KJlkoQaci0IcHq36kIKRmrSKpnBp/gc1xQ42x85Gy2SNo5LEkU6ugeBs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1741146516; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=TxlPGnoKNgS3wVCveAZcb9oK5G1y9jJIDGz+TMmNLUQ=; b=lqHI2aAx3sv4MNnrgnkZsaGx1mS+OycSZBahCwi74PE9sF6cdNhxTmNfUGakHF1a4Ai4s1STlX5X+jsAK9QEwFiuQJO4MkWtEnOWmOkYfqRv807U89YAz1tGe1d/+laI6TZjiPaBBBCXlM+8yZe2Jzm3nZeEX/dNtViLAfaOtac= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 17411465168671021.4840821180873; Tue, 4 Mar 2025 19:48:36 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tpfil-0005Ql-2q; Tue, 04 Mar 2025 22:46:59 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tpfik-0005QW-38 for qemu-devel@nongnu.org; Tue, 04 Mar 2025 22:46:58 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tpfih-00064B-Bq for qemu-devel@nongnu.org; Tue, 04 Mar 2025 22:46:57 -0500 Received: from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-6-rOcaZGNcPSqQtfKHYeEhpA-1; Tue, 04 Mar 2025 22:46:44 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id DCDD61954234; Wed, 5 Mar 2025 03:46:42 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.80.45]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 046B81956095; Wed, 5 Mar 2025 03:46:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741146412; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=TxlPGnoKNgS3wVCveAZcb9oK5G1y9jJIDGz+TMmNLUQ=; b=eOSBlFz0cWWKhKWtlzIQGffj7LTV80FWdw98DcWtfpaKHNrqzdrkEMHXKAj8IQg5Ayna84 xUoNUJdQDqmt6QnPXjb98CNnyLTHLWwZk+Lrs6lGZX9J3YLThSR2AVC5j6VTCP9Flzgc/K Xtix+CvJ9EuJuoRAih0NbbBE9o3xcHc= X-MC-Unique: rOcaZGNcPSqQtfKHYeEhpA-1 X-Mimecast-MFC-AGG-ID: rOcaZGNcPSqQtfKHYeEhpA_1741146403 From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Peter Maydell , Thomas Huth , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , John Snow Subject: [PATCH 08/57] docs/qapi-domain: add resolve_any_xref() Date: Tue, 4 Mar 2025 22:45:17 -0500 Message-ID: <20250305034610.960147-9-jsnow@redhat.com> In-Reply-To: <20250305034610.960147-1-jsnow@redhat.com> References: <20250305034610.960147-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1741146517139019000 Content-Type: text/plain; charset="utf-8" Add the ability to resolve cross-references using the `any` cross-reference syntax. Adding QAPI-specific cross-reference roles will be added in a forthcoming commit, and will share the same find_obj() helper. (There's less code needed for the generic cross-reference resolver, so it comes first in this series.) Once again, this code is based very heavily on sphinx.domains.python. Signed-off-by: John Snow --- docs/sphinx/qapi_domain.py | 98 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 94 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py index 716a38a5f00..744956045e8 100644 --- a/docs/sphinx/qapi_domain.py +++ b/docs/sphinx/qapi_domain.py @@ -23,6 +23,7 @@ =20 from compat import nested_parse from sphinx import addnodes +from sphinx.addnodes import pending_xref from sphinx.domains import ( Domain, Index, @@ -32,13 +33,15 @@ from sphinx.locale import _, __ from sphinx.util import logging from sphinx.util.docutils import SphinxDirective -from sphinx.util.nodes import make_id +from sphinx.util.nodes import make_id, make_refnode =20 =20 if TYPE_CHECKING: from docutils.nodes import Element, Node =20 from sphinx.application import Sphinx + from sphinx.builders import Builder + from sphinx.environment import BuildEnvironment from sphinx.util.typing import OptionSpec =20 logger =3D logging.getLogger(__name__) @@ -285,9 +288,96 @@ def merge_domaindata( ) self.objects[fullname] =3D obj =20 - def resolve_any_xref(self, *args: Any, **kwargs: Any) -> Any: - # pylint: disable=3Dunused-argument - return [] + def find_obj( + self, modname: str, name: str, typ: Optional[str] + ) -> list[tuple[str, ObjectEntry]]: + """ + Find a QAPI object for "name", perhaps using the given module. + + Returns a list of (name, object entry) tuples. + + :param modname: The current module context (if any!) + under which we are searching. + :param name: The name of the x-ref to resolve; + may or may not include a leading module. + :param type: The role name of the x-ref we're resolving, if provid= ed. + (This is absent for "any" lookups.) + """ + if not name: + return [] + + names: list[str] =3D [] + matches: list[tuple[str, ObjectEntry]] =3D [] + + fullname =3D name + if "." in fullname: + # We're searching for a fully qualified reference; + # ignore the contextual module. + pass + elif modname: + # We're searching for something from somewhere; + # try searching the current module first. + # e.g. :qapi:cmd:`query-block` or `query-block` is being searc= hed. + fullname =3D f"{modname}.{name}" + + if typ is None: + # type isn't specified, this is a generic xref. + # search *all* qapi-specific object types. + objtypes: Optional[List[str]] =3D list(self.object_types) + else: + # type is specified and will be a role (e.g. obj, mod, cmd) + # convert this to eligible object types (e.g. command, module) + # using the QAPIDomain.object_types table. + objtypes =3D self.objtypes_for_role(typ) + + # Either we should have been given no type, or the type we were + # given should correspond to at least one real actual object + # type. + assert objtypes + + if name in self.objects and self.objects[name].objtype in objtypes: + names =3D [name] + elif ( + fullname in self.objects + and self.objects[fullname].objtype in objtypes + ): + names =3D [fullname] + else: + # exact match wasn't found; e.g. we are searching for + # `query-block` from a different (or no) module. + searchname =3D "." + name + names =3D [ + oname + for oname in self.objects + if oname.endswith(searchname) + and self.objects[oname].objtype in objtypes + ] + + matches =3D [(oname, self.objects[oname]) for oname in names] + if len(matches) > 1: + matches =3D [m for m in matches if not m[1].aliased] + return matches + + def resolve_any_xref( + self, + env: BuildEnvironment, + fromdocname: str, + builder: Builder, + target: str, + node: pending_xref, + contnode: Element, + ) -> List[Tuple[str, nodes.reference]]: + results: List[Tuple[str, nodes.reference]] =3D [] + matches =3D self.find_obj(node.get("qapi:module"), target, None) + for name, obj in matches: + rolename =3D self.role_for_objtype(obj.objtype) + assert rolename is not None + role =3D f"qapi:{rolename}" + refnode =3D make_refnode( + builder, fromdocname, obj.docname, obj.node_id, contnode, = name + ) + results.append((role, refnode)) + return results =20 =20 def setup(app: Sphinx) -> Dict[str, Any]: --=20 2.48.1