Home | History | Annotate | Download | only in Misc
      1 # Autodetecting setup.py script for building the Python extensions
      2 #
      3 # Modified for BeOS build.  Donn Cave, March 27 2001.
      4 
      5 __version__ = "special BeOS after 1.37"
      6 
      7 import sys, os
      8 from distutils import sysconfig
      9 from distutils import text_file
     10 from distutils.errors import *
     11 from distutils.core import Extension, setup
     12 from distutils.command.build_ext import build_ext
     13 
     14 # This global variable is used to hold the list of modules to be disabled.
     15 disabled_module_list = ['dbm', 'mmap', 'resource', 'nis']
     16 
     17 def find_file(filename, std_dirs, paths):
     18     """Searches for the directory where a given file is located,
     19     and returns a possibly-empty list of additional directories, or None
     20     if the file couldn't be found at all.
     21 
     22     'filename' is the name of a file, such as readline.h or libcrypto.a.
     23     'std_dirs' is the list of standard system directories; if the
     24         file is found in one of them, no additional directives are needed.
     25     'paths' is a list of additional locations to check; if the file is
     26         found in one of them, the resulting list will contain the directory.
     27     """
     28 
     29     # Check the standard locations
     30     for dir in std_dirs:
     31         f = os.path.join(dir, filename)
     32         if os.path.exists(f): return []
     33 
     34     # Check the additional directories
     35     for dir in paths:
     36         f = os.path.join(dir, filename)
     37         if os.path.exists(f):
     38             return [dir]
     39 
     40     # Not found anywhere
     41     return None
     42 
     43 def find_library_file(compiler, libname, std_dirs, paths):
     44     filename = compiler.library_filename(libname, lib_type='shared')
     45     result = find_file(filename, std_dirs, paths)
     46     if result is not None: return result
     47 
     48     filename = compiler.library_filename(libname, lib_type='static')
     49     result = find_file(filename, std_dirs, paths)
     50     return result
     51 
     52 def module_enabled(extlist, modname):
     53     """Returns whether the module 'modname' is present in the list
     54     of extensions 'extlist'."""
     55     extlist = [ext for ext in extlist if ext.name == modname]
     56     return len(extlist)
     57 
     58 class PyBuildExt(build_ext):
     59 
     60     def build_extensions(self):
     61 
     62         # Detect which modules should be compiled
     63         self.detect_modules()
     64 
     65         # Remove modules that are present on the disabled list
     66         self.extensions = [ext for ext in self.extensions
     67                            if ext.name not in disabled_module_list]
     68 
     69         # Fix up the autodetected modules, prefixing all the source files
     70         # with Modules/ and adding Python's include directory to the path.
     71         (srcdir,) = sysconfig.get_config_vars('srcdir')
     72 
     73         # Figure out the location of the source code for extension modules
     74         moddir = os.path.join(os.getcwd(), srcdir, 'Modules')
     75         moddir = os.path.normpath(moddir)
     76         srcdir, tail = os.path.split(moddir)
     77         srcdir = os.path.normpath(srcdir)
     78         moddir = os.path.normpath(moddir)
     79 
     80         # Fix up the paths for scripts, too
     81         self.distribution.scripts = [os.path.join(srcdir, filename)
     82                                      for filename in self.distribution.scripts]
     83 
     84         for ext in self.extensions[:]:
     85             ext.sources = [ os.path.join(moddir, filename)
     86                             for filename in ext.sources ]
     87             ext.include_dirs.append( '.' ) # to get config.h
     88             ext.include_dirs.append( os.path.join(srcdir, './Include') )
     89 
     90             # If a module has already been built statically,
     91             # don't build it here
     92             if ext.name in sys.builtin_module_names:
     93                 self.extensions.remove(ext)
     94 
     95         # Parse Modules/Setup to figure out which modules are turned
     96         # on in the file.
     97         input = text_file.TextFile('Modules/Setup', join_lines=1)
     98         remove_modules = []
     99         while 1:
    100             line = input.readline()
    101             if not line: break
    102             line = line.split()
    103             remove_modules.append( line[0] )
    104         input.close()
    105 
    106         for ext in self.extensions[:]:
    107             if ext.name in remove_modules:
    108                 self.extensions.remove(ext)
    109 
    110         # When you run "make CC=altcc" or something similar, you really want
    111         # those environment variables passed into the setup.py phase.  Here's
    112         # a small set of useful ones.
    113         compiler = os.environ.get('CC')
    114         linker_so = os.environ.get('LDSHARED')
    115         args = {}
    116         # unfortunately, distutils doesn't let us provide separate C and C++
    117         # compilers
    118         if compiler is not None:
    119             args['compiler_so'] = compiler
    120         if linker_so is not None:
    121             args['linker_so'] = linker_so + ' -shared'
    122         self.compiler.set_executables(**args)
    123 
    124         build_ext.build_extensions(self)
    125 
    126     def build_extension(self, ext):
    127 
    128         try:
    129             build_ext.build_extension(self, ext)
    130         except (CCompilerError, DistutilsError), why:
    131             self.announce('WARNING: building of extension "%s" failed: %s' %
    132                           (ext.name, sys.exc_info()[1]))
    133 
    134     def get_platform (self):
    135         # Get value of sys.platform
    136         platform = sys.platform
    137         if platform[:6] =='cygwin':
    138             platform = 'cygwin'
    139         elif platform[:4] =='beos':
    140             platform = 'beos'
    141 
    142         return platform
    143 
    144     def detect_modules(self):
    145         try:
    146             belibs = os.environ['BELIBRARIES'].split(';')
    147         except KeyError:
    148             belibs = ['/boot/beos/system/lib']
    149         belibs.append('/boot/home/config/lib')
    150         self.compiler.library_dirs.append('/boot/home/config/lib')
    151         try:
    152             beincl = os.environ['BEINCLUDES'].split(';')
    153         except KeyError:
    154             beincl = []
    155         beincl.append('/boot/home/config/include')
    156         self.compiler.include_dirs.append('/boot/home/config/include')
    157         # lib_dirs and inc_dirs are used to search for files;
    158         # if a file is found in one of those directories, it can
    159         # be assumed that no additional -I,-L directives are needed.
    160         lib_dirs = belibs
    161         inc_dirs = beincl
    162         exts = []
    163 
    164         platform = self.get_platform()
    165 
    166         # Check for MacOS X, which doesn't need libm.a at all
    167         math_libs = ['m']
    168         if platform in ['Darwin1.2', 'beos']:
    169             math_libs = []
    170 
    171         # XXX Omitted modules: gl, pure, dl, SGI-specific modules
    172 
    173         #
    174         # The following modules are all pretty straightforward, and compile
    175         # on pretty much any POSIXish platform.
    176         #
    177 
    178         # Some modules that are normally always on:
    179         exts.append( Extension('_weakref', ['_weakref.c']) )
    180         exts.append( Extension('_symtable', ['symtablemodule.c']) )
    181 
    182         # array objects
    183         exts.append( Extension('array', ['arraymodule.c']) )
    184         # complex math library functions
    185         exts.append( Extension('cmath', ['cmathmodule.c'],
    186                                libraries=math_libs) )
    187 
    188         # math library functions, e.g. sin()
    189         exts.append( Extension('math',  ['mathmodule.c'],
    190                                libraries=math_libs) )
    191         # fast string operations implemented in C
    192         exts.append( Extension('strop', ['stropmodule.c']) )
    193         # time operations and variables
    194         exts.append( Extension('time', ['timemodule.c'],
    195                                libraries=math_libs) )
    196         # operator.add() and similar goodies
    197         exts.append( Extension('operator', ['operator.c']) )
    198         # access to the built-in codecs and codec registry
    199         exts.append( Extension('_codecs', ['_codecsmodule.c']) )
    200         # Python C API test module
    201         exts.append( Extension('_testcapi', ['_testcapimodule.c']) )
    202         # static Unicode character database
    203         exts.append( Extension('unicodedata', ['unicodedata.c']) )
    204         # access to ISO C locale support
    205         exts.append( Extension('_locale', ['_localemodule.c']) )
    206 
    207         # Modules with some UNIX dependencies -- on by default:
    208         # (If you have a really backward UNIX, select and socket may not be
    209         # supported...)
    210 
    211         # fcntl(2) and ioctl(2)
    212         exts.append( Extension('fcntl', ['fcntlmodule.c']) )
    213         # pwd(3)
    214         exts.append( Extension('pwd', ['pwdmodule.c']) )
    215         # grp(3)
    216         exts.append( Extension('grp', ['grpmodule.c']) )
    217         # posix (UNIX) errno values
    218         exts.append( Extension('errno', ['errnomodule.c']) )
    219         # select(2); not on ancient System V
    220         exts.append( Extension('select', ['selectmodule.c']) )
    221 
    222         # The md5 module implements the RSA Data Security, Inc. MD5
    223         # Message-Digest Algorithm, described in RFC 1321.  The necessary files
    224         # md5c.c and md5.h are included here.
    225         exts.append( Extension('md5', ['md5module.c', 'md5c.c']) )
    226 
    227         # The sha module implements the SHA checksum algorithm.
    228         # (NIST's Secure Hash Algorithm.)
    229         exts.append( Extension('sha', ['shamodule.c']) )
    230 
    231         # Helper module for various ascii-encoders
    232         exts.append( Extension('binascii', ['binascii.c']) )
    233 
    234         # Fred Drake's interface to the Python parser
    235         exts.append( Extension('parser', ['parsermodule.c']) )
    236 
    237         # cStringIO and cPickle
    238         exts.append( Extension('cStringIO', ['cStringIO.c']) )
    239         exts.append( Extension('cPickle', ['cPickle.c']) )
    240 
    241         # Memory-mapped files (also works on Win32).
    242         exts.append( Extension('mmap', ['mmapmodule.c']) )
    243 
    244         # Lance Ellinghaus's syslog daemon interface
    245         exts.append( Extension('syslog', ['syslogmodule.c']) )
    246 
    247         # George Neville-Neil's timing module:
    248         exts.append( Extension('timing', ['timingmodule.c']) )
    249 
    250         #
    251         # Here ends the simple stuff.  From here on, modules need certain
    252         # libraries, are platform-specific, or present other surprises.
    253         #
    254 
    255         # Multimedia modules
    256         # These don't work for 64-bit platforms!!!
    257         # These represent audio samples or images as strings:
    258 
    259         # Disabled on 64-bit platforms
    260         if sys.maxint != 9223372036854775807L:
    261             # Operations on audio samples
    262             exts.append( Extension('audioop', ['audioop.c']) )
    263             # Operations on images
    264             exts.append( Extension('imageop', ['imageop.c']) )
    265             # Read SGI RGB image files (but coded portably)
    266             exts.append( Extension('rgbimg', ['rgbimgmodule.c']) )
    267 
    268         # readline
    269         if self.compiler.find_library_file(lib_dirs, 'readline'):
    270             readline_libs = ['readline']
    271             if self.compiler.find_library_file(lib_dirs +
    272                                                ['/usr/lib/termcap'],
    273                                                'termcap'):
    274                 readline_libs.append('termcap')
    275             exts.append( Extension('readline', ['readline.c'],
    276                                    library_dirs=['/usr/lib/termcap'],
    277                                    libraries=readline_libs) )
    278 
    279         # The crypt module is now disabled by default because it breaks builds
    280         # on many systems (where -lcrypt is needed), e.g. Linux (I believe).
    281 
    282         if self.compiler.find_library_file(lib_dirs, 'crypt'):
    283             libs = ['crypt']
    284         else:
    285             libs = []
    286         exts.append( Extension('crypt', ['cryptmodule.c'], libraries=libs) )
    287 
    288         # socket(2)
    289         # Detect SSL support for the socket module
    290         ssl_incs = find_file('openssl/ssl.h', inc_dirs,
    291                              ['/usr/local/ssl/include',
    292                               '/usr/contrib/ssl/include/'
    293                              ]
    294                              )
    295         ssl_libs = find_library_file(self.compiler, 'ssl',lib_dirs,
    296                                      ['/usr/local/ssl/lib',
    297                                       '/usr/contrib/ssl/lib/'
    298                                      ] )
    299 
    300         if (ssl_incs is not None and
    301             ssl_libs is not None):
    302             exts.append( Extension('_socket', ['socketmodule.c'],
    303                                    include_dirs = ssl_incs,
    304                                    library_dirs = ssl_libs,
    305                                    libraries = ['ssl', 'crypto'],
    306                                    define_macros = [('USE_SSL',1)] ) )
    307         else:
    308             exts.append( Extension('_socket', ['socketmodule.c']) )
    309 
    310         # Modules that provide persistent dictionary-like semantics.  You will
    311         # probably want to arrange for at least one of them to be available on
    312         # your machine, though none are defined by default because of library
    313         # dependencies.  The Python module anydbm.py provides an
    314         # implementation independent wrapper for these; dumbdbm.py provides
    315         # similar functionality (but slower of course) implemented in Python.
    316 
    317         # The standard Unix dbm module:
    318         if platform not in ['cygwin']:
    319             if (self.compiler.find_library_file(lib_dirs, 'ndbm')):
    320                 exts.append( Extension('dbm', ['dbmmodule.c'],
    321                                        libraries = ['ndbm'] ) )
    322             else:
    323                 exts.append( Extension('dbm', ['dbmmodule.c']) )
    324 
    325         # Anthony Baxter's gdbm module.  GNU dbm(3) will require -lgdbm:
    326         if (self.compiler.find_library_file(lib_dirs, 'gdbm')):
    327             exts.append( Extension('gdbm', ['gdbmmodule.c'],
    328                                    libraries = ['gdbm'] ) )
    329 
    330         # Berkeley DB interface.
    331         #
    332         # This requires the Berkeley DB code, see
    333         # ftp://ftp.cs.berkeley.edu/pub/4bsd/db.1.85.tar.gz
    334         #
    335         # Edit the variables DB and DBPORT to point to the db top directory
    336         # and the subdirectory of PORT where you built it.
    337         #
    338         # (See http://electricrain.com/greg/python/bsddb3/ for an interface to
    339         # BSD DB 3.x.)
    340 
    341         dblib = []
    342         if self.compiler.find_library_file(lib_dirs, 'db'):
    343             dblib = ['db']
    344 
    345         db185_incs = find_file('db_185.h', inc_dirs,
    346                                ['/usr/include/db3', '/usr/include/db2'])
    347         db_inc = find_file('db.h', inc_dirs, ['/usr/include/db1'])
    348         if db185_incs is not None:
    349             exts.append( Extension('bsddb', ['bsddbmodule.c'],
    350                                    include_dirs = db185_incs,
    351                                    define_macros=[('HAVE_DB_185_H',1)],
    352                                    libraries = dblib ) )
    353         elif db_inc is not None:
    354             exts.append( Extension('bsddb', ['bsddbmodule.c'],
    355                                    include_dirs = db_inc,
    356                                    libraries = dblib) )
    357 
    358         # Unix-only modules
    359         if platform == 'win32':
    360             # Steen Lumholt's termios module
    361             exts.append( Extension('termios', ['termios.c']) )
    362             # Jeremy Hylton's rlimit interface
    363             if platform not in ['cygwin']:
    364                 exts.append( Extension('resource', ['resource.c']) )
    365 
    366             # Generic dynamic loading module
    367             #exts.append( Extension('dl', ['dlmodule.c']) )
    368 
    369             # Sun yellow pages. Some systems have the functions in libc.
    370             if platform not in ['cygwin']:
    371                 if (self.compiler.find_library_file(lib_dirs, 'nsl')):
    372                     libs = ['nsl']
    373                 else:
    374                     libs = []
    375                 exts.append( Extension('nis', ['nismodule.c'],
    376                                        libraries = libs) )
    377 
    378         # Curses support, requring the System V version of curses, often
    379         # provided by the ncurses library.
    380         if (self.compiler.find_library_file(lib_dirs, 'ncurses')):
    381             curses_libs = ['ncurses']
    382             exts.append( Extension('_curses', ['_cursesmodule.c'],
    383                                    libraries = curses_libs) )
    384         elif (self.compiler.find_library_file(lib_dirs, 'curses')):
    385             if (self.compiler.find_library_file(lib_dirs, 'terminfo')):
    386                 curses_libs = ['curses', 'terminfo']
    387             else:
    388                 curses_libs = ['curses', 'termcap']
    389 
    390             exts.append( Extension('_curses', ['_cursesmodule.c'],
    391                                    libraries = curses_libs) )
    392 
    393         # If the curses module is enabled, check for the panel module
    394         if (os.path.exists('Modules/_curses_panel.c') and
    395             module_enabled(exts, '_curses') and
    396             self.compiler.find_library_file(lib_dirs, 'panel')):
    397             exts.append( Extension('_curses_panel', ['_curses_panel.c'],
    398                                    libraries = ['panel'] + curses_libs) )
    399 
    400 
    401 
    402         # Lee Busby's SIGFPE modules.
    403         # The library to link fpectl with is platform specific.
    404         # Choose *one* of the options below for fpectl:
    405 
    406         if platform == 'irix5':
    407             # For SGI IRIX (tested on 5.3):
    408             exts.append( Extension('fpectl', ['fpectlmodule.c'],
    409                                    libraries=['fpe']) )
    410         elif 0: # XXX how to detect SunPro?
    411             # For Solaris with SunPro compiler (tested on Solaris 2.5 with SunPro C 4.2):
    412             # (Without the compiler you don't have -lsunmath.)
    413             #fpectl fpectlmodule.c -R/opt/SUNWspro/lib -lsunmath -lm
    414             pass
    415         else:
    416             # For other systems: see instructions in fpectlmodule.c.
    417             #fpectl fpectlmodule.c ...
    418             exts.append( Extension('fpectl', ['fpectlmodule.c']) )
    419 
    420 
    421         # Andrew Kuchling's zlib module.
    422         # This require zlib 1.1.3 (or later).
    423         # See http://www.gzip.org/zlib/
    424         if (self.compiler.find_library_file(lib_dirs, 'z')):
    425             exts.append( Extension('zlib', ['zlibmodule.c'],
    426                                    libraries = ['z']) )
    427 
    428         # Interface to the Expat XML parser
    429         #
    430         # Expat is written by James Clark and must be downloaded separately
    431         # (see below).  The pyexpat module was written by Paul Prescod after a
    432         # prototype by Jack Jansen.
    433         #
    434         # The Expat dist includes Windows .lib and .dll files.  Home page is
    435         # at http://www.jclark.com/xml/expat.html, the current production
    436         # release is always ftp://ftp.jclark.com/pub/xml/expat.zip.
    437         #
    438         # EXPAT_DIR, below, should point to the expat/ directory created by
    439         # unpacking the Expat source distribution.
    440         #
    441         # Note: the expat build process doesn't yet build a libexpat.a; you
    442         # can do this manually while we try convince the author to add it.  To
    443         # do so, cd to EXPAT_DIR, run "make" if you have not done so, then
    444         # run:
    445         #
    446         #    ar cr libexpat.a xmltok/*.o xmlparse/*.o
    447         #
    448         expat_defs = []
    449         expat_incs = find_file('expat.h', inc_dirs, [])
    450         if expat_incs is not None:
    451             # expat.h was found
    452             expat_defs = [('HAVE_EXPAT_H', 1)]
    453         else:
    454             expat_incs = find_file('xmlparse.h', inc_dirs, [])
    455 
    456         if (expat_incs is not None and
    457             self.compiler.find_library_file(lib_dirs, 'expat')):
    458             exts.append( Extension('pyexpat', ['pyexpat.c'],
    459                                    define_macros = expat_defs,
    460                                    libraries = ['expat']) )
    461 
    462         # Platform-specific libraries
    463         if platform == 'linux2':
    464             # Linux-specific modules
    465             exts.append( Extension('linuxaudiodev', ['linuxaudiodev.c']) )
    466 
    467         if platform == 'sunos5':
    468             # SunOS specific modules
    469             exts.append( Extension('sunaudiodev', ['sunaudiodev.c']) )
    470 
    471         self.extensions.extend(exts)
    472 
    473         # Call the method for detecting whether _tkinter can be compiled
    474         self.detect_tkinter(inc_dirs, lib_dirs)
    475 
    476 
    477     def detect_tkinter(self, inc_dirs, lib_dirs):
    478         # The _tkinter module.
    479 
    480         # Assume we haven't found any of the libraries or include files
    481         tcllib = tklib = tcl_includes = tk_includes = None
    482         for version in ['8.4', '8.3', '8.2', '8.1', '8.0']:
    483             tklib = self.compiler.find_library_file(lib_dirs,
    484                                                     'tk' + version )
    485             tcllib = self.compiler.find_library_file(lib_dirs,
    486                                                      'tcl' + version )
    487             if tklib and tcllib:
    488                 # Exit the loop when we've found the Tcl/Tk libraries
    489                 break
    490 
    491         # Now check for the header files
    492         if tklib and tcllib:
    493             # Check for the include files on Debian, where
    494             # they're put in /usr/include/{tcl,tk}X.Y
    495             debian_tcl_include = [ '/usr/include/tcl' + version ]
    496             debian_tk_include =  [ '/usr/include/tk'  + version ] + debian_tcl_include
    497             tcl_includes = find_file('tcl.h', inc_dirs, debian_tcl_include)
    498             tk_includes = find_file('tk.h', inc_dirs, debian_tk_include)
    499 
    500         if (tcllib is None or tklib is None and
    501             tcl_includes is None or tk_includes is None):
    502             # Something's missing, so give up
    503             return
    504 
    505         # OK... everything seems to be present for Tcl/Tk.
    506 
    507         include_dirs = [] ; libs = [] ; defs = [] ; added_lib_dirs = []
    508         for dir in tcl_includes + tk_includes:
    509             if dir not in include_dirs:
    510                 include_dirs.append(dir)
    511 
    512         # Check for various platform-specific directories
    513         platform = self.get_platform()
    514         if platform == 'sunos5':
    515             include_dirs.append('/usr/openwin/include')
    516             added_lib_dirs.append('/usr/openwin/lib')
    517         elif os.path.exists('/usr/X11R6/include'):
    518             include_dirs.append('/usr/X11R6/include')
    519             added_lib_dirs.append('/usr/X11R6/lib')
    520         elif os.path.exists('/usr/X11R5/include'):
    521             include_dirs.append('/usr/X11R5/include')
    522             added_lib_dirs.append('/usr/X11R5/lib')
    523         else:
    524             # Assume default location for X11
    525             include_dirs.append('/usr/X11/include')
    526             added_lib_dirs.append('/usr/X11/lib')
    527 
    528         # Check for BLT extension
    529         if self.compiler.find_library_file(lib_dirs + added_lib_dirs, 'BLT8.0'):
    530             defs.append( ('WITH_BLT', 1) )
    531             libs.append('BLT8.0')
    532 
    533         # Add the Tcl/Tk libraries
    534         libs.append('tk'+version)
    535         libs.append('tcl'+version)
    536 
    537         if platform in ['aix3', 'aix4']:
    538             libs.append('ld')
    539 
    540         # Finally, link with the X11 libraries
    541         libs.append('X11')
    542 
    543         ext = Extension('_tkinter', ['_tkinter.c', 'tkappinit.c'],
    544                         define_macros=[('WITH_APPINIT', 1)] + defs,
    545                         include_dirs = include_dirs,
    546                         libraries = libs,
    547                         library_dirs = added_lib_dirs,
    548                         )
    549         self.extensions.append(ext)
    550 
    551         # XXX handle these, but how to detect?
    552         # *** Uncomment and edit for PIL (TkImaging) extension only:
    553         #       -DWITH_PIL -I../Extensions/Imaging/libImaging  tkImaging.c \
    554         # *** Uncomment and edit for TOGL extension only:
    555         #       -DWITH_TOGL togl.c \
    556         # *** Uncomment these for TOGL extension only:
    557         #       -lGL -lGLU -lXext -lXmu \
    558 
    559 def main():
    560     setup(name = 'Python standard library',
    561           version = '%d.%d' % sys.version_info[:2],
    562           cmdclass = {'build_ext':PyBuildExt},
    563           # The struct module is defined here, because build_ext won't be
    564           # called unless there's at least one extension module defined.
    565           ext_modules=[Extension('struct', ['structmodule.c'])],
    566 
    567           # Scripts to install
    568           scripts = ['Tools/scripts/pydoc']
    569         )
    570 
    571 # --install-platlib
    572 if __name__ == '__main__':
    573     sysconfig.set_python_build()
    574     main()
    575