SCons/Tool/cyglink.py

   1 """SCons.Tool.cyglink
   2
   3 Customization of gnulink for Cygwin (http://www.cygwin.com/)
   4
   5 There normally shouldn't be any need to import this module directly.
   6 It will usually be imported through the generic SCons.Tool.Tool()
   7 selection method.
   8
   9 """
  10
  11 from SCons.Tool.linkCommon import StringizeLibSymlinks, EmitLibSymlinks
  12 from SCons.Util import CLVar, is_String
  13 from . import gnulink
  14
  15
  16 def cyglink_lib_emitter(target, source, env, **kw):
  17     verbose = True
  18
  19     if 'variable_prefix' in kw:
  20         var_prefix = kw['variable_prefix']
  21     else:
  22         var_prefix = 'SHLIB'
  23
  24     no_import_lib = env.get('no_import_lib', False)
  25
  26     if verbose:
  27         print("cyglink_lib_emitter: target[0]={!r}".format(target[0].get_path()))
  28
  29     if not no_import_lib:
  30         # Specify import lib and add to targets
  31
  32         import_lib = env.subst('$%s_IMPLIBNAME' % var_prefix, target=target, source=source)
  33         import_lib_target = env.fs.File(import_lib)
  34         import_lib_target.attributes.shared = True
  35         target.append(import_lib_target)
  36
  37         if verbose:
  38             print("cyglink_lib_emitter: import_lib={}".format(import_lib))
  39             print("cyglink_lib_emitter: target=%s" % target)
  40
  41     for tgt in target:
  42         if is_String(tgt):
  43             tgt = env.File(tgt)
  44         tgt.attributes.shared = True
  45
  46     return target, source
  47
  48
  49 def cyglink_ldmodule_emitter(target, source, env, **kw):
  50     return cyglink_lib_emitter(target, source, env, variable_prefix='LDMODULE')
  51
  52
  53 def cyglink_shlib_symlink_emitter(target, source, env, **kw):
  54     """
  55     On cygwin, we only create a symlink from the non-versioned implib to the versioned implib.
  56     We don't version the shared library itself.
  57     :param target:
  58     :param source:
  59     :param env:
  60     :param kw:
  61     :return:
  62     """
  63     verbose = True
  64
  65     if 'variable_prefix' in kw:
  66         var_prefix = kw['variable_prefix']
  67     else:
  68         var_prefix = 'SHLIB'
  69
  70     no_import_lib = env.get('no_import_lib', False)
  71     if no_import_lib in ['1', 'True', 'true', True]:
  72         if verbose:
  73             print("cyglink_shlib_symlink_emitter: no_import_lib=%s" % no_import_lib)
  74         return target, source
  75
  76     no_symlinks = env.subst('$%sNOVERSIONSYMLINKS' % var_prefix)
  77     if no_symlinks in ['1', 'True', 'true', True]:
  78         return target, source
  79
  80     shlibversion = env.subst('$%sVERSION' % var_prefix)
  81     if shlibversion:
  82         if verbose:
  83             print("cyglink_shlib_symlink_emitter: %sVERSION=%s" % (var_prefix, shlibversion))
  84
  85         # The implib (added by the cyglink_lib_emitter)
  86         imp_lib_node = target[1]
  87         shlib_noversion_symlink = env.subst('$%s_NOVERSION_SYMLINK' % var_prefix, target=target[0], source=source)
  88
  89         if verbose:
  90             print("cyglink_shlib_symlink_emitter: shlib_noversion_symlink :%s" % shlib_noversion_symlink)
  91             print("cyglink_shlib_symlink_emitter: imp_lib_node            :%s" % imp_lib_node)
  92
  93         symlinks = [(env.File(shlib_noversion_symlink), imp_lib_node)]
  94
  95         if verbose:
  96             print("cyglink_shlib_symlink_emitter: symlinks={!r}".format(
  97                 ', '.join(["%r->%r" % (k, v) for k, v in StringizeLibSymlinks(symlinks)])
  98             ))
  99
 100         if symlinks:
 101             # This does the actual symlinking
 102             EmitLibSymlinks(env, symlinks, target[0])
 103
 104             # This saves the information so if the versioned shared library is installed
 105             # it can faithfully reproduce the correct symlinks
 106             target[0].attributes.shliblinks = symlinks
 107
 108     return target, source
 109
 110
 111 def cyglink_ldmod_symlink_emitter(target, source, env, **kw):
 112     return cyglink_shlib_symlink_emitter(target, source, env, variable_prefix='LDMODULE')
 113
 114
 115 def cyglink_shlibversion(target, source, env, for_signature):
 116     var_prefix = 'SHLIB'
 117     var = '%sVERSION' % var_prefix
 118     if var not in env:
 119         return ''
 120
 121     version = env.subst("$%s" % var, target=target, source=source)
 122     version = version.replace('.', '-')
 123     return "." + version
 124
 125
 126 def cyglink_ldmodule_version(target, source, env, for_signature):
 127     var_prefix = 'LDMODULE'
 128     var = '%sVERSION' % var_prefix
 129     if var not in env:
 130         return ''
 131
 132     version = env.subst("$%s" % var, target=target, source=source)
 133     version = version.replace('.', '-')
 134     return "." + version
 135
 136
 137 def _implib_pre_flags(target, source, env, for_signature) -> str:
 138     no_import_lib = env.get('no_import_lib', False)
 139     if no_import_lib in ['1', 'True', 'true', True]:
 140         return ''
 141     else:
 142         return '-Wl,--out-implib=${TARGETS[1]} -Wl,--export-all-symbols -Wl,--enable-auto-import -Wl,--whole-archive'
 143
 144
 145 def _implib_post_flags(target, source, env, for_signature) -> str:
 146     no_import_lib = env.get('no_import_lib', False)
 147     if no_import_lib in ['1', 'True', 'true', True]:
 148         return ''
 149     else:
 150         return '-Wl,--no-whole-archive'
 151
 152
 153 def generate(env) -> None:
 154     """Add Builders and construction variables for cyglink to an Environment."""
 155     gnulink.generate(env)
 156
 157     env['LINKFLAGS'] = CLVar('-Wl,-no-undefined')
 158
 159     env['SHLIBPREFIX'] = 'cyg'
 160     env['SHLIBSUFFIX'] = '.dll'
 161
 162     env['IMPLIBPREFIX'] = 'lib'
 163     env['IMPLIBSUFFIX'] = '.dll.a'
 164
 165     # Variables used by versioned shared libraries
 166     # SHLIBVERSIONFLAGS and LDMODULEVERSIONFLAGS are same as in gnulink...
 167     env['_SHLIBVERSIONFLAGS'] = '$SHLIBVERSIONFLAGS'
 168     env['_LDMODULEVERSIONFLAGS'] = '$LDMODULEVERSIONFLAGS'
 169
 170     env['_IMPLIB_PRE_SOURCES'] = _implib_pre_flags
 171     env['_IMPLIB_POST_SOURCES'] = _implib_post_flags
 172     env['SHLINKCOM'] = '$SHLINK -o $TARGET $SHLINKFLAGS $__SHLIBVERSIONFLAGS $__RPATH ' \
 173                        '$_IMPLIB_PRE_SOURCES $SOURCES  $_IMPLIB_POST_SOURCES $_LIBDIRFLAGS $_LIBFLAGS'
 174     env['LDMODULECOM'] = '$LDMODULE -o $TARGET $SHLINKFLAGS $__LDMODULEVERSIONFLAGS $__RPATH ' \
 175                          '$_IMPLIB_PRE_SOURCES $SOURCES $_IMPLIB_POST_SOURCES $_LIBDIRFLAGS  $_LIBFLAGS'
 176
 177     # Overwrite emitters. Cyglink does things differently when creating symlinks
 178     env['SHLIBEMITTER'] = [cyglink_lib_emitter, cyglink_shlib_symlink_emitter]
 179     env['LDMODULEEMITTER'] = [cyglink_ldmodule_emitter, cyglink_ldmod_symlink_emitter]
 180
 181     # This is the non versioned shlib filename
 182     # If SHLIBVERSION is defined then this will symlink to $SHLIBNAME
 183     env['SHLIB_NOVERSION_SYMLINK'] = '${IMPLIBPREFIX}$_get_shlib_stem${IMPLIBSUFFIX}'
 184     env['LDMODULE_NOVERSION_SYMLINK'] = '${IMPLIBPREFIX}$_get_ldmodule_stem${IMPLIBSUFFIX}'
 185
 186     env['SHLIB_IMPLIBNAME'] = '${IMPLIBPREFIX}$_get_shlib_stem${_SHLIB_IMPLIBSUFFIX}'
 187     env['LDMODULE_IMPLIBNAME'] = '${IMPLIBPREFIX}$_get_ldmodule_stem${_LDMODULE_IMPLIBSUFFIX}'
 188
 189     env['_cyglink_shlibversion'] = cyglink_shlibversion
 190     env['_SHLIB_IMPLIBSUFFIX'] = '${_cyglink_shlibversion}${IMPLIBSUFFIX}'
 191     env['_SHLIBSUFFIX'] = '${_cyglink_shlibversion}${SHLIBSUFFIX}'
 192
 193     env['_cyglink_ldmodule_version'] = cyglink_ldmodule_version
 194
 195     env['_LDMODULESUFFIX'] = '${_cyglink_ldmodule_version}${LDMODULESUFFIX}'
 196     env['_LDMODULE_IMPLIBSUFFIX'] = '${_cyglink_ldmodule_version}${IMPLIBSUFFIX}'
 197
 198     # Remove variables set by default initialization which aren't needed/used by cyglink
 199     # these variables were set by gnulink but are not used in cyglink
 200     for rv in ['_SHLIBSONAME', '_LDMODULESONAME']:
 201         if rv in env:
 202             del env[rv]
 203
 204
 205 def exists(env):
 206     return gnulink.exists(env)
 207
 208 # Local Variables:
 209 # tab-width:4
 210 # indent-tabs-mode:nil
 211 # End:
 212 # vim: set expandtab tabstop=4 shiftwidth=4: