Android: passes a list of qualified JNI parameters as a param to the generator.

base/android/jni_generator/jni_generator.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.
 
 # TODO (qinmin): Need to refactor this file as base should not know about
 # higher level concepts. Currently this file has knowledge about higher level
 # java classes.
 
 """Extracts native methods from a Java file and generates the JNI bindings.
 If you change this, please run and update the tests."""
 
 import collections
 import optparse
 import os
 import re
 import string
 from string import Template
 import subprocess
 import sys
 import textwrap
 import zipfile
 
 UNKNOWN_JAVA_TYPE_PREFIX = 'UNKNOWN_JAVA_TYPE: '
-
+EXTERNAL_PARAM_LIST = []
 
 class ParseError(Exception):
   """Exception thrown when we can't parse the input file."""
 
   def __init__(self, description, *context_lines):
     Exception.__init__(self)
     self.description = description
     self.context_lines = context_lines
 
   def __str__(self):
@@ skipping 97 matching lines @@
       'Ljava/util/ArrayList',
       'Ljava/util/HashMap',
       'Ljava/util/List',
       'Landroid/content/Context',
       'Landroid/graphics/Bitmap',
       'Landroid/graphics/Canvas',
       'Landroid/graphics/Rect',
       'Landroid/graphics/RectF',
       'Landroid/graphics/Matrix',
       'Landroid/graphics/Point',
+      'Landroid/graphics/SurfaceTexture',
       'Landroid/graphics/SurfaceTexture$OnFrameAvailableListener',
       'Landroid/media/MediaPlayer',
       'Landroid/os/Message',
       'Landroid/view/KeyEvent',
       'Landroid/view/Surface',
       'Landroid/view/View',
       'Landroid/webkit/ValueCallback',
       'Ljava/io/InputStream',
       'Ljava/nio/ByteBuffer',
       'Ljava/util/Vector',
   ]
-  app_param_list = [
-      'Landroid/graphics/SurfaceTexture',
-      'Lcom/google/android/apps/chrome/ChromeContextMenuInfo',
-      'Lcom/google/android/apps/chrome/ChromeWindow',
-      'Lcom/google/android/apps/chrome/GoogleLocationSettingsHelperImpl',
-      'Lcom/google/android/apps/chrome/OmniboxSuggestion',
-      'Lcom/google/android/apps/chrome/PageInfoViewer',
-      'Lcom/google/android/apps/chrome/Tab',
-      'Lcom/google/android/apps/chrome/infobar/AutoLogin',
-      'Lcom/google/android/apps/chrome/infobar/InfoBarContainer',
-      'Lcom/google/android/apps/chrome/infobar/InfoBarContainer$NativeInfoBar',
-      ('Lcom/google/android/apps/chrome/preferences/ChromeNativePreferences$'
-       'PasswordListObserver'),
-      'Lorg/chromium/android_webview/AwContents',
-      'Lorg/chromium/android_webview/AwContentsClient',
-      'Lorg/chromium/android_webview/AwHttpAuthHandler',
-      'Lorg/chromium/android_webview/AwContentsIoThreadClient',
-      'Lorg/chromium/android_webview/AwWebContentsDelegate',
-      'Lorg/chromium/android_webview/InterceptedRequestData',
-      'Lorg/chromium/android_webview/JsPromptResultReceiver',
-      'Lorg/chromium/android_webview/JsResultHandler',
-      'Lorg/chromium/android_webview/JsResultReceiver',
-      'Lorg/chromium/base/SystemMessageHandler',
-      'Lorg/chromium/chrome/browser/autofill/AutofillExternalDelegate',
-      'Lorg/chromium/chrome/browser/autofill/AutofillSuggestion',
-      'Lorg/chromium/chrome/browser/ChromeBrowserProvider$BookmarkNode',
-      'Lorg/chromium/chrome/browser/ChromeHttpAuthHandler',
-      'Lorg/chromium/chrome/browser/ChromeWebContentsDelegateAndroid',
-      'Lorg/chromium/chrome/browser/FindMatchRectsDetails',
-      'Lorg/chromium/chrome/browser/FindNotificationDetails',
-      'Lorg/chromium/chrome/browser/GoogleLocationSettingsHelper',
-      'Lorg/chromium/chrome/browser/GoogleLocationSettingsHelperStub',
-      'Lorg/chromium/chrome/browser/JavascriptAppModalDialog',
-      'Lorg/chromium/chrome/browser/ProcessUtils',
-      ('Lorg/chromium/chrome/browser/component/navigation_interception/'
-       'InterceptNavigationDelegate'),
-      ('Lorg/chromium/chrome/browser/component/web_contents_delegate_android/'
-       'WebContentsDelegateAndroid'),
-      'Lorg/chromium/chrome/browser/database/SQLiteCursor',
-      'Lorg/chromium/content/app/SandboxedProcessService',
-      'Lorg/chromium/content/browser/ContainerViewDelegate',
-      'Lorg/chromium/content/browser/ContentVideoView',
-      'Lorg/chromium/content/browser/ContentViewCore',
-      'Lorg/chromium/content/browser/DeviceOrientation',
-      'Lorg/chromium/content/browser/JavaInputStream',
-      'Lorg/chromium/content/browser/LocationProvider',
-      'Lorg/chromium/content/browser/SandboxedProcessArgs',
-      'Lorg/chromium/content/browser/SandboxedProcessConnection',
-      'Lorg/chromium/content/browser/TouchPoint',
-      'Lorg/chromium/content/browser/WaitableNativeEvent',
-      'Lorg/chromium/content/browser/WebContentsObserverAndroid',
-      'Lorg/chromium/content/common/DeviceInfo',
-      'Lorg/chromium/content/common/SurfaceTextureListener',
-      'Lorg/chromium/media/MediaPlayerListener',
-      'Lorg/chromium/net/NetworkChangeNotifier',
-      'Lorg/chromium/net/ProxyChangeListener',
-      'Lorg/chromium/ui/gfx/NativeWindow',
-      'Lorg/chromium/ui/SelectFileDialog',
-  ]
   if param == 'byte[][]':
     return '[[B'
   prefix = ''
   # Array?
   if param[-2:] == '[]':
     prefix = '['
     param = param[:-2]
   # Generic?
   if '<' in param:
     param = param[:param.index('<')]
   if param in pod_param_map:
     return prefix + pod_param_map[param]
   if '/' in param:
     # Coming from javap, use the fully qualified param directly.
     return 'L' + param + ';'
-  for qualified_name in object_param_list + app_param_list:
+  for qualified_name in object_param_list + EXTERNAL_PARAM_LIST:

[Nico, 2012/10/30 19:47:36]

CAPS_NAMES are usually constants, which this isn't really. Can't you just pass
this in as a parameter anyway?

[bulach, 2012/10/31 10:17:02]

good points, thanks nico!

I refactored this a bit and created a class JniParams for all of these functions
so that this global has a narrower scope.

     if (qualified_name.endswith('/' + param) or
         qualified_name.endswith('$' + param.replace('.', '$')) or
         qualified_name == 'L' + param):
       return prefix + qualified_name + ';'
   else:
     return UNKNOWN_JAVA_TYPE_PREFIX + prefix + param + ';'
 
 
 def JniSignature(params, returns, wrap):
   """Returns the JNI signature for the given datatypes."""
@@ skipping 320 matching lines @@
     self.fully_qualified_class = fully_qualified_class
     self.class_name = self.fully_qualified_class.split('/')[-1]
     self.natives = natives
     self.called_by_natives = called_by_natives
     self.header_guard = fully_qualified_class.replace('/', '_') + '_JNI'
     unknown_datatypes = GetUnknownDatatypes(self.natives +
                                             self.called_by_natives)
     if unknown_datatypes:
       msg = ('There are a few unknown datatypes in %s' %
              self.fully_qualified_class)
       msg += '\nPlease, edit %s' % sys.argv[0]

[Yaron, 2012/10/30 19:42:36]

Actually, with this change, this will no longer be correct. Can you include the
external_param_list file in the error message.

[bulach, 2012/10/31 10:17:02]

Done.

       msg += '\nand add the java type to JavaParamToJni()\n'
       for unknown_datatype in unknown_datatypes:
         msg += '\n%s in methods:\n' % unknown_datatype
         msg += '\n '.join(unknown_datatypes[unknown_datatype])
       raise SyntaxError(msg)
 
   def GetContent(self):
     """Returns the content of the JNI binding file."""
     template = Template("""\
 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
@@ skipping 424 matching lines @@
     sys.exit(1)
   if output_file:
     if not os.path.exists(os.path.dirname(os.path.abspath(output_file))):
       os.makedirs(os.path.dirname(os.path.abspath(output_file)))
     with file(output_file, 'w') as f:
       f.write(content)
   else:
     print output
 
 
+def ReadExtraAppParamList(external_param_files):
+  if not external_param_files:
+    return
+  for external_param_file in set(external_param_files):
+    with file(external_param_file, 'r') as f:
+      contents = f.read()
+      global EXTERNAL_PARAM_LIST
+      EXTERNAL_PARAM_LIST += [x.strip() for x in contents.splitlines()
+                              if x and not x.startswith('#')]
+
+
 def main(argv):
   usage = """usage: %prog [OPTIONS]
 This script will parse the given java source code extracting the native
 declarations and print the header file to stdout (or a file).
 See SampleForTests.java for more details.
   """
   option_parser = optparse.OptionParser(usage=usage)
   option_parser.add_option('-j', dest='jar_file',
                            help='Extract the list of input files from'
                            ' a specified jar file.'
                            ' Uses javap to extract the methods from a'
                            ' pre-compiled class. --input should point'
                            ' to pre-compiled Java .class files.')
   option_parser.add_option('-n', dest='namespace',
                            help='Uses as a namespace in the generated header,'
                            ' instead of the javap class name.')
   option_parser.add_option('--input_file',
                            help='Single input file name. The output file name '
                            'will be derived from it. Must be used with '
                            '--output_dir.')
   option_parser.add_option('--output_dir',
                            help='The output directory. Must be used with '
                            '--input')
+  option_parser.add_option('--external_param_list',
+                           help='A file name containing a list with extra '
+                           'fully-qualified param names. Can be used multiple '
+                           'times.',
+                           action='append')
   options, args = option_parser.parse_args(argv)
+  ReadExtraAppParamList(options.external_param_list)
   if options.jar_file:
     input_file = ExtractJarInputFile(options.jar_file, options.input_file,
                                      options.output_dir)
   else:
     input_file = options.input_file
   output_file = None
   if options.output_dir:
     root_name = os.path.splitext(os.path.basename(input_file))[0]
     output_file = os.path.join(options.output_dir, root_name) + '_jni.h'
   GenerateJNIHeader(input_file, output_file, options.namespace)
 
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv))