import FIREFOX_52_6_0esr_RELEASE from mozilla-esr52 hg repo

This commit is contained in:
Roy Tam 2018-01-19 03:59:58 +08:00
commit dcd9973243
150858 changed files with 23884658 additions and 0 deletions

View file

@ -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

View file

@ -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.

View file

@ -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]]]])

View file

@ -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 <target>' where <target> 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."

View file

@ -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.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View file

@ -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

View file

@ -0,0 +1,132 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.MachO — Utilities for reading and writing Mach-O headers &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.MachoGraph — Graph data structure of Mach-O dependencies" href="MachoOGraph.html" />
<link rel="prev" title="Command-line tools" href="scripts.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="MachoOGraph.html" title="macholib.MachoGraph — Graph data structure of Mach-O dependencies"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="scripts.html" title="Command-line tools"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.MachO">
<span id="macholib-macho-utilities-for-reading-and-writing-mach-o-headers"></span><h1><a class="reference internal" href="#module-macholib.MachO" title="macholib.MachO: Utilities for reading and writing Mach-O headers"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.MachO</span></tt></a> &#8212; Utilities for reading and writing Mach-O headers<a class="headerlink" href="#module-macholib.MachO" title="Permalink to this headline"></a></h1>
<p>This module defines a class <tt class="xref py py-class docutils literal"><span class="pre">Macho</span></tt>, which enables reading
and writing the Mach-O header of an executable file or dynamic
library on MacOS X.</p>
<dl class="class">
<dt id="macholib.MachO.MachO">
<em class="property">class </em><tt class="descclassname">macholib.MachO.</tt><tt class="descname">MachO</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#macholib.MachO.MachO" title="Permalink to this definition"></a></dt>
<dd><p>Creates a MachO object by reading the Mach-O headers from
<em>filename</em>.</p>
<p>The <em>filename</em> should refer to an existing file in Mach-O
format, and can refer to fat (universal) binaries.</p>
</dd></dl>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">more information will be added later</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="scripts.html"
title="previous chapter">Command-line tools</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="MachoOGraph.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.MachoGraph</span></tt> &#8212; Graph data structure of Mach-O dependencies</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/MachO.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="MachoOGraph.html" title="macholib.MachoGraph — Graph data structure of Mach-O dependencies"
>next</a> |</li>
<li class="right" >
<a href="scripts.html" title="Command-line tools"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,125 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.MachoGraph — Graph data structure of Mach-O dependencies &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.MachOStandalone — Create standalone application bundles" href="MachoOStandalone.html" />
<link rel="prev" title="macholib.MachO — Utilities for reading and writing Mach-O headers" href="MachO.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="MachoOStandalone.html" title="macholib.MachOStandalone — Create standalone application bundles"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="MachO.html" title="macholib.MachO — Utilities for reading and writing Mach-O headers"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.MachOGraph">
<span id="macholib-machograph-graph-data-structure-of-mach-o-dependencies"></span><h1><tt class="xref py py-mod docutils literal"><span class="pre">macholib.MachoGraph</span></tt> &#8212; Graph data structure of Mach-O dependencies<a class="headerlink" href="#module-macholib.MachOGraph" title="Permalink to this headline"></a></h1>
<p>This module defines the class <a class="reference internal" href="#macholib.MachOGraph.MachOGraph" title="macholib.MachOGraph.MachOGraph"><tt class="xref py py-class docutils literal"><span class="pre">MachOGraph</span></tt></a> which represents the
direct and indirect dependencies of one or more Mach-O files on
other (library) files.</p>
<dl class="class">
<dt id="macholib.MachOGraph.MachOGraph">
<em class="property">class </em><tt class="descclassname">macholib.MachOGraph.</tt><tt class="descname">MachOGraph</tt><big>(</big><em>...</em><big>)</big><a class="headerlink" href="#macholib.MachOGraph.MachOGraph" title="Permalink to this definition"></a></dt>
<dd><p>To be discussed.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="MachO.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.MachO</span></tt> &#8212; Utilities for reading and writing Mach-O headers</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="MachoOStandalone.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.MachOStandalone</span></tt> &#8212; Create standalone application bundles</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/MachoOGraph.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="MachoOStandalone.html" title="macholib.MachOStandalone — Create standalone application bundles"
>next</a> |</li>
<li class="right" >
<a href="MachO.html" title="macholib.MachO — Utilities for reading and writing Mach-O headers"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,125 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.MachOStandalone — Create standalone application bundles &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.SymbolTable — Class to read the symbol table from a Mach-O header" href="SymbolTable.html" />
<link rel="prev" title="macholib.MachoGraph — Graph data structure of Mach-O dependencies" href="MachoOGraph.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="SymbolTable.html" title="macholib.SymbolTable — Class to read the symbol table from a Mach-O header"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="MachoOGraph.html" title="macholib.MachoGraph — Graph data structure of Mach-O dependencies"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.MachOStandalone">
<span id="macholib-machostandalone-create-standalone-application-bundles"></span><h1><a class="reference internal" href="#module-macholib.MachOStandalone" title="macholib.MachOStandalone: Create standalone application bundles"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.MachOStandalone</span></tt></a> &#8212; Create standalone application bundles<a class="headerlink" href="#module-macholib.MachOStandalone" title="Permalink to this headline"></a></h1>
<p>This module defines class <a class="reference internal" href="#macholib.MachOStandalone.MachOStandalone" title="macholib.MachOStandalone.MachOStandalone"><tt class="xref py py-class docutils literal"><span class="pre">MachOStandalone</span></tt></a> 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.</p>
<dl class="class">
<dt id="macholib.MachOStandalone.MachOStandalone">
<em class="property">class </em><tt class="descclassname">macholib.MachOStandalone.</tt><tt class="descname">MachOStandalone</tt><big>(</big><em>base</em><span class="optional">[</span>, <em>dest</em><span class="optional">[</span>, <em>graph</em><span class="optional">[</span>, <em>env</em><span class="optional">[</span>, <em>executable_path</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.MachOStandalone.MachOStandalone" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="MachoOGraph.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.MachoGraph</span></tt> &#8212; Graph data structure of Mach-O dependencies</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="SymbolTable.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.SymbolTable</span></tt> &#8212; Class to read the symbol table from a Mach-O header</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/MachoOStandalone.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="SymbolTable.html" title="macholib.SymbolTable — Class to read the symbol table from a Mach-O header"
>next</a> |</li>
<li class="right" >
<a href="MachoOGraph.html" title="macholib.MachoGraph — Graph data structure of Mach-O dependencies"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,136 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.SymbolTable — Class to read the symbol table from a Mach-O header &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.dyld — Dyld emulation" href="dyld.html" />
<link rel="prev" title="macholib.MachOStandalone — Create standalone application bundles" href="MachoOStandalone.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="dyld.html" title="macholib.dyld — Dyld emulation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="MachoOStandalone.html" title="macholib.MachOStandalone — Create standalone application bundles"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.SymbolTable">
<span id="macholib-symboltable-class-to-read-the-symbol-table-from-a-mach-o-header"></span><h1><a class="reference internal" href="#module-macholib.SymbolTable" title="macholib.SymbolTable: Class to read the symbol table from a Mach-O header"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.SymbolTable</span></tt></a> &#8212; Class to read the symbol table from a Mach-O header<a class="headerlink" href="#module-macholib.SymbolTable" title="Permalink to this headline"></a></h1>
<p>This module is deprecated because it is not by the author
and likely contains bugs. It also does not work for 64-bit binaries.</p>
<dl class="class">
<dt id="macholib.SymbolTable.SymbolTable">
<em class="property">class </em><tt class="descclassname">macholib.SymbolTable.</tt><tt class="descname">SymbolTable</tt><big>(</big><em>macho</em><span class="optional">[</span>, <em>openfile</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.SymbolTable.SymbolTable" title="Permalink to this definition"></a></dt>
<dd><p>Reads the SymbolTable for the given Mach-O object.</p>
<p>The option argument <em>openfile</em> specifies the
function to use to open the file, defaulting to
the builtin <a class="reference external" href="http://docs.python.org/library/functions.html#open" title="(in Python v2.7)"><tt class="xref py py-func docutils literal"><span class="pre">open()</span></tt></a> function.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>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.</p>
<p class="last">The end result of this is that the code does not
support 64-bit code at all and likely doesn&#8217;t work
properly for 32-bit code as well.</p>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="MachoOStandalone.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.MachOStandalone</span></tt> &#8212; Create standalone application bundles</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="dyld.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.dyld</span></tt> &#8212; Dyld emulation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/SymbolTable.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="dyld.html" title="macholib.dyld — Dyld emulation"
>next</a> |</li>
<li class="right" >
<a href="MachoOStandalone.html" title="macholib.MachOStandalone — Create standalone application bundles"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -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

View file

@ -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.

View file

@ -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]]]])

View file

@ -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.

View file

@ -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 <http://pypi.python.org/pypi/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 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)

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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 <http://bitbucket.org/ronaldoussoren/macholib/>`_
* `The issue tracker <http://bitbucket.org/ronaldoussoren/macholib/issues>`_
* `Mac OS X ABI Mach-O File Format Reference at Apple <http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/MachORuntime/Reference/reference.html>`_
Contributors
------------
Macholib was written by Bob Ippolito and is currently maintained by Ronald Oussoren <ronaldoussoren@mac.com>.
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View file

@ -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.

View file

@ -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 <http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/MachORuntime/Reference/reference.html>`_. This document therefore
doesn't explictly document the names in this module.

View file

@ -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.

View file

@ -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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 673 B

View file

@ -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;
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

View file

@ -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() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
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);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.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();
});

Binary file not shown.

After

Width:  |  Height:  |  Size: 368 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 363 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 392 B

File diff suppressed because one or more lines are too long

Binary file not shown.

After

Width:  |  Height:  |  Size: 199 B

View file

@ -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;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 199 B

View file

@ -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 */

View file

@ -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 = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p style="display: none"></p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.deferQuery(query);
},
/**
* execute search (requires search index to be loaded)
*/
query : function(query) {
var i;
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
// stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = query.split(/\s+/);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
objectterms.push(tmp[i].toLowerCase());
}
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
tmp[i] === "") {
// skip this "word"
continue;
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
var toAppend;
// select the correct list
if (word[0] == '-') {
toAppend = excluded;
word = word.substr(1);
}
else {
toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$u.contains(toAppend, word))
toAppend.push(word);
}
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
// console.debug('SEARCH: searching for:');
// console.info('required: ', searchterms);
// console.info('excluded: ', excluded);
// prepare search
var terms = this._index.terms;
var titleterms = this._index.titleterms;
// array of [filename, title, anchor, descr, score]
var results = [];
$('#search-progress').empty();
// lookup as object
for (i = 0; i < objectterms.length; i++) {
var others = [].concat(objectterms.slice(0, i),
objectterms.slice(i+1, objectterms.length));
results = results.concat(this.performObjectSearch(objectterms[i], others));
}
// lookup as search terms in fulltext
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
.concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
for (i = 0; i < results.length; i++)
results[i][4] = Scorer.score(results[i]);
}
// now sort the results by score (in opposite order of appearance, since the
// display function below uses pop() to retrieve items) and then
// alphabetically
results.sort(function(a, b) {
var left = a[4];
var right = b[4];
if (left > right) {
return 1;
} else if (left < right) {
return -1;
} else {
// same score: sort alphabetically
left = a[1].toLowerCase();
right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
}
});
// for debugging
//Search.lastresults = results.slice(); // a copy
//console.info('search results:', Search.lastresults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
} else {
// normal html builders
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
}
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '') {
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
}
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}});
} else {
// no source available, just display title
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
},
/**
* search for object names
*/
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
var i;
var results = [];
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
var score = 0;
var parts = fullname.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullname == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch;
}
var match = objects[prefix][name];
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
if (otherterms.length > 0) {
var haystack = (prefix + ' ' + name + ' ' +
objname + ' ' + title).toLowerCase();
var allfound = true;
for (i = 0; i < otherterms.length; i++) {
if (haystack.indexOf(otherterms[i]) == -1) {
allfound = false;
break;
}
}
if (!allfound) {
continue;
}
}
var descr = objname + _(', in ') + title;
var anchor = match[3];
if (anchor === '')
anchor = fullname;
else if (anchor == '-')
anchor = objnames[match[1]][1] + '-' + fullname;
// add custom score for some objects according to scorer
if (Scorer.objPrio.hasOwnProperty(match[2])) {
score += Scorer.objPrio[match[2]];
} else {
score += Scorer.objPrioDefault;
}
results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]);
}
}
}
return results;
},
/**
* search for full-text terms in the index
*/
performTermsSearch : function(searchterms, excluded, terms, score) {
var filenames = this._index.filenames;
var titles = this._index.titles;
var i, j, file, files;
var fileMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
// no match but word was a required one
if ((files = terms[word]) === undefined)
break;
if (files.length === undefined) {
files = [files];
}
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
if (file in fileMap)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (file in fileMap) {
var valid = true;
// check if all requirements are matched
if (fileMap[file].length != searchterms.length)
continue;
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
$u.contains(terms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it to the result list
if (valid) {
results.push([filenames[file], titles[file], '', null, score]);
}
}
return results;
},
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurance, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
return rv;
}
};
$(document).ready(function() {
Search.init();
});

View file

@ -0,0 +1,31 @@
// Underscore.js 1.3.1
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
// Underscore is freely distributable under the MIT license.
// Portions of Underscore are inspired or borrowed from Prototype,
// Oliver Steele's Functional, and John Resig's Micro-Templating.
// For all details and documentation:
// http://documentcloud.github.com/underscore
(function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck=
function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/"/g,"&quot;").replace(/'/g,"&#x27;").replace(/\//g,"&#x2F;")};b.mixin=function(a){j(b.functions(a),
function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+
u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);

Binary file not shown.

After

Width:  |  Height:  |  Size: 372 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 363 B

View file

@ -0,0 +1,808 @@
/*
* websupport.js
* ~~~~~~~~~~~~~
*
* sphinx.websupport utilties for all documentation.
*
* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
(function($) {
$.fn.autogrow = function() {
return this.each(function() {
var textarea = this;
$.fn.autogrow.resize(textarea);
$(textarea)
.focus(function() {
textarea.interval = setInterval(function() {
$.fn.autogrow.resize(textarea);
}, 500);
})
.blur(function() {
clearInterval(textarea.interval);
});
});
};
$.fn.autogrow.resize = function(textarea) {
var lineHeight = parseInt($(textarea).css('line-height'), 10);
var lines = textarea.value.split('\n');
var columns = textarea.cols;
var lineCount = 0;
$.each(lines, function() {
lineCount += Math.ceil(this.length / columns) || 1;
});
var height = lineHeight * (lineCount + 1);
$(textarea).css('height', height);
};
})(jQuery);
(function($) {
var comp, by;
function init() {
initEvents();
initComparator();
}
function initEvents() {
$('a.comment-close').live("click", function(event) {
event.preventDefault();
hide($(this).attr('id').substring(2));
});
$('a.vote').live("click", function(event) {
event.preventDefault();
handleVote($(this));
});
$('a.reply').live("click", function(event) {
event.preventDefault();
openReply($(this).attr('id').substring(2));
});
$('a.close-reply').live("click", function(event) {
event.preventDefault();
closeReply($(this).attr('id').substring(2));
});
$('a.sort-option').live("click", function(event) {
event.preventDefault();
handleReSort($(this));
});
$('a.show-proposal').live("click", function(event) {
event.preventDefault();
showProposal($(this).attr('id').substring(2));
});
$('a.hide-proposal').live("click", function(event) {
event.preventDefault();
hideProposal($(this).attr('id').substring(2));
});
$('a.show-propose-change').live("click", function(event) {
event.preventDefault();
showProposeChange($(this).attr('id').substring(2));
});
$('a.hide-propose-change').live("click", function(event) {
event.preventDefault();
hideProposeChange($(this).attr('id').substring(2));
});
$('a.accept-comment').live("click", function(event) {
event.preventDefault();
acceptComment($(this).attr('id').substring(2));
});
$('a.delete-comment').live("click", function(event) {
event.preventDefault();
deleteComment($(this).attr('id').substring(2));
});
$('a.comment-markup').live("click", function(event) {
event.preventDefault();
toggleCommentMarkupBox($(this).attr('id').substring(2));
});
}
/**
* Set comp, which is a comparator function used for sorting and
* inserting comments into the list.
*/
function setComparator() {
// If the first three letters are "asc", sort in ascending order
// and remove the prefix.
if (by.substring(0,3) == 'asc') {
var i = by.substring(3);
comp = function(a, b) { return a[i] - b[i]; };
} else {
// Otherwise sort in descending order.
comp = function(a, b) { return b[by] - a[by]; };
}
// Reset link styles and format the selected sort option.
$('a.sel').attr('href', '#').removeClass('sel');
$('a.by' + by).removeAttr('href').addClass('sel');
}
/**
* Create a comp function. If the user has preferences stored in
* the sortBy cookie, use those, otherwise use the default.
*/
function initComparator() {
by = 'rating'; // Default to sort by rating.
// If the sortBy cookie is set, use that instead.
if (document.cookie.length > 0) {
var start = document.cookie.indexOf('sortBy=');
if (start != -1) {
start = start + 7;
var end = document.cookie.indexOf(";", start);
if (end == -1) {
end = document.cookie.length;
by = unescape(document.cookie.substring(start, end));
}
}
}
setComparator();
}
/**
* Show a comment div.
*/
function show(id) {
$('#ao' + id).hide();
$('#ah' + id).show();
var context = $.extend({id: id}, opts);
var popup = $(renderTemplate(popupTemplate, context)).hide();
popup.find('textarea[name="proposal"]').hide();
popup.find('a.by' + by).addClass('sel');
var form = popup.find('#cf' + id);
form.submit(function(event) {
event.preventDefault();
addComment(form);
});
$('#s' + id).after(popup);
popup.slideDown('fast', function() {
getComments(id);
});
}
/**
* Hide a comment div.
*/
function hide(id) {
$('#ah' + id).hide();
$('#ao' + id).show();
var div = $('#sc' + id);
div.slideUp('fast', function() {
div.remove();
});
}
/**
* Perform an ajax request to get comments for a node
* and insert the comments into the comments tree.
*/
function getComments(id) {
$.ajax({
type: 'GET',
url: opts.getCommentsURL,
data: {node: id},
success: function(data, textStatus, request) {
var ul = $('#cl' + id);
var speed = 100;
$('#cf' + id)
.find('textarea[name="proposal"]')
.data('source', data.source);
if (data.comments.length === 0) {
ul.html('<li>No comments yet.</li>');
ul.data('empty', true);
} else {
// If there are comments, sort them and put them in the list.
var comments = sortComments(data.comments);
speed = data.comments.length * 100;
appendComments(comments, ul);
ul.data('empty', false);
}
$('#cn' + id).slideUp(speed + 200);
ul.slideDown(speed);
},
error: function(request, textStatus, error) {
showError('Oops, there was a problem retrieving the comments.');
},
dataType: 'json'
});
}
/**
* Add a comment via ajax and insert the comment into the comment tree.
*/
function addComment(form) {
var node_id = form.find('input[name="node"]').val();
var parent_id = form.find('input[name="parent"]').val();
var text = form.find('textarea[name="comment"]').val();
var proposal = form.find('textarea[name="proposal"]').val();
if (text == '') {
showError('Please enter a comment.');
return;
}
// Disable the form that is being submitted.
form.find('textarea,input').attr('disabled', 'disabled');
// Send the comment to the server.
$.ajax({
type: "POST",
url: opts.addCommentURL,
dataType: 'json',
data: {
node: node_id,
parent: parent_id,
text: text,
proposal: proposal
},
success: function(data, textStatus, error) {
// Reset the form.
if (node_id) {
hideProposeChange(node_id);
}
form.find('textarea')
.val('')
.add(form.find('input'))
.removeAttr('disabled');
var ul = $('#cl' + (node_id || parent_id));
if (ul.data('empty')) {
$(ul).empty();
ul.data('empty', false);
}
insertComment(data.comment);
var ao = $('#ao' + node_id);
ao.find('img').attr({'src': opts.commentBrightImage});
if (node_id) {
// if this was a "root" comment, remove the commenting box
// (the user can get it back by reopening the comment popup)
$('#ca' + node_id).slideUp();
}
},
error: function(request, textStatus, error) {
form.find('textarea,input').removeAttr('disabled');
showError('Oops, there was a problem adding the comment.');
}
});
}
/**
* Recursively append comments to the main comment list and children
* lists, creating the comment tree.
*/
function appendComments(comments, ul) {
$.each(comments, function() {
var div = createCommentDiv(this);
ul.append($(document.createElement('li')).html(div));
appendComments(this.children, div.find('ul.comment-children'));
// To avoid stagnating data, don't store the comments children in data.
this.children = null;
div.data('comment', this);
});
}
/**
* After adding a new comment, it must be inserted in the correct
* location in the comment tree.
*/
function insertComment(comment) {
var div = createCommentDiv(comment);
// To avoid stagnating data, don't store the comments children in data.
comment.children = null;
div.data('comment', comment);
var ul = $('#cl' + (comment.node || comment.parent));
var siblings = getChildren(ul);
var li = $(document.createElement('li'));
li.hide();
// Determine where in the parents children list to insert this comment.
for(i=0; i < siblings.length; i++) {
if (comp(comment, siblings[i]) <= 0) {
$('#cd' + siblings[i].id)
.parent()
.before(li.html(div));
li.slideDown('fast');
return;
}
}
// If we get here, this comment rates lower than all the others,
// or it is the only comment in the list.
ul.append(li.html(div));
li.slideDown('fast');
}
function acceptComment(id) {
$.ajax({
type: 'POST',
url: opts.acceptCommentURL,
data: {id: id},
success: function(data, textStatus, request) {
$('#cm' + id).fadeOut('fast');
$('#cd' + id).removeClass('moderate');
},
error: function(request, textStatus, error) {
showError('Oops, there was a problem accepting the comment.');
}
});
}
function deleteComment(id) {
$.ajax({
type: 'POST',
url: opts.deleteCommentURL,
data: {id: id},
success: function(data, textStatus, request) {
var div = $('#cd' + id);
if (data == 'delete') {
// Moderator mode: remove the comment and all children immediately
div.slideUp('fast', function() {
div.remove();
});
return;
}
// User mode: only mark the comment as deleted
div
.find('span.user-id:first')
.text('[deleted]').end()
.find('div.comment-text:first')
.text('[deleted]').end()
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
.remove();
var comment = div.data('comment');
comment.username = '[deleted]';
comment.text = '[deleted]';
div.data('comment', comment);
},
error: function(request, textStatus, error) {
showError('Oops, there was a problem deleting the comment.');
}
});
}
function showProposal(id) {
$('#sp' + id).hide();
$('#hp' + id).show();
$('#pr' + id).slideDown('fast');
}
function hideProposal(id) {
$('#hp' + id).hide();
$('#sp' + id).show();
$('#pr' + id).slideUp('fast');
}
function showProposeChange(id) {
$('#pc' + id).hide();
$('#hc' + id).show();
var textarea = $('#pt' + id);
textarea.val(textarea.data('source'));
$.fn.autogrow.resize(textarea[0]);
textarea.slideDown('fast');
}
function hideProposeChange(id) {
$('#hc' + id).hide();
$('#pc' + id).show();
var textarea = $('#pt' + id);
textarea.val('').removeAttr('disabled');
textarea.slideUp('fast');
}
function toggleCommentMarkupBox(id) {
$('#mb' + id).toggle();
}
/** Handle when the user clicks on a sort by link. */
function handleReSort(link) {
var classes = link.attr('class').split(/\s+/);
for (var i=0; i<classes.length; i++) {
if (classes[i] != 'sort-option') {
by = classes[i].substring(2);
}
}
setComparator();
// Save/update the sortBy cookie.
var expiration = new Date();
expiration.setDate(expiration.getDate() + 365);
document.cookie= 'sortBy=' + escape(by) +
';expires=' + expiration.toUTCString();
$('ul.comment-ul').each(function(index, ul) {
var comments = getChildren($(ul), true);
comments = sortComments(comments);
appendComments(comments, $(ul).empty());
});
}
/**
* Function to process a vote when a user clicks an arrow.
*/
function handleVote(link) {
if (!opts.voting) {
showError("You'll need to login to vote.");
return;
}
var id = link.attr('id');
if (!id) {
// Didn't click on one of the voting arrows.
return;
}
// If it is an unvote, the new vote value is 0,
// Otherwise it's 1 for an upvote, or -1 for a downvote.
var value = 0;
if (id.charAt(1) != 'u') {
value = id.charAt(0) == 'u' ? 1 : -1;
}
// The data to be sent to the server.
var d = {
comment_id: id.substring(2),
value: value
};
// Swap the vote and unvote links.
link.hide();
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
.show();
// The div the comment is displayed in.
var div = $('div#cd' + d.comment_id);
var data = div.data('comment');
// If this is not an unvote, and the other vote arrow has
// already been pressed, unpress it.
if ((d.value !== 0) && (data.vote === d.value * -1)) {
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
}
// Update the comments rating in the local data.
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
data.vote = d.value;
div.data('comment', data);
// Change the rating text.
div.find('.rating:first')
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
// Send the vote information to the server.
$.ajax({
type: "POST",
url: opts.processVoteURL,
data: d,
error: function(request, textStatus, error) {
showError('Oops, there was a problem casting that vote.');
}
});
}
/**
* Open a reply form used to reply to an existing comment.
*/
function openReply(id) {
// Swap out the reply link for the hide link
$('#rl' + id).hide();
$('#cr' + id).show();
// Add the reply li to the children ul.
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
$('#cl' + id)
.prepend(div)
// Setup the submit handler for the reply form.
.find('#rf' + id)
.submit(function(event) {
event.preventDefault();
addComment($('#rf' + id));
closeReply(id);
})
.find('input[type=button]')
.click(function() {
closeReply(id);
});
div.slideDown('fast', function() {
$('#rf' + id).find('textarea').focus();
});
}
/**
* Close the reply form opened with openReply.
*/
function closeReply(id) {
// Remove the reply div from the DOM.
$('#rd' + id).slideUp('fast', function() {
$(this).remove();
});
// Swap out the hide link for the reply link
$('#cr' + id).hide();
$('#rl' + id).show();
}
/**
* Recursively sort a tree of comments using the comp comparator.
*/
function sortComments(comments) {
comments.sort(comp);
$.each(comments, function() {
this.children = sortComments(this.children);
});
return comments;
}
/**
* Get the children comments from a ul. If recursive is true,
* recursively include childrens' children.
*/
function getChildren(ul, recursive) {
var children = [];
ul.children().children("[id^='cd']")
.each(function() {
var comment = $(this).data('comment');
if (recursive)
comment.children = getChildren($(this).find('#cl' + comment.id), true);
children.push(comment);
});
return children;
}
/** Create a div to display a comment in. */
function createCommentDiv(comment) {
if (!comment.displayed && !opts.moderator) {
return $('<div class="moderate">Thank you! Your comment will show up '
+ 'once it is has been approved by a moderator.</div>');
}
// 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 = '\
<div class="sphinx-comments" id="sc<%id%>">\
<p class="sort-options">\
Sort by:\
<a href="#" class="sort-option byrating">best rated</a>\
<a href="#" class="sort-option byascage">newest</a>\
<a href="#" class="sort-option byage">oldest</a>\
</p>\
<div class="comment-header">Comments</div>\
<div class="comment-loading" id="cn<%id%>">\
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
<ul id="cl<%id%>" class="comment-ul"></ul>\
<div id="ca<%id%>">\
<p class="add-a-comment">Add a comment\
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
<div class="comment-markup-box" id="mb<%id%>">\
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
<tt>``code``</tt>, \
code blocks: <tt>::</tt> and an indented block after blank line</div>\
<form method="post" id="cf<%id%>" class="comment-form" action="">\
<textarea name="comment" cols="80"></textarea>\
<p class="propose-button">\
<a href="#" id="pc<%id%>" class="show-propose-change">\
Propose a change &#9657;\
</a>\
<a href="#" id="hc<%id%>" class="hide-propose-change">\
Propose a change &#9663;\
</a>\
</p>\
<textarea name="proposal" id="pt<%id%>" cols="80"\
spellcheck="false"></textarea>\
<input type="submit" value="Add comment" />\
<input type="hidden" name="node" value="<%id%>" />\
<input type="hidden" name="parent" value="" />\
</form>\
</div>\
</div>';
var commentTemplate = '\
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
<div class="vote">\
<div class="arrow">\
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
<img src="<%upArrow%>" />\
</a>\
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
<img src="<%upArrowPressed%>" />\
</a>\
</div>\
<div class="arrow">\
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
<img src="<%downArrow%>" id="da<%id%>" />\
</a>\
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
<img src="<%downArrowPressed%>" />\
</a>\
</div>\
</div>\
<div class="comment-content">\
<p class="tagline comment">\
<span class="user-id"><%username%></span>\
<span class="rating"><%pretty_rating%></span>\
<span class="delta"><%time.delta%></span>\
</p>\
<div class="comment-text comment"><#text#></div>\
<p class="comment-opts comment">\
<a href="#" class="reply hidden" id="rl<%id%>">reply &#9657;</a>\
<a href="#" class="close-reply" id="cr<%id%>">reply &#9663;</a>\
<a href="#" id="sp<%id%>" class="show-proposal">proposal &#9657;</a>\
<a href="#" id="hp<%id%>" class="hide-proposal">proposal &#9663;</a>\
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
<span id="cm<%id%>" class="moderation hidden">\
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
</span>\
</p>\
<pre class="proposal" id="pr<%id%>">\
<#proposal_diff#>\
</pre>\
<ul class="comment-children" id="cl<%id%>"></ul>\
</div>\
<div class="clearleft"></div>\
</div>\
</div>';
var replyTemplate = '\
<li>\
<div class="reply-div" id="rd<%id%>">\
<form id="rf<%id%>">\
<textarea name="comment" cols="80"></textarea>\
<input type="submit" value="Add reply" />\
<input type="button" value="Cancel" />\
<input type="hidden" name="parent" value="<%id%>" />\
<input type="hidden" name="node" value="" />\
</form>\
</div>\
</li>';
$(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);
}
});

View file

@ -0,0 +1,385 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Release history &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="License" href="license.html" />
<link rel="prev" title="Macholib - Analyze and edit Mach-O headers" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="license.html" title="License"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Macholib - Analyze and edit Mach-O headers"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="release-history">
<h1>Release history<a class="headerlink" href="#release-history" title="Permalink to this headline"></a></h1>
<div class="section" id="macholib-1-7">
<h2>macholib 1.7<a class="headerlink" href="#macholib-1-7" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">Added support for ARM64, LC_ENCRYPTION_INFO_64 and LC_LINKER_OPTION</p>
<p>Patch by Matthias Ringwald.</p>
</li>
<li><p class="first">Load commands now have a &#8220;describe&#8221; method that returns more information
about the command.</p>
<p>Patch by David Dorsey.</p>
</li>
<li><p class="first">The MAGIC value in the header was always represented in the native
byte order, instead of as the value read from the binary.</p>
<p>Patch by David Dorsey.</p>
</li>
<li><p class="first">Added various new constants to &#8220;macholib.mach_o&#8221;.</p>
<p>Patch by David Dorsey.</p>
</li>
</ul>
</div>
<div class="section" id="macholib-1-6-1">
<h2>macholib 1.6.1<a class="headerlink" href="#macholib-1-6-1" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>?</li>
</ul>
</div>
<div class="section" id="macholib-1-6">
<h2>macholib 1.6<a class="headerlink" href="#macholib-1-6" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">Add support for <a class="reference external" href="mailto:'&#37;&#52;&#48;loader_path">'<span>&#64;</span>loader_path</a>&#8216; link command in
macholib.dyld:</p>
<ul class="simple">
<li>Added function <tt class="docutils literal"><span class="pre">macholib.dyld.dyld_loader_search</span></tt></li>
<li>This function is used by <tt class="docutils literal"><span class="pre">macholib.dyld.dyld_find</span></tt>,
and that function now has an new (optional) argument
with the path to the loader.</li>
</ul>
</li>
<li><p class="first">Also add support for <a class="reference external" href="mailto:'&#37;&#52;&#48;loader_path">'<span>&#64;</span>loader_path</a>&#8216; to macholib.MachoGraph,
using the newly added <a class="reference external" href="mailto:'&#37;&#52;&#48;loader_path">'<span>&#64;</span>loader_path</a>&#8216; support in the
dyld module.</p>
<p>Due to this suppport the <em>macho_standalone</em> tool can
now rewrite binaries that contain an <a class="reference external" href="mailto:'&#37;&#52;&#48;loader_path">'<span>&#64;</span>loader_path</a>&#8216; load
command.</p>
</li>
</ul>
</div>
<div class="section" id="macholib-1-5-2">
<h2>macholib 1.5.2<a class="headerlink" href="#macholib-1-5-2" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Issue #93: Show the name of the affected file in the exception message
for Mach-O headers that are too large to relocate.</li>
</ul>
</div>
<div class="section" id="macholib-1-5-1">
<h2>macholib 1.5.1<a class="headerlink" href="#macholib-1-5-1" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>There were no &#8216;classifiers&#8217; in the package metadata due to
a bug in setup.py.</li>
</ul>
</div>
<div class="section" id="macholib-1-5">
<h2>macholib 1.5<a class="headerlink" href="#macholib-1-5" title="Permalink to this headline"></a></h2>
<p>macholib 1.5 is a minor feature release</p>
<ul>
<li><p class="first">No longer use 2to3 to provide Python 3 support</p>
<p>As a side-effect of this macholib no longer supports
Python 2.5 and earlier.</p>
</li>
<li><p class="first">Adds suppport for some new macho load commands</p>
</li>
<li><p class="first">Fix for py3k problem in macho_standalone.py</p>
<p>Patch by Guanqun Lu.</p>
</li>
<li><p class="first">Fix for some issues in macho_dump.py</p>
<p>Patch by Nam Nguyen</p>
</li>
<li><p class="first">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.</p>
</li>
<li><p class="first">Issue #6: Fix for LC_ENCRYPTION_INFO linker commands</p>
</li>
<li><p class="first">Use the mach header information to print the cpu type of a
binary, instead of trying to deduce that from pointer width
and endianness.</p>
<p>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.</p>
</li>
<li><p class="first">The mapping <tt class="docutils literal"><span class="pre">macholib.macho_dump.ARCH_MAP</span></tt> is undocumented
and no longer used by macholib itself. It will be removed
in the next release.</p>
</li>
<li><p class="first">The command-line tools <tt class="docutils literal"><span class="pre">macho_find</span></tt>, <tt class="docutils literal"><span class="pre">macho_dump</span></tt> and
<tt class="docutils literal"><span class="pre">macho_standalone</span></tt> are deprecated. Use &#8220;python -mmacholib&#8221;
instead. That is:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python -mmacholib dump /usr/bin/grep
$ python -mmacholib find ~
$ python -mmacholib standalone myapp.app
</pre></div>
</div>
<p>This makes it clearer which version of the tools are used.</p>
</li>
</ul>
</div>
<div class="section" id="macholib-1-4-3">
<h2>macholib 1.4.3<a class="headerlink" href="#macholib-1-4-3" title="Permalink to this headline"></a></h2>
<p>macholib 1.4.3 is a minor feature release</p>
<ul>
<li><p class="first">Added strings for &#8216;x86_64&#8217; and &#8216;ppc64&#8217; to
macholib.mach_o.CPU_TYPE_NAMES.</p>
</li>
<li><p class="first">macho_find and macho_dump were broken in the 1.4.2 release</p>
</li>
<li><p class="first">added &#8216;macholib.util.NOT_SYSTEM_FILES&#8217;, a list of
files that aren&#8217;t system path&#8217;s even though they are
located in system locations.</p>
<p>Needed to work around a bug in PySide (see issue #32 in the
py2app tracker)</p>
</li>
</ul>
</div>
<div class="section" id="macholib-1-4-2">
<h2>macholib 1.4.2<a class="headerlink" href="#macholib-1-4-2" title="Permalink to this headline"></a></h2>
<p>macholib 1.4.2 is a minor bugfix release</p>
<ul class="simple">
<li>The support for new load commands that was added in 1.4.1
contained a typo that caused problems on OSX 10.7 (Lion).</li>
</ul>
</div>
<div class="section" id="macholib-1-4-1">
<h2>macholib 1.4.1<a class="headerlink" href="#macholib-1-4-1" title="Permalink to this headline"></a></h2>
<p>macholib 1.4.1 is a minor feature release</p>
<p>Features:</p>
<ul class="simple">
<li>Add support for a number of new MachO load commands that were added
during the lifetime of OSX 10.6: <tt class="docutils literal"><span class="pre">LC_LOAD_UPWARD_DYLIB</span></tt>,
<tt class="docutils literal"><span class="pre">LC_VERSION_MIN_MACOSX</span></tt>, <tt class="docutils literal"><span class="pre">LC_VERSION_MIN_IPHONEOS</span></tt> and
<tt class="docutils literal"><span class="pre">LC_FUNCTION_STARTS</span></tt>.</li>
</ul>
</div>
<div class="section" id="macholib-1-4">
<h2>macholib 1.4<a class="headerlink" href="#macholib-1-4" title="Permalink to this headline"></a></h2>
<p>macholib 1.4 is a feature release</p>
<p>Features:</p>
<ul>
<li><p class="first">Documentation is now generated using <a class="reference external" href="http://pypi.python.org/pypi/sphinx">sphinx</a>
and can be viewed at &lt;<a class="reference external" href="http://packages.python.org/macholib">http://packages.python.org/macholib</a>&gt;.</p>
</li>
<li><p class="first">The repository has moved to bitbucket</p>
</li>
<li><p class="first">There now is a testsuite</p>
</li>
<li><p class="first">Private functionality inside modules was renamed to
a name starting with an underscore.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">if this change affects your code you are relying on undefined
implementation features, please stop using private functions.</p>
</div>
</li>
<li><p class="first">The basic packable types in <tt class="docutils literal"><span class="pre">macholib.ptypes</span></tt> 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).</p>
<table border="1" class="docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head"><strong>Old name</strong></th>
<th class="head"><strong>New name</strong></th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>p_byte</td>
<td>p_int8</td>
</tr>
<tr class="row-odd"><td>p_ubyte</td>
<td>p_uint8</td>
</tr>
<tr class="row-even"><td>p_short</td>
<td>p_int16</td>
</tr>
<tr class="row-odd"><td>p_ushort</td>
<td>p_uint16</td>
</tr>
<tr class="row-even"><td>p_int</td>
<td>p_int32</td>
</tr>
<tr class="row-odd"><td>p_uint</td>
<td>p_uint32</td>
</tr>
<tr class="row-even"><td>p_long</td>
<td>p_int32</td>
</tr>
<tr class="row-odd"><td>p_ulong</td>
<td>p_uint32</td>
</tr>
<tr class="row-even"><td>p_longlong</td>
<td>p_int64</td>
</tr>
<tr class="row-odd"><td>p_ulonglong</td>
<td>p_uint64</td>
</tr>
</tbody>
</table>
<p><tt class="docutils literal"><span class="pre">Macholib.ptypes.p_ptr</span></tt> is no longer present as it had an unclear
definition and isn&#8217;t actually used in the codebase.</p>
</li>
</ul>
<p>Bug fixes:</p>
<ul>
<li><p class="first">The semantics of <tt class="docutils literal"><span class="pre">dyld.dyld_default_search</span></tt> were changed a bit,
it now first searches the framework path (if appropriate) and then
the linker path, irrespective of the value of the <tt class="docutils literal"><span class="pre">DYLD_FALLBACK*</span></tt>
environment variables.</p>
<p>Previous versions would change the search order when those variables
was set, which is odd and doesn&#8217;t correspond with the documented
behaviour of the system dyld.</p>
</li>
<li><p class="first">It is once again possible to install using python2.5</p>
</li>
<li><p class="first">The source distribution includes all files, this was broken
due to the switch to mercurial (which confused setuptools)</p>
</li>
</ul>
</div>
<div class="section" id="macholib-1-3">
<h2>macholib 1.3<a class="headerlink" href="#macholib-1-3" title="Permalink to this headline"></a></h2>
<p>macholib 1.3 is a feature release.</p>
<p>Features:</p>
<ul>
<li><p class="first">Experimental Python 3.x support</p>
<p>This version contains lightly tested support for Python 3.</p>
</li>
</ul>
</div>
<div class="section" id="macholib-1-2-2">
<h2>macholib 1.2.2<a class="headerlink" href="#macholib-1-2-2" title="Permalink to this headline"></a></h2>
<p>macholib 1.2.2 is a bugfix release.</p>
<p>Bug fixes:</p>
<ul class="simple">
<li>Macholib should work better with 64-bit code
(patch by Marc-Antoine Parent)</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Release history</a><ul>
<li><a class="reference internal" href="#macholib-1-7">macholib 1.7</a></li>
<li><a class="reference internal" href="#macholib-1-6-1">macholib 1.6.1</a></li>
<li><a class="reference internal" href="#macholib-1-6">macholib 1.6</a></li>
<li><a class="reference internal" href="#macholib-1-5-2">macholib 1.5.2</a></li>
<li><a class="reference internal" href="#macholib-1-5-1">macholib 1.5.1</a></li>
<li><a class="reference internal" href="#macholib-1-5">macholib 1.5</a></li>
<li><a class="reference internal" href="#macholib-1-4-3">macholib 1.4.3</a></li>
<li><a class="reference internal" href="#macholib-1-4-2">macholib 1.4.2</a></li>
<li><a class="reference internal" href="#macholib-1-4-1">macholib 1.4.1</a></li>
<li><a class="reference internal" href="#macholib-1-4">macholib 1.4</a></li>
<li><a class="reference internal" href="#macholib-1-3">macholib 1.3</a></li>
<li><a class="reference internal" href="#macholib-1-2-2">macholib 1.2.2</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Macholib - Analyze and edit Mach-O headers</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="license.html"
title="next chapter">License</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/changelog.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="license.html" title="License"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Macholib - Analyze and edit Mach-O headers"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,267 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.dyld — Dyld emulation &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.dylib — Generic dylib path manipulation" href="dylib.html" />
<link rel="prev" title="macholib.SymbolTable — Class to read the symbol table from a Mach-O header" href="SymbolTable.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="dylib.html" title="macholib.dylib — Generic dylib path manipulation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="SymbolTable.html" title="macholib.SymbolTable — Class to read the symbol table from a Mach-O header"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.dyld">
<span id="macholib-dyld-dyld-emulation"></span><h1><a class="reference internal" href="#module-macholib.dyld" title="macholib.dyld: Emulation of functonality of the dynamic linker"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.dyld</span></tt></a> &#8212; Dyld emulation<a class="headerlink" href="#module-macholib.dyld" title="Permalink to this headline"></a></h1>
<p>This module defines a number of functions that can be used
to emulate the functionality of the dynamic linker (<tt class="docutils literal"><span class="pre">dyld</span></tt>)
w.r.t. looking for library files and framworks.</p>
<dl class="function">
<dt id="macholib.dyld.dyld_image_suffix">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_image_suffix</tt><big>(</big><span class="optional">[</span><em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_image_suffix" title="Permalink to this definition"></a></dt>
<dd><p>Looks up the suffix to append to shared library and
framework names and returns this value when found.
Returns <tt class="docutils literal"><span class="pre">None</span></tt> when no suffix should be appended.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
<p>See the description of <tt class="docutils literal"><span class="pre">DYLD_IMAGE_SUFFIX</span></tt> in the
manual page for dyld(1) for more information.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dydl_framework_path">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dydl_framework_path</tt><big>(</big><span class="optional">[</span><em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dydl_framework_path" title="Permalink to this definition"></a></dt>
<dd><p>Returns a user-specified framework search path,
or an empty list when only the default search path
should be used.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
<p>See the description of <tt class="docutils literal"><span class="pre">DYLD_FRAMEWORK_PATH</span></tt> in the
manual page for dyld(1) for more information.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_library_path">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_library_path</tt><big>(</big><span class="optional">[</span><em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_library_path" title="Permalink to this definition"></a></dt>
<dd><p>Returns a user-specified library search path,
or an empty list when only the default search path
should be used.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
<p>See the description of <tt class="docutils literal"><span class="pre">DYLD_LIBRARY_PATH</span></tt> in the
manual page for dyld(1) for more information.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_fallback_framework_path">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_fallback_framework_path</tt><big>(</big><span class="optional">[</span><em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_fallback_framework_path" title="Permalink to this definition"></a></dt>
<dd><p>Return a user specified list of of directories where
to look for frameworks that aren&#8217;t in their install path,
or an empty list when the default fallback path should
be used.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
<p>See the description of <tt class="docutils literal"><span class="pre">DYLD_FALLBACK_FRAMEWORK_PATH</span></tt> in the
manual page for dyld(1) for more information.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_fallback_library_path">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_fallback_library_path</tt><big>(</big><span class="optional">[</span><em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_fallback_library_path" title="Permalink to this definition"></a></dt>
<dd><p>Return a user specified list of of directories where
to look for libraries that aren&#8217;t in their install path,
or an empty list when the default fallback path should
be used.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
<p>See the description of <tt class="docutils literal"><span class="pre">DYLD_FALLBACK_LIBRARY_PATH</span></tt> in the
manual page for dyld(1) for more information.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_image_suffix_search">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_image_suffix_search</tt><big>(</big><em>iterator</em><span class="optional">[</span>, <em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_image_suffix_search" title="Permalink to this definition"></a></dt>
<dd><p>Yields all items in <em>iterator</em>, and prepents names
with the image suffix to those items when the suffix
is specified.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_override_search">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_override_search</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_override_search" title="Permalink to this definition"></a></dt>
<dd><p>If <em>name</em> is a framework name yield filesystem
paths relative to the entries in the framework
search path.</p>
<p>Always yield the filesystem paths relative to the
entries in the library search path.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_executable_path_search">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_executable_path_search</tt><big>(</big><em>name</em>, <em>executable_path</em><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_executable_path_search" title="Permalink to this definition"></a></dt>
<dd><p>If <em>name</em> is a path starting with <tt class="docutils literal"><span class="pre">&#64;executable_path/</span></tt> yield
the path relative to the specified <em>executable_path</em>.</p>
<p>If <em>executable_path</em> is None nothing is yielded.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_loader_search">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_loader_search</tt><big>(</big><em>name</em>, <em>loader_path</em><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_loader_search" title="Permalink to this definition"></a></dt>
<dd><p>If <em>name</em> is a path starting with <tt class="docutils literal"><span class="pre">&#64;loader_path/</span></tt> yield
the path relative to the specified <em>loader_path</em>.</p>
<p>If <em>loader_path</em> is None nothing is yielded.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_default_search">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_default_search</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>env</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_default_search" title="Permalink to this definition"></a></dt>
<dd><p>Yield the filesystem locations to look for a dynamic
library or framework using the default locations
used by the system dynamic linker.</p>
<p>This function will look in <tt class="docutils literal"><span class="pre">~/Library/Frameworks</span></tt>
for frameworks, even though the system dynamic linker
doesn&#8217;t.</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.dyld_find">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">dyld_find</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>executable_path</em><span class="optional">[</span>, <em>env</em><span class="optional">[</span>, <em>loader</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.dyld_find" title="Permalink to this definition"></a></dt>
<dd><p>Returns the path of the requested dynamic library,
raises <tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt> when the library cannot be found.</p>
<p>This function searches for the library in the same
locations and de system dynamic linker.</p>
<p>The <em>executable_path</em> should be the filesystem path
of the executable to which the library is linked (either
directly or indirectly).</p>
<p>The <em>env</em> argument is a dictionary, which defaults
to <a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a>.</p>
<p>The <em>loader_path</em> argument is an optional filesystem path for
the object file (binary of shared library) that references
<em>name</em>.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.6: </span>Added the <em>loader_path</em> argument.</p>
</div>
</dd></dl>
<dl class="function">
<dt id="macholib.dyld.framework_find">
<tt class="descclassname">macholib.dyld.</tt><tt class="descname">framework_find</tt><big>(</big><em>fn</em><span class="optional">[</span>, <em>executable_path</em><span class="optional">[</span>, <em>env</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.dyld.framework_find" title="Permalink to this definition"></a></dt>
<dd><p>Find a framework using the same semantics as the
system dynamic linker, but will accept looser names
than the system linker.</p>
<p>This function will return a correct result for input
values like:</p>
<ul class="simple">
<li>Python</li>
<li>Python.framework</li>
<li>Python.framework/Versions/Current</li>
</ul>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="SymbolTable.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.SymbolTable</span></tt> &#8212; Class to read the symbol table from a Mach-O header</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="dylib.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.dylib</span></tt> &#8212; Generic dylib path manipulation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/dyld.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="dylib.html" title="macholib.dylib — Generic dylib path manipulation"
>next</a> |</li>
<li class="right" >
<a href="SymbolTable.html" title="macholib.SymbolTable — Class to read the symbol table from a Mach-O header"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,145 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.dylib — Generic dylib path manipulation &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.framework — Generic framework path manipulation" href="framework.html" />
<link rel="prev" title="macholib.dyld — Dyld emulation" href="dyld.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="framework.html" title="macholib.framework — Generic framework path manipulation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dyld.html" title="macholib.dyld — Dyld emulation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.dylib">
<span id="macholib-dylib-generic-dylib-path-manipulation"></span><h1><a class="reference internal" href="#module-macholib.dylib" title="macholib.dylib: Generic dylib path manipulation"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.dylib</span></tt></a> &#8212; Generic dylib path manipulation<a class="headerlink" href="#module-macholib.dylib" title="Permalink to this headline"></a></h1>
<p>This module defines a function <a class="reference internal" href="#macholib.dylib.dylib_info" title="macholib.dylib.dylib_info"><tt class="xref py py-func docutils literal"><span class="pre">dylib_info()</span></tt></a> that can extract
useful information from the name of a dynamic library.</p>
<dl class="function">
<dt id="macholib.dylib.dylib_info">
<tt class="descclassname">macholib.dylib.</tt><tt class="descname">dylib_info</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#macholib.dylib.dylib_info" title="Permalink to this definition"></a></dt>
<dd><p>A dylib name can take one of the following four forms:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">Location/Name.SomeVersion_Suffix.dylib</span></tt></li>
<li><tt class="docutils literal"><span class="pre">Location/Name.SomeVersion.dylib</span></tt></li>
<li><tt class="docutils literal"><span class="pre">Location/Name_Suffix.dylib</span></tt></li>
<li><tt class="docutils literal"><span class="pre">Location/Name.dylib</span></tt></li>
</ul>
<p>Returns None if not found or a mapping equivalent to:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="nb">dict</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="s">&#39;Location&#39;</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="s">&#39;Name.SomeVersion_Suffix.dylib&#39;</span><span class="p">,</span>
<span class="n">shortname</span><span class="o">=</span><span class="s">&#39;Name&#39;</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s">&#39;SomeVersion&#39;</span><span class="p">,</span>
<span class="n">suffix</span><span class="o">=</span><span class="s">&#39;Suffix&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><em>SomeVersion</em> and <em>Suffix</em> are optional and my be <tt class="docutils literal"><span class="pre">None</span></tt>
if not present.</p>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="dyld.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.dyld</span></tt> &#8212; Dyld emulation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="framework.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.framework</span></tt> &#8212; Generic framework path manipulation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/dylib.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="framework.html" title="macholib.framework — Generic framework path manipulation"
>next</a> |</li>
<li class="right" >
<a href="dyld.html" title="macholib.dyld — Dyld emulation"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,147 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.framework — Generic framework path manipulation &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.mach_o — Low-level definitions" href="macho_o.html" />
<link rel="prev" title="macholib.dylib — Generic dylib path manipulation" href="dylib.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="macho_o.html" title="macholib.mach_o — Low-level definitions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dylib.html" title="macholib.dylib — Generic dylib path manipulation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.framework">
<span id="macholib-framework-generic-framework-path-manipulation"></span><h1><a class="reference internal" href="#module-macholib.framework" title="macholib.framework: Generic framework path manipulation"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.framework</span></tt></a> &#8212; Generic framework path manipulation<a class="headerlink" href="#module-macholib.framework" title="Permalink to this headline"></a></h1>
<p>This module defines a function <a class="reference internal" href="#macholib.framework.framework_info" title="macholib.framework.framework_info"><tt class="xref py py-func docutils literal"><span class="pre">framework_info()</span></tt></a> that can extract
useful information from the name of a dynamic library in a framework.</p>
<dl class="function">
<dt id="macholib.framework.framework_info">
<tt class="descclassname">macholib.framework.</tt><tt class="descname">framework_info</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#macholib.framework.framework_info" title="Permalink to this definition"></a></dt>
<dd><blockquote>
<div><p>A framework name can take one of the following four forms:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">Location/Name.framework/Versions/SomeVersion/Name_Suffix</span></tt></li>
<li><tt class="docutils literal"><span class="pre">Location/Name.framework/Versions/SomeVersion/Name</span></tt></li>
<li><tt class="docutils literal"><span class="pre">Location/Name.framework/Name_Suffix</span></tt></li>
<li><tt class="docutils literal"><span class="pre">Location/Name.framework/Name</span></tt></li>
</ul>
<p>Returns <tt class="docutils literal"><span class="pre">None</span></tt> if not found, or a mapping equivalent to:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="nb">dict</span><span class="p">(</span>
<span class="n">location</span><span class="o">=</span><span class="s">&#39;Location&#39;</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="s">&#39;Name.framework/Versions/SomeVersion/Name_Suffix&#39;</span><span class="p">,</span>
<span class="n">shortname</span><span class="o">=</span><span class="s">&#39;Name&#39;</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s">&#39;SomeVersion&#39;</span><span class="p">,</span>
<span class="n">suffix</span><span class="o">=</span><span class="s">&#39;Suffix&#39;</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div></blockquote>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><em>SomeVersion</em> and <em>Suffix</em> are optional and may be None
if not present.</p>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="dylib.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.dylib</span></tt> &#8212; Generic dylib path manipulation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="macho_o.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.mach_o</span></tt> &#8212; Low-level definitions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/framework.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="macho_o.html" title="macholib.mach_o — Low-level definitions"
>next</a> |</li>
<li class="right" >
<a href="dylib.html" title="macholib.dylib — Generic dylib path manipulation"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,365 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#B"><strong>B</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#F"><strong>F</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
</div>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable">BasePackable (class in macholib.ptypes)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable._endian_">BasePackable._endian_ (in module macholib.ptypes)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="dyld.html#macholib.dyld.dydl_framework_path">dydl_framework_path() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_default_search">dyld_default_search() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_executable_path_search">dyld_executable_path_search() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_fallback_framework_path">dyld_fallback_framework_path() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_fallback_library_path">dyld_fallback_library_path() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_find">dyld_find() (in module macholib.dyld)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="dyld.html#macholib.dyld.dyld_image_suffix">dyld_image_suffix() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_image_suffix_search">dyld_image_suffix_search() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_library_path">dyld_library_path() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_loader_search">dyld_loader_search() (in module macholib.dyld)</a>
</dt>
<dt><a href="dyld.html#macholib.dyld.dyld_override_search">dyld_override_search() (in module macholib.dyld)</a>
</dt>
<dt><a href="dylib.html#macholib.dylib.dylib_info">dylib_info() (in module macholib.dylib)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="dyld.html#macholib.dyld.framework_find">framework_find() (in module macholib.dyld)</a>
</dt>
<dt><a href="framework.html#macholib.framework.framework_info">framework_info() (in module macholib.framework)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable.from_fileobj">from_fileobj() (macholib.ptypes.BasePackable method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable.from_mmap">from_mmap() (macholib.ptypes.BasePackable method)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable.from_str">from_str() (macholib.ptypes.BasePackable method)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable.from_tuple">from_tuple() (macholib.ptypes.BasePackable method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="MachO.html#macholib.MachO.MachO">MachO (class in macholib.MachO)</a>
</dt>
<dt><a href="MachoOGraph.html#macholib.MachOGraph.MachOGraph">MachOGraph (class in macholib.MachOGraph)</a>
</dt>
<dt><a href="dyld.html#module-macholib.dyld">macholib.dyld (module)</a>
</dt>
<dt><a href="dylib.html#module-macholib.dylib">macholib.dylib (module)</a>
</dt>
<dt><a href="framework.html#module-macholib.framework">macholib.framework (module)</a>
</dt>
<dt><a href="macho_o.html#module-macholib.mach_o">macholib.mach_o (module)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="MachO.html#module-macholib.MachO">macholib.MachO (module)</a>
</dt>
<dt><a href="MachoOGraph.html#module-macholib.MachOGraph">macholib.MachOGraph (module)</a>
</dt>
<dt><a href="MachoOStandalone.html#module-macholib.MachOStandalone">macholib.MachOStandalone (module)</a>
</dt>
<dt><a href="ptypes.html#module-macholib.ptypes">macholib.ptypes (module)</a>
</dt>
<dt><a href="SymbolTable.html#module-macholib.SymbolTable">macholib.SymbolTable (module)</a>
</dt>
<dt><a href="MachoOStandalone.html#macholib.MachOStandalone.MachOStandalone">MachOStandalone (class in macholib.MachOStandalone)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.p_char">p_char (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_double">p_double (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_float">p_float (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_int16">p_int16 (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_int32">p_int32 (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_int64">p_int64 (class in macholib.ptypes)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.p_int8">p_int8 (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_uint16">p_uint16 (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_uint32">p_uint32 (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_uint64">p_uint64 (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.p_uint8">p_uint8 (class in macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.pypackable">pypackable() (in module macholib.ptypes)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.sizeof">sizeof() (in module macholib.ptypes)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.Structure">Structure (class in macholib.ptypes)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.Structure._fields_">Structure._fields_ (in module macholib.ptypes)</a>
</dt>
<dt><a href="SymbolTable.html#macholib.SymbolTable.SymbolTable">SymbolTable (class in macholib.SymbolTable)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable.to_fileobj">to_fileobj() (macholib.ptypes.BasePackable method)</a>
</dt>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable.to_mmap">to_mmap() (macholib.ptypes.BasePackable method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="ptypes.html#macholib.ptypes.BasePackable.to_str">to_str() (macholib.ptypes.BasePackable method)</a>
</dt>
</dl></td>
</tr></table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,170 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Macholib - Analyze and edit Mach-O headers &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="#" />
<link rel="next" title="Release history" href="changelog.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="changelog.html" title="Release history"
accesskey="N">next</a> |</li>
<li><a href="#">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="macholib-analyze-and-edit-mach-o-headers">
<h1>Macholib - Analyze and edit Mach-O headers<a class="headerlink" href="#macholib-analyze-and-edit-mach-o-headers" title="Permalink to this headline"></a></h1>
<p>macholib can be used to analyze and edit Mach-O headers, the executable
format used by Mac OS X.</p>
<p>It&#8217;s typically used as a dependency analysis tool, and also to rewrite dylib
references in Mach-O headers to be <tt class="docutils literal"><span class="pre">&#64;executable_path</span></tt> relative.</p>
<p>Though this tool targets a platform specific file format, it is pure python
code that is platform and endian independent.</p>
<div class="section" id="general-documentation">
<h2>General documentation<a class="headerlink" href="#general-documentation" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Release history</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="scripts.html">Command-line tools</a></li>
</ul>
</div>
</div>
<div class="section" id="reference-guide">
<h2>Reference Guide<a class="headerlink" href="#reference-guide" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="MachO.html"><tt class="docutils literal"><span class="pre">macholib.MachO</span></tt> &#8212; Utilities for reading and writing Mach-O headers</a></li>
<li class="toctree-l1"><a class="reference internal" href="MachoOGraph.html"><tt class="docutils literal"><span class="pre">macholib.MachoGraph</span></tt> &#8212; Graph data structure of Mach-O dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="MachoOStandalone.html"><tt class="docutils literal"><span class="pre">macholib.MachOStandalone</span></tt> &#8212; Create standalone application bundles</a></li>
<li class="toctree-l1"><a class="reference internal" href="SymbolTable.html"><tt class="docutils literal"><span class="pre">macholib.SymbolTable</span></tt> &#8212; Class to read the symbol table from a Mach-O header</a></li>
<li class="toctree-l1"><a class="reference internal" href="dyld.html"><tt class="docutils literal"><span class="pre">macholib.dyld</span></tt> &#8212; Dyld emulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="dylib.html"><tt class="docutils literal"><span class="pre">macholib.dylib</span></tt> &#8212; Generic dylib path manipulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="framework.html"><tt class="docutils literal"><span class="pre">macholib.framework</span></tt> &#8212; Generic framework path manipulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="macho_o.html"><tt class="docutils literal"><span class="pre">macholib.mach_o</span></tt> &#8212; Low-level definitions</a></li>
<li class="toctree-l1"><a class="reference internal" href="ptypes.html"><tt class="docutils literal"><span class="pre">macholib.ptypes</span></tt> &#8212; Packable types</a></li>
</ul>
</div>
</div>
<div class="section" id="online-resources">
<h2>Online Resources<a class="headerlink" href="#online-resources" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="http://bitbucket.org/ronaldoussoren/macholib/">Sourcecode repository on bitbucket</a></li>
<li><a class="reference external" href="http://bitbucket.org/ronaldoussoren/macholib/issues">The issue tracker</a></li>
<li><a class="reference external" href="http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/MachORuntime/Reference/reference.html">Mac OS X ABI Mach-O File Format Reference at Apple</a></li>
</ul>
</div>
<div class="section" id="contributors">
<h2>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline"></a></h2>
<p>Macholib was written by Bob Ippolito and is currently maintained by Ronald Oussoren &lt;<a class="reference external" href="mailto:ronaldoussoren&#37;&#52;&#48;mac&#46;com">ronaldoussoren<span>&#64;</span>mac<span>&#46;</span>com</a>&gt;.</p>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Macholib - Analyze and edit Mach-O headers</a><ul>
<li><a class="reference internal" href="#general-documentation">General documentation</a></li>
<li><a class="reference internal" href="#reference-guide">Reference Guide</a></li>
<li><a class="reference internal" href="#online-resources">Online Resources</a></li>
<li><a class="reference internal" href="#contributors">Contributors</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="changelog.html"
title="next chapter">Release history</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="changelog.html" title="Release history"
>next</a> |</li>
<li><a href="#">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,140 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>License &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="Command-line tools" href="scripts.html" />
<link rel="prev" title="Release history" href="changelog.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="scripts.html" title="Command-line tools"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="changelog.html" title="Release history"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="license">
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
<p>Copyright (c) Bob Ippolito</p>
<p>Parts are copyright (c) 2010-2014 Ronald Oussoren</p>
<div class="section" id="mit-license">
<h2>MIT License<a class="headerlink" href="#mit-license" title="Permalink to this headline"></a></h2>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the &#8220;Software&#8221;), 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.</p>
<p>THE SOFTWARE IS PROVIDED &#8220;AS IS&#8221;, 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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">License</a><ul>
<li><a class="reference internal" href="#mit-license">MIT License</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="changelog.html"
title="previous chapter">Release history</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="scripts.html"
title="next chapter">Command-line tools</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/license.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="scripts.html" title="Command-line tools"
>next</a> |</li>
<li class="right" >
<a href="changelog.html" title="Release history"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,122 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.mach_o — Low-level definitions &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.ptypes — Packable types" href="ptypes.html" />
<link rel="prev" title="macholib.framework — Generic framework path manipulation" href="framework.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ptypes.html" title="macholib.ptypes — Packable types"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="framework.html" title="macholib.framework — Generic framework path manipulation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.mach_o">
<span id="macholib-mach-o-low-level-definitions"></span><h1><a class="reference internal" href="#module-macholib.mach_o" title="macholib.mach_o: Low-level definitions of elements in a Mach-O file"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.mach_o</span></tt></a> &#8212; Low-level definitions<a class="headerlink" href="#module-macholib.mach_o" title="Permalink to this headline"></a></h1>
<p>This module defines constants and packable structure types
that correspond to elements of a Mach-O file.</p>
<p>The names of classes and constants is the same as those in
the Mach-O header files and
<a class="reference external" href="http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/MachORuntime/Reference/reference.html">Apple&#8217;s documentation</a>. This document therefore
doesn&#8217;t explictly document the names in this module.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="framework.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.framework</span></tt> &#8212; Generic framework path manipulation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ptypes.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.ptypes</span></tt> &#8212; Packable types</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/macho_o.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ptypes.html" title="macholib.ptypes — Packable types"
>next</a> |</li>
<li class="right" >
<a href="framework.html" title="macholib.framework — Generic framework path manipulation"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

Binary file not shown.

View file

@ -0,0 +1,317 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macholib.ptypes — Packable types &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="prev" title="macholib.mach_o — Low-level definitions" href="macho_o.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="macho_o.html" title="macholib.mach_o — Low-level definitions"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-macholib.ptypes">
<span id="macholib-ptypes-packable-types"></span><h1><a class="reference internal" href="#module-macholib.ptypes" title="macholib.ptypes: Serializable types"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.ptypes</span></tt></a> &#8212; Packable types<a class="headerlink" href="#module-macholib.ptypes" title="Permalink to this headline"></a></h1>
<p>The module <a class="reference internal" href="#module-macholib.ptypes" title="macholib.ptypes: Serializable types"><tt class="xref py py-mod docutils literal"><span class="pre">macholib.ptypes</span></tt></a> defines types that can be serialized into
byte arrays, both for basic types and structured types (C <tt class="docutils literal"><span class="pre">struct</span></tt> values).</p>
<div class="section" id="utility-functions">
<h2>Utility functions<a class="headerlink" href="#utility-functions" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="macholib.ptypes.sizeof">
<tt class="descclassname">macholib.ptypes.</tt><tt class="descname">sizeof</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#macholib.ptypes.sizeof" title="Permalink to this definition"></a></dt>
<dd><p>Returns the size in bytes of an object when packed, raises <tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt>
for inappropriate values.</p>
</dd></dl>
<dl class="function">
<dt id="macholib.ptypes.pypackable">
<tt class="descclassname">macholib.ptypes.</tt><tt class="descname">pypackable</tt><big>(</big><em>name</em>, <em>pytype</em>, <em>format</em><big>)</big><a class="headerlink" href="#macholib.ptypes.pypackable" title="Permalink to this definition"></a></dt>
<dd><p>Returns a packable type that is a subclass of the Python type
<em>pytype</em>. The value is converted to and from the packed format using
the struct <em>format</em>.</p>
</dd></dl>
</div>
<div class="section" id="packable-types">
<h2>Packable types<a class="headerlink" href="#packable-types" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="macholib.ptypes.BasePackable">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">BasePackable</tt><a class="headerlink" href="#macholib.ptypes.BasePackable" title="Permalink to this definition"></a></dt>
<dd><p>All packable types are a subclass of <a class="reference internal" href="#macholib.ptypes.BasePackable" title="macholib.ptypes.BasePackable"><tt class="xref py py-class docutils literal"><span class="pre">BasePackable</span></tt></a>, which defines
the basic interface but is itself an abstract base class.</p>
<dl class="data">
<dt id="macholib.ptypes.BasePackable._endian_">
<tt class="descname">_endian_</tt><a class="headerlink" href="#macholib.ptypes.BasePackable._endian_" title="Permalink to this definition"></a></dt>
<dd><p>The byteorder of a packed value. This will be <tt class="docutils literal"><span class="pre">&quot;&lt;&quot;`</span> <span class="pre">for</span>
<span class="pre">little</span> <span class="pre">endian</span> <span class="pre">values</span> <span class="pre">and</span> <span class="pre">``&quot;&gt;&quot;</span></tt> for big-endian ones.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>the endianness option is a public value to be
able to support both big- and little-endian file formats.</p>
<p class="last">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.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="macholib.ptypes.BasePackable.from_mmap">
<tt class="descname">from_mmap</tt><big>(</big><em>mmap</em>, <em>ptr</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#macholib.ptypes.BasePackable.from_mmap" title="Permalink to this definition"></a></dt>
<dd><p>This class method constructs the value from a subview of a
<a class="reference external" href="http://docs.python.org/library/mmap.html#mmap.mmap" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">mmap.mmap</span></tt></a> object. It uses bytes starting at offset <em>ptr</em> and
reads just enough bytes to read the entire object.</p>
</dd></dl>
<dl class="method">
<dt id="macholib.ptypes.BasePackable.from_fileobj">
<tt class="descname">from_fileobj</tt><big>(</big><em>fp</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#macholib.ptypes.BasePackable.from_fileobj" title="Permalink to this definition"></a></dt>
<dd><p>This class method constructs the value by reading just enough bytes
from a file-like object.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The file must be opened in binary mode, that is read calls
should return byte-strings and not unicode-strings.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="macholib.ptypes.BasePackable.from_str">
<tt class="descname">from_str</tt><big>(</big><em>value</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#macholib.ptypes.BasePackable.from_str" title="Permalink to this definition"></a></dt>
<dd><p>This class method construct the value by using the struct module
to parse the given bytes.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">contrary to what the name suggests the argument to this
method is a byte-string, not a unicode-string.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="macholib.ptypes.BasePackable.from_tuple">
<tt class="descname">from_tuple</tt><big>(</big><em>fp</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#macholib.ptypes.BasePackable.from_tuple" title="Permalink to this definition"></a></dt>
<dd><p>This class method constructs the object from a tuple with all fields.</p>
</dd></dl>
<dl class="method">
<dt id="macholib.ptypes.BasePackable.to_str">
<tt class="descname">to_str</tt><big>(</big><big>)</big><a class="headerlink" href="#macholib.ptypes.BasePackable.to_str" title="Permalink to this definition"></a></dt>
<dd><p>Returns a byte representation of the value.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">there is no default implementation for this method</p>
</div>
</dd></dl>
<dl class="method">
<dt id="macholib.ptypes.BasePackable.to_fileobj">
<tt class="descname">to_fileobj</tt><big>(</big><em>fp</em><big>)</big><a class="headerlink" href="#macholib.ptypes.BasePackable.to_fileobj" title="Permalink to this definition"></a></dt>
<dd><p>Write a byte representation of the value to the given file-like
object. The file should be opened in binary mode.</p>
</dd></dl>
<dl class="method">
<dt id="macholib.ptypes.BasePackable.to_mmap">
<tt class="descname">to_mmap</tt><big>(</big><em>mmap</em>, <em>ptr</em><big>)</big><a class="headerlink" href="#macholib.ptypes.BasePackable.to_mmap" title="Permalink to this definition"></a></dt>
<dd><p>Write the byte representation of the value to a <a class="reference external" href="http://docs.python.org/library/mmap.html#mmap.mmap" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">mmap.mmap</span></tt></a>
object, starting at offset <em>ptr</em>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.Structure">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">Structure</tt><big>(</big><em>...</em><big>)</big><a class="headerlink" href="#macholib.ptypes.Structure" title="Permalink to this definition"></a></dt>
<dd><dl class="data">
<dt id="macholib.ptypes.Structure._fields_">
<tt class="descname">_fields_</tt><a class="headerlink" href="#macholib.ptypes.Structure._fields_" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<p>Every subclass of <a class="reference internal" href="#macholib.ptypes.Structure" title="macholib.ptypes.Structure"><tt class="xref py py-class docutils literal"><span class="pre">Structure</span></tt></a> must define <em>_fields_</em> to be
usefull, and the value of <em>_fields_</em> should not be changed after
class construction.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="basic-packables">
<h2>Basic packables<a class="headerlink" href="#basic-packables" title="Permalink to this headline"></a></h2>
<p>Other than the core functionality this module defines a number of
<a class="reference internal" href="#macholib.ptypes.pypackable" title="macholib.ptypes.pypackable"><tt class="xref py py-func docutils literal"><span class="pre">pypackable()</span></tt></a> types that correspond to useful basic C types.</p>
<dl class="class">
<dt id="macholib.ptypes.p_char">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_char</tt><big>(</big><span class="optional">[</span><em>value</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#macholib.ptypes.p_char" title="Permalink to this definition"></a></dt>
<dd><p>A byte string of length 1</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_int8">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_int8</tt><a class="headerlink" href="#macholib.ptypes.p_int8" title="Permalink to this definition"></a></dt>
<dd><p>An 8-bit signed integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_uint8">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_uint8</tt><a class="headerlink" href="#macholib.ptypes.p_uint8" title="Permalink to this definition"></a></dt>
<dd><p>An 8-bit unsigned integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_int16">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_int16</tt><a class="headerlink" href="#macholib.ptypes.p_int16" title="Permalink to this definition"></a></dt>
<dd><p>An 16-bit signed integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_uint16">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_uint16</tt><a class="headerlink" href="#macholib.ptypes.p_uint16" title="Permalink to this definition"></a></dt>
<dd><p>An 16-bit unsigned integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_int32">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_int32</tt><a class="headerlink" href="#macholib.ptypes.p_int32" title="Permalink to this definition"></a></dt>
<dd><p>An 32-bit signed integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_uint32">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_uint32</tt><a class="headerlink" href="#macholib.ptypes.p_uint32" title="Permalink to this definition"></a></dt>
<dd><p>An 32-bit unsigned integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_int64">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_int64</tt><a class="headerlink" href="#macholib.ptypes.p_int64" title="Permalink to this definition"></a></dt>
<dd><p>An 64-bit signed integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_uint64">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_uint64</tt><a class="headerlink" href="#macholib.ptypes.p_uint64" title="Permalink to this definition"></a></dt>
<dd><p>An 64-bit unsigned integer</p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_float">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_float</tt><a class="headerlink" href="#macholib.ptypes.p_float" title="Permalink to this definition"></a></dt>
<dd><p>An floating point value of type <tt class="docutils literal"><span class="pre">float</span></tt></p>
</dd></dl>
<dl class="class">
<dt id="macholib.ptypes.p_double">
<em class="property">class </em><tt class="descclassname">macholib.ptypes.</tt><tt class="descname">p_double</tt><a class="headerlink" href="#macholib.ptypes.p_double" title="Permalink to this definition"></a></dt>
<dd><p>An floating point value of type <tt class="docutils literal"><span class="pre">double</span></tt></p>
</dd></dl>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">the module exports a number of other types with
names starting with <tt class="docutils literal"><span class="pre">p_</span></tt>, such as <tt class="docutils literal"><span class="pre">p_int</span></tt>. Those types
are deprecated and should not be used.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><tt class="docutils literal"><span class="pre">macholib.ptypes</span></tt> &#8212; Packable types</a><ul>
<li><a class="reference internal" href="#utility-functions">Utility functions</a></li>
<li><a class="reference internal" href="#packable-types">Packable types</a></li>
<li><a class="reference internal" href="#basic-packables">Basic packables</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="macho_o.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">macholib.mach_o</span></tt> &#8212; Low-level definitions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/ptypes.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="macho_o.html" title="macholib.mach_o — Low-level definitions"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,154 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Python Module Index &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-m"><strong>m</strong></a>
</div>
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
<tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr>
<tr class="cap" id="cap-m"><td></td><td>
<strong>m</strong></td><td></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<tt class="xref">macholib</tt></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="dyld.html#module-macholib.dyld"><tt class="xref">macholib.dyld</tt></a></td><td>
<em>Emulation of functonality of the dynamic linker</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="dylib.html#module-macholib.dylib"><tt class="xref">macholib.dylib</tt></a></td><td>
<em>Generic dylib path manipulation</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="framework.html#module-macholib.framework"><tt class="xref">macholib.framework</tt></a></td><td>
<em>Generic framework path manipulation</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="macho_o.html#module-macholib.mach_o"><tt class="xref">macholib.mach_o</tt></a></td><td>
<em>Low-level definitions of elements in a Mach-O file</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="MachO.html#module-macholib.MachO"><tt class="xref">macholib.MachO</tt></a></td><td>
<em>Utilities for reading and writing Mach-O headers</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="MachoOGraph.html#module-macholib.MachOGraph"><tt class="xref">macholib.MachOGraph</tt></a></td><td>
<em>Graph data structure of Mach-O dependencies</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="MachoOStandalone.html#module-macholib.MachOStandalone"><tt class="xref">macholib.MachOStandalone</tt></a></td><td>
<em>Create standalone application bundles</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="ptypes.html#module-macholib.ptypes"><tt class="xref">macholib.ptypes</tt></a></td><td>
<em>Serializable types</em></td></tr>
<tr class="cg-1">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
<a href="SymbolTable.html#module-macholib.SymbolTable"><tt class="xref">macholib.SymbolTable</tt></a></td><td>
<em>Class to read the symbol table from a Mach-O header</em></td></tr>
</table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,156 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Command-line tools &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<link rel="next" title="macholib.MachO — Utilities for reading and writing Mach-O headers" href="MachO.html" />
<link rel="prev" title="License" href="license.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="MachO.html" title="macholib.MachO — Utilities for reading and writing Mach-O headers"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="license.html" title="License"
accesskey="P">previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="command-line-tools">
<h1>Command-line tools<a class="headerlink" href="#command-line-tools" title="Permalink to this headline"></a></h1>
<div class="section" id="python-m-macholib-find">
<h2>python -m macholib find<a class="headerlink" href="#python-m-macholib-find" title="Permalink to this headline"></a></h2>
<p>Usage:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python -mmacholib find dir...
</pre></div>
</div>
<p>Print the paths of all MachO binaries
in the specified directories.</p>
</div>
<div class="section" id="python-m-macholib-standalone">
<h2>python -m macholib standalone<a class="headerlink" href="#python-m-macholib-standalone" title="Permalink to this headline"></a></h2>
<p>Usage:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python -m macholib standalone appbundle...
</pre></div>
</div>
<p>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.</p>
</div>
<div class="section" id="python-mmacholib-dump">
<h2>python -mmacholib dump<a class="headerlink" href="#python-mmacholib-dump" title="Permalink to this headline"></a></h2>
<p>Usage:</p>
<div class="highlight-python"><div class="highlight"><pre>$ python -mmacholib dump dir...
</pre></div>
</div>
<p>Prints information about all architectures in a
Mach-O file as well as all libraries it links
to.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Command-line tools</a><ul>
<li><a class="reference internal" href="#python-m-macholib-find">python -m macholib find</a></li>
<li><a class="reference internal" href="#python-m-macholib-standalone">python -m macholib standalone</a></li>
<li><a class="reference internal" href="#python-mmacholib-dump">python -mmacholib dump</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="license.html"
title="previous chapter">License</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="MachO.html"
title="next chapter"><tt class="docutils literal"><span class="pre">macholib.MachO</span></tt> &#8212; Utilities for reading and writing Mach-O headers</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/scripts.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="MachO.html" title="macholib.MachO — Utilities for reading and writing Mach-O headers"
>next</a> |</li>
<li class="right" >
<a href="license.html" title="License"
>previous</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,105 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; macholib 1.7 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="macholib 1.7 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script type="text/javascript" id="searchindexloader"></script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="search-documentation">Search</h1>
<div id="fallback" class="admonition warning">
<script type="text/javascript">$('#fallback').hide();</script>
<p>
Please activate JavaScript to enable the search
functionality.
</p>
</div>
<p>
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.
</p>
<form action="" method="get">
<input type="text" name="q" value="" />
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results">
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">macholib 1.7 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010-2011, Ronald Oussoren.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>

File diff suppressed because one or more lines are too long

View file

@ -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 <http://pypi.python.org/pypi/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 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)

275
python/macholib/doc/conf.py Normal file
View file

@ -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
# "<project> v<release> 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 <link> 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),
}

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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 <http://bitbucket.org/ronaldoussoren/macholib/>`_
* `The issue tracker <http://bitbucket.org/ronaldoussoren/macholib/issues>`_
* `Mac OS X ABI Mach-O File Format Reference at Apple <http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/MachORuntime/Reference/reference.html>`_
Contributors
------------
Macholib was written by Bob Ippolito and is currently maintained by Ronald Oussoren <ronaldoussoren@mac.com>.
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View file

@ -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.

View file

@ -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 <http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/MachORuntime/Reference/reference.html>`_. This document therefore
doesn't explictly document the names in this module.

View file

@ -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.

View file

@ -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.