From nobody Mon Feb 9 11:28:46 2026 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=1602323839; cv=none; d=zohomail.com; s=zohoarc; b=FsycS6dAQuTdGn6DDIUf6J7wYs6avosr8GQpXGJIcGdrbO9v47kt4dX+ZtPBSoyTtZ8nZZsS9p8IpRvp92hTFADwTOblcT4Uiw6g2MMDWIYKDptS1l00iDSMphPVO18LNnTqrWJwwUy0NYcrsXTGo9ed4QrzD8FZq3p8pw4mveY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1602323839; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=nwbSkZFLhNjlGlUKypkB/L9ZdchRsEf7KjQkBXrzEKU=; b=mEe9cvGoU7tdU/fNLzZzp0Drt4HMDTu/OQC714WzKHTc1YrYNwy8maoPzvY2zWR3mONxd93dSw4on1aDBz4ujF5Dc2nrM/EJpYHPMiWYT9day0/ylNsZpzIvJEulhMegS/ETXKF7irKI+mwPrzVGsdhkqIcrvVKoQOBQn8DpPJ4= 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) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1602323839146239.63008307231485; Sat, 10 Oct 2020 02:57:19 -0700 (PDT) Received: from localhost ([::1]:44846 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kRBcr-00015J-Qo for importer@patchew.org; Sat, 10 Oct 2020 05:57:17 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60448) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kRBau-0007dL-4p for qemu-devel@nongnu.org; Sat, 10 Oct 2020 05:55:16 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:22217) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kRBaq-0002hf-Hc for qemu-devel@nongnu.org; Sat, 10 Oct 2020 05:55:15 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-149-e-0rUu01PyyZ4A5agdsoOw-1; Sat, 10 Oct 2020 05:55:07 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id AEC801005E5A; Sat, 10 Oct 2020 09:55:06 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-112-182.ams2.redhat.com [10.36.112.182]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 49C205D9FC; Sat, 10 Oct 2020 09:55:06 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id A0ADA112CE10; Sat, 10 Oct 2020 11:55:04 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602323710; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=nwbSkZFLhNjlGlUKypkB/L9ZdchRsEf7KjQkBXrzEKU=; b=T4WY/kHhpHyKZKxd6DznVZRMAZVUOzMe0OgCMCvpLTbI01nCCGLzi3cwTrzxsD1+B2tjvw YH2cyeBRUa4jN0xdL+KxHm9s1AS4QhRp5Q9E/N3DOiPpfYcnxDAISXcoVDSt4m7rkT7t4n /iOlStqYddnW131/DauCqONfyfDvUX4= X-MC-Unique: e-0rUu01PyyZ4A5agdsoOw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Subject: [PULL 03/34] qapi-gen: Separate arg-parsing from generation Date: Sat, 10 Oct 2020 11:54:33 +0200 Message-Id: <20201010095504.796182-4-armbru@redhat.com> In-Reply-To: <20201010095504.796182-1-armbru@redhat.com> References: <20201010095504.796182-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=armbru@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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=216.205.24.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/10 02:57:53 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] 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_H4=0.001, RCVD_IN_MSPIKE_WL=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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: peter.maydell@linaro.org, John Snow , Eduardo Habkost , Cleber Rosa Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" From: John Snow This is a minor re-work of the entrypoint script. It isolates a generate() method from the actual command-line mechanism. Signed-off-by: John Snow Reviewed-by: Eduardo Habkost Reviewed-by: Cleber Rosa Tested-by: Cleber Rosa Message-Id: <20201009161558.107041-4-jsnow@redhat.com> Reviewed-by: Markus Armbruster [invalid_char() renamed to invalid_prefix_char()] Signed-off-by: Markus Armbruster --- scripts/qapi-gen.py | 89 ++++++++++++++++++++++++++++++++++----------- 1 file changed, 67 insertions(+), 22 deletions(-) diff --git a/scripts/qapi-gen.py b/scripts/qapi-gen.py index 541e8c1f55..cf942d9ce3 100644 --- a/scripts/qapi-gen.py +++ b/scripts/qapi-gen.py @@ -1,30 +1,77 @@ #!/usr/bin/env python3 -# QAPI generator -# + # This work is licensed under the terms of the GNU GPL, version 2 or later. # See the COPYING file in the top-level directory. =20 +""" +QAPI Generator + +This is the main entry point for generating C code from the QAPI schema. +""" =20 import argparse import re import sys +from typing import Optional =20 from qapi.commands import gen_commands +from qapi.error import QAPIError from qapi.events import gen_events from qapi.introspect import gen_introspect -from qapi.schema import QAPIError, QAPISchema +from qapi.schema import QAPISchema from qapi.types import gen_types from qapi.visit import gen_visit =20 =20 -def main(argv): +def invalid_prefix_char(prefix: str) -> Optional[str]: + match =3D re.match(r'([A-Za-z_.-][A-Za-z0-9_.-]*)?', prefix) + if match.end() !=3D len(prefix): + return prefix[match.end()] + return None + + +def generate(schema_file: str, + output_dir: str, + prefix: str, + unmask: bool =3D False, + builtins: bool =3D False) -> None: + """ + Generate C code for the given schema into the target directory. + + :param schema_file: The primary QAPI schema file. + :param output_dir: The output directory to store generated code. + :param prefix: Optional C-code prefix for symbol names. + :param unmask: Expose non-ABI names through introspection? + :param builtins: Generate code for built-in types? + + :raise QAPIError: On failures. + """ + assert invalid_prefix_char(prefix) is None + + schema =3D QAPISchema(schema_file) + gen_types(schema, output_dir, prefix, builtins) + gen_visit(schema, output_dir, prefix, builtins) + gen_commands(schema, output_dir, prefix) + gen_events(schema, output_dir, prefix) + gen_introspect(schema, output_dir, prefix, unmask) + + +def main() -> int: + """ + gapi-gen executable entry point. + Expects arguments via sys.argv, see --help for details. + + :return: int, 0 on success, 1 on failure. + """ parser =3D argparse.ArgumentParser( description=3D'Generate code from a QAPI schema') parser.add_argument('-b', '--builtins', action=3D'store_true', help=3D"generate code for built-in types") - parser.add_argument('-o', '--output-dir', action=3D'store', default=3D= '', + parser.add_argument('-o', '--output-dir', action=3D'store', + default=3D'', help=3D"write output to directory OUTPUT_DIR") - parser.add_argument('-p', '--prefix', action=3D'store', default=3D'', + parser.add_argument('-p', '--prefix', action=3D'store', + default=3D'', help=3D"prefix for symbols") parser.add_argument('-u', '--unmask-non-abi-names', action=3D'store_tr= ue', dest=3D'unmask', @@ -32,25 +79,23 @@ def main(argv): parser.add_argument('schema', action=3D'store') args =3D parser.parse_args() =20 - match =3D re.match(r'([A-Za-z_.-][A-Za-z0-9_.-]*)?', args.prefix) - if match.end() !=3D len(args.prefix): - print("%s: 'funny character '%s' in argument of --prefix" - % (sys.argv[0], args.prefix[match.end()]), - file=3Dsys.stderr) - sys.exit(1) + funny_char =3D invalid_prefix_char(args.prefix) + if funny_char: + msg =3D f"funny character '{funny_char}' in argument of --prefix" + print(f"{sys.argv[0]}: {msg}", file=3Dsys.stderr) + return 1 =20 try: - schema =3D QAPISchema(args.schema) + generate(args.schema, + output_dir=3Dargs.output_dir, + prefix=3Dargs.prefix, + unmask=3Dargs.unmask, + builtins=3Dargs.builtins) except QAPIError as err: - print(err, file=3Dsys.stderr) - exit(1) - - gen_types(schema, args.output_dir, args.prefix, args.builtins) - gen_visit(schema, args.output_dir, args.prefix, args.builtins) - gen_commands(schema, args.output_dir, args.prefix) - gen_events(schema, args.output_dir, args.prefix) - gen_introspect(schema, args.output_dir, args.prefix, args.unmask) + print(f"{sys.argv[0]}: {str(err)}", file=3Dsys.stderr) + return 1 + return 0 =20 =20 if __name__ =3D=3D '__main__': - main(sys.argv) + sys.exit(main()) --=20 2.26.2