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