File: make-enums.py

package info (click to toggle)
wireshark 4.6.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 351,244 kB
  • sloc: ansic: 3,101,885; cpp: 129,710; xml: 100,972; python: 56,512; perl: 24,575; sh: 5,874; lex: 4,383; pascal: 4,304; makefile: 165; ruby: 113; objc: 91; tcl: 35
file content (109 lines) | stat: -rwxr-xr-x 2,639 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
#!/usr/bin/env python3
#
# Copyright 2021, João Valverde <j@v6e.pt>
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# SPDX-License-Identifier: GPL-2.0-or-later
#
#
# Uses pyclibrary to parse C headers for enums and integer macro
# definitions. Exports that data to a C file for the introspection API.
#
# Requires: https://github.com/MatthieuDartiailh/pyclibrary
#

import os
import sys
from pyclibrary import CParser

def parse_files(infiles, outfile):

    print("Input: {}".format(infiles))
    print("Output: '{}'".format(outfile))
    pre_line_count = 0
    with open(outfile, 'r') as out_f:
        pre_line_count = len(out_f.read().splitlines())

    parser = CParser(infiles)

    source = """\
/*
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Generated automatically from %s. It can be re-created by running
 * "tools/make-enums.py" from the top source directory.
 *
 * It is fine to edit this file by hand. Particularly if a symbol
 * disappears from the API it can just be removed here. There is no
 * requirement to re-run the generator script.
 *
 */
""" % (os.path.basename(sys.argv[0]))

    for f in infiles:
        source += '#include <{}>\n'.format(f)

    source += """
#define ENUM(arg) { #arg, arg }

static ws_enum_t const all_enums[] = {
"""

    definitions = parser.defs['values']
    symbols = list(definitions.keys())
    symbols.sort()

    for s in symbols:
        if isinstance(definitions[s], int):
            source += '    ENUM({}),\n'.format(s)

    source += """\
    { NULL, 0 },
};
"""

    post_line_count = len(source.splitlines())
    if post_line_count < pre_line_count:
        sys.stderr.write(f"Can't shrink {outfile} from {pre_line_count} lines to {post_line_count} lines.\n")
        sys.exit(1)

    try:
        fh = open(outfile, 'w')
    except OSError:
        sys.exit('Unable to write ' + outfile + '.\n')

    fh.write(source)
    fh.close()

epan_files = [
    "epan/address.h",
    "epan/ipproto.h",
    "epan/ftypes/ftypes.h",
    "epan/proto.h",         # PyClibrary 0.3.0 needs this after ftypes.h
    "epan/stat_groups.h",
]
parse_files(epan_files, "epan/introspection-enums.c")

wtap_files = [
    "wiretap/wtap.h",
]
parse_files(wtap_files, "wiretap/introspection-enums.c")

#
# Editor modelines  -  https://www.wireshark.org/tools/modelines.html
#
# Local variables:
# c-basic-offset: 4
# indent-tabs-mode: nil
# End:
#
# vi: set shiftwidth=4 expandtab:
# :indentSize=4:noTabs=true:
#