src/mapi/glapi/gen/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 "main/glheader.h"'
  46         print '#include "main/enums.h"'
  47         print '#include "main/imports.h"'
  48         print '#include "main/mtypes.h"'
  49         print ''
  50         print 'typedef struct {'
  51         print '   size_t offset;'
  52         print '   int n;'
  53         print '} enum_elt;'
  54         print ''
  55         return
  56
  57     def print_code(self):
  58         print """
  59 typedef int (*cfunc)(const void *, const void *);
  60
  61 /**
  62  * Compare a key name to an element in the \c all_enums array.
  63  *
  64  * \c bsearch always passes the key as the first parameter and the pointer
  65  * to the array element as the second parameter.  We can elimiate some
  66  * extra work by taking advantage of that fact.
  67  *
  68  * \param a  Pointer to the desired enum name.
  69  * \param b  Pointer to an element of the \c all_enums array.
  70  */
  71 static int compar_name( const char *a, const enum_elt *b )
  72 {
  73    return strcmp( a, & enum_string_table[ b->offset ] );
  74 }
  75
  76 /**
  77  * Compare a key enum value to an element in the \c all_enums array.
  78  *
  79  * \c bsearch always passes the key as the first parameter and the pointer
  80  * to the array element as the second parameter.  We can elimiate some
  81  * extra work by taking advantage of that fact.
  82  *
  83  * \param a  Pointer to the desired enum name.
  84  * \param b  Pointer to an index into the \c all_enums array.
  85  */
  86 static int compar_nr( const int *a, const unsigned *b )
  87 {
  88    return a[0] - all_enums[*b].n;
  89 }
  90
  91
  92 static char token_tmp[20];
  93
  94 const char *_mesa_lookup_enum_by_nr( int nr )
  95 {
  96    unsigned * i;
  97
  98    i = (unsigned *) _mesa_bsearch(& nr, reduced_enums,
  99                                   Elements(reduced_enums),
 100                                   sizeof(reduced_enums[0]),
 101                                   (cfunc) compar_nr);
 102
 103    if ( i != NULL ) {
 104       return & enum_string_table[ all_enums[ *i ].offset ];
 105    }
 106    else {
 107       /* this is not re-entrant safe, no big deal here */
 108       _mesa_snprintf(token_tmp, sizeof(token_tmp) - 1, "0x%x", nr);
 109       token_tmp[sizeof(token_tmp) - 1] = '\\0';
 110       return token_tmp;
 111    }
 112 }
 113
 114 /**
 115  * Primitive names
 116  */
 117 static const char *prim_names[PRIM_MAX+3] = {
 118    "GL_POINTS",
 119    "GL_LINES",
 120    "GL_LINE_LOOP",
 121    "GL_LINE_STRIP",
 122    "GL_TRIANGLES",
 123    "GL_TRIANGLE_STRIP",
 124    "GL_TRIANGLE_FAN",
 125    "GL_QUADS",
 126    "GL_QUAD_STRIP",
 127    "GL_POLYGON",
 128    "GL_LINES_ADJACENCY",
 129    "GL_LINE_STRIP_ADJACENCY",
 130    "GL_TRIANGLES_ADJACENCY",
 131    "GL_TRIANGLE_STRIP_ADJACENCY",
 132    "outside begin/end",
 133    "unknown state"
 134 };
 135
 136
 137 /* Get the name of an enum given that it is a primitive type.  Avoids
 138  * GL_FALSE/GL_POINTS ambiguity and others.
 139  */
 140 const char *
 141 _mesa_lookup_prim_by_nr(GLuint nr)
 142 {
 143    if (nr < Elements(prim_names))
 144       return prim_names[nr];
 145    else
 146       return "invalid mode";
 147 }
 148
 149
 150 int _mesa_lookup_enum_by_name( const char *symbol )
 151 {
 152    enum_elt * f = NULL;
 153
 154    if ( symbol != NULL ) {
 155       f = (enum_elt *) _mesa_bsearch(symbol, all_enums,
 156                                      Elements(all_enums),
 157                                      sizeof( enum_elt ),
 158                                      (cfunc) compar_name);
 159    }
 160
 161    return (f != NULL) ? f->n : -1;
 162 }
 163
 164 """
 165         return
 166
 167
 168     def printBody(self, api_list):
 169         self.enum_table = {}
 170         for api in api_list:
 171             self.process_enums( api )
 172
 173         keys = self.enum_table.keys()
 174         keys.sort()
 175
 176         name_table = []
 177         enum_table = {}
 178
 179         for enum in keys:
 180             low_pri = 9
 181             for [name, pri] in self.enum_table[ enum ]:
 182                 name_table.append( [name, enum] )
 183
 184                 if pri < low_pri:
 185                     low_pri = pri
 186                     enum_table[enum] = name
 187
 188
 189         name_table.sort()
 190
 191         string_offsets = {}
 192         i = 0;
 193         print 'LONGSTRING static const char enum_string_table[] = '
 194         for [name, enum] in name_table:
 195             print '   "%s\\0"' % (name)
 196             string_offsets[ name ] = i
 197             i += len(name) + 1
 198
 199         print '   ;'
 200         print ''
 201
 202
 203         print 'static const enum_elt all_enums[%u] =' % (len(name_table))
 204         print '{'
 205         for [name, enum] in name_table:
 206             print '   { %5u, 0x%08X }, /* %s */' % (string_offsets[name], enum, name)
 207         print '};'
 208         print ''
 209
 210         print 'static const unsigned reduced_enums[%u] =' % (len(keys))
 211         print '{'
 212         for enum in keys:
 213             name = enum_table[ enum ]
 214             if [name, enum] not in name_table:
 215                 print '      /* Error! %s, 0x%04x */ 0,' % (name, enum)
 216             else:
 217                 i = name_table.index( [name, enum] )
 218
 219                 print '      %4u, /* %s */' % (i, name)
 220         print '};'
 221
 222
 223         self.print_code()
 224         return
 225
 226
 227     def process_enums(self, api):
 228         for obj in api.enumIterateByName():
 229             if obj.value not in self.enum_table:
 230                 self.enum_table[ obj.value ] = []
 231
 232
 233             enum = self.enum_table[ obj.value ]
 234             name = "GL_" + obj.name
 235             priority = obj.priority()
 236             already_in = False;
 237             for n, p in enum:
 238                 if n == name:
 239                     already_in = True
 240             if not already_in:
 241                 enum.append( [name, priority] )
 242
 243
 244 def show_usage():
 245     print "Usage: %s [-f input_file_name]" % sys.argv[0]
 246     sys.exit(1)
 247
 248 if __name__ == '__main__':
 249     try:
 250         (args, trail) = getopt.getopt(sys.argv[1:], "f:")
 251     except Exception,e:
 252         show_usage()
 253
 254     api_list = []
 255     for (arg,val) in args:
 256         if arg == "-f":
 257             api = gl_XML.parse_GL_API( val )
 258             api_list.append(api);
 259
 260     printer = PrintGlEnums()
 261     printer.Print( api_list )