reivised code, fixed cygwin/variant-dir issue, cleaned-up some areas

6 files changed, 242 insertions, 60 deletions

diff --git a/src/engine/SCons/Tool/__init__.py b/src/engine/SCons/Tool/__init__.py
index 4a27c0d..0e6e7d8 100644
--- a/src/engine/SCons/Tool/__init__.py
+++ b/src/engine/SCons/Tool/__init__.py
@@ -367,7 +367,7 @@ LdModSuffixGenerator  = _LibSuffixGenerator('LdMod')
 ImpLibSuffixGenerator = _LibSuffixGenerator('ImpLib')
 
 class _LibSymlinkGenerator(_LibInfoGeneratorBase):
-    """Library symlink map generator. It generates a dict of symlinks that
+    """Library symlink map generator. It generates a list of symlinks that
     should be created by SharedLibrary or LoadableModule builders"""
     def __init__(self, libtype):
         super(_LibSymlinkGenerator, self).__init__(libtype, 'Symlinks')
@@ -397,7 +397,7 @@ class _LibSymlinkGenerator(_LibInfoGeneratorBase):
         Verbose = False
 
         if Verbose:
-            print "_LibSymLinkGenerator: str(libnode)=%r" % str(libnode)
+            print "_LibSymLinkGenerator: libnode=%r" % libnode.get_path()
 
         symlinks = None
 
@@ -412,7 +412,7 @@ class _LibSymlinkGenerator(_LibInfoGeneratorBase):
             symlinks = self.generate_versioned_lib_info(env, [libnode, version, suffix], **kw)
 
         if Verbose:
-            print '_LibSymlinkGenerator: return symlinks=%r' % symlinks
+            print '_LibSymlinkGenerator: return symlinks=%r' % StringizeLibSymlinks(symlinks)
         return symlinks
 
 ShLibSymlinkGenerator =  _LibSymlinkGenerator('ShLib')
@@ -430,7 +430,7 @@ class _LibNameGenerator(_LibInfoGeneratorBase):
         Verbose = False
 
         if Verbose:
-            print "_LibNameGenerator: str(libnode)=%r" % str(libnode)
+            print "_LibNameGenerator: libnode=%r" % libnode.get_path()
 
         version = self.get_lib_version(env, **kw)
         if Verbose:
@@ -442,7 +442,7 @@ class _LibNameGenerator(_LibInfoGeneratorBase):
             name = self.generate_versioned_lib_info(env, [libnode, version, suffix], **kw)
 
         if not name:
-            name = os.path.basename(str(libnode))
+            name = os.path.basename(libnode.get_path())
 
         if Verbose:
             print '_LibNameGenerator: return name=%r' % name
@@ -464,7 +464,7 @@ class _LibSonameGenerator(_LibInfoGeneratorBase):
         Verbose = False
 
         if Verbose:
-            print "_LibSonameGenerator: str(libnode)=%r" % str(libnode)
+            print "_LibSonameGenerator: libnode=%r" % libnode.get_path()
 
         soname = env.subst('$SONAME')
         if not soname:
@@ -489,41 +489,56 @@ class _LibSonameGenerator(_LibInfoGeneratorBase):
 ShLibSonameGenerator =  _LibSonameGenerator('ShLib')
 LdModSonameGenerator =  _LibSonameGenerator('LdMod')
 
+def StringizeLibSymlinks(symlinks):
+    """Converts list with pairs of nodes to list with pairs of node paths
+    (strings). Used mainly for debugging."""
+    if SCons.Util.is_List(symlinks):
+        try:
+            return [ (k.get_path(), v.get_path()) for k,v in symlinks ]
+        except TypeError:
+            return symlinks
+        except ValueError:
+            return symlinks
+    else:
+        return symlinks
+
 def EmitLibSymlinks(env, symlinks, libnode):
     """Used by emitters to handle (shared/versioned) library symlinks"""
     Verbose = False
-    for linkname, linktgt in symlinks.iteritems():
-        env.SideEffect(linkname, linktgt)
+
+    # nodes involved in process... all symlinks + library
+    nodes = list(set([ x for x,y in symlinks ] + [libnode]))
+      
+    for link, linktgt in symlinks:
+        env.SideEffect(link, linktgt)
         if(Verbose):
-            print "EmitLibSymlinks: SideEffect(", linkname, ", ", linktgt, ")"
-        clean = list(set(filter(lambda x : x != linktgt, symlinks.keys() + [str(libnode)])))
-        env.Clean(linktgt, clean)
+            print "EmitLibSymlinks: SideEffect(%r,%r)" % (link.get_path(), linktgt.get_path())
+        clean_list = filter(lambda x : x != linktgt, nodes)
+        env.Clean(linktgt, clean_list)
         if(Verbose):
-            print "EmitLibSymlinks: Clean(%r,%r)" % (linktgt, clean)
+            print "EmitLibSymlinks: Clean(%r,%r)" % (linktgt.get_path(), map(lambda x : x.get_path(), clean_list))
 
 def CreateLibSymlinks(env, symlinks):
-    """Physically creates symlinks. The symlinks argument must be a dict in
-    form { linkname : linktarget }
+    """Physically creates symlinks. The symlinks argument must be a list in
+    form [ (link, linktarget), ... ], where link and linktarget are SCons
+    nodes.
     """
     
     Verbose = False
-    for linkname, linktgt in symlinks.iteritems():
-        linkname = str(env.arg2nodes(linkname)[0])
-        linkdir = os.path.dirname(linkname)
-        if linkdir:
-            # NOTE: os.path.relpath appears in python 2.6
-            linktgt = os.path.relpath(linktgt, linkdir)
-        else:
-            linktgt = os.path.basename(linktgt)
+    for link, linktgt in symlinks:
+        linktgt = link.get_dir().rel_path(linktgt)
+        link = link.get_path()
         if(Verbose):
-            print "CreateLibSymlinks: preparing to add symlink ", linkname, " -> ", linktgt
+            print "CreateLibSymlinks: preparing to add symlink %r -> %r" % (link, linktgt)
         try:
-            os.remove(linkname)
+            os.remove(link)
+            if(Verbose):
+                print "CreateLibSymlinks: removed old file %r" % link
         except:
             pass
-        os.symlink(linktgt, linkname)
+        os.symlink(linktgt, link)
         if(Verbose):
-            print "CreateLibSymlinks: add symlink ", linkname, " -> ", linktgt
+            print "CreateLibSymlinks: add symlink %r -> %r" % (link, linktgt)
     return 0
 
 def LibSymlinksActionFunction(target, source, env):
diff --git a/src/engine/SCons/Tool/cyglink.py b/src/engine/SCons/Tool/cyglink.py
index 4033978..59258b2 100644
--- a/src/engine/SCons/Tool/cyglink.py
+++ b/src/engine/SCons/Tool/cyglink.py
@@ -56,6 +56,9 @@ def ldmod_generator(target, source, env, for_signature):
 def _lib_emitter(target, source, env, **kw):
     Verbose = False
 
+    if Verbose:
+        print "_lib_emitter: target[0]=%r" % target[0].get_path()
+
     try: vp = kw['varprefix']
     except KeyError: vp = 'SHLIB'
 
@@ -65,6 +68,9 @@ def _lib_emitter(target, source, env, **kw):
     dll = env.FindIxes(target, '%sPREFIX' % vp, '%sSUFFIX' % vp)
     no_import_lib = env.get('no_import_lib', 0)
 
+    if Verbose:
+        print "_lib_emitter: dll=%r" % dll.get_path()
+
     if not dll or len(target) > 1:
         raise SCons.Errors.UserError("A shared library should have exactly one target with the suffix: %s" % env.subst("$%sSUFFIX" % vp))
     
@@ -73,20 +79,28 @@ def _lib_emitter(target, source, env, **kw):
     if dll.name[len(pre):len(pre)+3] == 'lib':
         dll.name = pre + dll.name[len(pre)+3:]
 
+    if Verbose:
+        print "_lib_emitter: dll.name=%r" % dll.name
+
     orig_target = target
     target = [env.fs.File(dll)]
     target[0].attributes.shared = 1
 
+    if Verbose:
+        print "_lib_emitter: after target=[env.fs.File(dll)]: target[0]=%r" % target[0].get_path()
+
     # Append an import lib target
     if not no_import_lib:
         # Create list of target libraries as strings
         target_strings = env.ReplaceIxes(orig_target[0],
                                          '%sPREFIX' % vp, '%sSUFFIX' % vp,
                                          'IMPLIBPREFIX', 'IMPLIBSUFFIX')
+        if Verbose:
+            print "_lib_emitter: target_strings=%r" % target_strings
         
         implib_target = env.fs.File(target_strings)
         if Verbose:
-            print "_lib_emitter: implib_target=%r" % str(implib_target) 
+            print "_lib_emitter: implib_target=%r" % implib_target.get_path()
         implib_target.attributes.shared = 1
         target.append(implib_target)
 
@@ -94,7 +108,7 @@ def _lib_emitter(target, source, env, **kw):
                                                  implib_libtype=libtype,
                                                  generator_libtype=libtype+'ImpLib')
     if Verbose:
-        print "_lib_emitter: implib symlinks=%r" % symlinks
+        print "_lib_emitter: implib symlinks=%r" % SCons.Tool.StringizeLibSymlinks(symlinks)
     if symlinks:
         SCons.Tool.EmitLibSymlinks(env, symlinks, implib_target)
         implib_target.attributes.shliblinks = symlinks
@@ -129,20 +143,19 @@ def _versioned_implib_name(env, libnode, version, suffix, **kw):
 
 def _versioned_implib_symlinks(env, libnode, version, suffix, **kw):
     """Generate link names that should be created for a versioned shared lirbrary.
-       Returns a dictionary in the form { linkname : linktarget }
+       Returns a list in the form [ (link, linktarget), ... ]
     """
     Verbose = False
 
     if Verbose:
-        print "_versioned_implib_symlinks: str(libnode)=%r" % str(libnode)
+        print "_versioned_implib_symlinks: libnode=%r" % libnode.get_path()
         print "_versioned_implib_symlinks: version=%r" % version
 
     try: libtype = kw['libtype']
     except KeyError: libtype = 'ShLib'
 
-    symlinks = {}
 
-    linkdir = os.path.dirname(str(libnode))
+    linkdir = os.path.dirname(libnode.get_path())
     if Verbose:
         print "_versioned_implib_symlinks: linkdir=%r" % linkdir
 
@@ -154,12 +167,11 @@ def _versioned_implib_symlinks(env, libnode, version, suffix, **kw):
 
     major = version.split('.')[0]
 
-    link0 = os.path.join(str(linkdir), name)
-
-    symlinks[link0] = str(libnode)
+    link0 = env.fs.File(os.path.join(linkdir, name))
+    symlinks = [(link0, libnode)]
 
     if Verbose:
-        print "_versioned_implib_symlinks: return symlinks=%r" % symlinks
+        print "_versioned_implib_symlinks: return symlinks=%r" % SCons.Tool.StringizeLibSymlinks(symlinks)
 
     return symlinks
 
diff --git a/src/engine/SCons/Tool/gnulink.py b/src/engine/SCons/Tool/gnulink.py
index ea0ca5a..14007af 100644
--- a/src/engine/SCons/Tool/gnulink.py
+++ b/src/engine/SCons/Tool/gnulink.py
@@ -85,18 +85,16 @@ def _versioned_lib_symlinks(env, libnode, version, suffix, name_generator, sonam
         print "_versioned_lib_symlinks: str(libnode)=%r" % str(libnode)
         print "_versioned_lib_symlinks: version=%r" % version
 
-    symlinks = {}
-
     if sys.platform.startswith('openbsd'):
         # OpenBSD uses x.y shared library versioning numbering convention
         # and doesn't use symlinks to backwards-compatible libraries
         if Verbose:
-            print "_versioned_lib_symlinks: return symlinks=%r" % symlinks
-        return symlinks
+            print "_versioned_lib_symlinks: return symlinks=%r" % None
+        return None
 
-    linkdir = os.path.dirname(str(libnode))
+    linkdir = libnode.get_dir()
     if Verbose:
-        print "_versioned_lib_symlinks: linkdir=%r" % linkdir
+        print "_versioned_lib_symlinks: linkdir=%r" % linkdir.get_path()
 
     name = name_generator(env, libnode)
     if Verbose:
@@ -104,14 +102,13 @@ def _versioned_lib_symlinks(env, libnode, version, suffix, name_generator, sonam
 
     soname = soname_generator(env, libnode)
 
-    link0 = os.path.join(str(linkdir), soname)
-    link1 = os.path.join(str(linkdir), name)
+    link0 = env.fs.File(soname, linkdir)
+    link1 = env.fs.File(name, linkdir)
 
-    symlinks[link0] = str(libnode)
-    symlinks[link1] = link0
+    symlinks = [ (link0, libnode), (link1, link0) ]
 
     if Verbose:
-        print "_versioned_lib_symlinks: return symlinks=%r" % symlinks
+        print "_versioned_lib_symlinks: return symlinks=%r" % SCons.Tool.StringizeLibSymlinks(symlinks)
 
     return symlinks
 
diff --git a/src/engine/SCons/Tool/install.py b/src/engine/SCons/Tool/install.py
index c5c2adb..9d5db9f 100644
--- a/src/engine/SCons/Tool/install.py
+++ b/src/engine/SCons/Tool/install.py
@@ -147,18 +147,19 @@ def copyFuncVersionedLib(dest, source, env):
     return 0
 
 def listShlibLinksToInstall(dest, source, env):
-    install_links = {}
-    install_dir = os.path.dirname(str(dest))
+    install_links = []
     source = env.arg2nodes(source)
+    dest = env.fs.File(dest)
+    install_dir = dest.get_dir()
     for src in source:
-        links = getattr(getattr(src,'attributes',None), 'shliblinks', None)
-        if SCons.Util.is_Dict(links):
-            for linkname, linktgt in links.iteritems():
-                linkname_base = os.path.basename(str(linkname))
-                linktgt_base  = os.path.basename(str(linktgt))
-                install_linkname = os.path.join(install_dir, linkname_base)
-                install_linktgt = os.path.join(install_dir, linktgt_base)
-                install_links[install_linkname] = install_linktgt
+        symlinks = getattr(getattr(src,'attributes',None), 'shliblinks', None)
+        if symlinks:
+            for link, linktgt in symlinks:
+                link_base = os.path.basename(link.get_path())
+                linktgt_base  = os.path.basename(linktgt.get_path())
+                install_link = env.fs.File(link_base, install_dir)
+                install_linktgt = env.fs.File(linktgt_base, install_dir)
+                install_links.append((install_link, install_linktgt))
     return install_links
 
 def installShlibLinks(dest, source, env):
@@ -167,7 +168,7 @@ def installShlibLinks(dest, source, env):
 
     symlinks = listShlibLinksToInstall(dest, source, env)
     if Verbose:
-        print 'installShlibLinks: symlinks=%r' % symlinks
+        print 'installShlibLinks: symlinks=%r' % SCons.Tool.StringizeLibSymlinks(symlinks)
     if symlinks:
         SCons.Tool.CreateLibSymlinks(env, symlinks)
     return
diff --git a/test/LINK/VersionedLib-VariantDir.py b/test/LINK/VersionedLib-VariantDir.py
new file mode 100644
index 0000000..a3ea660
--- /dev/null
+++ b/test/LINK/VersionedLib-VariantDir.py
@@ -0,0 +1,157 @@
+#!/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__"
+
+"""
+Ensure that SharedLibrary builder with SHLIBVERSION set works with VariantDir.
+"""
+
+import TestSCons
+import os
+import sys
+
+import SCons.Platform
+
+platform = SCons.Platform.platform_default()
+
+test = TestSCons.TestSCons()
+
+test.subdir(['src'])
+test.subdir(['src','lib'])
+test.subdir(['src','bin'])
+
+test.write(['src','lib','foo.c'], """
+#if _WIN32
+__declspec(dllexport)
+#endif
+int foo() { return 0; }
+""")
+
+test.write(['src','bin','main.c'], """
+#if _WIN32
+__declspec(dllimport)
+#endif
+int foo();
+int main()
+{
+  return foo();
+}
+""")
+
+test.write('SConstruct', """
+env = Environment()
+variant = { 'variant_dir' : 'build',
+            'src_dir'     : 'src',
+            'duplicate'   : 0,
+            'exports'     : { 'env' : env } }
+SConscript('src/lib/SConscript', **variant)
+SConscript('src/bin/SConscript', **variant)
+""")
+
+test.write(['src','lib','SConscript'], """
+Import('env')
+env.SharedLibrary('foo', 'foo.c', SHLIBVERSION = '0.1.2')
+""" )
+
+test.write(['src','bin','SConscript'], """
+Import('env')
+env.Program('main.c', LIBS=['foo'], LIBPATH=['../lib'])
+""")
+
+test.run(arguments = ['--tree=all'])
+
+if platform == 'cygwin' or platform == 'win32':
+    # PATH is used to search for *.dll libraries on windows
+    path = os.environ.get('PATH','')
+    if path: path = path + os.pathsep
+    path = path + test.workpath('build/lib')
+    os.environ['PATH'] = path
+
+if os.name == 'posix':
+    os.environ['LD_LIBRARY_PATH'] = test.workpath('build/lib')
+if sys.platform.find('irix') != -1:
+    os.environ['LD_LIBRARYN32_PATH'] = test.workpath('build/lib')
+
+test.run(program = test.workpath('build/bin/main'))
+
+if platform == 'posix':
+    # All (?) the files we expect will get created in the current directory
+    files = [
+    'libfoo.so',
+    'libfoo.so.0',
+    'libfoo.so.0.1.2',
+    ]
+    obj = 'foo.os'
+elif platform == 'darwin':
+    # All (?) the files we expect will get created in the current directory
+    files = [
+    'libfoo.dylib',
+    'libfoo.0.1.2.dylib',
+    ]
+    obj = 'foo.os'
+elif platform == 'cygwin':
+    # All (?) the files we expect will get created in the current directory
+    files = [
+    'cygfoo-0-1-2.dll',
+    'libfoo-0-1-2.dll.a',
+    'libfoo.dll.a',
+    ]
+    obj = 'foo.os'
+elif platform == 'win32':
+    # All (?) the files we expect will get created in the current directory
+    files = [
+    'foo.dll',
+    'foo.lib',
+    ]
+    obj = 'foo.obj'
+else:
+    # All (?) the files we expect will get created in the current directory
+    files= [
+    'libfoo.so',
+    ]
+    obj = 'foo.os'
+
+test.must_exist([ 'build', 'lib', obj ])
+for f in files:
+    test.must_exist([ 'build', 'lib', f ])
+
+test.run(arguments = ['-c'])
+
+test.must_not_exist([ 'build', 'lib', obj ])
+for f in files:
+    test.must_not_exist([ 'build', 'lib', f ])
+
+test.must_exist(['src', 'lib', 'foo.c'])
+test.must_exist(['SConstruct'])
+test.must_exist(['src', 'lib', 'SConscript'])
+test.must_exist(['src', 'bin', 'SConscript'])
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:
diff --git a/test/LINK/VersionedLib-subdir.py b/test/LINK/VersionedLib-subdir.py
index 5fae101..6facd41 100644
--- a/test/LINK/VersionedLib-subdir.py
+++ b/test/LINK/VersionedLib-subdir.py
@@ -76,8 +76,8 @@ env.Program('main.c', LIBS=['foo'])
 
 test.run(arguments = ['--tree=all'])
 
-if platform == 'cygwin':
-    # PATH is used to search for *.dll librarier (cygfoo-0-2-1.dll in our case)
+if platform == 'cygwin' or platform == 'win32':
+    # PATH is used to search for *.dll libraries on windows
     path = os.environ.get('PATH','')
     if path: path = path + os.pathsep
     path = path + test.workpath(subdir)