Allow tests to stub out GL draw calls.

ui/gl/generate_bindings.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """code generator for GL/GLES extension wrangler."""
 
 import optparse
 import os
 import collections
@@ skipping 743 matching lines @@
   'arguments': 'GLuint array',
   'other_extensions': ['OES_vertex_array_object',
                        'APPLE_vertex_array_object',
                        'ARB_vertex_array_object'] },
 { 'return_type': 'void',
   'names': ['glDiscardFramebufferEXT', 'glInvalidateFramebuffer'],
   'arguments': 'GLenum target, GLsizei numAttachments, '
       'const GLenum* attachments' },
 ]
 
+GL_NULLDRAW_FUNCTIONS = [
+{ 'return_type': 'void',
+  'names': ['glClear'],
+  'arguments': 'GLbitfield mask', },
+{ 'return_type': 'void',
+  'names': ['glDrawArrays'],
+  'arguments': 'GLenum mode, GLint first, GLsizei count', },
+{ 'return_type': 'void',
+  'names': ['glDrawElements'],
+  'arguments':
+      'GLenum mode, GLsizei count, GLenum type, const void* indices', },
+]
+
 OSMESA_FUNCTIONS = [
 { 'return_type': 'OSMesaContext',
   'names': ['OSMesaCreateContext'],
   'arguments': 'GLenum format, OSMesaContext sharelist', },
 { 'return_type': 'OSMesaContext',
   'names': ['OSMesaCreateContextExt'],
   'arguments':
       'GLenum format, GLint depthBits, GLint stencilBits, GLint accumBits, '
       'OSMesaContext sharelist', },
 { 'return_type': 'void',
@@ skipping 410 matching lines @@
       'Display* dpy, GLXDrawable drawable, int64* ust, int64* msc, '
       'int64* sbc' },
 { 'return_type': 'bool',
   'names': ['glXGetMscRateOML'],
   'arguments':
       'Display* dpy, GLXDrawable drawable, int32* numerator, '
       'int32* denominator' },
 ]
 
 FUNCTION_SETS = [
-  [GL_FUNCTIONS, 'gl', [
+  [GL_FUNCTIONS, GL_NULLDRAW_FUNCTIONS, 'gl', [
       'GL/glext.h',
       'GLES2/gl2ext.h',
       # Files below are Chromium-specific and shipped with Chromium sources.
       'GL/glextchromium.h',
       'GLES2/gl2chromium.h',
       'GLES2/gl2extchromium.h'
   ], []],
-  [OSMESA_FUNCTIONS, 'osmesa', [], []],
-  [EGL_FUNCTIONS, 'egl', [
+  [OSMESA_FUNCTIONS, [], 'osmesa', [], []],
+  [EGL_FUNCTIONS, [], 'egl', [
       'EGL/eglext.h',
       # Files below are Chromium-specific and shipped with Chromium sources.
       'EGL/eglextchromium.h',
     ],
     [
       'EGL_ANGLE_d3d_share_handle_client_buffer',
       'EGL_ANGLE_surface_d3d_texture_2d_share_handle',
     ],
   ],
-  [WGL_FUNCTIONS, 'wgl', ['GL/wglext.h'], []],
-  [GLX_FUNCTIONS, 'glx', ['GL/glx.h', 'GL/glxext.h'], []],
+  [WGL_FUNCTIONS, [], 'wgl', ['GL/wglext.h'], []],
+  [GLX_FUNCTIONS, [], 'glx', ['GL/glx.h', 'GL/glxext.h'], []],
 ]
 
 def GenerateHeader(file, functions, set_name, used_extension_functions):
   """Generates gl_bindings_autogen_x.h"""
 
   # Write file header.
   file.write(
 """// Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
@@ skipping 125 matching lines @@
   for func in functions:
     args = func['arguments']
     if args == 'void':
       args = ''
     file.write('  virtual %s %s(%s) = 0;\n' %
       (func['return_type'], func['names'][0][2:], args))
 
   file.write('\n')
 
 
-def GenerateSource(file, functions, set_name, used_extension_functions):
+def GenerateSource(
+  file, functions, nulldraw_functions, set_name, used_extension_functions):
   """Generates gl_bindings_autogen_x.cc"""
 
   # Write file header.
   file.write(
 """// Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file is automatically generated.
 
@@ skipping 55 matching lines @@
       file.write(
          '    fn.%sFn = reinterpret_cast<%sProc>(GetGLProcAddress("%s"));\n' %
              (entry_point_name, entry_point_name, function_name))
       queried_entry_points.add(entry_point_name)
     file.write('  }\n')
   file.write('  if (g_debugBindingsInitialized)\n')
   file.write('    UpdateDebugExtensionBindings();\n')
   file.write('}\n')
   file.write('\n')
 
+  # Write empty stubs for functions that want one.
+  file.write('extern "C" {\n')
+  for func in nulldraw_functions:
+    names = func['names']
+    return_type = func['return_type']
+    arguments = func['arguments']
+    file.write('\n')
+    file.write('static %s GL_BINDING_CALL Stub_%s(%s) {}\n' %
+        (return_type, names[0], arguments))
+  file.write('}  // extern "C"\n')
+
   # Write logging wrappers for each function.
   file.write('extern "C" {\n')
   for func in functions:
     names = func['names']
     return_type = func['return_type']
     arguments = func['arguments']
     file.write('\n')
     file.write('static %s GL_BINDING_CALL Debug_%s(%s) {\n' %
         (return_type, names[0], arguments))
     argument_names = re.sub(
@@ skipping 59 matching lines @@
              set_name.upper())
   for func in functions:
     first_name = func['names'][0]
     file.write('  if (!debug_fn.%sFn) {\n' % first_name)
     file.write('    debug_fn.%sFn = fn.%sFn;\n' % (first_name, first_name))
     file.write('    fn.%sFn = Debug_%s;\n' % (first_name, first_name))
     file.write('  }\n')
   file.write('  g_debugBindingsInitialized = true;\n')
   file.write('}\n')
 
+  # Write function to initialize the nulldraw function pointers.
+  if nulldraw_functions:
+    file.write('\n')
+    file.write('void Driver%s::InitializeNullDrawBindings() {\n' %
+               set_name.upper())
+
+    for func in nulldraw_functions:
+      first_name = func['names'][0]
+      file.write('  fn.%sFn = Stub_%s;\n' % (first_name, first_name))
+    file.write('}\n')
+
   # Write function to update the debug function pointers to extension functions
   # after the extensions have been initialized.
   file.write('\n')
   file.write('void Driver%s::UpdateDebugExtensionBindings() {\n' %
              set_name.upper())
   for extension, ext_functions in used_extension_functions:
     for name, _ in ext_functions:
       file.write('  if (debug_fn.%sFn != fn.%sFn &&\n' % (name, name))
       file.write('      fn.%sFn != Debug_%s) {\n' % (name, name))
       file.write('    debug_fn.%sFn = fn.%sFn;\n' % (name, name))
@@ skipping 264 matching lines @@
 def main(argv):
   """This is the main function."""
 
   parser = optparse.OptionParser()
   parser.add_option('--inputs', action='store_true')
   parser.add_option('--header-paths')
 
   options, args = parser.parse_args(argv)
 
   if options.inputs:
-    for [_, _, headers, _] in FUNCTION_SETS:
+    for [_, _, _, headers, _] in FUNCTION_SETS:
       for header in headers:
         print ResolveHeader(header, options.header_paths)
     return 0
 
   if len(args) >= 1:
     dir = args[0]
   else:
     dir = '.'
 
-  for [functions, set_name, extension_headers, extensions] in FUNCTION_SETS:
+  for [functions,
+       nulldraw_functions,
+       set_name,
+       extension_headers,
+       extensions] in FUNCTION_SETS:
     extension_headers = [ResolveHeader(h, options.header_paths)
                          for h in extension_headers]
     used_extension_functions = GetUsedExtensionFunctions(
         functions, extension_headers, extensions)
 
     header_file = open(
         os.path.join(dir, 'gl_bindings_autogen_%s.h' % set_name), 'wb')
     GenerateHeader(header_file, functions, set_name, used_extension_functions)
     header_file.close()
 
     header_file = open(
         os.path.join(dir, 'gl_bindings_api_autogen_%s.h' % set_name), 'wb')
     GenerateAPIHeader(
         header_file, functions, set_name, used_extension_functions)
     header_file.close()
 
     source_file = open(
         os.path.join(dir, 'gl_bindings_autogen_%s.cc' % set_name), 'wb')
-    GenerateSource(source_file, functions, set_name, used_extension_functions)
+    GenerateSource(source_file,
+                   functions,
+                   nulldraw_functions,
+                   set_name,
+                   used_extension_functions)
     source_file.close()
 
     header_file = open(
         os.path.join(dir, 'gl_interface_autogen_%s.h' % set_name), 'wb')
     GenerateInterfaceHeader(
         header_file, functions, set_name, used_extension_functions)
     header_file.close()
 
     header_file = open(
         os.path.join(dir, 'gl_mock_autogen_%s.h' % set_name), 'wb')
     GenerateMockHeader(
         header_file, functions, set_name, used_extension_functions)
     header_file.close()
 
   source_file = open(os.path.join(dir, 'gl_bindings_autogen_mock.cc'), 'wb')
   GenerateMockSource(source_file, GL_FUNCTIONS)
   source_file.close()
   return 0
 
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv[1:]))