gyp_packager.py

#!/usr/bin/python3
#
# Copyright 2014 Google Inc. All rights reserved.
#
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file or at
# https://developers.google.com/open-source/licenses/bsd
"""This script wraps gyp and sets up build environments.

Build instructions:

1. Setup gyp: ./gyp_packager.py or use gclient runhooks

Ninja is the default build system. User can also change to make by
overriding GYP_GENERATORS to make, i.e.
"GYP_GENERATORS='make' gclient runhooks".

2. The first step generates the make files but does not start the
build process. Ninja is the default build system. Refer to Ninja
manual on how to do the build.

Common syntaxes: ninja -C out/{Debug/Release} [Module]
Module is optional. If not specified, build everything.

Step 1 is only required if there is any gyp file change. Otherwise, you
may just run ninja.
"""

import os
import sys

checkout_dir = os.path.dirname(os.path.realpath(__file__))
src_dir = os.path.join(checkout_dir, 'packager')

# Workaround the dynamic path.
# pylint: disable=wrong-import-position

sys.path.insert(0, os.path.join(src_dir, 'build'))
import gyp_helper

sys.path.insert(0, os.path.join(src_dir, 'tools', 'gyp', 'pylib'))
import gyp

if __name__ == '__main__':
  args = sys.argv[1:]

  # Allow src/.../chromium.gyp_env to define GYP variables.
  gyp_helper.apply_chromium_gyp_env()

  # If we didn't get a gyp file, then fall back to assuming 'packager.gyp' from
  # the same directory as the script.
  if not any(arg.endswith('.gyp') for arg in args):
    args.append(os.path.join(src_dir, 'packager.gyp'))

  # Always include Chromium's common.gypi and our common.gypi.
  args.extend([
      '-I' + os.path.join(src_dir, 'build', 'common.gypi'),
      '-I' + os.path.join(src_dir, 'common.gypi')
  ])

  # Set these default GYP_DEFINES if user does not set the value explicitly.
  _DEFAULT_DEFINES = {'test_isolation_mode': 'noop',
                      'use_custom_libcxx': 0,
                      'use_glib': 0,
                      'use_openssl': 1,
                      'use_sysroot': 0,
                      'use_x11': 0,
                      'linux_use_bundled_binutils': 0,
                      'linux_use_bundled_gold': 0,
                      'linux_use_gold_flags': 0,
                      'clang': 0,
                      'host_clang': 0,
                      'clang_xcode': 1,
                      'use_allocator': 'none',
                      'mac_deployment_target': '10.10',
                      'use_experimental_allocator_shim': 0,
                      'clang_use_chrome_plugins': 0}

  gyp_defines_str = os.environ.get('GYP_DEFINES', '')
  user_gyp_defines_map = {}
  for term in gyp_defines_str.split(' '):
    if term:
      key, value = term.strip().split('=')
      user_gyp_defines_map[key] = value

  for key, value in _DEFAULT_DEFINES.items():
    if key not in user_gyp_defines_map:
      gyp_defines_str += ' {0}={1}'.format(key, value)
  os.environ['GYP_DEFINES'] = gyp_defines_str.strip()

  # Default to ninja, but only if no generator has explicitly been set.
  if 'GYP_GENERATORS' not in os.environ:
    os.environ['GYP_GENERATORS'] = 'ninja'

  # By default, don't download our own toolchain for Windows.
  if 'DEPOT_TOOLS_WIN_TOOLCHAIN' not in os.environ:
    os.environ['DEPOT_TOOLS_WIN_TOOLCHAIN'] = '0'

  # There shouldn't be a circular dependency relationship between .gyp files,
  # but in Chromium's .gyp files, on non-Mac platforms, circular relationships
  # currently exist.  The check for circular dependencies is currently
  # bypassed on other platforms, but is left enabled on the Mac, where a
  # violation of the rule causes Xcode to misbehave badly.
  if 'xcode' not in os.environ['GYP_GENERATORS']:
    args.append('--no-circular-check')

  # TODO(kqyang): Find a better way to handle the depth. This workaround works
  # only if this script is executed in 'src' directory.
  if not any('--depth' in arg for arg in args):
    args.append('--depth=packager')

  if 'output_dir=' not in os.environ.get('GYP_GENERATOR_FLAGS', ''):
    output_dir = os.path.join(checkout_dir, 'out')
    gyp_generator_flags = 'output_dir="' + output_dir + '"'
    if os.environ.get('GYP_GENERATOR_FLAGS'):
      os.environ['GYP_GENERATOR_FLAGS'] += ' ' + gyp_generator_flags
    else:
      os.environ['GYP_GENERATOR_FLAGS'] = gyp_generator_flags

  print('Updating projects from gyp files...')
  sys.stdout.flush()

  # Off we go...
  sys.exit(gyp.main(args))