[v3,0/8] qapi-go: add generator for Golang interfaces

Message

Victor Toso Jan. 10, 2025, 10:49 a.m. UTC

This patch series intent is to introduce a generator that produces a Go
module for Go applications to interact over QMP with QEMU.

The initial Goal is to have a Go module that works as intended and can
be improved upon. I'd consider initial releases to be alpha while we
work with utilities tools and libraries on top of this.

The generated code should reside in a separated Git repository, similar
to python-qemu-qmp.

Applications should be able to consume this under qemu.org
namespace (e.g: import "qemu.org/go/qemu"), see Daniel's suggestion:
https://lists.gnu.org/archive/html/qemu-devel/2023-09/msg07024.html

This is the third iteration:
v2: https://lists.gnu.org/archive/html/qemu-devel/2023-10/msg04785.html

I've pushed this series in my gitlab fork:
https://gitlab.com/victortoso/qapi-go/

The fork contains some tests, including tests that were generated from
QAPI's own examples from another generator created for testing, if you
are interested in it:
https://lists.gnu.org/archive/html/qemu-devel/2023-09/msg04946.html

I've generated the qapi-go module over each commit of this series, see:
https://gitlab.com/victortoso/qapi-go/-/commits/qapi-golang-v3-by-patch

I've also generated the qapi-go module over QEMU tags: v9.1.0, v9.2.0:
https://gitlab.com/victortoso/qapi-go/-/commits/qapi-golang-v3-by-tags

--

Sorry that its been awhile between v2 and v3, I had to prioritize other
things. I hope to get this back on track in 2025.

Cheers,
Victor

* Changes:

On generated go:
 - the output should be formatted as gofmt/goimports tools (Daniel)

 - Included QAPI's documentation too (Daniel), see:
   https://lists.gnu.org/archive/html/qemu-devel/2024-11/msg01621.html
    
 - Commands and Events should Marshal directly (Andrea)

On python script:
 - rebased: now uses QAPISchemaBranches, QAPISchemaAlternatives

 - use textwrap as much as possible (Andrea)

 - lots of changes to make the output like gofmt does

Victor Toso (8):
  qapi: golang: Generate enum type
  qapi: golang: Generate alternate types
  qapi: golang: Generate struct types
  qapi: golang: structs: Address nullable members
  qapi: golang: Generate union type
  qapi: golang: Generate event type
  qapi: golang: Generate command type
  docs: add notes on Golang code generator

 docs/devel/index-build.rst          |    1 +
 docs/devel/qapi-golang-code-gen.rst |  548 +++++++++
 scripts/qapi/golang.py              | 1645 +++++++++++++++++++++++++++
 scripts/qapi/main.py                |    3 +
 4 files changed, 2197 insertions(+)
 create mode 100644 docs/devel/qapi-golang-code-gen.rst
 create mode 100644 scripts/qapi/golang.py