From 98afdad6be617de3d95e0c2114dd01e628e88759 Mon Sep 17 00:00:00 2001
From: stevenknight <stevenknight@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Date: Wed, 6 Jan 2010 21:54:12 +0000
Subject: [PATCH] Issue 2505:  fix use of pre-compiled headers when the source
 .cpp file is listed in both the env.PCH() and env.Program() calls.

git-svn-id: http://scons.tigris.org/svn/scons/trunk@4596 fdb21ef1-2011-0410-befe-b5e4ea1792b1
---
 src/engine/SCons/Tool/msvc.py |  16 ++++-
 test/MSVC/PCH-source.py       | 107 ++++++++++++++++++++++++++++++++++
 2 files changed, 121 insertions(+), 2 deletions(-)
 create mode 100644 test/MSVC/PCH-source.py

diff --git a/src/engine/SCons/Tool/msvc.py b/src/engine/SCons/Tool/msvc.py
index 507e7409..920ac7c1 100644
--- a/src/engine/SCons/Tool/msvc.py
+++ b/src/engine/SCons/Tool/msvc.py
@@ -89,8 +89,20 @@ def object_emitter(target, source, env, parent_emitter):
 
     parent_emitter(target, source, env)
 
-    if env.has_key('PCH') and env['PCH']:
-        env.Depends(target, env['PCH'])
+    # Add a dependency, but only if the target (e.g. 'Source1.obj')
+    # doesn't correspond to the pre-compiled header ('Source1.pch').
+    # If the basenames match, then this was most likely caused by
+    # someone adding the source file to both the env.PCH() and the
+    # env.Program() calls, and adding the explicit dependency would
+    # cause a cycle on the .pch file itself.
+    #
+    # See issue #2505 for a discussion of what to do if it turns
+    # out this assumption causes trouble in the wild:
+    # http://scons.tigris.org/issues/show_bug.cgi?id=2505
+    if env.has_key('PCH'):
+        pch = env['PCH']
+        if str(target[0]) != SCons.Util.splitext(str(pch))[0] + '.obj':
+            env.Depends(target, pch)
 
     return (target, source)
 
diff --git a/test/MSVC/PCH-source.py b/test/MSVC/PCH-source.py
new file mode 100644
index 00000000..df6d6b15
--- /dev/null
+++ b/test/MSVC/PCH-source.py
@@ -0,0 +1,107 @@
+#!/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__"
+
+"""
+Test use of pre-compiled headers when the source .cpp file shows
+up in both the env.PCH() and the env.Program() source list.
+
+Issue 2505:  http://scons.tigris.org/issues/show_bug.cgi?id=2505
+"""
+
+import sys
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+if sys.platform != 'win32':
+    msg = "Skipping Visual C/C++ test on non-Windows platform '%s'\n" % sys.platform
+    test.skip_test(msg)
+
+
+test.write('SConstruct', """\
+env = Environment(tools=['msvc', 'mslink'])
+env['PCH'] = env.PCH('Source1.cpp')[0]
+env['PCHSTOP'] = 'Header1.hpp'
+env.Program('foo', ['foo.cpp', 'Source2.cpp', 'Source1.cpp'])
+""" % locals())
+
+test.write('Header1.hpp', r"""
+""")
+
+test.write('Source1.cpp', r"""
+#include <stdio.h>
+
+#include "Header1.hpp"
+
+void
+Source1(void) {
+    printf("Source1.cpp\n");
+}
+""")
+
+test.write('Source2.cpp', r"""
+#include <stdio.h>
+
+#include "Header1.hpp"
+
+void
+Source2(void) {
+    printf("Source2.cpp\n");
+}
+""")
+
+test.write('foo.cpp', r"""
+#include <stdio.h>
+
+#include "Header1.hpp"
+
+void Source1(void);
+void Source2(void);
+
+int
+main(int argc, char *argv[])
+{
+    Source1();
+    Source2();
+    printf("foo.cpp\n");
+}
+""")
+
+test.run(arguments = ".")
+
+test.run(program=test.workpath('foo'+TestSCons._exe),
+         stdout="Source1.cpp\nSource2.cpp\nfoo.cpp\n")
+
+
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:
-- 
2.26.2