glapi: gl_enmus.py: Use mako instead of prints

This produces what is effectively the same code as the previous
generator (minus whitespace changes). The difference is the way hex is
printed, and the capitalization of the hex string.

The details are that the original code implemented '0x' as a string, and
then joined the resulting hex to it. The new code uses a hex formatter
string. Due to a limitation in python letters in a hex string are all
caps, or all lower.

So, this happened:
0xBEEFBEEF -> 0xbeefbeef

The other option would be to have:
0xBEEFBEEF -> 0XBEEFBEEF

When I polled people around the office they preferred all lower to all
upper, but I don't care either way.

Signed-off-by: Dylan Baker <dylanx.c.baker@intel.com>

4 files changed, 179 insertions, 174 deletions

diff --git a/src/mapi/glapi/gen/Makefile.am b/src/mapi/glapi/gen/Makefile.am
index 8d312e374e..43db442521 100644
--- a/src/mapi/glapi/gen/Makefile.am
+++ b/src/mapi/glapi/gen/Makefile.am
@@ -268,8 +268,9 @@ $(MESA_GLAPI_DIR)/glapi_sparc.S: gl_SPARC_asm.py $(COMMON)
 
 ######################################################################
 
-$(MESA_DIR)/main/enums.c: gl_enums.py $(COMMON)
-	$(PYTHON_GEN) $< -f $(srcdir)/gl_and_es_API.xml > $@
+$(MESA_DIR)/main/enums.c: gl_enums.py $(COMMON) templates/enums.c.mako
+	$(PYTHON_GEN) $< -f $(srcdir)/gl_and_es_API.xml \
+	  | $(INDENT) $(INDENT_FLAGS) > $@
 
 $(MESA_DIR)/main/api_exec.c: gl_genexec.py apiexec.py $(COMMON)
 	$(PYTHON_GEN) $< -f $(srcdir)/gl_and_es_API.xml > $@
diff --git a/src/mapi/glapi/gen/SConscript b/src/mapi/glapi/gen/SConscript
index 6b6e99338d..d202a2905a 100644
--- a/src/mapi/glapi/gen/SConscript
+++ b/src/mapi/glapi/gen/SConscript
@@ -51,7 +51,7 @@ env.CodeGenerate(
 env.CodeGenerate(
     target = '../../../mesa/main/enums.c',
     script = 'gl_enums.py',
-    source = sources,
+    source = sources + ['templates/enums.c.mako'],
     command = python_cmd + ' $SCRIPT -f $SOURCE > $TARGET'
     )
 
diff --git a/src/mapi/glapi/gen/gl_enums.py b/src/mapi/glapi/gen/gl_enums.py
index 955f27d081..2b31a67ba2 100644
--- a/src/mapi/glapi/gen/gl_enums.py
+++ b/src/mapi/glapi/gen/gl_enums.py
@@ -27,180 +27,48 @@
 #    Zack Rusin <zack@kde.org>
 
 import argparse
+import collections
 
-import license
 import gl_XML
-import sys, getopt
-
-class PrintGlEnums(gl_XML.gl_print_base):
-
-    def __init__(self):
-        gl_XML.gl_print_base.__init__(self)
-
-        self.name = "gl_enums.py (from Mesa)"
-        self.license = license.bsd_license_template % ( \
-"""Copyright (C) 1999-2005 Brian Paul All Rights Reserved.""", "BRIAN PAUL")
-        self.enum_table = {}
-
-
-    def printRealHeader(self):
-        print '#include "main/glheader.h"'
-        print '#include "main/enums.h"'
-        print '#include "main/imports.h"'
-        print '#include "main/mtypes.h"'
-        print ''
-        print 'typedef struct PACKED {'
-        print '   uint16_t offset;'
-        print '   int n;'
-        print '} enum_elt;'
-        print ''
-        return
-
-    def print_code(self):
-        print """
-typedef int (*cfunc)(const void *, const void *);
-
-/**
- * Compare a key enum value to an element in the \c enum_string_table_offsets array.
- *
- * \c bsearch always passes the key as the first parameter and the pointer
- * to the array element as the second parameter.  We can elimiate some
- * extra work by taking advantage of that fact.
- *
- * \param a  Pointer to the desired enum name.
- * \param b  Pointer into the \c enum_string_table_offsets array.
- */
-static int compar_nr( const int *a, enum_elt *b )
-{
-   return a[0] - b->n;
-}
-
-
-static char token_tmp[20];
-
-const char *_mesa_lookup_enum_by_nr( int nr )
-{
-   enum_elt *elt;
-
-   STATIC_ASSERT(sizeof(enum_string_table) < (1 << 16));
-
-   elt = bsearch(& nr, enum_string_table_offsets,
-                 ARRAY_SIZE(enum_string_table_offsets),
-                 sizeof(enum_string_table_offsets[0]),
-                 (cfunc) compar_nr);
-
-   if (elt != NULL) {
-      return &enum_string_table[elt->offset];
-   }
-   else {
-      /* this is not re-entrant safe, no big deal here */
-      _mesa_snprintf(token_tmp, sizeof(token_tmp) - 1, "0x%x", nr);
-      token_tmp[sizeof(token_tmp) - 1] = '\\0';
-      return token_tmp;
-   }
-}
-
-/**
- * Primitive names
- */
-static const char *prim_names[PRIM_MAX+3] = {
-   "GL_POINTS",
-   "GL_LINES",
-   "GL_LINE_LOOP",
-   "GL_LINE_STRIP",
-   "GL_TRIANGLES",
-   "GL_TRIANGLE_STRIP",
-   "GL_TRIANGLE_FAN",
-   "GL_QUADS",
-   "GL_QUAD_STRIP",
-   "GL_POLYGON",
-   "GL_LINES_ADJACENCY",
-   "GL_LINE_STRIP_ADJACENCY",
-   "GL_TRIANGLES_ADJACENCY",
-   "GL_TRIANGLE_STRIP_ADJACENCY",
-   "outside begin/end",
-   "unknown state"
-};
-
-
-/* Get the name of an enum given that it is a primitive type.  Avoids
- * GL_FALSE/GL_POINTS ambiguity and others.
- */
-const char *
-_mesa_lookup_prim_by_nr(GLuint nr)
-{
-   if (nr < ARRAY_SIZE(prim_names))
-      return prim_names[nr];
-   else
-      return "invalid mode";
-}
-
-
-"""
-        return
-
-
-    def printBody(self, api_list):
-        self.enum_table = {}
-        for api in api_list:
-            self.process_enums( api )
-
-        enum_table = []
-
-        for enum in sorted(self.enum_table.keys()):
-            low_pri = 9
-            best_name = ''
-            for [name, pri] in self.enum_table[ enum ]:
-                if pri < low_pri:
-                    low_pri = pri
-                    best_name = name
-
-            enum_table.append((enum, best_name))
-
-        string_offsets = {}
-        i = 0;
-        print '#if defined(__GNUC__)'
-        print '# define LONGSTRING __extension__'
-        print '#else'
-        print '# define LONGSTRING'
-        print '#endif'
-        print ''
-        print 'LONGSTRING static const char enum_string_table[] = '
-        for enum, name in enum_table:
-            print '   "%s\\0"' % (name)
-            string_offsets[ enum ] = i
-            i += len(name) + 1
-
-        print '   ;'
-        print ''
-
-
-        print 'static const enum_elt enum_string_table_offsets[%u] =' % (len(enum_table))
-        print '{'
-        for enum, name in enum_table:
-            print '   { %5u, 0x%08X }, /* %s */' % (string_offsets[enum], enum, name)
-        print '};'
-        print ''
-
-        self.print_code()
-        return
-
-
-    def process_enums(self, api):
-        for obj in api.enumIterateByName():
-            if obj.value not in self.enum_table:
-                self.enum_table[ obj.value ] = []
+from python import templates
 
 
-            enum = self.enum_table[ obj.value ]
+def _make_table(api):
+    """Generate a list of tuples in the form (enum, name)."""
+    def process_enums(api):
+        table = collections.defaultdict(list)
+        for obj in api.enumIterateByName():
+            enum = table[obj.value]
             name = "GL_" + obj.name
-            priority = obj.priority()
-            already_in = False;
-            for n, p in enum:
+
+            for n, _ in enum:
                 if n == name:
-                    already_in = True
-            if not already_in:
-                enum.append( [name, priority] )
+                    break
+            else:
+                enum.append((name, obj.priority()))
+
+        return table
+
+    def p_filter(values):
+        """Return the name with the lowest priority.
+
+        Give the input: [('a', 1), ('b', 10), ('c', 0)] this function will
+        return 'c', discarding the priority.
+
+        """
+        return min(values, key=lambda x: x[1])[0]
+
+    def dict_sort(dict_):
+        """Sort a dictionary by it's keys.
+
+        This works around oddity in the way that python's sorted() works on
+        dictionaries, it returns a sorted list of keys.
+
+        """
+        for key in sorted(dict_):
+            yield key, dict_[key]
+
+    return [(k, p_filter(v)) for k, v in dict_sort(process_enums(api))]
 
 
 def _parser():
@@ -213,10 +81,10 @@ def _parser():
 
 def main():
     args = _parser()
-    api_list = [gl_XML.parse_GL_API(args.input_file)]
+    api = gl_XML.parse_GL_API(args.input_file)
+    template = templates.LOOKUP.get_template('enums.c.mako')
 
-    printer = PrintGlEnums()
-    printer.Print(api_list)
+    print template.render(enums=_make_table(api))
 
 
 if __name__ == '__main__':
diff --git a/src/mapi/glapi/gen/templates/enums.c.mako b/src/mapi/glapi/gen/templates/enums.c.mako
new file mode 100644
index 0000000000..a749511faa
--- /dev/null
+++ b/src/mapi/glapi/gen/templates/enums.c.mako
@@ -0,0 +1,136 @@
+## Copyright (C) 2015 Intel Corporation
+##
+## Permission is hereby granted, free of charge, to any person obtaining
+## a copy of this software and associated documentation files (the "Software"),
+## to deal in the Software without restriction, including without limitation
+## the rights to use, copy, modify, merge, publish, distribute, sublicense,
+## and/or sell copies of the Software, and to permit persons to whom the
+## Software is furnished to do so, subject to the following conditions:
+##
+## The above copyright notice and this permission notice shall be included
+## in all copies or substantial portions of the Software.
+##
+## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+## EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+## OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+## IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+## DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+## TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+## OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+##
+## In case it isn't obvious, this ## commented copyright header will not be
+## rendered into the actual template, it applies to the template.
+##
+<%namespace name="utils" file="utils.mako"/>
+
+${utils.copyright(['1999-2005 Brian Paul'], 'gl_enums.py')}
+
+#include "main/glheader.h"
+#include "main/enums.h"
+#include "main/imports.h"
+#include "main/mtypes.h"
+
+typedef struct PACKED {
+  uint16_t offset;
+  int n;
+} enum_elt;
+
+#if defined(__GNUC__)
+# define LONGSTRING __extension__
+#else
+# define LONGSTRING
+#endif
+
+LONGSTRING static const char enum_string_table[] =
+% for _, name in enums:
+  "${name}\0"
+% endfor
+  ;
+
+<% offset = 0 %>
+static const enum_elt enum_string_table_offsets[${len(enums)}] =
+{
+% for enum, name in enums:
+  ## The awful string formatter creates the hex format with padding.
+  { ${str(offset).rjust(5)}, ${"{0:#0{1}x}".format(enum, 10)} }, /* ${name} */
+  <% offset += len(name) + 1 %>\
+% endfor
+};
+
+
+typedef int (*cfunc)(const void *, const void *);
+
+/**
+ * Compare a key enum value to an element in the \c enum_string_table_offsets array.
+ *
+ * \c bsearch always passes the key as the first parameter and the pointer
+ * to the array element as the second parameter.  We can elimiate some
+ * extra work by taking advantage of that fact.
+ *
+ * \param a  Pointer to the desired enum name.
+ * \param b  Pointer into the \c enum_string_table_offsets array.
+ */
+static int compar_nr( const int *a, enum_elt *b )
+{
+   return a[0] - b->n;
+}
+
+
+static char token_tmp[20];
+
+const char *_mesa_lookup_enum_by_nr( int nr )
+{
+   enum_elt *elt;
+
+   STATIC_ASSERT(sizeof(enum_string_table) < (1 << 16));
+
+   elt = bsearch(& nr, enum_string_table_offsets,
+                 ARRAY_SIZE(enum_string_table_offsets),
+                 sizeof(enum_string_table_offsets[0]),
+                 (cfunc) compar_nr);
+
+   if (elt != NULL) {
+      return &enum_string_table[elt->offset];
+   }
+   else {
+      /* this is not re-entrant safe, no big deal here */
+      _mesa_snprintf(token_tmp, sizeof(token_tmp) - 1, "0x%x", nr);
+      token_tmp[sizeof(token_tmp) - 1] = '\0';
+      return token_tmp;
+   }
+}
+
+/**
+ * Primitive names
+ */
+static const char *prim_names[PRIM_MAX+3] = {
+   "GL_POINTS",
+   "GL_LINES",
+   "GL_LINE_LOOP",
+   "GL_LINE_STRIP",
+   "GL_TRIANGLES",
+   "GL_TRIANGLE_STRIP",
+   "GL_TRIANGLE_FAN",
+   "GL_QUADS",
+   "GL_QUAD_STRIP",
+   "GL_POLYGON",
+   "GL_LINES_ADJACENCY",
+   "GL_LINE_STRIP_ADJACENCY",
+   "GL_TRIANGLES_ADJACENCY",
+   "GL_TRIANGLE_STRIP_ADJACENCY",
+   "outside begin/end",
+   "unknown state"
+};
+
+
+/* Get the name of an enum given that it is a primitive type.  Avoids
+ * GL_FALSE/GL_POINTS ambiguity and others.
+ */
+const char *
+_mesa_lookup_prim_by_nr(GLuint nr)
+{
+   if (nr < ARRAY_SIZE(prim_names))
+      return prim_names[nr];
+   else
+      return "invalid mode";
+}