test/CPPDEFINES/fixture/SConstruct-Prepend

   1 # SPDX-License-Identifier: MIT
   2 #
   3 # Copyright The SCons Foundation
   4
   5 """Prepend/PrependUnique tests"""
   6
   7 DefaultEnvironment(tools=[])
   8
   9 # Special cases:
  10 # https://github.com/SCons/scons/issues/1738
  11 env_1738_2 = Environment(tools=['cc'],CPPDEFPREFIX='-D')
  12 env_1738_2['CPPDEFINES'] = ['FOO']
  13 env_1738_2.Prepend(CPPDEFINES={'value': '1'})
  14 print(env_1738_2.subst('$_CPPDEFFLAGS'))
  15 # env_1738_2.Object('test_1738_2', 'main.c')
  16
  17 # https://github.com/SCons/scons/issues/2300
  18 env_2300_1 = Environment(tools=['cc'],CPPDEFINES='foo', CPPDEFPREFIX='-D')
  19 env_2300_1.Prepend(CPPDEFINES='bar')
  20 print(env_2300_1.subst('$_CPPDEFFLAGS'))
  21
  22 env_2300_2 = Environment(tools=['cc'],CPPDEFINES=['foo'], CPPDEFPREFIX='-D')  # note the list
  23 env_2300_2.Prepend(CPPDEFINES='bar')
  24 print(env_2300_2.subst('$_CPPDEFFLAGS'))
  25
  26 # An initial space-separated string will be split, but not a string in a list.
  27 env_multi = Environment(tools=['cc'],CPPDEFPREFIX='-D')
  28 env_multi['CPPDEFINES'] = "foo bar"
  29 env_multi.Prepend(CPPDEFINES="baz")
  30 print(env_multi.subst('$_CPPDEFFLAGS'))
  31
  32 env_multi = Environment(tools=['cc'],CPPDEFPREFIX='-D')
  33 env_multi['CPPDEFINES'] = ["foo bar"]
  34 env_multi.Prepend(CPPDEFINES="baz")
  35 print(env_multi.subst('$_CPPDEFFLAGS'))
  36
  37 env_multi = Environment(tools=['cc'],CPPDEFPREFIX='-D')
  38 env_multi['CPPDEFINES'] = "foo"
  39 env_multi.Prepend(CPPDEFINES=["bar baz"])
  40 print(env_multi.subst('$_CPPDEFFLAGS'))
  41
  42 env_multi = Environment(tools=['cc'],CPPDEFPREFIX='-D')
  43 env_multi['CPPDEFINES'] = "foo"
  44 env_multi.Prepend(CPPDEFINES="bar baz")
  45 print(env_multi.subst('$_CPPDEFFLAGS'))
  46
  47 # Check that PrependUnique(..., delete_existing=True) works as expected.
  48 # Each addition is in different but matching form, and different order
  49 # so we expect a reordered list, but with the same macro defines.
  50 env_multi = Environment(tools=['cc'],CPPDEFPREFIX='-D')
  51 env_multi.Prepend(CPPDEFINES=["Macro1=Value1", ("Macro2", "Value2"), {"Macro3": "Value3"}])
  52 try:
  53     env_multi.PrependUnique(CPPDEFINES="Macro2=Value2", delete_existing=True)
  54     env_multi.PrependUnique(CPPDEFINES=[("Macro4", None)], delete_existing=True)
  55     env_multi.PrependUnique(CPPDEFINES=[("Macro3", "Value3")], delete_existing=True)
  56     env_multi.PrependUnique(CPPDEFINES={"Macro1": "Value1"}, delete_existing=True)
  57 except Exception as t:
  58     print(f"Prepend FAILED: {t}")
  59 else:
  60     print(env_multi.subst('$_CPPDEFFLAGS'))
  61
  62 # A lone tuple handled differently than a lone list.
  63 env_tuple = Environment(tools=['cc'],CPPDEFPREFIX='-D', CPPDEFINES=("Macro1", "Value1"))
  64 print(env_tuple.subst('$_CPPDEFFLAGS'))
  65 env_multi = Environment(tools=['cc'],CPPDEFPREFIX='-D', CPPDEFINES=["Macro1", "Value1"])
  66 print(env_multi.subst('$_CPPDEFFLAGS'))
  67
  68 # https://github.com/SCons/scons/issues/1152
  69 # https://github.com/SCons/scons/issues/2900
  70 # Python3 dicts dont preserve order. Hence we supply subclass of OrderedDict
  71 # whose __str__ and __repr__ act like a normal dict.
  72 from collections import OrderedDict
  73
  74
  75 class OrderedPrintingDict(OrderedDict):
  76     def __repr__(self):
  77         return '{' + ', '.join([f'{k!r}: {v!r}' for (k, v) in self.items()]) + '}'
  78
  79     __str__ = __repr__
  80
  81     # Because dict-like objects (except dict and UserDict) are not deep copied
  82     # directly when constructing Environment(CPPDEFINES=OrderedPrintingDict(...))
  83     def __semi_deepcopy__(self):
  84         return self.copy()
  85
  86
  87 # each of these types will be prepended to each of the others
  88 # the first item in each tuple is a label for the output
  89 cases = [
  90     ('string', 'FOO'),
  91     ('valuestring', 'NAME1=VAL1'),
  92     ('list', ['NAME1', 'NAME2', 'NAME3']),
  93     ('tuple', ('NAME1', 'VAL1')),
  94     ('list-of-2lists', [('NAME1', 'VAL1'), ['NAME2', 'VAL2']]),
  95     (
  96         'dict',  # intentionally not sorted by key
  97         OrderedPrintingDict([('NAME2', 'VAL2'), ('NAME3', None), ('NAME1', 'VAL1')]),
  98     ),
  99 ]
 100
 101
 102 def dlist(coll):
 103     # if it's a deque, turn it into a list for display purposes
 104     from collections import deque
 105
 106     if isinstance(coll, deque):
 107         return list(coll)
 108     return coll
 109
 110
 111 for (t1, c1) in cases:
 112     for (t2, c2) in cases:
 113         print(f"==== Testing CPPDEFINES, prepending a {t2} to a {t1}")
 114         # string-like appearance if the value is a string
 115         orig = f"{c1!r}" if isinstance(c1, str) else c1
 116         pre = f"{c2!r}" if isinstance(c2, str) else c2
 117         print(f"   orig = {orig}, prepend = {pre}")
 118         env = Environment(tools=['cc'],CPPDEFINES=c1, CPPDEFPREFIX='-D')
 119         try:
 120             env.Prepend(CPPDEFINES=c2)
 121             final = env.subst('$_CPPDEFFLAGS', source="src", target="tgt")
 122             print(f"Prepend:\n    result={dlist(env['CPPDEFINES'])}\n    final={final}")
 123         except Exception as t:
 124             print(f"Prepend:\n    FAILED: {t}")
 125
 126         env = Environment(tools=['cc'],CPPDEFINES=c1, CPPDEFPREFIX='-D')
 127         try:
 128             env.PrependUnique(CPPDEFINES=c2)
 129             final = env.subst('$_CPPDEFFLAGS', source="src", target="tgt")
 130             print(
 131                 f"PrependUnique:\n    result={dlist(env['CPPDEFINES'])}\n    final={final}"
 132             )
 133         except Exception as t:
 134             print(f"PrependUnique:\n    FAILED: {t}")