From 5f8de423f190bbb79a62f804151bc24824fa32d8 Mon Sep 17 00:00:00 2001 From: "Matt A. Tobin" Date: Fri, 2 Feb 2018 04:16:08 -0500 Subject: Add m-esr52 at 52.6.0 --- python/macholib/MANIFEST.in | 8 + python/macholib/PKG-INFO | 275 ++++ python/macholib/README.txt | 8 + python/macholib/doc/MachO.rst | 19 + python/macholib/doc/MachoOGraph.rst | 14 + python/macholib/doc/MachoOStandalone.rst | 13 + python/macholib/doc/Makefile | 130 ++ python/macholib/doc/SymbolTable.rst | 24 + python/macholib/doc/_build/doctrees/MachO.doctree | Bin 0 -> 7229 bytes .../doc/_build/doctrees/MachoOGraph.doctree | Bin 0 -> 6109 bytes .../doc/_build/doctrees/MachoOStandalone.doctree | Bin 0 -> 7099 bytes .../doc/_build/doctrees/SymbolTable.doctree | Bin 0 -> 8138 bytes .../macholib/doc/_build/doctrees/changelog.doctree | Bin 0 -> 45133 bytes python/macholib/doc/_build/doctrees/dyld.doctree | Bin 0 -> 42349 bytes python/macholib/doc/_build/doctrees/dylib.doctree | Bin 0 -> 9129 bytes .../doc/_build/doctrees/environment.pickle | Bin 0 -> 1281784 bytes .../macholib/doc/_build/doctrees/framework.doctree | Bin 0 -> 9557 bytes python/macholib/doc/_build/doctrees/index.doctree | Bin 0 -> 11612 bytes .../macholib/doc/_build/doctrees/license.doctree | Bin 0 -> 4977 bytes .../macholib/doc/_build/doctrees/macho_o.doctree | Bin 0 -> 5186 bytes python/macholib/doc/_build/doctrees/ptypes.doctree | Bin 0 -> 44118 bytes .../macholib/doc/_build/doctrees/scripts.doctree | Bin 0 -> 5399 bytes python/macholib/doc/_build/html/.buildinfo | 4 + python/macholib/doc/_build/html/MachO.html | 132 ++ python/macholib/doc/_build/html/MachoOGraph.html | 125 ++ .../macholib/doc/_build/html/MachoOStandalone.html | 125 ++ python/macholib/doc/_build/html/SymbolTable.html | 136 ++ python/macholib/doc/_build/html/_sources/MachO.txt | 19 + .../doc/_build/html/_sources/MachoOGraph.txt | 14 + .../doc/_build/html/_sources/MachoOStandalone.txt | 13 + .../doc/_build/html/_sources/SymbolTable.txt | 24 + .../doc/_build/html/_sources/changelog.txt | 242 ++++ python/macholib/doc/_build/html/_sources/dyld.txt | 159 +++ python/macholib/doc/_build/html/_sources/dylib.txt | 33 + .../doc/_build/html/_sources/framework.txt | 34 + python/macholib/doc/_build/html/_sources/index.txt | 59 + .../macholib/doc/_build/html/_sources/license.txt | 23 + .../macholib/doc/_build/html/_sources/macho_o.txt | 13 + .../macholib/doc/_build/html/_sources/ptypes.txt | 157 +++ .../macholib/doc/_build/html/_sources/scripts.txt | 35 + .../doc/_build/html/_static/ajax-loader.gif | Bin 0 -> 673 bytes python/macholib/doc/_build/html/_static/basic.css | 537 ++++++++ .../doc/_build/html/_static/comment-bright.png | Bin 0 -> 3500 bytes .../doc/_build/html/_static/comment-close.png | Bin 0 -> 3578 bytes .../macholib/doc/_build/html/_static/comment.png | Bin 0 -> 3445 bytes .../macholib/doc/_build/html/_static/doctools.js | 238 ++++ .../doc/_build/html/_static/down-pressed.png | Bin 0 -> 368 bytes python/macholib/doc/_build/html/_static/down.png | Bin 0 -> 363 bytes python/macholib/doc/_build/html/_static/file.png | Bin 0 -> 392 bytes python/macholib/doc/_build/html/_static/jquery.js | 2 + python/macholib/doc/_build/html/_static/minus.png | Bin 0 -> 199 bytes python/macholib/doc/_build/html/_static/nature.css | 245 ++++ python/macholib/doc/_build/html/_static/plus.png | Bin 0 -> 199 bytes .../macholib/doc/_build/html/_static/pygments.css | 62 + .../doc/_build/html/_static/searchtools.js | 622 ++++++++++ .../macholib/doc/_build/html/_static/underscore.js | 31 + .../doc/_build/html/_static/up-pressed.png | Bin 0 -> 372 bytes python/macholib/doc/_build/html/_static/up.png | Bin 0 -> 363 bytes .../macholib/doc/_build/html/_static/websupport.js | 808 ++++++++++++ python/macholib/doc/_build/html/changelog.html | 385 ++++++ python/macholib/doc/_build/html/dyld.html | 267 ++++ python/macholib/doc/_build/html/dylib.html | 145 +++ python/macholib/doc/_build/html/framework.html | 147 +++ python/macholib/doc/_build/html/genindex.html | 365 ++++++ python/macholib/doc/_build/html/index.html | 170 +++ python/macholib/doc/_build/html/license.html | 140 +++ python/macholib/doc/_build/html/macho_o.html | 122 ++ python/macholib/doc/_build/html/objects.inv | Bin 0 -> 692 bytes python/macholib/doc/_build/html/ptypes.html | 317 +++++ python/macholib/doc/_build/html/py-modindex.html | 154 +++ python/macholib/doc/_build/html/scripts.html | 156 +++ python/macholib/doc/_build/html/search.html | 105 ++ python/macholib/doc/_build/html/searchindex.js | 1 + python/macholib/doc/changelog.rst | 242 ++++ python/macholib/doc/conf.py | 275 ++++ python/macholib/doc/dyld.rst | 159 +++ python/macholib/doc/dylib.rst | 33 + python/macholib/doc/framework.rst | 34 + python/macholib/doc/index.rst | 59 + python/macholib/doc/license.rst | 23 + python/macholib/doc/macho_o.rst | 13 + python/macholib/doc/ptypes.rst | 157 +++ python/macholib/doc/scripts.rst | 35 + python/macholib/macholib/MachO.py | 398 ++++++ python/macholib/macholib/MachOGraph.py | 131 ++ python/macholib/macholib/MachOStandalone.py | 147 +++ python/macholib/macholib/SymbolTable.py | 95 ++ python/macholib/macholib/__init__.py | 10 + python/macholib/macholib/__main__.py | 73 ++ python/macholib/macholib/_cmdline.py | 44 + python/macholib/macholib/dyld.py | 176 +++ python/macholib/macholib/dylib.py | 42 + python/macholib/macholib/framework.py | 42 + python/macholib/macholib/itergraphreport.py | 73 ++ python/macholib/macholib/mach_o.py | 1311 ++++++++++++++++++++ python/macholib/macholib/macho_dump.py | 48 + python/macholib/macholib/macho_find.py | 17 + python/macholib/macholib/macho_standalone.py | 26 + python/macholib/macholib/ptypes.py | 290 +++++ python/macholib/macholib/util.py | 245 ++++ python/macholib/macholib_tests/__init__.py | 1 + .../macholib/macholib_tests/binaries/src/build.py | 22 + python/macholib/macholib_tests/test_MachO.py | 15 + python/macholib/macholib_tests/test_MachOGraph.py | 15 + .../macholib_tests/test_MachOStandalone.py | 15 + python/macholib/macholib_tests/test_SymbolTable.py | 15 + .../macholib/macholib_tests/test_command_line.py | 147 +++ python/macholib/macholib_tests/test_dyld.py | 450 +++++++ python/macholib/macholib_tests/test_dylib.py | 38 + python/macholib/macholib_tests/test_framework.py | 88 ++ .../macholib_tests/test_itergraphreport.py | 15 + python/macholib/macholib_tests/test_mach_o.py | 21 + python/macholib/macholib_tests/test_ptypes.py | 191 +++ python/macholib/setup.cfg | 42 + python/macholib/setup.py | 867 +++++++++++++ 115 files changed, 12997 insertions(+) create mode 100644 python/macholib/MANIFEST.in create mode 100644 python/macholib/PKG-INFO create mode 100644 python/macholib/README.txt create mode 100644 python/macholib/doc/MachO.rst create mode 100644 python/macholib/doc/MachoOGraph.rst create mode 100644 python/macholib/doc/MachoOStandalone.rst create mode 100644 python/macholib/doc/Makefile create mode 100644 python/macholib/doc/SymbolTable.rst create mode 100644 python/macholib/doc/_build/doctrees/MachO.doctree create mode 100644 python/macholib/doc/_build/doctrees/MachoOGraph.doctree create mode 100644 python/macholib/doc/_build/doctrees/MachoOStandalone.doctree create mode 100644 python/macholib/doc/_build/doctrees/SymbolTable.doctree create mode 100644 python/macholib/doc/_build/doctrees/changelog.doctree create mode 100644 python/macholib/doc/_build/doctrees/dyld.doctree create mode 100644 python/macholib/doc/_build/doctrees/dylib.doctree create mode 100644 python/macholib/doc/_build/doctrees/environment.pickle create mode 100644 python/macholib/doc/_build/doctrees/framework.doctree create mode 100644 python/macholib/doc/_build/doctrees/index.doctree create mode 100644 python/macholib/doc/_build/doctrees/license.doctree create mode 100644 python/macholib/doc/_build/doctrees/macho_o.doctree create mode 100644 python/macholib/doc/_build/doctrees/ptypes.doctree create mode 100644 python/macholib/doc/_build/doctrees/scripts.doctree create mode 100644 python/macholib/doc/_build/html/.buildinfo create mode 100644 python/macholib/doc/_build/html/MachO.html create mode 100644 python/macholib/doc/_build/html/MachoOGraph.html create mode 100644 python/macholib/doc/_build/html/MachoOStandalone.html create mode 100644 python/macholib/doc/_build/html/SymbolTable.html create mode 100644 python/macholib/doc/_build/html/_sources/MachO.txt create mode 100644 python/macholib/doc/_build/html/_sources/MachoOGraph.txt create mode 100644 python/macholib/doc/_build/html/_sources/MachoOStandalone.txt create mode 100644 python/macholib/doc/_build/html/_sources/SymbolTable.txt create mode 100644 python/macholib/doc/_build/html/_sources/changelog.txt create mode 100644 python/macholib/doc/_build/html/_sources/dyld.txt create mode 100644 python/macholib/doc/_build/html/_sources/dylib.txt create mode 100644 python/macholib/doc/_build/html/_sources/framework.txt create mode 100644 python/macholib/doc/_build/html/_sources/index.txt create mode 100644 python/macholib/doc/_build/html/_sources/license.txt create mode 100644 python/macholib/doc/_build/html/_sources/macho_o.txt create mode 100644 python/macholib/doc/_build/html/_sources/ptypes.txt create mode 100644 python/macholib/doc/_build/html/_sources/scripts.txt create mode 100644 python/macholib/doc/_build/html/_static/ajax-loader.gif create mode 100644 python/macholib/doc/_build/html/_static/basic.css create mode 100644 python/macholib/doc/_build/html/_static/comment-bright.png create mode 100644 python/macholib/doc/_build/html/_static/comment-close.png create mode 100644 python/macholib/doc/_build/html/_static/comment.png create mode 100644 python/macholib/doc/_build/html/_static/doctools.js create mode 100644 python/macholib/doc/_build/html/_static/down-pressed.png create mode 100644 python/macholib/doc/_build/html/_static/down.png create mode 100644 python/macholib/doc/_build/html/_static/file.png create mode 100644 python/macholib/doc/_build/html/_static/jquery.js create mode 100644 python/macholib/doc/_build/html/_static/minus.png create mode 100644 python/macholib/doc/_build/html/_static/nature.css create mode 100644 python/macholib/doc/_build/html/_static/plus.png create mode 100644 python/macholib/doc/_build/html/_static/pygments.css create mode 100644 python/macholib/doc/_build/html/_static/searchtools.js create mode 100644 python/macholib/doc/_build/html/_static/underscore.js create mode 100644 python/macholib/doc/_build/html/_static/up-pressed.png create mode 100644 python/macholib/doc/_build/html/_static/up.png create mode 100644 python/macholib/doc/_build/html/_static/websupport.js create mode 100644 python/macholib/doc/_build/html/changelog.html create mode 100644 python/macholib/doc/_build/html/dyld.html create mode 100644 python/macholib/doc/_build/html/dylib.html create mode 100644 python/macholib/doc/_build/html/framework.html create mode 100644 python/macholib/doc/_build/html/genindex.html create mode 100644 python/macholib/doc/_build/html/index.html create mode 100644 python/macholib/doc/_build/html/license.html create mode 100644 python/macholib/doc/_build/html/macho_o.html create mode 100644 python/macholib/doc/_build/html/objects.inv create mode 100644 python/macholib/doc/_build/html/ptypes.html create mode 100644 python/macholib/doc/_build/html/py-modindex.html create mode 100644 python/macholib/doc/_build/html/scripts.html create mode 100644 python/macholib/doc/_build/html/search.html create mode 100644 python/macholib/doc/_build/html/searchindex.js create mode 100644 python/macholib/doc/changelog.rst create mode 100644 python/macholib/doc/conf.py create mode 100644 python/macholib/doc/dyld.rst create mode 100644 python/macholib/doc/dylib.rst create mode 100644 python/macholib/doc/framework.rst create mode 100644 python/macholib/doc/index.rst create mode 100644 python/macholib/doc/license.rst create mode 100644 python/macholib/doc/macho_o.rst create mode 100644 python/macholib/doc/ptypes.rst create mode 100644 python/macholib/doc/scripts.rst create mode 100644 python/macholib/macholib/MachO.py create mode 100644 python/macholib/macholib/MachOGraph.py create mode 100644 python/macholib/macholib/MachOStandalone.py create mode 100644 python/macholib/macholib/SymbolTable.py create mode 100644 python/macholib/macholib/__init__.py create mode 100644 python/macholib/macholib/__main__.py create mode 100644 python/macholib/macholib/_cmdline.py create mode 100644 python/macholib/macholib/dyld.py create mode 100644 python/macholib/macholib/dylib.py create mode 100644 python/macholib/macholib/framework.py create mode 100644 python/macholib/macholib/itergraphreport.py create mode 100644 python/macholib/macholib/mach_o.py create mode 100644 python/macholib/macholib/macho_dump.py create mode 100644 python/macholib/macholib/macho_find.py create mode 100644 python/macholib/macholib/macho_standalone.py create mode 100644 python/macholib/macholib/ptypes.py create mode 100644 python/macholib/macholib/util.py create mode 100644 python/macholib/macholib_tests/__init__.py create mode 100644 python/macholib/macholib_tests/binaries/src/build.py create mode 100644 python/macholib/macholib_tests/test_MachO.py create mode 100644 python/macholib/macholib_tests/test_MachOGraph.py create mode 100644 python/macholib/macholib_tests/test_MachOStandalone.py create mode 100644 python/macholib/macholib_tests/test_SymbolTable.py create mode 100644 python/macholib/macholib_tests/test_command_line.py create mode 100644 python/macholib/macholib_tests/test_dyld.py create mode 100644 python/macholib/macholib_tests/test_dylib.py create mode 100644 python/macholib/macholib_tests/test_framework.py create mode 100644 python/macholib/macholib_tests/test_itergraphreport.py create mode 100644 python/macholib/macholib_tests/test_mach_o.py create mode 100644 python/macholib/macholib_tests/test_ptypes.py create mode 100644 python/macholib/setup.cfg create mode 100644 python/macholib/setup.py (limited to 'python/macholib') diff --git a/python/macholib/MANIFEST.in b/python/macholib/MANIFEST.in new file mode 100644 index 000000000..f39832106 --- /dev/null +++ b/python/macholib/MANIFEST.in @@ -0,0 +1,8 @@ +include *.txt MANIFEST.in *.py +graft doc +graft doc/_static +graft doc/_templates +graft macholib_tests +global-exclude .DS_Store +global-exclude *.pyc +global-exclude *.so diff --git a/python/macholib/PKG-INFO b/python/macholib/PKG-INFO new file mode 100644 index 000000000..33408d200 --- /dev/null +++ b/python/macholib/PKG-INFO @@ -0,0 +1,275 @@ +Metadata-Version: 1.1 +Name: macholib +Version: 1.7 +Summary: Mach-O header analysis and editing +Home-page: http://bitbucket.org/ronaldoussoren/macholib +Author: Ronald Oussoren +Author-email: ronaldoussoren@mac.com +License: MIT +Download-URL: http://pypi.python.org/pypi/macholib +Description: macholib can be used to analyze and edit Mach-O headers, the executable + format used by Mac OS X. + + It's typically used as a dependency analysis tool, and also to rewrite dylib + references in Mach-O headers to be @executable_path relative. + + Though this tool targets a platform specific file format, it is pure python + code that is platform and endian independent. + + + Release history + =============== + + macholib 1.7 + ------------ + + * Added support for ARM64, LC_ENCRYPTION_INFO_64 and LC_LINKER_OPTION + + Patch by Matthias Ringwald. + + * Load commands now have a "describe" method that returns more information + about the command. + + Patch by David Dorsey. + + * The MAGIC value in the header was always represented in the native + byte order, instead of as the value read from the binary. + + Patch by David Dorsey. + + * Added various new constants to "macholib.mach_o". + + Patch by David Dorsey. + + macholib 1.6.1 + -------------- + + * ? + + macholib 1.6 + ------------ + + * Add support for '@loader_path' link command in + macholib.dyld: + + - Added function ``macholib.dyld.dyld_loader_search`` + + - This function is used by ``macholib.dyld.dyld_find``, + and that function now has an new (optional) argument + with the path to the loader. + + * Also add support for '@loader_path' to macholib.MachoGraph, + using the newly added '@loader_path' support in the + dyld module. + + Due to this suppport the *macho_standalone* tool can + now rewrite binaries that contain an '@loader_path' load + command. + + + macholib 1.5.2 + -------------- + + * Issue #93: Show the name of the affected file in the exception message + for Mach-O headers that are too large to relocate. + + + macholib 1.5.1 + -------------- + + * There were no 'classifiers' in the package metadata due to + a bug in setup.py. + + macholib 1.5 + -------------- + + macholib 1.5 is a minor feature release + + * No longer use 2to3 to provide Python 3 support + + As a side-effect of this macholib no longer supports + Python 2.5 and earlier. + + * Adds suppport for some new macho load commands + + * Fix for py3k problem in macho_standalone.py + + Patch by Guanqun Lu. + + * Fix for some issues in macho_dump.py + + Patch by Nam Nguyen + + * Issue #10: Fix for LC_DATA_IN_CODE linker commands, without + this fix py2app cannot build application bundles when + the source binaries have been compiled with Xcode 4.5. + + * Issue #6: Fix for LC_ENCRYPTION_INFO linker commands + + * Use the mach header information to print the cpu type of a + binary, instead of trying to deduce that from pointer width + and endianness. + + Changed the code because of issue #6, in which a user tries to + dump a iOS binary which results in bogus output in the previous + releases. + + * The mapping ``macholib.macho_dump.ARCH_MAP`` is undocumented + and no longer used by macholib itself. It will be removed + in the next release. + + + * The command-line tools ``macho_find``, ``macho_dump`` and + ``macho_standalone`` are deprecated. Use "python -mmacholib" + instead. That is:: + + $ python -mmacholib dump /usr/bin/grep + + $ python -mmacholib find ~ + + $ python -mmacholib standalone myapp.app + + This makes it clearer which version of the tools are used. + + macholib 1.4.3 + -------------- + + macholib 1.4.3 is a minor feature release + + * Added strings for 'x86_64' and 'ppc64' to + macholib.mach_o.CPU_TYPE_NAMES. + + * macho_find and macho_dump were broken in the 1.4.2 release + + * added 'macholib.util.NOT_SYSTEM_FILES', a list of + files that aren't system path's even though they are + located in system locations. + + Needed to work around a bug in PySide (see issue #32 in the + py2app tracker) + + + + macholib 1.4.2 + -------------- + + macholib 1.4.2 is a minor bugfix release + + * The support for new load commands that was added in 1.4.1 + contained a typo that caused problems on OSX 10.7 (Lion). + + macholib 1.4.1 + -------------- + + macholib 1.4.1 is a minor feature release + + Features: + + - Add support for a number of new MachO load commands that were added + during the lifetime of OSX 10.6: ``LC_LOAD_UPWARD_DYLIB``, + ``LC_VERSION_MIN_MACOSX``, ``LC_VERSION_MIN_IPHONEOS`` and + ``LC_FUNCTION_STARTS``. + + macholib 1.4 + ------------- + + macholib 1.4 is a feature release + + Features: + + - Documentation is now generated using `sphinx `_ + and can be viewed at . + + - The repository has moved to bitbucket + + - There now is a testsuite + + - Private functionality inside modules was renamed to + a name starting with an underscore. + + .. note:: if this change affects your code you are relying on undefined + implementation features, please stop using private functions. + + - The basic packable types in ``macholib.ptypes`` were renamed to better + represent the corresponding C type. The table below lists the old + an new names (the old names are still available, but are deprecated and + will be removed in a future release). + + +--------------+--------------+ + | **Old name** | **New name** | + +==============+==============+ + | p_byte | p_int8 | + +--------------+--------------+ + | p_ubyte | p_uint8 | + +--------------+--------------+ + | p_short | p_int16 | + +--------------+--------------+ + | p_ushort | p_uint16 | + +--------------+--------------+ + | p_int | p_int32 | + +--------------+--------------+ + | p_uint | p_uint32 | + +--------------+--------------+ + | p_long | p_int32 | + +--------------+--------------+ + | p_ulong | p_uint32 | + +--------------+--------------+ + | p_longlong | p_int64 | + +--------------+--------------+ + | p_ulonglong | p_uint64 | + +--------------+--------------+ + + ``Macholib.ptypes.p_ptr`` is no longer present as it had an unclear + definition and isn't actually used in the codebase. + + + Bug fixes: + + - The semantics of ``dyld.dyld_default_search`` were changed a bit, + it now first searches the framework path (if appropriate) and then + the linker path, irrespective of the value of the ``DYLD_FALLBACK*`` + environment variables. + + Previous versions would change the search order when those variables + was set, which is odd and doesn't correspond with the documented + behaviour of the system dyld. + + - It is once again possible to install using python2.5 + + - The source distribution includes all files, this was broken + due to the switch to mercurial (which confused setuptools) + + macholib 1.3 + ------------ + + macholib 1.3 is a feature release. + + Features: + + - Experimental Python 3.x support + + This version contains lightly tested support for Python 3. + + macholib 1.2.2 + -------------- + + macholib 1.2.2 is a bugfix release. + + Bug fixes: + + - Macholib should work better with 64-bit code + (patch by Marc-Antoine Parent) + +Keywords: Mach-O,,dyld +Platform: any +Classifier: Intended Audience :: Developers +Classifier: License :: OSI Approved :: MIT License +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 2 +Classifier: Programming Language :: Python :: 2.7 +Classifier: Programming Language :: Python :: 3 +Classifier: Programming Language :: Python :: 3.3 +Classifier: Programming Language :: Python :: 3.4 +Classifier: Operating System :: MacOS :: MacOS X +Classifier: Topic :: Software Development :: Libraries :: Python Modules +Classifier: Topic :: Software Development :: Build Tools diff --git a/python/macholib/README.txt b/python/macholib/README.txt new file mode 100644 index 000000000..62dbdb709 --- /dev/null +++ b/python/macholib/README.txt @@ -0,0 +1,8 @@ +macholib can be used to analyze and edit Mach-O headers, the executable +format used by Mac OS X. + +It's typically used as a dependency analysis tool, and also to rewrite dylib +references in Mach-O headers to be @executable_path relative. + +Though this tool targets a platform specific file format, it is pure python +code that is platform and endian independent. diff --git a/python/macholib/doc/MachO.rst b/python/macholib/doc/MachO.rst new file mode 100644 index 000000000..204e04087 --- /dev/null +++ b/python/macholib/doc/MachO.rst @@ -0,0 +1,19 @@ +:mod:`macholib.MachO` --- Utilities for reading and writing Mach-O headers +========================================================================== + +.. module:: macholib.MachO + :synopsis: Utilities for reading and writing Mach-O headers + +This module defines a class :class:`Macho`, which enables reading +and writing the Mach-O header of an executable file or dynamic +library on MacOS X. + +.. class:: MachO(filename) + + Creates a MachO object by reading the Mach-O headers from + *filename*. + + The *filename* should refer to an existing file in Mach-O + format, and can refer to fat (universal) binaries. + +.. note:: more information will be added later diff --git a/python/macholib/doc/MachoOGraph.rst b/python/macholib/doc/MachoOGraph.rst new file mode 100644 index 000000000..256a4137f --- /dev/null +++ b/python/macholib/doc/MachoOGraph.rst @@ -0,0 +1,14 @@ +:mod:`macholib.MachoGraph` --- Graph data structure of Mach-O dependencies +=============================================================================== + +.. module:: macholib.MachOGraph + :synopsis: Graph data structure of Mach-O dependencies + +This module defines the class :class:`MachOGraph` which represents the +direct and indirect dependencies of one or more Mach-O files on +other (library) files. + +.. class:: MachOGraph(...) + + To be discussed. + diff --git a/python/macholib/doc/MachoOStandalone.rst b/python/macholib/doc/MachoOStandalone.rst new file mode 100644 index 000000000..d1a8052f6 --- /dev/null +++ b/python/macholib/doc/MachoOStandalone.rst @@ -0,0 +1,13 @@ +:mod:`macholib.MachOStandalone` --- Create standalone application bundles +========================================================================== + +.. module:: macholib.MachOStandalone + :synopsis: Create standalone application bundles + +This module defines class :class:`MachOStandalone` which locates +all Mach-O files in a directory (assumed to be the root of an +application or plugin bundle) and then copies all non-system +dependencies for the located files into the bundle. + +.. class:: MachOStandalone(base[, dest[, graph[, env[, executable_path]]]]) + diff --git a/python/macholib/doc/Makefile b/python/macholib/doc/Makefile new file mode 100644 index 000000000..cca691360 --- /dev/null +++ b/python/macholib/doc/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/macholib.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/macholib.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/macholib" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/macholib" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/python/macholib/doc/SymbolTable.rst b/python/macholib/doc/SymbolTable.rst new file mode 100644 index 000000000..5417e315c --- /dev/null +++ b/python/macholib/doc/SymbolTable.rst @@ -0,0 +1,24 @@ +:mod:`macholib.SymbolTable` --- Class to read the symbol table from a Mach-O header +=================================================================================== + +.. module:: macholib.SymbolTable + :synopsis: Class to read the symbol table from a Mach-O header + +This module is deprecated because it is not by the author +and likely contains bugs. It also does not work for 64-bit binaries. + +.. class:: SymbolTable(macho[, openfile]) + + Reads the SymbolTable for the given Mach-O object. + + The option argument *openfile* specifies the + function to use to open the file, defaulting to + the builtin :func:`open` function. + + .. warning:: As far as we know this class is not used + by any user of the modulegraph package, and the code + has not been updated after the initial implementation. + + The end result of this is that the code does not + support 64-bit code at all and likely doesn't work + properly for 32-bit code as well. diff --git a/python/macholib/doc/_build/doctrees/MachO.doctree b/python/macholib/doc/_build/doctrees/MachO.doctree new file mode 100644 index 000000000..0aed18b42 Binary files /dev/null and b/python/macholib/doc/_build/doctrees/MachO.doctree differ diff --git a/python/macholib/doc/_build/doctrees/MachoOGraph.doctree b/python/macholib/doc/_build/doctrees/MachoOGraph.doctree new file mode 100644 index 000000000..7ed639427 Binary files /dev/null and b/python/macholib/doc/_build/doctrees/MachoOGraph.doctree differ diff --git a/python/macholib/doc/_build/doctrees/MachoOStandalone.doctree b/python/macholib/doc/_build/doctrees/MachoOStandalone.doctree new file mode 100644 index 000000000..f19f00e8e Binary files /dev/null and b/python/macholib/doc/_build/doctrees/MachoOStandalone.doctree differ diff --git a/python/macholib/doc/_build/doctrees/SymbolTable.doctree b/python/macholib/doc/_build/doctrees/SymbolTable.doctree new file mode 100644 index 000000000..0ff1c997c Binary files /dev/null and b/python/macholib/doc/_build/doctrees/SymbolTable.doctree differ diff --git a/python/macholib/doc/_build/doctrees/changelog.doctree b/python/macholib/doc/_build/doctrees/changelog.doctree new file mode 100644 index 000000000..ffb3f138a Binary files /dev/null and b/python/macholib/doc/_build/doctrees/changelog.doctree differ diff --git a/python/macholib/doc/_build/doctrees/dyld.doctree b/python/macholib/doc/_build/doctrees/dyld.doctree new file mode 100644 index 000000000..1692b9834 Binary files /dev/null and b/python/macholib/doc/_build/doctrees/dyld.doctree differ diff --git a/python/macholib/doc/_build/doctrees/dylib.doctree b/python/macholib/doc/_build/doctrees/dylib.doctree new file mode 100644 index 000000000..0c501fc6b Binary files /dev/null and b/python/macholib/doc/_build/doctrees/dylib.doctree differ diff --git a/python/macholib/doc/_build/doctrees/environment.pickle b/python/macholib/doc/_build/doctrees/environment.pickle new file mode 100644 index 000000000..126177dfd Binary files /dev/null and b/python/macholib/doc/_build/doctrees/environment.pickle differ diff --git a/python/macholib/doc/_build/doctrees/framework.doctree b/python/macholib/doc/_build/doctrees/framework.doctree new file mode 100644 index 000000000..9db55ed0c Binary files /dev/null and b/python/macholib/doc/_build/doctrees/framework.doctree differ diff --git a/python/macholib/doc/_build/doctrees/index.doctree b/python/macholib/doc/_build/doctrees/index.doctree new file mode 100644 index 000000000..db4b86e65 Binary files /dev/null and b/python/macholib/doc/_build/doctrees/index.doctree differ diff --git a/python/macholib/doc/_build/doctrees/license.doctree b/python/macholib/doc/_build/doctrees/license.doctree new file mode 100644 index 000000000..231522cfc Binary files /dev/null and b/python/macholib/doc/_build/doctrees/license.doctree differ diff --git a/python/macholib/doc/_build/doctrees/macho_o.doctree b/python/macholib/doc/_build/doctrees/macho_o.doctree new file mode 100644 index 000000000..2e4a8aa2c Binary files /dev/null and b/python/macholib/doc/_build/doctrees/macho_o.doctree differ diff --git a/python/macholib/doc/_build/doctrees/ptypes.doctree b/python/macholib/doc/_build/doctrees/ptypes.doctree new file mode 100644 index 000000000..53b528782 Binary files /dev/null and b/python/macholib/doc/_build/doctrees/ptypes.doctree differ diff --git a/python/macholib/doc/_build/doctrees/scripts.doctree b/python/macholib/doc/_build/doctrees/scripts.doctree new file mode 100644 index 000000000..6c9413c02 Binary files /dev/null and b/python/macholib/doc/_build/doctrees/scripts.doctree differ diff --git a/python/macholib/doc/_build/html/.buildinfo b/python/macholib/doc/_build/html/.buildinfo new file mode 100644 index 000000000..97c8fd2fd --- /dev/null +++ b/python/macholib/doc/_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: b80b1cc6a748fe1205999d2fef6726e1 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/python/macholib/doc/_build/html/MachO.html b/python/macholib/doc/_build/html/MachO.html new file mode 100644 index 000000000..61c8bf3a6 --- /dev/null +++ b/python/macholib/doc/_build/html/MachO.html @@ -0,0 +1,132 @@ + + + + + + + + macholib.MachO — Utilities for reading and writing Mach-O headers — macholib 1.7 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +
+

macholib.MachO — Utilities for reading and writing Mach-O headers

+

This module defines a class Macho, which enables reading +and writing the Mach-O header of an executable file or dynamic +library on MacOS X.

+
+
+class macholib.MachO.MachO(filename)
+

Creates a MachO object by reading the Mach-O headers from +filename.

+

The filename should refer to an existing file in Mach-O +format, and can refer to fat (universal) binaries.

+
+ +
+

Note

+

more information will be added later

+
+
+ + +
+
+
+
+
+

Previous topic

+

Command-line tools

+

Next topic

+

macholib.MachoGraph — Graph data structure of Mach-O dependencies

+

This Page

+ + + +
+
+
+
+ + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/MachoOGraph.html b/python/macholib/doc/_build/html/MachoOGraph.html new file mode 100644 index 000000000..aeba004d3 --- /dev/null +++ b/python/macholib/doc/_build/html/MachoOGraph.html @@ -0,0 +1,125 @@ + + + + + + + + macholib.MachoGraph — Graph data structure of Mach-O dependencies — macholib 1.7 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +
+

macholib.MachoGraph — Graph data structure of Mach-O dependencies

+

This module defines the class MachOGraph which represents the +direct and indirect dependencies of one or more Mach-O files on +other (library) files.

+
+
+class macholib.MachOGraph.MachOGraph(...)
+

To be discussed.

+
+ +
+ + +
+
+
+
+
+

Previous topic

+

macholib.MachO — Utilities for reading and writing Mach-O headers

+

Next topic

+

macholib.MachOStandalone — Create standalone application bundles

+

This Page

+ + + +
+
+
+
+ + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/MachoOStandalone.html b/python/macholib/doc/_build/html/MachoOStandalone.html new file mode 100644 index 000000000..4b94201b6 --- /dev/null +++ b/python/macholib/doc/_build/html/MachoOStandalone.html @@ -0,0 +1,125 @@ + + + + + + + + macholib.MachOStandalone — Create standalone application bundles — macholib 1.7 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +
+

macholib.MachOStandalone — Create standalone application bundles

+

This module defines class MachOStandalone which locates +all Mach-O files in a directory (assumed to be the root of an +application or plugin bundle) and then copies all non-system +dependencies for the located files into the bundle.

+
+
+class macholib.MachOStandalone.MachOStandalone(base[, dest[, graph[, env[, executable_path]]]])
+
+ +
+ + +
+
+
+
+
+

Previous topic

+

macholib.MachoGraph — Graph data structure of Mach-O dependencies

+

Next topic

+

macholib.SymbolTable — Class to read the symbol table from a Mach-O header

+

This Page

+ + + +
+
+
+
+ + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/SymbolTable.html b/python/macholib/doc/_build/html/SymbolTable.html new file mode 100644 index 000000000..f6847d612 --- /dev/null +++ b/python/macholib/doc/_build/html/SymbolTable.html @@ -0,0 +1,136 @@ + + + + + + + + macholib.SymbolTable — Class to read the symbol table from a Mach-O header — macholib 1.7 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +
+

macholib.SymbolTable — Class to read the symbol table from a Mach-O header

+

This module is deprecated because it is not by the author +and likely contains bugs. It also does not work for 64-bit binaries.

+
+
+class macholib.SymbolTable.SymbolTable(macho[, openfile])
+

Reads the SymbolTable for the given Mach-O object.

+

The option argument openfile specifies the +function to use to open the file, defaulting to +the builtin open() function.

+
+

Warning

+

As far as we know this class is not used +by any user of the modulegraph package, and the code +has not been updated after the initial implementation.

+

The end result of this is that the code does not +support 64-bit code at all and likely doesn’t work +properly for 32-bit code as well.

+
+
+ +
+ + +
+
+
+
+
+

Previous topic

+

macholib.MachOStandalone — Create standalone application bundles

+

Next topic

+

macholib.dyld — Dyld emulation

+

This Page

+ + + +
+
+
+
+ + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/_sources/MachO.txt b/python/macholib/doc/_build/html/_sources/MachO.txt new file mode 100644 index 000000000..204e04087 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/MachO.txt @@ -0,0 +1,19 @@ +:mod:`macholib.MachO` --- Utilities for reading and writing Mach-O headers +========================================================================== + +.. module:: macholib.MachO + :synopsis: Utilities for reading and writing Mach-O headers + +This module defines a class :class:`Macho`, which enables reading +and writing the Mach-O header of an executable file or dynamic +library on MacOS X. + +.. class:: MachO(filename) + + Creates a MachO object by reading the Mach-O headers from + *filename*. + + The *filename* should refer to an existing file in Mach-O + format, and can refer to fat (universal) binaries. + +.. note:: more information will be added later diff --git a/python/macholib/doc/_build/html/_sources/MachoOGraph.txt b/python/macholib/doc/_build/html/_sources/MachoOGraph.txt new file mode 100644 index 000000000..256a4137f --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/MachoOGraph.txt @@ -0,0 +1,14 @@ +:mod:`macholib.MachoGraph` --- Graph data structure of Mach-O dependencies +=============================================================================== + +.. module:: macholib.MachOGraph + :synopsis: Graph data structure of Mach-O dependencies + +This module defines the class :class:`MachOGraph` which represents the +direct and indirect dependencies of one or more Mach-O files on +other (library) files. + +.. class:: MachOGraph(...) + + To be discussed. + diff --git a/python/macholib/doc/_build/html/_sources/MachoOStandalone.txt b/python/macholib/doc/_build/html/_sources/MachoOStandalone.txt new file mode 100644 index 000000000..d1a8052f6 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/MachoOStandalone.txt @@ -0,0 +1,13 @@ +:mod:`macholib.MachOStandalone` --- Create standalone application bundles +========================================================================== + +.. module:: macholib.MachOStandalone + :synopsis: Create standalone application bundles + +This module defines class :class:`MachOStandalone` which locates +all Mach-O files in a directory (assumed to be the root of an +application or plugin bundle) and then copies all non-system +dependencies for the located files into the bundle. + +.. class:: MachOStandalone(base[, dest[, graph[, env[, executable_path]]]]) + diff --git a/python/macholib/doc/_build/html/_sources/SymbolTable.txt b/python/macholib/doc/_build/html/_sources/SymbolTable.txt new file mode 100644 index 000000000..5417e315c --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/SymbolTable.txt @@ -0,0 +1,24 @@ +:mod:`macholib.SymbolTable` --- Class to read the symbol table from a Mach-O header +=================================================================================== + +.. module:: macholib.SymbolTable + :synopsis: Class to read the symbol table from a Mach-O header + +This module is deprecated because it is not by the author +and likely contains bugs. It also does not work for 64-bit binaries. + +.. class:: SymbolTable(macho[, openfile]) + + Reads the SymbolTable for the given Mach-O object. + + The option argument *openfile* specifies the + function to use to open the file, defaulting to + the builtin :func:`open` function. + + .. warning:: As far as we know this class is not used + by any user of the modulegraph package, and the code + has not been updated after the initial implementation. + + The end result of this is that the code does not + support 64-bit code at all and likely doesn't work + properly for 32-bit code as well. diff --git a/python/macholib/doc/_build/html/_sources/changelog.txt b/python/macholib/doc/_build/html/_sources/changelog.txt new file mode 100644 index 000000000..d73299f91 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/changelog.txt @@ -0,0 +1,242 @@ +Release history +=============== + +macholib 1.7 +------------ + +* Added support for ARM64, LC_ENCRYPTION_INFO_64 and LC_LINKER_OPTION + + Patch by Matthias Ringwald. + +* Load commands now have a "describe" method that returns more information + about the command. + + Patch by David Dorsey. + +* The MAGIC value in the header was always represented in the native + byte order, instead of as the value read from the binary. + + Patch by David Dorsey. + +* Added various new constants to "macholib.mach_o". + + Patch by David Dorsey. + +macholib 1.6.1 +-------------- + +* ? + +macholib 1.6 +------------ + +* Add support for '@loader_path' link command in + macholib.dyld: + + - Added function ``macholib.dyld.dyld_loader_search`` + + - This function is used by ``macholib.dyld.dyld_find``, + and that function now has an new (optional) argument + with the path to the loader. + +* Also add support for '@loader_path' to macholib.MachoGraph, + using the newly added '@loader_path' support in the + dyld module. + + Due to this suppport the *macho_standalone* tool can + now rewrite binaries that contain an '@loader_path' load + command. + + +macholib 1.5.2 +-------------- + +* Issue #93: Show the name of the affected file in the exception message + for Mach-O headers that are too large to relocate. + + +macholib 1.5.1 +-------------- + +* There were no 'classifiers' in the package metadata due to + a bug in setup.py. + +macholib 1.5 +-------------- + +macholib 1.5 is a minor feature release + +* No longer use 2to3 to provide Python 3 support + + As a side-effect of this macholib no longer supports + Python 2.5 and earlier. + +* Adds suppport for some new macho load commands + +* Fix for py3k problem in macho_standalone.py + + Patch by Guanqun Lu. + +* Fix for some issues in macho_dump.py + + Patch by Nam Nguyen + +* Issue #10: Fix for LC_DATA_IN_CODE linker commands, without + this fix py2app cannot build application bundles when + the source binaries have been compiled with Xcode 4.5. + +* Issue #6: Fix for LC_ENCRYPTION_INFO linker commands + +* Use the mach header information to print the cpu type of a + binary, instead of trying to deduce that from pointer width + and endianness. + + Changed the code because of issue #6, in which a user tries to + dump a iOS binary which results in bogus output in the previous + releases. + +* The mapping ``macholib.macho_dump.ARCH_MAP`` is undocumented + and no longer used by macholib itself. It will be removed + in the next release. + + +* The command-line tools ``macho_find``, ``macho_dump`` and + ``macho_standalone`` are deprecated. Use "python -mmacholib" + instead. That is:: + + $ python -mmacholib dump /usr/bin/grep + + $ python -mmacholib find ~ + + $ python -mmacholib standalone myapp.app + + This makes it clearer which version of the tools are used. + +macholib 1.4.3 +-------------- + +macholib 1.4.3 is a minor feature release + +* Added strings for 'x86_64' and 'ppc64' to + macholib.mach_o.CPU_TYPE_NAMES. + +* macho_find and macho_dump were broken in the 1.4.2 release + +* added 'macholib.util.NOT_SYSTEM_FILES', a list of + files that aren't system path's even though they are + located in system locations. + + Needed to work around a bug in PySide (see issue #32 in the + py2app tracker) + + + +macholib 1.4.2 +-------------- + +macholib 1.4.2 is a minor bugfix release + +* The support for new load commands that was added in 1.4.1 + contained a typo that caused problems on OSX 10.7 (Lion). + +macholib 1.4.1 +-------------- + +macholib 1.4.1 is a minor feature release + +Features: + +- Add support for a number of new MachO load commands that were added + during the lifetime of OSX 10.6: ``LC_LOAD_UPWARD_DYLIB``, + ``LC_VERSION_MIN_MACOSX``, ``LC_VERSION_MIN_IPHONEOS`` and + ``LC_FUNCTION_STARTS``. + +macholib 1.4 +------------- + +macholib 1.4 is a feature release + +Features: + +- Documentation is now generated using `sphinx `_ + and can be viewed at . + +- The repository has moved to bitbucket + +- There now is a testsuite + +- Private functionality inside modules was renamed to + a name starting with an underscore. + + .. note:: if this change affects your code you are relying on undefined + implementation features, please stop using private functions. + +- The basic packable types in ``macholib.ptypes`` were renamed to better + represent the corresponding C type. The table below lists the old + an new names (the old names are still available, but are deprecated and + will be removed in a future release). + + +--------------+--------------+ + | **Old name** | **New name** | + +==============+==============+ + | p_byte | p_int8 | + +--------------+--------------+ + | p_ubyte | p_uint8 | + +--------------+--------------+ + | p_short | p_int16 | + +--------------+--------------+ + | p_ushort | p_uint16 | + +--------------+--------------+ + | p_int | p_int32 | + +--------------+--------------+ + | p_uint | p_uint32 | + +--------------+--------------+ + | p_long | p_int32 | + +--------------+--------------+ + | p_ulong | p_uint32 | + +--------------+--------------+ + | p_longlong | p_int64 | + +--------------+--------------+ + | p_ulonglong | p_uint64 | + +--------------+--------------+ + + ``Macholib.ptypes.p_ptr`` is no longer present as it had an unclear + definition and isn't actually used in the codebase. + + +Bug fixes: + +- The semantics of ``dyld.dyld_default_search`` were changed a bit, + it now first searches the framework path (if appropriate) and then + the linker path, irrespective of the value of the ``DYLD_FALLBACK*`` + environment variables. + + Previous versions would change the search order when those variables + was set, which is odd and doesn't correspond with the documented + behaviour of the system dyld. + +- It is once again possible to install using python2.5 + +- The source distribution includes all files, this was broken + due to the switch to mercurial (which confused setuptools) + +macholib 1.3 +------------ + +macholib 1.3 is a feature release. + +Features: + +- Experimental Python 3.x support + + This version contains lightly tested support for Python 3. + +macholib 1.2.2 +-------------- + +macholib 1.2.2 is a bugfix release. + +Bug fixes: + +- Macholib should work better with 64-bit code + (patch by Marc-Antoine Parent) diff --git a/python/macholib/doc/_build/html/_sources/dyld.txt b/python/macholib/doc/_build/html/_sources/dyld.txt new file mode 100644 index 000000000..14895b6b0 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/dyld.txt @@ -0,0 +1,159 @@ +:mod:`macholib.dyld` --- Dyld emulation +======================================= + +.. module:: macholib.dyld + :synopsis: Emulation of functonality of the dynamic linker + +This module defines a number of functions that can be used +to emulate the functionality of the dynamic linker (``dyld``) +w.r.t. looking for library files and framworks. + +.. function:: dyld_image_suffix([env]) + + Looks up the suffix to append to shared library and + framework names and returns this value when found. + Returns ``None`` when no suffix should be appended. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_IMAGE_SUFFIX`` in the + manual page for dyld(1) for more information. + +.. function:: dydl_framework_path([env]) + + Returns a user-specified framework search path, + or an empty list when only the default search path + should be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_FRAMEWORK_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_library_path([env]) + + Returns a user-specified library search path, + or an empty list when only the default search path + should be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_LIBRARY_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_fallback_framework_path([env]) + + Return a user specified list of of directories where + to look for frameworks that aren't in their install path, + or an empty list when the default fallback path should + be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_FALLBACK_FRAMEWORK_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_fallback_library_path([env]) + + Return a user specified list of of directories where + to look for libraries that aren't in their install path, + or an empty list when the default fallback path should + be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_FALLBACK_LIBRARY_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_image_suffix_search(iterator[, env]) + + Yields all items in *iterator*, and prepents names + with the image suffix to those items when the suffix + is specified. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + +.. function:: dyld_override_search(name[, env]) + + If *name* is a framework name yield filesystem + paths relative to the entries in the framework + search path. + + Always yield the filesystem paths relative to the + entries in the library search path. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + +.. function:: dyld_executable_path_search(name, executable_path) + + If *name* is a path starting with ``@executable_path/`` yield + the path relative to the specified *executable_path*. + + If *executable_path* is None nothing is yielded. + +.. function:: dyld_loader_search(name, loader_path) + + If *name* is a path starting with ``@loader_path/`` yield + the path relative to the specified *loader_path*. + + If *loader_path* is None nothing is yielded. + + .. versionadded: 1.6 + +.. function:: dyld_default_search(name[, env]) + + Yield the filesystem locations to look for a dynamic + library or framework using the default locations + used by the system dynamic linker. + + This function will look in ``~/Library/Frameworks`` + for frameworks, even though the system dynamic linker + doesn't. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + +.. function:: dyld_find(name[, executable_path[, env [, loader]]]) + + Returns the path of the requested dynamic library, + raises :exc:`ValueError` when the library cannot be found. + + This function searches for the library in the same + locations and de system dynamic linker. + + The *executable_path* should be the filesystem path + of the executable to which the library is linked (either + directly or indirectly). + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + The *loader_path* argument is an optional filesystem path for + the object file (binary of shared library) that references + *name*. + + .. versionchanged:: 1.6 + + Added the *loader_path* argument. + +.. function:: framework_find(fn[, executable_path[, env]]) + + Find a framework using the same semantics as the + system dynamic linker, but will accept looser names + than the system linker. + + This function will return a correct result for input + values like: + + * Python + + * Python.framework + + * Python.framework/Versions/Current diff --git a/python/macholib/doc/_build/html/_sources/dylib.txt b/python/macholib/doc/_build/html/_sources/dylib.txt new file mode 100644 index 000000000..969680212 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/dylib.txt @@ -0,0 +1,33 @@ +:mod:`macholib.dylib` --- Generic dylib path manipulation +========================================================= + +.. module:: macholib.dylib + :synopsis: Generic dylib path manipulation + +This module defines a function :func:`dylib_info` that can extract +useful information from the name of a dynamic library. + +.. function:: dylib_info(filename) + + A dylib name can take one of the following four forms: + + * ``Location/Name.SomeVersion_Suffix.dylib`` + + * ``Location/Name.SomeVersion.dylib`` + + * ``Location/Name_Suffix.dylib`` + + * ``Location/Name.dylib`` + + Returns None if not found or a mapping equivalent to:: + + dict( + location='Location', + name='Name.SomeVersion_Suffix.dylib', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + ) + + .. note:: *SomeVersion* and *Suffix* are optional and my be ``None`` + if not present. diff --git a/python/macholib/doc/_build/html/_sources/framework.txt b/python/macholib/doc/_build/html/_sources/framework.txt new file mode 100644 index 000000000..b58b5751c --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/framework.txt @@ -0,0 +1,34 @@ +:mod:`macholib.framework` --- Generic framework path manipulation +========================================================================== + +.. module:: macholib.framework + :synopsis: Generic framework path manipulation + + +This module defines a function :func:`framework_info` that can extract +useful information from the name of a dynamic library in a framework. + +.. function:: framework_info(filename) + + A framework name can take one of the following four forms: + + * ``Location/Name.framework/Versions/SomeVersion/Name_Suffix`` + + * ``Location/Name.framework/Versions/SomeVersion/Name`` + + * ``Location/Name.framework/Name_Suffix`` + + * ``Location/Name.framework/Name`` + + Returns ``None`` if not found, or a mapping equivalent to:: + + dict( + location='Location', + name='Name.framework/Versions/SomeVersion/Name_Suffix', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + ) + + .. note:: *SomeVersion* and *Suffix* are optional and may be None + if not present. diff --git a/python/macholib/doc/_build/html/_sources/index.txt b/python/macholib/doc/_build/html/_sources/index.txt new file mode 100644 index 000000000..3067926a8 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/index.txt @@ -0,0 +1,59 @@ +Macholib - Analyze and edit Mach-O headers +========================================== + +macholib can be used to analyze and edit Mach-O headers, the executable +format used by Mac OS X. + +It's typically used as a dependency analysis tool, and also to rewrite dylib +references in Mach-O headers to be ``@executable_path`` relative. + +Though this tool targets a platform specific file format, it is pure python +code that is platform and endian independent. + +General documentation +--------------------- + +.. toctree:: + :maxdepth: 1 + + changelog + license + scripts + +Reference Guide +--------------- + +.. toctree:: + :maxdepth: 1 + + MachO + MachoOGraph + MachoOStandalone + SymbolTable + dyld + dylib + framework + macho_o + ptypes + +Online Resources +---------------- + +* `Sourcecode repository on bitbucket `_ + +* `The issue tracker `_ + +* `Mac OS X ABI Mach-O File Format Reference at Apple `_ + +Contributors +------------ + +Macholib was written by Bob Ippolito and is currently maintained by Ronald Oussoren . + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/python/macholib/doc/_build/html/_sources/license.txt b/python/macholib/doc/_build/html/_sources/license.txt new file mode 100644 index 000000000..f9c8cc50e --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/license.txt @@ -0,0 +1,23 @@ +License +======= + +Copyright (c) Bob Ippolito + +Parts are copyright (c) 2010-2014 Ronald Oussoren + +MIT License +........... + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software +and associated documentation files (the "Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do +so. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + diff --git a/python/macholib/doc/_build/html/_sources/macho_o.txt b/python/macholib/doc/_build/html/_sources/macho_o.txt new file mode 100644 index 000000000..dfa347e8f --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/macho_o.txt @@ -0,0 +1,13 @@ +:mod:`macholib.mach_o` --- Low-level definitions +================================================ + +.. module:: macholib.mach_o + :synopsis: Low-level definitions of elements in a Mach-O file + +This module defines constants and packable structure types +that correspond to elements of a Mach-O file. + +The names of classes and constants is the same as those in +the Mach-O header files and +`Apple's documentation `_. This document therefore +doesn't explictly document the names in this module. diff --git a/python/macholib/doc/_build/html/_sources/ptypes.txt b/python/macholib/doc/_build/html/_sources/ptypes.txt new file mode 100644 index 000000000..ade2ac847 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/ptypes.txt @@ -0,0 +1,157 @@ +:mod:`macholib.ptypes` --- Packable types +========================================= + +.. module:: macholib.ptypes + :synopsis: Serializable types + +The module :mod:`macholib.ptypes` defines types that can be serialized into +byte arrays, both for basic types and structured types (C ``struct`` values). + +Utility functions +----------------- + +.. function:: sizeof(value) + + Returns the size in bytes of an object when packed, raises :exc:`ValueError` + for inappropriate values. + +.. function:: pypackable(name, pytype, format) + + Returns a packable type that is a subclass of the Python type + *pytype*. The value is converted to and from the packed format using + the struct *format*. + + + +Packable types +-------------- + + +.. class:: BasePackable + + All packable types are a subclass of :class:`BasePackable`, which defines + the basic interface but is itself an abstract base class. + + .. data:: _endian_ + + The byteorder of a packed value. This will be ``"<"` for + little endian values and ``">"`` for big-endian ones. + + .. note:: the endianness option is a public value to be + able to support both big- and little-endian file formats. + + The name suggests that this attribute is private, this + is partically for historical reasons and partially to + avoid conflicts with field names in C structs. + + .. method:: from_mmap(mmap, ptr, \**kw) + + This class method constructs the value from a subview of a + :class:`mmap.mmap` object. It uses bytes starting at offset *ptr* and + reads just enough bytes to read the entire object. + + .. method:: from_fileobj(fp, \**kw) + + This class method constructs the value by reading just enough bytes + from a file-like object. + + .. note:: The file must be opened in binary mode, that is read calls + should return byte-strings and not unicode-strings. + + .. method:: from_str(value, \**kw) + + This class method construct the value by using the struct module + to parse the given bytes. + + .. note:: contrary to what the name suggests the argument to this + method is a byte-string, not a unicode-string. + + .. method:: from_tuple(fp, \**kw) + + This class method constructs the object from a tuple with all fields. + + + .. method:: to_str() + + Returns a byte representation of the value. + + .. note:: there is no default implementation for this method + + .. method:: to_fileobj(fp) + + Write a byte representation of the value to the given file-like + object. The file should be opened in binary mode. + + .. method:: to_mmap(mmap, ptr) + + Write the byte representation of the value to a :class:`mmap.mmap` + object, starting at offset *ptr*. + + +.. class:: Structure(...) + + .. data:: _fields_ + + This class attribute is a list that contains the fields of the + structure in the right order. Every item of this list is a tuple + with 2 arguments: the first element is the name of the field, and + the second the packable type for the field. + + Every subclass of :class:`Structure` must define *_fields_* to be + usefull, and the value of *_fields_* should not be changed after + class construction. + + +Basic packables +--------------- + +Other than the core functionality this module defines a number of +:func:`pypackable` types that correspond to useful basic C types. + +.. class:: p_char([value]) + + A byte string of length 1 + +.. class:: p_int8 + + An 8-bit signed integer + +.. class:: p_uint8 + + An 8-bit unsigned integer + +.. class:: p_int16 + + An 16-bit signed integer + +.. class:: p_uint16 + + An 16-bit unsigned integer + +.. class:: p_int32 + + An 32-bit signed integer + +.. class:: p_uint32 + + An 32-bit unsigned integer + +.. class:: p_int64 + + An 64-bit signed integer + +.. class:: p_uint64 + + An 64-bit unsigned integer + +.. class:: p_float + + An floating point value of type ``float`` + +.. class:: p_double + + An floating point value of type ``double`` + +.. note:: the module exports a number of other types with + names starting with ``p_``, such as ``p_int``. Those types + are deprecated and should not be used. diff --git a/python/macholib/doc/_build/html/_sources/scripts.txt b/python/macholib/doc/_build/html/_sources/scripts.txt new file mode 100644 index 000000000..50cf38028 --- /dev/null +++ b/python/macholib/doc/_build/html/_sources/scripts.txt @@ -0,0 +1,35 @@ +Command-line tools +================== + +python -m macholib find +----------------------- + +Usage:: + + $ python -mmacholib find dir... + +Print the paths of all MachO binaries +in the specified directories. + +python -m macholib standalone +----------------------------- + +Usage:: + + $ python -m macholib standalone appbundle... + +Convert one or more application bundles into +standalone bundles. That is, copy all non-system +shared libraries and frameworks used by the bundle +into the bundle and rewrite load commands. + +python -mmacholib dump +---------------------- + +Usage:: + + $ python -mmacholib dump dir... + +Prints information about all architectures in a +Mach-O file as well as all libraries it links +to. diff --git a/python/macholib/doc/_build/html/_static/ajax-loader.gif b/python/macholib/doc/_build/html/_static/ajax-loader.gif new file mode 100644 index 000000000..61faf8cab Binary files /dev/null and b/python/macholib/doc/_build/html/_static/ajax-loader.gif differ diff --git a/python/macholib/doc/_build/html/_static/basic.css b/python/macholib/doc/_build/html/_static/basic.css new file mode 100644 index 000000000..c959cf0db --- /dev/null +++ b/python/macholib/doc/_build/html/_static/basic.css @@ -0,0 +1,537 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + width: 30px; +} + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/python/macholib/doc/_build/html/_static/comment-bright.png b/python/macholib/doc/_build/html/_static/comment-bright.png new file mode 100644 index 000000000..551517b8c Binary files /dev/null and b/python/macholib/doc/_build/html/_static/comment-bright.png differ diff --git a/python/macholib/doc/_build/html/_static/comment-close.png b/python/macholib/doc/_build/html/_static/comment-close.png new file mode 100644 index 000000000..09b54be46 Binary files /dev/null and b/python/macholib/doc/_build/html/_static/comment-close.png differ diff --git a/python/macholib/doc/_build/html/_static/comment.png b/python/macholib/doc/_build/html/_static/comment.png new file mode 100644 index 000000000..92feb52b8 Binary files /dev/null and b/python/macholib/doc/_build/html/_static/comment.png differ diff --git a/python/macholib/doc/_build/html/_static/doctools.js b/python/macholib/doc/_build/html/_static/doctools.js new file mode 100644 index 000000000..2036e5f5f --- /dev/null +++ b/python/macholib/doc/_build/html/_static/doctools.js @@ -0,0 +1,238 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/python/macholib/doc/_build/html/_static/down-pressed.png b/python/macholib/doc/_build/html/_static/down-pressed.png new file mode 100644 index 000000000..6f7ad7827 Binary files /dev/null and b/python/macholib/doc/_build/html/_static/down-pressed.png differ diff --git a/python/macholib/doc/_build/html/_static/down.png b/python/macholib/doc/_build/html/_static/down.png new file mode 100644 index 000000000..3003a8877 Binary files /dev/null and b/python/macholib/doc/_build/html/_static/down.png differ diff --git a/python/macholib/doc/_build/html/_static/file.png b/python/macholib/doc/_build/html/_static/file.png new file mode 100644 index 000000000..d18082e39 Binary files /dev/null and b/python/macholib/doc/_build/html/_static/file.png differ diff --git a/python/macholib/doc/_build/html/_static/jquery.js b/python/macholib/doc/_build/html/_static/jquery.js new file mode 100644 index 000000000..83589daa7 --- /dev/null +++ b/python/macholib/doc/_build/html/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v1.8.3 jquery.com | jquery.org/license */ +(function(e,t){function _(e){var t=M[e]={};return v.each(e.split(y),function(e,n){t[n]=!0}),t}function H(e,n,r){if(r===t&&e.nodeType===1){var i="data-"+n.replace(P,"-$1").toLowerCase();r=e.getAttribute(i);if(typeof r=="string"){try{r=r==="true"?!0:r==="false"?!1:r==="null"?null:+r+""===r?+r:D.test(r)?v.parseJSON(r):r}catch(s){}v.data(e,n,r)}else r=t}return r}function B(e){var t;for(t in e){if(t==="data"&&v.isEmptyObject(e[t]))continue;if(t!=="toJSON")return!1}return!0}function et(){return!1}function tt(){return!0}function ut(e){return!e||!e.parentNode||e.parentNode.nodeType===11}function at(e,t){do e=e[t];while(e&&e.nodeType!==1);return e}function ft(e,t,n){t=t||0;if(v.isFunction(t))return v.grep(e,function(e,r){var i=!!t.call(e,r,e);return i===n});if(t.nodeType)return v.grep(e,function(e,r){return e===t===n});if(typeof t=="string"){var r=v.grep(e,function(e){return e.nodeType===1});if(it.test(t))return v.filter(t,r,!n);t=v.filter(t,r)}return v.grep(e,function(e,r){return v.inArray(e,t)>=0===n})}function lt(e){var t=ct.split("|"),n=e.createDocumentFragment();if(n.createElement)while(t.length)n.createElement(t.pop());return n}function Lt(e,t){return e.getElementsByTagName(t)[0]||e.appendChild(e.ownerDocument.createElement(t))}function At(e,t){if(t.nodeType!==1||!v.hasData(e))return;var n,r,i,s=v._data(e),o=v._data(t,s),u=s.events;if(u){delete o.handle,o.events={};for(n in u)for(r=0,i=u[n].length;r").appendTo(i.body),n=t.css("display");t.remove();if(n==="none"||n===""){Pt=i.body.appendChild(Pt||v.extend(i.createElement("iframe"),{frameBorder:0,width:0,height:0}));if(!Ht||!Pt.createElement)Ht=(Pt.contentWindow||Pt.contentDocument).document,Ht.write(""),Ht.close();t=Ht.body.appendChild(Ht.createElement(e)),n=Dt(t,"display"),i.body.removeChild(Pt)}return Wt[e]=n,n}function fn(e,t,n,r){var i;if(v.isArray(t))v.each(t,function(t,i){n||sn.test(e)?r(e,i):fn(e+"["+(typeof i=="object"?t:"")+"]",i,n,r)});else if(!n&&v.type(t)==="object")for(i in t)fn(e+"["+i+"]",t[i],n,r);else r(e,t)}function Cn(e){return function(t,n){typeof t!="string"&&(n=t,t="*");var r,i,s,o=t.toLowerCase().split(y),u=0,a=o.length;if(v.isFunction(n))for(;u)[^>]*$|#([\w\-]*)$)/,E=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,S=/^[\],:{}\s]*$/,x=/(?:^|:|,)(?:\s*\[)+/g,T=/\\(?:["\\\/bfnrt]|u[\da-fA-F]{4})/g,N=/"[^"\\\r\n]*"|true|false|null|-?(?:\d\d*\.|)\d+(?:[eE][\-+]?\d+|)/g,C=/^-ms-/,k=/-([\da-z])/gi,L=function(e,t){return(t+"").toUpperCase()},A=function(){i.addEventListener?(i.removeEventListener("DOMContentLoaded",A,!1),v.ready()):i.readyState==="complete"&&(i.detachEvent("onreadystatechange",A),v.ready())},O={};v.fn=v.prototype={constructor:v,init:function(e,n,r){var s,o,u,a;if(!e)return this;if(e.nodeType)return this.context=this[0]=e,this.length=1,this;if(typeof e=="string"){e.charAt(0)==="<"&&e.charAt(e.length-1)===">"&&e.length>=3?s=[null,e,null]:s=w.exec(e);if(s&&(s[1]||!n)){if(s[1])return n=n instanceof v?n[0]:n,a=n&&n.nodeType?n.ownerDocument||n:i,e=v.parseHTML(s[1],a,!0),E.test(s[1])&&v.isPlainObject(n)&&this.attr.call(e,n,!0),v.merge(this,e);o=i.getElementById(s[2]);if(o&&o.parentNode){if(o.id!==s[2])return r.find(e);this.length=1,this[0]=o}return this.context=i,this.selector=e,this}return!n||n.jquery?(n||r).find(e):this.constructor(n).find(e)}return v.isFunction(e)?r.ready(e):(e.selector!==t&&(this.selector=e.selector,this.context=e.context),v.makeArray(e,this))},selector:"",jquery:"1.8.3",length:0,size:function(){return this.length},toArray:function(){return l.call(this)},get:function(e){return e==null?this.toArray():e<0?this[this.length+e]:this[e]},pushStack:function(e,t,n){var r=v.merge(this.constructor(),e);return r.prevObject=this,r.context=this.context,t==="find"?r.selector=this.selector+(this.selector?" ":"")+n:t&&(r.selector=this.selector+"."+t+"("+n+")"),r},each:function(e,t){return v.each(this,e,t)},ready:function(e){return v.ready.promise().done(e),this},eq:function(e){return e=+e,e===-1?this.slice(e):this.slice(e,e+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(l.apply(this,arguments),"slice",l.call(arguments).join(","))},map:function(e){return this.pushStack(v.map(this,function(t,n){return e.call(t,n,t)}))},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:[].sort,splice:[].splice},v.fn.init.prototype=v.fn,v.extend=v.fn.extend=function(){var e,n,r,i,s,o,u=arguments[0]||{},a=1,f=arguments.length,l=!1;typeof u=="boolean"&&(l=u,u=arguments[1]||{},a=2),typeof u!="object"&&!v.isFunction(u)&&(u={}),f===a&&(u=this,--a);for(;a0)return;r.resolveWith(i,[v]),v.fn.trigger&&v(i).trigger("ready").off("ready")},isFunction:function(e){return v.type(e)==="function"},isArray:Array.isArray||function(e){return v.type(e)==="array"},isWindow:function(e){return e!=null&&e==e.window},isNumeric:function(e){return!isNaN(parseFloat(e))&&isFinite(e)},type:function(e){return e==null?String(e):O[h.call(e)]||"object"},isPlainObject:function(e){if(!e||v.type(e)!=="object"||e.nodeType||v.isWindow(e))return!1;try{if(e.constructor&&!p.call(e,"constructor")&&!p.call(e.constructor.prototype,"isPrototypeOf"))return!1}catch(n){return!1}var r;for(r in e);return r===t||p.call(e,r)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},error:function(e){throw new Error(e)},parseHTML:function(e,t,n){var r;return!e||typeof e!="string"?null:(typeof t=="boolean"&&(n=t,t=0),t=t||i,(r=E.exec(e))?[t.createElement(r[1])]:(r=v.buildFragment([e],t,n?null:[]),v.merge([],(r.cacheable?v.clone(r.fragment):r.fragment).childNodes)))},parseJSON:function(t){if(!t||typeof t!="string")return null;t=v.trim(t);if(e.JSON&&e.JSON.parse)return e.JSON.parse(t);if(S.test(t.replace(T,"@").replace(N,"]").replace(x,"")))return(new Function("return "+t))();v.error("Invalid JSON: "+t)},parseXML:function(n){var r,i;if(!n||typeof n!="string")return null;try{e.DOMParser?(i=new DOMParser,r=i.parseFromString(n,"text/xml")):(r=new ActiveXObject("Microsoft.XMLDOM"),r.async="false",r.loadXML(n))}catch(s){r=t}return(!r||!r.documentElement||r.getElementsByTagName("parsererror").length)&&v.error("Invalid XML: "+n),r},noop:function(){},globalEval:function(t){t&&g.test(t)&&(e.execScript||function(t){e.eval.call(e,t)})(t)},camelCase:function(e){return e.replace(C,"ms-").replace(k,L)},nodeName:function(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()},each:function(e,n,r){var i,s=0,o=e.length,u=o===t||v.isFunction(e);if(r){if(u){for(i in e)if(n.apply(e[i],r)===!1)break}else for(;s0&&e[0]&&e[a-1]||a===0||v.isArray(e));if(f)for(;u-1)a.splice(n,1),i&&(n<=o&&o--,n<=u&&u--)}),this},has:function(e){return v.inArray(e,a)>-1},empty:function(){return a=[],this},disable:function(){return a=f=n=t,this},disabled:function(){return!a},lock:function(){return f=t,n||c.disable(),this},locked:function(){return!f},fireWith:function(e,t){return t=t||[],t=[e,t.slice?t.slice():t],a&&(!r||f)&&(i?f.push(t):l(t)),this},fire:function(){return c.fireWith(this,arguments),this},fired:function(){return!!r}};return c},v.extend({Deferred:function(e){var t=[["resolve","done",v.Callbacks("once memory"),"resolved"],["reject","fail",v.Callbacks("once memory"),"rejected"],["notify","progress",v.Callbacks("memory")]],n="pending",r={state:function(){return n},always:function(){return i.done(arguments).fail(arguments),this},then:function(){var e=arguments;return v.Deferred(function(n){v.each(t,function(t,r){var s=r[0],o=e[t];i[r[1]](v.isFunction(o)?function(){var e=o.apply(this,arguments);e&&v.isFunction(e.promise)?e.promise().done(n.resolve).fail(n.reject).progress(n.notify):n[s+"With"](this===i?n:this,[e])}:n[s])}),e=null}).promise()},promise:function(e){return e!=null?v.extend(e,r):r}},i={};return r.pipe=r.then,v.each(t,function(e,s){var o=s[2],u=s[3];r[s[1]]=o.add,u&&o.add(function(){n=u},t[e^1][2].disable,t[2][2].lock),i[s[0]]=o.fire,i[s[0]+"With"]=o.fireWith}),r.promise(i),e&&e.call(i,i),i},when:function(e){var t=0,n=l.call(arguments),r=n.length,i=r!==1||e&&v.isFunction(e.promise)?r:0,s=i===1?e:v.Deferred(),o=function(e,t,n){return function(r){t[e]=this,n[e]=arguments.length>1?l.call(arguments):r,n===u?s.notifyWith(t,n):--i||s.resolveWith(t,n)}},u,a,f;if(r>1){u=new Array(r),a=new Array(r),f=new Array(r);for(;t
a",n=p.getElementsByTagName("*"),r=p.getElementsByTagName("a")[0];if(!n||!r||!n.length)return{};s=i.createElement("select"),o=s.appendChild(i.createElement("option")),u=p.getElementsByTagName("input")[0],r.style.cssText="top:1px;float:left;opacity:.5",t={leadingWhitespace:p.firstChild.nodeType===3,tbody:!p.getElementsByTagName("tbody").length,htmlSerialize:!!p.getElementsByTagName("link").length,style:/top/.test(r.getAttribute("style")),hrefNormalized:r.getAttribute("href")==="/a",opacity:/^0.5/.test(r.style.opacity),cssFloat:!!r.style.cssFloat,checkOn:u.value==="on",optSelected:o.selected,getSetAttribute:p.className!=="t",enctype:!!i.createElement("form").enctype,html5Clone:i.createElement("nav").cloneNode(!0).outerHTML!=="<:nav>",boxModel:i.compatMode==="CSS1Compat",submitBubbles:!0,changeBubbles:!0,focusinBubbles:!1,deleteExpando:!0,noCloneEvent:!0,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableMarginRight:!0,boxSizingReliable:!0,pixelPosition:!1},u.checked=!0,t.noCloneChecked=u.cloneNode(!0).checked,s.disabled=!0,t.optDisabled=!o.disabled;try{delete p.test}catch(d){t.deleteExpando=!1}!p.addEventListener&&p.attachEvent&&p.fireEvent&&(p.attachEvent("onclick",h=function(){t.noCloneEvent=!1}),p.cloneNode(!0).fireEvent("onclick"),p.detachEvent("onclick",h)),u=i.createElement("input"),u.value="t",u.setAttribute("type","radio"),t.radioValue=u.value==="t",u.setAttribute("checked","checked"),u.setAttribute("name","t"),p.appendChild(u),a=i.createDocumentFragment(),a.appendChild(p.lastChild),t.checkClone=a.cloneNode(!0).cloneNode(!0).lastChild.checked,t.appendChecked=u.checked,a.removeChild(u),a.appendChild(p);if(p.attachEvent)for(l in{submit:!0,change:!0,focusin:!0})f="on"+l,c=f in p,c||(p.setAttribute(f,"return;"),c=typeof p[f]=="function"),t[l+"Bubbles"]=c;return v(function(){var n,r,s,o,u="padding:0;margin:0;border:0;display:block;overflow:hidden;",a=i.getElementsByTagName("body")[0];if(!a)return;n=i.createElement("div"),n.style.cssText="visibility:hidden;border:0;width:0;height:0;position:static;top:0;margin-top:1px",a.insertBefore(n,a.firstChild),r=i.createElement("div"),n.appendChild(r),r.innerHTML="
t
",s=r.getElementsByTagName("td"),s[0].style.cssText="padding:0;margin:0;border:0;display:none",c=s[0].offsetHeight===0,s[0].style.display="",s[1].style.display="none",t.reliableHiddenOffsets=c&&s[0].offsetHeight===0,r.innerHTML="",r.style.cssText="box-sizing:border-box;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;padding:1px;border:1px;display:block;width:4px;margin-top:1%;position:absolute;top:1%;",t.boxSizing=r.offsetWidth===4,t.doesNotIncludeMarginInBodyOffset=a.offsetTop!==1,e.getComputedStyle&&(t.pixelPosition=(e.getComputedStyle(r,null)||{}).top!=="1%",t.boxSizingReliable=(e.getComputedStyle(r,null)||{width:"4px"}).width==="4px",o=i.createElement("div"),o.style.cssText=r.style.cssText=u,o.style.marginRight=o.style.width="0",r.style.width="1px",r.appendChild(o),t.reliableMarginRight=!parseFloat((e.getComputedStyle(o,null)||{}).marginRight)),typeof r.style.zoom!="undefined"&&(r.innerHTML="",r.style.cssText=u+"width:1px;padding:1px;display:inline;zoom:1",t.inlineBlockNeedsLayout=r.offsetWidth===3,r.style.display="block",r.style.overflow="visible",r.innerHTML="
",r.firstChild.style.width="5px",t.shrinkWrapBlocks=r.offsetWidth!==3,n.style.zoom=1),a.removeChild(n),n=r=s=o=null}),a.removeChild(p),n=r=s=o=u=a=p=null,t}();var D=/(?:\{[\s\S]*\}|\[[\s\S]*\])$/,P=/([A-Z])/g;v.extend({cache:{},deletedIds:[],uuid:0,expando:"jQuery"+(v.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(e){return e=e.nodeType?v.cache[e[v.expando]]:e[v.expando],!!e&&!B(e)},data:function(e,n,r,i){if(!v.acceptData(e))return;var s,o,u=v.expando,a=typeof n=="string",f=e.nodeType,l=f?v.cache:e,c=f?e[u]:e[u]&&u;if((!c||!l[c]||!i&&!l[c].data)&&a&&r===t)return;c||(f?e[u]=c=v.deletedIds.pop()||v.guid++:c=u),l[c]||(l[c]={},f||(l[c].toJSON=v.noop));if(typeof n=="object"||typeof n=="function")i?l[c]=v.extend(l[c],n):l[c].data=v.extend(l[c].data,n);return s=l[c],i||(s.data||(s.data={}),s=s.data),r!==t&&(s[v.camelCase(n)]=r),a?(o=s[n],o==null&&(o=s[v.camelCase(n)])):o=s,o},removeData:function(e,t,n){if(!v.acceptData(e))return;var r,i,s,o=e.nodeType,u=o?v.cache:e,a=o?e[v.expando]:v.expando;if(!u[a])return;if(t){r=n?u[a]:u[a].data;if(r){v.isArray(t)||(t in r?t=[t]:(t=v.camelCase(t),t in r?t=[t]:t=t.split(" ")));for(i=0,s=t.length;i1,null,!1))},removeData:function(e){return this.each(function(){v.removeData(this,e)})}}),v.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=v._data(e,t),n&&(!r||v.isArray(n)?r=v._data(e,t,v.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=v.queue(e,t),r=n.length,i=n.shift(),s=v._queueHooks(e,t),o=function(){v.dequeue(e,t)};i==="inprogress"&&(i=n.shift(),r--),i&&(t==="fx"&&n.unshift("inprogress"),delete s.stop,i.call(e,o,s)),!r&&s&&s.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return v._data(e,n)||v._data(e,n,{empty:v.Callbacks("once memory").add(function(){v.removeData(e,t+"queue",!0),v.removeData(e,n,!0)})})}}),v.fn.extend({queue:function(e,n){var r=2;return typeof e!="string"&&(n=e,e="fx",r--),arguments.length1)},removeAttr:function(e){return this.each(function(){v.removeAttr(this,e)})},prop:function(e,t){return v.access(this,v.prop,e,t,arguments.length>1)},removeProp:function(e){return e=v.propFix[e]||e,this.each(function(){try{this[e]=t,delete this[e]}catch(n){}})},addClass:function(e){var t,n,r,i,s,o,u;if(v.isFunction(e))return this.each(function(t){v(this).addClass(e.call(this,t,this.className))});if(e&&typeof e=="string"){t=e.split(y);for(n=0,r=this.length;n=0)r=r.replace(" "+n[s]+" "," ");i.className=e?v.trim(r):""}}}return this},toggleClass:function(e,t){var n=typeof e,r=typeof t=="boolean";return v.isFunction(e)?this.each(function(n){v(this).toggleClass(e.call(this,n,this.className,t),t)}):this.each(function(){if(n==="string"){var i,s=0,o=v(this),u=t,a=e.split(y);while(i=a[s++])u=r?u:!o.hasClass(i),o[u?"addClass":"removeClass"](i)}else if(n==="undefined"||n==="boolean")this.className&&v._data(this,"__className__",this.className),this.className=this.className||e===!1?"":v._data(this,"__className__")||""})},hasClass:function(e){var t=" "+e+" ",n=0,r=this.length;for(;n=0)return!0;return!1},val:function(e){var n,r,i,s=this[0];if(!arguments.length){if(s)return n=v.valHooks[s.type]||v.valHooks[s.nodeName.toLowerCase()],n&&"get"in n&&(r=n.get(s,"value"))!==t?r:(r=s.value,typeof r=="string"?r.replace(R,""):r==null?"":r);return}return i=v.isFunction(e),this.each(function(r){var s,o=v(this);if(this.nodeType!==1)return;i?s=e.call(this,r,o.val()):s=e,s==null?s="":typeof s=="number"?s+="":v.isArray(s)&&(s=v.map(s,function(e){return e==null?"":e+""})),n=v.valHooks[this.type]||v.valHooks[this.nodeName.toLowerCase()];if(!n||!("set"in n)||n.set(this,s,"value")===t)this.value=s})}}),v.extend({valHooks:{option:{get:function(e){var t=e.attributes.value;return!t||t.specified?e.value:e.text}},select:{get:function(e){var t,n,r=e.options,i=e.selectedIndex,s=e.type==="select-one"||i<0,o=s?null:[],u=s?i+1:r.length,a=i<0?u:s?i:0;for(;a=0}),n.length||(e.selectedIndex=-1),n}}},attrFn:{},attr:function(e,n,r,i){var s,o,u,a=e.nodeType;if(!e||a===3||a===8||a===2)return;if(i&&v.isFunction(v.fn[n]))return v(e)[n](r);if(typeof e.getAttribute=="undefined")return v.prop(e,n,r);u=a!==1||!v.isXMLDoc(e),u&&(n=n.toLowerCase(),o=v.attrHooks[n]||(X.test(n)?F:j));if(r!==t){if(r===null){v.removeAttr(e,n);return}return o&&"set"in o&&u&&(s=o.set(e,r,n))!==t?s:(e.setAttribute(n,r+""),r)}return o&&"get"in o&&u&&(s=o.get(e,n))!==null?s:(s=e.getAttribute(n),s===null?t:s)},removeAttr:function(e,t){var n,r,i,s,o=0;if(t&&e.nodeType===1){r=t.split(y);for(;o=0}})});var $=/^(?:textarea|input|select)$/i,J=/^([^\.]*|)(?:\.(.+)|)$/,K=/(?:^|\s)hover(\.\S+|)\b/,Q=/^key/,G=/^(?:mouse|contextmenu)|click/,Y=/^(?:focusinfocus|focusoutblur)$/,Z=function(e){return v.event.special.hover?e:e.replace(K,"mouseenter$1 mouseleave$1")};v.event={add:function(e,n,r,i,s){var o,u,a,f,l,c,h,p,d,m,g;if(e.nodeType===3||e.nodeType===8||!n||!r||!(o=v._data(e)))return;r.handler&&(d=r,r=d.handler,s=d.selector),r.guid||(r.guid=v.guid++),a=o.events,a||(o.events=a={}),u=o.handle,u||(o.handle=u=function(e){return typeof v=="undefined"||!!e&&v.event.triggered===e.type?t:v.event.dispatch.apply(u.elem,arguments)},u.elem=e),n=v.trim(Z(n)).split(" ");for(f=0;f=0&&(y=y.slice(0,-1),a=!0),y.indexOf(".")>=0&&(b=y.split("."),y=b.shift(),b.sort());if((!s||v.event.customEvent[y])&&!v.event.global[y])return;n=typeof n=="object"?n[v.expando]?n:new v.Event(y,n):new v.Event(y),n.type=y,n.isTrigger=!0,n.exclusive=a,n.namespace=b.join("."),n.namespace_re=n.namespace?new RegExp("(^|\\.)"+b.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,h=y.indexOf(":")<0?"on"+y:"";if(!s){u=v.cache;for(f in u)u[f].events&&u[f].events[y]&&v.event.trigger(n,r,u[f].handle.elem,!0);return}n.result=t,n.target||(n.target=s),r=r!=null?v.makeArray(r):[],r.unshift(n),p=v.event.special[y]||{};if(p.trigger&&p.trigger.apply(s,r)===!1)return;m=[[s,p.bindType||y]];if(!o&&!p.noBubble&&!v.isWindow(s)){g=p.delegateType||y,l=Y.test(g+y)?s:s.parentNode;for(c=s;l;l=l.parentNode)m.push([l,g]),c=l;c===(s.ownerDocument||i)&&m.push([c.defaultView||c.parentWindow||e,g])}for(f=0;f=0:v.find(h,this,null,[s]).length),u[h]&&f.push(c);f.length&&w.push({elem:s,matches:f})}d.length>m&&w.push({elem:this,matches:d.slice(m)});for(r=0;r0?this.on(t,null,e,n):this.trigger(t)},Q.test(t)&&(v.event.fixHooks[t]=v.event.keyHooks),G.test(t)&&(v.event.fixHooks[t]=v.event.mouseHooks)}),function(e,t){function nt(e,t,n,r){n=n||[],t=t||g;var i,s,a,f,l=t.nodeType;if(!e||typeof e!="string")return n;if(l!==1&&l!==9)return[];a=o(t);if(!a&&!r)if(i=R.exec(e))if(f=i[1]){if(l===9){s=t.getElementById(f);if(!s||!s.parentNode)return n;if(s.id===f)return n.push(s),n}else if(t.ownerDocument&&(s=t.ownerDocument.getElementById(f))&&u(t,s)&&s.id===f)return n.push(s),n}else{if(i[2])return S.apply(n,x.call(t.getElementsByTagName(e),0)),n;if((f=i[3])&&Z&&t.getElementsByClassName)return S.apply(n,x.call(t.getElementsByClassName(f),0)),n}return vt(e.replace(j,"$1"),t,n,r,a)}function rt(e){return function(t){var n=t.nodeName.toLowerCase();return n==="input"&&t.type===e}}function it(e){return function(t){var n=t.nodeName.toLowerCase();return(n==="input"||n==="button")&&t.type===e}}function st(e){return N(function(t){return t=+t,N(function(n,r){var i,s=e([],n.length,t),o=s.length;while(o--)n[i=s[o]]&&(n[i]=!(r[i]=n[i]))})})}function ot(e,t,n){if(e===t)return n;var r=e.nextSibling;while(r){if(r===t)return-1;r=r.nextSibling}return 1}function ut(e,t){var n,r,s,o,u,a,f,l=L[d][e+" "];if(l)return t?0:l.slice(0);u=e,a=[],f=i.preFilter;while(u){if(!n||(r=F.exec(u)))r&&(u=u.slice(r[0].length)||u),a.push(s=[]);n=!1;if(r=I.exec(u))s.push(n=new m(r.shift())),u=u.slice(n.length),n.type=r[0].replace(j," ");for(o in i.filter)(r=J[o].exec(u))&&(!f[o]||(r=f[o](r)))&&(s.push(n=new m(r.shift())),u=u.slice(n.length),n.type=o,n.matches=r);if(!n)break}return t?u.length:u?nt.error(e):L(e,a).slice(0)}function at(e,t,r){var i=t.dir,s=r&&t.dir==="parentNode",o=w++;return t.first?function(t,n,r){while(t=t[i])if(s||t.nodeType===1)return e(t,n,r)}:function(t,r,u){if(!u){var a,f=b+" "+o+" ",l=f+n;while(t=t[i])if(s||t.nodeType===1){if((a=t[d])===l)return t.sizset;if(typeof a=="string"&&a.indexOf(f)===0){if(t.sizset)return t}else{t[d]=l;if(e(t,r,u))return t.sizset=!0,t;t.sizset=!1}}}else while(t=t[i])if(s||t.nodeType===1)if(e(t,r,u))return t}}function ft(e){return e.length>1?function(t,n,r){var i=e.length;while(i--)if(!e[i](t,n,r))return!1;return!0}:e[0]}function lt(e,t,n,r,i){var s,o=[],u=0,a=e.length,f=t!=null;for(;u-1&&(s[f]=!(o[f]=c))}}else g=lt(g===o?g.splice(d,g.length):g),i?i(null,o,g,a):S.apply(o,g)})}function ht(e){var t,n,r,s=e.length,o=i.relative[e[0].type],u=o||i.relative[" "],a=o?1:0,f=at(function(e){return e===t},u,!0),l=at(function(e){return T.call(t,e)>-1},u,!0),h=[function(e,n,r){return!o&&(r||n!==c)||((t=n).nodeType?f(e,n,r):l(e,n,r))}];for(;a1&&ft(h),a>1&&e.slice(0,a-1).join("").replace(j,"$1"),n,a0,s=e.length>0,o=function(u,a,f,l,h){var p,d,v,m=[],y=0,w="0",x=u&&[],T=h!=null,N=c,C=u||s&&i.find.TAG("*",h&&a.parentNode||a),k=b+=N==null?1:Math.E;T&&(c=a!==g&&a,n=o.el);for(;(p=C[w])!=null;w++){if(s&&p){for(d=0;v=e[d];d++)if(v(p,a,f)){l.push(p);break}T&&(b=k,n=++o.el)}r&&((p=!v&&p)&&y--,u&&x.push(p))}y+=w;if(r&&w!==y){for(d=0;v=t[d];d++)v(x,m,a,f);if(u){if(y>0)while(w--)!x[w]&&!m[w]&&(m[w]=E.call(l));m=lt(m)}S.apply(l,m),T&&!u&&m.length>0&&y+t.length>1&&nt.uniqueSort(l)}return T&&(b=k,c=N),x};return o.el=0,r?N(o):o}function dt(e,t,n){var r=0,i=t.length;for(;r2&&(f=u[0]).type==="ID"&&t.nodeType===9&&!s&&i.relative[u[1].type]){t=i.find.ID(f.matches[0].replace($,""),t,s)[0];if(!t)return n;e=e.slice(u.shift().length)}for(o=J.POS.test(e)?-1:u.length-1;o>=0;o--){f=u[o];if(i.relative[l=f.type])break;if(c=i.find[l])if(r=c(f.matches[0].replace($,""),z.test(u[0].type)&&t.parentNode||t,s)){u.splice(o,1),e=r.length&&u.join("");if(!e)return S.apply(n,x.call(r,0)),n;break}}}return a(e,h)(r,t,s,n,z.test(e)),n}function mt(){}var n,r,i,s,o,u,a,f,l,c,h=!0,p="undefined",d=("sizcache"+Math.random()).replace(".",""),m=String,g=e.document,y=g.documentElement,b=0,w=0,E=[].pop,S=[].push,x=[].slice,T=[].indexOf||function(e){var t=0,n=this.length;for(;ti.cacheLength&&delete e[t.shift()],e[n+" "]=r},e)},k=C(),L=C(),A=C(),O="[\\x20\\t\\r\\n\\f]",M="(?:\\\\.|[-\\w]|[^\\x00-\\xa0])+",_=M.replace("w","w#"),D="([*^$|!~]?=)",P="\\["+O+"*("+M+")"+O+"*(?:"+D+O+"*(?:(['\"])((?:\\\\.|[^\\\\])*?)\\3|("+_+")|)|)"+O+"*\\]",H=":("+M+")(?:\\((?:(['\"])((?:\\\\.|[^\\\\])*?)\\2|([^()[\\]]*|(?:(?:"+P+")|[^:]|\\\\.)*|.*))\\)|)",B=":(even|odd|eq|gt|lt|nth|first|last)(?:\\("+O+"*((?:-\\d)?\\d*)"+O+"*\\)|)(?=[^-]|$)",j=new RegExp("^"+O+"+|((?:^|[^\\\\])(?:\\\\.)*)"+O+"+$","g"),F=new RegExp("^"+O+"*,"+O+"*"),I=new RegExp("^"+O+"*([\\x20\\t\\r\\n\\f>+~])"+O+"*"),q=new RegExp(H),R=/^(?:#([\w\-]+)|(\w+)|\.([\w\-]+))$/,U=/^:not/,z=/[\x20\t\r\n\f]*[+~]/,W=/:not\($/,X=/h\d/i,V=/input|select|textarea|button/i,$=/\\(?!\\)/g,J={ID:new RegExp("^#("+M+")"),CLASS:new RegExp("^\\.("+M+")"),NAME:new RegExp("^\\[name=['\"]?("+M+")['\"]?\\]"),TAG:new RegExp("^("+M.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+H),POS:new RegExp(B,"i"),CHILD:new RegExp("^:(only|nth|first|last)-child(?:\\("+O+"*(even|odd|(([+-]|)(\\d*)n|)"+O+"*(?:([+-]|)"+O+"*(\\d+)|))"+O+"*\\)|)","i"),needsContext:new RegExp("^"+O+"*[>+~]|"+B,"i")},K=function(e){var t=g.createElement("div");try{return e(t)}catch(n){return!1}finally{t=null}},Q=K(function(e){return e.appendChild(g.createComment("")),!e.getElementsByTagName("*").length}),G=K(function(e){return e.innerHTML="",e.firstChild&&typeof e.firstChild.getAttribute!==p&&e.firstChild.getAttribute("href")==="#"}),Y=K(function(e){e.innerHTML="";var t=typeof e.lastChild.getAttribute("multiple");return t!=="boolean"&&t!=="string"}),Z=K(function(e){return e.innerHTML="",!e.getElementsByClassName||!e.getElementsByClassName("e").length?!1:(e.lastChild.className="e",e.getElementsByClassName("e").length===2)}),et=K(function(e){e.id=d+0,e.innerHTML="
",y.insertBefore(e,y.firstChild);var t=g.getElementsByName&&g.getElementsByName(d).length===2+g.getElementsByName(d+0).length;return r=!g.getElementById(d),y.removeChild(e),t});try{x.call(y.childNodes,0)[0].nodeType}catch(tt){x=function(e){var t,n=[];for(;t=this[e];e++)n.push(t);return n}}nt.matches=function(e,t){return nt(e,null,null,t)},nt.matchesSelector=function(e,t){return nt(t,null,null,[e]).length>0},s=nt.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(i===1||i===9||i===11){if(typeof e.textContent=="string")return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=s(e)}else if(i===3||i===4)return e.nodeValue}else for(;t=e[r];r++)n+=s(t);return n},o=nt.isXML=function(e){var t=e&&(e.ownerDocument||e).documentElement;return t?t.nodeName!=="HTML":!1},u=nt.contains=y.contains?function(e,t){var n=e.nodeType===9?e.documentElement:e,r=t&&t.parentNode;return e===r||!!(r&&r.nodeType===1&&n.contains&&n.contains(r))}:y.compareDocumentPosition?function(e,t){return t&&!!(e.compareDocumentPosition(t)&16)}:function(e,t){while(t=t.parentNode)if(t===e)return!0;return!1},nt.attr=function(e,t){var n,r=o(e);return r||(t=t.toLowerCase()),(n=i.attrHandle[t])?n(e):r||Y?e.getAttribute(t):(n=e.getAttributeNode(t),n?typeof e[t]=="boolean"?e[t]?t:null:n.specified?n.value:null:null)},i=nt.selectors={cacheLength:50,createPseudo:N,match:J,attrHandle:G?{}:{href:function(e){return e.getAttribute("href",2)},type:function(e){return e.getAttribute("type")}},find:{ID:r?function(e,t,n){if(typeof t.getElementById!==p&&!n){var r=t.getElementById(e);return r&&r.parentNode?[r]:[]}}:function(e,n,r){if(typeof n.getElementById!==p&&!r){var i=n.getElementById(e);return i?i.id===e||typeof i.getAttributeNode!==p&&i.getAttributeNode("id").value===e?[i]:t:[]}},TAG:Q?function(e,t){if(typeof t.getElementsByTagName!==p)return t.getElementsByTagName(e)}:function(e,t){var n=t.getElementsByTagName(e);if(e==="*"){var r,i=[],s=0;for(;r=n[s];s++)r.nodeType===1&&i.push(r);return i}return n},NAME:et&&function(e,t){if(typeof t.getElementsByName!==p)return t.getElementsByName(name)},CLASS:Z&&function(e,t,n){if(typeof t.getElementsByClassName!==p&&!n)return t.getElementsByClassName(e)}},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace($,""),e[3]=(e[4]||e[5]||"").replace($,""),e[2]==="~="&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),e[1]==="nth"?(e[2]||nt.error(e[0]),e[3]=+(e[3]?e[4]+(e[5]||1):2*(e[2]==="even"||e[2]==="odd")),e[4]=+(e[6]+e[7]||e[2]==="odd")):e[2]&&nt.error(e[0]),e},PSEUDO:function(e){var t,n;if(J.CHILD.test(e[0]))return null;if(e[3])e[2]=e[3];else if(t=e[4])q.test(t)&&(n=ut(t,!0))&&(n=t.indexOf(")",t.length-n)-t.length)&&(t=t.slice(0,n),e[0]=e[0].slice(0,n)),e[2]=t;return e.slice(0,3)}},filter:{ID:r?function(e){return e=e.replace($,""),function(t){return t.getAttribute("id")===e}}:function(e){return e=e.replace($,""),function(t){var n=typeof t.getAttributeNode!==p&&t.getAttributeNode("id");return n&&n.value===e}},TAG:function(e){return e==="*"?function(){return!0}:(e=e.replace($,"").toLowerCase(),function(t){return t.nodeName&&t.nodeName.toLowerCase()===e})},CLASS:function(e){var t=k[d][e+" "];return t||(t=new RegExp("(^|"+O+")"+e+"("+O+"|$)"))&&k(e,function(e){return t.test(e.className||typeof e.getAttribute!==p&&e.getAttribute("class")||"")})},ATTR:function(e,t,n){return function(r,i){var s=nt.attr(r,e);return s==null?t==="!=":t?(s+="",t==="="?s===n:t==="!="?s!==n:t==="^="?n&&s.indexOf(n)===0:t==="*="?n&&s.indexOf(n)>-1:t==="$="?n&&s.substr(s.length-n.length)===n:t==="~="?(" "+s+" ").indexOf(n)>-1:t==="|="?s===n||s.substr(0,n.length+1)===n+"-":!1):!0}},CHILD:function(e,t,n,r){return e==="nth"?function(e){var t,i,s=e.parentNode;if(n===1&&r===0)return!0;if(s){i=0;for(t=s.firstChild;t;t=t.nextSibling)if(t.nodeType===1){i++;if(e===t)break}}return i-=r,i===n||i%n===0&&i/n>=0}:function(t){var n=t;switch(e){case"only":case"first":while(n=n.previousSibling)if(n.nodeType===1)return!1;if(e==="first")return!0;n=t;case"last":while(n=n.nextSibling)if(n.nodeType===1)return!1;return!0}}},PSEUDO:function(e,t){var n,r=i.pseudos[e]||i.setFilters[e.toLowerCase()]||nt.error("unsupported pseudo: "+e);return r[d]?r(t):r.length>1?(n=[e,e,"",t],i.setFilters.hasOwnProperty(e.toLowerCase())?N(function(e,n){var i,s=r(e,t),o=s.length;while(o--)i=T.call(e,s[o]),e[i]=!(n[i]=s[o])}):function(e){return r(e,0,n)}):r}},pseudos:{not:N(function(e){var t=[],n=[],r=a(e.replace(j,"$1"));return r[d]?N(function(e,t,n,i){var s,o=r(e,null,i,[]),u=e.length;while(u--)if(s=o[u])e[u]=!(t[u]=s)}):function(e,i,s){return t[0]=e,r(t,null,s,n),!n.pop()}}),has:N(function(e){return function(t){return nt(e,t).length>0}}),contains:N(function(e){return function(t){return(t.textContent||t.innerText||s(t)).indexOf(e)>-1}}),enabled:function(e){return e.disabled===!1},disabled:function(e){return e.disabled===!0},checked:function(e){var t=e.nodeName.toLowerCase();return t==="input"&&!!e.checked||t==="option"&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,e.selected===!0},parent:function(e){return!i.pseudos.empty(e)},empty:function(e){var t;e=e.firstChild;while(e){if(e.nodeName>"@"||(t=e.nodeType)===3||t===4)return!1;e=e.nextSibling}return!0},header:function(e){return X.test(e.nodeName)},text:function(e){var t,n;return e.nodeName.toLowerCase()==="input"&&(t=e.type)==="text"&&((n=e.getAttribute("type"))==null||n.toLowerCase()===t)},radio:rt("radio"),checkbox:rt("checkbox"),file:rt("file"),password:rt("password"),image:rt("image"),submit:it("submit"),reset:it("reset"),button:function(e){var t=e.nodeName.toLowerCase();return t==="input"&&e.type==="button"||t==="button"},input:function(e){return V.test(e.nodeName)},focus:function(e){var t=e.ownerDocument;return e===t.activeElement&&(!t.hasFocus||t.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},active:function(e){return e===e.ownerDocument.activeElement},first:st(function(){return[0]}),last:st(function(e,t){return[t-1]}),eq:st(function(e,t,n){return[n<0?n+t:n]}),even:st(function(e,t){for(var n=0;n=0;)e.push(r);return e}),gt:st(function(e,t,n){for(var r=n<0?n+t:n;++r",e.querySelectorAll("[selected]").length||i.push("\\["+O+"*(?:checked|disabled|ismap|multiple|readonly|selected|value)"),e.querySelectorAll(":checked").length||i.push(":checked")}),K(function(e){e.innerHTML="

",e.querySelectorAll("[test^='']").length&&i.push("[*^$]="+O+"*(?:\"\"|'')"),e.innerHTML="",e.querySelectorAll(":enabled").length||i.push(":enabled",":disabled")}),i=new RegExp(i.join("|")),vt=function(e,r,s,o,u){if(!o&&!u&&!i.test(e)){var a,f,l=!0,c=d,h=r,p=r.nodeType===9&&e;if(r.nodeType===1&&r.nodeName.toLowerCase()!=="object"){a=ut(e),(l=r.getAttribute("id"))?c=l.replace(n,"\\$&"):r.setAttribute("id",c),c="[id='"+c+"'] ",f=a.length;while(f--)a[f]=c+a[f].join("");h=z.test(e)&&r.parentNode||r,p=a.join(",")}if(p)try{return S.apply(s,x.call(h.querySelectorAll(p),0)),s}catch(v){}finally{l||r.removeAttribute("id")}}return t(e,r,s,o,u)},u&&(K(function(t){e=u.call(t,"div");try{u.call(t,"[test!='']:sizzle"),s.push("!=",H)}catch(n){}}),s=new RegExp(s.join("|")),nt.matchesSelector=function(t,n){n=n.replace(r,"='$1']");if(!o(t)&&!s.test(n)&&!i.test(n))try{var a=u.call(t,n);if(a||e||t.document&&t.document.nodeType!==11)return a}catch(f){}return nt(n,null,null,[t]).length>0})}(),i.pseudos.nth=i.pseudos.eq,i.filters=mt.prototype=i.pseudos,i.setFilters=new mt,nt.attr=v.attr,v.find=nt,v.expr=nt.selectors,v.expr[":"]=v.expr.pseudos,v.unique=nt.uniqueSort,v.text=nt.getText,v.isXMLDoc=nt.isXML,v.contains=nt.contains}(e);var nt=/Until$/,rt=/^(?:parents|prev(?:Until|All))/,it=/^.[^:#\[\.,]*$/,st=v.expr.match.needsContext,ot={children:!0,contents:!0,next:!0,prev:!0};v.fn.extend({find:function(e){var t,n,r,i,s,o,u=this;if(typeof e!="string")return v(e).filter(function(){for(t=0,n=u.length;t0)for(i=r;i=0:v.filter(e,this).length>0:this.filter(e).length>0)},closest:function(e,t){var n,r=0,i=this.length,s=[],o=st.test(e)||typeof e!="string"?v(e,t||this.context):0;for(;r-1:v.find.matchesSelector(n,e)){s.push(n);break}n=n.parentNode}}return s=s.length>1?v.unique(s):s,this.pushStack(s,"closest",e)},index:function(e){return e?typeof e=="string"?v.inArray(this[0],v(e)):v.inArray(e.jquery?e[0]:e,this):this[0]&&this[0].parentNode?this.prevAll().length:-1},add:function(e,t){var n=typeof e=="string"?v(e,t):v.makeArray(e&&e.nodeType?[e]:e),r=v.merge(this.get(),n);return this.pushStack(ut(n[0])||ut(r[0])?r:v.unique(r))},addBack:function(e){return this.add(e==null?this.prevObject:this.prevObject.filter(e))}}),v.fn.andSelf=v.fn.addBack,v.each({parent:function(e){var t=e.parentNode;return t&&t.nodeType!==11?t:null},parents:function(e){return v.dir(e,"parentNode")},parentsUntil:function(e,t,n){return v.dir(e,"parentNode",n)},next:function(e){return at(e,"nextSibling")},prev:function(e){return at(e,"previousSibling")},nextAll:function(e){return v.dir(e,"nextSibling")},prevAll:function(e){return v.dir(e,"previousSibling")},nextUntil:function(e,t,n){return v.dir(e,"nextSibling",n)},prevUntil:function(e,t,n){return v.dir(e,"previousSibling",n)},siblings:function(e){return v.sibling((e.parentNode||{}).firstChild,e)},children:function(e){return v.sibling(e.firstChild)},contents:function(e){return v.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:v.merge([],e.childNodes)}},function(e,t){v.fn[e]=function(n,r){var i=v.map(this,t,n);return nt.test(e)||(r=n),r&&typeof r=="string"&&(i=v.filter(r,i)),i=this.length>1&&!ot[e]?v.unique(i):i,this.length>1&&rt.test(e)&&(i=i.reverse()),this.pushStack(i,e,l.call(arguments).join(","))}}),v.extend({filter:function(e,t,n){return n&&(e=":not("+e+")"),t.length===1?v.find.matchesSelector(t[0],e)?[t[0]]:[]:v.find.matches(e,t)},dir:function(e,n,r){var i=[],s=e[n];while(s&&s.nodeType!==9&&(r===t||s.nodeType!==1||!v(s).is(r)))s.nodeType===1&&i.push(s),s=s[n];return i},sibling:function(e,t){var n=[];for(;e;e=e.nextSibling)e.nodeType===1&&e!==t&&n.push(e);return n}});var ct="abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",ht=/ jQuery\d+="(?:null|\d+)"/g,pt=/^\s+/,dt=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,vt=/<([\w:]+)/,mt=/]","i"),Et=/^(?:checkbox|radio)$/,St=/checked\s*(?:[^=]|=\s*.checked.)/i,xt=/\/(java|ecma)script/i,Tt=/^\s*\s*$/g,Nt={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]},Ct=lt(i),kt=Ct.appendChild(i.createElement("div"));Nt.optgroup=Nt.option,Nt.tbody=Nt.tfoot=Nt.colgroup=Nt.caption=Nt.thead,Nt.th=Nt.td,v.support.htmlSerialize||(Nt._default=[1,"X
","
"]),v.fn.extend({text:function(e){return v.access(this,function(e){return e===t?v.text(this):this.empty().append((this[0]&&this[0].ownerDocument||i).createTextNode(e))},null,e,arguments.length)},wrapAll:function(e){if(v.isFunction(e))return this.each(function(t){v(this).wrapAll(e.call(this,t))});if(this[0]){var t=v(e,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstChild&&e.firstChild.nodeType===1)e=e.firstChild;return e}).append(this)}return this},wrapInner:function(e){return v.isFunction(e)?this.each(function(t){v(this).wrapInner(e.call(this,t))}):this.each(function(){var t=v(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=v.isFunction(e);return this.each(function(n){v(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(){return this.parent().each(function(){v.nodeName(this,"body")||v(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.appendChild(e)})},prepend:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.insertBefore(e,this.firstChild)})},before:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(e,this),"before",this.selector)}},after:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this.nextSibling)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(this,e),"after",this.selector)}},remove:function(e,t){var n,r=0;for(;(n=this[r])!=null;r++)if(!e||v.filter(e,[n]).length)!t&&n.nodeType===1&&(v.cleanData(n.getElementsByTagName("*")),v.cleanData([n])),n.parentNode&&n.parentNode.removeChild(n);return this},empty:function(){var e,t=0;for(;(e=this[t])!=null;t++){e.nodeType===1&&v.cleanData(e.getElementsByTagName("*"));while(e.firstChild)e.removeChild(e.firstChild)}return this},clone:function(e,t){return e=e==null?!1:e,t=t==null?e:t,this.map(function(){return v.clone(this,e,t)})},html:function(e){return v.access(this,function(e){var n=this[0]||{},r=0,i=this.length;if(e===t)return n.nodeType===1?n.innerHTML.replace(ht,""):t;if(typeof e=="string"&&!yt.test(e)&&(v.support.htmlSerialize||!wt.test(e))&&(v.support.leadingWhitespace||!pt.test(e))&&!Nt[(vt.exec(e)||["",""])[1].toLowerCase()]){e=e.replace(dt,"<$1>");try{for(;r1&&typeof f=="string"&&St.test(f))return this.each(function(){v(this).domManip(e,n,r)});if(v.isFunction(f))return this.each(function(i){var s=v(this);e[0]=f.call(this,i,n?s.html():t),s.domManip(e,n,r)});if(this[0]){i=v.buildFragment(e,this,l),o=i.fragment,s=o.firstChild,o.childNodes.length===1&&(o=s);if(s){n=n&&v.nodeName(s,"tr");for(u=i.cacheable||c-1;a0?this.clone(!0):this).get(),v(o[i])[t](r),s=s.concat(r);return this.pushStack(s,e,o.selector)}}),v.extend({clone:function(e,t,n){var r,i,s,o;v.support.html5Clone||v.isXMLDoc(e)||!wt.test("<"+e.nodeName+">")?o=e.cloneNode(!0):(kt.innerHTML=e.outerHTML,kt.removeChild(o=kt.firstChild));if((!v.support.noCloneEvent||!v.support.noCloneChecked)&&(e.nodeType===1||e.nodeType===11)&&!v.isXMLDoc(e)){Ot(e,o),r=Mt(e),i=Mt(o);for(s=0;r[s];++s)i[s]&&Ot(r[s],i[s])}if(t){At(e,o);if(n){r=Mt(e),i=Mt(o);for(s=0;r[s];++s)At(r[s],i[s])}}return r=i=null,o},clean:function(e,t,n,r){var s,o,u,a,f,l,c,h,p,d,m,g,y=t===i&&Ct,b=[];if(!t||typeof t.createDocumentFragment=="undefined")t=i;for(s=0;(u=e[s])!=null;s++){typeof u=="number"&&(u+="");if(!u)continue;if(typeof u=="string")if(!gt.test(u))u=t.createTextNode(u);else{y=y||lt(t),c=t.createElement("div"),y.appendChild(c),u=u.replace(dt,"<$1>"),a=(vt.exec(u)||["",""])[1].toLowerCase(),f=Nt[a]||Nt._default,l=f[0],c.innerHTML=f[1]+u+f[2];while(l--)c=c.lastChild;if(!v.support.tbody){h=mt.test(u),p=a==="table"&&!h?c.firstChild&&c.firstChild.childNodes:f[1]===""&&!h?c.childNodes:[];for(o=p.length-1;o>=0;--o)v.nodeName(p[o],"tbody")&&!p[o].childNodes.length&&p[o].parentNode.removeChild(p[o])}!v.support.leadingWhitespace&&pt.test(u)&&c.insertBefore(t.createTextNode(pt.exec(u)[0]),c.firstChild),u=c.childNodes,c.parentNode.removeChild(c)}u.nodeType?b.push(u):v.merge(b,u)}c&&(u=c=y=null);if(!v.support.appendChecked)for(s=0;(u=b[s])!=null;s++)v.nodeName(u,"input")?_t(u):typeof u.getElementsByTagName!="undefined"&&v.grep(u.getElementsByTagName("input"),_t);if(n){m=function(e){if(!e.type||xt.test(e.type))return r?r.push(e.parentNode?e.parentNode.removeChild(e):e):n.appendChild(e)};for(s=0;(u=b[s])!=null;s++)if(!v.nodeName(u,"script")||!m(u))n.appendChild(u),typeof u.getElementsByTagName!="undefined"&&(g=v.grep(v.merge([],u.getElementsByTagName("script")),m),b.splice.apply(b,[s+1,0].concat(g)),s+=g.length)}return b},cleanData:function(e,t){var n,r,i,s,o=0,u=v.expando,a=v.cache,f=v.support.deleteExpando,l=v.event.special;for(;(i=e[o])!=null;o++)if(t||v.acceptData(i)){r=i[u],n=r&&a[r];if(n){if(n.events)for(s in n.events)l[s]?v.event.remove(i,s):v.removeEvent(i,s,n.handle);a[r]&&(delete a[r],f?delete i[u]:i.removeAttribute?i.removeAttribute(u):i[u]=null,v.deletedIds.push(r))}}}}),function(){var e,t;v.uaMatch=function(e){e=e.toLowerCase();var t=/(chrome)[ \/]([\w.]+)/.exec(e)||/(webkit)[ \/]([\w.]+)/.exec(e)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(e)||/(msie) ([\w.]+)/.exec(e)||e.indexOf("compatible")<0&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(e)||[];return{browser:t[1]||"",version:t[2]||"0"}},e=v.uaMatch(o.userAgent),t={},e.browser&&(t[e.browser]=!0,t.version=e.version),t.chrome?t.webkit=!0:t.webkit&&(t.safari=!0),v.browser=t,v.sub=function(){function e(t,n){return new e.fn.init(t,n)}v.extend(!0,e,this),e.superclass=this,e.fn=e.prototype=this(),e.fn.constructor=e,e.sub=this.sub,e.fn.init=function(r,i){return i&&i instanceof v&&!(i instanceof e)&&(i=e(i)),v.fn.init.call(this,r,i,t)},e.fn.init.prototype=e.fn;var t=e(i);return e}}();var Dt,Pt,Ht,Bt=/alpha\([^)]*\)/i,jt=/opacity=([^)]*)/,Ft=/^(top|right|bottom|left)$/,It=/^(none|table(?!-c[ea]).+)/,qt=/^margin/,Rt=new RegExp("^("+m+")(.*)$","i"),Ut=new RegExp("^("+m+")(?!px)[a-z%]+$","i"),zt=new RegExp("^([-+])=("+m+")","i"),Wt={BODY:"block"},Xt={position:"absolute",visibility:"hidden",display:"block"},Vt={letterSpacing:0,fontWeight:400},$t=["Top","Right","Bottom","Left"],Jt=["Webkit","O","Moz","ms"],Kt=v.fn.toggle;v.fn.extend({css:function(e,n){return v.access(this,function(e,n,r){return r!==t?v.style(e,n,r):v.css(e,n)},e,n,arguments.length>1)},show:function(){return Yt(this,!0)},hide:function(){return Yt(this)},toggle:function(e,t){var n=typeof e=="boolean";return v.isFunction(e)&&v.isFunction(t)?Kt.apply(this,arguments):this.each(function(){(n?e:Gt(this))?v(this).show():v(this).hide()})}}),v.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Dt(e,"opacity");return n===""?"1":n}}}},cssNumber:{fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":v.support.cssFloat?"cssFloat":"styleFloat"},style:function(e,n,r,i){if(!e||e.nodeType===3||e.nodeType===8||!e.style)return;var s,o,u,a=v.camelCase(n),f=e.style;n=v.cssProps[a]||(v.cssProps[a]=Qt(f,a)),u=v.cssHooks[n]||v.cssHooks[a];if(r===t)return u&&"get"in u&&(s=u.get(e,!1,i))!==t?s:f[n];o=typeof r,o==="string"&&(s=zt.exec(r))&&(r=(s[1]+1)*s[2]+parseFloat(v.css(e,n)),o="number");if(r==null||o==="number"&&isNaN(r))return;o==="number"&&!v.cssNumber[a]&&(r+="px");if(!u||!("set"in u)||(r=u.set(e,r,i))!==t)try{f[n]=r}catch(l){}},css:function(e,n,r,i){var s,o,u,a=v.camelCase(n);return n=v.cssProps[a]||(v.cssProps[a]=Qt(e.style,a)),u=v.cssHooks[n]||v.cssHooks[a],u&&"get"in u&&(s=u.get(e,!0,i)),s===t&&(s=Dt(e,n)),s==="normal"&&n in Vt&&(s=Vt[n]),r||i!==t?(o=parseFloat(s),r||v.isNumeric(o)?o||0:s):s},swap:function(e,t,n){var r,i,s={};for(i in t)s[i]=e.style[i],e.style[i]=t[i];r=n.call(e);for(i in t)e.style[i]=s[i];return r}}),e.getComputedStyle?Dt=function(t,n){var r,i,s,o,u=e.getComputedStyle(t,null),a=t.style;return u&&(r=u.getPropertyValue(n)||u[n],r===""&&!v.contains(t.ownerDocument,t)&&(r=v.style(t,n)),Ut.test(r)&&qt.test(n)&&(i=a.width,s=a.minWidth,o=a.maxWidth,a.minWidth=a.maxWidth=a.width=r,r=u.width,a.width=i,a.minWidth=s,a.maxWidth=o)),r}:i.documentElement.currentStyle&&(Dt=function(e,t){var n,r,i=e.currentStyle&&e.currentStyle[t],s=e.style;return i==null&&s&&s[t]&&(i=s[t]),Ut.test(i)&&!Ft.test(t)&&(n=s.left,r=e.runtimeStyle&&e.runtimeStyle.left,r&&(e.runtimeStyle.left=e.currentStyle.left),s.left=t==="fontSize"?"1em":i,i=s.pixelLeft+"px",s.left=n,r&&(e.runtimeStyle.left=r)),i===""?"auto":i}),v.each(["height","width"],function(e,t){v.cssHooks[t]={get:function(e,n,r){if(n)return e.offsetWidth===0&&It.test(Dt(e,"display"))?v.swap(e,Xt,function(){return tn(e,t,r)}):tn(e,t,r)},set:function(e,n,r){return Zt(e,n,r?en(e,t,r,v.support.boxSizing&&v.css(e,"boxSizing")==="border-box"):0)}}}),v.support.opacity||(v.cssHooks.opacity={get:function(e,t){return jt.test((t&&e.currentStyle?e.currentStyle.filter:e.style.filter)||"")?.01*parseFloat(RegExp.$1)+"":t?"1":""},set:function(e,t){var n=e.style,r=e.currentStyle,i=v.isNumeric(t)?"alpha(opacity="+t*100+")":"",s=r&&r.filter||n.filter||"";n.zoom=1;if(t>=1&&v.trim(s.replace(Bt,""))===""&&n.removeAttribute){n.removeAttribute("filter");if(r&&!r.filter)return}n.filter=Bt.test(s)?s.replace(Bt,i):s+" "+i}}),v(function(){v.support.reliableMarginRight||(v.cssHooks.marginRight={get:function(e,t){return v.swap(e,{display:"inline-block"},function(){if(t)return Dt(e,"marginRight")})}}),!v.support.pixelPosition&&v.fn.position&&v.each(["top","left"],function(e,t){v.cssHooks[t]={get:function(e,n){if(n){var r=Dt(e,t);return Ut.test(r)?v(e).position()[t]+"px":r}}}})}),v.expr&&v.expr.filters&&(v.expr.filters.hidden=function(e){return e.offsetWidth===0&&e.offsetHeight===0||!v.support.reliableHiddenOffsets&&(e.style&&e.style.display||Dt(e,"display"))==="none"},v.expr.filters.visible=function(e){return!v.expr.filters.hidden(e)}),v.each({margin:"",padding:"",border:"Width"},function(e,t){v.cssHooks[e+t]={expand:function(n){var r,i=typeof n=="string"?n.split(" "):[n],s={};for(r=0;r<4;r++)s[e+$t[r]+t]=i[r]||i[r-2]||i[0];return s}},qt.test(e)||(v.cssHooks[e+t].set=Zt)});var rn=/%20/g,sn=/\[\]$/,on=/\r?\n/g,un=/^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,an=/^(?:select|textarea)/i;v.fn.extend({serialize:function(){return v.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?v.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||an.test(this.nodeName)||un.test(this.type))}).map(function(e,t){var n=v(this).val();return n==null?null:v.isArray(n)?v.map(n,function(e,n){return{name:t.name,value:e.replace(on,"\r\n")}}):{name:t.name,value:n.replace(on,"\r\n")}}).get()}}),v.param=function(e,n){var r,i=[],s=function(e,t){t=v.isFunction(t)?t():t==null?"":t,i[i.length]=encodeURIComponent(e)+"="+encodeURIComponent(t)};n===t&&(n=v.ajaxSettings&&v.ajaxSettings.traditional);if(v.isArray(e)||e.jquery&&!v.isPlainObject(e))v.each(e,function(){s(this.name,this.value)});else for(r in e)fn(r,e[r],n,s);return i.join("&").replace(rn,"+")};var ln,cn,hn=/#.*$/,pn=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,dn=/^(?:about|app|app\-storage|.+\-extension|file|res|widget):$/,vn=/^(?:GET|HEAD)$/,mn=/^\/\//,gn=/\?/,yn=/)<[^<]*)*<\/script>/gi,bn=/([?&])_=[^&]*/,wn=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+)|)|)/,En=v.fn.load,Sn={},xn={},Tn=["*/"]+["*"];try{cn=s.href}catch(Nn){cn=i.createElement("a"),cn.href="",cn=cn.href}ln=wn.exec(cn.toLowerCase())||[],v.fn.load=function(e,n,r){if(typeof e!="string"&&En)return En.apply(this,arguments);if(!this.length)return this;var i,s,o,u=this,a=e.indexOf(" ");return a>=0&&(i=e.slice(a,e.length),e=e.slice(0,a)),v.isFunction(n)?(r=n,n=t):n&&typeof n=="object"&&(s="POST"),v.ajax({url:e,type:s,dataType:"html",data:n,complete:function(e,t){r&&u.each(r,o||[e.responseText,t,e])}}).done(function(e){o=arguments,u.html(i?v("
").append(e.replace(yn,"")).find(i):e)}),this},v.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(e,t){v.fn[t]=function(e){return this.on(t,e)}}),v.each(["get","post"],function(e,n){v[n]=function(e,r,i,s){return v.isFunction(r)&&(s=s||i,i=r,r=t),v.ajax({type:n,url:e,data:r,success:i,dataType:s})}}),v.extend({getScript:function(e,n){return v.get(e,t,n,"script")},getJSON:function(e,t,n){return v.get(e,t,n,"json")},ajaxSetup:function(e,t){return t?Ln(e,v.ajaxSettings):(t=e,e=v.ajaxSettings),Ln(e,t),e},ajaxSettings:{url:cn,isLocal:dn.test(ln[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded; charset=UTF-8",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":Tn},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":e.String,"text html":!0,"text json":v.parseJSON,"text xml":v.parseXML},flatOptions:{context:!0,url:!0}},ajaxPrefilter:Cn(Sn),ajaxTransport:Cn(xn),ajax:function(e,n){function T(e,n,s,a){var l,y,b,w,S,T=n;if(E===2)return;E=2,u&&clearTimeout(u),o=t,i=a||"",x.readyState=e>0?4:0,s&&(w=An(c,x,s));if(e>=200&&e<300||e===304)c.ifModified&&(S=x.getResponseHeader("Last-Modified"),S&&(v.lastModified[r]=S),S=x.getResponseHeader("Etag"),S&&(v.etag[r]=S)),e===304?(T="notmodified",l=!0):(l=On(c,w),T=l.state,y=l.data,b=l.error,l=!b);else{b=T;if(!T||e)T="error",e<0&&(e=0)}x.status=e,x.statusText=(n||T)+"",l?d.resolveWith(h,[y,T,x]):d.rejectWith(h,[x,T,b]),x.statusCode(g),g=t,f&&p.trigger("ajax"+(l?"Success":"Error"),[x,c,l?y:b]),m.fireWith(h,[x,T]),f&&(p.trigger("ajaxComplete",[x,c]),--v.active||v.event.trigger("ajaxStop"))}typeof e=="object"&&(n=e,e=t),n=n||{};var r,i,s,o,u,a,f,l,c=v.ajaxSetup({},n),h=c.context||c,p=h!==c&&(h.nodeType||h instanceof v)?v(h):v.event,d=v.Deferred(),m=v.Callbacks("once memory"),g=c.statusCode||{},b={},w={},E=0,S="canceled",x={readyState:0,setRequestHeader:function(e,t){if(!E){var n=e.toLowerCase();e=w[n]=w[n]||e,b[e]=t}return this},getAllResponseHeaders:function(){return E===2?i:null},getResponseHeader:function(e){var n;if(E===2){if(!s){s={};while(n=pn.exec(i))s[n[1].toLowerCase()]=n[2]}n=s[e.toLowerCase()]}return n===t?null:n},overrideMimeType:function(e){return E||(c.mimeType=e),this},abort:function(e){return e=e||S,o&&o.abort(e),T(0,e),this}};d.promise(x),x.success=x.done,x.error=x.fail,x.complete=m.add,x.statusCode=function(e){if(e){var t;if(E<2)for(t in e)g[t]=[g[t],e[t]];else t=e[x.status],x.always(t)}return this},c.url=((e||c.url)+"").replace(hn,"").replace(mn,ln[1]+"//"),c.dataTypes=v.trim(c.dataType||"*").toLowerCase().split(y),c.crossDomain==null&&(a=wn.exec(c.url.toLowerCase()),c.crossDomain=!(!a||a[1]===ln[1]&&a[2]===ln[2]&&(a[3]||(a[1]==="http:"?80:443))==(ln[3]||(ln[1]==="http:"?80:443)))),c.data&&c.processData&&typeof c.data!="string"&&(c.data=v.param(c.data,c.traditional)),kn(Sn,c,n,x);if(E===2)return x;f=c.global,c.type=c.type.toUpperCase(),c.hasContent=!vn.test(c.type),f&&v.active++===0&&v.event.trigger("ajaxStart");if(!c.hasContent){c.data&&(c.url+=(gn.test(c.url)?"&":"?")+c.data,delete c.data),r=c.url;if(c.cache===!1){var N=v.now(),C=c.url.replace(bn,"$1_="+N);c.url=C+(C===c.url?(gn.test(c.url)?"&":"?")+"_="+N:"")}}(c.data&&c.hasContent&&c.contentType!==!1||n.contentType)&&x.setRequestHeader("Content-Type",c.contentType),c.ifModified&&(r=r||c.url,v.lastModified[r]&&x.setRequestHeader("If-Modified-Since",v.lastModified[r]),v.etag[r]&&x.setRequestHeader("If-None-Match",v.etag[r])),x.setRequestHeader("Accept",c.dataTypes[0]&&c.accepts[c.dataTypes[0]]?c.accepts[c.dataTypes[0]]+(c.dataTypes[0]!=="*"?", "+Tn+"; q=0.01":""):c.accepts["*"]);for(l in c.headers)x.setRequestHeader(l,c.headers[l]);if(!c.beforeSend||c.beforeSend.call(h,x,c)!==!1&&E!==2){S="abort";for(l in{success:1,error:1,complete:1})x[l](c[l]);o=kn(xn,c,n,x);if(!o)T(-1,"No Transport");else{x.readyState=1,f&&p.trigger("ajaxSend",[x,c]),c.async&&c.timeout>0&&(u=setTimeout(function(){x.abort("timeout")},c.timeout));try{E=1,o.send(b,T)}catch(k){if(!(E<2))throw k;T(-1,k)}}return x}return x.abort()},active:0,lastModified:{},etag:{}});var Mn=[],_n=/\?/,Dn=/(=)\?(?=&|$)|\?\?/,Pn=v.now();v.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Mn.pop()||v.expando+"_"+Pn++;return this[e]=!0,e}}),v.ajaxPrefilter("json jsonp",function(n,r,i){var s,o,u,a=n.data,f=n.url,l=n.jsonp!==!1,c=l&&Dn.test(f),h=l&&!c&&typeof a=="string"&&!(n.contentType||"").indexOf("application/x-www-form-urlencoded")&&Dn.test(a);if(n.dataTypes[0]==="jsonp"||c||h)return s=n.jsonpCallback=v.isFunction(n.jsonpCallback)?n.jsonpCallback():n.jsonpCallback,o=e[s],c?n.url=f.replace(Dn,"$1"+s):h?n.data=a.replace(Dn,"$1"+s):l&&(n.url+=(_n.test(f)?"&":"?")+n.jsonp+"="+s),n.converters["script json"]=function(){return u||v.error(s+" was not called"),u[0]},n.dataTypes[0]="json",e[s]=function(){u=arguments},i.always(function(){e[s]=o,n[s]&&(n.jsonpCallback=r.jsonpCallback,Mn.push(s)),u&&v.isFunction(o)&&o(u[0]),u=o=t}),"script"}),v.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(e){return v.globalEval(e),e}}}),v.ajaxPrefilter("script",function(e){e.cache===t&&(e.cache=!1),e.crossDomain&&(e.type="GET",e.global=!1)}),v.ajaxTransport("script",function(e){if(e.crossDomain){var n,r=i.head||i.getElementsByTagName("head")[0]||i.documentElement;return{send:function(s,o){n=i.createElement("script"),n.async="async",e.scriptCharset&&(n.charset=e.scriptCharset),n.src=e.url,n.onload=n.onreadystatechange=function(e,i){if(i||!n.readyState||/loaded|complete/.test(n.readyState))n.onload=n.onreadystatechange=null,r&&n.parentNode&&r.removeChild(n),n=t,i||o(200,"success")},r.insertBefore(n,r.firstChild)},abort:function(){n&&n.onload(0,1)}}}});var Hn,Bn=e.ActiveXObject?function(){for(var e in Hn)Hn[e](0,1)}:!1,jn=0;v.ajaxSettings.xhr=e.ActiveXObject?function(){return!this.isLocal&&Fn()||In()}:Fn,function(e){v.extend(v.support,{ajax:!!e,cors:!!e&&"withCredentials"in e})}(v.ajaxSettings.xhr()),v.support.ajax&&v.ajaxTransport(function(n){if(!n.crossDomain||v.support.cors){var r;return{send:function(i,s){var o,u,a=n.xhr();n.username?a.open(n.type,n.url,n.async,n.username,n.password):a.open(n.type,n.url,n.async);if(n.xhrFields)for(u in n.xhrFields)a[u]=n.xhrFields[u];n.mimeType&&a.overrideMimeType&&a.overrideMimeType(n.mimeType),!n.crossDomain&&!i["X-Requested-With"]&&(i["X-Requested-With"]="XMLHttpRequest");try{for(u in i)a.setRequestHeader(u,i[u])}catch(f){}a.send(n.hasContent&&n.data||null),r=function(e,i){var u,f,l,c,h;try{if(r&&(i||a.readyState===4)){r=t,o&&(a.onreadystatechange=v.noop,Bn&&delete Hn[o]);if(i)a.readyState!==4&&a.abort();else{u=a.status,l=a.getAllResponseHeaders(),c={},h=a.responseXML,h&&h.documentElement&&(c.xml=h);try{c.text=a.responseText}catch(p){}try{f=a.statusText}catch(p){f=""}!u&&n.isLocal&&!n.crossDomain?u=c.text?200:404:u===1223&&(u=204)}}}catch(d){i||s(-1,d)}c&&s(u,f,c,l)},n.async?a.readyState===4?setTimeout(r,0):(o=++jn,Bn&&(Hn||(Hn={},v(e).unload(Bn)),Hn[o]=r),a.onreadystatechange=r):r()},abort:function(){r&&r(0,1)}}}});var qn,Rn,Un=/^(?:toggle|show|hide)$/,zn=new RegExp("^(?:([-+])=|)("+m+")([a-z%]*)$","i"),Wn=/queueHooks$/,Xn=[Gn],Vn={"*":[function(e,t){var n,r,i=this.createTween(e,t),s=zn.exec(t),o=i.cur(),u=+o||0,a=1,f=20;if(s){n=+s[2],r=s[3]||(v.cssNumber[e]?"":"px");if(r!=="px"&&u){u=v.css(i.elem,e,!0)||n||1;do a=a||".5",u/=a,v.style(i.elem,e,u+r);while(a!==(a=i.cur()/o)&&a!==1&&--f)}i.unit=r,i.start=u,i.end=s[1]?u+(s[1]+1)*n:n}return i}]};v.Animation=v.extend(Kn,{tweener:function(e,t){v.isFunction(e)?(t=e,e=["*"]):e=e.split(" ");var n,r=0,i=e.length;for(;r-1,f={},l={},c,h;a?(l=i.position(),c=l.top,h=l.left):(c=parseFloat(o)||0,h=parseFloat(u)||0),v.isFunction(t)&&(t=t.call(e,n,s)),t.top!=null&&(f.top=t.top-s.top+c),t.left!=null&&(f.left=t.left-s.left+h),"using"in t?t.using.call(e,f):i.css(f)}},v.fn.extend({position:function(){if(!this[0])return;var e=this[0],t=this.offsetParent(),n=this.offset(),r=er.test(t[0].nodeName)?{top:0,left:0}:t.offset();return n.top-=parseFloat(v.css(e,"marginTop"))||0,n.left-=parseFloat(v.css(e,"marginLeft"))||0,r.top+=parseFloat(v.css(t[0],"borderTopWidth"))||0,r.left+=parseFloat(v.css(t[0],"borderLeftWidth"))||0,{top:n.top-r.top,left:n.left-r.left}},offsetParent:function(){return this.map(function(){var e=this.offsetParent||i.body;while(e&&!er.test(e.nodeName)&&v.css(e,"position")==="static")e=e.offsetParent;return e||i.body})}}),v.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(e,n){var r=/Y/.test(n);v.fn[e]=function(i){return v.access(this,function(e,i,s){var o=tr(e);if(s===t)return o?n in o?o[n]:o.document.documentElement[i]:e[i];o?o.scrollTo(r?v(o).scrollLeft():s,r?s:v(o).scrollTop()):e[i]=s},e,i,arguments.length,null)}}),v.each({Height:"height",Width:"width"},function(e,n){v.each({padding:"inner"+e,content:n,"":"outer"+e},function(r,i){v.fn[i]=function(i,s){var o=arguments.length&&(r||typeof i!="boolean"),u=r||(i===!0||s===!0?"margin":"border");return v.access(this,function(n,r,i){var s;return v.isWindow(n)?n.document.documentElement["client"+e]:n.nodeType===9?(s=n.documentElement,Math.max(n.body["scroll"+e],s["scroll"+e],n.body["offset"+e],s["offset"+e],s["client"+e])):i===t?v.css(n,r,i,u):v.style(n,r,i,u)},n,o?i:t,o,null)}})}),e.jQuery=e.$=v,typeof define=="function"&&define.amd&&define.amd.jQuery&&define("jquery",[],function(){return v})})(window); \ No newline at end of file diff --git a/python/macholib/doc/_build/html/_static/minus.png b/python/macholib/doc/_build/html/_static/minus.png new file mode 100644 index 000000000..da1c5620d Binary files /dev/null and b/python/macholib/doc/_build/html/_static/minus.png differ diff --git a/python/macholib/doc/_build/html/_static/nature.css b/python/macholib/doc/_build/html/_static/nature.css new file mode 100644 index 000000000..f46081870 --- /dev/null +++ b/python/macholib/doc/_build/html/_static/nature.css @@ -0,0 +1,245 @@ +/* + * nature.css_t + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- nature theme. + * + * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Arial, sans-serif; + font-size: 100%; + background-color: #111; + color: #555; + margin: 0; + padding: 0; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 230px; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.document { + background-color: #eee; +} + +div.body { + background-color: #ffffff; + color: #3E4349; + padding: 0 30px 30px 30px; + font-size: 0.9em; +} + +div.footer { + color: #555; + width: 100%; + padding: 13px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #444; + text-decoration: underline; +} + +div.related { + background-color: #6BA81E; + line-height: 32px; + color: #fff; + text-shadow: 0px 1px 0 #444; + font-size: 0.9em; +} + +div.related a { + color: #E2F3CC; +} + +div.sphinxsidebar { + font-size: 0.75em; + line-height: 1.5em; +} + +div.sphinxsidebarwrapper{ + padding: 20px 0; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Arial, sans-serif; + color: #222; + font-size: 1.2em; + font-weight: normal; + margin: 0; + padding: 5px 10px; + background-color: #ddd; + text-shadow: 1px 1px 0 white +} + +div.sphinxsidebar h4{ + font-size: 1.1em; +} + +div.sphinxsidebar h3 a { + color: #444; +} + + +div.sphinxsidebar p { + color: #888; + padding: 5px 20px; +} + +div.sphinxsidebar p.topless { +} + +div.sphinxsidebar ul { + margin: 10px 20px; + padding: 0; + color: #000; +} + +div.sphinxsidebar a { + color: #444; +} + +div.sphinxsidebar input { + border: 1px solid #ccc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar input[type=text]{ + margin-left: 20px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #005B81; + text-decoration: none; +} + +a:hover { + color: #E32E00; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Arial, sans-serif; + background-color: #BED4EB; + font-weight: normal; + color: #212224; + margin: 30px 0px 10px 0px; + padding: 5px 0 5px 10px; + text-shadow: 0px 1px 0 white +} + +div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 150%; background-color: #C8D5E3; } +div.body h3 { font-size: 120%; background-color: #D8DEE3; } +div.body h4 { font-size: 110%; background-color: #D8DEE3; } +div.body h5 { font-size: 100%; background-color: #D8DEE3; } +div.body h6 { font-size: 100%; background-color: #D8DEE3; } + +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li { + line-height: 1.5em; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.highlight{ + background-color: white; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + padding: 10px; + background-color: White; + color: #222; + line-height: 1.2em; + border: 1px solid #C6C9CB; + font-size: 1.1em; + margin: 1.5em 0 1.5em 0; + -webkit-box-shadow: 1px 1px 1px #d8d8d8; + -moz-box-shadow: 1px 1px 1px #d8d8d8; +} + +tt { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ + font-size: 1.1em; + font-family: monospace; +} + +.viewcode-back { + font-family: Arial, sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} \ No newline at end of file diff --git a/python/macholib/doc/_build/html/_static/plus.png b/python/macholib/doc/_build/html/_static/plus.png new file mode 100644 index 000000000..b3cb37425 Binary files /dev/null and b/python/macholib/doc/_build/html/_static/plus.png differ diff --git a/python/macholib/doc/_build/html/_static/pygments.css b/python/macholib/doc/_build/html/_static/pygments.css new file mode 100644 index 000000000..d79caa151 --- /dev/null +++ b/python/macholib/doc/_build/html/_static/pygments.css @@ -0,0 +1,62 @@ +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #333333 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/python/macholib/doc/_build/html/_static/searchtools.js b/python/macholib/doc/_build/html/_static/searchtools.js new file mode 100644 index 000000000..f5c7e5fee --- /dev/null +++ b/python/macholib/doc/_build/html/_static/searchtools.js @@ -0,0 +1,622 @@ +/* + * searchtools.js_t + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilties for the full-text search. + * + * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + + +/** + * Simple result scoring code. + */ +var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [filename, title, anchor, descr, score] + // and returns the new score. + /* + score: function(result) { + return result[4]; + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: {0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5}, // used to be unimportantResults + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + // query found in terms + term: 5 +}; + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + loadIndex : function(url) { + $.ajax({type: "GET", url: url, data: null, + dataType: "script", cache: true, + complete: function(jqxhr, textstatus) { + if (textstatus != "success") { + document.getElementById("searchindexloader").src = url; + } + }}); + }, + + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + var i; + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + } + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

' + _('Searching') + '

').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

').appendTo(this.out); + this.output = $('
'); + } + // Prettify the comment rating. + comment.pretty_rating = comment.rating + ' point' + + (comment.rating == 1 ? '' : 's'); + // Make a class (for displaying not yet moderated comments differently) + comment.css_class = comment.displayed ? '' : ' moderate'; + // Create a div for this comment. + var context = $.extend({}, opts, comment); + var div = $(renderTemplate(commentTemplate, context)); + + // If the user has voted on this comment, highlight the correct arrow. + if (comment.vote) { + var direction = (comment.vote == 1) ? 'u' : 'd'; + div.find('#' + direction + 'v' + comment.id).hide(); + div.find('#' + direction + 'u' + comment.id).show(); + } + + if (opts.moderator || comment.text != '[deleted]') { + div.find('a.reply').show(); + if (comment.proposal_diff) + div.find('#sp' + comment.id).show(); + if (opts.moderator && !comment.displayed) + div.find('#cm' + comment.id).show(); + if (opts.moderator || (opts.username == comment.username)) + div.find('#dc' + comment.id).show(); + } + return div; + } + + /** + * A simple template renderer. Placeholders such as <%id%> are replaced + * by context['id'] with items being escaped. Placeholders such as <#id#> + * are not escaped. + */ + function renderTemplate(template, context) { + var esc = $(document.createElement('div')); + + function handle(ph, escape) { + var cur = context; + $.each(ph.split('.'), function() { + cur = cur[this]; + }); + return escape ? esc.text(cur || "").html() : cur; + } + + return template.replace(/<([%#])([\w\.]*)\1>/g, function() { + return handle(arguments[2], arguments[1] == '%' ? true : false); + }); + } + + /** Flash an error message briefly. */ + function showError(message) { + $(document.createElement('div')).attr({'class': 'popup-error'}) + .append($(document.createElement('div')) + .attr({'class': 'error-message'}).text(message)) + .appendTo('body') + .fadeIn("slow") + .delay(2000) + .fadeOut("slow"); + } + + /** Add a link the user uses to open the comments popup. */ + $.fn.comment = function() { + return this.each(function() { + var id = $(this).attr('id').substring(1); + var count = COMMENT_METADATA[id]; + var title = count + ' comment' + (count == 1 ? '' : 's'); + var image = count > 0 ? opts.commentBrightImage : opts.commentImage; + var addcls = count == 0 ? ' nocomment' : ''; + $(this) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-open' + addcls, + id: 'ao' + id + }) + .append($(document.createElement('img')).attr({ + src: image, + alt: 'comment', + title: title + })) + .click(function(event) { + event.preventDefault(); + show($(this).attr('id').substring(2)); + }) + ) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-close hidden', + id: 'ah' + id + }) + .append($(document.createElement('img')).attr({ + src: opts.closeCommentImage, + alt: 'close', + title: 'close' + })) + .click(function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }) + ); + }); + }; + + var opts = { + processVoteURL: '/_process_vote', + addCommentURL: '/_add_comment', + getCommentsURL: '/_get_comments', + acceptCommentURL: '/_accept_comment', + deleteCommentURL: '/_delete_comment', + commentImage: '/static/_static/comment.png', + closeCommentImage: '/static/_static/comment-close.png', + loadingImage: '/static/_static/ajax-loader.gif', + commentBrightImage: '/static/_static/comment-bright.png', + upArrow: '/static/_static/up.png', + downArrow: '/static/_static/down.png', + upArrowPressed: '/static/_static/up-pressed.png', + downArrowPressed: '/static/_static/down-pressed.png', + voting: false, + moderator: false + }; + + if (typeof COMMENT_OPTIONS != "undefined") { + opts = jQuery.extend(opts, COMMENT_OPTIONS); + } + + var popupTemplate = '\ +
\ +

\ + Sort by:\ + best rated\ + newest\ + oldest\ +

\ +
Comments
\ +
\ + loading comments...
\ +
    \ +
    \ +

    Add a comment\ + (markup):

    \ +
    \ + reStructured text markup: *emph*, **strong**, \ + ``code``, \ + code blocks: :: and an indented block after blank line
    \ +
    \ + \ +

    \ + \ + Propose a change ▹\ + \ + \ + Propose a change ▿\ + \ +

    \ + \ + \ + \ + \ + \ +
    \ +
    '; + + var commentTemplate = '\ +
    \ +
    \ +
    \ + \ + \ + \ + \ + \ + \ +
    \ +
    \ + \ + \ + \ + \ + \ + \ +
    \ +
    \ +
    \ +

    \ + <%username%>\ + <%pretty_rating%>\ + <%time.delta%>\ +

    \ +
    <#text#>
    \ +

    \ + \ + reply ▿\ + proposal ▹\ + proposal ▿\ + \ + \ +

    \ +
    \
    +<#proposal_diff#>\
    +        
    \ +
      \ +
      \ +
      \ +
      \ + '; + + var replyTemplate = '\ +
    • \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
    • '; + + $(document).ready(function() { + init(); + }); +})(jQuery); + +$(document).ready(function() { + // add comment anchors for all paragraphs that are commentable + $('.sphinx-has-comment').comment(); + + // highlight search words in search results + $("div.context").each(function() { + var params = $.getQueryParameters(); + var terms = (params.q) ? params.q[0].split(/\s+/) : []; + var result = $(this); + $.each(terms, function() { + result.highlightText(this.toLowerCase(), 'highlighted'); + }); + }); + + // directly open comment window if requested + var anchor = document.location.hash; + if (anchor.substring(0, 9) == '#comment-') { + $('#ao' + anchor.substring(9)).click(); + document.location.hash = '#s' + anchor.substring(9); + } +}); diff --git a/python/macholib/doc/_build/html/changelog.html b/python/macholib/doc/_build/html/changelog.html new file mode 100644 index 000000000..6cf3dbcde --- /dev/null +++ b/python/macholib/doc/_build/html/changelog.html @@ -0,0 +1,385 @@ + + + + + + + + Release history — macholib 1.7 documentation + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      Release history

      +
      +

      macholib 1.7

      +
        +
      • Added support for ARM64, LC_ENCRYPTION_INFO_64 and LC_LINKER_OPTION

        +

        Patch by Matthias Ringwald.

        +
      • +
      • Load commands now have a “describe” method that returns more information +about the command.

        +

        Patch by David Dorsey.

        +
      • +
      • The MAGIC value in the header was always represented in the native +byte order, instead of as the value read from the binary.

        +

        Patch by David Dorsey.

        +
      • +
      • Added various new constants to “macholib.mach_o”.

        +

        Patch by David Dorsey.

        +
      • +
      +
      +
      +

      macholib 1.6.1

      +
        +
      • ?
      • +
      +
      +
      +

      macholib 1.6

      +
        +
      • Add support for '@loader_path‘ link command in +macholib.dyld:

        +
          +
        • Added function macholib.dyld.dyld_loader_search
        • +
        • This function is used by macholib.dyld.dyld_find, +and that function now has an new (optional) argument +with the path to the loader.
        • +
        +
      • +
      • Also add support for '@loader_path‘ to macholib.MachoGraph, +using the newly added '@loader_path‘ support in the +dyld module.

        +

        Due to this suppport the macho_standalone tool can +now rewrite binaries that contain an '@loader_path‘ load +command.

        +
      • +
      +
      +
      +

      macholib 1.5.2

      +
        +
      • Issue #93: Show the name of the affected file in the exception message +for Mach-O headers that are too large to relocate.
      • +
      +
      +
      +

      macholib 1.5.1

      +
        +
      • There were no ‘classifiers’ in the package metadata due to +a bug in setup.py.
      • +
      +
      +
      +

      macholib 1.5

      +

      macholib 1.5 is a minor feature release

      +
        +
      • No longer use 2to3 to provide Python 3 support

        +

        As a side-effect of this macholib no longer supports +Python 2.5 and earlier.

        +
      • +
      • Adds suppport for some new macho load commands

        +
      • +
      • Fix for py3k problem in macho_standalone.py

        +

        Patch by Guanqun Lu.

        +
      • +
      • Fix for some issues in macho_dump.py

        +

        Patch by Nam Nguyen

        +
      • +
      • Issue #10: Fix for LC_DATA_IN_CODE linker commands, without +this fix py2app cannot build application bundles when +the source binaries have been compiled with Xcode 4.5.

        +
      • +
      • Issue #6: Fix for LC_ENCRYPTION_INFO linker commands

        +
      • +
      • Use the mach header information to print the cpu type of a +binary, instead of trying to deduce that from pointer width +and endianness.

        +

        Changed the code because of issue #6, in which a user tries to +dump a iOS binary which results in bogus output in the previous +releases.

        +
      • +
      • The mapping macholib.macho_dump.ARCH_MAP is undocumented +and no longer used by macholib itself. It will be removed +in the next release.

        +
      • +
      • The command-line tools macho_find, macho_dump and +macho_standalone are deprecated. Use “python -mmacholib” +instead. That is:

        +
        $ python -mmacholib dump /usr/bin/grep
        +
        +$ python -mmacholib find ~
        +
        +$ python -mmacholib standalone myapp.app
        +
        +
        +

        This makes it clearer which version of the tools are used.

        +
      • +
      +
      +
      +

      macholib 1.4.3

      +

      macholib 1.4.3 is a minor feature release

      +
        +
      • Added strings for ‘x86_64’ and ‘ppc64’ to +macholib.mach_o.CPU_TYPE_NAMES.

        +
      • +
      • macho_find and macho_dump were broken in the 1.4.2 release

        +
      • +
      • added ‘macholib.util.NOT_SYSTEM_FILES’, a list of +files that aren’t system path’s even though they are +located in system locations.

        +

        Needed to work around a bug in PySide (see issue #32 in the +py2app tracker)

        +
      • +
      +
      +
      +

      macholib 1.4.2

      +

      macholib 1.4.2 is a minor bugfix release

      +
        +
      • The support for new load commands that was added in 1.4.1 +contained a typo that caused problems on OSX 10.7 (Lion).
      • +
      +
      +
      +

      macholib 1.4.1

      +

      macholib 1.4.1 is a minor feature release

      +

      Features:

      +
        +
      • Add support for a number of new MachO load commands that were added +during the lifetime of OSX 10.6: LC_LOAD_UPWARD_DYLIB, +LC_VERSION_MIN_MACOSX, LC_VERSION_MIN_IPHONEOS and +LC_FUNCTION_STARTS.
      • +
      +
      +
      +

      macholib 1.4

      +

      macholib 1.4 is a feature release

      +

      Features:

      +
        +
      • Documentation is now generated using sphinx +and can be viewed at <http://packages.python.org/macholib>.

        +
      • +
      • The repository has moved to bitbucket

        +
      • +
      • There now is a testsuite

        +
      • +
      • Private functionality inside modules was renamed to +a name starting with an underscore.

        +
        +

        Note

        +

        if this change affects your code you are relying on undefined +implementation features, please stop using private functions.

        +
        +
      • +
      • The basic packable types in macholib.ptypes were renamed to better +represent the corresponding C type. The table below lists the old +an new names (the old names are still available, but are deprecated and +will be removed in a future release).

        +
      ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Old nameNew name
      p_bytep_int8
      p_ubytep_uint8
      p_shortp_int16
      p_ushortp_uint16
      p_intp_int32
      p_uintp_uint32
      p_longp_int32
      p_ulongp_uint32
      p_longlongp_int64
      p_ulonglongp_uint64
      +

      Macholib.ptypes.p_ptr is no longer present as it had an unclear +definition and isn’t actually used in the codebase.

      + + +

      Bug fixes:

      +
        +
      • The semantics of dyld.dyld_default_search were changed a bit, +it now first searches the framework path (if appropriate) and then +the linker path, irrespective of the value of the DYLD_FALLBACK* +environment variables.

        +

        Previous versions would change the search order when those variables +was set, which is odd and doesn’t correspond with the documented +behaviour of the system dyld.

        +
      • +
      • It is once again possible to install using python2.5

        +
      • +
      • The source distribution includes all files, this was broken +due to the switch to mercurial (which confused setuptools)

        +
      • +
      + +
      +

      macholib 1.3

      +

      macholib 1.3 is a feature release.

      +

      Features:

      +
        +
      • Experimental Python 3.x support

        +

        This version contains lightly tested support for Python 3.

        +
      • +
      +
      +
      +

      macholib 1.2.2

      +

      macholib 1.2.2 is a bugfix release.

      +

      Bug fixes:

      +
        +
      • Macholib should work better with 64-bit code +(patch by Marc-Antoine Parent)
      • +
      +
      + + + + + + +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      Macholib - Analyze and edit Mach-O headers

      +

      Next topic

      +

      License

      +

      This Page

      + + + +
      +
      +
      + + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/dyld.html b/python/macholib/doc/_build/html/dyld.html new file mode 100644 index 000000000..ad8555058 --- /dev/null +++ b/python/macholib/doc/_build/html/dyld.html @@ -0,0 +1,267 @@ + + + + + + + + macholib.dyld — Dyld emulation — macholib 1.7 documentation + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      macholib.dyld — Dyld emulation

      +

      This module defines a number of functions that can be used +to emulate the functionality of the dynamic linker (dyld) +w.r.t. looking for library files and framworks.

      +
      +
      +macholib.dyld.dyld_image_suffix([env])
      +

      Looks up the suffix to append to shared library and +framework names and returns this value when found. +Returns None when no suffix should be appended.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +

      See the description of DYLD_IMAGE_SUFFIX in the +manual page for dyld(1) for more information.

      +
      + +
      +
      +macholib.dyld.dydl_framework_path([env])
      +

      Returns a user-specified framework search path, +or an empty list when only the default search path +should be used.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +

      See the description of DYLD_FRAMEWORK_PATH in the +manual page for dyld(1) for more information.

      +
      + +
      +
      +macholib.dyld.dyld_library_path([env])
      +

      Returns a user-specified library search path, +or an empty list when only the default search path +should be used.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +

      See the description of DYLD_LIBRARY_PATH in the +manual page for dyld(1) for more information.

      +
      + +
      +
      +macholib.dyld.dyld_fallback_framework_path([env])
      +

      Return a user specified list of of directories where +to look for frameworks that aren’t in their install path, +or an empty list when the default fallback path should +be used.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +

      See the description of DYLD_FALLBACK_FRAMEWORK_PATH in the +manual page for dyld(1) for more information.

      +
      + +
      +
      +macholib.dyld.dyld_fallback_library_path([env])
      +

      Return a user specified list of of directories where +to look for libraries that aren’t in their install path, +or an empty list when the default fallback path should +be used.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +

      See the description of DYLD_FALLBACK_LIBRARY_PATH in the +manual page for dyld(1) for more information.

      +
      + +
      + +

      Yields all items in iterator, and prepents names +with the image suffix to those items when the suffix +is specified.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +
      + +
      + +

      If name is a framework name yield filesystem +paths relative to the entries in the framework +search path.

      +

      Always yield the filesystem paths relative to the +entries in the library search path.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +
      + +
      + +

      If name is a path starting with @executable_path/ yield +the path relative to the specified executable_path.

      +

      If executable_path is None nothing is yielded.

      +
      + +
      + +

      If name is a path starting with @loader_path/ yield +the path relative to the specified loader_path.

      +

      If loader_path is None nothing is yielded.

      +
      + +
      + +

      Yield the filesystem locations to look for a dynamic +library or framework using the default locations +used by the system dynamic linker.

      +

      This function will look in ~/Library/Frameworks +for frameworks, even though the system dynamic linker +doesn’t.

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +
      + +
      +
      +macholib.dyld.dyld_find(name[, executable_path[, env[, loader]]])
      +

      Returns the path of the requested dynamic library, +raises ValueError when the library cannot be found.

      +

      This function searches for the library in the same +locations and de system dynamic linker.

      +

      The executable_path should be the filesystem path +of the executable to which the library is linked (either +directly or indirectly).

      +

      The env argument is a dictionary, which defaults +to os.environ.

      +

      The loader_path argument is an optional filesystem path for +the object file (binary of shared library) that references +name.

      +
      +

      Changed in version 1.6: Added the loader_path argument.

      +
      +
      + +
      +
      +macholib.dyld.framework_find(fn[, executable_path[, env]])
      +

      Find a framework using the same semantics as the +system dynamic linker, but will accept looser names +than the system linker.

      +

      This function will return a correct result for input +values like:

      +
        +
      • Python
      • +
      • Python.framework
      • +
      • Python.framework/Versions/Current
      • +
      +
      + +
      + + +
      +
      +
      +
      +
      +

      Previous topic

      +

      macholib.SymbolTable — Class to read the symbol table from a Mach-O header

      +

      Next topic

      +

      macholib.dylib — Generic dylib path manipulation

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/dylib.html b/python/macholib/doc/_build/html/dylib.html new file mode 100644 index 000000000..dd293fef2 --- /dev/null +++ b/python/macholib/doc/_build/html/dylib.html @@ -0,0 +1,145 @@ + + + + + + + + macholib.dylib — Generic dylib path manipulation — macholib 1.7 documentation + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      macholib.dylib — Generic dylib path manipulation

      +

      This module defines a function dylib_info() that can extract +useful information from the name of a dynamic library.

      +
      +
      +macholib.dylib.dylib_info(filename)
      +

      A dylib name can take one of the following four forms:

      +
        +
      • Location/Name.SomeVersion_Suffix.dylib
      • +
      • Location/Name.SomeVersion.dylib
      • +
      • Location/Name_Suffix.dylib
      • +
      • Location/Name.dylib
      • +
      +

      Returns None if not found or a mapping equivalent to:

      +
      dict(
      +    location='Location',
      +    name='Name.SomeVersion_Suffix.dylib',
      +    shortname='Name',
      +    version='SomeVersion',
      +    suffix='Suffix',
      +)
      +
      +
      +
      +

      Note

      +

      SomeVersion and Suffix are optional and my be None +if not present.

      +
      +
      + +
      + + +
      +
      +
      +
      +
      +

      Previous topic

      +

      macholib.dyld — Dyld emulation

      +

      Next topic

      +

      macholib.framework — Generic framework path manipulation

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/framework.html b/python/macholib/doc/_build/html/framework.html new file mode 100644 index 000000000..023e580ed --- /dev/null +++ b/python/macholib/doc/_build/html/framework.html @@ -0,0 +1,147 @@ + + + + + + + + macholib.framework — Generic framework path manipulation — macholib 1.7 documentation + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      macholib.framework — Generic framework path manipulation

      +

      This module defines a function framework_info() that can extract +useful information from the name of a dynamic library in a framework.

      +
      +
      +macholib.framework.framework_info(filename)
      +
      +

      A framework name can take one of the following four forms:

      +
        +
      • Location/Name.framework/Versions/SomeVersion/Name_Suffix
      • +
      • Location/Name.framework/Versions/SomeVersion/Name
      • +
      • Location/Name.framework/Name_Suffix
      • +
      • Location/Name.framework/Name
      • +
      +

      Returns None if not found, or a mapping equivalent to:

      +
      dict(
      +    location='Location',
      +    name='Name.framework/Versions/SomeVersion/Name_Suffix',
      +    shortname='Name',
      +    version='SomeVersion',
      +    suffix='Suffix',
      +)
      +
      +
      +
      +
      +

      Note

      +

      SomeVersion and Suffix are optional and may be None +if not present.

      +
      +
      + +
      + + +
      +
      +
      +
      +
      +

      Previous topic

      +

      macholib.dylib — Generic dylib path manipulation

      +

      Next topic

      +

      macholib.mach_o — Low-level definitions

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/genindex.html b/python/macholib/doc/_build/html/genindex.html new file mode 100644 index 000000000..4c18044e2 --- /dev/null +++ b/python/macholib/doc/_build/html/genindex.html @@ -0,0 +1,365 @@ + + + + + + + + + Index — macholib 1.7 documentation + + + + + + + + + + + + + +
      +
      +
      +
      + + +

      Index

      + +
      + B + | D + | F + | M + | P + | S + | T + +
      +

      B

      + + + +
      + +
      BasePackable (class in macholib.ptypes) +
      + +
      + +
      BasePackable._endian_ (in module macholib.ptypes) +
      + +
      + +

      D

      + + + +
      + +
      dydl_framework_path() (in module macholib.dyld) +
      + + +
      dyld_default_search() (in module macholib.dyld) +
      + + +
      dyld_executable_path_search() (in module macholib.dyld) +
      + + +
      dyld_fallback_framework_path() (in module macholib.dyld) +
      + + +
      dyld_fallback_library_path() (in module macholib.dyld) +
      + + +
      dyld_find() (in module macholib.dyld) +
      + +
      + +
      dyld_image_suffix() (in module macholib.dyld) +
      + + +
      dyld_image_suffix_search() (in module macholib.dyld) +
      + + +
      dyld_library_path() (in module macholib.dyld) +
      + + +
      dyld_loader_search() (in module macholib.dyld) +
      + + +
      dyld_override_search() (in module macholib.dyld) +
      + + +
      dylib_info() (in module macholib.dylib) +
      + +
      + +

      F

      + + + +
      + +
      framework_find() (in module macholib.dyld) +
      + + +
      framework_info() (in module macholib.framework) +
      + + +
      from_fileobj() (macholib.ptypes.BasePackable method) +
      + +
      + +
      from_mmap() (macholib.ptypes.BasePackable method) +
      + + +
      from_str() (macholib.ptypes.BasePackable method) +
      + + +
      from_tuple() (macholib.ptypes.BasePackable method) +
      + +
      + +

      M

      + + + +
      + +
      MachO (class in macholib.MachO) +
      + + +
      MachOGraph (class in macholib.MachOGraph) +
      + + +
      macholib.dyld (module) +
      + + +
      macholib.dylib (module) +
      + + +
      macholib.framework (module) +
      + + +
      macholib.mach_o (module) +
      + +
      + +
      macholib.MachO (module) +
      + + +
      macholib.MachOGraph (module) +
      + + +
      macholib.MachOStandalone (module) +
      + + +
      macholib.ptypes (module) +
      + + +
      macholib.SymbolTable (module) +
      + + +
      MachOStandalone (class in macholib.MachOStandalone) +
      + +
      + +

      P

      + + + +
      + +
      p_char (class in macholib.ptypes) +
      + + +
      p_double (class in macholib.ptypes) +
      + + +
      p_float (class in macholib.ptypes) +
      + + +
      p_int16 (class in macholib.ptypes) +
      + + +
      p_int32 (class in macholib.ptypes) +
      + + +
      p_int64 (class in macholib.ptypes) +
      + +
      + +
      p_int8 (class in macholib.ptypes) +
      + + +
      p_uint16 (class in macholib.ptypes) +
      + + +
      p_uint32 (class in macholib.ptypes) +
      + + +
      p_uint64 (class in macholib.ptypes) +
      + + +
      p_uint8 (class in macholib.ptypes) +
      + + +
      pypackable() (in module macholib.ptypes) +
      + +
      + +

      S

      + + + +
      + +
      sizeof() (in module macholib.ptypes) +
      + + +
      Structure (class in macholib.ptypes) +
      + +
      + +
      Structure._fields_ (in module macholib.ptypes) +
      + + +
      SymbolTable (class in macholib.SymbolTable) +
      + +
      + +

      T

      + + + +
      + +
      to_fileobj() (macholib.ptypes.BasePackable method) +
      + + +
      to_mmap() (macholib.ptypes.BasePackable method) +
      + +
      + +
      to_str() (macholib.ptypes.BasePackable method) +
      + +
      + + + +
      +
      +
      +
      +
      + + + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/index.html b/python/macholib/doc/_build/html/index.html new file mode 100644 index 000000000..8b405f778 --- /dev/null +++ b/python/macholib/doc/_build/html/index.html @@ -0,0 +1,170 @@ + + + + + + + + Macholib - Analyze and edit Mach-O headers — macholib 1.7 documentation + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      Macholib - Analyze and edit Mach-O headers

      +

      macholib can be used to analyze and edit Mach-O headers, the executable +format used by Mac OS X.

      +

      It’s typically used as a dependency analysis tool, and also to rewrite dylib +references in Mach-O headers to be @executable_path relative.

      +

      Though this tool targets a platform specific file format, it is pure python +code that is platform and endian independent.

      +
      +

      General documentation

      + +
      + + +
      +

      Contributors

      +

      Macholib was written by Bob Ippolito and is currently maintained by Ronald Oussoren <ronaldoussoren@mac.com>.

      +
      +
      +

      Indices and tables

      + +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Next topic

      +

      Release history

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/license.html b/python/macholib/doc/_build/html/license.html new file mode 100644 index 000000000..88765bfce --- /dev/null +++ b/python/macholib/doc/_build/html/license.html @@ -0,0 +1,140 @@ + + + + + + + + License — macholib 1.7 documentation + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      License

      +

      Copyright (c) Bob Ippolito

      +

      Parts are copyright (c) 2010-2014 Ronald Oussoren

      +
      +

      MIT License

      +

      Permission is hereby granted, free of charge, to any person obtaining a copy of this software +and associated documentation files (the “Software”), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do +so.

      +

      THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE.

      +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      Release history

      +

      Next topic

      +

      Command-line tools

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/macho_o.html b/python/macholib/doc/_build/html/macho_o.html new file mode 100644 index 000000000..5e41f7a96 --- /dev/null +++ b/python/macholib/doc/_build/html/macho_o.html @@ -0,0 +1,122 @@ + + + + + + + + macholib.mach_o — Low-level definitions — macholib 1.7 documentation + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      macholib.mach_o — Low-level definitions

      +

      This module defines constants and packable structure types +that correspond to elements of a Mach-O file.

      +

      The names of classes and constants is the same as those in +the Mach-O header files and +Apple’s documentation. This document therefore +doesn’t explictly document the names in this module.

      +
      + + +
      +
      +
      +
      +
      +

      Previous topic

      +

      macholib.framework — Generic framework path manipulation

      +

      Next topic

      +

      macholib.ptypes — Packable types

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/objects.inv b/python/macholib/doc/_build/html/objects.inv new file mode 100644 index 000000000..4edc7d27d Binary files /dev/null and b/python/macholib/doc/_build/html/objects.inv differ diff --git a/python/macholib/doc/_build/html/ptypes.html b/python/macholib/doc/_build/html/ptypes.html new file mode 100644 index 000000000..a74627186 --- /dev/null +++ b/python/macholib/doc/_build/html/ptypes.html @@ -0,0 +1,317 @@ + + + + + + + + macholib.ptypes — Packable types — macholib 1.7 documentation + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      macholib.ptypes — Packable types

      +

      The module macholib.ptypes defines types that can be serialized into +byte arrays, both for basic types and structured types (C struct values).

      +
      +

      Utility functions

      +
      +
      +macholib.ptypes.sizeof(value)
      +

      Returns the size in bytes of an object when packed, raises ValueError +for inappropriate values.

      +
      + +
      +
      +macholib.ptypes.pypackable(name, pytype, format)
      +

      Returns a packable type that is a subclass of the Python type +pytype. The value is converted to and from the packed format using +the struct format.

      +
      + +
      +
      +

      Packable types

      +
      +
      +class macholib.ptypes.BasePackable
      +

      All packable types are a subclass of BasePackable, which defines +the basic interface but is itself an abstract base class.

      +
      +
      +_endian_
      +

      The byteorder of a packed value. This will be "<"` for +little endian values and ``">" for big-endian ones.

      +
      +

      Note

      +

      the endianness option is a public value to be +able to support both big- and little-endian file formats.

      +

      The name suggests that this attribute is private, this +is partically for historical reasons and partially to +avoid conflicts with field names in C structs.

      +
      +
      + +
      +
      +from_mmap(mmap, ptr, **kw)
      +

      This class method constructs the value from a subview of a +mmap.mmap object. It uses bytes starting at offset ptr and +reads just enough bytes to read the entire object.

      +
      + +
      +
      +from_fileobj(fp, **kw)
      +

      This class method constructs the value by reading just enough bytes +from a file-like object.

      +
      +

      Note

      +

      The file must be opened in binary mode, that is read calls +should return byte-strings and not unicode-strings.

      +
      +
      + +
      +
      +from_str(value, **kw)
      +

      This class method construct the value by using the struct module +to parse the given bytes.

      +
      +

      Note

      +

      contrary to what the name suggests the argument to this +method is a byte-string, not a unicode-string.

      +
      +
      + +
      +
      +from_tuple(fp, **kw)
      +

      This class method constructs the object from a tuple with all fields.

      +
      + +
      +
      +to_str()
      +

      Returns a byte representation of the value.

      +
      +

      Note

      +

      there is no default implementation for this method

      +
      +
      + +
      +
      +to_fileobj(fp)
      +

      Write a byte representation of the value to the given file-like +object. The file should be opened in binary mode.

      +
      + +
      +
      +to_mmap(mmap, ptr)
      +

      Write the byte representation of the value to a mmap.mmap +object, starting at offset ptr.

      +
      + +
      + +
      +
      +class macholib.ptypes.Structure(...)
      +
      +
      +_fields_
      +

      This class attribute is a list that contains the fields of the +structure in the right order. Every item of this list is a tuple +with 2 arguments: the first element is the name of the field, and +the second the packable type for the field.

      +

      Every subclass of Structure must define _fields_ to be +usefull, and the value of _fields_ should not be changed after +class construction.

      +
      + +
      + +
      +
      +

      Basic packables

      +

      Other than the core functionality this module defines a number of +pypackable() types that correspond to useful basic C types.

      +
      +
      +class macholib.ptypes.p_char([value])
      +

      A byte string of length 1

      +
      + +
      +
      +class macholib.ptypes.p_int8
      +

      An 8-bit signed integer

      +
      + +
      +
      +class macholib.ptypes.p_uint8
      +

      An 8-bit unsigned integer

      +
      + +
      +
      +class macholib.ptypes.p_int16
      +

      An 16-bit signed integer

      +
      + +
      +
      +class macholib.ptypes.p_uint16
      +

      An 16-bit unsigned integer

      +
      + +
      +
      +class macholib.ptypes.p_int32
      +

      An 32-bit signed integer

      +
      + +
      +
      +class macholib.ptypes.p_uint32
      +

      An 32-bit unsigned integer

      +
      + +
      +
      +class macholib.ptypes.p_int64
      +

      An 64-bit signed integer

      +
      + +
      +
      +class macholib.ptypes.p_uint64
      +

      An 64-bit unsigned integer

      +
      + +
      +
      +class macholib.ptypes.p_float
      +

      An floating point value of type float

      +
      + +
      +
      +class macholib.ptypes.p_double
      +

      An floating point value of type double

      +
      + +
      +

      Note

      +

      the module exports a number of other types with +names starting with p_, such as p_int. Those types +are deprecated and should not be used.

      +
      +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      macholib.mach_o — Low-level definitions

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/py-modindex.html b/python/macholib/doc/_build/html/py-modindex.html new file mode 100644 index 000000000..30a195a20 --- /dev/null +++ b/python/macholib/doc/_build/html/py-modindex.html @@ -0,0 +1,154 @@ + + + + + + + + Python Module Index — macholib 1.7 documentation + + + + + + + + + + + + + + + + +
      +
      +
      +
      + + +

      Python Module Index

      + +
      + m +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
       
      + m
      + macholib +
          + macholib.dyld + Emulation of functonality of the dynamic linker
          + macholib.dylib + Generic dylib path manipulation
          + macholib.framework + Generic framework path manipulation
          + macholib.mach_o + Low-level definitions of elements in a Mach-O file
          + macholib.MachO + Utilities for reading and writing Mach-O headers
          + macholib.MachOGraph + Graph data structure of Mach-O dependencies
          + macholib.MachOStandalone + Create standalone application bundles
          + macholib.ptypes + Serializable types
          + macholib.SymbolTable + Class to read the symbol table from a Mach-O header
      + + +
      +
      +
      +
      +
      + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/scripts.html b/python/macholib/doc/_build/html/scripts.html new file mode 100644 index 000000000..38e540300 --- /dev/null +++ b/python/macholib/doc/_build/html/scripts.html @@ -0,0 +1,156 @@ + + + + + + + + Command-line tools — macholib 1.7 documentation + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      Command-line tools

      +
      +

      python -m macholib find

      +

      Usage:

      +
      $ python -mmacholib find dir...
      +
      +
      +

      Print the paths of all MachO binaries +in the specified directories.

      +
      +
      +

      python -m macholib standalone

      +

      Usage:

      +
      $ python -m macholib standalone appbundle...
      +
      +
      +

      Convert one or more application bundles into +standalone bundles. That is, copy all non-system +shared libraries and frameworks used by the bundle +into the bundle and rewrite load commands.

      +
      +
      +

      python -mmacholib dump

      +

      Usage:

      +
      $ python -mmacholib dump dir...
      +
      +
      +

      Prints information about all architectures in a +Mach-O file as well as all libraries it links +to.

      +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      License

      +

      Next topic

      +

      macholib.MachO — Utilities for reading and writing Mach-O headers

      +

      This Page

      + + + +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/search.html b/python/macholib/doc/_build/html/search.html new file mode 100644 index 000000000..1aa1b53df --- /dev/null +++ b/python/macholib/doc/_build/html/search.html @@ -0,0 +1,105 @@ + + + + + + + + Search — macholib 1.7 documentation + + + + + + + + + + + + + + + + + + + +
      +
      +
      +
      + +

      Search

      +
      + +

      + Please activate JavaScript to enable the search + functionality. +

      +
      +

      + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +

      +
      + + + +
      + +
      + +
      + +
      +
      +
      +
      +
      +
      +
      +
      +
      + + + + \ No newline at end of file diff --git a/python/macholib/doc/_build/html/searchindex.js b/python/macholib/doc/_build/html/searchindex.js new file mode 100644 index 000000000..1ed235d8f --- /dev/null +++ b/python/macholib/doc/_build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({envversion:42,terms:{osx:4,all:[0,4,5,8,10,11],code:[1,8,4],partial:5,represent:5,four:[7,6],follow:[7,6],ptr:5,privat:[5,4],from_mmap:5,ronaldoussoren:1,dyld_library_path:11,those:[11,3,5,4],aris:2,merchant:2,p_char:5,sourc:4,everi:5,string:[5,4],p_int8:[5,4],than:[11,5],p_longlong:4,fat:12,affect:4,tri:4,magic:4,level:1,py2app:4,iter:11,"try":4,item:[11,5],dir:10,pleas:4,x86_64:4,impli:2,cpu_type_nam:4,direct:9,sign:5,second:5,odd:4,append:11,even:[11,4],index:1,what:5,p_int16:[5,4],dorsei:4,abi:1,abl:5,current:[1,11],"public":5,experiment:4,"new":4,oussoren:[1,2],method:[5,4],deduc:4,metadata:4,sizeof:5,gener:4,lc_load_upward_dylib:4,onli:11,behaviour:4,path:[11,4],modifi:2,"_endian_":5,valu:[11,5,4],search:[1,11,4],subview:5,p_int64:[5,4],permit:2,macho_standalon:4,implement:[8,5,4],from_fileobj:5,semant:[11,4],useful:5,app:4,filenam:[7,12,6],inappropri:5,instal:[11,4],lc_function_start:4,from:12,describ:4,would:4,univers:12,dure:4,next:4,call:5,usr:4,typo:4,type:[1,3,4],minor:4,more:[11,12,10,9,4],share:[11,10],nguyen:4,p_uint:4,particular:2,sourcecod:1,herebi:2,must:5,none:[7,11,6],setup:4,work:[8,4],can:[1,4,5,7,6,11,12],endian:[1,5,4],purpos:2,root:0,claim:2,bogu:4,ppc64:4,accept:11,serial:5,unsign:5,looser:11,alwai:[11,4],end:8,classifi:4,far:8,pure:1,instead:4,updat:8,map:[7,6,4],after:[8,5],ronald:[1,2],mac:1,mai:7,underscor:4,associ:2,p_long:4,author:[8,2],correspond:[3,5,4],element:[5,3],issu:[1,4],inform:[4,10,7,6,11,12],"switch":4,maintain:1,environ:[11,4],reloc:4,fallback:11,order:[5,4],furnish:2,to_mmap:5,move:4,becaus:[8,4],still:4,pointer:4,dynam:[7,11,12,6],p_uint32:[5,4],fit:2,fix:4,better:4,tort:2,contrari:5,therefor:3,non:[0,10],"return":[7,11,6,5,4],env:[0,11],thei:4,python:[1,11,5,4],initi:8,framework:[11,4],now:4,discuss:9,from_str:5,name:[3,4,5,7,6,11],name_suffix:[7,6],mode:5,found:[7,11,6],unicod:5,side:4,compil:4,list:[11,5,4],connect:2,extract:[7,6],event:2,out:2,variabl:4,antoin:4,newli:4,publish:2,dylib_info:6,rewrit:[1,10,4],rel:[1,11],print:[10,4],correct:11,earlier:4,insid:4,macho_dump:4,free:2,reason:5,base:[0,5],dictionari:11,p_float:5,org:4,"byte":[5,4],modulegraph:8,dyld_find:[11,4],dyld_image_suffix:11,david:4,length:5,isn:4,lc_encryption_info:4,lifetim:4,confus:4,suppport:4,first:[5,4],softwar:2,suffix:[7,11,6],directli:11,onc:4,arrai:5,independ:1,number:[11,5,4],restrict:2,construct:5,open:[8,5],size:5,given:[8,5],width:4,licens:1,system:[0,11,10,4],messag:4,mercuri:4,too:4,lc_version_min_iphoneo:4,includ:[2,4],option:[4,5,7,8,6,11],tool:[1,4],copi:[0,2,10],setuptool:4,specifi:[11,8,10],part:2,pars:5,holder:2,packabl:[1,3,4],kind:2,grep:4,target:1,provid:[2,4],remov:4,see:[11,4],were:4,"function":[6,7,11,8,4],loader_path:[11,4],linker:[11,4],appbundl:10,argument:[11,8,5,4],packag:[8,4],properli:8,lightli:4,need:4,lc_data_in_cod:4,sell:2,caus:4,equival:[7,6],also:[1,8,4],builtin:8,arch_map:4,take:[7,6],which:[0,4,5,9,11,12],noth:11,distribut:[2,4],though:[1,11,4],dydl_framework_path:11,previou:4,clearer:4,sublicens:2,maco:12,"class":[0,12,9],charg:2,renam:4,framework_info:7,later:12,request:11,doe:8,shortnam:[7,6],show:4,xcode:4,permiss:2,find:[11,4],dyld_executable_path_search:11,locat:[0,7,11,6,4],macho_find:4,copyright:2,enough:5,should:[11,12,5,4],version:[7,11,6,4],dict:[7,6],to_fileobj:5,p_int32:[5,4],variou:4,express:2,stop:4,nativ:4,cannot:[11,4],liabl:2,partic:5,byteord:5,enabl:12,yield:11,patch:4,irrespect:4,"default":[11,8,5],contain:[8,5,4],where:11,view:4,set:4,dump:4,pytyp:5,from_tupl:5,lion:4,result:[11,8,4],dyld_override_search:11,basepack:5,written:1,p_byte:4,attribut:5,pypack:5,parent:4,p_ptr:4,entir:5,both:5,plugin:0,dyld_default_search:[11,4],contract:2,matthia:4,py3k:4,com:1,load:[10,4],unclear:4,undocu:4,somevers:[7,6],point:5,loader:[11,4],platform:1,assum:0,damag:2,liabil:2,marc:4,due:4,empti:11,whom:2,basic:4,valueerror:[11,5],dyld_fallback:4,imag:11,convert:[5,10],ani:[8,2],p_uint64:[5,4],p_int:[5,4],present:[7,6,4],look:11,histor:5,defin:[0,3,5,7,9,6,11,12],mmacholib:4,pack:5,have:4,itself:[5,4],myapp:4,dyld_fallback_library_path:11,p_uint16:[5,4],grant:2,suggest:5,make:4,same:[11,3],binari:[4,5,8,10,11,12],pysid:4,p_short:4,document:4,conflict:5,http:4,effect:4,action:2,rais:[11,5],user:[11,8,4],typic:1,p_doubl:5,noninfring:2,appropri:4,p_ushort:4,entri:11,well:[8,10],person:2,without:[2,4],command:[1,4],thi:[0,1,2,3,4,5,7,8,9,6,11,12],filesystem:11,undefin:4,just:5,when:[11,5,4],obtain:2,guanqun:4,struct:5,mmap:5,had:4,except:4,littl:5,add:4,lc_linker_opt:4,input:11,modul:[0,1,3,4,5,7,8,9,6,11,12],build:4,bin:4,around:4,format:[1,12,5],dest:0,big:5,p_ulonglong:4,know:8,bit:[8,5,4],python2:4,like:[11,8,5],specif:1,deprec:[8,5,4],manual:11,integ:5,either:11,output:4,prepent:11,page:[1,11],openfil:8,right:[5,2],old:4,p_uint8:[5,4],dyld_image_suffix_search:11,some:4,ptype:[1,4],someversion_suffix:6,"export":5,indirect:9,librari:[10,7,9,6,11,12],p_ubyt:4,avoid:5,shall:2,definit:[1,4],framwork:11,subclass:5,not_system_fil:4,tracker:[1,4],larg:4,refer:[11,12],core:5,ippolito:[1,2],object:[11,8,5,12],usag:10,broken:4,repositori:[1,4],offset:5,executable_path:[0,1,11],about:[10,4],actual:4,testsuit:4,explictli:3,doubl:5,"float":5,warranti:2,been:[8,4],chang:[11,5,4],reli:4,your:4,merg:2,deal:2,aren:[11,4],execut:[1,12,11],support:[8,5,4],avail:4,start:[11,5,4],lc_version_min_macosx:4,appl:[1,3],interfac:5,low:1,ringwald:4,analysi:1,"_fields_":5,form:[7,6],tupl:5,link:[11,10,4],p_ulong:4,line:[1,4],dyld_fallback_framework_path:11,bug:[8,4],framework_find:11,possibl:4,whether:2,bugfix:4,below:4,limit:2,arm64:4,otherwis:2,problem:4,featur:4,constant:[3,4],creat:12,"abstract":5,doesn:[11,3,8,4],repres:[9,4],exist:12,file:[0,1,2,3,4,5,8,9,10,11,12],bob:[1,2],codebas:4,again:4,lc_encryption_info_64:4,"2to3":4,nam:4,field:5,other:[9,5,2],futur:4,test:4,you:4,architectur:10,mach_o:[1,4],dyld:4,bitbucket:[1,4],sphinx:4,longer:4,directori:[0,11,10],dyld_framework_path:11,dyld_loader_search:[11,4],descript:11,indirectli:11,to_str:5,cpu:4},objtypes:{"0":"py:module","1":"py:method","2":"py:function","3":"py:class","4":"py:data"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","function","Python function"],"3":["py","class","Python class"],"4":["py","data","Python data"]},filenames:["MachoOStandalone","index","license","macho_o","changelog","ptypes","dylib","framework","SymbolTable","MachoOGraph","scripts","dyld","MachO"],titles:["macholib.MachOStandalone — Create standalone application bundles","Macholib - Analyze and edit Mach-O headers","License","macholib.mach_o — Low-level definitions","Release history","macholib.ptypes — Packable types","macholib.dylib — Generic dylib path manipulation","macholib.framework — Generic framework path manipulation","macholib.SymbolTable — Class to read the symbol table from a Mach-O header","macholib.MachoGraph — Graph data structure of Mach-O dependencies","Command-line tools","macholib.dyld — Dyld emulation","macholib.MachO — Utilities for reading and writing Mach-O headers"],objects:{"macholib.MachO":{MachO:[12,3,1,""]},"macholib.MachOStandalone":{MachOStandalone:[0,3,1,""]},"macholib.ptypes":{p_char:[5,3,1,""],BasePackable:[5,3,1,""],p_uint16:[5,3,1,""],p_uint8:[5,3,1,""],p_uint64:[5,3,1,""],p_int8:[5,3,1,""],p_uint32:[5,3,1,""],p_float:[5,3,1,""],p_int64:[5,3,1,""],pypackable:[5,2,1,""],p_double:[5,3,1,""],p_int16:[5,3,1,""],p_int32:[5,3,1,""],sizeof:[5,2,1,""],Structure:[5,3,1,""]},"macholib.MachOGraph":{MachOGraph:[9,3,1,""]},macholib:{mach_o:[3,0,0,"-"],MachOGraph:[9,0,0,"-"],ptypes:[5,0,0,"-"],framework:[7,0,0,"-"],SymbolTable:[8,0,0,"-"],MachOStandalone:[0,0,0,"-"],dylib:[6,0,0,"-"],dyld:[11,0,0,"-"],MachO:[12,0,0,"-"]},"macholib.ptypes.Structure":{"_fields_":[5,4,1,""]},"macholib.SymbolTable":{SymbolTable:[8,3,1,""]},"macholib.dylib":{dylib_info:[6,2,1,""]},"macholib.ptypes.BasePackable":{from_str:[5,1,1,""],to_mmap:[5,1,1,""],from_tuple:[5,1,1,""],to_str:[5,1,1,""],to_fileobj:[5,1,1,""],from_mmap:[5,1,1,""],from_fileobj:[5,1,1,""],"_endian_":[5,4,1,""]},"macholib.framework":{framework_info:[7,2,1,""]},"macholib.dyld":{framework_find:[11,2,1,""],dyld_executable_path_search:[11,2,1,""],dyld_override_search:[11,2,1,""],dyld_find:[11,2,1,""],dydl_framework_path:[11,2,1,""],dyld_image_suffix_search:[11,2,1,""],dyld_library_path:[11,2,1,""],dyld_image_suffix:[11,2,1,""],dyld_default_search:[11,2,1,""],dyld_fallback_framework_path:[11,2,1,""],dyld_loader_search:[11,2,1,""],dyld_fallback_library_path:[11,2,1,""]}},titleterms:{bundl:0,machostandalon:0,dump:10,definit:3,symbolt:8,ptype:5,indic:1,header:[1,8,12],framework:7,tabl:[1,8],contributor:1,onlin:1,guid:1,find:10,from:8,creat:0,graph:9,licens:2,machograph:9,"class":8,write:12,read:[12,8],analyz:1,basic:5,macho:12,type:5,mit:2,refer:1,"function":5,applic:0,mach_o:3,resourc:1,python:10,symbol:8,manipul:[7,6],tool:10,util:[12,5],standalon:[0,10],low:3,releas:4,depend:9,line:10,data:9,packabl:5,mach:[1,8,9,12],document:1,dylib:6,level:3,edit:1,macholib:[0,1,3,4,5,6,7,8,9,10,11,12],structur:9,histori:4,emul:11,dyld:11,command:10,gener:[1,6,7],path:[7,6],mmacholib:10}}) \ No newline at end of file diff --git a/python/macholib/doc/changelog.rst b/python/macholib/doc/changelog.rst new file mode 100644 index 000000000..d73299f91 --- /dev/null +++ b/python/macholib/doc/changelog.rst @@ -0,0 +1,242 @@ +Release history +=============== + +macholib 1.7 +------------ + +* Added support for ARM64, LC_ENCRYPTION_INFO_64 and LC_LINKER_OPTION + + Patch by Matthias Ringwald. + +* Load commands now have a "describe" method that returns more information + about the command. + + Patch by David Dorsey. + +* The MAGIC value in the header was always represented in the native + byte order, instead of as the value read from the binary. + + Patch by David Dorsey. + +* Added various new constants to "macholib.mach_o". + + Patch by David Dorsey. + +macholib 1.6.1 +-------------- + +* ? + +macholib 1.6 +------------ + +* Add support for '@loader_path' link command in + macholib.dyld: + + - Added function ``macholib.dyld.dyld_loader_search`` + + - This function is used by ``macholib.dyld.dyld_find``, + and that function now has an new (optional) argument + with the path to the loader. + +* Also add support for '@loader_path' to macholib.MachoGraph, + using the newly added '@loader_path' support in the + dyld module. + + Due to this suppport the *macho_standalone* tool can + now rewrite binaries that contain an '@loader_path' load + command. + + +macholib 1.5.2 +-------------- + +* Issue #93: Show the name of the affected file in the exception message + for Mach-O headers that are too large to relocate. + + +macholib 1.5.1 +-------------- + +* There were no 'classifiers' in the package metadata due to + a bug in setup.py. + +macholib 1.5 +-------------- + +macholib 1.5 is a minor feature release + +* No longer use 2to3 to provide Python 3 support + + As a side-effect of this macholib no longer supports + Python 2.5 and earlier. + +* Adds suppport for some new macho load commands + +* Fix for py3k problem in macho_standalone.py + + Patch by Guanqun Lu. + +* Fix for some issues in macho_dump.py + + Patch by Nam Nguyen + +* Issue #10: Fix for LC_DATA_IN_CODE linker commands, without + this fix py2app cannot build application bundles when + the source binaries have been compiled with Xcode 4.5. + +* Issue #6: Fix for LC_ENCRYPTION_INFO linker commands + +* Use the mach header information to print the cpu type of a + binary, instead of trying to deduce that from pointer width + and endianness. + + Changed the code because of issue #6, in which a user tries to + dump a iOS binary which results in bogus output in the previous + releases. + +* The mapping ``macholib.macho_dump.ARCH_MAP`` is undocumented + and no longer used by macholib itself. It will be removed + in the next release. + + +* The command-line tools ``macho_find``, ``macho_dump`` and + ``macho_standalone`` are deprecated. Use "python -mmacholib" + instead. That is:: + + $ python -mmacholib dump /usr/bin/grep + + $ python -mmacholib find ~ + + $ python -mmacholib standalone myapp.app + + This makes it clearer which version of the tools are used. + +macholib 1.4.3 +-------------- + +macholib 1.4.3 is a minor feature release + +* Added strings for 'x86_64' and 'ppc64' to + macholib.mach_o.CPU_TYPE_NAMES. + +* macho_find and macho_dump were broken in the 1.4.2 release + +* added 'macholib.util.NOT_SYSTEM_FILES', a list of + files that aren't system path's even though they are + located in system locations. + + Needed to work around a bug in PySide (see issue #32 in the + py2app tracker) + + + +macholib 1.4.2 +-------------- + +macholib 1.4.2 is a minor bugfix release + +* The support for new load commands that was added in 1.4.1 + contained a typo that caused problems on OSX 10.7 (Lion). + +macholib 1.4.1 +-------------- + +macholib 1.4.1 is a minor feature release + +Features: + +- Add support for a number of new MachO load commands that were added + during the lifetime of OSX 10.6: ``LC_LOAD_UPWARD_DYLIB``, + ``LC_VERSION_MIN_MACOSX``, ``LC_VERSION_MIN_IPHONEOS`` and + ``LC_FUNCTION_STARTS``. + +macholib 1.4 +------------- + +macholib 1.4 is a feature release + +Features: + +- Documentation is now generated using `sphinx `_ + and can be viewed at . + +- The repository has moved to bitbucket + +- There now is a testsuite + +- Private functionality inside modules was renamed to + a name starting with an underscore. + + .. note:: if this change affects your code you are relying on undefined + implementation features, please stop using private functions. + +- The basic packable types in ``macholib.ptypes`` were renamed to better + represent the corresponding C type. The table below lists the old + an new names (the old names are still available, but are deprecated and + will be removed in a future release). + + +--------------+--------------+ + | **Old name** | **New name** | + +==============+==============+ + | p_byte | p_int8 | + +--------------+--------------+ + | p_ubyte | p_uint8 | + +--------------+--------------+ + | p_short | p_int16 | + +--------------+--------------+ + | p_ushort | p_uint16 | + +--------------+--------------+ + | p_int | p_int32 | + +--------------+--------------+ + | p_uint | p_uint32 | + +--------------+--------------+ + | p_long | p_int32 | + +--------------+--------------+ + | p_ulong | p_uint32 | + +--------------+--------------+ + | p_longlong | p_int64 | + +--------------+--------------+ + | p_ulonglong | p_uint64 | + +--------------+--------------+ + + ``Macholib.ptypes.p_ptr`` is no longer present as it had an unclear + definition and isn't actually used in the codebase. + + +Bug fixes: + +- The semantics of ``dyld.dyld_default_search`` were changed a bit, + it now first searches the framework path (if appropriate) and then + the linker path, irrespective of the value of the ``DYLD_FALLBACK*`` + environment variables. + + Previous versions would change the search order when those variables + was set, which is odd and doesn't correspond with the documented + behaviour of the system dyld. + +- It is once again possible to install using python2.5 + +- The source distribution includes all files, this was broken + due to the switch to mercurial (which confused setuptools) + +macholib 1.3 +------------ + +macholib 1.3 is a feature release. + +Features: + +- Experimental Python 3.x support + + This version contains lightly tested support for Python 3. + +macholib 1.2.2 +-------------- + +macholib 1.2.2 is a bugfix release. + +Bug fixes: + +- Macholib should work better with 64-bit code + (patch by Marc-Antoine Parent) diff --git a/python/macholib/doc/conf.py b/python/macholib/doc/conf.py new file mode 100644 index 000000000..08a48f3ed --- /dev/null +++ b/python/macholib/doc/conf.py @@ -0,0 +1,275 @@ +# -*- coding: utf-8 -*- +# +# macholib documentation build configuration file, created by +# sphinx-quickstart on Tue Sep 28 22:23:35 2010. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +def get_version(): + fn = os.path.join( + os.path.dirname(os.path.dirname(os.path.abspath(__file__))), + 'setup.cfg') + for ln in open(fn): + if ln.startswith('version'): + version = ln.split('=')[-1].strip() + return version + + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, + os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'macholib' +copyright = u'2010-2011, Ronald Oussoren' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = get_version() +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'macholibdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'macholib.tex', u'macholib Documentation', + u'Ronald Oussoren', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'macholib', u'macholib Documentation', + [u'Ronald Oussoren'], 1) +] + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'macholib' +epub_author = u'Ronald Oussoren' +epub_publisher = u'Ronald Oussoren' +epub_copyright = u'2010, Ronald Oussoren' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'python': ('http://docs.python.org/', None), + 'altgraph': ('http://packages.python.org/altgraph', None), +} diff --git a/python/macholib/doc/dyld.rst b/python/macholib/doc/dyld.rst new file mode 100644 index 000000000..14895b6b0 --- /dev/null +++ b/python/macholib/doc/dyld.rst @@ -0,0 +1,159 @@ +:mod:`macholib.dyld` --- Dyld emulation +======================================= + +.. module:: macholib.dyld + :synopsis: Emulation of functonality of the dynamic linker + +This module defines a number of functions that can be used +to emulate the functionality of the dynamic linker (``dyld``) +w.r.t. looking for library files and framworks. + +.. function:: dyld_image_suffix([env]) + + Looks up the suffix to append to shared library and + framework names and returns this value when found. + Returns ``None`` when no suffix should be appended. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_IMAGE_SUFFIX`` in the + manual page for dyld(1) for more information. + +.. function:: dydl_framework_path([env]) + + Returns a user-specified framework search path, + or an empty list when only the default search path + should be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_FRAMEWORK_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_library_path([env]) + + Returns a user-specified library search path, + or an empty list when only the default search path + should be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_LIBRARY_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_fallback_framework_path([env]) + + Return a user specified list of of directories where + to look for frameworks that aren't in their install path, + or an empty list when the default fallback path should + be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_FALLBACK_FRAMEWORK_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_fallback_library_path([env]) + + Return a user specified list of of directories where + to look for libraries that aren't in their install path, + or an empty list when the default fallback path should + be used. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + See the description of ``DYLD_FALLBACK_LIBRARY_PATH`` in the + manual page for dyld(1) for more information. + +.. function:: dyld_image_suffix_search(iterator[, env]) + + Yields all items in *iterator*, and prepents names + with the image suffix to those items when the suffix + is specified. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + +.. function:: dyld_override_search(name[, env]) + + If *name* is a framework name yield filesystem + paths relative to the entries in the framework + search path. + + Always yield the filesystem paths relative to the + entries in the library search path. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + +.. function:: dyld_executable_path_search(name, executable_path) + + If *name* is a path starting with ``@executable_path/`` yield + the path relative to the specified *executable_path*. + + If *executable_path* is None nothing is yielded. + +.. function:: dyld_loader_search(name, loader_path) + + If *name* is a path starting with ``@loader_path/`` yield + the path relative to the specified *loader_path*. + + If *loader_path* is None nothing is yielded. + + .. versionadded: 1.6 + +.. function:: dyld_default_search(name[, env]) + + Yield the filesystem locations to look for a dynamic + library or framework using the default locations + used by the system dynamic linker. + + This function will look in ``~/Library/Frameworks`` + for frameworks, even though the system dynamic linker + doesn't. + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + +.. function:: dyld_find(name[, executable_path[, env [, loader]]]) + + Returns the path of the requested dynamic library, + raises :exc:`ValueError` when the library cannot be found. + + This function searches for the library in the same + locations and de system dynamic linker. + + The *executable_path* should be the filesystem path + of the executable to which the library is linked (either + directly or indirectly). + + The *env* argument is a dictionary, which defaults + to :data:`os.environ`. + + The *loader_path* argument is an optional filesystem path for + the object file (binary of shared library) that references + *name*. + + .. versionchanged:: 1.6 + + Added the *loader_path* argument. + +.. function:: framework_find(fn[, executable_path[, env]]) + + Find a framework using the same semantics as the + system dynamic linker, but will accept looser names + than the system linker. + + This function will return a correct result for input + values like: + + * Python + + * Python.framework + + * Python.framework/Versions/Current diff --git a/python/macholib/doc/dylib.rst b/python/macholib/doc/dylib.rst new file mode 100644 index 000000000..969680212 --- /dev/null +++ b/python/macholib/doc/dylib.rst @@ -0,0 +1,33 @@ +:mod:`macholib.dylib` --- Generic dylib path manipulation +========================================================= + +.. module:: macholib.dylib + :synopsis: Generic dylib path manipulation + +This module defines a function :func:`dylib_info` that can extract +useful information from the name of a dynamic library. + +.. function:: dylib_info(filename) + + A dylib name can take one of the following four forms: + + * ``Location/Name.SomeVersion_Suffix.dylib`` + + * ``Location/Name.SomeVersion.dylib`` + + * ``Location/Name_Suffix.dylib`` + + * ``Location/Name.dylib`` + + Returns None if not found or a mapping equivalent to:: + + dict( + location='Location', + name='Name.SomeVersion_Suffix.dylib', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + ) + + .. note:: *SomeVersion* and *Suffix* are optional and my be ``None`` + if not present. diff --git a/python/macholib/doc/framework.rst b/python/macholib/doc/framework.rst new file mode 100644 index 000000000..b58b5751c --- /dev/null +++ b/python/macholib/doc/framework.rst @@ -0,0 +1,34 @@ +:mod:`macholib.framework` --- Generic framework path manipulation +========================================================================== + +.. module:: macholib.framework + :synopsis: Generic framework path manipulation + + +This module defines a function :func:`framework_info` that can extract +useful information from the name of a dynamic library in a framework. + +.. function:: framework_info(filename) + + A framework name can take one of the following four forms: + + * ``Location/Name.framework/Versions/SomeVersion/Name_Suffix`` + + * ``Location/Name.framework/Versions/SomeVersion/Name`` + + * ``Location/Name.framework/Name_Suffix`` + + * ``Location/Name.framework/Name`` + + Returns ``None`` if not found, or a mapping equivalent to:: + + dict( + location='Location', + name='Name.framework/Versions/SomeVersion/Name_Suffix', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + ) + + .. note:: *SomeVersion* and *Suffix* are optional and may be None + if not present. diff --git a/python/macholib/doc/index.rst b/python/macholib/doc/index.rst new file mode 100644 index 000000000..3067926a8 --- /dev/null +++ b/python/macholib/doc/index.rst @@ -0,0 +1,59 @@ +Macholib - Analyze and edit Mach-O headers +========================================== + +macholib can be used to analyze and edit Mach-O headers, the executable +format used by Mac OS X. + +It's typically used as a dependency analysis tool, and also to rewrite dylib +references in Mach-O headers to be ``@executable_path`` relative. + +Though this tool targets a platform specific file format, it is pure python +code that is platform and endian independent. + +General documentation +--------------------- + +.. toctree:: + :maxdepth: 1 + + changelog + license + scripts + +Reference Guide +--------------- + +.. toctree:: + :maxdepth: 1 + + MachO + MachoOGraph + MachoOStandalone + SymbolTable + dyld + dylib + framework + macho_o + ptypes + +Online Resources +---------------- + +* `Sourcecode repository on bitbucket `_ + +* `The issue tracker `_ + +* `Mac OS X ABI Mach-O File Format Reference at Apple `_ + +Contributors +------------ + +Macholib was written by Bob Ippolito and is currently maintained by Ronald Oussoren . + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/python/macholib/doc/license.rst b/python/macholib/doc/license.rst new file mode 100644 index 000000000..f9c8cc50e --- /dev/null +++ b/python/macholib/doc/license.rst @@ -0,0 +1,23 @@ +License +======= + +Copyright (c) Bob Ippolito + +Parts are copyright (c) 2010-2014 Ronald Oussoren + +MIT License +........... + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software +and associated documentation files (the "Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do +so. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + diff --git a/python/macholib/doc/macho_o.rst b/python/macholib/doc/macho_o.rst new file mode 100644 index 000000000..dfa347e8f --- /dev/null +++ b/python/macholib/doc/macho_o.rst @@ -0,0 +1,13 @@ +:mod:`macholib.mach_o` --- Low-level definitions +================================================ + +.. module:: macholib.mach_o + :synopsis: Low-level definitions of elements in a Mach-O file + +This module defines constants and packable structure types +that correspond to elements of a Mach-O file. + +The names of classes and constants is the same as those in +the Mach-O header files and +`Apple's documentation `_. This document therefore +doesn't explictly document the names in this module. diff --git a/python/macholib/doc/ptypes.rst b/python/macholib/doc/ptypes.rst new file mode 100644 index 000000000..ade2ac847 --- /dev/null +++ b/python/macholib/doc/ptypes.rst @@ -0,0 +1,157 @@ +:mod:`macholib.ptypes` --- Packable types +========================================= + +.. module:: macholib.ptypes + :synopsis: Serializable types + +The module :mod:`macholib.ptypes` defines types that can be serialized into +byte arrays, both for basic types and structured types (C ``struct`` values). + +Utility functions +----------------- + +.. function:: sizeof(value) + + Returns the size in bytes of an object when packed, raises :exc:`ValueError` + for inappropriate values. + +.. function:: pypackable(name, pytype, format) + + Returns a packable type that is a subclass of the Python type + *pytype*. The value is converted to and from the packed format using + the struct *format*. + + + +Packable types +-------------- + + +.. class:: BasePackable + + All packable types are a subclass of :class:`BasePackable`, which defines + the basic interface but is itself an abstract base class. + + .. data:: _endian_ + + The byteorder of a packed value. This will be ``"<"` for + little endian values and ``">"`` for big-endian ones. + + .. note:: the endianness option is a public value to be + able to support both big- and little-endian file formats. + + The name suggests that this attribute is private, this + is partically for historical reasons and partially to + avoid conflicts with field names in C structs. + + .. method:: from_mmap(mmap, ptr, \**kw) + + This class method constructs the value from a subview of a + :class:`mmap.mmap` object. It uses bytes starting at offset *ptr* and + reads just enough bytes to read the entire object. + + .. method:: from_fileobj(fp, \**kw) + + This class method constructs the value by reading just enough bytes + from a file-like object. + + .. note:: The file must be opened in binary mode, that is read calls + should return byte-strings and not unicode-strings. + + .. method:: from_str(value, \**kw) + + This class method construct the value by using the struct module + to parse the given bytes. + + .. note:: contrary to what the name suggests the argument to this + method is a byte-string, not a unicode-string. + + .. method:: from_tuple(fp, \**kw) + + This class method constructs the object from a tuple with all fields. + + + .. method:: to_str() + + Returns a byte representation of the value. + + .. note:: there is no default implementation for this method + + .. method:: to_fileobj(fp) + + Write a byte representation of the value to the given file-like + object. The file should be opened in binary mode. + + .. method:: to_mmap(mmap, ptr) + + Write the byte representation of the value to a :class:`mmap.mmap` + object, starting at offset *ptr*. + + +.. class:: Structure(...) + + .. data:: _fields_ + + This class attribute is a list that contains the fields of the + structure in the right order. Every item of this list is a tuple + with 2 arguments: the first element is the name of the field, and + the second the packable type for the field. + + Every subclass of :class:`Structure` must define *_fields_* to be + usefull, and the value of *_fields_* should not be changed after + class construction. + + +Basic packables +--------------- + +Other than the core functionality this module defines a number of +:func:`pypackable` types that correspond to useful basic C types. + +.. class:: p_char([value]) + + A byte string of length 1 + +.. class:: p_int8 + + An 8-bit signed integer + +.. class:: p_uint8 + + An 8-bit unsigned integer + +.. class:: p_int16 + + An 16-bit signed integer + +.. class:: p_uint16 + + An 16-bit unsigned integer + +.. class:: p_int32 + + An 32-bit signed integer + +.. class:: p_uint32 + + An 32-bit unsigned integer + +.. class:: p_int64 + + An 64-bit signed integer + +.. class:: p_uint64 + + An 64-bit unsigned integer + +.. class:: p_float + + An floating point value of type ``float`` + +.. class:: p_double + + An floating point value of type ``double`` + +.. note:: the module exports a number of other types with + names starting with ``p_``, such as ``p_int``. Those types + are deprecated and should not be used. diff --git a/python/macholib/doc/scripts.rst b/python/macholib/doc/scripts.rst new file mode 100644 index 000000000..50cf38028 --- /dev/null +++ b/python/macholib/doc/scripts.rst @@ -0,0 +1,35 @@ +Command-line tools +================== + +python -m macholib find +----------------------- + +Usage:: + + $ python -mmacholib find dir... + +Print the paths of all MachO binaries +in the specified directories. + +python -m macholib standalone +----------------------------- + +Usage:: + + $ python -m macholib standalone appbundle... + +Convert one or more application bundles into +standalone bundles. That is, copy all non-system +shared libraries and frameworks used by the bundle +into the bundle and rewrite load commands. + +python -mmacholib dump +---------------------- + +Usage:: + + $ python -mmacholib dump dir... + +Prints information about all architectures in a +Mach-O file as well as all libraries it links +to. diff --git a/python/macholib/macholib/MachO.py b/python/macholib/macholib/MachO.py new file mode 100644 index 000000000..f83ddb711 --- /dev/null +++ b/python/macholib/macholib/MachO.py @@ -0,0 +1,398 @@ +""" +Utilities for reading and writing Mach-O headers +""" +from __future__ import print_function + +import sys +import struct + +from macholib.mach_o import * +from macholib.dyld import dyld_find, framework_info +from macholib.util import fileview +try: + from macholib.compat import bytes +except ImportError: + pass + +try: + unicode +except NameError: + unicode = str + +__all__ = ['MachO'] + +_RELOCATABLE = set(( + # relocatable commands that should be used for dependency walking + LC_LOAD_DYLIB, + LC_LOAD_WEAK_DYLIB, + LC_PREBOUND_DYLIB, + LC_REEXPORT_DYLIB, +)) + +_RELOCATABLE_NAMES = { + LC_LOAD_DYLIB: 'load_dylib', + LC_LOAD_WEAK_DYLIB: 'load_weak_dylib', + LC_PREBOUND_DYLIB: 'prebound_dylib', + LC_REEXPORT_DYLIB: 'reexport_dylib', +} + +def _shouldRelocateCommand(cmd): + """ + Should this command id be investigated for relocation? + """ + return cmd in _RELOCATABLE + +class MachO(object): + """ + Provides reading/writing the Mach-O header of a specific existing file + """ + # filename - the original filename of this mach-o + # sizediff - the current deviation from the initial mach-o size + # header - the mach-o header + # commands - a list of (load_command, somecommand, data) + # data is either a str, or a list of segment structures + # total_size - the current mach-o header size (including header) + # low_offset - essentially, the maximum mach-o header size + # id_cmd - the index of my id command, or None + + + def __init__(self, filename): + + # supports the ObjectGraph protocol + self.graphident = filename + self.filename = filename + + # initialized by load + self.fat = None + self.headers = [] + with open(filename, 'rb') as fp: + self.load(fp) + + def __repr__(self): + return "" % (self.filename,) + + def load(self, fh): + assert fh.tell() == 0 + header = struct.unpack('>I', fh.read(4))[0] + fh.seek(0) + if header == FAT_MAGIC: + self.load_fat(fh) + else: + fh.seek(0, 2) + size = fh.tell() + fh.seek(0) + self.load_header(fh, 0, size) + + def load_fat(self, fh): + self.fat = fat_header.from_fileobj(fh) + archs = [fat_arch.from_fileobj(fh) for i in range(self.fat.nfat_arch)] + for arch in archs: + self.load_header(fh, arch.offset, arch.size) + + def rewriteLoadCommands(self, *args, **kw): + changed = False + for header in self.headers: + if header.rewriteLoadCommands(*args, **kw): + changed = True + return changed + + def load_header(self, fh, offset, size): + fh.seek(offset) + header = struct.unpack('>I', fh.read(4))[0] + fh.seek(offset) + if header == MH_MAGIC: + magic, hdr, endian = MH_MAGIC, mach_header, '>' + elif header == MH_CIGAM: + magic, hdr, endian = MH_CIGAM, mach_header, '<' + elif header == MH_MAGIC_64: + magic, hdr, endian = MH_MAGIC_64, mach_header_64, '>' + elif header == MH_CIGAM_64: + magic, hdr, endian = MH_CIGAM_64, mach_header_64, '<' + else: + raise ValueError("Unknown Mach-O header: 0x%08x in %r" % ( + header, fh)) + hdr = MachOHeader(self, fh, offset, size, magic, hdr, endian) + self.headers.append(hdr) + + def write(self, f): + for header in self.headers: + header.write(f) + +class MachOHeader(object): + """ + Provides reading/writing the Mach-O header of a specific existing file + """ + # filename - the original filename of this mach-o + # sizediff - the current deviation from the initial mach-o size + # header - the mach-o header + # commands - a list of (load_command, somecommand, data) + # data is either a str, or a list of segment structures + # total_size - the current mach-o header size (including header) + # low_offset - essentially, the maximum mach-o header size + # id_cmd - the index of my id command, or None + + + def __init__(self, parent, fh, offset, size, magic, hdr, endian): + self.MH_MAGIC = magic + self.mach_header = hdr + + # These are all initialized by self.load() + self.parent = parent + self.offset = offset + self.size = size + + self.endian = endian + self.header = None + self.commands = None + self.id_cmd = None + self.sizediff = None + self.total_size = None + self.low_offset = None + self.filetype = None + self.headers = [] + + self.load(fh) + + def __repr__(self): + return "<%s filename=%r offset=%d size=%d endian=%r>" % ( + type(self).__name__, self.parent.filename, self.offset, self.size, + self.endian) + + def load(self, fh): + fh = fileview(fh, self.offset, self.size) + fh.seek(0) + + self.sizediff = 0 + kw = {'_endian_': self.endian} + header = self.mach_header.from_fileobj(fh, **kw) + self.header = header + #if header.magic != self.MH_MAGIC: + # raise ValueError("header has magic %08x, expecting %08x" % ( + # header.magic, self.MH_MAGIC)) + + cmd = self.commands = [] + + self.filetype = self.get_filetype_shortname(header.filetype) + + read_bytes = 0 + low_offset = sys.maxsize + for i in range(header.ncmds): + # read the load command + cmd_load = load_command.from_fileobj(fh, **kw) + + # read the specific command + klass = LC_REGISTRY.get(cmd_load.cmd, None) + if klass is None: + raise ValueError("Unknown load command: %d" % (cmd_load.cmd,)) + cmd_cmd = klass.from_fileobj(fh, **kw) + + if cmd_load.cmd == LC_ID_DYLIB: + # remember where this command was + if self.id_cmd is not None: + raise ValueError("This dylib already has an id") + self.id_cmd = i + + if cmd_load.cmd in (LC_SEGMENT, LC_SEGMENT_64): + # for segment commands, read the list of segments + segs = [] + # assert that the size makes sense + if cmd_load.cmd == LC_SEGMENT: + section_cls = section + else: # LC_SEGMENT_64 + section_cls = section_64 + + expected_size = ( + sizeof(klass) + sizeof(load_command) + + (sizeof(section_cls) * cmd_cmd.nsects) + ) + if cmd_load.cmdsize != expected_size: + raise ValueError("Segment size mismatch") + # this is a zero block or something + # so the beginning is wherever the fileoff of this command is + if cmd_cmd.nsects == 0: + if cmd_cmd.filesize != 0: + low_offset = min(low_offset, cmd_cmd.fileoff) + else: + # this one has multiple segments + for j in range(cmd_cmd.nsects): + # read the segment + seg = section_cls.from_fileobj(fh, **kw) + # if the segment has a size and is not zero filled + # then its beginning is the offset of this segment + not_zerofill = ((seg.flags & S_ZEROFILL) != S_ZEROFILL) + if seg.offset > 0 and seg.size > 0 and not_zerofill: + low_offset = min(low_offset, seg.offset) + if not_zerofill: + c = fh.tell() + fh.seek(seg.offset) + sd = fh.read(seg.size) + seg.add_section_data(sd) + fh.seek(c) + segs.append(seg) + # data is a list of segments + cmd_data = segs + + # XXX: Disabled for now because writing back doesn't work + #elif cmd_load.cmd == LC_CODE_SIGNATURE: + # c = fh.tell() + # fh.seek(cmd_cmd.dataoff) + # cmd_data = fh.read(cmd_cmd.datasize) + # fh.seek(c) + #elif cmd_load.cmd == LC_SYMTAB: + # c = fh.tell() + # fh.seek(cmd_cmd.stroff) + # cmd_data = fh.read(cmd_cmd.strsize) + # fh.seek(c) + + else: + # data is a raw str + data_size = ( + cmd_load.cmdsize - sizeof(klass) - sizeof(load_command) + ) + cmd_data = fh.read(data_size) + cmd.append((cmd_load, cmd_cmd, cmd_data)) + read_bytes += cmd_load.cmdsize + + # make sure the header made sense + if read_bytes != header.sizeofcmds: + raise ValueError("Read %d bytes, header reports %d bytes" % ( + read_bytes, header.sizeofcmds)) + self.total_size = sizeof(self.mach_header) + read_bytes + self.low_offset = low_offset + + # this header overwrites a segment, what the heck? + if self.total_size > low_offset: + raise ValueError("total_size > low_offset (%d > %d)" % ( + self.total_size, low_offset)) + + def walkRelocatables(self, shouldRelocateCommand=_shouldRelocateCommand): + """ + for all relocatable commands + yield (command_index, command_name, filename) + """ + for (idx, (lc, cmd, data)) in enumerate(self.commands): + if shouldRelocateCommand(lc.cmd): + name = _RELOCATABLE_NAMES[lc.cmd] + ofs = cmd.name - sizeof(lc.__class__) - sizeof(cmd.__class__) + yield idx, name, data[ofs:data.find(b'\x00', ofs)].decode( + sys.getfilesystemencoding()) + + def rewriteInstallNameCommand(self, loadcmd): + """Rewrite the load command of this dylib""" + if self.id_cmd is not None: + self.rewriteDataForCommand(self.id_cmd, loadcmd) + return True + return False + + def changedHeaderSizeBy(self, bytes): + self.sizediff += bytes + if (self.total_size + self.sizediff) > self.low_offset: + print("WARNING: Mach-O header in %r may be too large to relocate"%(self.parent.filename,)) + + def rewriteLoadCommands(self, changefunc): + """ + Rewrite the load commands based upon a change dictionary + """ + data = changefunc(self.parent.filename) + changed = False + if data is not None: + if self.rewriteInstallNameCommand( + data.encode(sys.getfilesystemencoding())): + changed = True + for idx, name, filename in self.walkRelocatables(): + data = changefunc(filename) + if data is not None: + if self.rewriteDataForCommand(idx, data.encode( + sys.getfilesystemencoding())): + changed = True + return changed + + def rewriteDataForCommand(self, idx, data): + lc, cmd, old_data = self.commands[idx] + hdrsize = sizeof(lc.__class__) + sizeof(cmd.__class__) + align = struct.calcsize('L') + data = data + (b'\x00' * (align - (len(data) % align))) + newsize = hdrsize + len(data) + self.commands[idx] = (lc, cmd, data) + self.changedHeaderSizeBy(newsize - lc.cmdsize) + lc.cmdsize, cmd.name = newsize, hdrsize + return True + + def synchronize_size(self): + if (self.total_size + self.sizediff) > self.low_offset: + raise ValueError("New Mach-O header is too large to relocate in %r"%(self.parent.filename,)) + self.header.sizeofcmds += self.sizediff + self.total_size = sizeof(self.mach_header) + self.header.sizeofcmds + self.sizediff = 0 + + def write(self, fileobj): + fileobj = fileview(fileobj, self.offset, self.size) + fileobj.seek(0) + + # serialize all the mach-o commands + self.synchronize_size() + + self.header.to_fileobj(fileobj) + for lc, cmd, data in self.commands: + lc.to_fileobj(fileobj) + cmd.to_fileobj(fileobj) + + if sys.version_info[0] == 2: + if isinstance(data, unicode): + fileobj.write(data.encode(sys.getfilesystemencoding())) + + elif isinstance(data, (bytes, str)): + fileobj.write(data) + else: + # segments.. + for obj in data: + obj.to_fileobj(fileobj) + else: + if isinstance(data, str): + fileobj.write(data.encode(sys.getfilesystemencoding())) + + elif isinstance(data, bytes): + fileobj.write(data) + + else: + # segments.. + for obj in data: + obj.to_fileobj(fileobj) + + # zero out the unused space, doubt this is strictly necessary + # and is generally probably already the case + fileobj.write(b'\x00' * (self.low_offset - fileobj.tell())) + + def getSymbolTableCommand(self): + for lc, cmd, data in self.commands: + if lc.cmd == LC_SYMTAB: + return cmd + return None + + def getDynamicSymbolTableCommand(self): + for lc, cmd, data in self.commands: + if lc.cmd == LC_DYSYMTAB: + return cmd + return None + + def get_filetype_shortname(self, filetype): + if filetype in MH_FILETYPE_SHORTNAMES: + return MH_FILETYPE_SHORTNAMES[filetype] + else: + return 'unknown' + +def main(fn): + m = MachO(fn) + seen = set() + for header in m.headers: + for idx, name, other in header.walkRelocatables(): + if other not in seen: + seen.add(other) + print('\t' + name + ": " + other) + +if __name__ == '__main__': + import sys + files = sys.argv[1:] or ['/bin/ls'] + for fn in files: + print(fn) + main(fn) diff --git a/python/macholib/macholib/MachOGraph.py b/python/macholib/macholib/MachOGraph.py new file mode 100644 index 000000000..8875c56eb --- /dev/null +++ b/python/macholib/macholib/MachOGraph.py @@ -0,0 +1,131 @@ +""" +Utilities for reading and writing Mach-O headers +""" + +import os +import sys + +from altgraph.Graph import Graph +from altgraph.ObjectGraph import ObjectGraph + +from macholib.mach_o import * +from macholib.dyld import dyld_find +from macholib.MachO import MachO +from macholib.itergraphreport import itergraphreport + +__all__ = ['MachOGraph'] + +try: + unicode +except NameError: + unicode = str + +class MissingMachO(object): + def __init__(self, filename): + self.graphident = filename + self.headers = () + + def __repr__(self): + return '<%s graphident=%r>' % (type(self).__name__, self.graphident) + +class MachOGraph(ObjectGraph): + """ + Graph data structure of Mach-O dependencies + """ + def __init__(self, debug=0, graph=None, env=None, executable_path=None): + super(MachOGraph, self).__init__(debug=debug, graph=graph) + self.env = env + self.trans_table = {} + self.executable_path = executable_path + + def locate(self, filename, loader=None): + assert isinstance(filename, (str, unicode)) + if filename.startswith('@loader_path/') and loader is not None: + fn = self.trans_table.get((loader.filename, filename)) + if fn is None: + try: + fn = dyld_find(filename, env=self.env, + executable_path=self.executable_path, + loader=loader.filename) + self.trans_table[(loader.filename, filename)] = fn + except ValueError: + return None + + else: + fn = self.trans_table.get(filename) + if fn is None: + try: + fn = dyld_find(filename, env=self.env, + executable_path=self.executable_path) + self.trans_table[filename] = fn + except ValueError: + return None + return fn + + def findNode(self, name, loader=None): + assert isinstance(name, (str, unicode)) + data = super(MachOGraph, self).findNode(name) + if data is not None: + return data + newname = self.locate(name, loader=loader) + if newname is not None and newname != name: + return self.findNode(newname) + return None + + def run_file(self, pathname, caller=None): + assert isinstance(pathname, (str, unicode)) + self.msgin(2, "run_file", pathname) + m = self.findNode(pathname, loader=caller) + if m is None: + if not os.path.exists(pathname): + raise ValueError('%r does not exist' % (pathname,)) + m = self.createNode(MachO, pathname) + self.createReference(caller, m, edge_data='run_file') + self.scan_node(m) + self.msgout(2, '') + return m + + def load_file(self, name, caller=None): + assert isinstance(name, (str, unicode)) + self.msgin(2, "load_file", name) + m = self.findNode(name) + if m is None: + newname = self.locate(name, loader=caller) + if newname is not None and newname != name: + return self.load_file(newname, caller=caller) + if os.path.exists(name): + m = self.createNode(MachO, name) + self.scan_node(m) + else: + m = self.createNode(MissingMachO, name) + self.msgout(2, '') + return m + + def scan_node(self, node): + self.msgin(2, 'scan_node', node) + for header in node.headers: + for idx, name, filename in header.walkRelocatables(): + assert isinstance(name, (str, unicode)) + assert isinstance(filename, (str, unicode)) + m = self.load_file(filename, caller=node) + self.createReference(node, m, edge_data=name) + self.msgout(2, '', node) + + def itergraphreport(self, name='G'): + nodes = map(self.graph.describe_node, self.graph.iterdfs(self)) + describe_edge = self.graph.describe_edge + return itergraphreport(nodes, describe_edge, name=name) + + def graphreport(self, fileobj=None): + if fileobj is None: + fileobj = sys.stdout + fileobj.writelines(self.itergraphreport()) + +def main(args): + g = MachOGraph() + for arg in args: + g.run_file(arg) + g.graphreport() + +if __name__ == '__main__': + main(sys.argv[1:] or ['/bin/ls']) diff --git a/python/macholib/macholib/MachOStandalone.py b/python/macholib/macholib/MachOStandalone.py new file mode 100644 index 000000000..f8627336c --- /dev/null +++ b/python/macholib/macholib/MachOStandalone.py @@ -0,0 +1,147 @@ +import os + +from macholib.MachOGraph import MachOGraph, MissingMachO +from macholib.util import iter_platform_files, in_system_path, mergecopy, \ + mergetree, flipwritable, has_filename_filter +from macholib.dyld import framework_info +from collections import deque + +class ExcludedMachO(MissingMachO): + pass + +class FilteredMachOGraph(MachOGraph): + def __init__(self, delegate, *args, **kwargs): + super(FilteredMachOGraph, self).__init__(*args, **kwargs) + self.delegate = delegate + + def createNode(self, cls, name): + cls = self.delegate.getClass(name, cls) + res = super(FilteredMachOGraph, self).createNode(cls, name) + return res + + def locate(self, filename, loader=None): + newname = super(FilteredMachOGraph, self).locate(filename, loader) + if newname is None: + return None + return self.delegate.locate(newname) + +class MachOStandalone(object): + def __init__(self, base, dest=None, graph=None, env=None, + executable_path=None): + self.base = os.path.join(os.path.abspath(base), '') + if dest is None: + dest = os.path.join(self.base, 'Contents', 'Frameworks') + self.dest = dest + self.mm = FilteredMachOGraph(self, graph=graph, env=env, + executable_path=executable_path) + self.changemap = {} + self.excludes = [] + self.pending = deque() + + def getClass(self, name, cls): + if in_system_path(name): + return ExcludedMachO + for base in self.excludes: + if name.startswith(base): + return ExcludedMachO + return cls + + def locate(self, filename): + if in_system_path(filename): + return filename + if filename.startswith(self.base): + return filename + for base in self.excludes: + if filename.startswith(base): + return filename + if filename in self.changemap: + return self.changemap[filename] + info = framework_info(filename) + if info is None: + res = self.copy_dylib(filename) + self.changemap[filename] = res + return res + else: + res = self.copy_framework(info) + self.changemap[filename] = res + return res + + def copy_dylib(self, filename): + # When the filename is a symlink use the basename of the target of the link + # as the name in standalone bundle. This avoids problems when two libraries + # link to the same dylib but using different symlinks. + if os.path.islink(filename): + dest = os.path.join(self.dest, os.path.basename(os.path.realpath(filename))) + else: + dest = os.path.join(self.dest, os.path.basename(filename)) + + if not os.path.exists(dest): + self.mergecopy(filename, dest) + return dest + + def mergecopy(self, src, dest): + return mergecopy(src, dest) + + def mergetree(self, src, dest): + return mergetree(src, dest) + + def copy_framework(self, info): + dest = os.path.join(self.dest, info['shortname'] + '.framework') + destfn = os.path.join(self.dest, info['name']) + src = os.path.join(info['location'], info['shortname'] + '.framework') + if not os.path.exists(dest): + self.mergetree(src, dest) + self.pending.append((destfn, iter_platform_files(dest))) + return destfn + + def run(self, platfiles=None, contents=None): + mm = self.mm + if contents is None: + contents = '@executable_path/..' + if platfiles is None: + platfiles = iter_platform_files(self.base) + + for fn in platfiles: + mm.run_file(fn) + + while self.pending: + fmwk, files = self.pending.popleft() + ref = mm.findNode(fmwk) + for fn in files: + mm.run_file(fn, caller=ref) + + changemap = {} + skipcontents = os.path.join(os.path.dirname(self.dest), '') + machfiles = [] + + for node in mm.flatten(has_filename_filter): + machfiles.append(node) + dest = os.path.join(contents, node.filename[len(skipcontents):]) + changemap[node.filename] = dest + + def changefunc(path): + res = mm.locate(path) + return changemap.get(res) + + for node in machfiles: + fn = mm.locate(node.filename) + if fn is None: + continue + rewroteAny = False + for header in node.headers: + if node.rewriteLoadCommands(changefunc): + rewroteAny = True + if rewroteAny: + old_mode = flipwritable(fn) + try: + with open(fn, 'rb+') as f: + for header in node.headers: + f.seek(0) + node.write(f) + f.seek(0, 2) + f.flush() + finally: + flipwritable(fn, old_mode) + + allfiles = [mm.locate(node.filename) for node in machfiles] + return set(filter(None, allfiles)) diff --git a/python/macholib/macholib/SymbolTable.py b/python/macholib/macholib/SymbolTable.py new file mode 100644 index 000000000..62fb172fd --- /dev/null +++ b/python/macholib/macholib/SymbolTable.py @@ -0,0 +1,95 @@ +""" +Class to read the symbol table from a Mach-O header +""" + +from macholib.mach_o import * + +__all__ = ['SymbolTable'] + +# XXX: Does not support 64-bit, probably broken anyway + +class SymbolTable(object): + def __init__(self, macho, openfile=None): + if openfile is None: + openfile = open + self.macho = macho.headers[0] + self.symtab = macho.getSymbolTableCommand() + self.dysymtab = macho.getDynamicSymbolTableCommand() + fh = openfile(self.macho.filename, 'rb') + try: + if self.symtab is not None: + self.readSymbolTable(fh) + if self.dysymtab is not None: + self.readDynamicSymbolTable(fh) + finally: + fh.close() + + def readSymbolTable(self, fh): + cmd = self.symtab + fh.seek(cmd.stroff) + strtab = fh.read(cmd.strsize) + fh.seek(cmd.symoff) + nlists = [] + for i in xrange(cmd.nsyms): + cmd = nlist.from_fileobj(fh) + if cmd.n_un == 0: + nlists.append((cmd, '')) + else: + nlists.append((cmd, strtab[cmd.n_un:strtab.find(b'\x00', cmd.n_un)])) + self.nlists = nlists + + def readDynamicSymbolTable(self, fh): + cmd = self.dysymtab + nlists = self.nlists + self.localsyms = nlists[cmd.ilocalsym:cmd.ilocalsym+cmd.nlocalsym] + self.extdefsyms = nlists[cmd.iextdefsym:cmd.iextdefsym+cmd.nextdefsym] + self.undefsyms = nlists[cmd.iundefsym:cmd.iundefsym+cmd.nundefsym] + #if cmd.tocoff == 0: + # self.toc = None + #else: + # self.toc = self.readtoc(fh, cmd.tocoff, cmd.ntoc) + #if cmd.modtaboff == 0: + # self.modtab = None + #else: + # self.modtab = self.readmodtab(fh, cmd.modtaboff, cmd.nmodtab) + if cmd.extrefsymoff == 0: + self.extrefsym = None + else: + self.extrefsym = self.readsym(fh, cmd.extrefsymoff, cmd.nextrefsyms) + #if cmd.indirectsymoff == 0: + # self.indirectsym = None + #else: + # self.indirectsym = self.readsym(fh, cmd.indirectsymoff, cmd.nindirectsyms) + #if cmd.extreloff == 0: + # self.extrel = None + #else: + # self.extrel = self.readrel(fh, cmd.extreloff, cmd.nextrel) + #if cmd.locreloff == 0: + # self.locrel = None + #else: + # self.locrel = self.readrel(fh, cmd.locreloff, cmd.nlocrel) + + def readtoc(self, fh, off, n): + #print 'toc', off, n + fh.seek(off) + return [dylib_table_of_contents.from_fileobj(fh) for i in xrange(n)] + + def readmodtab(self, fh, off, n): + #print 'modtab', off, n + fh.seek(off) + return [dylib_module.from_fileobj(fh) for i in xrange(n)] + + def readsym(self, fh, off, n): + #print 'sym', off, n + fh.seek(off) + refs = [] + for i in xrange(n): + ref = dylib_reference.from_fileobj(fh) + isym, flags = divmod(ref.isym_flags, 256) + refs.append((self.nlists[isym], flags)) + return refs + + def readrel(self, fh, off, n): + #print 'rel', off, n + fh.seek(off) + return [relocation_info.from_fileobj(fh) for i in xrange(n)] diff --git a/python/macholib/macholib/__init__.py b/python/macholib/macholib/__init__.py new file mode 100644 index 000000000..df68ce802 --- /dev/null +++ b/python/macholib/macholib/__init__.py @@ -0,0 +1,10 @@ +""" +Enough Mach-O to make your head spin. + +See the relevant header files in /usr/include/mach-o + +And also Apple's documentation. +""" +from __future__ import print_function +import pkg_resources +__version__ = pkg_resources.require('macholib')[0].version diff --git a/python/macholib/macholib/__main__.py b/python/macholib/macholib/__main__.py new file mode 100644 index 000000000..5309872ca --- /dev/null +++ b/python/macholib/macholib/__main__.py @@ -0,0 +1,73 @@ +from __future__ import print_function, absolute_import +import os, sys + +from macholib.util import is_platform_file +from macholib import macho_dump +from macholib import macho_standalone + +gCommand = None + +def check_file(fp, path, callback): + if not os.path.exists(path): + print('%s: %s: No such file or directory' % (gCommand, path), + file=sys.stderr) + return 1 + + try: + is_plat = is_platform_file(path) + + except IOError as msg: + print('%s: %s: %s' % (gCommand, path, msg), file=sys.stderr) + return 1 + + else: + if is_plat: + callback(fp, path) + return 0 + +def walk_tree(callback, paths): + args = sys.argv[1:] + err = 0 + + for base in paths: + if os.path.isdir(base): + for root, dirs, files in os.walk(base): + for fn in files: + err |= check_file( + sys.stdout, os.path.join(root, fn), callback) + else: + err |= check_file(sys.stdout, base, callback) + + return err + +def print_usage(fp): + print("Usage:", file=sys.stderr) + print(" python -mmacholib dump FILE ...", file=fp) + print(" python -mmacholib find DIR ...", file=fp) + print(" python -mmacholib standalone DIR ...", file=fp) + +def main(): + global gCommand + if len(sys.argv) < 3: + print_usage(sys.stderr) + sys.exit(1) + + gCommand = sys.argv[1] + + if gCommand == 'dump': + walk_tree(macho_dump.print_file, sys.argv[2:]) + + elif gCommand == 'find': + walk_tree(lambda fp, path: print(path, file=fp), sys.argv[2:]) + + elif gCommand == 'standalone': + for dn in sys.argv[2:]: + macho_standalone.standaloneApp(dn) + + else: + print_usage(sys.stderr) + sys.exit(1) + + +if __name__ == "__main__": + main() diff --git a/python/macholib/macholib/_cmdline.py b/python/macholib/macholib/_cmdline.py new file mode 100644 index 000000000..eb44824f9 --- /dev/null +++ b/python/macholib/macholib/_cmdline.py @@ -0,0 +1,44 @@ +""" +Internal helpers for basic commandline tools +""" +from __future__ import print_function, absolute_import +import os +import sys + +from macholib.util import is_platform_file + +def check_file(fp, path, callback): + if not os.path.exists(path): + print('%s: %s: No such file or directory' % (sys.argv[0], path), file=sys.stderr) + return 1 + + try: + is_plat = is_platform_file(path) + + except IOError as msg: + print('%s: %s: %s' % (sys.argv[0], path, msg), file=sys.stderr) + return 1 + + else: + if is_plat: + callback(fp, path) + return 0 + +def main(callback): + args = sys.argv[1:] + name = os.path.basename(sys.argv[0]) + err = 0 + + if not args: + print("Usage: %s filename..."%(name,), file=sys.stderr) + return 1 + + for base in args: + if os.path.isdir(base): + for root, dirs, files in os.walk(base): + for fn in files: + err |= check_file(sys.stdout, os.path.join(root, fn), callback) + else: + err |= check_file(sys.stdout, base, callback) + + return err diff --git a/python/macholib/macholib/dyld.py b/python/macholib/macholib/dyld.py new file mode 100644 index 000000000..2e81db7f8 --- /dev/null +++ b/python/macholib/macholib/dyld.py @@ -0,0 +1,176 @@ +""" +dyld emulation +""" + +from itertools import chain + +import os, sys + +from macholib.framework import framework_info +from macholib.dylib import dylib_info + +__all__ = [ + 'dyld_find', 'framework_find', + 'framework_info', 'dylib_info', +] + +# These are the defaults as per man dyld(1) +# +_DEFAULT_FRAMEWORK_FALLBACK = [ + os.path.expanduser("~/Library/Frameworks"), + "/Library/Frameworks", + "/Network/Library/Frameworks", + "/System/Library/Frameworks", +] + +_DEFAULT_LIBRARY_FALLBACK = [ + os.path.expanduser("~/lib"), + "/usr/local/lib", + "/lib", + "/usr/lib", +] + +# XXX: Is this function still needed? +if sys.version_info[0] == 2: + def _ensure_utf8(s): + """Not all of PyObjC and Python understand unicode paths very well yet""" + if isinstance(s, unicode): + return s.encode('utf8') + return s +else: + def _ensure_utf8(s): + if s is not None and not isinstance(s, str): + raise ValueError(s) + return s + + +def _dyld_env(env, var): + if env is None: + env = os.environ + rval = env.get(var) + if rval is None or rval == '': + return [] + return rval.split(':') + +def dyld_image_suffix(env=None): + if env is None: + env = os.environ + return env.get('DYLD_IMAGE_SUFFIX') + +def dyld_framework_path(env=None): + return _dyld_env(env, 'DYLD_FRAMEWORK_PATH') + +def dyld_library_path(env=None): + return _dyld_env(env, 'DYLD_LIBRARY_PATH') + +def dyld_fallback_framework_path(env=None): + return _dyld_env(env, 'DYLD_FALLBACK_FRAMEWORK_PATH') + +def dyld_fallback_library_path(env=None): + return _dyld_env(env, 'DYLD_FALLBACK_LIBRARY_PATH') + +def dyld_image_suffix_search(iterator, env=None): + """For a potential path iterator, add DYLD_IMAGE_SUFFIX semantics""" + suffix = dyld_image_suffix(env) + if suffix is None: + return iterator + def _inject(iterator=iterator, suffix=suffix): + for path in iterator: + if path.endswith('.dylib'): + yield path[:-len('.dylib')] + suffix + '.dylib' + else: + yield path + suffix + yield path + return _inject() + +def dyld_override_search(name, env=None): + # If DYLD_FRAMEWORK_PATH is set and this dylib_name is a + # framework name, use the first file that exists in the framework + # path if any. If there is none go on to search the DYLD_LIBRARY_PATH + # if any. + + framework = framework_info(name) + + if framework is not None: + for path in dyld_framework_path(env): + yield os.path.join(path, framework['name']) + + # If DYLD_LIBRARY_PATH is set then use the first file that exists + # in the path. If none use the original name. + for path in dyld_library_path(env): + yield os.path.join(path, os.path.basename(name)) + +def dyld_executable_path_search(name, executable_path=None): + # If we haven't done any searching and found a library and the + # dylib_name starts with "@executable_path/" then construct the + # library name. + if name.startswith('@executable_path/') and executable_path is not None: + yield os.path.join(executable_path, name[len('@executable_path/'):]) + +def dyld_loader_search(name, loader_path=None): + # If we haven't done any searching and found a library and the + # dylib_name starts with "@loader_path/" then construct the + # library name. + if name.startswith('@loader_path/') and loader_path is not None: + yield os.path.join(loader_path, name[len('@loader_path/'):]) + +def dyld_default_search(name, env=None): + yield name + + framework = framework_info(name) + + if framework is not None: + fallback_framework_path = dyld_fallback_framework_path(env) + + if fallback_framework_path: + for path in fallback_framework_path: + yield os.path.join(path, framework['name']) + + else: + for path in _DEFAULT_FRAMEWORK_FALLBACK: + yield os.path.join(path, framework['name']) + + fallback_library_path = dyld_fallback_library_path(env) + if fallback_library_path: + for path in fallback_library_path: + yield os.path.join(path, os.path.basename(name)) + + else: + for path in _DEFAULT_LIBRARY_FALLBACK: + yield os.path.join(path, os.path.basename(name)) + +def dyld_find(name, executable_path=None, env=None, loader_path=None): + """ + Find a library or framework using dyld semantics + """ + name = _ensure_utf8(name) + executable_path = _ensure_utf8(executable_path) + for path in dyld_image_suffix_search(chain( + dyld_override_search(name, env), + dyld_executable_path_search(name, executable_path), + dyld_loader_search(name, loader_path), + dyld_default_search(name, env), + ), env): + if os.path.isfile(path): + return path + raise ValueError("dylib %s could not be found" % (name,)) + +def framework_find(fn, executable_path=None, env=None): + """ + Find a framework using dyld semantics in a very loose manner. + + Will take input such as: + Python + Python.framework + Python.framework/Versions/Current + """ + try: + return dyld_find(fn, executable_path=executable_path, env=env) + except ValueError: + pass + fmwk_index = fn.rfind('.framework') + if fmwk_index == -1: + fmwk_index = len(fn) + fn += '.framework' + fn = os.path.join(fn, os.path.basename(fn[:fmwk_index])) + return dyld_find(fn, executable_path=executable_path, env=env) diff --git a/python/macholib/macholib/dylib.py b/python/macholib/macholib/dylib.py new file mode 100644 index 000000000..cea6a95c3 --- /dev/null +++ b/python/macholib/macholib/dylib.py @@ -0,0 +1,42 @@ +""" +Generic dylib path manipulation +""" + +import re + +__all__ = ['dylib_info'] + +_DYLIB_RE = re.compile(r"""(?x) +(?P^.*)(?:^|/) +(?P + (?P\w+?) + (?:\.(?P[^._]+))? + (?:_(?P[^._]+))? + \.dylib$ +) +""") + +def dylib_info(filename): + """ + A dylib name can take one of the following four forms: + Location/Name.SomeVersion_Suffix.dylib + Location/Name.SomeVersion.dylib + Location/Name_Suffix.dylib + Location/Name.dylib + + returns None if not found or a mapping equivalent to: + dict( + location='Location', + name='Name.SomeVersion_Suffix.dylib', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + ) + + Note that SomeVersion and Suffix are optional and may be None + if not present. + """ + is_dylib = _DYLIB_RE.match(filename) + if not is_dylib: + return None + return is_dylib.groupdict() diff --git a/python/macholib/macholib/framework.py b/python/macholib/macholib/framework.py new file mode 100644 index 000000000..da099573c --- /dev/null +++ b/python/macholib/macholib/framework.py @@ -0,0 +1,42 @@ +""" +Generic framework path manipulation +""" + +import re + +__all__ = ['framework_info'] + +_STRICT_FRAMEWORK_RE = re.compile(r"""(?x) +(?P^.*)(?:^|/) +(?P + (?P[-_A-Za-z0-9]+).framework/ + (?:Versions/(?P[^/]+)/)? + (?P=shortname) + (?:_(?P[^_]+))? +)$ +""") + +def framework_info(filename): + """ + A framework name can take one of the following four forms: + Location/Name.framework/Versions/SomeVersion/Name_Suffix + Location/Name.framework/Versions/SomeVersion/Name + Location/Name.framework/Name_Suffix + Location/Name.framework/Name + + returns None if not found, or a mapping equivalent to: + dict( + location='Location', + name='Name.framework/Versions/SomeVersion/Name_Suffix', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + ) + + Note that SomeVersion and Suffix are optional and may be None + if not present + """ + is_framework = _STRICT_FRAMEWORK_RE.match(filename) + if not is_framework: + return None + return is_framework.groupdict() diff --git a/python/macholib/macholib/itergraphreport.py b/python/macholib/macholib/itergraphreport.py new file mode 100644 index 000000000..453c96e2a --- /dev/null +++ b/python/macholib/macholib/itergraphreport.py @@ -0,0 +1,73 @@ +""" +Utilities for creating dot output from a MachOGraph + +XXX: need to rewrite this based on altgraph.Dot +""" + +from collections import deque + +try: + from itertools import imap +except ImportError: + imap = map + +__all__ = ['itergraphreport'] + +def itergraphreport(nodes, describe_edge, name='G'): + edges = deque() + nodetoident = {} + mainedges = set() + + def nodevisitor(node, data, outgoing, incoming): + return {'label': str(node)} + + def edgevisitor(edge, data, head, tail): + return {} + + yield 'digraph %s {\n' % (name,) + attr = dict(rankdir='LR', concentrate='true') + cpatt = '%s="%s"' + for item in attr.iteritems(): + yield '\t%s;\n' % (cpatt % item,) + + # find all packages (subgraphs) + for (node, data, outgoing, incoming) in nodes: + nodetoident[node] = getattr(data, 'identifier', node) + + # create sets for subgraph, write out descriptions + for (node, data, outgoing, incoming) in nodes: + # update edges + for edge in imap(describe_edge, outgoing): + edges.append(edge) + + # describe node + yield '\t"%s" [%s];\n' % ( + node, + ','.join([ + (cpatt % item) for item in + nodevisitor(node, data, outgoing, incoming).iteritems() + ]), + ) + + graph = [] + + while edges: + edge, data, head, tail = edges.popleft() + if data in ('run_file', 'load_dylib'): + graph.append((edge, data, head, tail)) + + def do_graph(edges, tabs): + edgestr = tabs + '"%s" -> "%s" [%s];\n' + # describe edge + for (edge, data, head, tail) in edges: + attribs = edgevisitor(edge, data, head, tail) + yield edgestr % ( + head, + tail, + ','.join([(cpatt % item) for item in attribs.iteritems()]), + ) + + for s in do_graph(graph, '\t'): + yield s + + yield '}\n' diff --git a/python/macholib/macholib/mach_o.py b/python/macholib/macholib/mach_o.py new file mode 100644 index 000000000..1a85c75cf --- /dev/null +++ b/python/macholib/macholib/mach_o.py @@ -0,0 +1,1311 @@ +""" +Other than changing the load commands in such a way that they do not +contain the load command itself, this is largely a by-hand conversion +of the C headers. Hopefully everything in here should be at least as +obvious as the C headers, and you should be using the C headers as a real +reference because the documentation didn't come along for the ride. + +Doing much of anything with the symbol tables or segments is really +not covered at this point. + +See /usr/include/mach-o and friends. +""" +import time + +from macholib.ptypes import * + + +_CPU_ARCH_ABI64 = 0x01000000 + +CPU_TYPE_NAMES = { + -1: 'ANY', + 1: 'VAX', + 6: 'MC680x0', + 7: 'i386', + _CPU_ARCH_ABI64 | 7: 'x86_64', + 8: 'MIPS', + 10: 'MC98000', + 11: 'HPPA', + 12: 'ARM', + _CPU_ARCH_ABI64 | 12: 'ARM64', + 13: 'MC88000', + 14: 'SPARC', + 15: 'i860', + 16: 'Alpha', + 18: 'PowerPC', + _CPU_ARCH_ABI64 | 18: 'PowerPC64', +} + +INTEL64_SUBTYPE = { + 3 : "CPU_SUBTYPE_X86_64_ALL", + 4 : "CPU_SUBTYPE_X86_ARCH1" +} + +#define CPU_SUBTYPE_INTEL(f, m) ((cpu_subtype_t) (f) + ((m) << 4)) +INTEL_SUBTYPE = { + 0 : "CPU_SUBTYPE_INTEL_MODEL_ALL", + 1 : "CPU_THREADTYPE_INTEL_HTT", + 3 : "CPU_SUBTYPE_I386_ALL", + 4 : "CPU_SUBTYPE_486", + 5 : "CPU_SUBTYPE_586", + 8 : "CPU_SUBTYPE_PENTIUM_3", + 9 : "CPU_SUBTYPE_PENTIUM_M", + 10 : "CPU_SUBTYPE_PENTIUM_4", + 11 : "CPU_SUBTYPE_ITANIUM", + 12 : "CPU_SUBTYPE_XEON", + 34 : "CPU_SUBTYPE_XEON_MP", + 42 : "CPU_SUBTYPE_PENTIUM_4_M", + 43 : "CPU_SUBTYPE_ITANIUM_2", + 38 : "CPU_SUBTYPE_PENTPRO", + 40 : "CPU_SUBTYPE_PENTIUM_3_M", + 52 : "CPU_SUBTYPE_PENTIUM_3_XEON", + 102 : "CPU_SUBTYPE_PENTII_M3", + 132 : "CPU_SUBTYPE_486SX", + 166 : "CPU_SUBTYPE_PENTII_M5", + 199 : "CPU_SUBTYPE_CELERON", + 231 : "CPU_SUBTYPE_CELERON_MOBILE" +} + +MC680_SUBTYPE = { + 1 : "CPU_SUBTYPE_MC680x0_ALL", + 2 : "CPU_SUBTYPE_MC68040", + 3 : "CPU_SUBTYPE_MC68030_ONLY" +} + +MIPS_SUBTYPE = { + 0 : "CPU_SUBTYPE_MIPS_ALL", + 1 : "CPU_SUBTYPE_MIPS_R2300", + 2 : "CPU_SUBTYPE_MIPS_R2600", + 3 : "CPU_SUBTYPE_MIPS_R2800", + 4 : "CPU_SUBTYPE_MIPS_R2000a", + 5 : "CPU_SUBTYPE_MIPS_R2000", + 6 : "CPU_SUBTYPE_MIPS_R3000a", + 7 : "CPU_SUBTYPE_MIPS_R3000" +} + +MC98000_SUBTYPE = { + 0 : "CPU_SUBTYPE_MC98000_ALL", + 1 : "CPU_SUBTYPE_MC98601" +} + +HPPA_SUBTYPE = { + 0 : "CPU_SUBTYPE_HPPA_7100", + 1 : "CPU_SUBTYPE_HPPA_7100LC" +} + +MC88_SUBTYPE = { + 0 : "CPU_SUBTYPE_MC88000_ALL", + 1 : "CPU_SUBTYPE_MC88100", + 2 : "CPU_SUBTYPE_MC88110" +} + +SPARC_SUBTYPE = { + 0 : "CPU_SUBTYPE_SPARC_ALL" +} + +I860_SUBTYPE = { + 0 : "CPU_SUBTYPE_I860_ALL", + 1 : "CPU_SUBTYPE_I860_860" +} + +POWERPC_SUBTYPE = { + 0 : "CPU_SUBTYPE_POWERPC_ALL", + 1 : "CPU_SUBTYPE_POWERPC_601", + 2 : "CPU_SUBTYPE_POWERPC_602", + 3 : "CPU_SUBTYPE_POWERPC_603", + 4 : "CPU_SUBTYPE_POWERPC_603e", + 5 : "CPU_SUBTYPE_POWERPC_603ev", + 6 : "CPU_SUBTYPE_POWERPC_604", + 7 : "CPU_SUBTYPE_POWERPC_604e", + 8 : "CPU_SUBTYPE_POWERPC_620", + 9 : "CPU_SUBTYPE_POWERPC_750", + 10 : "CPU_SUBTYPE_POWERPC_7400", + 11 : "CPU_SUBTYPE_POWERPC_7450", + 100 : "CPU_SUBTYPE_POWERPC_970" +} + +ARM_SUBTYPE = { + 0 : "CPU_SUBTYPE_ARM_ALL12", + 5 : "CPU_SUBTYPE_ARM_V4T", + 6 : "CPU_SUBTYPE_ARM_V6", + 7 : "CPU_SUBTYPE_ARM_V5TEJ", + 8 : "CPU_SUBTYPE_ARM_XSCALE", + 9 : "CPU_SUBTYPE_ARM_V7", + 10 : "CPU_SUBTYPE_ARM_V7F", + 12 : "CPU_SUBTYPE_ARM_V7K" +} + +VAX_SUBTYPE = { + 0 : "CPU_SUBTYPE_VAX_ALL", + 1 : "CPU_SUBTYPE_VAX780", + 2 : "CPU_SUBTYPE_VAX785", + 3 : "CPU_SUBTYPE_VAX750", + 4 : "CPU_SUBTYPE_VAX730", + 5 : "CPU_SUBTYPE_UVAXI", + 6 : "CPU_SUBTYPE_UVAXII", + 7 : "CPU_SUBTYPE_VAX8200", + 8 : "CPU_SUBTYPE_VAX8500", + 9 : "CPU_SUBTYPE_VAX8600", + 10 : "CPU_SUBTYPE_VAX8650", + 11 : "CPU_SUBTYPE_VAX8800", + 12 : "CPU_SUBTYPE_UVAXIII", +} + + +def get_cpu_subtype(cpu_type, cpu_subtype): + st = cpu_subtype & 0x0fffffff + + if cpu_type == 1: + subtype = VAX_SUBTYPE.get(st, st) + elif cpu_type == 6: + subtype = MC680_SUBTYPE.get(st, st) + elif cpu_type == 7: + subtype = INTEL_SUBTYPE.get(st, st) + elif cpu_type == 7 | _CPU_ARCH_ABI64: + subtype = INTEL64_SUBTYPE.get(st, st) + elif cpu_type == 8: + subtype = MIPS_SUBTYPE.get(st, st) + elif cpu_type == 10: + subtype = MC98000_SUBTYPE.get(st, st) + elif cpu_type == 11: + subtype = HPPA_SUBTYPE.get(st, st) + elif cpu_type == 12: + subtype = ARM_SUBTYPE.get(st, st) + elif cpu_type == 13: + subtype = MC88_SUBTYPE.get(st, st) + elif cpu_type == 14: + subtype = SPARC_SUBTYPE.get(st, st) + elif cpu_type == 15: + subtype = I860_SUBTYPE.get(st, st) + elif cpu_type == 16: + subtype = MIPS_SUBTYPE.get(st, st) + elif cpu_type == 18: + subtype = POWERPC_SUBTYPE.get(st, st) + elif cpu_type == 18 | _CPU_ARCH_ABI64: + subtype = POWERPC_SUBTYPE.get(st, st) + else: + subtype = str(st) + + return subtype + + +_MH_EXECUTE_SYM = "__mh_execute_header" +MH_EXECUTE_SYM = "_mh_execute_header" +_MH_BUNDLE_SYM = "__mh_bundle_header" +MH_BUNDLE_SYM = "_mh_bundle_header" +_MH_DYLIB_SYM = "__mh_dylib_header" +MH_DYLIB_SYM = "_mh_dylib_header" +_MH_DYLINKER_SYM = "__mh_dylinker_header" +MH_DYLINKER_SYM = "_mh_dylinker_header" + +( + MH_OBJECT, MH_EXECUTE, MH_FVMLIB, MH_CORE, MH_PRELOAD, MH_DYLIB, + MH_DYLINKER, MH_BUNDLE, MH_DYLIB_STUB, MH_DSYM +) = range(0x1, 0xb) + +( + MH_NOUNDEFS, MH_INCRLINK, MH_DYLDLINK, MH_BINDATLOAD, MH_PREBOUND, + MH_SPLIT_SEGS, MH_LAZY_INIT, MH_TWOLEVEL, MH_FORCE_FLAT, MH_NOMULTIDEFS, + MH_NOFIXPREBINDING, MH_PREBINDABLE, MH_ALLMODSBOUND, MH_SUBSECTIONS_VIA_SYMBOLS, + MH_CANONICAL, MH_WEAK_DEFINES, MH_BINDS_TO_WEAK, MH_ALLOW_STACK_EXECUTION, + MH_ROOT_SAFE, MH_SETUID_SAFE, MH_NO_REEXPORTED_DYLIBS, MH_PIE, + MH_DEAD_STRIPPABLE_DYLIB, MH_HAS_TLV_DESCRIPTORS, MH_NO_HEAP_EXECUTION +) = map((1).__lshift__, range(25)) + +MH_MAGIC = 0xfeedface +MH_CIGAM = 0xcefaedfe +MH_MAGIC_64 = 0xfeedfacf +MH_CIGAM_64 = 0xcffaedfe + +integer_t = p_int32 +cpu_type_t = integer_t +cpu_subtype_t = p_uint32 + +MH_FILETYPE_NAMES = { + MH_OBJECT: 'relocatable object', + MH_EXECUTE: 'demand paged executable', + MH_FVMLIB: 'fixed vm shared library', + MH_CORE: 'core', + MH_PRELOAD: 'preloaded executable', + MH_DYLIB: 'dynamically bound shared library', + MH_DYLINKER: 'dynamic link editor', + MH_BUNDLE: 'dynamically bound bundle', + MH_DYLIB_STUB: 'shared library stub for static linking', + MH_DSYM: 'symbol information', +} + +MH_FILETYPE_SHORTNAMES = { + MH_OBJECT: 'object', + MH_EXECUTE: 'execute', + MH_FVMLIB: 'fvmlib', + MH_CORE: 'core', + MH_PRELOAD: 'preload', + MH_DYLIB: 'dylib', + MH_DYLINKER: 'dylinker', + MH_BUNDLE: 'bundle', + MH_DYLIB_STUB: 'dylib_stub', + MH_DSYM: 'dsym', +} + +MH_FLAGS_NAMES = { + MH_NOUNDEFS: 'MH_NOUNDEFS', + MH_INCRLINK: 'MH_INCRLINK', + MH_DYLDLINK: 'MH_DYLDLINK', + MH_BINDATLOAD: 'MH_BINDATLOAD', + MH_PREBOUND: 'MH_PREBOUND', + MH_SPLIT_SEGS: 'MH_SPLIT_SEGS', + MH_LAZY_INIT: 'MH_LAZY_INIT', + MH_TWOLEVEL: 'MH_TWOLEVEL', + MH_FORCE_FLAT: 'MH_FORCE_FLAT', + MH_NOMULTIDEFS: 'MH_NOMULTIDEFS', + MH_NOFIXPREBINDING: 'MH_NOFIXPREBINDING', + MH_PREBINDABLE: 'MH_PREBINDABLE', + MH_ALLMODSBOUND: 'MH_ALLMODSBOUND', + MH_SUBSECTIONS_VIA_SYMBOLS: 'MH_SUBSECTIONS_VIA_SYMBOLS', + MH_CANONICAL: 'MH_CANONICAL', + MH_WEAK_DEFINES: 'MH_WEAK_DEFINES', + MH_BINDS_TO_WEAK: 'MH_BINDS_TO_WEAK', + MH_ALLOW_STACK_EXECUTION: 'MH_ALLOW_STACK_EXECUTION', + MH_ROOT_SAFE: 'MH_ROOT_SAFE', + MH_SETUID_SAFE: 'MH_SETUID_SAFE', + MH_NO_REEXPORTED_DYLIBS: 'MH_NO_REEXPORTED_DYLIBS', + MH_PIE: 'MH_PIE', + MH_DEAD_STRIPPABLE_DYLIB: 'MH_DEAD_STRIPPABLE_DYLIB', + MH_HAS_TLV_DESCRIPTORS: 'MH_HAS_TLV_DESCRIPTORS', + MH_NO_HEAP_EXECUTION: 'MH_NO_HEAP_EXECUTION', +} + +MH_FLAGS_DESCRIPTIONS = { + MH_NOUNDEFS: 'no undefined references', + MH_INCRLINK: 'output of an incremental link', + MH_DYLDLINK: 'input for the dynamic linker', + MH_BINDATLOAD: 'undefined references bound dynamically when loaded', + MH_PREBOUND: 'dynamic undefined references prebound', + MH_SPLIT_SEGS: 'split read-only and read-write segments', + MH_LAZY_INIT: '(obsolete)', + MH_TWOLEVEL: 'using two-level name space bindings', + MH_FORCE_FLAT: 'forcing all imagges to use flat name space bindings', + MH_NOMULTIDEFS: 'umbrella guarantees no multiple definitions', + MH_NOFIXPREBINDING: 'do not notify prebinding agent about this executable', + MH_PREBINDABLE: 'the binary is not prebound but can have its prebinding redone', + MH_ALLMODSBOUND: 'indicates that this binary binds to all two-level namespace modules of its dependent libraries', + MH_SUBSECTIONS_VIA_SYMBOLS: 'safe to divide up the sections into sub-sections via symbols for dead code stripping', + MH_CANONICAL: 'the binary has been canonicalized via the unprebind operation', + MH_WEAK_DEFINES: 'the final linked image contains external weak symbols', + MH_BINDS_TO_WEAK: 'the final linked image uses weak symbols', + MH_ALLOW_STACK_EXECUTION: 'all stacks in the task will be given stack execution privilege', + MH_ROOT_SAFE: 'the binary declares it is safe for use in processes with uid zero', + MH_SETUID_SAFE: 'the binary declares it is safe for use in processes when issetugid() is true', + MH_NO_REEXPORTED_DYLIBS: 'the static linker does not need to examine dependent dylibs to see if any are re-exported', + MH_PIE: 'the OS will load the main executable at a random address', + MH_DEAD_STRIPPABLE_DYLIB: 'the static linker will automatically not create a LC_LOAD_DYLIB load command to the dylib if no symbols are being referenced from the dylib', + MH_HAS_TLV_DESCRIPTORS: 'contains a section of type S_THREAD_LOCAL_VARIABLES', + MH_NO_HEAP_EXECUTION: 'the OS will run the main executable with a non-executable heap even on platforms that don\'t require it', +} + +class mach_version_helper(Structure): + _fields_ = ( + ('major', p_ushort), + ('minor', p_uint8), + ('rev', p_uint8), + ) + def __str__(self): + return '%s.%s.%s' % (self.major, self.minor, self.rev) + +class mach_timestamp_helper(p_uint32): + def __str__(self): + return time.ctime(self) + +def read_struct(f, s, **kw): + return s.from_fileobj(f, **kw) + +class mach_header(Structure): + _fields_ = ( + ('magic', p_uint32), + ('cputype', cpu_type_t), + ('cpusubtype', cpu_subtype_t), + ('filetype', p_uint32), + ('ncmds', p_uint32), + ('sizeofcmds', p_uint32), + ('flags', p_uint32), + ) + def _describe(self): + bit = 1 + flags = self.flags + dflags = [] + while flags and bit < (1<<32): + if flags & bit: + dflags.append({'name': MH_FLAGS_NAMES.get(bit, str(bit)), 'description': MH_FLAGS_DESCRIPTIONS.get(bit, str(bit))}) + flags = flags ^ bit + bit <<= 1 + return ( + ('magic', int(self.magic)), + ('cputype_string', CPU_TYPE_NAMES.get(self.cputype, self.cputype)), + ('cputype', int(self.cputype)), + ('cpusubtype_string', get_cpu_subtype(self.cputype, self.cpusubtype)), + ('cpusubtype', int(self.cpusubtype)), + ('filetype_string', MH_FILETYPE_NAMES.get(self.filetype, self.filetype)), + ('filetype', int(self.filetype)), + ('ncmds', self.ncmds), + ('sizeofcmds', self.sizeofcmds), + ('flags', dflags), + ('raw_flags', int(self.flags)) + ) + +class mach_header_64(mach_header): + _fields_ = mach_header._fields_ + (('reserved', p_uint32),) + +class load_command(Structure): + _fields_ = ( + ('cmd', p_uint32), + ('cmdsize', p_uint32), + ) + + def get_cmd_name(self): + return LC_NAMES.get(self.cmd, self.cmd) + +LC_REQ_DYLD = 0x80000000 + +( + LC_SEGMENT, LC_SYMTAB, LC_SYMSEG, LC_THREAD, LC_UNIXTHREAD, LC_LOADFVMLIB, + LC_IDFVMLIB, LC_IDENT, LC_FVMFILE, LC_PREPAGE, LC_DYSYMTAB, LC_LOAD_DYLIB, + LC_ID_DYLIB, LC_LOAD_DYLINKER, LC_ID_DYLINKER, LC_PREBOUND_DYLIB, + LC_ROUTINES, LC_SUB_FRAMEWORK, LC_SUB_UMBRELLA, LC_SUB_CLIENT, + LC_SUB_LIBRARY, LC_TWOLEVEL_HINTS, LC_PREBIND_CKSUM +) = range(0x1, 0x18) + +LC_LOAD_WEAK_DYLIB = LC_REQ_DYLD | 0x18 + +LC_SEGMENT_64 = 0x19 +LC_ROUTINES_64 = 0x1a +LC_UUID = 0x1b +LC_RPATH = (0x1c | LC_REQ_DYLD) +LC_CODE_SIGNATURE = 0x1d +LC_CODE_SEGMENT_SPLIT_INFO = 0x1e +LC_REEXPORT_DYLIB = 0x1f | LC_REQ_DYLD +LC_LAZY_LOAD_DYLIB = 0x20 +LC_ENCRYPTION_INFO = 0x21 +LC_DYLD_INFO = 0x22 +LC_DYLD_INFO_ONLY = 0x22 | LC_REQ_DYLD +LC_LOAD_UPWARD_DYLIB = 0x23 | LC_REQ_DYLD +LC_VERSION_MIN_MACOSX = 0x24 +LC_VERSION_MIN_IPHONEOS = 0x25 +LC_FUNCTION_STARTS = 0x26 +LC_DYLD_ENVIRONMENT = 0x27 +LC_MAIN = 0x28 | LC_REQ_DYLD +LC_DATA_IN_CODE = 0x29 +LC_SOURCE_VERSION = 0x2a +LC_DYLIB_CODE_SIGN_DRS = 0x2b +LC_ENCRYPTION_INFO_64 = 0x2c +LC_LINKER_OPTION = 0x2d + + +# this is really a union.. but whatever +class lc_str(p_uint32): + pass + +p_str16 = pypackable('p_str16', bytes, '16s') + +vm_prot_t = p_int32 +class segment_command(Structure): + _fields_ = ( + ('segname', p_str16), + ('vmaddr', p_uint32), + ('vmsize', p_uint32), + ('fileoff', p_uint32), + ('filesize', p_uint32), + ('maxprot', vm_prot_t), + ('initprot', vm_prot_t), + ('nsects', p_uint32), # read the section structures ? + ('flags', p_uint32), + ) + + def describe(self): + segname = self.segname + s = {} + s['segname'] = self.segname.rstrip('\x00') + s['vmaddr'] = int(self.vmaddr) + s['vmsize'] = int(self.vmsize) + s['fileoff'] = int(self.fileoff) + s['filesize'] = int(self.filesize) + s['initprot'] = self.get_initial_virtual_memory_protections() + s['initprot_raw'] = int(self.initprot) + s['maxprot'] = self.get_max_virtual_memory_protections() + s['maxprot_raw'] = int(self.maxprot) + s['nsects'] = int(self.nsects) + s['flags'] = self.flags + return s + + def get_initial_virtual_memory_protections(self): + vm = [] + if self.initprot == 0: + vm.append("VM_PROT_NONE") + if self.initprot & 1: + vm.append("VM_PROT_READ") + if self.initprot & 2: + vm.append("VM_PROT_WRITE") + if self.initprot & 4: + vm.append("VM_PROT_EXECUTE") + return vm + + def get_max_virtual_memory_protections(self): + vm = [] + if self.maxprot == 0: + vm.append("VM_PROT_NONE") + if self.maxprot & 1: + vm.append("VM_PROT_READ") + if self.maxprot & 2: + vm.append("VM_PROT_WRITE") + if self.maxprot & 4: + vm.append("VM_PROT_EXECUTE") + return vm + +class segment_command_64(Structure): + _fields_ = ( + ('segname', p_str16), + ('vmaddr', p_uint64), + ('vmsize', p_uint64), + ('fileoff', p_uint64), + ('filesize', p_uint64), + ('maxprot', vm_prot_t), + ('initprot', vm_prot_t), + ('nsects', p_uint32), # read the section structures ? + ('flags', p_uint32), + ) + + def describe(self): + s = {} + s['segname'] = self.segname.rstrip('\x00') + s['vmaddr'] = int(self.vmaddr) + s['vmsize'] = int(self.vmsize) + s['fileoff'] = int(self.fileoff) + s['filesize'] = int(self.filesize) + s['initprot'] = self.get_initial_virtual_memory_protections() + s['initprot_raw'] = int(self.initprot) + s['maxprot'] = self.get_max_virtual_memory_protections() + s['maxprot_raw'] = int(self.maxprot) + s['nsects'] = int(self.nsects) + s['flags'] = self.flags + return s + + def get_initial_virtual_memory_protections(self): + vm = [] + if self.initprot == 0: + vm.append("VM_PROT_NONE") + if self.initprot & 1: + vm.append("VM_PROT_READ") + if self.initprot & 2: + vm.append("VM_PROT_WRITE") + if self.initprot & 4: + vm.append("VM_PROT_EXECUTE") + return vm + + def get_max_virtual_memory_protections(self): + vm = [] + if self.maxprot == 0: + vm.append("VM_PROT_NONE") + if self.maxprot & 1: + vm.append("VM_PROT_READ") + if self.maxprot & 2: + vm.append("VM_PROT_WRITE") + if self.maxprot & 4: + vm.append("VM_PROT_EXECUTE") + return vm + + +SG_HIGHVM = 0x1 +SG_FVMLIB = 0x2 +SG_NORELOC = 0x4 + +class section(Structure): + _fields_ = ( + ('sectname', p_str16), + ('segname', p_str16), + ('addr', p_uint32), + ('size', p_uint32), + ('offset', p_uint32), + ('align', p_uint32), + ('reloff', p_uint32), + ('nreloc', p_uint32), + ('flags', p_uint32), + ('reserved1', p_uint32), + ('reserved2', p_uint32), + ) + + def describe(self): + s = {} + s['sectname'] = self.sectname.rstrip('\x00') + s['segname'] = self.segname.rstrip('\x00') + s['addr'] = int(self.addr) + s['size'] = int(self.size) + s['offset'] = int(self.offset) + s['align'] = int(self.align) + s['reloff'] = int(self.reloff) + s['nreloc'] = int(self.nreloc) + f = {} + f['type'] = FLAG_SECTION_TYPES[int(self.flags) & 0xff] + f['attributes'] = [] + for k in FLAG_SECTION_ATTRIBUTES: + if k & self.flags: + f['attributes'].append(FLAG_SECTION_ATTRIBUTES[k]) + if not f['attributes']: + del f['attributes'] + s['flags'] = f + s['reserved1'] = int(self.reserved1) + s['reserved2'] = int(self.reserved2) + return s + + def add_section_data(self, data): + self.section_data = data + +class section_64(Structure): + _fields_ = ( + ('sectname', p_str16), + ('segname', p_str16), + ('addr', p_uint64), + ('size', p_uint64), + ('offset', p_uint32), + ('align', p_uint32), + ('reloff', p_uint32), + ('nreloc', p_uint32), + ('flags', p_uint32), + ('reserved1', p_uint32), + ('reserved2', p_uint32), + ('reserved3', p_uint32), + ) + + def describe(self): + s = {} + s['sectname'] = self.sectname.rstrip('\x00') + s['segname'] = self.segname.rstrip('\x00') + s['addr'] = int(self.addr) + s['size'] = int(self.size) + s['offset'] = int(self.offset) + s['align'] = int(self.align) + s['reloff'] = int(self.reloff) + s['nreloc'] = int(self.nreloc) + f = {} + f['type'] = FLAG_SECTION_TYPES[int(self.flags) & 0xff] + f['attributes'] = [] + for k in FLAG_SECTION_ATTRIBUTES: + if k & self.flags: + f['attributes'].append(FLAG_SECTION_ATTRIBUTES[k]) + if not f['attributes']: + del f['attributes'] + s['flags'] = f + s['reserved1'] = int(self.reserved1) + s['reserved2'] = int(self.reserved2) + s['reserved3'] = int(self.reserved3) + return s + + def add_section_data(self, data): + self.section_data = data + +SECTION_TYPE = 0xff +SECTION_ATTRIBUTES = 0xffffff00 +S_REGULAR = 0x0 +S_ZEROFILL = 0x1 +S_CSTRING_LITERALS = 0x2 +S_4BYTE_LITERALS = 0x3 +S_8BYTE_LITERALS = 0x4 +S_LITERAL_POINTERS = 0x5 +S_NON_LAZY_SYMBOL_POINTERS = 0x6 +S_LAZY_SYMBOL_POINTERS = 0x7 +S_SYMBOL_STUBS = 0x8 +S_MOD_INIT_FUNC_POINTERS = 0x9 +S_MOD_TERM_FUNC_POINTERS = 0xa +S_COALESCED = 0xb + +FLAG_SECTION_TYPES = { + 0x0 : "S_REGULAR", + 0x1 : "S_ZEROFILL", + 0x2 : "S_CSTRING_LITERALS", + 0x3 : "S_4BYTE_LITERALS", + 0x4 : "S_8BYTE_LITERALS", + 0x5 : "S_LITERAL_POINTERS", + 0x6 : "S_NON_LAZY_SYMBOL_POINTERS", + 0x7 : "S_LAZY_SYMBOL_POINTERS", + 0x8 : "S_SYMBOL_STUBS", + 0x9 : "S_MOD_INIT_FUNC_POINTERS", + 0xa : "S_MOD_TERM_FUNC_POINTERS", + 0xb : "S_COALESCED", + 0xc : "S_GB_ZEROFILL", + 0xd : "S_INTERPOSING", + 0xe : "S_16BYTE_LITERALS", + 0xf : "S_DTRACE_DOF", + 0x10 : "S_LAZY_DYLIB_SYMBOL_POINTERS", + 0x11 : "S_THREAD_LOCAL_REGULAR", + 0x12 : "S_THREAD_LOCAL_ZEROFILL", + 0x13 : "S_THREAD_LOCAL_VARIABLES", + 0x14 : "S_THREAD_LOCAL_VARIABLE_POINTERS", + 0x15 : "S_THREAD_LOCAL_INIT_FUNCTION_POINTERS" +} + + +FLAG_SECTION_ATTRIBUTES = { + 0x80000000 : "S_ATTR_PURE_INSTRUCTIONS", + 0x40000000 : "S_ATTR_NO_TOC", + 0x20000000 : "S_ATTR_STRIP_STATIC_SYMS", + 0x10000000 : "S_ATTR_NO_DEAD_STRIP", + 0x08000000 : "S_ATTR_LIVE_SUPPORT", + 0x04000000 : "S_ATTR_SELF_MODIFYING_CODE", + 0x02000000 : "S_ATTR_DEBUG", + 0x00000400 : "S_ATTR_SOME_INSTRUCTIONS", + 0x00000200 : "S_ATTR_EXT_RELOC", + 0x00000100 : "S_ATTR_LOC_RELOC" +} + +SECTION_ATTRIBUTES_USR = 0xff000000 +S_ATTR_PURE_INSTRUCTIONS = 0x80000000 +S_ATTR_NO_TOC = 0x40000000 +S_ATTR_STRIP_STATIC_SYMS = 0x20000000 +SECTION_ATTRIBUTES_SYS = 0x00ffff00 +S_ATTR_SOME_INSTRUCTIONS = 0x00000400 +S_ATTR_EXT_RELOC = 0x00000200 +S_ATTR_LOC_RELOC = 0x00000100 + + +SEG_PAGEZERO = "__PAGEZERO" +SEG_TEXT = "__TEXT" +SECT_TEXT = "__text" +SECT_FVMLIB_INIT0 = "__fvmlib_init0" +SECT_FVMLIB_INIT1 = "__fvmlib_init1" +SEG_DATA = "__DATA" +SECT_DATA = "__data" +SECT_BSS = "__bss" +SECT_COMMON = "__common" +SEG_OBJC = "__OBJC" +SECT_OBJC_SYMBOLS = "__symbol_table" +SECT_OBJC_MODULES = "__module_info" +SECT_OBJC_STRINGS = "__selector_strs" +SECT_OBJC_REFS = "__selector_refs" +SEG_ICON = "__ICON" +SECT_ICON_HEADER = "__header" +SECT_ICON_TIFF = "__tiff" +SEG_LINKEDIT = "__LINKEDIT" +SEG_UNIXSTACK = "__UNIXSTACK" + +# +# I really should remove all these _command classes because they +# are no different. I decided to keep the load commands separate, +# so classes like fvmlib and fvmlib_command are equivalent. +# + +class fvmlib(Structure): + _fields_ = ( + ('name', lc_str), + ('minor_version', mach_version_helper), + ('header_addr', p_uint32), + ) + +class fvmlib_command(Structure): + _fields_ = fvmlib._fields_ + + def describe(self): + s = {} + s['header_addr'] = int(self.header_addr) + return s + +class dylib(Structure): + _fields_ = ( + ('name', lc_str), + ('timestamp', mach_timestamp_helper), + ('current_version', mach_version_helper), + ('compatibility_version', mach_version_helper), + ) + +# merged dylib structure +class dylib_command(Structure): + _fields_ = dylib._fields_ + + def describe(self): + s = {} + s['timestamp'] = str(self.timestamp) + s['current_version'] = str(self.current_version) + s['compatibility_version'] = str(self.compatibility_version) + return s + +class sub_framework_command(Structure): + _fields_ = ( + ('umbrella', lc_str), + ) + + def describe(self): + return {} + +class sub_client_command(Structure): + _fields_ = ( + ('client', lc_str), + ) + + def describe(self): + return {} + +class sub_umbrella_command(Structure): + _fields_ = ( + ('sub_umbrella', lc_str), + ) + + def describe(self): + return {} + +class sub_library_command(Structure): + _fields_ = ( + ('sub_library', lc_str), + ) + + def describe(self): + return {} + +class prebound_dylib_command(Structure): + _fields_ = ( + ('name', lc_str), + ('nmodules', p_uint32), + ('linked_modules', lc_str), + ) + + def describe(self): + return {'nmodules': int(self.nmodules)} + +class dylinker_command(Structure): + _fields_ = ( + ('name', lc_str), + ) + + def describe(self): + return {} + +class thread_command(Structure): + _fields_ = ( + ) + + def describe(self): + return {} + +class entry_point_command(Structure): + _fields_ = ( + ('entryoff', p_uint64), + ('stacksize', p_uint64), + ) + + def describe(self): + s = {} + s['entryoff'] = int(self.entryoff) + s['stacksize'] = int(self.stacksize) + return s + +class routines_command(Structure): + _fields_ = ( + ('init_address', p_uint32), + ('init_module', p_uint32), + ('reserved1', p_uint32), + ('reserved2', p_uint32), + ('reserved3', p_uint32), + ('reserved4', p_uint32), + ('reserved5', p_uint32), + ('reserved6', p_uint32), + ) + + def describe(self): + s = {} + s['init_address'] = int(self.init_address) + s['init_module'] = int(self.init_module) + s['reserved1'] = int(self.reserved1) + s['reserved2'] = int(self.reserved2) + s['reserved3'] = int(self.reserved3) + s['reserved4'] = int(self.reserved4) + s['reserved5'] = int(self.reserved5) + s['reserved6'] = int(self.reserved6) + return s + +class routines_command_64(Structure): + _fields_ = ( + ('init_address', p_uint64), + ('init_module', p_uint64), + ('reserved1', p_uint64), + ('reserved2', p_uint64), + ('reserved3', p_uint64), + ('reserved4', p_uint64), + ('reserved5', p_uint64), + ('reserved6', p_uint64), + ) + + def describe(self): + s = {} + s['init_address'] = int(self.init_address) + s['init_module'] = int(self.init_module) + s['reserved1'] = int(self.reserved1) + s['reserved2'] = int(self.reserved2) + s['reserved3'] = int(self.reserved3) + s['reserved4'] = int(self.reserved4) + s['reserved5'] = int(self.reserved5) + s['reserved6'] = int(self.reserved6) + return s + +class symtab_command(Structure): + _fields_ = ( + ('symoff', p_uint32), + ('nsyms', p_uint32), + ('stroff', p_uint32), + ('strsize', p_uint32), + ) + + def describe(self): + s = {} + s['symoff'] = int(self.symoff) + s['nsyms'] = int(self.nsyms) + s['stroff'] = int(self.stroff) + s['strsize'] = int(self.strsize) + return s + + +class dysymtab_command(Structure): + _fields_ = ( + ('ilocalsym', p_uint32), + ('nlocalsym', p_uint32), + ('iextdefsym', p_uint32), + ('nextdefsym', p_uint32), + ('iundefsym', p_uint32), + ('nundefsym', p_uint32), + ('tocoff', p_uint32), + ('ntoc', p_uint32), + ('modtaboff', p_uint32), + ('nmodtab', p_uint32), + ('extrefsymoff', p_uint32), + ('nextrefsyms', p_uint32), + ('indirectsymoff', p_uint32), + ('nindirectsyms', p_uint32), + ('extreloff', p_uint32), + ('nextrel', p_uint32), + ('locreloff', p_uint32), + ('nlocrel', p_uint32), + ) + + def describe(self): + dys = {} + dys['ilocalsym'] = int(self.ilocalsym) + dys['nlocalsym'] = int(self.nlocalsym) + dys['iextdefsym'] = int(self.iextdefsym) + dys['nextdefsym'] = int(self.nextdefsym) + dys['iundefsym'] = int(self.iundefsym) + dys['nundefsym'] = int(self.nundefsym) + dys['tocoff'] = int(self.tocoff) + dys['ntoc'] = int(self.ntoc) + dys['modtaboff'] = int(self.modtaboff) + dys['nmodtab'] = int(self.nmodtab) + dys['extrefsymoff'] = int(self.extrefsymoff) + dys['nextrefsyms'] = int(self.nextrefsyms) + dys['indirectsymoff'] = int(self.indirectsymoff) + dys['nindirectsyms'] = int(self.nindirectsyms) + dys['extreloff'] = int(self.extreloff) + dys['nextrel'] = int(self.nextrel) + dys['locreloff'] = int(self.locreloff) + dys['nlocrel'] = int(self.nlocrel) + return dys + +INDIRECT_SYMBOL_LOCAL = 0x80000000 +INDIRECT_SYMBOL_ABS = 0x40000000 + +class dylib_table_of_contents(Structure): + _fields_ = ( + ('symbol_index', p_uint32), + ('module_index', p_uint32), + ) + +class dylib_module(Structure): + _fields_ = ( + ('module_name', p_uint32), + ('iextdefsym', p_uint32), + ('nextdefsym', p_uint32), + ('irefsym', p_uint32), + ('nrefsym', p_uint32), + ('ilocalsym', p_uint32), + ('nlocalsym', p_uint32), + ('iextrel', p_uint32), + ('nextrel', p_uint32), + ('iinit_iterm', p_uint32), + ('ninit_nterm', p_uint32), + ('objc_module_info_addr', p_uint32), + ('objc_module_info_size', p_uint32), + ) + +class dylib_module_64(Structure): + _fields_ = ( + ('module_name', p_uint32), + ('iextdefsym', p_uint32), + ('nextdefsym', p_uint32), + ('irefsym', p_uint32), + ('nrefsym', p_uint32), + ('ilocalsym', p_uint32), + ('nlocalsym', p_uint32), + ('iextrel', p_uint32), + ('nextrel', p_uint32), + ('iinit_iterm', p_uint32), + ('ninit_nterm', p_uint32), + ('objc_module_info_size', p_uint32), + ('objc_module_info_addr', p_uint64), + ) + +class dylib_reference(Structure): + _fields_ = ( + # XXX - ick, fix + ('isym_flags', p_uint32), + #('isym', p_uint8 * 3), + #('flags', p_uint8), + ) + +class twolevel_hints_command(Structure): + _fields_ = ( + ('offset', p_uint32), + ('nhints', p_uint32), + ) + + def describe(self): + s = {} + s['offset'] = int(self.offset) + s['nhints'] = int(self.nhints) + return s + +class twolevel_hint(Structure): + _fields_ = ( + # XXX - ick, fix + ('isub_image_itoc', p_uint32), + #('isub_image', p_uint8), + #('itoc', p_uint8 * 3), + ) + +class prebind_cksum_command(Structure): + _fields_ = ( + ('cksum', p_uint32), + ) + + def describe(self): + return {'cksum': int(self.cksum)} + +class symseg_command(Structure): + _fields_ = ( + ('offset', p_uint32), + ('size', p_uint32), + ) + + def describe(self): + s = {} + s['offset'] = int(self.offset) + s['size'] = int(self.size) + +class ident_command(Structure): + _fields_ = ( + ) + + def describe(self): + return {} + +class fvmfile_command(Structure): + _fields_ = ( + ('name', lc_str), + ('header_addr', p_uint32), + ) + + def describe(self): + return {'header_addr': int(self.header_addr)} + +class uuid_command (Structure): + _fields_ = ( + ('uuid', p_str16), + ) + + def describe(self): + return {'uuid': self.uuid.rstrip('\x00')} + +class rpath_command (Structure): + _fields_ = ( + ('path', lc_str), + ) + + def describe(self): + return {} + + +class linkedit_data_command (Structure): + _fields_ = ( + ('dataoff', p_uint32), + ('datasize', p_uint32), + ) + + def describe(self): + s = {} + s['dataoff'] = int(self.dataoff) + s['datasize'] = int(self.datasize) + return s + + +class version_min_command (Structure): + _fields_ = ( + ('version', p_uint32), # X.Y.Z is encoded in nibbles xxxx.yy.zz + ('reserved', p_uint32), + ) + + def describe(self): + v = int(self.version) + v3 = v & 0xFF + v = v >> 8 + v2 = v & 0xFF + v = v >> 8 + v1 = v & 0xFFFF + return {'version': str(int(v1)) + "." + str(int(v2)) + "." + str(int(v3))} + +class source_version_command (Structure): + _fields_ = ( + ('version', p_uint64), + ) + + def describe(self): + v = int(self.version) + a = v >> 40 + b = (v >> 30) & 0x3ff + c = (v >> 20) & 0x3ff + d = (v >> 10) & 0x3ff + e = v & 0x3ff + r = str(a)+'.'+str(b)+'.'+str(c)+'.'+str(d)+'.'+str(e) + return {'version': r} + +class encryption_info_command (Structure): + _fields_ = ( + ('cryptoff', p_uint32), + ('cryptsize', p_uint32), + ('cryptid', p_uint32), + ) + + def describe(self): + s = {} + s['cryptoff'] = int(self.cryptoff) + s['cryptsize'] = int(self.cryptsize) + s['cryptid'] = int(self.cryptid) + return s + +class encryption_info_command_64 (Structure): + _fields_ = ( + ('cryptoff', p_uint32), + ('cryptsize', p_uint32), + ('cryptid', p_uint32), + ('pad', p_uint32), + ) + + def describe(self): + s = {} + s['cryptoff'] = int(self.cryptoff) + s['cryptsize'] = int(self.cryptsize) + s['cryptid'] = int(self.cryptid) + s['pad'] = int(self.pad) + return s + + +class dyld_info_command (Structure): + _fields_ = ( + ('rebase_off', p_uint32), + ('rebase_size', p_uint32), + ('bind_off', p_uint32), + ('bind_size', p_uint32), + ('weak_bind_off', p_uint32), + ('weak_bind_size', p_uint32), + ('lazy_bind_off', p_uint32), + ('lazy_bind_size', p_uint32), + ('export_off', p_uint32), + ('export_size', p_uint32), + ) + + def describe(self): + dyld = {} + dyld['rebase_off'] = int(self.rebase_off) + dyld['rebase_size'] = int(self.rebase_size) + dyld['bind_off'] = int(self.bind_off) + dyld['bind_size'] = int(self.bind_size) + dyld['weak_bind_off'] = int(self.weak_bind_off) + dyld['weak_bind_size'] = int(self.weak_bind_size) + dyld['lazy_bind_off'] = int(self.lazy_bind_off) + dyld['lazy_bind_size'] = int(self.lazy_bind_size) + dyld['export_off'] = int(self.export_off) + dyld['export_size'] = int(self.export_size) + return dyld + +class linker_option_command (Structure): + _fields_ = ( + ('count', p_uint32), + ) + + def describe(self): + return {'count': int(self.count)} + + +LC_REGISTRY = { + LC_SEGMENT: segment_command, + LC_IDFVMLIB: fvmlib_command, + LC_LOADFVMLIB: fvmlib_command, + LC_ID_DYLIB: dylib_command, + LC_LOAD_DYLIB: dylib_command, + LC_LOAD_WEAK_DYLIB: dylib_command, + LC_SUB_FRAMEWORK: sub_framework_command, + LC_SUB_CLIENT: sub_client_command, + LC_SUB_UMBRELLA: sub_umbrella_command, + LC_SUB_LIBRARY: sub_library_command, + LC_PREBOUND_DYLIB: prebound_dylib_command, + LC_ID_DYLINKER: dylinker_command, + LC_LOAD_DYLINKER: dylinker_command, + LC_THREAD: thread_command, + LC_UNIXTHREAD: thread_command, + LC_ROUTINES: routines_command, + LC_SYMTAB: symtab_command, + LC_DYSYMTAB: dysymtab_command, + LC_TWOLEVEL_HINTS: twolevel_hints_command, + LC_PREBIND_CKSUM: prebind_cksum_command, + LC_SYMSEG: symseg_command, + LC_IDENT: ident_command, + LC_FVMFILE: fvmfile_command, + LC_SEGMENT_64: segment_command_64, + LC_ROUTINES_64: routines_command_64, + LC_UUID: uuid_command, + LC_RPATH: rpath_command, + LC_CODE_SIGNATURE: linkedit_data_command, + LC_CODE_SEGMENT_SPLIT_INFO: linkedit_data_command, + LC_REEXPORT_DYLIB: dylib_command, + LC_LAZY_LOAD_DYLIB: dylib_command, + LC_ENCRYPTION_INFO: encryption_info_command, + LC_DYLD_INFO: dyld_info_command, + LC_DYLD_INFO_ONLY: dyld_info_command, + LC_LOAD_UPWARD_DYLIB: dylib_command, + LC_VERSION_MIN_MACOSX: version_min_command, + LC_VERSION_MIN_IPHONEOS: version_min_command, + LC_FUNCTION_STARTS: linkedit_data_command, + LC_DYLD_ENVIRONMENT: dylinker_command, + LC_MAIN: entry_point_command, + LC_DATA_IN_CODE: linkedit_data_command, + LC_SOURCE_VERSION: source_version_command, + LC_DYLIB_CODE_SIGN_DRS: linkedit_data_command, + LC_ENCRYPTION_INFO_64: encryption_info_command_64, + LC_LINKER_OPTION: linker_option_command, +} + +LC_NAMES = { + LC_SEGMENT: 'LC_SEGMENT', + LC_IDFVMLIB: 'LC_IDFVMLIB', + LC_LOADFVMLIB: 'LC_LOADFVMLIB', + LC_ID_DYLIB: 'LC_ID_DYLIB', + LC_LOAD_DYLIB: 'LC_LOAD_DYLIB', + LC_LOAD_WEAK_DYLIB: 'LC_LOAD_WEAK_DYLIB', + LC_SUB_FRAMEWORK: 'LC_SUB_FRAMEWORK', + LC_SUB_CLIENT: 'LC_SUB_CLIENT', + LC_SUB_UMBRELLA: 'LC_SUB_UMBRELLA', + LC_SUB_LIBRARY: 'LC_SUB_LIBRARY', + LC_PREBOUND_DYLIB: 'LC_PREBOUND_DYLIB', + LC_ID_DYLINKER: 'LC_ID_DYLINKER', + LC_LOAD_DYLINKER: 'LC_LOAD_DYLINKER', + LC_THREAD: 'LC_THREAD', + LC_UNIXTHREAD: 'LC_UNIXTHREAD', + LC_ROUTINES: 'LC_ROUTINES', + LC_SYMTAB: 'LC_SYMTAB', + LC_DYSYMTAB: 'LC_DYSYMTAB', + LC_TWOLEVEL_HINTS: 'LC_TWOLEVEL_HINTS', + LC_PREBIND_CKSUM: 'LC_PREBIND_CKSUM', + LC_SYMSEG: 'LC_SYMSEG', + LC_IDENT: 'LC_IDENT', + LC_FVMFILE: 'LC_FVMFILE', + LC_SEGMENT_64: 'LC_SEGMENT_64', + LC_ROUTINES_64: 'LC_ROUTINES_64', + LC_UUID: 'LC_UUID', + LC_RPATH: 'LC_RPATH', + LC_CODE_SIGNATURE: 'LC_CODE_SIGNATURE', + LC_CODE_SEGMENT_SPLIT_INFO: 'LC_CODE_SEGMENT_SPLIT_INFO', + LC_REEXPORT_DYLIB: 'LC_REEXPORT_DYLIB', + LC_LAZY_LOAD_DYLIB: 'LC_LAZY_LOAD_DYLIB', + LC_ENCRYPTION_INFO: 'LC_ENCRYPTION_INFO', + LC_DYLD_INFO: 'LC_DYLD_INFO', + LC_DYLD_INFO_ONLY: 'LC_DYLD_INFO_ONLY', + LC_LOAD_UPWARD_DYLIB: 'LC_LOAD_UPWARD_DYLIB', + LC_VERSION_MIN_MACOSX: 'LC_VERSION_MIN_MACOSX', + LC_VERSION_MIN_IPHONEOS: 'LC_VERSION_MIN_IPHONEOS', + LC_FUNCTION_STARTS: 'LC_FUNCTION_STARTS', + LC_DYLD_ENVIRONMENT: 'LC_DYLD_ENVIRONMENT', + LC_MAIN: 'LC_MAIN', + LC_DATA_IN_CODE: 'LC_DATA_IN_CODE', + LC_SOURCE_VERSION: 'LC_SOURCE_VERSION', + LC_DYLIB_CODE_SIGN_DRS: 'LC_DYLIB_CODE_SIGN_DRS', +} + + +#this is another union. +class n_un(p_int32): + pass + +class nlist(Structure): + _fields_ = ( + ('n_un', n_un), + ('n_type', p_uint8), + ('n_sect', p_uint8), + ('n_desc', p_short), + ('n_value', p_uint32), + ) + +class nlist_64(Structure): + _fields_ = [ + ('n_un', n_un), + ('n_type', p_uint8), + ('n_sect', p_uint8), + ('n_desc', p_short), + ('n_value', p_int64), + ] + +N_STAB = 0xe0 +N_PEXT = 0x10 +N_TYPE = 0x0e +N_EXT = 0x01 + +N_UNDF = 0x0 +N_ABS = 0x2 +N_SECT = 0xe +N_PBUD = 0xc +N_INDR = 0xa + +NO_SECT = 0 +MAX_SECT = 255 + +REFERENCE_TYPE = 0xf +REFERENCE_FLAG_UNDEFINED_NON_LAZY = 0 +REFERENCE_FLAG_UNDEFINED_LAZY = 1 +REFERENCE_FLAG_DEFINED = 2 +REFERENCE_FLAG_PRIVATE_DEFINED = 3 +REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY = 4 +REFERENCE_FLAG_PRIVATE_UNDEFINED_LAZY = 5 + +REFERENCED_DYNAMICALLY = 0x0010 + +def GET_LIBRARY_ORDINAL(n_desc): + return (((n_desc) >> 8) & 0xff) + +def SET_LIBRARY_ORDINAL(n_desc, ordinal): + return (((n_desc) & 0x00ff) | (((ordinal & 0xff) << 8))) + +SELF_LIBRARY_ORDINAL = 0x0 +MAX_LIBRARY_ORDINAL = 0xfd +DYNAMIC_LOOKUP_ORDINAL = 0xfe +EXECUTABLE_ORDINAL = 0xff + +N_DESC_DISCARDED = 0x0020 +N_WEAK_REF = 0x0040 +N_WEAK_DEF = 0x0080 + +# /usr/include/mach-o/fat.h +FAT_MAGIC = 0xcafebabe +class fat_header(Structure): + _fields_ = ( + ('magic', p_uint32), + ('nfat_arch', p_uint32), + ) + +class fat_arch(Structure): + _fields_ = ( + ('cputype', cpu_type_t), + ('cpusubtype', cpu_subtype_t), + ('offset', p_uint32), + ('size', p_uint32), + ('align', p_uint32), + ) diff --git a/python/macholib/macholib/macho_dump.py b/python/macholib/macholib/macho_dump.py new file mode 100644 index 000000000..737ce8ebe --- /dev/null +++ b/python/macholib/macholib/macho_dump.py @@ -0,0 +1,48 @@ +#!/usr/bin/env python + +from __future__ import print_function + +import os +import sys + +from macholib._cmdline import main as _main +from macholib.MachO import MachO +from macholib.mach_o import * + +ARCH_MAP={ + ('<', '64-bit'): 'x86_64', + ('<', '32-bit'): 'i386', + ('>', '64-bit'): 'ppc64', + ('>', '32-bit'): 'ppc', +} + +def print_file(fp, path): + print(path, file=fp) + m = MachO(path) + for header in m.headers: + seen = set() + if header.MH_MAGIC == MH_MAGIC_64: + sz = '64-bit' + else: + sz = '32-bit' + + arch = CPU_TYPE_NAMES.get(header.header.cputype, + header.header.cputype) + + print(' [%s endian=%r size=%r arch=%r]' % (header.__class__.__name__, + header.endian, sz, arch), file=fp) + for idx, name, other in header.walkRelocatables(): + if other not in seen: + seen.add(other) + print('\t' + other, file=fp) + print('', file=fp) + +def main(): + print("WARNING: 'macho_dump' is deprecated, use 'python -mmacholib dump' instead") + _main(print_file) + +if __name__ == '__main__': + try: + sys.exit(main()) + except KeyboardInterrupt: + pass diff --git a/python/macholib/macholib/macho_find.py b/python/macholib/macholib/macho_find.py new file mode 100644 index 000000000..0a0cef270 --- /dev/null +++ b/python/macholib/macholib/macho_find.py @@ -0,0 +1,17 @@ +#!/usr/bin/env python +from __future__ import print_function +from macholib._cmdline import main as _main + + +def print_file(fp, path): + print(path, file=fp) + +def main(): + print("WARNING: 'macho_find' is deprecated, use 'python -mmacholib dump' instead") + _main(print_file) + +if __name__ == '__main__': + try: + main() + except KeyboardInterrupt: + pass diff --git a/python/macholib/macholib/macho_standalone.py b/python/macholib/macholib/macho_standalone.py new file mode 100644 index 000000000..ceec82bc9 --- /dev/null +++ b/python/macholib/macholib/macho_standalone.py @@ -0,0 +1,26 @@ +#!/usr/bin/env python + +import os +import sys + +from macholib.MachOStandalone import MachOStandalone +from macholib.util import strip_files + +def standaloneApp(path): + if not (os.path.isdir(path) and os.path.exists( + os.path.join(path, 'Contents'))): + print('%s: %s does not look like an app bundle' + % (sys.argv[0], path)) + sys.exit(1) + files = MachOStandalone(path).run() + strip_files(files) + +def main(): + print("WARNING: 'macho_standalone' is deprecated, use 'python -mmacholib standalone' instead") + if not sys.argv[1:]: + raise SystemExit('usage: %s [appbundle ...]' % (sys.argv[0],)) + for fn in sys.argv[1:]: + standaloneApp(fn) + +if __name__ == '__main__': + main() diff --git a/python/macholib/macholib/ptypes.py b/python/macholib/macholib/ptypes.py new file mode 100644 index 000000000..f1457c91b --- /dev/null +++ b/python/macholib/macholib/ptypes.py @@ -0,0 +1,290 @@ +""" +This module defines packable types, that is types than can be easily converted to a binary format +as used in MachO headers. +""" +import struct +import sys + +try: + from itertools import izip, imap +except ImportError: + izip, imap = zip, map +from itertools import chain, starmap +import warnings + +__all__ = """ +sizeof +BasePackable +Structure +pypackable +p_char +p_byte +p_ubyte +p_short +p_ushort +p_int +p_uint +p_long +p_ulong +p_longlong +p_ulonglong +p_int8 +p_uint8 +p_int16 +p_uint16 +p_int32 +p_uint32 +p_int64 +p_uint64 +p_float +p_double +""".split() + +def sizeof(s): + """ + Return the size of an object when packed + """ + if hasattr(s, '_size_'): + return s._size_ + + elif isinstance(s, bytes): + return len(s) + + raise ValueError(s) + +class MetaPackable(type): + """ + Fixed size struct.unpack-able types use from_tuple as their designated initializer + """ + def from_mmap(cls, mm, ptr, **kw): + return cls.from_str(mm[ptr:ptr+cls._size_], **kw) + + def from_fileobj(cls, f, **kw): + return cls.from_str(f.read(cls._size_), **kw) + + def from_str(cls, s, **kw): + endian = kw.get('_endian_', cls._endian_) + return cls.from_tuple(struct.unpack(endian + cls._format_, s), **kw) + + def from_tuple(cls, tpl, **kw): + return cls(tpl[0], **kw) + +class BasePackable(object): + _endian_ = '>' + + def to_str(self): + raise NotImplementedError + + def to_fileobj(self, f): + f.write(self.to_str()) + + def to_mmap(self, mm, ptr): + mm[ptr:ptr+self._size_] = self.to_str() + + +# This defines a class with a custom metaclass, we'd normally +# use "class Packable(BasePackable, metaclass=MetaPackage)", +# but that syntax is not valid in Python 2 (and likewise the +# python 2 syntax is not valid in Python 3) +def _make(): + def to_str(self): + cls = type(self) + endian = getattr(self, '_endian_', cls._endian_) + return struct.pack(endian + cls._format_, self) + return MetaPackable("Packable", (BasePackable,), {'to_str': to_str}) +Packable = _make() +del _make + +def pypackable(name, pytype, format): + """ + Create a "mix-in" class with a python type and a + Packable with the given struct format + """ + size, items = _formatinfo(format) + return type(Packable)(name, (pytype, Packable), { + '_format_': format, + '_size_': size, + '_items_': items, + }) + +def _formatinfo(format): + """ + Calculate the size and number of items in a struct format. + """ + size = struct.calcsize(format) + return size, len(struct.unpack(format, b'\x00' * size)) + +class MetaStructure(MetaPackable): + """ + The metaclass of Structure objects that does all the magic. + + Since we can assume that all Structures have a fixed size, + we can do a bunch of calculations up front and pack or + unpack the whole thing in one struct call. + """ + def __new__(cls, clsname, bases, dct): + fields = dct['_fields_'] + names = [] + types = [] + structmarks = [] + format = '' + items = 0 + size = 0 + + def struct_property(name, typ): + def _get(self): + return self._objects_[name] + def _set(self, obj): + if type(obj) is not typ: + obj = typ(obj) + self._objects_[name] = obj + return property(_get, _set, typ.__name__) + + for name, typ in fields: + dct[name] = struct_property(name, typ) + names.append(name) + types.append(typ) + format += typ._format_ + size += typ._size_ + if (typ._items_ > 1): + structmarks.append((items, typ._items_, typ)) + items += typ._items_ + + dct['_structmarks_'] = structmarks + dct['_names_'] = names + dct['_types_'] = types + dct['_size_'] = size + dct['_items_'] = items + dct['_format_'] = format + return super(MetaStructure, cls).__new__(cls, clsname, bases, dct) + + def from_tuple(cls, tpl, **kw): + values = [] + current = 0 + for begin, length, typ in cls._structmarks_: + if begin > current: + values.extend(tpl[current:begin]) + current = begin + length + values.append(typ.from_tuple(tpl[begin:current], **kw)) + values.extend(tpl[current:]) + return cls(*values, **kw) + +# See metaclass discussion earlier in this file +def _make(): + class_dict={} + class_dict['_fields_'] = () + + def as_method(function): + class_dict[function.__name__] = function + + @as_method + def __init__(self, *args, **kwargs): + if len(args) == 1 and not kwargs and type(args[0]) is type(self): + kwargs = args[0]._objects_ + args = () + self._objects_ = {} + iargs = chain(izip(self._names_, args), kwargs.items()) + for key, value in iargs: + if key not in self._names_ and key != "_endian_": + raise TypeError + setattr(self, key, value) + for key, typ in izip(self._names_, self._types_): + if key not in self._objects_: + self._objects_[key] = typ() + + @as_method + def _get_packables(self): + for obj in imap(self._objects_.__getitem__, self._names_): + if obj._items_ == 1: + yield obj + else: + for obj in obj._get_packables(): + yield obj + + @as_method + def to_str(self): + return struct.pack(self._endian_ + self._format_, *self._get_packables()) + + @as_method + def __cmp__(self, other): + if type(other) is not type(self): + raise TypeError('Cannot compare objects of type %r to objects of type %r' % (type(other), type(self))) + if sys.version_info[0] == 2: + _cmp = cmp + else: + def _cmp(a, b): + if a < b: + return -1 + elif a > b: + return 1 + elif a == b: + return 0 + else: + raise TypeError() + + for cmpval in starmap(_cmp, izip(self._get_packables(), other._get_packables())): + if cmpval != 0: + return cmpval + return 0 + + @as_method + def __eq__(self, other): + r = self.__cmp__(other) + return r == 0 + + @as_method + def __ne__(self, other): + r = self.__cmp__(other) + return r != 0 + + @as_method + def __lt__(self, other): + r = self.__cmp__(other) + return r < 0 + + @as_method + def __le__(self, other): + r = self.__cmp__(other) + return r <= 0 + + @as_method + def __gt__(self, other): + r = self.__cmp__(other) + return r > 0 + + @as_method + def __ge__(self, other): + r = self.__cmp__(other) + return r >= 0 + + return MetaStructure("Structure", (BasePackable,), class_dict) +Structure = _make() +del _make + +try: + long +except NameError: + long = int + +# export common packables with predictable names +p_char = pypackable('p_char', bytes, 'c') +p_int8 = pypackable('p_int8', int, 'b') +p_uint8 = pypackable('p_uint8', int, 'B') +p_int16 = pypackable('p_int16', int, 'h') +p_uint16 = pypackable('p_uint16', int, 'H') +p_int32 = pypackable('p_int32', int, 'i') +p_uint32 = pypackable('p_uint32', long, 'I') +p_int64 = pypackable('p_int64', long, 'q') +p_uint64 = pypackable('p_uint64', long, 'Q') +p_float = pypackable('p_float', float, 'f') +p_double = pypackable('p_double', float, 'd') + +# Deprecated names, need trick to emit deprecation warning. +p_byte = p_int8 +p_ubyte = p_uint8 +p_short = p_int16 +p_ushort = p_uint16 +p_int = p_long = p_int32 +p_uint = p_ulong = p_uint32 +p_longlong = p_int64 +p_ulonglong = p_uint64 diff --git a/python/macholib/macholib/util.py b/python/macholib/macholib/util.py new file mode 100644 index 000000000..7f954b6f7 --- /dev/null +++ b/python/macholib/macholib/util.py @@ -0,0 +1,245 @@ +import os +import sys +import stat +import operator +import struct +import shutil + +#from modulegraph.util import * + +from macholib import mach_o + +MAGIC = [ + struct.pack('!L', getattr(mach_o, 'MH_' + _)) + for _ in ['MAGIC', 'CIGAM', 'MAGIC_64', 'CIGAM_64'] +] +FAT_MAGIC_BYTES = struct.pack('!L', mach_o.FAT_MAGIC) +MAGIC_LEN = 4 +STRIPCMD = ['/usr/bin/strip', '-x', '-S', '-'] + +try: + unicode +except NameError: + unicode = str + + +def fsencoding(s, encoding=sys.getfilesystemencoding()): + """ + Ensure the given argument is in filesystem encoding (not unicode) + """ + if isinstance(s, unicode): + s = s.encode(encoding) + return s + +def move(src, dst): + """ + move that ensures filesystem encoding of paths + """ + shutil.move(fsencoding(src), fsencoding(dst)) + +def copy2(src, dst): + """ + copy2 that ensures filesystem encoding of paths + """ + shutil.copy2(fsencoding(src), fsencoding(dst)) + +def flipwritable(fn, mode=None): + """ + Flip the writability of a file and return the old mode. Returns None + if the file is already writable. + """ + if os.access(fn, os.W_OK): + return None + old_mode = os.stat(fn).st_mode + os.chmod(fn, stat.S_IWRITE | old_mode) + return old_mode + +class fileview(object): + """ + A proxy for file-like objects that exposes a given view of a file + """ + + def __init__(self, fileobj, start, size): + self._fileobj = fileobj + self._start = start + self._end = start + size + + def __repr__(self): + return '' % ( + self._start, self._end, self._fileobj) + + def tell(self): + return self._fileobj.tell() - self._start + + def _checkwindow(self, seekto, op): + if not (self._start <= seekto <= self._end): + raise IOError("%s to offset %d is outside window [%d, %d]" % ( + op, seekto, self._start, self._end)) + + def seek(self, offset, whence=0): + seekto = offset + if whence == 0: + seekto += self._start + elif whence == 1: + seekto += self._fileobj.tell() + elif whence == 2: + seekto += self._end + else: + raise IOError("Invalid whence argument to seek: %r" % (whence,)) + self._checkwindow(seekto, 'seek') + self._fileobj.seek(seekto) + + def write(self, bytes): + here = self._fileobj.tell() + self._checkwindow(here, 'write') + self._checkwindow(here + len(bytes), 'write') + self._fileobj.write(bytes) + + def read(self, size=sys.maxsize): + if size < 0: + raise ValueError("Invalid size %s while reading from %s", size, self._fileobj) + here = self._fileobj.tell() + self._checkwindow(here, 'read') + bytes = min(size, self._end - here) + return self._fileobj.read(bytes) + + +def mergecopy(src, dest): + """ + copy2, but only if the destination isn't up to date + """ + if os.path.exists(dest) and os.stat(dest).st_mtime >= os.stat(src).st_mtime: + return + + copy2(src, dest) + +def mergetree(src, dst, condition=None, copyfn=mergecopy, srcbase=None): + """ + Recursively merge a directory tree using mergecopy(). + """ + src = fsencoding(src) + dst = fsencoding(dst) + if srcbase is None: + srcbase = src + names = map(fsencoding, os.listdir(src)) + try: + os.makedirs(dst) + except OSError: + pass + errors = [] + for name in names: + srcname = os.path.join(src, name) + dstname = os.path.join(dst, name) + if condition is not None and not condition(srcname): + continue + try: + if os.path.islink(srcname): + # XXX: This is naive at best, should check srcbase(?) + realsrc = os.readlink(srcname) + os.symlink(realsrc, dstname) + elif os.path.isdir(srcname): + mergetree(srcname, dstname, + condition=condition, copyfn=copyfn, srcbase=srcbase) + else: + copyfn(srcname, dstname) + except (IOError, os.error) as why: + errors.append((srcname, dstname, why)) + if errors: + raise IOError(errors) + +def sdk_normalize(filename): + """ + Normalize a path to strip out the SDK portion, normally so that it + can be decided whether it is in a system path or not. + """ + if filename.startswith('/Developer/SDKs/'): + pathcomp = filename.split('/') + del pathcomp[1:4] + filename = '/'.join(pathcomp) + return filename + +NOT_SYSTEM_FILES=[] + +def in_system_path(filename): + """ + Return True if the file is in a system path + """ + fn = sdk_normalize(os.path.realpath(filename)) + if fn.startswith('/usr/local/'): + return False + elif fn.startswith('/System/') or fn.startswith('/usr/'): + if fn in NOT_SYSTEM_FILES: + return False + return True + else: + return False + +def has_filename_filter(module): + """ + Return False if the module does not have a filename attribute + """ + return getattr(module, 'filename', None) is not None + +def get_magic(): + """ + Get a list of valid Mach-O header signatures, not including the fat header + """ + return MAGIC + +def is_platform_file(path): + """ + Return True if the file is Mach-O + """ + if not os.path.exists(path) or os.path.islink(path): + return False + # If the header is fat, we need to read into the first arch + with open(path, 'rb') as fileobj: + bytes = fileobj.read(MAGIC_LEN) + if bytes == FAT_MAGIC_BYTES: + # Read in the fat header + fileobj.seek(0) + header = mach_o.fat_header.from_fileobj(fileobj, _endian_='>') + if header.nfat_arch < 1: + return False + # Read in the first fat arch header + arch = mach_o.fat_arch.from_fileobj(fileobj, _endian_='>') + fileobj.seek(arch.offset) + # Read magic off the first header + bytes = fileobj.read(MAGIC_LEN) + for magic in MAGIC: + if bytes == magic: + return True + return False + +def iter_platform_files(dst): + """ + Walk a directory and yield each full path that is a Mach-O file + """ + for root, dirs, files in os.walk(dst): + for fn in files: + fn = os.path.join(root, fn) + if is_platform_file(fn): + yield fn + +def strip_files(files, argv_max=(256 * 1024)): + """ + Strip a list of files + """ + tostrip = [(fn, flipwritable(fn)) for fn in files] + while tostrip: + cmd = list(STRIPCMD) + flips = [] + pathlen = sum([len(s) + 1 for s in cmd]) + while pathlen < argv_max: + if not tostrip: + break + added, flip = tostrip.pop() + pathlen += len(added) + 1 + cmd.append(added) + flips.append((added, flip)) + else: + cmd.pop() + tostrip.append(flips.pop()) + os.spawnv(os.P_WAIT, cmd[0], cmd) + for args in flips: + flipwritable(*args) diff --git a/python/macholib/macholib_tests/__init__.py b/python/macholib/macholib_tests/__init__.py new file mode 100644 index 000000000..b5fe939b4 --- /dev/null +++ b/python/macholib/macholib_tests/__init__.py @@ -0,0 +1 @@ +""" macholib_tests package """ diff --git a/python/macholib/macholib_tests/binaries/src/build.py b/python/macholib/macholib_tests/binaries/src/build.py new file mode 100644 index 000000000..e2a179c78 --- /dev/null +++ b/python/macholib/macholib_tests/binaries/src/build.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python + +import os, sys + + +class Builder (object): + def __init__(self, args): + self.output_dir = args[1] + + + def run(self): + for nm in dir(type(self)): + if nm.startswith('build_'): + getattr(self, nm)() + + def build_executable(self): + print "Building plain executable" + pass + + +builder = Builder(sys.argv) +builder.run() diff --git a/python/macholib/macholib_tests/test_MachO.py b/python/macholib/macholib_tests/test_MachO.py new file mode 100644 index 000000000..730007e12 --- /dev/null +++ b/python/macholib/macholib_tests/test_MachO.py @@ -0,0 +1,15 @@ +from macholib import MachO + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +class TestMachO (unittest.TestCase): + @unittest.expectedFailure + def test_missing(self): + self.fail("tests are missing") + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_MachOGraph.py b/python/macholib/macholib_tests/test_MachOGraph.py new file mode 100644 index 000000000..3f8e4ea19 --- /dev/null +++ b/python/macholib/macholib_tests/test_MachOGraph.py @@ -0,0 +1,15 @@ +from macholib import MachOGraph + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +class TestMachOGraph (unittest.TestCase): + @unittest.expectedFailure + def test_missing(self): + self.fail("tests are missing") + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_MachOStandalone.py b/python/macholib/macholib_tests/test_MachOStandalone.py new file mode 100644 index 000000000..aa431e517 --- /dev/null +++ b/python/macholib/macholib_tests/test_MachOStandalone.py @@ -0,0 +1,15 @@ +from macholib import MachOStandalone + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +class TestMachOStandalone (unittest.TestCase): + @unittest.expectedFailure + def test_missing(self): + self.fail("tests are missing") + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_SymbolTable.py b/python/macholib/macholib_tests/test_SymbolTable.py new file mode 100644 index 000000000..8970ca0a9 --- /dev/null +++ b/python/macholib/macholib_tests/test_SymbolTable.py @@ -0,0 +1,15 @@ +from macholib import SymbolTable + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +class TestSymbolTable (unittest.TestCase): + @unittest.expectedFailure + def test_missing(self): + self.fail("tests are missing") + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_command_line.py b/python/macholib/macholib_tests/test_command_line.py new file mode 100644 index 000000000..a9cfd6f10 --- /dev/null +++ b/python/macholib/macholib_tests/test_command_line.py @@ -0,0 +1,147 @@ +from macholib import macho_dump +from macholib import macho_find +from macholib import _cmdline +from macholib import util + +import sys +import shutil +import os + +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +try: + from StringIO import StringIO +except ImportError: + from io import StringIO + +class TestCmdLine (unittest.TestCase): + + # This test is no longer valid: + def no_test_main_is_shared(self): + self.assertTrue(macho_dump.main is _cmdline.main) + self.assertTrue(macho_find.main is _cmdline.main) + + def test_check_file(self): + record = [] + def record_cb(fp, path): + record.append((fp, path)) + + self.assertEqual(_cmdline.check_file(sys.stdout, '/bin/sh', record_cb), 0) + self.assertEqual(record, [(sys.stdout, '/bin/sh')]) + + saved_stderr = sys.stderr + saved_argv = sys.argv + try: + sys.stderr = StringIO() + sys.argv = ['macho_test'] + + record[:] = [] + self.assertEqual(_cmdline.check_file(sys.stdout, '/bin/no-shell', record_cb), 1) + self.assertEqual(record, []) + self.assertEqual(sys.stderr.getvalue(), "macho_test: /bin/no-shell: No such file or directory\n") + self.assertEqual(record, []) + + shutil.copy('/bin/sh', 'test.exec') + os.chmod('test.exec', 0) + + sys.stderr = StringIO() + self.assertEqual(_cmdline.check_file(sys.stdout, 'test.exec', record_cb), 1) + self.assertEqual(record, []) + self.assertEqual(sys.stderr.getvalue(), "macho_test: test.exec: [Errno 13] Permission denied: 'test.exec'\n") + self.assertEqual(record, []) + + + finally: + sys.stderr = sys.stderr + sys.argv = saved_argv + if os.path.exists('test.exec'): + os.unlink('test.exec') + + def test_shared_main(self): + + saved_stderr = sys.stderr + saved_argv = sys.argv + try: + sys.stderr = StringIO() + + sys.argv = ['macho_tool'] + + self.assertEqual(_cmdline.main(lambda *args: None), 1) + self.assertEqual(sys.stderr.getvalue(), 'Usage: macho_tool filename...\n') + + names = [] + def record_names(fp, name): + self.assertEqual(fp, sys.stdout) + names.append(name) + + + sys.stderr = StringIO() + sys.argv = ['macho_tool', '/bin/sh'] + self.assertEqual(_cmdline.main(record_names), 0) + self.assertEqual(sys.stderr.getvalue(), '') + self.assertEqual(names, ['/bin/sh']) + + names = [] + sys.stderr = StringIO() + sys.argv = ['macho_tool', '/bin/sh', '/bin/ls'] + self.assertEqual(_cmdline.main(record_names), 0) + self.assertEqual(sys.stderr.getvalue(), '') + self.assertEqual(names, ['/bin/sh', '/bin/ls']) + + names = [] + sys.stderr = StringIO() + sys.argv = ['macho_tool', '/bin'] + self.assertEqual(_cmdline.main(record_names), 0) + self.assertEqual(sys.stderr.getvalue(), '') + names.sort() + dn = '/bin' + real_names = [ + os.path.join(dn, fn) for fn in os.listdir(dn) + if util.is_platform_file(os.path.join(dn, fn)) ] + real_names.sort() + + self.assertEqual(names, real_names) + + finally: + sys.stderr = saved_stderr + sys.argv = saved_argv + + def test_macho_find(self): + fp = StringIO() + macho_find.print_file(fp, "file1") + macho_find.print_file(fp, "file2") + self.assertEqual(fp.getvalue(), "file1\nfile2\n") + + def test_macho_dump(self): + fp = StringIO() + macho_dump.print_file(fp, "/bin/sh") + lines = fp.getvalue().splitlines() + + self.assertEqual(lines[0], "/bin/sh") + self.assertTrue(len(lines) > 3) + + self.assertEqual(lines[-1], '') + del lines[-1] + + idx = 1 + while idx < len(lines): + self.assertTrue(lines[idx].startswith(' [MachOHeader endian')) + idx+=1 + + lc = 0 + while idx < len(lines): + if not lines[idx].startswith('\t'): + break + + lc +=1 + self.assertTrue(os.path.exists(lines[idx].lstrip())) + idx += 1 + + self.assertTrue(lc > 1) + + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_dyld.py b/python/macholib/macholib_tests/test_dyld.py new file mode 100644 index 000000000..7b41758d9 --- /dev/null +++ b/python/macholib/macholib_tests/test_dyld.py @@ -0,0 +1,450 @@ +from macholib import dyld + +import sys +import os +import functools + +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +class DyldPatcher (object): + def __init__(self): + self.calls = [] + self.patched = {} + + def clear_calls(self): + self.calls = [] + + def cleanup(self): + for name in self.patched: + setattr(dyld, name, self.patched[name]) + + def log_calls(self, name): + if name in self.patched: + return + + self.patched[name] = getattr(dyld, name) + + + @functools.wraps(self.patched[name]) + def wrapper(*args, **kwds): + self.calls.append((name, args, kwds)) + return self.patched[name](*args, **kwds) + + setattr(dyld, name, wrapper) + + +class TestDyld (unittest.TestCase): + if not hasattr(unittest.TestCase, 'assertIsInstance'): + def assertIsInstance(self, value, types, message=None): + self.assertTrue(isinstance(value, types), + message or "%r is not an instance of %r"%(value, types)) + + def setUp(self): + self._environ = os.environ + os.environ = dict([(k, os.environ[k]) for k in os.environ if 'DYLD' not in k]) + self._dyld_env = dyld._dyld_env + self._dyld_image_suffix = dyld.dyld_image_suffix + + def tearDown(self): + dyld._dyld_env = self._dyld_env + dyld.dyld_image_suffix = self._dyld_image_suffix + os.environ = self._environ + + if sys.version_info[0] == 2: + def test_ensure_utf8(self): + self.assertEqual(dyld._ensure_utf8("hello"), "hello") + self.assertEqual(dyld._ensure_utf8("hello".decode('utf-8')), "hello") + self.assertEqual(dyld._ensure_utf8(None), None) + + else: + def test_ensure_utf8(self): + self.assertEqual(dyld._ensure_utf8("hello"), "hello") + self.assertEqual(dyld._ensure_utf8(None), None) + self.assertRaises(ValueError, dyld._ensure_utf8, b"hello") + + def test__dyld_env(self): + new = os.environ + + self.assertEqual(dyld._dyld_env(None, 'DYLD_FOO'), []) + self.assertEqual(dyld._dyld_env({'DYLD_FOO':'bar'}, 'DYLD_FOO'), ['bar']) + self.assertEqual(dyld._dyld_env({'DYLD_FOO':'bar:baz'}, 'DYLD_FOO'), ['bar', 'baz']) + self.assertEqual(dyld._dyld_env({}, 'DYLD_FOO'), []) + self.assertEqual(dyld._dyld_env({'DYLD_FOO':''}, 'DYLD_FOO'), []) + os.environ['DYLD_FOO'] = 'foobar' + self.assertEqual(dyld._dyld_env(None, 'DYLD_FOO'), ['foobar']) + os.environ['DYLD_FOO'] = 'foobar:nowhere' + self.assertEqual(dyld._dyld_env(None, 'DYLD_FOO'), ['foobar', 'nowhere']) + self.assertEqual(dyld._dyld_env({'DYLD_FOO':'bar'}, 'DYLD_FOO'), ['bar']) + self.assertEqual(dyld._dyld_env({}, 'DYLD_FOO'), []) + + + self.assertEqual(dyld.dyld_image_suffix(), None) + self.assertEqual(dyld.dyld_image_suffix(None), None) + self.assertEqual(dyld.dyld_image_suffix({'DYLD_IMAGE_SUFFIX':'bar'}), 'bar') + os.environ['DYLD_IMAGE_SUFFIX'] = 'foobar' + self.assertEqual(dyld.dyld_image_suffix(), 'foobar') + self.assertEqual(dyld.dyld_image_suffix(None), 'foobar') + + def test_dyld_helpers(self): + record = [] + def fake__dyld_env(env, key): + record.append((env, key)) + return ['hello'] + + dyld._dyld_env = fake__dyld_env + self.assertEqual(dyld.dyld_framework_path(), ['hello']) + self.assertEqual(dyld.dyld_framework_path({}), ['hello']) + + self.assertEqual(dyld.dyld_library_path(), ['hello']) + self.assertEqual(dyld.dyld_library_path({}), ['hello']) + + self.assertEqual(dyld.dyld_fallback_framework_path(), ['hello']) + self.assertEqual(dyld.dyld_fallback_framework_path({}), ['hello']) + + self.assertEqual(dyld.dyld_fallback_library_path(), ['hello']) + self.assertEqual(dyld.dyld_fallback_library_path({}), ['hello']) + + self.assertEqual(record, [ + (None, 'DYLD_FRAMEWORK_PATH'), + ({}, 'DYLD_FRAMEWORK_PATH'), + (None, 'DYLD_LIBRARY_PATH'), + ({}, 'DYLD_LIBRARY_PATH'), + (None, 'DYLD_FALLBACK_FRAMEWORK_PATH'), + ({}, 'DYLD_FALLBACK_FRAMEWORK_PATH'), + (None, 'DYLD_FALLBACK_LIBRARY_PATH'), + ({}, 'DYLD_FALLBACK_LIBRARY_PATH'), + ]) + + def test_dyld_suffix_search(self): + envs = [object()] + def fake_suffix(env): + envs[0] = env + return None + dyld.dyld_image_suffix = fake_suffix + + iterator = [ + '/usr/lib/foo', + '/usr/lib/foo.dylib', + ] + result = dyld.dyld_image_suffix_search(iter(iterator)) + self.assertEqual(list(result), iterator) + self.assertEqual(envs[0], None) + + result = dyld.dyld_image_suffix_search(iter(iterator), {}) + self.assertEqual(list(result), iterator) + self.assertEqual(envs[0], {}) + + envs = [object()] + def fake_suffix(env): + envs[0] = env + return '_profile' + dyld.dyld_image_suffix = fake_suffix + + iterator = [ + '/usr/lib/foo', + '/usr/lib/foo.dylib', + ] + result = dyld.dyld_image_suffix_search(iter(iterator)) + self.assertEqual(list(result), [ + '/usr/lib/foo_profile', + '/usr/lib/foo', + '/usr/lib/foo_profile.dylib', + '/usr/lib/foo.dylib', + ]) + self.assertEqual(envs[0], None) + + result = dyld.dyld_image_suffix_search(iter(iterator), {}) + self.assertEqual(list(result), [ + '/usr/lib/foo_profile', + '/usr/lib/foo', + '/usr/lib/foo_profile.dylib', + '/usr/lib/foo.dylib', + ]) + self.assertEqual(envs[0], {}) + + def test_override_search(self): + os.environ['DYLD_FRAMEWORK_PATH'] = '' + os.environ['DYLD_LIBRARY_PATH'] = '' + + self.assertEqual( + list(dyld.dyld_override_search("foo.dyld", None)), []) + self.assertEqual( + list(dyld.dyld_override_search("/usr/lib/libfoo.dyld", None)), []) + self.assertEqual( + list(dyld.dyld_override_search("/Library/Frameworks/Python.framework/Versions/Current/Python", None)), []) + + + os.environ['DYLD_FRAMEWORK_PATH'] = '/Foo/Frameworks:/Bar/Frameworks' + os.environ['DYLD_LIBRARY_PATH'] = '' + self.assertEqual( + list(dyld.dyld_override_search("foo.dyld", None)), []) + self.assertEqual( + list(dyld.dyld_override_search("/usr/lib/libfoo.dyld", None)), []) + self.assertEqual( + list(dyld.dyld_override_search("/Library/Frameworks/Python.framework/Versions/Current/Python", None)), [ + '/Foo/Frameworks/Python.framework/Versions/Current/Python', + '/Bar/Frameworks/Python.framework/Versions/Current/Python', + ]) + + os.environ['DYLD_FRAMEWORK_PATH'] = '' + os.environ['DYLD_LIBRARY_PATH'] = '/local/lib:/remote/lib' + self.assertEqual( + list(dyld.dyld_override_search("foo.dyld", None)), [ + '/local/lib/foo.dyld', + '/remote/lib/foo.dyld', + ]) + self.assertEqual( + list(dyld.dyld_override_search("/usr/lib/libfoo.dyld", None)), [ + '/local/lib/libfoo.dyld', + '/remote/lib/libfoo.dyld', + ]) + self.assertEqual( + list(dyld.dyld_override_search("/Library/Frameworks/Python.framework/Versions/Current/Python", None)), [ + '/local/lib/Python', + '/remote/lib/Python', + ]) + + os.environ['DYLD_FRAMEWORK_PATH'] = '/Foo/Frameworks:/Bar/Frameworks' + os.environ['DYLD_LIBRARY_PATH'] = '/local/lib:/remote/lib' + self.assertEqual( + list(dyld.dyld_override_search("foo.dyld", None)), [ + '/local/lib/foo.dyld', + '/remote/lib/foo.dyld', + ]) + self.assertEqual( + list(dyld.dyld_override_search("/usr/lib/libfoo.dyld", None)), [ + '/local/lib/libfoo.dyld', + '/remote/lib/libfoo.dyld', + ]) + self.assertEqual( + list(dyld.dyld_override_search("/Library/Frameworks/Python.framework/Versions/Current/Python", None)), [ + '/Foo/Frameworks/Python.framework/Versions/Current/Python', + '/Bar/Frameworks/Python.framework/Versions/Current/Python', + '/local/lib/Python', + '/remote/lib/Python', + ]) + + def test_executable_path_search(self): + self.assertEqual(list(dyld.dyld_executable_path_search("/usr/lib/foo.dyld", "/usr/bin")), []) + self.assertEqual( + list(dyld.dyld_executable_path_search("@executable_path/foo.dyld", "/usr/bin")), + ['/usr/bin/foo.dyld']) + self.assertEqual( + list(dyld.dyld_executable_path_search("@executable_path/../../lib/foo.dyld", "/usr/bin")), + ['/usr/bin/../../lib/foo.dyld']) + + def test_default_search(self): + self.assertEqual( + list(dyld.dyld_default_search('/usr/lib/mylib.dylib', None)), [ + '/usr/lib/mylib.dylib', + os.path.join(os.path.expanduser('~/lib'), 'mylib.dylib'), + '/usr/local/lib/mylib.dylib', + '/lib/mylib.dylib', + '/usr/lib/mylib.dylib', + + ]) + + self.assertEqual( + list(dyld.dyld_default_search('/Library/Frameworks/Python.framework/Versions/2.7/Python', None)), [ + '/Library/Frameworks/Python.framework/Versions/2.7/Python', + os.path.join(os.path.expanduser('~/Library/Frameworks'), 'Python.framework/Versions/2.7/Python'), + '/Library/Frameworks/Python.framework/Versions/2.7/Python', + '/Network/Library/Frameworks/Python.framework/Versions/2.7/Python', + '/System/Library/Frameworks/Python.framework/Versions/2.7/Python', + os.path.join(os.path.expanduser('~/lib'), 'Python'), + '/usr/local/lib/Python', + '/lib/Python', + '/usr/lib/Python', + ]) + + + + + os.environ['DYLD_FALLBACK_LIBRARY_PATH'] = '/local/lib:/network/lib' + os.environ['DYLD_FALLBACK_FRAMEWORK_PATH'] = '' + + self.assertEqual( + list(dyld.dyld_default_search('/usr/lib/mylib.dylib', None)), [ + '/usr/lib/mylib.dylib', + '/local/lib/mylib.dylib', + '/network/lib/mylib.dylib', + ]) + + + self.assertEqual( + list(dyld.dyld_default_search('/Library/Frameworks/Python.framework/Versions/2.7/Python', None)), [ + '/Library/Frameworks/Python.framework/Versions/2.7/Python', + os.path.join(os.path.expanduser('~/Library/Frameworks'), 'Python.framework/Versions/2.7/Python'), + '/Library/Frameworks/Python.framework/Versions/2.7/Python', + '/Network/Library/Frameworks/Python.framework/Versions/2.7/Python', + '/System/Library/Frameworks/Python.framework/Versions/2.7/Python', + '/local/lib/Python', + '/network/lib/Python', + ]) + + + os.environ['DYLD_FALLBACK_LIBRARY_PATH'] = '' + os.environ['DYLD_FALLBACK_FRAMEWORK_PATH'] = '/MyFrameworks:/OtherFrameworks' + + + self.assertEqual( + list(dyld.dyld_default_search('/usr/lib/mylib.dylib', None)), [ + '/usr/lib/mylib.dylib', + os.path.join(os.path.expanduser('~/lib'), 'mylib.dylib'), + '/usr/local/lib/mylib.dylib', + '/lib/mylib.dylib', + '/usr/lib/mylib.dylib', + + ]) + + self.assertEqual( + list(dyld.dyld_default_search('/Library/Frameworks/Python.framework/Versions/2.7/Python', None)), [ + '/Library/Frameworks/Python.framework/Versions/2.7/Python', + '/MyFrameworks/Python.framework/Versions/2.7/Python', + '/OtherFrameworks/Python.framework/Versions/2.7/Python', + os.path.join(os.path.expanduser('~/lib'), 'Python'), + '/usr/local/lib/Python', + '/lib/Python', + '/usr/lib/Python', + ]) + + os.environ['DYLD_FALLBACK_LIBRARY_PATH'] = '/local/lib:/network/lib' + os.environ['DYLD_FALLBACK_FRAMEWORK_PATH'] = '/MyFrameworks:/OtherFrameworks' + + + self.assertEqual( + list(dyld.dyld_default_search('/usr/lib/mylib.dylib', None)), [ + '/usr/lib/mylib.dylib', + '/local/lib/mylib.dylib', + '/network/lib/mylib.dylib', + + ]) + + self.assertEqual( + list(dyld.dyld_default_search('/Library/Frameworks/Python.framework/Versions/2.7/Python', None)), [ + '/Library/Frameworks/Python.framework/Versions/2.7/Python', + '/MyFrameworks/Python.framework/Versions/2.7/Python', + '/OtherFrameworks/Python.framework/Versions/2.7/Python', + '/local/lib/Python', + '/network/lib/Python', + ]) + + def test_dyld_find(self): + result = dyld.dyld_find('/usr/lib/libSystem.dylib') + self.assertEqual(result, '/usr/lib/libSystem.dylib') + self.assertIsInstance(result, str) # bytes on 2.x, unicode on 3.x + + result = dyld.dyld_find(b'/usr/lib/libSystem.dylib'.decode('ascii')) + self.assertEqual(result, '/usr/lib/libSystem.dylib') + self.assertIsInstance(result, str) # bytes on 2.x, unicode on 3.x + + patcher = DyldPatcher() + try: + patcher.log_calls('dyld_image_suffix_search') + patcher.log_calls('dyld_override_search') + patcher.log_calls('dyld_executable_path_search') + patcher.log_calls('dyld_default_search') + + result = dyld.dyld_find('/usr/lib/libSystem.dylib') + self.assertEqual(patcher.calls[:-1], [ + ('dyld_override_search', ('/usr/lib/libSystem.dylib', None), {}), + ('dyld_executable_path_search', ('/usr/lib/libSystem.dylib', None), {}), + ('dyld_default_search', ('/usr/lib/libSystem.dylib', None), {}), + ]) + self.assertEqual(patcher.calls[-1][0], 'dyld_image_suffix_search') + patcher.clear_calls() + + result = dyld.dyld_find('/usr/lib/libSystem.dylib', env=None) + self.assertEqual(patcher.calls[:-1], [ + ('dyld_override_search', ('/usr/lib/libSystem.dylib', None), {}), + ('dyld_executable_path_search', ('/usr/lib/libSystem.dylib', None), {}), + ('dyld_default_search', ('/usr/lib/libSystem.dylib', None), {}), + ]) + self.assertEqual(patcher.calls[-1][0], 'dyld_image_suffix_search') + patcher.clear_calls() + + result = dyld.dyld_find('/usr/lib/libSystem.dylib', env={}) + self.assertEqual(patcher.calls[:-1], [ + ('dyld_override_search', ('/usr/lib/libSystem.dylib', {}), {}), + ('dyld_executable_path_search', ('/usr/lib/libSystem.dylib', None), {}), + ('dyld_default_search', ('/usr/lib/libSystem.dylib', {}), {}), + ]) + self.assertEqual(patcher.calls[-1][0], 'dyld_image_suffix_search') + patcher.clear_calls() + + result = dyld.dyld_find('/usr/lib/libSystem.dylib', executable_path="/opt/py2app/bin", env={}) + self.assertEqual(patcher.calls[:-1], [ + ('dyld_override_search', ('/usr/lib/libSystem.dylib', {}), {}), + ('dyld_executable_path_search', ('/usr/lib/libSystem.dylib', "/opt/py2app/bin"), {}), + ('dyld_default_search', ('/usr/lib/libSystem.dylib', {}), {}), + ]) + self.assertEqual(patcher.calls[-1][0], 'dyld_image_suffix_search') + patcher.clear_calls() + + finally: + patcher.cleanup() + + def test_framework_find(self): + result = dyld.framework_find('/System/Library/Frameworks/Cocoa.framework/Versions/Current/Cocoa') + self.assertEqual(result, '/System/Library/Frameworks/Cocoa.framework/Versions/Current/Cocoa') + self.assertIsInstance(result, str) # bytes on 2.x, unicode on 3.x + + result = dyld.framework_find(b'/System/Library/Frameworks/Cocoa.framework/Versions/Current/Cocoa'.decode('latin1')) + self.assertEqual(result, '/System/Library/Frameworks/Cocoa.framework/Versions/Current/Cocoa') + self.assertIsInstance(result, str) # bytes on 2.x, unicode on 3.x + + result = dyld.framework_find('Cocoa.framework') + self.assertEqual(result, '/System/Library/Frameworks/Cocoa.framework/Cocoa') + self.assertIsInstance(result, str) # bytes on 2.x, unicode on 3.x + + result = dyld.framework_find('Cocoa') + self.assertEqual(result, '/System/Library/Frameworks/Cocoa.framework/Cocoa') + self.assertIsInstance(result, str) # bytes on 2.x, unicode on 3.x + + patcher = DyldPatcher() + try: + patcher.log_calls('dyld_find') + + result = dyld.framework_find('/System/Library/Frameworks/Cocoa.framework/Versions/Current/Cocoa') + self.assertEqual(patcher.calls, [ + ('dyld_find', ('/System/Library/Frameworks/Cocoa.framework/Versions/Current/Cocoa',), + {'env':None, 'executable_path': None}), + ]) + patcher.clear_calls() + + result = dyld.framework_find('Cocoa') + self.assertEqual(patcher.calls, [ + ('dyld_find', ('Cocoa',), + {'env':None, 'executable_path': None}), + ('dyld_find', ('Cocoa.framework/Cocoa',), + {'env':None, 'executable_path': None}), + ]) + patcher.clear_calls() + + result = dyld.framework_find('Cocoa', '/my/sw/bin', {}) + self.assertEqual(patcher.calls, [ + ('dyld_find', ('Cocoa',), + {'env':{}, 'executable_path': '/my/sw/bin'}), + ('dyld_find', ('Cocoa.framework/Cocoa',), + {'env':{}, 'executable_path': '/my/sw/bin'}), + ]) + patcher.clear_calls() + + + finally: + patcher.cleanup() + + + + +class TestTrivialDyld (unittest.TestCase): + # Tests ported from the implementation file + def testBasic(self): + self.assertEqual(dyld.dyld_find('libSystem.dylib'), '/usr/lib/libSystem.dylib') + self.assertEqual(dyld.dyld_find('System.framework/System'), '/System/Library/Frameworks/System.framework/System') + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_dylib.py b/python/macholib/macholib_tests/test_dylib.py new file mode 100644 index 000000000..dcbc45358 --- /dev/null +++ b/python/macholib/macholib_tests/test_dylib.py @@ -0,0 +1,38 @@ +from macholib import dylib + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +def d(location=None, name=None, shortname=None, version=None, suffix=None): + return dict( + location=location, + name=name, + shortname=shortname, + version=version, + suffix=suffix + ) + +class TestDylib (unittest.TestCase): + def testInvalid(self): + self.assertTrue(dylib.dylib_info('completely/invalid') is None) + self.assertTrue(dylib.dylib_info('completely/invalid_debug') is None) + + def testUnversioned(self): + self.assertEqual(dylib.dylib_info('P/Foo.dylib'), + d('P', 'Foo.dylib', 'Foo')) + self.assertEqual(dylib.dylib_info('P/Foo_debug.dylib'), + d('P', 'Foo_debug.dylib', 'Foo', suffix='debug')) + + def testVersioned(self): + self.assertEqual(dylib.dylib_info('P/Foo.A.dylib'), + d('P', 'Foo.A.dylib', 'Foo', 'A')) + self.assertEqual(dylib.dylib_info('P/Foo_debug.A.dylib'), + d('P', 'Foo_debug.A.dylib', 'Foo_debug', 'A')) + self.assertEqual(dylib.dylib_info('P/Foo.A_debug.dylib'), + d('P', 'Foo.A_debug.dylib', 'Foo', 'A', 'debug')) + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_framework.py b/python/macholib/macholib_tests/test_framework.py new file mode 100644 index 000000000..8c123afd0 --- /dev/null +++ b/python/macholib/macholib_tests/test_framework.py @@ -0,0 +1,88 @@ +from macholib import framework + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + + +class TestFramework (unittest.TestCase): + def test_framework(self): + self.assertEqual( + framework.framework_info('Location/Name.framework/Versions/SomeVersion/Name_Suffix'), + dict( + location='Location', + name='Name.framework/Versions/SomeVersion/Name_Suffix', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + )) + self.assertEqual( + framework.framework_info('Location/Name.framework/Versions/SomeVersion/Name'), + dict( + location='Location', + name='Name.framework/Versions/SomeVersion/Name', + shortname='Name', + version='SomeVersion', + suffix=None, + )) + self.assertEqual( + framework.framework_info('Location/Name.framework/Name_Suffix'), + dict( + location='Location', + name='Name.framework/Name_Suffix', + shortname='Name', + version=None, + suffix='Suffix', + )) + self.assertEqual( + framework.framework_info('Location/Name.framework/Name'), + dict( + location='Location', + name='Name.framework/Name', + shortname='Name', + version=None, + suffix=None + )) + self.assertEqual( + framework.framework_info('Location/Name.framework.disabled/Name'), + None + ) + self.assertEqual( + framework.framework_info('Location/Name.framework/Versions/A/B/Name'), + None + ) + self.assertEqual( + framework.framework_info('Location/Name.framework/Versions/A'), + None + ) + self.assertEqual( + framework.framework_info('Location/Name.framework/Versions/A/Name/_debug'), + None + ) + + def test_interal_tests(self): + # Ported over from the source file + def d(location=None, name=None, shortname=None, version=None, suffix=None): + return dict( + location=location, + name=name, + shortname=shortname, + version=version, + suffix=suffix + ) + self.assertEqual(framework.framework_info('completely/invalid'), None) + self.assertEqual(framework.framework_info('completely/invalid/_debug'), None) + self.assertEqual(framework.framework_info('P/F.framework'), None) + self.assertEqual(framework.framework_info('P/F.framework/_debug'), None) + self.assertEqual(framework.framework_info('P/F.framework/F'), d('P', 'F.framework/F', 'F')) + self.assertEqual(framework.framework_info('P/F.framework/F_debug'), d('P', 'F.framework/F_debug', 'F', suffix='debug')) + self.assertEqual(framework.framework_info('P/F.framework/Versions'), None) + self.assertEqual(framework.framework_info('P/F.framework/Versions/A'), None) + self.assertEqual(framework.framework_info('P/F.framework/Versions/A/F'), d('P', 'F.framework/Versions/A/F', 'F', 'A')) + self.assertEqual(framework.framework_info('P/F.framework/Versions/A/F_debug'), d('P', 'F.framework/Versions/A/F_debug', 'F', 'A', 'debug')) + + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_itergraphreport.py b/python/macholib/macholib_tests/test_itergraphreport.py new file mode 100644 index 000000000..f3e7c28a3 --- /dev/null +++ b/python/macholib/macholib_tests/test_itergraphreport.py @@ -0,0 +1,15 @@ +from macholib import itergraphreport + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +class TestIterGraphReport (unittest.TestCase): + @unittest.expectedFailure + def test_missing(self): + self.fail("tests are missing") + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_mach_o.py b/python/macholib/macholib_tests/test_mach_o.py new file mode 100644 index 000000000..0fbcf04b2 --- /dev/null +++ b/python/macholib/macholib_tests/test_mach_o.py @@ -0,0 +1,21 @@ +from macholib import mach_o + +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + + +class TestMachO (unittest.TestCase): + # This module is just a set of struct definitions, + # not sure how to test those without replicating + # the code. + # + # The definitions will get exercised by the + # other tests, therefore testing is ignored + # for now. + pass + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/macholib_tests/test_ptypes.py b/python/macholib/macholib_tests/test_ptypes.py new file mode 100644 index 000000000..f221d37d3 --- /dev/null +++ b/python/macholib/macholib_tests/test_ptypes.py @@ -0,0 +1,191 @@ +from macholib import ptypes + +import unittest +import sys +if sys.version_info[:2] <= (2,6): + import unittest2 as unittest +else: + import unittest + +try: + from io import BytesIO +except ImportError: + from cStringIO import StringIO as BytesIO +import mmap + +try: + long +except NameError: + long = int + + +class TestPTypes (unittest.TestCase): + if not hasattr(unittest.TestCase, 'assertIsSubclass'): + def assertIsSubclass(self, class1, class2, message=None): + self.assertTrue(issubclass(class1, class2), + message or "%r is not a subclass of %r"%(class1, class2)) + + if not hasattr(unittest.TestCase, 'assertIsInstance'): + def assertIsInstance(self, value, types, message=None): + self.assertTrue(isinstance(value, types), + message or "%r is not an instance of %r"%(value, types)) + + def test_sizeof(self): + self.assertEqual(ptypes.sizeof(b"foobar"), 6) + + self.assertRaises(ValueError, ptypes.sizeof, []) + self.assertRaises(ValueError, ptypes.sizeof, {}) + self.assertRaises(ValueError, ptypes.sizeof, b"foo".decode('ascii')) + + class M (object): + pass + + m = M() + m._size_ = 42 + self.assertEqual(ptypes.sizeof(m), 42) + + + def verifyType(self, ptype, size, pytype, values): + self.assertEqual(ptypes.sizeof(ptype), size) + self.assertIsSubclass(ptype, pytype) + + for v in values: + pv = ptype(v) + packed = pv.to_str() + self.assertIsInstance(packed, bytes) + self.assertEqual(len(packed), size) + + unp = ptype.from_str(packed) + self.assertIsInstance(unp, ptype) + self.assertEqual(unp, pv) + + fp = BytesIO(packed) + unp = ptype.from_fileobj(fp) + fp.close() + self.assertIsInstance(unp, ptype) + self.assertEqual(unp, pv) + + fp = BytesIO() + pv.to_fileobj(fp) + data = fp.getvalue() + fp.close() + self.assertEqual(data, packed) + + mm = mmap.mmap(-1, size+20) + mm[:] = b'\x00' * (size+20) + pv.to_mmap(mm, 10) + + self.assertEqual(ptype.from_mmap(mm, 10), pv) + self.assertEqual(mm[:], (b'\x00'*10) + packed + (b'\x00'*10)) + + self.assertEqual(ptype.from_tuple((v,)), pv) + + def test_basic_types(self): + self.verifyType(ptypes.p_char, 1, bytes, [b'a', b'b']) + self.verifyType(ptypes.p_int8, 1, int, [1, 42, -4]) + self.verifyType(ptypes.p_uint8, 1, int, [1, 42, 253]) + + self.verifyType(ptypes.p_int16, 2, int, [1, 400, -10, -5000]) + self.verifyType(ptypes.p_uint16, 2, int, [1, 400, 65000]) + + self.verifyType(ptypes.p_int32, 4, int, [1, 400, 2**24, -10, -5000, -2**24]) + self.verifyType(ptypes.p_uint32, 4, long, [1, 400, 2*31+5, 65000]) + + self.verifyType(ptypes.p_int64, 8, long, [1, 400, 2**43, -10, -5000, -2**43]) + self.verifyType(ptypes.p_uint64, 8, long, [1, 400, 2*63+5, 65000]) + + self.verifyType(ptypes.p_float, 4, float, [1.0, 42.5]) + self.verifyType(ptypes.p_double, 8, float, [1.0, 42.5]) + + def test_basic_types_deprecated(self): + self.verifyType(ptypes.p_byte, 1, int, [1, 42, -4]) + self.verifyType(ptypes.p_ubyte, 1, int, [1, 42, 253]) + + self.verifyType(ptypes.p_short, 2, int, [1, 400, -10, -5000]) + self.verifyType(ptypes.p_ushort, 2, int, [1, 400, 65000]) + + self.verifyType(ptypes.p_int, 4, int, [1, 400, 2**24, -10, -5000, -2**24]) + self.verifyType(ptypes.p_uint, 4, long, [1, 400, 2*31+5, 65000]) + + self.verifyType(ptypes.p_long, 4, int, [1, 400, 2**24, -10, -5000, -2**24]) + self.verifyType(ptypes.p_ulong, 4, long, [1, 400, 2*31+5, 65000]) + + self.verifyType(ptypes.p_longlong, 8, long, [1, 400, 2**43, -10, -5000, -2**43]) + self.verifyType(ptypes.p_ulonglong, 8, long, [1, 400, 2*63+5, 65000]) + +class TestPTypesPrivate (unittest.TestCase): + # These are tests for functions that aren't part of the public + # API. + + def test_formatinfo(self): + self.assertEqual(ptypes._formatinfo(">b"), (1, 1)) + self.assertEqual(ptypes._formatinfo(">h"), (2, 1)) + self.assertEqual(ptypes._formatinfo(">HhL"), (8, 3)) + self.assertEqual(ptypes._formatinfo("<': + kw = dict(_endian_=endian) + MYSTRUCTURE = b'\x00\x11\x22\x33\xFF' + for fn, args in [ + ('from_str', (MYSTRUCTURE,)), + ('from_mmap', (MYSTRUCTURE, 0)), + ('from_fileobj', (BytesIO(MYSTRUCTURE),)), + ]: + myStructure = getattr(MyStructure, fn)(*args, **kw) + if endian == '>': + self.assertEqual(myStructure.foo, 0x00112233) + else: + self.assertEqual( myStructure.foo, 0x33221100) + self.assertEqual(myStructure.bar, 0xFF) + self.assertEqual(myStructure.to_str(), MYSTRUCTURE) + + MYFUNSTRUCTURE = b'!' + MYSTRUCTURE + for fn, args in [ + ('from_str', (MYFUNSTRUCTURE,)), + ('from_mmap', (MYFUNSTRUCTURE, 0)), + ('from_fileobj', (BytesIO(MYFUNSTRUCTURE),)), + ]: + myFunStructure = getattr(MyFunStructure, fn)(*args, **kw) + self.assertEqual(myFunStructure.mystruct, myStructure) + self.assertEqual(myFunStructure.fun, b'!', (myFunStructure.fun, b'!')) + self.assertEqual(myFunStructure.to_str(), MYFUNSTRUCTURE) + + sio = BytesIO() + myFunStructure.to_fileobj(sio) + self.assertEqual(sio.getvalue(), MYFUNSTRUCTURE) + + mm = mmap.mmap(-1, ptypes.sizeof(MyFunStructure) * 2) + mm[:] = b'\x00' * (ptypes.sizeof(MyFunStructure) * 2) + myFunStructure.to_mmap(mm, 0) + self.assertEqual(MyFunStructure.from_mmap(mm, 0, **kw), myFunStructure) + self.assertEqual(mm[:ptypes.sizeof(MyFunStructure)], MYFUNSTRUCTURE) + self.assertEqual(mm[ptypes.sizeof(MyFunStructure):], b'\x00' * ptypes.sizeof(MyFunStructure)) + myFunStructure.to_mmap(mm, ptypes.sizeof(MyFunStructure)) + self.assertEqual(mm[:], MYFUNSTRUCTURE + MYFUNSTRUCTURE) + self.assertEqual(MyFunStructure.from_mmap(mm, ptypes.sizeof(MyFunStructure), **kw), myFunStructure) + +if __name__ == "__main__": + unittest.main() diff --git a/python/macholib/setup.cfg b/python/macholib/setup.cfg new file mode 100644 index 000000000..1713110a8 --- /dev/null +++ b/python/macholib/setup.cfg @@ -0,0 +1,42 @@ +[metadata] +name = macholib +version = 1.7 +description = Mach-O header analysis and editing +long_description_file = + README.txt + doc/changelog.rst +classifiers = + Intended Audience :: Developers + License :: OSI Approved :: MIT License + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.3 + Programming Language :: Python :: 3.4 + Operating System :: MacOS :: MacOS X + Topic :: Software Development :: Libraries :: Python Modules + Topic :: Software Development :: Build Tools +author = Ronald Oussoren +author_email = ronaldoussoren@mac.com +maintainer = Ronald Oussoren +maintainer_email = ronaldoussoren@mac.com +url = http://bitbucket.org/ronaldoussoren/macholib +download_url = http://pypi.python.org/pypi/macholib +packages = macholib +license = MIT +platforms = any +requires-dist = + altgraph (>=0.12) +zip-safe = yes +console_scripts = + macho_find = macholib.macho_find:main + macho_standalone = macholib.macho_standalone:main + macho_dump = macholib.macho_dump:main +keywords = Mach-O, dyld + +[egg_info] +tag_build = +tag_date = 0 +tag_svn_revision = 0 + diff --git a/python/macholib/setup.py b/python/macholib/setup.py new file mode 100644 index 000000000..a1a4cb6eb --- /dev/null +++ b/python/macholib/setup.py @@ -0,0 +1,867 @@ +""" +Shared setup file for simple python packages. Uses a setup.cfg that +is the same as the distutils2 project, unless noted otherwise. + +It exists for two reasons: +1) This makes it easier to reuse setup.py code between my own + projects + +2) Easier migration to distutils2 when that catches on. + +Additional functionality: + +* Section metadata: + requires-test: Same as 'tests_require' option for setuptools. + +""" + +import sys +import os +import re +import platform +from fnmatch import fnmatch +import os +import sys +import time +import tempfile +import tarfile +try: + import urllib.request as urllib +except ImportError: + import urllib +from distutils import log +try: + from hashlib import md5 + +except ImportError: + from md5 import md5 + +if sys.version_info[0] == 2: + from ConfigParser import RawConfigParser, NoOptionError, NoSectionError +else: + from configparser import RawConfigParser, NoOptionError, NoSectionError + +ROOTDIR = os.path.dirname(os.path.abspath(__file__)) + + +# +# +# +# Parsing the setup.cfg and converting it to something that can be +# used by setuptools.setup() +# +# +# + +def eval_marker(value): + """ + Evaluate an distutils2 environment marker. + + This code is unsafe when used with hostile setup.cfg files, + but that's not a problem for our own files. + """ + value = value.strip() + + class M: + def __init__(self, **kwds): + for k, v in kwds.items(): + setattr(self, k, v) + + variables = { + 'python_version': '%d.%d'%(sys.version_info[0], sys.version_info[1]), + 'python_full_version': sys.version.split()[0], + 'os': M( + name=os.name, + ), + 'sys': M( + platform=sys.platform, + ), + 'platform': M( + version=platform.version(), + machine=platform.machine(), + ), + } + + return bool(eval(value, variables, variables)) + + + return True + +def _opt_value(cfg, into, section, key, transform = None): + try: + v = cfg.get(section, key) + if transform != _as_lines and ';' in v: + v, marker = v.rsplit(';', 1) + if not eval_marker(marker): + return + + v = v.strip() + + if v: + if transform: + into[key] = transform(v.strip()) + else: + into[key] = v.strip() + + except (NoOptionError, NoSectionError): + pass + +def _as_bool(value): + if value.lower() in ('y', 'yes', 'on'): + return True + elif value.lower() in ('n', 'no', 'off'): + return False + elif value.isdigit(): + return bool(int(value)) + else: + raise ValueError(value) + +def _as_list(value): + return value.split() + +def _as_lines(value): + result = [] + for v in value.splitlines(): + if ';' in v: + v, marker = v.rsplit(';', 1) + if not eval_marker(marker): + continue + + v = v.strip() + if v: + result.append(v) + else: + result.append(v) + return result + +def _map_requirement(value): + m = re.search(r'(\S+)\s*(?:\((.*)\))?', value) + name = m.group(1) + version = m.group(2) + + if version is None: + return name + + else: + mapped = [] + for v in version.split(','): + v = v.strip() + if v[0].isdigit(): + # Checks for a specific version prefix + m = v.rsplit('.', 1) + mapped.append('>=%s,<%s.%s'%( + v, m[0], int(m[1])+1)) + + else: + mapped.append(v) + return '%s %s'%(name, ','.join(mapped),) + +def _as_requires(value): + requires = [] + for req in value.splitlines(): + if ';' in req: + req, marker = v.rsplit(';', 1) + if not eval_marker(marker): + continue + req = req.strip() + + if not req: + continue + requires.append(_map_requirement(req)) + return requires + +def parse_setup_cfg(): + cfg = RawConfigParser() + r = cfg.read([os.path.join(ROOTDIR, 'setup.cfg')]) + if len(r) != 1: + print("Cannot read 'setup.cfg'") + sys.exit(1) + + metadata = dict( + name = cfg.get('metadata', 'name'), + version = cfg.get('metadata', 'version'), + description = cfg.get('metadata', 'description'), + ) + + _opt_value(cfg, metadata, 'metadata', 'license') + _opt_value(cfg, metadata, 'metadata', 'maintainer') + _opt_value(cfg, metadata, 'metadata', 'maintainer_email') + _opt_value(cfg, metadata, 'metadata', 'author') + _opt_value(cfg, metadata, 'metadata', 'author_email') + _opt_value(cfg, metadata, 'metadata', 'url') + _opt_value(cfg, metadata, 'metadata', 'download_url') + _opt_value(cfg, metadata, 'metadata', 'classifiers', _as_lines) + _opt_value(cfg, metadata, 'metadata', 'platforms', _as_list) + _opt_value(cfg, metadata, 'metadata', 'packages', _as_list) + _opt_value(cfg, metadata, 'metadata', 'keywords', _as_list) + + try: + v = cfg.get('metadata', 'requires-dist') + + except (NoOptionError, NoSectionError): + pass + + else: + requires = _as_requires(v) + if requires: + metadata['install_requires'] = requires + + try: + v = cfg.get('metadata', 'requires-test') + + except (NoOptionError, NoSectionError): + pass + + else: + requires = _as_requires(v) + if requires: + metadata['tests_require'] = requires + + + try: + v = cfg.get('metadata', 'long_description_file') + except (NoOptionError, NoSectionError): + pass + + else: + parts = [] + for nm in v.split(): + fp = open(nm, 'rU') + parts.append(fp.read()) + fp.close() + + metadata['long_description'] = '\n\n'.join(parts) + + + try: + v = cfg.get('metadata', 'zip-safe') + except (NoOptionError, NoSectionError): + pass + + else: + metadata['zip_safe'] = _as_bool(v) + + try: + v = cfg.get('metadata', 'console_scripts') + except (NoOptionError, NoSectionError): + pass + + else: + if 'entry_points' not in metadata: + metadata['entry_points'] = {} + + metadata['entry_points']['console_scripts'] = v.splitlines() + + if sys.version_info[:2] <= (2,6): + try: + metadata['tests_require'] += ", unittest2" + except KeyError: + metadata['tests_require'] = "unittest2" + + return metadata + + +# +# +# +# Bootstrapping setuptools/distribute, based on +# a heavily modified version of distribute_setup.py +# +# +# + + +SETUPTOOLS_PACKAGE='setuptools' + + +try: + import subprocess + + def _python_cmd(*args): + args = (sys.executable,) + args + return subprocess.call(args) == 0 + +except ImportError: + def _python_cmd(*args): + args = (sys.executable,) + args + new_args = [] + for a in args: + new_args.append(a.replace("'", "'\"'\"'")) + os.system(' '.join(new_args)) == 0 + + +try: + import json + + def get_pypi_src_download(package): + url = 'https://pypi.python.org/pypi/%s/json'%(package,) + fp = urllib.urlopen(url) + try: + try: + data = fp.read() + + finally: + fp.close() + except urllib.error: + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + pkgdata = json.loads(data.decode('utf-8')) + if 'urls' not in pkgdata: + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + for info in pkgdata['urls']: + if info['packagetype'] == 'sdist' and info['url'].endswith('tar.gz'): + return (info.get('md5_digest'), info['url']) + + raise RuntimeError("Cannot determine downlink link for %s"%(package,)) + +except ImportError: + # Python 2.5 compatibility, no JSON in stdlib but luckily JSON syntax is + # simular enough to Python's syntax to be able to abuse the Python compiler + + import _ast as ast + + def get_pypi_src_download(package): + url = 'https://pypi.python.org/pypi/%s/json'%(package,) + fp = urllib.urlopen(url) + try: + try: + data = fp.read() + + finally: + fp.close() + except urllib.error: + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + + a = compile(data, '-', 'eval', ast.PyCF_ONLY_AST) + if not isinstance(a, ast.Expression): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + a = a.body + if not isinstance(a, ast.Dict): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + for k, v in zip(a.keys, a.values): + if not isinstance(k, ast.Str): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + k = k.s + if k == 'urls': + a = v + break + else: + raise RuntimeError("PyPI JSON for %s doesn't contain URLs section"%(package,)) + + if not isinstance(a, ast.List): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + for info in v.elts: + if not isinstance(info, ast.Dict): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + url = None + packagetype = None + chksum = None + + for k, v in zip(info.keys, info.values): + if not isinstance(k, ast.Str): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + + if k.s == 'url': + if not isinstance(v, ast.Str): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + url = v.s + + elif k.s == 'packagetype': + if not isinstance(v, ast.Str): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + packagetype = v.s + + elif k.s == 'md5_digest': + if not isinstance(v, ast.Str): + raise RuntimeError("Cannot determine download link for %s"%(package,)) + chksum = v.s + + if url is not None and packagetype == 'sdist' and url.endswith('.tar.gz'): + return (chksum, url) + + raise RuntimeError("Cannot determine download link for %s"%(package,)) + +def _build_egg(egg, tarball, to_dir): + # extracting the tarball + tmpdir = tempfile.mkdtemp() + log.warn('Extracting in %s', tmpdir) + old_wd = os.getcwd() + try: + os.chdir(tmpdir) + tar = tarfile.open(tarball) + _extractall(tar) + tar.close() + + # going in the directory + subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0]) + os.chdir(subdir) + log.warn('Now working in %s', subdir) + + # building an egg + log.warn('Building a %s egg in %s', egg, to_dir) + _python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir) + + finally: + os.chdir(old_wd) + # returning the result + log.warn(egg) + if not os.path.exists(egg): + raise IOError('Could not build the egg.') + + +def _do_download(to_dir, packagename=SETUPTOOLS_PACKAGE): + tarball = download_setuptools(packagename, to_dir) + version = tarball.split('-')[-1][:-7] + egg = os.path.join(to_dir, '%s-%s-py%d.%d.egg' + % (packagename, version, sys.version_info[0], sys.version_info[1])) + if not os.path.exists(egg): + _build_egg(egg, tarball, to_dir) + sys.path.insert(0, egg) + import setuptools + setuptools.bootstrap_install_from = egg + + +def use_setuptools(): + # making sure we use the absolute path + return _do_download(os.path.abspath(os.curdir)) + +def download_setuptools(packagename, to_dir): + # making sure we use the absolute path + to_dir = os.path.abspath(to_dir) + try: + from urllib.request import urlopen + except ImportError: + from urllib2 import urlopen + + chksum, url = get_pypi_src_download(packagename) + tgz_name = os.path.basename(url) + saveto = os.path.join(to_dir, tgz_name) + + src = dst = None + if not os.path.exists(saveto): # Avoid repeated downloads + try: + log.warn("Downloading %s", url) + src = urlopen(url) + # Read/write all in one block, so we don't create a corrupt file + # if the download is interrupted. + data = src.read() + + if chksum is not None: + data_sum = md5(data).hexdigest() + if data_sum != chksum: + raise RuntimeError("Downloading %s failed: corrupt checksum"%(url,)) + + + dst = open(saveto, "wb") + dst.write(data) + finally: + if src: + src.close() + if dst: + dst.close() + return os.path.realpath(saveto) + + + +def _extractall(self, path=".", members=None): + """Extract all members from the archive to the current working + directory and set owner, modification time and permissions on + directories afterwards. `path' specifies a different directory + to extract to. `members' is optional and must be a subset of the + list returned by getmembers(). + """ + import copy + import operator + from tarfile import ExtractError + directories = [] + + if members is None: + members = self + + for tarinfo in members: + if tarinfo.isdir(): + # Extract directories with a safe mode. + directories.append(tarinfo) + tarinfo = copy.copy(tarinfo) + tarinfo.mode = 448 # decimal for oct 0700 + self.extract(tarinfo, path) + + # Reverse sort directories. + if sys.version_info < (2, 4): + def sorter(dir1, dir2): + return cmp(dir1.name, dir2.name) + directories.sort(sorter) + directories.reverse() + else: + directories.sort(key=operator.attrgetter('name'), reverse=True) + + # Set correct owner, mtime and filemode on directories. + for tarinfo in directories: + dirpath = os.path.join(path, tarinfo.name) + try: + self.chown(tarinfo, dirpath) + self.utime(tarinfo, dirpath) + self.chmod(tarinfo, dirpath) + except ExtractError: + e = sys.exc_info()[1] + if self.errorlevel > 1: + raise + else: + self._dbg(1, "tarfile: %s" % e) + + +# +# +# +# Definitions of custom commands +# +# +# + +try: + import setuptools + +except ImportError: + use_setuptools() + +from setuptools import setup + +try: + from distutils.core import PyPIRCCommand +except ImportError: + PyPIRCCommand = None # Ancient python version + +from distutils.core import Command +from distutils.errors import DistutilsError +from distutils import log + +if PyPIRCCommand is None: + class upload_docs (Command): + description = "upload sphinx documentation" + user_options = [] + + def initialize_options(self): + pass + + def finalize_options(self): + pass + + def run(self): + raise DistutilsError("not supported on this version of python") + +else: + class upload_docs (PyPIRCCommand): + description = "upload sphinx documentation" + user_options = PyPIRCCommand.user_options + + def initialize_options(self): + PyPIRCCommand.initialize_options(self) + self.username = '' + self.password = '' + + + def finalize_options(self): + PyPIRCCommand.finalize_options(self) + config = self._read_pypirc() + if config != {}: + self.username = config['username'] + self.password = config['password'] + + + def run(self): + import subprocess + import shutil + import zipfile + import os + import urllib + import StringIO + from base64 import standard_b64encode + import httplib + import urlparse + + # Extract the package name from distutils metadata + meta = self.distribution.metadata + name = meta.get_name() + + # Run sphinx + if os.path.exists('doc/_build'): + shutil.rmtree('doc/_build') + os.mkdir('doc/_build') + + p = subprocess.Popen(['make', 'html'], + cwd='doc') + exit = p.wait() + if exit != 0: + raise DistutilsError("sphinx-build failed") + + # Collect sphinx output + if not os.path.exists('dist'): + os.mkdir('dist') + zf = zipfile.ZipFile('dist/%s-docs.zip'%(name,), 'w', + compression=zipfile.ZIP_DEFLATED) + + for toplevel, dirs, files in os.walk('doc/_build/html'): + for fn in files: + fullname = os.path.join(toplevel, fn) + relname = os.path.relpath(fullname, 'doc/_build/html') + + print ("%s -> %s"%(fullname, relname)) + + zf.write(fullname, relname) + + zf.close() + + # Upload the results, this code is based on the distutils + # 'upload' command. + content = open('dist/%s-docs.zip'%(name,), 'rb').read() + + data = { + ':action': 'doc_upload', + 'name': name, + 'content': ('%s-docs.zip'%(name,), content), + } + auth = "Basic " + standard_b64encode(self.username + ":" + + self.password) + + + boundary = '--------------GHSKFJDLGDS7543FJKLFHRE75642756743254' + sep_boundary = '\n--' + boundary + end_boundary = sep_boundary + '--' + body = StringIO.StringIO() + for key, value in data.items(): + if not isinstance(value, list): + value = [value] + + for value in value: + if isinstance(value, tuple): + fn = ';filename="%s"'%(value[0]) + value = value[1] + else: + fn = '' + + body.write(sep_boundary) + body.write('\nContent-Disposition: form-data; name="%s"'%key) + body.write(fn) + body.write("\n\n") + body.write(value) + + body.write(end_boundary) + body.write('\n') + body = body.getvalue() + + self.announce("Uploading documentation to %s"%(self.repository,), log.INFO) + + schema, netloc, url, params, query, fragments = \ + urlparse.urlparse(self.repository) + + + if schema == 'http': + http = httplib.HTTPConnection(netloc) + elif schema == 'https': + http = httplib.HTTPSConnection(netloc) + else: + raise AssertionError("unsupported schema "+schema) + + data = '' + loglevel = log.INFO + try: + http.connect() + http.putrequest("POST", url) + http.putheader('Content-type', + 'multipart/form-data; boundary=%s'%boundary) + http.putheader('Content-length', str(len(body))) + http.putheader('Authorization', auth) + http.endheaders() + http.send(body) + except socket.error: + e = socket.exc_info()[1] + self.announce(str(e), log.ERROR) + return + + r = http.getresponse() + if r.status in (200, 301): + self.announce('Upload succeeded (%s): %s' % (r.status, r.reason), + log.INFO) + else: + self.announce('Upload failed (%s): %s' % (r.status, r.reason), + log.ERROR) + + print ('-'*75) + print (r.read()) + print ('-'*75) + + +def recursiveGlob(root, pathPattern): + """ + Recursively look for files matching 'pathPattern'. Return a list + of matching files/directories. + """ + result = [] + + for rootpath, dirnames, filenames in os.walk(root): + for fn in filenames: + if fnmatch(fn, pathPattern): + result.append(os.path.join(rootpath, fn)) + return result + + +def importExternalTestCases(unittest, + pathPattern="test_*.py", root=".", package=None): + """ + Import all unittests in the PyObjC tree starting at 'root' + """ + + testFiles = recursiveGlob(root, pathPattern) + testModules = map(lambda x:x[len(root)+1:-3].replace('/', '.'), testFiles) + if package is not None: + testModules = [(package + '.' + m) for m in testModules] + + suites = [] + + for modName in testModules: + try: + module = __import__(modName) + except ImportError: + print("SKIP %s: %s"%(modName, sys.exc_info()[1])) + continue + + if '.' in modName: + for elem in modName.split('.')[1:]: + module = getattr(module, elem) + + s = unittest.defaultTestLoader.loadTestsFromModule(module) + suites.append(s) + + return unittest.TestSuite(suites) + + + +class test (Command): + description = "run test suite" + user_options = [ + ('verbosity=', None, "print what tests are run"), + ] + + def initialize_options(self): + self.verbosity='1' + + def finalize_options(self): + if isinstance(self.verbosity, str): + self.verbosity = int(self.verbosity) + + + def cleanup_environment(self): + ei_cmd = self.get_finalized_command('egg_info') + egg_name = ei_cmd.egg_name.replace('-', '_') + + to_remove = [] + for dirname in sys.path: + bn = os.path.basename(dirname) + if bn.startswith(egg_name + "-"): + to_remove.append(dirname) + + for dirname in to_remove: + log.info("removing installed %r from sys.path before testing"%( + dirname,)) + sys.path.remove(dirname) + + def add_project_to_sys_path(self): + from pkg_resources import normalize_path, add_activation_listener + from pkg_resources import working_set, require + + self.reinitialize_command('egg_info') + self.run_command('egg_info') + self.reinitialize_command('build_ext', inplace=1) + self.run_command('build_ext') + + + # Check if this distribution is already on sys.path + # and remove that version, this ensures that the right + # copy of the package gets tested. + + self.__old_path = sys.path[:] + self.__old_modules = sys.modules.copy() + + + ei_cmd = self.get_finalized_command('egg_info') + sys.path.insert(0, normalize_path(ei_cmd.egg_base)) + sys.path.insert(1, os.path.dirname(__file__)) + + # Strip the namespace packages defined in this distribution + # from sys.modules, needed to reset the search path for + # those modules. + + nspkgs = getattr(self.distribution, 'namespace_packages') + if nspkgs is not None: + for nm in nspkgs: + del sys.modules[nm] + + # Reset pkg_resources state: + add_activation_listener(lambda dist: dist.activate()) + working_set.__init__() + require('%s==%s'%(ei_cmd.egg_name, ei_cmd.egg_version)) + + def remove_from_sys_path(self): + from pkg_resources import working_set + sys.path[:] = self.__old_path + sys.modules.clear() + sys.modules.update(self.__old_modules) + working_set.__init__() + + + def run(self): + import unittest + + # Ensure that build directory is on sys.path (py3k) + + self.cleanup_environment() + self.add_project_to_sys_path() + + try: + meta = self.distribution.metadata + name = meta.get_name() + test_pkg = name + "_tests" + suite = importExternalTestCases(unittest, + "test_*.py", test_pkg, test_pkg) + + runner = unittest.TextTestRunner(verbosity=self.verbosity) + result = runner.run(suite) + + # Print out summary. This is a structured format that + # should make it easy to use this information in scripts. + summary = dict( + count=result.testsRun, + fails=len(result.failures), + errors=len(result.errors), + xfails=len(getattr(result, 'expectedFailures', [])), + xpass=len(getattr(result, 'expectedSuccesses', [])), + skip=len(getattr(result, 'skipped', [])), + ) + print("SUMMARY: %s"%(summary,)) + + finally: + self.remove_from_sys_path() + +# +# +# +# And finally run the setuptools main entry point. +# +# +# + +metadata = parse_setup_cfg() + +setup( + cmdclass=dict( + upload_docs=upload_docs, + test=test, + ), + **metadata +) -- cgit v1.2.3