diff options
| -rw-r--r-- | src/CHANGES.txt | 6 | ||||
| -rw-r--r-- | src/engine/SCons/Defaults.py | 15 | ||||
| -rw-r--r-- | src/engine/SCons/Environment.py | 107 | ||||
| -rw-r--r-- | test/CPPDEFINES/append.py | 223 | ||||
| -rw-r--r-- | test/CPPDEFINES/basic.py | 4 | ||||
| -rw-r--r-- | test/CPPDEFINES/pkg-config.py | 100 |
6 files changed, 439 insertions, 16 deletions
diff --git a/src/CHANGES.txt b/src/CHANGES.txt index 85d5bda..e4a5560 100644 --- a/src/CHANGES.txt +++ b/src/CHANGES.txt @@ -7,6 +7,12 @@ RELEASE 2.1.0.alpha.yyyymmdd - NEW DATE WILL BE INSERTED HERE + From Jean-Baptiste Lab: + + - Fix problems with appending CPPDEFINES that contain + dictionaries, and related issues with Parse/MergeFlags and + CPPDEFINES. + From Allen Weeks: - Fix for an issue with implicit-cache with multiple targets diff --git a/src/engine/SCons/Defaults.py b/src/engine/SCons/Defaults.py index 2311b50..dbefcbf 100644 --- a/src/engine/SCons/Defaults.py +++ b/src/engine/SCons/Defaults.py @@ -373,9 +373,20 @@ def processDefines(defs): l = [] for d in defs: if SCons.Util.is_List(d) or isinstance(d, tuple): - l.append(str(d[0]) + '=' + str(d[1])) - else: + if len(d) >= 2: + l.append(str(d[0]) + '=' + str(d[1])) + else: + l.append(str(d[0])) + elif SCons.Util.is_Dict(d): + for macro,value in d.iteritems(): + if value is not None: + l.append(str(macro) + '=' + str(value)) + else: + l.append(str(macro)) + elif SCons.Util.is_String(d): l.append(str(d)) + else: + raise elif SCons.Util.is_Dict(defs): # The items in a dictionary are stored in random order, but # if the order of the command-line options changes from diff --git a/src/engine/SCons/Environment.py b/src/engine/SCons/Environment.py index c7dc474..ed3aaa0 100644 --- a/src/engine/SCons/Environment.py +++ b/src/engine/SCons/Environment.py @@ -1146,12 +1146,17 @@ class Base(SubstitutionEnvironment): # "continue" statements whenever we finish processing an item, # but Python 1.5.2 apparently doesn't let you use "continue" # within try:-except: blocks, so we have to nest our code. - try: + try: + if key == 'CPPDEFINES' and SCons.Util.is_String(self._dict[key]): + self._dict[key] = [self._dict[key]] orig = self._dict[key] except KeyError: # No existing variable in the environment, so just set # it to the new value. - self._dict[key] = val + if key == 'CPPDEFINES' and SCons.Util.is_String(val): + self._dict[key] = [val] + else: + self._dict[key] = val else: try: # Check if the original looks like a dictionary. @@ -1188,8 +1193,13 @@ class Base(SubstitutionEnvironment): # The original looks like a dictionary, so update it # based on what we think the value looks like. if SCons.Util.is_List(val): - for v in val: - orig[v] = None + if key == 'CPPDEFINES': + orig = orig.items() + orig += val + self._dict[key] = orig + else: + for v in val: + orig[v] = None else: try: update_dict(val) @@ -1251,8 +1261,39 @@ class Base(SubstitutionEnvironment): self._dict[key].update(val) elif SCons.Util.is_List(val): dk = self._dict[key] - if not SCons.Util.is_List(dk): - dk = [dk] + if key == 'CPPDEFINES': + tmp = [] + for i in val: + if SCons.Util.is_List(i): + if len(i) >= 2: + tmp.append((i[0], i[1])) + else: + tmp.append((i[0],)) + elif SCons.Util.is_Tuple(i): + tmp.append(i) + else: + tmp.append((i,)) + val = tmp + if SCons.Util.is_Dict(dk): + dk = dk.items() + elif SCons.Util.is_String(dk): + dk = [(dk,)] + else: + tmp = [] + for i in dk: + if SCons.Util.is_List(i): + if len(i) >= 2: + tmp.append((i[0], i[1])) + else: + tmp.append((i[0],)) + elif SCons.Util.is_Tuple(i): + tmp.append(i) + else: + tmp.append((i,)) + dk = tmp + else: + if not SCons.Util.is_List(dk): + dk = [dk] if delete_existing: dk = [x for x in dk if x not in val] else: @@ -1261,15 +1302,57 @@ class Base(SubstitutionEnvironment): else: dk = self._dict[key] if SCons.Util.is_List(dk): - # By elimination, val is not a list. Since dk is a - # list, wrap val in a list first. - if delete_existing: - dk = [x for x in dk if x not in val] - self._dict[key] = dk + [val] + if key == 'CPPDEFINES': + tmp = [] + for i in dk: + if SCons.Util.is_List(i): + if len(i) >= 2: + tmp.append((i[0], i[1])) + else: + tmp.append((i[0],)) + elif SCons.Util.is_Tuple(i): + tmp.append(i) + else: + tmp.append((i,)) + dk = tmp + if SCons.Util.is_Dict(val): + val = val.items() + elif SCons.Util.is_String(val): + val = [(val,)] + if delete_existing: + dk = filter(lambda x, val=val: x not in val, dk) + self._dict[key] = dk + val + else: + dk = [x for x in dk if x not in val] + self._dict[key] = dk + val else: - if not val in dk: + # By elimination, val is not a list. Since dk is a + # list, wrap val in a list first. + if delete_existing: + dk = filter(lambda x, val=val: x not in val, dk) self._dict[key] = dk + [val] + else: + if not val in dk: + self._dict[key] = dk + [val] else: + if key == 'CPPDEFINES': + if SCons.Util.is_String(dk): + dk = [dk] + elif SCons.Util.is_Dict(dk): + dk = dk.items() + if SCons.Util.is_String(val): + if val in dk: + val = [] + else: + val = [val] + elif SCons.Util.is_Dict(val): + tmp = [] + for i,j in val.iteritems(): + if j is not None: + tmp.append((i,j)) + else: + tmp.append(i) + val = tmp if delete_existing: dk = [x for x in dk if x not in val] self._dict[key] = dk + val diff --git a/test/CPPDEFINES/append.py b/test/CPPDEFINES/append.py new file mode 100644 index 0000000..92b113c --- /dev/null +++ b/test/CPPDEFINES/append.py @@ -0,0 +1,223 @@ +#!/usr/bin/env python +# +# __COPYRIGHT__ +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" + +""" +Verify appending to CPPPDEFINES with various data types. +See also pkg-config.py in this dir. +""" + +import TestSCons + +test = TestSCons.TestSCons() + +test.write('SConstruct', """\ +env_1738_2 = Environment() +env_1738_2['CPPDEFINES'] = ['FOO'] +env_1738_2.Append(CPPDEFINES={'value' : '1'}) +print env_1738_2.subst('$_CPPDEFFLAGS') +#env_1738_2.Object('test_1738_2', 'main.c') + +# http://scons.tigris.org/issues/show_bug.cgi?id=2300 +env_2300_1 = DefaultEnvironment(CPPDEFINES = 'foo') +env_2300_1.Append(CPPDEFINES='bar') +print env_2300_1.subst('$_CPPDEFFLAGS') +#env_2300_1.Object('test_2300_1', 'main.c') + +env_2300_2 = DefaultEnvironment(CPPDEFINES = ['foo']) # note the list +env_2300_2.Append(CPPDEFINES='bar') +print env_2300_2.subst('$_CPPDEFFLAGS') +#env_2300_2.Object('test_2300_2', 'main.c') + +# http://scons.tigris.org/issues/show_bug.cgi?id=1152 +cases=[('string', 'FOO'), + ('list', ['NAME1', 'NAME2']), + ('list-of-2lists', [('NAME1','VAL1'), ['NAME2','VAL2']]), + ('dict', {'NAME1' : 'VAL1', 'NAME2' : 'VAL2'}) + ] + +for (t1, c1) in cases: + for (t2, c2) in cases: + print "==== Testing CPPDEFINES, appending a %s to a %s"%(t2, t1) + print " orig = %s, append = %s"%(c1, c2) + env=Environment(CPPDEFINES = c1) + env.Append(CPPDEFINES = c2) + final=env.subst('$_CPPDEFFLAGS',source="src", target="tgt") + print 'Append: \\n\\tresult=%s\\n\\tfinal=%s'%\\ + (env['CPPDEFINES'], final) + env=Environment(CPPDEFINES = c1) + env.AppendUnique(CPPDEFINES = c2) + final=env.subst('$_CPPDEFFLAGS',source="src", target="tgt") + print 'AppendUnique:\\n\\tresult=%s\\n\\tfinal=%s'%\\ + (env['CPPDEFINES'], final) +""") + + +expect_print_output="""\ +-DFOO -Dvalue=1 +-Dfoo -Dbar +-Dfoo -Dbar -Dbar +==== Testing CPPDEFINES, appending a string to a string + orig = FOO, append = FOO +Append: + result=['FOO', 'FOO'] + final=-DFOO -DFOO +AppendUnique: + result=['FOO'] + final=-DFOO +==== Testing CPPDEFINES, appending a list to a string + orig = FOO, append = ['NAME1', 'NAME2'] +Append: + result=['FOO', 'NAME1', 'NAME2'] + final=-DFOO -DNAME1 -DNAME2 +AppendUnique: + result=[('FOO',), ('NAME1',), ('NAME2',)] + final=-DFOO -DNAME1 -DNAME2 +==== Testing CPPDEFINES, appending a list-of-2lists to a string + orig = FOO, append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']] +Append: + result=['FOO', ('NAME1', 'VAL1'), ['NAME2', 'VAL2']] + final=-DFOO -DNAME1=VAL1 -DNAME2=VAL2 +AppendUnique: + result=[('FOO',), ('NAME1', 'VAL1'), ('NAME2', 'VAL2')] + final=-DFOO -DNAME1=VAL1 -DNAME2=VAL2 +==== Testing CPPDEFINES, appending a dict to a string + orig = FOO, append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'} +Append: + result=['FOO', {'NAME2': 'VAL2', 'NAME1': 'VAL1'}] + final=-DFOO -DNAME2=VAL2 -DNAME1=VAL1 +AppendUnique: + result=['FOO', ('NAME2', 'VAL2'), ('NAME1', 'VAL1')] + final=-DFOO -DNAME2=VAL2 -DNAME1=VAL1 +==== Testing CPPDEFINES, appending a string to a list + orig = ['NAME1', 'NAME2'], append = FOO +Append: + result=['NAME1', 'NAME2', 'FOO'] + final=-DNAME1 -DNAME2 -DFOO +AppendUnique: + result=[('NAME1',), ('NAME2',), ('FOO',)] + final=-DNAME1 -DNAME2 -DFOO +==== Testing CPPDEFINES, appending a list to a list + orig = ['NAME1', 'NAME2'], append = ['NAME1', 'NAME2'] +Append: + result=['NAME1', 'NAME2', 'NAME1', 'NAME2'] + final=-DNAME1 -DNAME2 -DNAME1 -DNAME2 +AppendUnique: + result=[('NAME1',), ('NAME2',)] + final=-DNAME1 -DNAME2 +==== Testing CPPDEFINES, appending a list-of-2lists to a list + orig = ['NAME1', 'NAME2'], append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']] +Append: + result=['NAME1', 'NAME2', ('NAME1', 'VAL1'), ['NAME2', 'VAL2']] + final=-DNAME1 -DNAME2 -DNAME1=VAL1 -DNAME2=VAL2 +AppendUnique: + result=[('NAME1',), ('NAME2',), ('NAME1', 'VAL1'), ('NAME2', 'VAL2')] + final=-DNAME1 -DNAME2 -DNAME1=VAL1 -DNAME2=VAL2 +==== Testing CPPDEFINES, appending a dict to a list + orig = ['NAME1', 'NAME2'], append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'} +Append: + result=['NAME1', 'NAME2', {'NAME2': 'VAL2', 'NAME1': 'VAL1'}] + final=-DNAME1 -DNAME2 -DNAME2=VAL2 -DNAME1=VAL1 +AppendUnique: + result=[('NAME1',), ('NAME2',), ('NAME2', 'VAL2'), ('NAME1', 'VAL1')] + final=-DNAME1 -DNAME2 -DNAME2=VAL2 -DNAME1=VAL1 +==== Testing CPPDEFINES, appending a string to a list-of-2lists + orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = FOO +Append: + result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], 'FOO'] + final=-DNAME1=VAL1 -DNAME2=VAL2 -DFOO +AppendUnique: + result=[('NAME1', 'VAL1'), ('NAME2', 'VAL2'), ('FOO',)] + final=-DNAME1=VAL1 -DNAME2=VAL2 -DFOO +==== Testing CPPDEFINES, appending a list to a list-of-2lists + orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = ['NAME1', 'NAME2'] +Append: + result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], 'NAME1', 'NAME2'] + final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME1 -DNAME2 +AppendUnique: + result=[('NAME1', 'VAL1'), ('NAME2', 'VAL2'), ('NAME1',), ('NAME2',)] + final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME1 -DNAME2 +==== Testing CPPDEFINES, appending a list-of-2lists to a list-of-2lists + orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']] +Append: + result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], ('NAME1', 'VAL1'), ['NAME2', 'VAL2']] + final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME1=VAL1 -DNAME2=VAL2 +AppendUnique: + result=[('NAME1', 'VAL1'), ('NAME2', 'VAL2')] + final=-DNAME1=VAL1 -DNAME2=VAL2 +==== Testing CPPDEFINES, appending a dict to a list-of-2lists + orig = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']], append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'} +Append: + result=[('NAME1', 'VAL1'), ['NAME2', 'VAL2'], {'NAME2': 'VAL2', 'NAME1': 'VAL1'}] + final=-DNAME1=VAL1 -DNAME2=VAL2 -DNAME2=VAL2 -DNAME1=VAL1 +AppendUnique: + result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1')] + final=-DNAME2=VAL2 -DNAME1=VAL1 +==== Testing CPPDEFINES, appending a string to a dict + orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = FOO +Append: + result={'FOO': None, 'NAME2': 'VAL2', 'NAME1': 'VAL1'} + final=-DFOO -DNAME1=VAL1 -DNAME2=VAL2 +AppendUnique: + result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), 'FOO'] + final=-DNAME2=VAL2 -DNAME1=VAL1 -DFOO +==== Testing CPPDEFINES, appending a list to a dict + orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = ['NAME1', 'NAME2'] +Append: + result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), 'NAME1', 'NAME2'] + final=-DNAME2=VAL2 -DNAME1=VAL1 -DNAME1 -DNAME2 +AppendUnique: + result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), ('NAME1',), ('NAME2',)] + final=-DNAME2=VAL2 -DNAME1=VAL1 -DNAME1 -DNAME2 +==== Testing CPPDEFINES, appending a list-of-2lists to a dict + orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = [('NAME1', 'VAL1'), ['NAME2', 'VAL2']] +Append: + result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1'), ('NAME1', 'VAL1'), ['NAME2', 'VAL2']] + final=-DNAME2=VAL2 -DNAME1=VAL1 -DNAME1=VAL1 -DNAME2=VAL2 +AppendUnique: + result=[('NAME2', 'VAL2'), ('NAME1', 'VAL1')] + final=-DNAME2=VAL2 -DNAME1=VAL1 +==== Testing CPPDEFINES, appending a dict to a dict + orig = {'NAME2': 'VAL2', 'NAME1': 'VAL1'}, append = {'NAME2': 'VAL2', 'NAME1': 'VAL1'} +Append: + result={'NAME2': 'VAL2', 'NAME1': 'VAL1'} + final=-DNAME1=VAL1 -DNAME2=VAL2 +AppendUnique: + result={'NAME2': 'VAL2', 'NAME1': 'VAL1'} + final=-DNAME1=VAL1 -DNAME2=VAL2 +""" + +build_output="scons: `.' is up to date.\n" + +expect = test.wrap_stdout(build_str=build_output, + read_str = expect_print_output) +test.run(arguments = '.', stdout=expect) +test.pass_test() + +# Local Variables: +# tab-width:4 +# indent-tabs-mode:nil +# End: +# vim: set expandtab tabstop=4 shiftwidth=4: diff --git a/test/CPPDEFINES/basic.py b/test/CPPDEFINES/basic.py index 4259a24..b54a421 100644 --- a/test/CPPDEFINES/basic.py +++ b/test/CPPDEFINES/basic.py @@ -39,11 +39,11 @@ test_list = [ ['x', ['y', 123], 'z', ('int', '$INTEGER')], { 'c' : 3, 'b': None, 'a' : 1 }, ] -env = Environment(CPPDEFPREFIX='-D', CPPDEFSUFFIX='', INTEGER=0) for i in test_list: + env = Environment(CPPDEFPREFIX='-D', CPPDEFSUFFIX='', INTEGER=0) print env.Clone(CPPDEFINES=i).subst('$_CPPDEFFLAGS') -env = Environment(CPPDEFPREFIX='|', CPPDEFSUFFIX='|', INTEGER=1) for i in test_list: + env = Environment(CPPDEFPREFIX='|', CPPDEFSUFFIX='|', INTEGER=1) print env.Clone(CPPDEFINES=i).subst('$_CPPDEFFLAGS') """) diff --git a/test/CPPDEFINES/pkg-config.py b/test/CPPDEFINES/pkg-config.py new file mode 100644 index 0000000..f59b3b0 --- /dev/null +++ b/test/CPPDEFINES/pkg-config.py @@ -0,0 +1,100 @@ +#!/usr/bin/env python +# +# __COPYRIGHT__ +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" + +""" +Verify merging with MergeFlags to CPPPDEFINES with various data types. +""" + +import TestSCons + +test = TestSCons.TestSCons() + +test.write('bug.pc', """\ +prefix=/usr +exec_prefix=${prefix} +libdir=${exec_prefix}/lib +includedir=${prefix}/include + +Name: bug +Description: A test case .pc file +Version: 1.2 +Cflags: -DSOMETHING -DVARIABLE=2 +""") + +test.write('main.c', """\ +int main(int argc, char *argv[]) +{ + return 0; +} +""") + +test.write('SConstruct', """\ +# http://scons.tigris.org/issues/show_bug.cgi?id=2671 +# Passing test cases +env_1 = Environment(CPPDEFINES=[('DEBUG','1'), 'TEST']) +env_1.ParseConfig('PKG_CONFIG_PATH=. pkg-config --cflags bug') +print env_1.subst('$_CPPDEFFLAGS') + +env_2 = Environment(CPPDEFINES=[('DEBUG','1'), 'TEST']) +env_2.MergeFlags('-DSOMETHING -DVARIABLE=2') +print env_2.subst('$_CPPDEFFLAGS') + +# Failing test cases +env_3 = Environment(CPPDEFINES={'DEBUG':1, 'TEST':None}) +env_3.ParseConfig('PKG_CONFIG_PATH=. pkg-config --cflags bug') +print env_3.subst('$_CPPDEFFLAGS') + +env_4 = Environment(CPPDEFINES={'DEBUG':1, 'TEST':None}) +env_4.MergeFlags('-DSOMETHING -DVARIABLE=2') +print env_4.subst('$_CPPDEFFLAGS') + +# http://scons.tigris.org/issues/show_bug.cgi?id=1738 +env_1738_1 = Environment(tools=['default']) +env_1738_1.ParseConfig('PKG_CONFIG_PATH=. pkg-config --cflags --libs bug') +env_1738_1.Append(CPPDEFINES={'value' : '1'}) +print env_1738_1.subst('$_CPPDEFFLAGS') +""") + +expect_print_output="""\ +-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2 +-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2 +-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2 +-DDEBUG=1 -DTEST -DSOMETHING -DVARIABLE=2 +-DSOMETHING -DVARIABLE=2 -Dvalue=1 +""" + +build_output="scons: `.' is up to date.\n" + +expect = test.wrap_stdout(build_str=build_output, + read_str = expect_print_output) +test.run(arguments = '.', stdout=expect) +test.pass_test() + +# Local Variables: +# tab-width:4 +# indent-tabs-mode:nil +# End: +# vim: set expandtab tabstop=4 shiftwidth=4: |