build/templates.mozbuild

   1 # -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*-
   2 # vim: set filetype=python:
   3 # This Source Code Form is subject to the terms of the Mozilla Public
   4 # License, v. 2.0. If a copy of the MPL was not distributed with this
   5 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   6
   7 @template
   8 def Binary():
   9     '''Generic template for target binaries. Meant to be used by other
  10     templates.'''
  11
  12     # Add -llog by default, since we use it all over the place.
  13     if CONFIG['OS_TARGET'] == 'Android':
  14         OS_LIBS += ['log']
  15
  16
  17 @template
  18 def Program(name):
  19     '''Template for program executables.'''
  20     PROGRAM = name
  21
  22     Binary()
  23
  24
  25 @template
  26 def SimplePrograms(names, ext='.cpp'):
  27     '''Template for simple program executables.
  28
  29     Those have a single source with the same base name as the executable.
  30     '''
  31     SIMPLE_PROGRAMS += names
  32     SOURCES += ['%s%s' % (name, ext) for name in names]
  33
  34     Binary()
  35
  36
  37 @template
  38 def CppUnitTests(names, ext='.cpp'):
  39     '''Template for C++ unit tests.
  40
  41     Those have a single source with the same base name as the executable.
  42     '''
  43     COMPILE_FLAGS['EXTRA_INCLUDES'] = ['-I%s/dist/include' % TOPOBJDIR,
  44                                        '-I%s/dist/include/testing' % TOPOBJDIR]
  45     CPP_UNIT_TESTS += names
  46     SOURCES += ['%s%s' % (name, ext) for name in names]
  47
  48     Binary()
  49
  50
  51 @template
  52 def Library(name):
  53     '''Template for libraries.'''
  54     LIBRARY_NAME = name
  55
  56 @template
  57 def AllowCompilerWarnings():
  58     COMPILE_FLAGS['WARNINGS_AS_ERRORS'] = []
  59     WASM_FLAGS['WARNINGS_AS_ERRORS'] = []
  60
  61 @template
  62 def DisableCompilerWarnings():
  63     COMPILE_FLAGS['WARNINGS_CFLAGS'] = []
  64
  65 @template
  66 def RustLibrary(name, features=None, output_category=None, is_gkrust=False):
  67     '''Template for Rust libraries.'''
  68     Library(name)
  69
  70     IS_RUST_LIBRARY = True
  71     # Some Rust build scripts compile C/C++ sources, don't error on warnings for them.
  72     AllowCompilerWarnings()
  73
  74     # And furthermore, don't even show warnings for them, so they don't regress
  75     # the Compiler Warnings build metric
  76     # <https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Automated_Performance_Testing_and_Sheriffing/Build_Metrics#compiler_warnings>.
  77     DisableCompilerWarnings()
  78
  79     if features:
  80         RUST_LIBRARY_FEATURES = features
  81
  82     if output_category:
  83         RUST_LIBRARY_OUTPUT_CATEGORY = output_category
  84
  85     if is_gkrust:
  86         IS_GKRUST = True
  87
  88
  89 @template
  90 def SharedLibrary(name, output_category=None):
  91     '''Template for shared libraries.'''
  92     Library(name)
  93
  94     FORCE_SHARED_LIB = True
  95
  96     if output_category:
  97         SHARED_LIBRARY_OUTPUT_CATEGORY = output_category
  98
  99     Binary()
 100
 101
 102 @template
 103 def Framework(name, output_category=None):
 104     '''Template for OSX Frameworks.'''
 105     SharedLibrary(name, output_category)
 106
 107     IS_FRAMEWORK = True
 108
 109
 110 @template
 111 def HostProgram(name):
 112     '''Template for build tools executables.'''
 113     HOST_PROGRAM = name
 114
 115
 116 @template
 117 def HostSimplePrograms(names, ext='.cpp'):
 118     '''Template for simple build tools executables.
 119
 120     Those have a single source with the same base name as the executable.
 121     '''
 122     HOST_SIMPLE_PROGRAMS += names
 123     HOST_SOURCES += ['%s%s' % (name.replace('host_', ''), ext)
 124         for name in names]
 125
 126
 127 @template
 128 def HostSharedLibrary(name):
 129     '''Template for build tools libraries.'''
 130     if name != 'clang-plugin':
 131         error('Please make sure host shared library support is complete '
 132               'before using for something else than the clang plugin')
 133
 134     HOST_LIBRARY_NAME = name
 135
 136     FORCE_SHARED_LIB = True
 137
 138 @template
 139 def HostLibrary(name):
 140     '''Template for build tools libraries.'''
 141     HOST_LIBRARY_NAME = name
 142
 143 @template
 144 def HostRustLibrary(name, features=None):
 145     '''Template for host Rust libraries.'''
 146     HostLibrary(name)
 147
 148     IS_RUST_LIBRARY = True
 149     # Some Rust build scripts compile C/C++ sources, don't error on warnings for them.
 150     AllowCompilerWarnings()
 151
 152     if features:
 153         HOST_RUST_LIBRARY_FEATURES = features
 154
 155 @template
 156 def DisableStlWrapping():
 157     COMPILE_FLAGS['STL'] = []
 158
 159 @template
 160 def NoVisibilityFlags():
 161     COMPILE_FLAGS['VISIBILITY'] = []
 162
 163 @template
 164 def ForceInclude(*headers):
 165     """Force includes a set of header files in C++ compilations"""
 166     if CONFIG['CC_TYPE'] == 'clang-cl':
 167         include_flag = '-FI'
 168     else:
 169         include_flag = '-include'
 170     for header in headers:
 171         CXXFLAGS += [include_flag, header]
 172
 173 @template
 174 def GeneratedFile(name, *names, **kwargs):
 175     """Add one or more GENERATED_FILES with the given attributes.
 176
 177     You must pass in at least one generated file (the "name" argument). Other
 178     names can be included as positional arguments after "name"."""
 179     script = kwargs.pop('script', None)
 180     entry_point = kwargs.pop('entry_point', None)
 181     inputs = kwargs.pop('inputs', [])
 182     flags = kwargs.pop('flags', [])
 183     force = kwargs.pop('force', False)
 184     if kwargs:
 185         error('Unrecognized argument(s) to GeneratedFile: %s' %
 186               ', '.join(kwargs))
 187     if entry_point and not script:
 188        error('entry_point cannot be provided if script is not provided')
 189     if script and ':' in script:
 190        error('script should not include a `:`. If you want to provide an '
 191              'alternative entry point for your script, use the entry_point '
 192              'parameter.')
 193
 194     key = (name,) + names if names else name
 195     GENERATED_FILES += [key]
 196     generated_file = GENERATED_FILES[key]
 197     if script and not entry_point:
 198         generated_file.script = script
 199     if script and entry_point:
 200         generated_file.script = script + ':' + entry_point
 201     generated_file.inputs = inputs
 202     generated_file.flags = flags
 203     generated_file.force = force
 204
 205 @template
 206 def CbindgenHeader(name, inputs):
 207     """Add one GENERATED_FILES by running RunCbindgen.py"""
 208
 209     inputs = ['!/config/cbindgen-metadata.json'] + inputs
 210     GeneratedFile(name, script='/build/RunCbindgen.py',
 211                   entry_point='generate', inputs=inputs)
 212
 213
 214 include('gecko_templates.mozbuild')