build/protoc_java.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5
   6 """Generate java source files from protobuf files.
   7
   8 This is a helper file for the genproto_java action in protoc_java.gypi.
   9
  10 It performs the following steps:
  11 1. Deletes all old sources (ensures deleted classes are not part of new jars).
  12 2. Creates source directory.
  13 3. Generates Java files using protoc (output into either --java-out-dir or
  14    --srcjar).
  15 4. Creates a new stamp file.
  16 """
  17
  18 import os
  19 import optparse
  20 import shutil
  21 import subprocess
  22 import sys
  23
  24 sys.path.append(os.path.join(os.path.dirname(__file__), "android", "gyp"))
  25 from util import build_utils
  26
  27 def main(argv):
  28   parser = optparse.OptionParser()
  29   build_utils.AddDepfileOption(parser)
  30   parser.add_option("--protoc", help="Path to protoc binary.")
  31   parser.add_option("--proto-path", help="Path to proto directory.")
  32   parser.add_option("--java-out-dir",
  33       help="Path to output directory for java files.")
  34   parser.add_option("--srcjar", help="Path to output srcjar.")
  35   parser.add_option("--stamp", help="File to touch on success.")
  36   parser.add_option("--nano",
  37       help="Use to generate nano protos.", action='store_true')
  38   parser.add_option("--protoc-javalite-plugin-dir",
  39       help="Path to protoc java lite plugin directory.")
  40   options, args = parser.parse_args(argv)
  41
  42   build_utils.CheckOptions(options, parser, ['protoc', 'proto_path'])
  43   if not options.java_out_dir and not options.srcjar:
  44     print 'One of --java-out-dir or --srcjar must be specified.'
  45     return 1
  46
  47   if not options.nano and not options.protoc_javalite_plugin_dir:
  48     print 'One of --nano or --protoc-javalite-plugin-dir must be specified.'
  49     return 1
  50
  51   with build_utils.TempDir() as temp_dir:
  52     if options.nano:
  53       # Specify arguments to the generator.
  54       generator_args = ['optional_field_style=reftypes',
  55                         'store_unknown_fields=true']
  56       out_arg = '--javanano_out=' + ','.join(generator_args) + ':' + temp_dir
  57     else:
  58       out_arg = '--javalite_out=' + temp_dir
  59
  60     custom_env = os.environ.copy()
  61     if options.protoc_javalite_plugin_dir:
  62       # if we are generating lite protos, then the lite plugin needs to be in the path when protoc
  63       # is called. See https://github.com/protocolbuffers/protobuf/blob/master/java/lite.md
  64       custom_env['PATH'] = '{}:{}'.format(
  65           os.path.abspath(options.protoc_javalite_plugin_dir), custom_env['PATH'])
  66
  67     # Generate Java files using protoc.
  68     build_utils.CheckOutput(
  69         [options.protoc, '--proto_path', options.proto_path, out_arg]
  70         + args, env=custom_env)
  71
  72     if options.java_out_dir:
  73       build_utils.DeleteDirectory(options.java_out_dir)
  74       shutil.copytree(temp_dir, options.java_out_dir)
  75     else:
  76       build_utils.ZipDir(options.srcjar, temp_dir)
  77
  78   if options.depfile:
  79     assert options.srcjar
  80     deps = args + [options.protoc]
  81     build_utils.WriteDepfile(options.depfile, options.srcjar, deps,
  82                              add_pydeps=False)
  83
  84   if options.stamp:
  85     build_utils.Touch(options.stamp)
  86
  87 if __name__ == '__main__':
  88   sys.exit(main(sys.argv[1:]))