yuzu/unicorn
1
0
Fork 0
mirror of https://github.com/yuzu-emu/unicorn.git synced 2025-03-28 09:56:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

qapi: Streamline boilerplate comment generation

Browse source 
Every generator has separate boilerplate for .h and .c, and their
differences are boring. All of them repeat the license note.

Reduce the repetition as follows. Move common text like the license
note to common open_output(), next to the existing common text there.
For each generator, replace the two separate descriptions by a single
one.

While there, emit an "automatically generated" note into generated
documentation, too.

Backports commit c263de3f419be945499ff7e6bd7512702f8bd522 from qemu
This commit is contained in:
Markus Armbruster 2018-03-09 07:40:43 -05:00 committed by Lioncash
parent 4b9a1ceb4a
commit 42f64cc962
No known key found for this signature in database
GPG key ID: 4E3C3CC1031BA9C7
4 changed files with 27 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
qemu/scripts/qapi-event.py
View file

@ -170,38 +170,19 @@ class QAPISchemaGenEventVisitor(QAPISchemaVisitor):
(input_file, output_dir, do_c, do_h, prefix, dummy) = parse_command_line()
c_comment = '''
/*
* schema-defined QAPI event functions
blurb = '''
* Schema-defined QAPI/QMP events
*
* Copyright (c) 2014 Wenchao Xia
*
* Authors:
* Wenchao Xia <wenchaoqemu@gmail.com>
*
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
* See the COPYING.LIB file in the top-level directory.
*
*/
'''
h_comment = '''
/*
* schema-defined QAPI event functions
*
* Copyright (c) 2014 Wenchao Xia
*
* Authors:
* Wenchao Xia <wenchaoqemu@gmail.com>
*
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
* See the COPYING.LIB file in the top-level directory.
*
*/
'''
(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
'qapi-event.c', 'qapi-event.h',
c_comment, h_comment)
blurb)
fdef.write(mcgen('''
#include "qemu-common.h"
#include "%(prefix)sqapi-event.h"

26
qemu/scripts/qapi-types.py
View file

@ -250,39 +250,19 @@ for o, a in opts:
if o in ('-b', '--builtins'):
do_builtins = True
c_comment = '''
/*
* deallocation functions for schema-defined QAPI types
blurb = '''
* Schema-defined QAPI types
*
* Copyright IBM, Corp. 2011
*
* Authors:
* Anthony Liguori <aliguori@us.ibm.com>
* Michael Roth <mdroth@linux.vnet.ibm.com>
*
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
* See the COPYING.LIB file in the top-level directory.
*
*/
'''
h_comment = '''
/*
* schema-defined QAPI types
*
* Copyright IBM, Corp. 2011
*
* Authors:
* Anthony Liguori <aliguori@us.ibm.com>
*
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
* See the COPYING.LIB file in the top-level directory.
*
*/
'''
(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
'qapi-types.c', 'qapi-types.h',
c_comment, h_comment)
blurb)
fdef.write(mcgen('''
#include "qemu/osdep.h"

26
qemu/scripts/qapi-visit.py
View file

@ -334,38 +334,18 @@ for o, a in opts:
if o in ('-b', '--builtins'):
do_builtins = True
c_comment = '''
/*
* schema-defined QAPI visitor functions
blurb = '''
* Schema-defined QAPI visitors
*
* Copyright IBM, Corp. 2011
*
* Authors:
* Anthony Liguori <aliguori@us.ibm.com>
*
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
* See the COPYING.LIB file in the top-level directory.
*
*/
'''
h_comment = '''
/*
* schema-defined QAPI visitor functions
*
* Copyright IBM, Corp. 2011
*
* Authors:
* Anthony Liguori <aliguori@us.ibm.com>
*
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
* See the COPYING.LIB file in the top-level directory.
*
*/
'''
(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
'qapi-visit.c', 'qapi-visit.h',
c_comment, h_comment)
blurb)
fdef.write(mcgen('''
#include "qemu/osdep.h"

31
qemu/scripts/qapi.py
View file

@ -1990,11 +1990,21 @@ def parse_command_line(extra_options='', extra_long_options=[]):
#
def open_output(output_dir, do_c, do_h, prefix, c_file, h_file,
c_comment, h_comment):
def open_output(output_dir, do_c, do_h, prefix, c_file, h_file, blurb):
guard = guardname(prefix + h_file)
c_file = output_dir + prefix + c_file
h_file = output_dir + prefix + h_file
comment = mcgen('''/* AUTOMATICALLY GENERATED, DO NOT MODIFY */
/*
%(blurb)s
*
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
* See the COPYING.LIB file in the top-level directory.
*/
''',
blurb=blurb.strip('\n'))
if output_dir:
try:
@ -2012,27 +2022,22 @@ def open_output(output_dir, do_c, do_h, prefix, c_file, h_file,
fdef = maybe_open(do_c, c_file, 'w')
fdecl = maybe_open(do_h, h_file, 'w')
fdef.write(mcgen('''
/* AUTOMATICALLY GENERATED, DO NOT MODIFY */
%(comment)s
''',
comment=c_comment))
fdef.write(comment)
fdecl.write(comment)
fdecl.write(mcgen('''
/* AUTOMATICALLY GENERATED, DO NOT MODIFY */
%(comment)s
#ifndef %(guard)s
#define %(guard)s
''',
comment=h_comment, guard=guard))
guard=guard))
return (fdef, fdecl)
def close_output(fdef, fdecl):
fdecl.write('''
fdecl.write(mcgen('''
#endif
''')
'''))
fdecl.close()
fdef.close()