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
   8 @template
   9 def GeckoBinary(linkage="dependent", mozglue=None):
  10     """Template for Gecko-related binaries.
  11
  12     This template is meant to be used in other templates.
  13
  14     `linkage` indicates the wanted xpcom linkage type. Valid values are
  15     'dependent', 'standalone' or None. 'dependent' is the default. It is
  16     used for e.g. XPCOM components and executables with direct dependencies
  17     on libxul. Most executables should use the 'standalone' linkage, which
  18     uses the standalone XPCOM glue to load libxul. None means no XPCOM glue
  19     or libxul linkage at all.
  20
  21     `mozglue` indicates whether to link against the mozglue library, and if
  22     so, what linkage to apply. Valid values are None (mozglue not linked),
  23     'program' (mozglue linked to an executable program), or 'library' (mozglue
  24     linked to a shared library).
  25     """
  26     if linkage == "dependent":
  27         USE_LIBS += [
  28             "nspr",
  29             "xul-real",
  30         ]
  31     elif linkage == "standalone":
  32         DEFINES["XPCOM_GLUE"] = True
  33
  34         USE_LIBS += [
  35             "xpcomglue",
  36         ]
  37     elif linkage != None:
  38         error('`linkage` must be "dependent", "standalone" or None')
  39
  40     if mozglue:
  41         if mozglue == "program":
  42             USE_LIBS += ["mozglue"]
  43             DEFINES["MOZ_HAS_MOZGLUE"] = True
  44             if CONFIG["MOZ_GLUE_IN_PROGRAM"] and CONFIG["CC_TYPE"] in ("clang", "gcc"):
  45                 LDFLAGS += ["-rdynamic"]
  46         elif mozglue == "library":
  47             LIBRARY_DEFINES["MOZ_HAS_MOZGLUE"] = True
  48             if not CONFIG["MOZ_GLUE_IN_PROGRAM"]:
  49                 USE_LIBS += ["mozglue"]
  50         else:
  51             error('`mozglue` must be "program" or "library"')
  52
  53
  54 @template
  55 def GeckoProgram(name, linkage="standalone", **kwargs):
  56     """Template for program executables related to Gecko.
  57
  58     `name` identifies the executable base name.
  59
  60     See the documentation for `GeckoBinary` for other possible arguments,
  61     with the notable difference that the default for `linkage` is 'standalone'.
  62     """
  63     Program(name)
  64
  65     kwargs.setdefault("mozglue", "program")
  66
  67     GeckoBinary(linkage=linkage, **kwargs)
  68
  69
  70 @template
  71 def GeckoSimplePrograms(names, **kwargs):
  72     """Template for simple program executables related to Gecko.
  73
  74     `names` identifies the executable base names for each executable.
  75
  76     See the documentation for `GeckoBinary` for other possible arguments.
  77     """
  78     SimplePrograms(names)
  79
  80     kwargs.setdefault("mozglue", "program")
  81
  82     GeckoBinary(**kwargs)
  83
  84
  85 @template
  86 def GeckoCppUnitTests(names, **kwargs):
  87     """Template for C++ unit tests related to Gecko.
  88
  89     `names` identifies the executable base names for each executable.
  90
  91     See the documentation for `GeckoBinary` for other possible arguments.
  92     """
  93     CppUnitTests(names)
  94
  95     kwargs.setdefault("mozglue", "program")
  96
  97     GeckoBinary(**kwargs)
  98
  99
 100 @template
 101 def GeckoSharedLibrary(name, output_category=None, **kwargs):
 102     """Template for shared libraries related to Gecko.
 103
 104     `name` identifies the library base name.
 105     See the documentation for `GeckoBinary` for other possible arguments.
 106     """
 107     SharedLibrary(name, output_category)
 108
 109     kwargs.setdefault("mozglue", "library")
 110
 111     GeckoBinary(**kwargs)
 112
 113
 114 @template
 115 def GeckoFramework(name, output_category=None, **kwargs):
 116     """Template for OSX frameworks related to Gecko.
 117
 118     `name` identifies the library base name.
 119     See the documentation for `GeckoBinary` for other possible arguments.
 120     """
 121     Framework(name, output_category)
 122
 123     kwargs.setdefault("mozglue", "library")
 124
 125     GeckoBinary(**kwargs)