use LONGSTRING to silence warning
[mesa.git] / src / mesa / glapi / gl_enums.py
1 #!/usr/bin/python2
2 # -*- Mode: Python; py-indent-offset: 8 -*-
3
4 # (C) Copyright Zack Rusin 2005
5 # All Rights Reserved.
6 #
7 # Permission is hereby granted, free of charge, to any person obtaining a
8 # copy of this software and associated documentation files (the "Software"),
9 # to deal in the Software without restriction, including without limitation
10 # on the rights to use, copy, modify, merge, publish, distribute, sub
11 # license, and/or sell copies of the Software, and to permit persons to whom
12 # the Software is furnished to do so, subject to the following conditions:
13 #
14 # The above copyright notice and this permission notice (including the next
15 # paragraph) shall be included in all copies or substantial portions of the
16 # Software.
17 #
18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 # IBM AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 # IN THE SOFTWARE.
25 #
26 # Authors:
27 # Zack Rusin <zack@kde.org>
28
29 import license
30 import gl_XML
31 import sys, getopt
32
33 class PrintGlEnums(gl_XML.gl_print_base):
34
35 def __init__(self):
36 gl_XML.gl_print_base.__init__(self)
37
38 self.name = "gl_enums.py (from Mesa)"
39 self.license = license.bsd_license_template % ( \
40 """Copyright (C) 1999-2005 Brian Paul All Rights Reserved.""", "BRIAN PAUL")
41 self.enum_table = {}
42
43
44 def printRealHeader(self):
45 print '#include "glheader.h"'
46 print '#include "enums.h"'
47 print '#include "imports.h"'
48 print ''
49 print 'typedef struct {'
50 print ' size_t offset;'
51 print ' int n;'
52 print '} enum_elt;'
53 print ''
54 return
55
56 def print_code(self):
57 print """
58 #define Elements(x) sizeof(x)/sizeof(*x)
59
60 typedef int (*cfunc)(const void *, const void *);
61
62 /**
63 * Compare a key name to an element in the \c all_enums array.
64 *
65 * \c bsearch always passes the key as the first parameter and the pointer
66 * to the array element as the second parameter. We can elimiate some
67 * extra work by taking advantage of that fact.
68 *
69 * \param a Pointer to the desired enum name.
70 * \param b Pointer to an element of the \c all_enums array.
71 */
72 static int compar_name( const char *a, const enum_elt *b )
73 {
74 return _mesa_strcmp( a, & enum_string_table[ b->offset ] );
75 }
76
77 /**
78 * Compare a key enum value to an element in the \c all_enums array.
79 *
80 * \c bsearch always passes the key as the first parameter and the pointer
81 * to the array element as the second parameter. We can elimiate some
82 * extra work by taking advantage of that fact.
83 *
84 * \param a Pointer to the desired enum name.
85 * \param b Pointer to an index into the \c all_enums array.
86 */
87 static int compar_nr( const int *a, const unsigned *b )
88 {
89 return a[0] - all_enums[*b].n;
90 }
91
92
93 static char token_tmp[20];
94
95 const char *_mesa_lookup_enum_by_nr( int nr )
96 {
97 unsigned * i;
98
99 i = (unsigned *)bsearch( & nr, reduced_enums, Elements(reduced_enums),
100 sizeof(reduced_enums[0]), (cfunc) compar_nr );
101
102 if ( i != NULL ) {
103 return & enum_string_table[ all_enums[ *i ].offset ];
104 }
105 else {
106 /* this is not re-entrant safe, no big deal here */
107 _mesa_sprintf(token_tmp, "0x%x", nr);
108 return token_tmp;
109 }
110 }
111
112 int _mesa_lookup_enum_by_name( const char *symbol )
113 {
114 enum_elt * f = NULL;
115
116 if ( symbol != NULL ) {
117 f = (enum_elt *)bsearch( symbol, all_enums, Elements(all_enums),
118 sizeof( enum_elt ), (cfunc) compar_name );
119 }
120
121 return (f != NULL) ? f->n : -1;
122 }
123
124 """
125 return
126
127
128 def printBody(self, api):
129 self.process_enums( api )
130
131 keys = self.enum_table.keys()
132 keys.sort()
133
134 name_table = []
135 enum_table = {}
136
137 for enum in keys:
138 low_pri = 9
139 for [name, pri] in self.enum_table[ enum ]:
140 name_table.append( [name, enum] )
141
142 if pri < low_pri:
143 low_pri = pri
144 enum_table[enum] = name
145
146
147 name_table.sort()
148
149 string_offsets = {}
150 i = 0;
151 print 'LONGSTRING static const char enum_string_table[] = '
152 for [name, enum] in name_table:
153 print ' "%s\\0"' % (name)
154 string_offsets[ name ] = i
155 i += len(name) + 1
156
157 print ' ;'
158 print ''
159
160
161 print 'static const enum_elt all_enums[%u] =' % (len(name_table))
162 print '{'
163 for [name, enum] in name_table:
164 print ' { %5u, 0x%08X }, /* %s */' % (string_offsets[name], enum, name)
165 print '};'
166 print ''
167
168 print 'static const unsigned reduced_enums[%u] =' % (len(keys))
169 print '{'
170 for enum in keys:
171 name = enum_table[ enum ]
172 if [name, enum] not in name_table:
173 print ' /* Error! %s, 0x%04x */ 0,' % (name, enum)
174 else:
175 i = name_table.index( [name, enum] )
176
177 print ' %4u, /* %s */' % (i, name)
178 print '};'
179
180
181 self.print_code()
182 return
183
184
185 def process_enums(self, api):
186 self.enum_table = {}
187
188 for obj in api.enumIterateByName():
189 if obj.value not in self.enum_table:
190 self.enum_table[ obj.value ] = []
191
192
193 name = "GL_" + obj.name
194 priority = obj.priority()
195 self.enum_table[ obj.value ].append( [name, priority] )
196
197
198 def show_usage():
199 print "Usage: %s [-f input_file_name]" % sys.argv[0]
200 sys.exit(1)
201
202 if __name__ == '__main__':
203 file_name = "gl_API.xml"
204
205 try:
206 (args, trail) = getopt.getopt(sys.argv[1:], "f:")
207 except Exception,e:
208 show_usage()
209
210 for (arg,val) in args:
211 if arg == "-f":
212 file_name = val
213
214 api = gl_XML.parse_GL_API( file_name )
215
216 printer = PrintGlEnums()
217 printer.Print( api )