wxPython/config.py

   1 #----------------------------------------------------------------------
   2 # Name:        wx.build.config
   3 # Purpose:     Most of the contents of this module used to be located
   4 #              in wxPython's setup.py script.  It was moved here so
   5 #              it would be installed with the rest of wxPython and
   6 #              could therefore be used by the setup.py for other
   7 #              projects that needed this same info and functionality
   8 #              (most likely in order to be compatible with wxPython.)
   9 #
  10 #              This split from setup.py is still fairly rough, and
  11 #              some things may still get shuffled back and forth,
  12 #              refactored, etc.  Please send me any comments and
  13 #              suggestions about this.
  14 #
  15 # Author:      Robin Dunn
  16 #
  17 # Created:     23-March-2004
  18 # RCS-ID:      $Id$
  19 # Copyright:   (c) 2004 by Total Control Software
  20 # Licence:     wxWindows license
  21 #----------------------------------------------------------------------
  22
  23 import sys, os, glob, fnmatch, tempfile
  24 from distutils.core      import setup, Extension
  25 from distutils.file_util import copy_file
  26 from distutils.dir_util  import mkpath
  27 from distutils.dep_util  import newer
  28 from distutils.spawn     import spawn
  29
  30 import distutils.command.install
  31 import distutils.command.install_data
  32 import distutils.command.install_headers
  33 import distutils.command.clean
  34
  35 #----------------------------------------------------------------------
  36 # flags and values that affect this script
  37 #----------------------------------------------------------------------
  38
  39 VER_MAJOR        = 2      # The first three must match wxWidgets
  40 VER_MINOR        = 7
  41 VER_RELEASE      = 0
  42 VER_SUBREL       = 0      # wxPython release num for x.y.z release of wxWidgets
  43 VER_FLAGS        = "pre"  # release flags, such as prerelease or RC num, etc.
  44
  45 DESCRIPTION      = "Cross platform GUI toolkit for Python"
  46 AUTHOR           = "Robin Dunn"
  47 AUTHOR_EMAIL     = "Robin Dunn <robin@alldunn.com>"
  48 URL              = "http://wxPython.org/"
  49 DOWNLOAD_URL     = "http://wxPython.org/download.php"
  50 LICENSE          = "wxWidgets Library License (LGPL derivative)"
  51 PLATFORMS        = "WIN32,OSX,POSIX"
  52 KEYWORDS         = "GUI,wx,wxWindows,wxWidgets,cross-platform"
  53
  54 LONG_DESCRIPTION = """\
  55 wxPython is a GUI toolkit for Python that is a wrapper around the
  56 wxWidgets C++ GUI library.  wxPython provides a large variety of
  57 window types and controls, all implemented with a native look and
  58 feel (by using the native widgets) on the platforms upon which it is
  59 supported.
  60 """
  61
  62 CLASSIFIERS      = """\
  63 Development Status :: 6 - Mature
  64 Environment :: MacOS X :: Carbon
  65 Environment :: Win32 (MS Windows)
  66 Environment :: X11 Applications :: GTK
  67 Intended Audience :: Developers
  68 License :: OSI Approved
  69 Operating System :: MacOS :: MacOS X
  70 Operating System :: Microsoft :: Windows :: Windows 95/98/2000
  71 Operating System :: POSIX
  72 Programming Language :: Python
  73 Topic :: Software Development :: User Interfaces
  74 """
  75
  76 ## License :: OSI Approved :: wxWidgets Library Licence
  77
  78
  79 # Config values below this point can be reset on the setup.py command line.
  80
  81 BUILD_GLCANVAS = 1 # If true, build the contrib/glcanvas extension module
  82 BUILD_OGL = 0      # If true, build the contrib/ogl extension module
  83 BUILD_STC = 1      # If true, build the contrib/stc extension module
  84 BUILD_GIZMOS = 1   # Build a module for the gizmos contrib library
  85 BUILD_ANIMATE = 1  # Build a module for the animate contrib library
  86 BUILD_DLLWIDGET = 0# Build a module that enables unknown wx widgets
  87                    # to be loaded from a DLL and to be used from Python.
  88
  89                    # Internet Explorer wrapper (experimental)
  90 BUILD_ACTIVEX = (os.name == 'nt')  # new version of IEWIN and more
  91
  92
  93 CORE_ONLY = 0      # if true, don't build any of the above
  94
  95 PREP_ONLY = 0      # Only run the prepatory steps, not the actual build.
  96
  97 USE_SWIG = 0       # Should we actually execute SWIG, or just use the
  98                    # files already in the distribution?
  99
 100 SWIG = "swig"      # The swig executable to use.
 101
 102 BUILD_RENAMERS = 1 # Should we build the renamer modules too?
 103
 104 FULL_DOCS = 0      # Some docstrings are split into a basic docstring and a
 105                    # details string.  Setting this flag to 1 will
 106                    # cause the two strings to be combined and output
 107                    # as the full docstring.
 108
 109 UNICODE = 0        # This will pass the 'wxUSE_UNICODE' flag to SWIG and
 110                    # will ensure that the right headers are found and the
 111                    # right libs are linked.
 112
 113 UNDEF_NDEBUG = 1   # Python 2.2 on Unix/Linux by default defines NDEBUG,
 114                    # and distutils will pick this up and use it on the
 115                    # compile command-line for the extensions.  This could
 116                    # conflict with how wxWidgets was built.  If NDEBUG is
 117                    # set then wxWidgets' __WXDEBUG__ setting will be turned
 118                    # off.  If wxWidgets was actually built with it turned
 119                    # on then you end up with mismatched class structures,
 120                    # and wxPython will crash.
 121
 122 NO_SCRIPTS = 0     # Don't install the tool scripts
 123 NO_HEADERS = 0     # Don't install the wxPython *.h and *.i files
 124
 125 INSTALL_MULTIVERSION = 1 # Install the packages such that multiple versions
 126                    # can co-exist.  When turned on the wx and wxPython
 127                    # pacakges will be installed in a versioned subdir
 128                    # of site-packages, and a *.pth file will be
 129                    # created that adds that dir to the sys.path.  In
 130                    # addition, a wxselect.py module will be installed
 131                    # to site-pacakges that will allow applications to
 132                    # choose a specific version if more than one is
 133                    # installed.
 134
 135 FLAVOUR = ""       # Optional flavour string to be appended to VERSION
 136                    # in MULTIVERSION installs
 137
 138 EP_ADD_OPTS = 1    # When doing MULTIVERSION installs the wx port and
 139                    # ansi/unicode settings can optionally be added to the
 140                    # subdir path used in site-packages
 141
 142 EP_FULL_VER = 0    # When doing MULTIVERSION installs the default is to
 143                    # put only 2 or 3 (depending on stable/unstable) of
 144                    # the version compnonents into the "extra path"
 145                    # subdir of site-packages.  Setting this option to
 146                    # 1 will cause the full 4 components of the version
 147                    # number to be used instead.
 148
 149 WX_CONFIG = None   # Usually you shouldn't need to touch this, but you can set
 150                    # it to pass an alternate version of wx-config or alternate
 151                    # flags, eg. as required by the .deb in-tree build.  By
 152                    # default a wx-config command will be assembled based on
 153                    # version, port, etc. and it will be looked for on the
 154                    # default $PATH.
 155
 156 SYS_WX_CONFIG = None # When installing an in tree build, setup.py uses wx-config
 157                      # for two different purposes.  First, to determine the prefix
 158                      # where files will be installed, and secondly, to initialise
 159                      # build_options.py with the correct options for it.
 160                      # WX_CONFIG is used for the first task.  SYS_WX_CONFIG may
 161                      # be set independently, to the value that should appear in
 162                      # build_options.py, if it is different to that.  The default
 163                      # is to use the value of WX_CONFIG.
 164
 165 WXPORT = 'gtk2'    # On Linux/Unix there are several ports of wxWidgets available.
 166                    # Setting this value lets you select which will be used for
 167                    # the wxPython build.  Possibilites are 'gtk', 'gtk2' and
 168                    # 'x11'.  Curently only gtk and gtk2 works.
 169
 170 BUILD_BASE = "build" # Directory to use for temporary build files.
 171                      # This name will be appended to if the WXPORT or
 172                      # the UNICODE flags are set to non-standard
 173                      # values.  See below.
 174
 175
 176 CONTRIBS_INC = ""  # A dir to add as an -I flag when compiling the contribs
 177
 178
 179 # Some MSW build settings
 180
 181 MONOLITHIC = 1     # The core wxWidgets lib can be built as either a
 182                    # single monolithic DLL or as a collection of DLLs.
 183                    # This flag controls which set of libs will be used
 184                    # on Windows.  (For other platforms it is automatic
 185                    # via using wx-config.)
 186
 187 FINAL = 0          # Will use the release version of the wxWidgets libs on MSW.
 188
 189 HYBRID = 1         # Will use the "hybrid" version of the wxWidgets
 190                    # libs on MSW.  A "hybrid" build is one that is
 191                    # basically a release build, but that also defines
 192                    # __WXDEBUG__ to activate the runtime checks and
 193                    # assertions in the library.  When any of these is
 194                    # triggered it is turned into a Python exception so
 195                    # this is a very useful feature to have turned on.
 196
 197
 198                    # Version part of wxWidgets LIB/DLL names
 199 WXDLLVER = '%d%d' % (VER_MAJOR, VER_MINOR)
 200
 201 WXPY_SRC = '.'  # Assume we're in the source tree already, but allow the
 202                 # user to change it, particularly for extension building.
 203
 204
 205 #----------------------------------------------------------------------
 206
 207 def msg(text):
 208     if hasattr(sys, 'setup_is_main') and sys.setup_is_main:
 209         print text
 210
 211
 212 def opj(*args):
 213     path = os.path.join(*args)
 214     return os.path.normpath(path)
 215
 216
 217 def libFlag():
 218     if FINAL:
 219         rv = ''
 220     elif HYBRID:
 221         rv = 'h'
 222     else:
 223         rv = 'd'
 224     if UNICODE:
 225         rv = 'u' + rv
 226     return rv
 227
 228
 229 #----------------------------------------------------------------------
 230 # Some other globals
 231 #----------------------------------------------------------------------
 232
 233 PKGDIR = 'wx'
 234 wxpExtensions = []
 235 DATA_FILES = []
 236 CLEANUP = []
 237
 238 force = '--force' in sys.argv or '-f' in sys.argv
 239 debug = '--debug' in sys.argv or '-g' in sys.argv
 240 cleaning = 'clean' in sys.argv
 241
 242
 243 # change the PORT default for wxMac
 244 if sys.platform[:6] == "darwin":
 245     WXPORT = 'mac'
 246
 247 # and do the same for wxMSW, just for consistency
 248 if os.name == 'nt':
 249     WXPORT = 'msw'
 250
 251 WXPYTHON_TYPE_TABLE = '_wxPython_table'
 252
 253 #----------------------------------------------------------------------
 254 # Check for build flags on the command line
 255 #----------------------------------------------------------------------
 256
 257 # Boolean (int) flags
 258 for flag in [ 'BUILD_ACTIVEX', 'BUILD_ANIMATE', 'BUILD_DLLWIDGET',
 259               'BUILD_GIZMOS', 'BUILD_GLCANVAS',
 260               'BUILD_OGL', 'BUILD_STC',
 261              'CORE_ONLY', 'PREP_ONLY', 'USE_SWIG', 'UNICODE',
 262              'UNDEF_NDEBUG', 'NO_SCRIPTS', 'NO_HEADERS', 'BUILD_RENAMERS',
 263              'FULL_DOCS', 'INSTALL_MULTIVERSION', 'EP_ADD_OPTS', 'EP_FULL_VER',
 264              'MONOLITHIC', 'FINAL', 'HYBRID', ]:
 265     for x in range(len(sys.argv)):
 266         if sys.argv[x].find(flag) == 0:
 267             pos = sys.argv[x].find('=') + 1
 268             if pos > 0:
 269                 vars()[flag] = eval(sys.argv[x][pos:])
 270                 sys.argv[x] = ''
 271
 272 # String options
 273 for option in ['WX_CONFIG', 'SYS_WX_CONFIG', 'WXDLLVER', 'BUILD_BASE',
 274                'WXPORT', 'SWIG', 'CONTRIBS_INC', 'WXPY_SRC', 'FLAVOUR',
 275                ]:
 276     for x in range(len(sys.argv)):
 277         if sys.argv[x].find(option) == 0:
 278             pos = sys.argv[x].find('=') + 1
 279             if pos > 0:
 280                 vars()[option] = sys.argv[x][pos:]
 281                 sys.argv[x] = ''
 282
 283 sys.argv = filter(None, sys.argv)
 284
 285
 286 #----------------------------------------------------------------------
 287 # build options file
 288 #----------------------------------------------------------------------
 289
 290 if SYS_WX_CONFIG is None:
 291     SYS_WX_CONFIG = WX_CONFIG
 292
 293 build_options_template = """
 294 UNICODE=%d
 295 UNDEF_NDEBUG=%d
 296 INSTALL_MULTIVERSION=%d
 297 FLAVOUR="%s"
 298 EP_ADD_OPTS=%d
 299 EP_FULL_VER=%d
 300 WX_CONFIG="%s"
 301 WXPORT="%s"
 302 MONOLITHIC=%d
 303 FINAL=%d
 304 HYBRID=%d
 305 """ % (UNICODE, UNDEF_NDEBUG, INSTALL_MULTIVERSION, FLAVOUR, EP_ADD_OPTS,
 306        EP_FULL_VER, SYS_WX_CONFIG, WXPORT, MONOLITHIC, FINAL, HYBRID)
 307
 308 try:
 309     from build_options import *
 310 except:
 311     build_options_file = os.path.join(os.path.dirname(__file__), "build_options.py")
 312     if not os.path.exists(build_options_file):
 313         try:
 314             myfile = open(build_options_file, "w")
 315             myfile.write(build_options_template)
 316             myfile.close()
 317         except:
 318             print "WARNING: Unable to create build_options.py."
 319
 320
 321 #----------------------------------------------------------------------
 322 # some helper functions
 323 #----------------------------------------------------------------------
 324
 325 def Verify_WX_CONFIG():
 326     """ Called below for the builds that need wx-config, if WX_CONFIG
 327         is not set then determines the flags needed based on build
 328         options and searches for wx-config on the PATH.
 329     """
 330     # if WX_CONFIG hasn't been set to an explicit value then construct one.
 331     global WX_CONFIG
 332     if WX_CONFIG is None:
 333         WX_CONFIG='wx-config'
 334         port = WXPORT
 335         if port == "x11":
 336             port = "x11univ"
 337         flags =  ' --toolkit=%s' % port
 338         flags += ' --unicode=%s' % (UNICODE and 'yes' or 'no')
 339         flags += ' --version=%s.%s' % (VER_MAJOR, VER_MINOR)
 340
 341         searchpath = os.environ["PATH"]
 342         for p in searchpath.split(':'):
 343             fp = os.path.join(p, 'wx-config')
 344             if os.path.exists(fp) and os.access(fp, os.X_OK):
 345                 # success
 346                 msg("Found wx-config: " + fp)
 347                 msg("    Using flags: " + flags)
 348                 WX_CONFIG = fp + flags
 349                 if hasattr(sys, 'setup_is_main') and not sys.setup_is_main:
 350                     WX_CONFIG += " 2>/dev/null "
 351                 break
 352         else:
 353             msg("ERROR: WX_CONFIG not specified and wx-config not found on the $PATH")
 354             # should we exit?
 355
 356         # TODO:  execute WX_CONFIG --list and verify a matching config is found
 357
 358
 359 def run_swig(files, dir, gendir, package, USE_SWIG, force, swig_args,
 360              swig_deps=[], add_under=False):
 361     """Run SWIG the way I want it done"""
 362
 363     if USE_SWIG and not os.path.exists(os.path.join(dir, gendir)):
 364         os.mkdir(os.path.join(dir, gendir))
 365
 366     if USE_SWIG and not os.path.exists(os.path.join("docs", "xml-raw")):
 367         if not os.path.exists("docs"):
 368             os.mkdir("docs")
 369         os.mkdir(os.path.join("docs", "xml-raw"))
 370
 371     sources = []
 372
 373     if add_under:  pre = '_'
 374     else:          pre = ''
 375
 376     for file in files:
 377         basefile = os.path.splitext(file)[0]
 378         i_file   = os.path.join(dir, file)
 379         py_file  = os.path.join(dir, gendir, pre+basefile+'.py')
 380         cpp_file = os.path.join(dir, gendir, pre+basefile+'_wrap.cpp')
 381         xml_file = os.path.join("docs", "xml-raw", basefile+pre+'_swig.xml')
 382
 383         if add_under:
 384             interface = ['-interface', '_'+basefile+'_']
 385         else:
 386             interface = []
 387
 388         sources.append(cpp_file)
 389
 390         if not cleaning and USE_SWIG:
 391             for dep in swig_deps:
 392                 # this may fail for external builds, but it's not
 393                 # a fatal error, so keep going.
 394                 try:
 395                     if newer(dep, py_file) or newer(dep, cpp_file):
 396                         force = 1
 397                         break
 398                 except:
 399                     pass
 400
 401             if force or newer(i_file, py_file) or newer(i_file, cpp_file):
 402                 ## we need forward slashes here, even on win32
 403                 #cpp_file = opj(cpp_file) #'/'.join(cpp_file.split('\\'))
 404                 #i_file = opj(i_file)     #'/'.join(i_file.split('\\'))
 405
 406                 if BUILD_RENAMERS:
 407                     xmltemp = tempfile.mktemp('.xml')
 408
 409                     # First run swig to produce the XML file, adding
 410                     # an extra -D that prevents the old rename
 411                     # directives from being used
 412                     cmd = [ swig_cmd ] + swig_args + \
 413                           [ '-DBUILDING_RENAMERS', '-xmlout', xmltemp ] + \
 414                           ['-I'+dir, '-o', cpp_file, i_file]
 415                     msg(' '.join(cmd))
 416                     spawn(cmd)
 417
 418                     # Next run build_renamers to process the XML
 419                     myRenamer = BuildRenamers()
 420                     myRenamer.run(dir, pre+basefile, xmltemp)
 421                     os.remove(xmltemp)
 422
 423                 # Then run swig for real
 424                 cmd = [ swig_cmd ] + swig_args + interface + \
 425                       ['-I'+dir, '-o', cpp_file, '-xmlout', xml_file, i_file]
 426                 msg(' '.join(cmd))
 427                 spawn(cmd)
 428
 429
 430         # copy the generated python file to the package directory
 431         copy_file(py_file, package, update=not force, verbose=0)
 432         CLEANUP.append(opj(package, os.path.basename(py_file)))
 433
 434     return sources
 435
 436
 437
 438 # Specializations of some distutils command classes
 439 class wx_smart_install_data(distutils.command.install_data.install_data):
 440     """need to change self.install_dir to the actual library dir"""
 441     def run(self):
 442         install_cmd = self.get_finalized_command('install')
 443         self.install_dir = getattr(install_cmd, 'install_lib')
 444         return distutils.command.install_data.install_data.run(self)
 445
 446
 447 class wx_extra_clean(distutils.command.clean.clean):
 448     """
 449     Also cleans stuff that this setup.py copies itself.  If the
 450     --all flag was used also searches for .pyc, .pyd, .so files
 451     """
 452     def run(self):
 453         from distutils import log
 454         from distutils.filelist import FileList
 455         global CLEANUP
 456
 457         distutils.command.clean.clean.run(self)
 458
 459         if self.all:
 460             fl = FileList()
 461             fl.include_pattern("*.pyc", 0)
 462             fl.include_pattern("*.pyd", 0)
 463             fl.include_pattern("*.so", 0)
 464             CLEANUP += fl.files
 465
 466         for f in CLEANUP:
 467             if os.path.isdir(f):
 468                 try:
 469                     if not self.dry_run and os.path.exists(f):
 470                         os.rmdir(f)
 471                     log.info("removing '%s'", f)
 472                 except IOError:
 473                     log.warning("unable to remove '%s'", f)
 474
 475             else:
 476                 try:
 477                     if not self.dry_run and os.path.exists(f):
 478                         os.remove(f)
 479                     log.info("removing '%s'", f)
 480                 except IOError:
 481                     log.warning("unable to remove '%s'", f)
 482
 483
 484
 485 class wx_install(distutils.command.install.install):
 486     """
 487     Turns off install_path_file
 488     """
 489     def initialize_options(self):
 490         distutils.command.install.install.initialize_options(self)
 491         self.install_path_file = 0
 492
 493
 494 class wx_install_headers(distutils.command.install_headers.install_headers):
 495     """
 496     Install the header files to the WXPREFIX, with an extra dir per
 497     filename too
 498     """
 499     def initialize_options(self):
 500         self.root = None
 501         distutils.command.install_headers.install_headers.initialize_options(self)
 502
 503     def finalize_options(self):
 504         self.set_undefined_options('install', ('root', 'root'))
 505         distutils.command.install_headers.install_headers.finalize_options(self)
 506
 507     def run(self):
 508         if os.name == 'nt':
 509             return
 510         headers = self.distribution.headers
 511         if not headers:
 512             return
 513
 514         root = self.root
 515         if root is None or WXPREFIX.startswith(root):
 516             root = ''
 517         for header, location in headers:
 518             install_dir = os.path.normpath(root +
 519                                            WXPREFIX +
 520                                            '/include/wx-%d.%d/wx' % (VER_MAJOR, VER_MINOR) +
 521                                            location)
 522             self.mkpath(install_dir)
 523             (out, _) = self.copy_file(header, install_dir)
 524             self.outfiles.append(out)
 525
 526
 527
 528
 529 def build_locale_dir(destdir, verbose=1):
 530     """Build a locale dir under the wxPython package for MSW"""
 531     moFiles = glob.glob(opj(WXDIR, 'locale', '*.mo'))
 532     for src in moFiles:
 533         lang = os.path.splitext(os.path.basename(src))[0]
 534         dest = opj(destdir, lang, 'LC_MESSAGES')
 535         mkpath(dest, verbose=verbose)
 536         copy_file(src, opj(dest, 'wxstd.mo'), update=1, verbose=verbose)
 537         CLEANUP.append(opj(dest, 'wxstd.mo'))
 538         CLEANUP.append(dest)
 539
 540
 541 def build_locale_list(srcdir):
 542     # get a list of all files under the srcdir, to be used for install_data
 543     def walk_helper(lst, dirname, files):
 544         for f in files:
 545             filename = opj(dirname, f)
 546             if not os.path.isdir(filename):
 547                 lst.append( (dirname, [filename]) )
 548     file_list = []
 549     os.path.walk(srcdir, walk_helper, file_list)
 550     return file_list
 551
 552
 553 def find_data_files(srcdir, *wildcards):
 554     # get a list of all files under the srcdir matching wildcards,
 555     # returned in a format to be used for install_data
 556
 557     def walk_helper(arg, dirname, files):
 558         names = []
 559         lst, wildcards = arg
 560         for wc in wildcards:
 561             for f in files:
 562                 filename = opj(dirname, f)
 563                 if fnmatch.fnmatch(filename, wc) and not os.path.isdir(filename):
 564                     names.append(filename)
 565         if names:
 566             lst.append( (dirname, names ) )
 567
 568     file_list = []
 569     os.path.walk(srcdir, walk_helper, (file_list, wildcards))
 570     return file_list
 571
 572
 573 def makeLibName(name):
 574     if os.name == 'posix':
 575         libname = '%s_%s-%s' % (WXBASENAME, name, WXRELEASE)
 576     elif name:
 577         libname = 'wxmsw%s%s_%s' % (WXDLLVER, libFlag(), name)
 578     else:
 579         libname = 'wxmsw%s%s' % (WXDLLVER, libFlag())
 580     return [libname]
 581
 582
 583
 584 def adjustCFLAGS(cflags, defines, includes):
 585     '''Extract the raw -I, -D, and -U flags and put them into
 586        defines and includes as needed.'''
 587     newCFLAGS = []
 588     for flag in cflags:
 589         if flag[:2] == '-I':
 590             includes.append(flag[2:])
 591         elif flag[:2] == '-D':
 592             flag = flag[2:]
 593             if flag.find('=') == -1:
 594                 defines.append( (flag, None) )
 595             else:
 596                 defines.append( tuple(flag.split('=')) )
 597         elif flag[:2] == '-U':
 598             defines.append( (flag[2:], ) )
 599         else:
 600             newCFLAGS.append(flag)
 601     return newCFLAGS
 602
 603
 604
 605 def adjustLFLAGS(lfags, libdirs, libs):
 606     '''Extract the -L and -l flags and put them in libdirs and libs as needed'''
 607     newLFLAGS = []
 608     for flag in lflags:
 609         if flag[:2] == '-L':
 610             libdirs.append(flag[2:])
 611         elif flag[:2] == '-l':
 612             libs.append(flag[2:])
 613         else:
 614             newLFLAGS.append(flag)
 615
 616     return newLFLAGS
 617
 618
 619
 620 def getExtraPath(shortVer=True, addOpts=False):
 621     """Get the dirname that wxPython will be installed under."""
 622
 623     if shortVer:
 624         # short version, just Major.Minor
 625         ep = "wx-%d.%d" % (VER_MAJOR, VER_MINOR)
 626
 627         # plus release if minor is odd
 628         if VER_MINOR % 2 == 1:
 629             ep += ".%d" % VER_RELEASE
 630
 631     else:
 632         # long version, full version
 633         ep = "wx-%d.%d.%d.%d" % (VER_MAJOR, VER_MINOR, VER_RELEASE, VER_SUBREL)
 634
 635     if addOpts:
 636         port = WXPORT
 637         if port == "msw": port = "win32"
 638         ep += "-%s-%s" % (WXPORT, (UNICODE and 'unicode' or 'ansi'))
 639
 640     if FLAVOUR:
 641         ep += "-" + FLAVOUR
 642
 643     return ep
 644
 645 #----------------------------------------------------------------------
 646 # sanity checks
 647
 648 if CORE_ONLY:
 649     BUILD_GLCANVAS = 0
 650     BUILD_OGL = 0
 651     BUILD_STC = 0
 652     BUILD_GIZMOS = 0
 653     BUILD_DLLWIDGET = 0
 654     BUILD_ACTIVEX = 0
 655     BUILD_ANIMATE = 0
 656
 657 if debug:
 658     FINAL  = 0
 659     HYBRID = 0
 660
 661 if FINAL:
 662     HYBRID = 0
 663
 664 if UNICODE and WXPORT not in ['msw', 'gtk2', 'mac']:
 665     raise SystemExit, "UNICODE mode not currently supported on this WXPORT: "+WXPORT
 666
 667
 668 if CONTRIBS_INC:
 669     CONTRIBS_INC = [ CONTRIBS_INC ]
 670 else:
 671     CONTRIBS_INC = []
 672
 673
 674 #----------------------------------------------------------------------
 675 # Setup some platform specific stuff
 676 #----------------------------------------------------------------------
 677
 678 if os.name == 'nt':
 679     # Set compile flags and such for MSVC.  These values are derived
 680     # from the wxWidgets makefiles for MSVC, other compilers settings
 681     # will probably vary...
 682     if os.environ.has_key('WXWIN'):
 683         WXDIR = os.environ['WXWIN']
 684     else:
 685         msg("WARNING: WXWIN not set in environment.")
 686         WXDIR = '..'  # assumes in CVS tree
 687     WXPLAT = '__WXMSW__'
 688     GENDIR = 'msw'
 689
 690     includes = ['include', 'src',
 691                 opj(WXDIR, 'lib', 'vc_dll', 'msw'  + libFlag()),
 692                 opj(WXDIR, 'include'),
 693                 opj(WXDIR, 'contrib', 'include'),
 694                 ]
 695
 696     defines = [ ('WIN32', None),
 697                 ('_WINDOWS', None),
 698
 699                 (WXPLAT, None),
 700                 ('WXUSINGDLL', '1'),
 701
 702                 ('SWIG_TYPE_TABLE', WXPYTHON_TYPE_TABLE),
 703                 ('WXP_USE_THREAD', '1'),
 704                 ]
 705
 706     if UNDEF_NDEBUG:
 707         defines.append( ('NDEBUG',) )  # using a 1-tuple makes it do an undef
 708
 709     if HYBRID:
 710         defines.append( ('__NO_VC_CRTDBG__', None) )
 711
 712     if not FINAL or HYBRID:
 713         defines.append( ('__WXDEBUG__', None) )
 714
 715     libdirs = [ opj(WXDIR, 'lib', 'vc_dll') ]
 716     if MONOLITHIC:
 717         libs = makeLibName('')
 718     else:
 719         libs = [ 'wxbase' + WXDLLVER + libFlag(),
 720                  'wxbase' + WXDLLVER + libFlag() + '_net',
 721                  'wxbase' + WXDLLVER + libFlag() + '_xml',
 722                  makeLibName('core')[0],
 723                  makeLibName('adv')[0],
 724                  makeLibName('html')[0],
 725                  makeLibName('xrc')[0],
 726                  ]
 727
 728     libs = libs + ['kernel32', 'user32', 'gdi32', 'comdlg32',
 729             'winspool', 'winmm', 'shell32', 'oldnames', 'comctl32',
 730             'odbc32', 'ole32', 'oleaut32', 'uuid', 'rpcrt4',
 731             'advapi32', 'wsock32']
 732
 733
 734     cflags = [ '/Gy',
 735              # '/GX-'  # workaround for internal compiler error in MSVC on some machines
 736              ]
 737     lflags = None
 738
 739     # Other MSVC flags...
 740     # Too bad I don't remember why I was playing with these, can they be removed?
 741     if FINAL:
 742         pass #cflags = cflags + ['/O1']
 743     elif HYBRID :
 744         pass #cflags = cflags + ['/Ox']
 745     else:
 746         pass # cflags = cflags + ['/Od', '/Z7']
 747              # lflags = ['/DEBUG', ]
 748
 749
 750
 751 #----------------------------------------------------------------------
 752
 753 elif os.name == 'posix':
 754     WXDIR = '..'
 755     includes = ['include', 'src']
 756     defines = [('SWIG_TYPE_TABLE', WXPYTHON_TYPE_TABLE),
 757                ('HAVE_CONFIG_H', None),
 758                ('WXP_USE_THREAD', '1'),
 759                ]
 760     if UNDEF_NDEBUG:
 761         defines.append( ('NDEBUG',) )  # using a 1-tuple makes it do an undef
 762
 763     Verify_WX_CONFIG()
 764
 765     libdirs = []
 766     libs = []
 767
 768     # If you get unresolved symbol errors on Solaris and are using gcc, then
 769     # uncomment this block to add the right flags to the link step and build
 770     # again.
 771     ## if os.uname()[0] == 'SunOS':
 772     ##     import commands
 773     ##     libs.append('gcc')
 774     ##     libdirs.append(commands.getoutput("gcc -print-search-dirs | grep '^install' | awk '{print $2}'")[:-1])
 775
 776     cflags = os.popen(WX_CONFIG + ' --cxxflags', 'r').read()[:-1]
 777     cflags = cflags.split()
 778     if debug:
 779         cflags.append('-g')
 780         cflags.append('-O0')
 781     else:
 782         cflags.append('-O3')
 783
 784     lflags = os.popen(WX_CONFIG + ' --libs', 'r').read()[:-1]
 785     lflags = lflags.split()
 786
 787     WXBASENAME = os.popen(WX_CONFIG + ' --basename').read()[:-1]
 788     WXRELEASE  = os.popen(WX_CONFIG + ' --release').read()[:-1]
 789     WXPREFIX   = os.popen(WX_CONFIG + ' --prefix').read()[:-1]
 790
 791
 792     if sys.platform[:6] == "darwin" and WXPORT == 'mac':
 793         # Flags and such for a Darwin (Max OS X) build of Python
 794         WXPLAT = '__WXMAC__'
 795         GENDIR = 'mac'
 796         libs = ['stdc++']
 797         NO_SCRIPTS = 1
 798
 799
 800     else:
 801         # Set flags for other Unix type platforms
 802         GENDIR = WXPORT
 803
 804         if WXPORT == 'gtk':
 805             WXPLAT = '__WXGTK__'
 806             portcfg = os.popen('gtk-config --cflags', 'r').read()[:-1]
 807         elif WXPORT == 'gtk2':
 808             WXPLAT = '__WXGTK__'
 809             GENDIR = 'gtk' # no code differences so use the same generated sources
 810             portcfg = os.popen('pkg-config gtk+-2.0 --cflags', 'r').read()[:-1]
 811             BUILD_BASE = BUILD_BASE + '-' + WXPORT
 812         elif WXPORT == 'x11':
 813             WXPLAT = '__WXX11__'
 814             portcfg = ''
 815             BUILD_BASE = BUILD_BASE + '-' + WXPORT
 816         else:
 817             raise SystemExit, "Unknown WXPORT value: " + WXPORT
 818
 819         cflags += portcfg.split()
 820
 821         # Some distros (e.g. Mandrake) put libGLU in /usr/X11R6/lib, but
 822         # wx-config doesn't output that for some reason.  For now, just
 823         # add it unconditionally but we should really check if the lib is
 824         # really found there or wx-config should be fixed.
 825         libdirs.append("/usr/X11R6/lib")
 826
 827
 828     # Move the various -I, -D, etc. flags we got from the *config scripts
 829     # into the distutils lists.
 830     cflags = adjustCFLAGS(cflags, defines, includes)
 831     lflags = adjustLFLAGS(lflags, libdirs, libs)
 832
 833
 834 #----------------------------------------------------------------------
 835 else:
 836     raise 'Sorry, platform not supported...'
 837
 838
 839 #----------------------------------------------------------------------
 840 # post platform setup checks and tweaks, create the full version string
 841 #----------------------------------------------------------------------
 842
 843 if UNICODE:
 844     BUILD_BASE = BUILD_BASE + '.unicode'
 845     ##VER_FLAGS += 'u'
 846
 847 if os.path.exists('DAILY_BUILD'):
 848
 849     VER_FLAGS += '.' + open('DAILY_BUILD').read().strip()
 850
 851 VERSION = "%s.%s.%s.%s%s" % (VER_MAJOR, VER_MINOR, VER_RELEASE,
 852                              VER_SUBREL, VER_FLAGS)
 853
 854
 855 #----------------------------------------------------------------------
 856 # SWIG defaults
 857 #----------------------------------------------------------------------
 858
 859 # *.i files could live in the wxWidgets/wxPython/src dir, or in
 860 # a subdirectory of the devel package. Let's specify both
 861 # dirs as includes so we don't have to guess which is correct.
 862
 863 wxfilesdir = ""
 864 i_subdir = opj("include", getExtraPath(), "wx", "wxPython", "i_files")
 865 if os.name != "nt":
 866     wxfilesdir = opj(WXPREFIX, i_subdir)
 867 else:
 868     wxfilesdir = opj(WXPY_SRC, i_subdir)
 869
 870 i_files_includes = [ '-I' + opj(WXPY_SRC, 'src'),
 871                      '-I' + wxfilesdir ]
 872
 873 swig_cmd = SWIG
 874 swig_force = force
 875 swig_args = ['-c++',
 876              '-Wall',
 877              '-nodefault',
 878
 879              '-python',
 880              '-keyword',
 881              '-new_repr',
 882              '-modern',
 883              '-D'+WXPLAT,
 884              ] + i_files_includes
 885
 886 if UNICODE:
 887     swig_args.append('-DwxUSE_UNICODE')
 888
 889 if FULL_DOCS:
 890     swig_args.append('-D_DO_FULL_DOCS')
 891
 892
 893 swig_deps = [ opj(WXPY_SRC, 'src/my_typemaps.i'),
 894               opj(WXPY_SRC, 'src/pyfragments.swg'),
 895               ]
 896
 897 depends = [ #'include/wx/wxPython/wxPython.h',
 898             #'include/wx/wxPython/wxPython_int.h',
 899             #'src/pyclasses.h',
 900             ]
 901
 902 #----------------------------------------------------------------------
 903
 904 ####################################
 905 # BuildRenamers
 906 ####################################
 907
 908 import pprint, shutil
 909 try:
 910     import libxml2
 911     FOUND_LIBXML2 = True
 912 except ImportError:
 913     FOUND_LIBXML2 = False
 914
 915 #---------------------------------------------------------------------------
 916
 917 renamerTemplateStart = """\
 918 // A bunch of %rename directives generated by BuildRenamers in config.py
 919 // in order to remove the wx prefix from all global scope names.
 920
 921 #ifndef BUILDING_RENAMERS
 922
 923 """
 924
 925 renamerTemplateEnd = """
 926 #endif
 927 """
 928
 929 wxPythonTemplateStart = """\
 930 ## This file reverse renames symbols in the wx package to give
 931 ## them their wx prefix again, for backwards compatibility.
 932 ##
 933 ## Generated by BuildRenamers in config.py
 934
 935 # This silly stuff here is so the wxPython.wx module doesn't conflict
 936 # with the wx package.  We need to import modules from the wx package
 937 # here, then we'll put the wxPython.wx entry back in sys.modules.
 938 import sys
 939 _wx = None
 940 if sys.modules.has_key('wxPython.wx'):
 941     _wx = sys.modules['wxPython.wx']
 942     del sys.modules['wxPython.wx']
 943
 944 import wx.%s
 945
 946 sys.modules['wxPython.wx'] = _wx
 947 del sys, _wx
 948
 949
 950 # Now assign all the reverse-renamed names:
 951 """
 952
 953 wxPythonTemplateEnd = """
 954
 955 """
 956
 957
 958
 959 #---------------------------------------------------------------------------
 960 class BuildRenamers:
 961     def run(self, destdir, modname, xmlfile, wxPythonDir="wxPython"):
 962
 963         assert FOUND_LIBXML2, "The libxml2 module is required to use the BuildRenamers functionality."
 964
 965         if not os.path.exists(wxPythonDir):
 966             os.mkdir(wxPythonDir)
 967
 968         swigDest = os.path.join(destdir, "_"+modname+"_rename.i")
 969         pyDest = os.path.join(wxPythonDir, modname + '.py')
 970
 971         swigDestTemp = tempfile.mktemp('.tmp')
 972         swigFile = open(swigDestTemp, "w")
 973         swigFile.write(renamerTemplateStart)
 974
 975         pyDestTemp = tempfile.mktemp('.tmp')
 976         pyFile = open(pyDestTemp, "w")
 977         pyFile.write(wxPythonTemplateStart % modname)
 978
 979         print "Parsing XML and building renamers..."
 980         self.processXML(xmlfile, modname, swigFile, pyFile)
 981
 982         self.checkOtherNames(pyFile, modname,
 983                         os.path.join(destdir, '_'+modname+'_reverse.txt'))
 984         pyFile.write(wxPythonTemplateEnd)
 985         pyFile.close()
 986
 987         swigFile.write(renamerTemplateEnd)
 988         swigFile.close()
 989
 990         # Compare the files just created with the existing one and
 991         # blow away the old one if they are different.
 992         for dest, temp in [(swigDest, swigDestTemp),
 993                            (pyDest, pyDestTemp)]:
 994             # NOTE: we don't use shutil.move() because it was introduced
 995             # in Python 2.3. Eventually we can switch to it when people
 996             # stop building using 2.2.
 997             if not os.path.exists(dest):
 998                 shutil.copyfile(temp, dest)
 999             elif open(dest).read() != open(temp).read():
1000                 os.unlink(dest)
1001                 shutil.copyfile(temp, dest)
1002             else:
1003                 print dest + " not changed."
1004                 os.unlink(temp)
1005
1006     #---------------------------------------------------------------------------
1007
1008
1009     def GetAttr(self, node, name):
1010         path = "./attributelist/attribute[@name='%s']/@value" % name
1011         n = node.xpathEval2(path)
1012         if len(n):
1013             return n[0].content
1014         else:
1015             return None
1016
1017
1018     def processXML(self, xmlfile, modname, swigFile, pyFile):
1019
1020         topnode = libxml2.parseFile(xmlfile).children
1021
1022         # remove any import nodes as we don't need to do renamers for symbols found therein
1023         imports = topnode.xpathEval2("*/import")
1024         for n in imports:
1025             n.unlinkNode()
1026             n.freeNode()
1027
1028         # do a depth first iteration over what's left
1029         for node in topnode:
1030             doRename = False
1031             doPtr = False
1032             addWX = False
1033             revOnly = False
1034
1035
1036             if node.name == "class":
1037                 lastClassName = name = self.GetAttr(node, "name")
1038                 lastClassSymName = sym_name = self.GetAttr(node, "sym_name")
1039                 doRename = True
1040                 doPtr = True
1041                 if sym_name != name:
1042                     name = sym_name
1043                     addWX = True
1044
1045             # renamed constructors
1046             elif node.name == "constructor":
1047                 name     = self.GetAttr(node, "name")
1048                 sym_name = self.GetAttr(node, "sym_name")
1049                 if sym_name != name:
1050                     name = sym_name
1051                     addWX = True
1052                     doRename = True
1053
1054             # only enumitems at the top level
1055             elif node.name == "enumitem" and node.parent.parent.name == "include":
1056                 name     = self.GetAttr(node, "name")
1057                 sym_name = self.GetAttr(node, "sym_name")
1058                 doRename = True
1059
1060
1061             elif node.name in ["cdecl", "constant"]:
1062                 name      = self.GetAttr(node, "name")
1063                 sym_name  = self.GetAttr(node, "sym_name")
1064                 toplevel  = node.parent.name == "include"
1065
1066                 # top-level functions
1067                 if toplevel and self.GetAttr(node, "view") == "globalfunctionHandler":
1068                     doRename = True
1069
1070                 # top-level global vars
1071                 elif toplevel and self.GetAttr(node, "feature_immutable") == "1":
1072                     doRename = True
1073
1074                 # static methods
1075                 elif self.GetAttr(node, "view") == "staticmemberfunctionHandler":
1076                     name     = lastClassName + '_' + name
1077                     sym_name = lastClassSymName + '_' + sym_name
1078                     # only output the reverse renamer in this case
1079                     doRename = revOnly = True
1080
1081                 if doRename and name != sym_name:
1082                     name = sym_name
1083                     addWX = True
1084
1085
1086             if doRename and name:
1087                 old = new = name
1088                 if old.startswith('wx') and not old.startswith('wxEVT_'):
1089                     # remove all wx prefixes except wxEVT_ and write a %rename directive for it
1090                     new = old[2:]
1091                     if not revOnly:
1092                         swigFile.write("%%rename(%s)  %35s;\n" % (new, old))
1093
1094                 # Write assignments to import into the old wxPython namespace
1095                 if addWX and not old.startswith('wx'):
1096                     old = 'wx'+old
1097                 pyFile.write("%s = wx.%s.%s\n" % (old, modname, new))
1098                 if doPtr:
1099                     pyFile.write("%sPtr = wx.%s.%sPtr\n" % (old, modname, new))
1100
1101
1102     #---------------------------------------------------------------------------
1103
1104     def checkOtherNames(self, pyFile, moduleName, filename):
1105         if os.path.exists(filename):
1106             prefixes = []
1107             for line in file(filename):
1108                 if line.endswith('\n'):
1109                     line = line[:-1]
1110                 if line and not line.startswith('#'):
1111                     if line.endswith('*'):
1112                         prefixes.append(line[:-1])
1113                     elif line.find('=') != -1:
1114                         pyFile.write("%s\n" % line)
1115                     else:
1116                         wxname = 'wx' + line
1117                         if line.startswith('wx') or line.startswith('WX') or line.startswith('EVT'):
1118                             wxname = line
1119                         pyFile.write("%s = wx.%s.%s\n" % (wxname, moduleName, line))
1120
1121             if prefixes:
1122                 pyFile.write(
1123                     "\n\nd = globals()\nfor k, v in wx.%s.__dict__.iteritems():"
1124                     % moduleName)
1125                 first = True
1126                 for p in prefixes:
1127                     if first:
1128                         pyFile.write("\n    if ")
1129                         first = False
1130                     else:
1131                         pyFile.write("\n    elif ")
1132                     pyFile.write("k.startswith('%s'):\n        d[k] = v" % p)
1133                 pyFile.write("\ndel d, k, v\n\n")
1134
1135
1136 #---------------------------------------------------------------------------