build/gecko_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 GeckoBinary(linkage='dependent', msvcrt='dynamic', mozglue=None):
   9     '''Template for Gecko-related binaries.
  10
  11     This template is meant to be used in other templates.
  12
  13     `linkage` indicates the wanted xpcom linkage type. Valid values are
  14     'dependent', 'standalone' or None. 'dependent' is the default. It is
  15     used for e.g. XPCOM components and executables with direct dependencies
  16     on libxul. Most executables should use the 'standalone' linkage, which
  17     uses the standalone XPCOM glue to load libxul. None means no XPCOM glue
  18     or libxul linkage at all.
  19
  20     `msvcrt` indicates which Microsoft Visual Studio CRT, for Windows build,
  21     ought to be linked: 'static' or 'dynamic'.
  22
  23     `mozglue` indicates whether to link against the mozglue library, and if
  24     so, what linkage to apply. Valid values are None (mozglue not linked),
  25     'program' (mozglue linked to an executable program), or 'library' (mozglue
  26     linked to a shared library).
  27     '''
  28     if msvcrt == 'dynamic' or CONFIG['OS_ARCH'] != 'WINNT' or CONFIG['MOZ_ASAN']:
  29         xpcomglue = 'xpcomglue'
  30     elif msvcrt == 'static':
  31         USE_STATIC_LIBS = True
  32         xpcomglue = 'xpcomglue_staticruntime'
  33         if not CONFIG['GNU_CC']:
  34             mozglue = None
  35             if linkage == 'dependent':
  36                 USE_LIBS += [
  37                     'mozalloc_staticruntime',
  38                 ]
  39     else:
  40         error('msvcrt must be "dynamic" or "static"')
  41
  42     if linkage == 'dependent':
  43         USE_LIBS += [
  44             'nspr',
  45             'xul',
  46         ]
  47     elif linkage == 'standalone':
  48         DEFINES['XPCOM_GLUE'] = True
  49
  50         USE_LIBS += [
  51             xpcomglue,
  52         ]
  53     elif linkage != None:
  54         error('`linkage` must be "dependent", "standalone" or None')
  55
  56     if mozglue:
  57         LDFLAGS += CONFIG['MOZ_GLUE_WRAP_LDFLAGS']
  58         if mozglue == 'program':
  59             USE_LIBS += ['mozglue']
  60             DEFINES['MOZ_HAS_MOZGLUE'] = True
  61             if CONFIG['MOZ_GLUE_IN_PROGRAM']:
  62                 if CONFIG['GNU_CC']:
  63                     LDFLAGS += ['-rdynamic']
  64                 if CONFIG['MOZ_MEMORY']:
  65                     USE_LIBS += ['memory']
  66         elif mozglue == 'library':
  67             LIBRARY_DEFINES['MOZ_HAS_MOZGLUE'] = True
  68             if not CONFIG['MOZ_GLUE_IN_PROGRAM']:
  69                 USE_LIBS += ['mozglue']
  70         else:
  71             error('`mozglue` must be "program" or "library"')
  72
  73     if not CONFIG['JS_STANDALONE']:
  74         USE_LIBS += [
  75             'fallible',
  76         ]
  77
  78
  79 @template
  80 def GeckoProgram(name, linkage='standalone', **kwargs):
  81     '''Template for program executables related to Gecko.
  82
  83     `name` identifies the executable base name.
  84
  85     See the documentation for `GeckoBinary` for other possible arguments,
  86     with the notable difference that the default for `linkage` is 'standalone'.
  87     '''
  88     Program(name)
  89
  90     kwargs.setdefault('mozglue', 'program')
  91
  92     GeckoBinary(linkage=linkage, **kwargs)
  93
  94
  95 @template
  96 def GeckoSimplePrograms(names, **kwargs):
  97     '''Template for simple program executables related to Gecko.
  98
  99     `names` identifies the executable base names for each executable.
 100
 101     See the documentation for `GeckoBinary` for other possible arguments.
 102     '''
 103     SimplePrograms(names)
 104
 105     kwargs.setdefault('mozglue', 'program')
 106
 107     GeckoBinary(**kwargs)
 108
 109
 110 @template
 111 def GeckoCppUnitTests(names, **kwargs):
 112     '''Template for C++ unit tests related to Gecko.
 113
 114     `names` identifies the executable base names for each executable.
 115
 116     See the documentation for `GeckoBinary` for other possible arguments.
 117     '''
 118     CppUnitTests(names)
 119
 120     kwargs.setdefault('mozglue', 'program')
 121
 122     GeckoBinary(**kwargs)
 123
 124
 125 @template
 126 def GeckoSharedLibrary(name, **kwargs):
 127     '''Template for shared libraries related to Gecko.
 128
 129     `name` identifies the library base name.
 130     See the documentation for `GeckoBinary` for other possible arguments.
 131     '''
 132     SharedLibrary(name)
 133
 134     kwargs.setdefault('mozglue', 'library')
 135
 136     GeckoBinary(**kwargs)
 137
 138
 139 @template
 140 def GeckoFramework(name, **kwargs):
 141     '''Template for OSX frameworks related to Gecko.
 142
 143     `name` identifies the library base name.
 144     See the documentation for `GeckoBinary` for other possible arguments.
 145     '''
 146     Framework(name)
 147
 148     kwargs.setdefault('mozglue', 'library')
 149
 150     GeckoBinary(**kwargs)
 151
 152
 153 @template
 154 def XPCOMBinaryComponent(name):
 155     '''Template defining an XPCOM binary component for Gecko.
 156
 157     `name` is the name of the component.
 158     '''
 159     GeckoSharedLibrary(name)
 160
 161     IS_COMPONENT = True