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 enum value to an element in the \c enum_string_table_offsets 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 into the \c enum_string_table_offsets array.
  70  */
  71 static int compar_nr( const int *a, enum_elt *b )
  72 {
  73    return a[0] - b->n;
  74 }
  75
  76
  77 static char token_tmp[20];
  78
  79 const char *_mesa_lookup_enum_by_nr( int nr )
  80 {
  81    enum_elt *elt = _mesa_bsearch(& nr, enum_string_table_offsets,
  82                                  Elements(enum_string_table_offsets),
  83                                  sizeof(enum_string_table_offsets[0]),
  84                                  (cfunc) compar_nr);
  85
  86    if (elt != NULL) {
  87       return &enum_string_table[elt->offset];
  88    }
  89    else {
  90       /* this is not re-entrant safe, no big deal here */
  91       _mesa_snprintf(token_tmp, sizeof(token_tmp) - 1, "0x%x", nr);
  92       token_tmp[sizeof(token_tmp) - 1] = '\\0';
  93       return token_tmp;
  94    }
  95 }
  96
  97 /**
  98  * Primitive names
  99  */
 100 static const char *prim_names[PRIM_MAX+3] = {
 101    "GL_POINTS",
 102    "GL_LINES",
 103    "GL_LINE_LOOP",
 104    "GL_LINE_STRIP",
 105    "GL_TRIANGLES",
 106    "GL_TRIANGLE_STRIP",
 107    "GL_TRIANGLE_FAN",
 108    "GL_QUADS",
 109    "GL_QUAD_STRIP",
 110    "GL_POLYGON",
 111    "GL_LINES_ADJACENCY",
 112    "GL_LINE_STRIP_ADJACENCY",
 113    "GL_TRIANGLES_ADJACENCY",
 114    "GL_TRIANGLE_STRIP_ADJACENCY",
 115    "outside begin/end",
 116    "unknown state"
 117 };
 118
 119
 120 /* Get the name of an enum given that it is a primitive type.  Avoids
 121  * GL_FALSE/GL_POINTS ambiguity and others.
 122  */
 123 const char *
 124 _mesa_lookup_prim_by_nr(GLuint nr)
 125 {
 126    if (nr < Elements(prim_names))
 127       return prim_names[nr];
 128    else
 129       return "invalid mode";
 130 }
 131
 132
 133 """
 134         return
 135
 136
 137     def printBody(self, api_list):
 138         self.enum_table = {}
 139         for api in api_list:
 140             self.process_enums( api )
 141
 142         enum_table = []
 143
 144         for enum in sorted(self.enum_table.keys()):
 145             low_pri = 9
 146             best_name = ''
 147             for [name, pri] in self.enum_table[ enum ]:
 148                 if pri < low_pri:
 149                     low_pri = pri
 150                     best_name = name
 151
 152             enum_table.append((enum, best_name))
 153
 154         string_offsets = {}
 155         i = 0;
 156         print 'LONGSTRING static const char enum_string_table[] = '
 157         for enum, name in enum_table:
 158             print '   "%s\\0"' % (name)
 159             string_offsets[ enum ] = i
 160             i += len(name) + 1
 161
 162         print '   ;'
 163         print ''
 164
 165
 166         print 'static const enum_elt enum_string_table_offsets[%u] =' % (len(enum_table))
 167         print '{'
 168         for enum, name in enum_table:
 169             print '   { %5u, 0x%08X }, /* %s */' % (string_offsets[enum], enum, name)
 170         print '};'
 171         print ''
 172
 173         self.print_code()
 174         return
 175
 176
 177     def process_enums(self, api):
 178         for obj in api.enumIterateByName():
 179             if obj.value not in self.enum_table:
 180                 self.enum_table[ obj.value ] = []
 181
 182
 183             enum = self.enum_table[ obj.value ]
 184             name = "GL_" + obj.name
 185             priority = obj.priority()
 186             already_in = False;
 187             for n, p in enum:
 188                 if n == name:
 189                     already_in = True
 190             if not already_in:
 191                 enum.append( [name, priority] )
 192
 193
 194 def show_usage():
 195     print "Usage: %s [-f input_file_name]" % sys.argv[0]
 196     sys.exit(1)
 197
 198 if __name__ == '__main__':
 199     try:
 200         (args, trail) = getopt.getopt(sys.argv[1:], "f:")
 201     except Exception,e:
 202         show_usage()
 203
 204     api_list = []
 205     for (arg,val) in args:
 206         if arg == "-f":
 207             api = gl_XML.parse_GL_API( val )
 208             api_list.append(api);
 209
 210     printer = PrintGlEnums()
 211     printer.Print( api_list )