work of creating these additional configuration modules.</p>
<dlclass="function">
<dtid="sipconfig.create_config_module">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">create_config_module</tt><big>(</big><em>module</em>, <em>template</em>, <em>content</em><spanclass="optional">[</span>, <em>macros=None</em><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.create_config_module"title="Permalink to this definition">¶</a></dt>
<trclass="field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><em>module</em>– the name of the configuration module file to create.</li>
<li><em>template</em>– the name of the template file.</li>
<li><em>content</em>– a string which replaces every occurence of the pattern
<ttclass="docutils literal"><spanclass="pre">@SIP_CONFIGURATION@</span></tt> in the template file. The content string is
usually created from a Python dictionary using
<atitle="sipconfig.create_content"class="reference internal"href="#sipconfig.create_content"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.create_content()</span></tt></a>. <em>content</em> may also be a
dictionary, in which case <atitle="sipconfig.create_content"class="reference internal"href="#sipconfig.create_content"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.create_content()</span></tt></a> is
automatically called to convert it to a string.</li>
<li><em>macros</em>– an optional dictionary of platform specific build macros. It is only
used if <atitle="sipconfig.create_content"class="reference internal"href="#sipconfig.create_content"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.create_content()</span></tt></a> is called automatically to
convert a <em>content</em> dictionary to a string.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.create_content">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">create_content</tt><big>(</big><em>dict</em><spanclass="optional">[</span>, <em>macros=None</em><spanclass="optional">]</span><big>)</big>→ string<aclass="headerlink"href="#sipconfig.create_content"title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a Python dictionary to a string that can be parsed by the
Python interpreter and converted back to an equivalent dictionary. It is
<li><em>dict</em>– the Python dictionary to convert.</li>
<li><em>macros</em>– the optional dictionary of platform specific build macros.</li>
</ul>
</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the string representation of the dictionary.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.create_wrapper">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">create_wrapper</tt><big>(</big><em>script</em>, <em>wrapper</em><spanclass="optional">[</span>, <em>gui=0</em><spanclass="optional">[</span>, <em>use_arch=''</em><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big>→ string<aclass="headerlink"href="#sipconfig.create_wrapper"title="Permalink to this definition">¶</a></dt>
<dd><p>This creates a platform dependent executable wrapper around a Python
<li><em>script</em>– the full pathname of the script.</li>
<li><em>wrapper</em>– the full pathname of the wrapper to create, excluding any platform
specific extension.</li>
<li><em>gui</em>– is non-zero if a GUI enabled version of the interpreter should be used
on platforms that require it.</li>
<li><em>use_arch</em>– is the MacOS/X architecture to invoke python with.</li>
</ul>
</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the platform specific name of the wrapper.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.error">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">error</tt><big>(</big><em>msg</em><big>)</big><aclass="headerlink"href="#sipconfig.error"title="Permalink to this definition">¶</a></dt>
<dd><p>This displays an error message on <ttclass="docutils literal"><spanclass="pre">stderr</span></tt> and calls <ttclass="docutils literal"><spanclass="pre">sys.exit(1)</span></tt>.</p>
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>msg</em>– the text of the message and should not include any newline characters.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.format">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">format</tt><big>(</big><em>msg</em><spanclass="optional">[</span>, <em>leftmargin=0</em><spanclass="optional">[</span>, <em>rightmargin=78</em><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big>→ string<aclass="headerlink"href="#sipconfig.format"title="Permalink to this definition">¶</a></dt>
<dd><p>This formats a message by inserting newline characters at appropriate
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">inform</tt><big>(</big><em>msg</em><big>)</big><aclass="headerlink"href="#sipconfig.inform"title="Permalink to this definition">¶</a></dt>
<dd><p>This displays an information message on <ttclass="docutils literal"><spanclass="pre">stdout</span></tt>.</p>
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>msg</em>– the text of the message and should not include any newline characters.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.parse_build_macros">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">parse_build_macros</tt><big>(</big><em>filename</em>, <em>names</em><spanclass="optional">[</span>, <em>overrides=None</em><spanclass="optional">[</span>, <em>properties=None</em><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big>→ dict<aclass="headerlink"href="#sipconfig.parse_build_macros"title="Permalink to this definition">¶</a></dt>
<dd><p>This parses a <ttclass="docutils literal"><spanclass="pre">qmake</span></tt> compatible file of build system macros and converts
it to a dictionary. A macro is a name/value pair. Individual macros may
<li><em>filename</em>– the name of the file to parse.</li>
<li><em>names</em>– the list of the macro names to extract from the file.</li>
<li><em>overrides</em>– the optional list of macro names and values that modify those found in
the file. They are of the form <ttclass="docutils literal"><spanclass="pre">name=value</span></tt> (in which case the value
replaces the value found in the file) or <ttclass="docutils literal"><spanclass="pre">name+=value</span></tt> (in which case
the value is appended to the value found in the file).</li>
<li><em>properties</em>– the optional dictionary of property name and values that are used to
resolve any expressions of the form <ttclass="docutils literal"><spanclass="pre">$[name]</span></tt> in the file.</li>
</ul>
</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the dictionary of parsed macros or <ttclass="xref docutils literal"><spanclass="pre">None</span></tt> if any of the overrides
were invalid.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.read_version">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">read_version</tt><big>(</big><em>filename</em>, <em>description</em><spanclass="optional">[</span>, <em>numdefine=None</em><spanclass="optional">[</span>, <em>strdefine=None</em><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big>→ integer, string<aclass="headerlink"href="#sipconfig.read_version"title="Permalink to this definition">¶</a></dt>
<dd><p>This extracts version information for a package from a file, usually a C or
C++ header file. The version information must each be specified as a
<ttclass="docutils literal"><spanclass="pre">#define</span></tt> of a numeric (hexadecimal or decimal) value and/or a string
<li><em>filename</em>– the name of the file to read.</li>
<li><em>description</em>– a descriptive name of the package used in error messages.</li>
<li><em>numdefine</em>– the optional name of the <ttclass="docutils literal"><spanclass="pre">#define</span></tt> of the version as a number. If it
is <ttclass="xref docutils literal"><spanclass="pre">None</span></tt> then the numeric version is ignored.</li>
<li><em>strdefine</em>– the optional name of the <ttclass="docutils literal"><spanclass="pre">#define</span></tt> of the version as a string. If it
is <ttclass="xref docutils literal"><spanclass="pre">None</span></tt> then the string version is ignored.</li>
</ul>
</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">a tuple of the numeric and string versions. <atitle="sipconfig.error"class="reference internal"href="#sipconfig.error"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.error()</span></tt></a>
is called if either were required but could not be found.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.version_to_sip_tag">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">version_to_sip_tag</tt><big>(</big><em>version</em>, <em>tags</em>, <em>description</em><big>)</big>→ string<aclass="headerlink"href="#sipconfig.version_to_sip_tag"title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a version number to a SIP version tag. SIP uses the
<aclass="reference external"href="directives.html#directive-%Timeline"><ttclass="xref docutils literal"><spanclass="pre">%Timeline</span></tt></a> directive to define the chronology of the different
versions of the C/C++ library being wrapped. Typically it is not necessary
to define a version tag for every version of the library, but only for
those versions that affect the library’s API as SIP sees it.</p>
<li><em>version</em>– the numeric version number of the C/C++ library being wrapped. If it
is negative then the latest version is assumed. (This is typically
useful if a snapshot is indicated by a negative version number.)</li>
<li><em>tags</em>– the dictionary of SIP version tags keyed by the corresponding C/C++
library version number. The tag used is the one with the smallest key
(i.e. earliest version) that is greater than <em>version</em>.</li>
<li><em>description</em>– a descriptive name of the C/C++ library used in error messages.</li>
</ul>
</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the SIP version tag. <atitle="sipconfig.error"class="reference internal"href="#sipconfig.error"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.error()</span></tt></a> is called if the C/C++
library version number did not correspond to a SIP version tag.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="sipconfig.version_to_string">
<ttclass="descclassname">sipconfig.</tt><ttclass="descname">version_to_string</tt><big>(</big><em>v</em><big>)</big>→ string<aclass="headerlink"href="#sipconfig.version_to_string"title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a 3 part version number encoded as a hexadecimal value to a
<emclass="property">class </em><ttclass="descclassname">sipconfig.</tt><ttclass="descname">Configuration</tt><aclass="headerlink"href="#sipconfig.Configuration"title="Permalink to this definition">¶</a></dt>
<dd><p>This class encapsulates configuration values that can be accessed as
instance objects. A sub-class may provide a dictionary of additional
configuration values in its constructor the elements of which will have
precedence over the super-class’s values.</p>
<p>The following configuration values are provided:</p>
<dlclass="attribute">
<dtid="sipconfig.Configuration.default_bin_dir">
<ttclass="descname">default_bin_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.default_bin_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the directory where executables should be installed by
default.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.default_mod_dir">
<ttclass="descname">default_mod_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.default_mod_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the directory where SIP generated modules should be
installed by default.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.default_sip_dir">
<ttclass="descname">default_sip_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.default_sip_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the base directory where the <ttclass="docutils literal"><spanclass="pre">.sip</span></tt> files for SIP
generated modules should be installed by default. A sub-directory with
the same name as the module should be created and its <ttclass="docutils literal"><spanclass="pre">.sip</span></tt> files
should be installed in the sub-directory. The <ttclass="docutils literal"><spanclass="pre">.sip</span></tt> files only need
to be installed if you might want to build other bindings based on
them.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.platform">
<ttclass="descname">platform</tt><aclass="headerlink"href="#sipconfig.Configuration.platform"title="Permalink to this definition">¶</a></dt>
<dd>The name of the platform/compiler for which the build system has been
configured for.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.py_conf_inc_dir">
<ttclass="descname">py_conf_inc_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.py_conf_inc_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the directory containing the <ttclass="docutils literal"><spanclass="pre">pyconfig.h</span></tt> header file.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.py_inc_dir">
<ttclass="descname">py_inc_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.py_inc_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the directory containing the <ttclass="docutils literal"><spanclass="pre">Python.h</span></tt> header file.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.py_lib_dir">
<ttclass="descname">py_lib_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.py_lib_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the directory containing the Python interpreter library.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.py_version">
<ttclass="descname">py_version</tt><aclass="headerlink"href="#sipconfig.Configuration.py_version"title="Permalink to this definition">¶</a></dt>
<dd>The Python version as a 3 part hexadecimal number (e.g. v2.3.3 is
represented as <ttclass="docutils literal"><spanclass="pre">0x020303</span></tt>).</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.sip_bin">
<ttclass="descname">sip_bin</tt><aclass="headerlink"href="#sipconfig.Configuration.sip_bin"title="Permalink to this definition">¶</a></dt>
<dd>The full pathname of the SIP executable.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.sip_config_args">
<ttclass="descname">sip_config_args</tt><aclass="headerlink"href="#sipconfig.Configuration.sip_config_args"title="Permalink to this definition">¶</a></dt>
<dd>The command line passed to <ttclass="docutils literal"><spanclass="pre">configure.py</span></tt> when SIP was configured.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.sip_inc_dir">
<ttclass="descname">sip_inc_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.sip_inc_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the directory containing the <ttclass="docutils literal"><spanclass="pre">sip.h</span></tt> header file.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.sip_mod_dir">
<ttclass="descname">sip_mod_dir</tt><aclass="headerlink"href="#sipconfig.Configuration.sip_mod_dir"title="Permalink to this definition">¶</a></dt>
<dd>The name of the directory containing the SIP module.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.sip_version">
<ttclass="descname">sip_version</tt><aclass="headerlink"href="#sipconfig.Configuration.sip_version"title="Permalink to this definition">¶</a></dt>
<dd>The SIP version as a 3 part hexadecimal number (e.g. v4.0.0 is
represented as <ttclass="docutils literal"><spanclass="pre">0x040000</span></tt>).</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.sip_version_str">
<ttclass="descname">sip_version_str</tt><aclass="headerlink"href="#sipconfig.Configuration.sip_version_str"title="Permalink to this definition">¶</a></dt>
<dd>The SIP version as a string. For development snapshots it will start
with <ttclass="docutils literal"><spanclass="pre">snapshot-</span></tt>.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.universal">
<ttclass="descname">universal</tt><aclass="headerlink"href="#sipconfig.Configuration.universal"title="Permalink to this definition">¶</a></dt>
<dd>The name of the MacOS/X SDK used when creating universal binaries.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Configuration.arch">
<ttclass="descname">arch</tt><aclass="headerlink"href="#sipconfig.Configuration.arch"title="Permalink to this definition">¶</a></dt>
<dd>The space separated MacOS/X architectures to build.</dd></dl>
<dlclass="method">
<dtid="sipconfig.Configuration.__init__">
<ttclass="descname">__init__</tt><big>(</big><spanclass="optional">[</span><em>sub_cfg=None</em><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.Configuration.__init__"title="Permalink to this definition">¶</a></dt>
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>sub_cfg</em>– an optional list of sub-class configurations. It should only be
used by the <ttclass="docutils literal"><spanclass="pre">__init__()</span></tt> method of a sub-class to append its own
dictionary of configuration values before passing the list to its
super-class.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Configuration.build_macros">
<ttclass="descname">build_macros</tt><big>(</big><big>)</big>→ dict<aclass="headerlink"href="#sipconfig.Configuration.build_macros"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the dictionary of platform specific build macros.</p>
<ttclass="descname">set_build_macros</tt><big>(</big><em>macros</em><big>)</big><aclass="headerlink"href="#sipconfig.Configuration.set_build_macros"title="Permalink to this definition">¶</a></dt>
<dd><p>Set the dictionary of platform specific build macros to be used when
generating Makefiles. Normally there is no need to change the default
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>macros</em>– the macros dictionary.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="sipconfig.Makefile">
<emclass="property">class </em><ttclass="descclassname">sipconfig.</tt><ttclass="descname">Makefile</tt><aclass="headerlink"href="#sipconfig.Makefile"title="Permalink to this definition">¶</a></dt>
<dd><p>This class encapsulates a Makefile. It is intended to be sub-classed to
generate Makefiles for particular purposes. It handles all platform and
compiler specific flags, but allows them to be adjusted to suit the
requirements of a particular module or program. These are defined using a
number of macros which can be accessed as instance attributes.</p>
<p>The following instance attributes are provided to help in fine tuning the
generated Makefile:</p>
<dlclass="attribute">
<dtid="sipconfig.Makefile.chkdir">
<ttclass="descname">chkdir</tt><aclass="headerlink"href="#sipconfig.Makefile.chkdir"title="Permalink to this definition">¶</a></dt>
<dd>A string that will check for the existence of a directory.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.config">
<ttclass="descname">config</tt><aclass="headerlink"href="#sipconfig.Makefile.config"title="Permalink to this definition">¶</a></dt>
<dd>A reference to the <em>configuration</em> argument that was passed to
<ttclass="descname">copy</tt><aclass="headerlink"href="#sipconfig.Makefile.copy"title="Permalink to this definition">¶</a></dt>
<dd>A string that will copy a file.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.extra_cflags">
<ttclass="descname">extra_cflags</tt><aclass="headerlink"href="#sipconfig.Makefile.extra_cflags"title="Permalink to this definition">¶</a></dt>
<dd>A list of additional flags passed to the C compiler.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.extra_cxxflags">
<ttclass="descname">extra_cxxflags</tt><aclass="headerlink"href="#sipconfig.Makefile.extra_cxxflags"title="Permalink to this definition">¶</a></dt>
<dd>A list of additional flags passed to the C++ compiler.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.extra_defines">
<ttclass="descname">extra_defines</tt><aclass="headerlink"href="#sipconfig.Makefile.extra_defines"title="Permalink to this definition">¶</a></dt>
<dd>A list of additional macro names passed to the C/C++ preprocessor.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.extra_include_dirs">
<ttclass="descname">extra_include_dirs</tt><aclass="headerlink"href="#sipconfig.Makefile.extra_include_dirs"title="Permalink to this definition">¶</a></dt>
<dd>A list of additional include directories passed to the C/C++
preprocessor.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.extra_lflags">
<ttclass="descname">extra_lflags</tt><aclass="headerlink"href="#sipconfig.Makefile.extra_lflags"title="Permalink to this definition">¶</a></dt>
<dd>A list of additional flags passed to the linker.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.extra_lib_dirs">
<ttclass="descname">extra_lib_dirs</tt><aclass="headerlink"href="#sipconfig.Makefile.extra_lib_dirs"title="Permalink to this definition">¶</a></dt>
<dd>A list of additional library directories passed to the linker.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.extra_libs">
<ttclass="descname">extra_libs</tt><aclass="headerlink"href="#sipconfig.Makefile.extra_libs"title="Permalink to this definition">¶</a></dt>
<dd>A list of additional libraries passed to the linker. The names of the
libraries must be in platform neutral form (i.e. without any platform
specific prefixes, version numbers or extensions).</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.generator">
<ttclass="descname">generator</tt><aclass="headerlink"href="#sipconfig.Makefile.generator"title="Permalink to this definition">¶</a></dt>
<dd>A string that defines the platform specific style of Makefile. The
only supported values are <ttclass="docutils literal"><spanclass="pre">UNIX</span></tt>, <ttclass="docutils literal"><spanclass="pre">MSVC</span></tt>, <ttclass="docutils literal"><spanclass="pre">MSVC.NET</span></tt>, <ttclass="docutils literal"><spanclass="pre">MINGW</span></tt>
and <ttclass="docutils literal"><spanclass="pre">BMAKE</span></tt>.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.mkdir">
<ttclass="descname">mkdir</tt><aclass="headerlink"href="#sipconfig.Makefile.mkdir"title="Permalink to this definition">¶</a></dt>
<dd>A string that will create a directory.</dd></dl>
<dlclass="attribute">
<dtid="sipconfig.Makefile.rm">
<ttclass="descname">rm</tt><aclass="headerlink"href="#sipconfig.Makefile.rm"title="Permalink to this definition">¶</a></dt>
<dd>A string that will remove a file.</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.__init__">
<ttclass="descname">__init__</tt><big>(</big><em>configuration</em><spanclass="optional">[</span>, <em>console=0</em><spanclass="optional">[</span>, <em>qt=0</em><spanclass="optional">[</span>, <em>opengl=0</em><spanclass="optional">[</span>, <em>python=0</em><spanclass="optional">[</span>, <em>threaded=0</em><spanclass="optional">[</span>, <em>warnings=None</em><spanclass="optional">[</span>, <em>debug=0</em><spanclass="optional">[</span>, <em>dir=None</em><spanclass="optional">[</span>, <em>makefile="Makefile"</em><spanclass="optional">[</span>, <em>installs=None</em><spanclass="optional">[</span>, <em>universal=None</em><spanclass="optional">[</span>, <em>arch=None</em><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.__init__"title="Permalink to this definition">¶</a></dt>
<trclass="field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><em>configuration</em>– the current configuration and is an instance of the
<atitle="sipconfig.Configuration"class="reference internal"href="#sipconfig.Configuration"><ttclass="xref docutils literal"><spanclass="pre">Configuration</span></tt></a> class or a sub-class.</li>
<li><em>console</em>– is set if the target is a console (rather than GUI) target. This
only affects Windows and is ignored on other platforms.</li>
<ttclass="descname">clean_build_file_objects</tt><big>(</big><em>mfile</em>, <em>build</em><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.clean_build_file_objects"title="Permalink to this definition">¶</a></dt>
<dd><p>This generates the Makefile commands that will remove any files
generated during the build of the default target.</p>
<trclass="field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><em>mfile</em>– the Python file object of the Makefile.</li>
<li><em>build</em>– the dictionary created from parsing the build file.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.finalise">
<ttclass="descname">finalise</tt><big>(</big><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.finalise"title="Permalink to this definition">¶</a></dt>
<dd>This is called just before the Makefile is generated to ensure that it
is fully configured. It must be reimplemented by a sub-class.</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.generate">
<ttclass="descname">generate</tt><big>(</big><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.generate"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.generate_macros_and_rules"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile macros and rules
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>mfile</em>– the Python file object of the Makefile.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.generate_target_clean">
<ttclass="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.generate_target_clean"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile clean target
<ttclass="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.generate_target_default"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile default target
<ttclass="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.generate_target_install"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the default implementation of the Makefile install target
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>mfile</em>– the Python file object of the Makefile.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.install_file">
<ttclass="descname">install_file</tt><big>(</big><em>mfile</em>, <em>src</em>, <em>dst</em><spanclass="optional">[</span>, <em>strip=0</em><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.install_file"title="Permalink to this definition">¶</a></dt>
<dd><p>This generates the Makefile commands to install one or more files to a
<trclass="field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><em>mfile</em>– the Python file object of the Makefile.</li>
<li><em>src</em>– the name of a single file to install or a list of a number of files
to install.</li>
<li><em>dst</em>– the name of the destination directory.</li>
<li><em>strip</em>– is set if the files should be stripped of unneeded symbols after
having been installed.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.optional_list">
<ttclass="descname">optional_list</tt><big>(</big><em>name</em><big>)</big>→ list<aclass="headerlink"href="#sipconfig.Makefile.optional_list"title="Permalink to this definition">¶</a></dt>
<dd><p>This returns an optional Makefile macro as a list.</p>
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>name</em>– the name of the macro.</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body">the macro as a list.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.optional_string">
<ttclass="descname">optional_string</tt><big>(</big><em>name</em><spanclass="optional">[</span>, <em>default=""</em><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.optional_string"title="Permalink to this definition">¶</a></dt>
<dd><p>This returns an optional Makefile macro as a string.</p>
<li><em>name</em>– the name of the macro.</li>
<li><em>default</em>– the optional default value of the macro.</li>
</ul>
</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the macro as a string.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.parse_build_file">
<ttclass="descname">parse_build_file</tt><big>(</big><em>filename</em><big>)</big>→ dict<aclass="headerlink"href="#sipconfig.Makefile.parse_build_file"title="Permalink to this definition">¶</a></dt>
<dd><p>This parses a build file (created with the <aclass="reference external"href="command_line.html#cmdoption-sip-b"><emclass="xref">-b</em></a> SIP
command line option) and converts it to a dictionary. It can also
validate an existing dictionary created through other means.</p>
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>filename</em>– is the name of the build file, or is a dictionary to
be validated. A valid dictionary will contain the name of the
target to build (excluding any platform specific extension) keyed
by <ttclass="docutils literal"><spanclass="pre">target</span></tt>; the names of all source files keyed by <ttclass="docutils literal"><spanclass="pre">sources</span></tt>;
and, optionally, the names of all header files keyed by
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body">a dictionary corresponding to the parsed build file.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.platform_lib">
<ttclass="descname">platform_lib</tt><big>(</big><em>clib</em><spanclass="optional">[</span>, <em>framework=0</em><spanclass="optional">]</span><big>)</big>→ string<aclass="headerlink"href="#sipconfig.Makefile.platform_lib"title="Permalink to this definition">¶</a></dt>
<dd><p>This converts a library name to a platform specific form.</p>
<li><em>clib</em>– the name of the library in cannonical form.</li>
<li><em>framework</em>– is set if the library is implemented as a MacOS framework.</li>
</ul>
</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the platform specific name.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.ready">
<ttclass="descname">ready</tt><big>(</big><big>)</big><aclass="headerlink"href="#sipconfig.Makefile.ready"title="Permalink to this definition">¶</a></dt>
<dd>This is called to ensure that the Makefile is fully configured. It is
normally called automatically when needed.</dd></dl>
<dlclass="method">
<dtid="sipconfig.Makefile.required_string">
<ttclass="descname">required_string</tt><big>(</big><em>name</em><big>)</big>→ string<aclass="headerlink"href="#sipconfig.Makefile.required_string"title="Permalink to this definition">¶</a></dt>
<dd><p>This returns a required Makefile macro as a string.</p>
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>name</em>– the name of the macro.</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body">the macro as a string. An exception is raised if the macro does
not exist or has an empty value.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="sipconfig.ModuleMakefile">
<emclass="property">class </em><ttclass="descclassname">sipconfig.</tt><ttclass="descname">ModuleMakefile</tt><aclass="headerlink"href="#sipconfig.ModuleMakefile"title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <atitle="sipconfig.Makefile"class="reference internal"href="#sipconfig.Makefile"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile to build a generic Python extension
module.</p>
<dlclass="method">
<dtid="sipconfig.ModuleMakefile.__init__">
<ttclass="descname">__init__</tt><big>(</big><em>self</em>, <em>configuration</em>, <em>build_file</em><spanclass="optional">[</span>, <em>install_dir=None</em><spanclass="optional">[</span>, <em>static=0</em><spanclass="optional">[</span>, <em>console=0</em><spanclass="optional">[</span>, <em>opengl=0</em><spanclass="optional">[</span>, <em>threaded=0</em><spanclass="optional">[</span>, <em>warnings=None</em><spanclass="optional">[</span>, <em>debug=0</em><spanclass="optional">[</span>, <em>dir=None</em><spanclass="optional">[</span>, <em>makefile="Makefile"</em><spanclass="optional">[</span>, <em>installs=None</em><spanclass="optional">[</span>, <em>strip=1</em><spanclass="optional">[</span>, <em>export_all=0</em><spanclass="optional">[</span>, <em>universal=None</em><spanclass="optional">[</span>, <em>arch=None</em><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.ModuleMakefile.__init__"title="Permalink to this definition">¶</a></dt>
<trclass="field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><em>configuration</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>build_file</em>– the name of the build file. Build files are generated using the
<aclass="reference external"href="command_line.html#cmdoption-sip-b"><emclass="xref">-b</em></a> SIP command line option.</li>
<li><em>install_dir</em>– the name of the directory where the module will be optionally
installed.</li>
<li><em>static</em>– is set if the module should be built as a static library (see
<aclass="reference external"href="builtin.html#ref-builtin"><em>Builtin Modules and Custom Interpreters</em></a>).</li>
<li><em>console</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>qt</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>opengl</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>threaded</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>warnings</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>debug</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>dir</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>makefile</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>installs</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>strip</em>– is set if the module should be stripped of unneeded symbols after
installation. It is ignored if either <em>debug</em> or <em>static</em> is set,
or if the platform doesn’t support it.</li>
<li><em>export_all</em>– is set if all of the module’s symbols should be exported rather
than just the module’s initialisation function. Exporting all
symbols increases the size of the module and slows down module load
times but may avoid problems with modules that use C++ exceptions.
All symbols are exported if either <em>debug</em> or <em>static</em> is set, or
if the platform doesn’t support it.</li>
<li><em>universal</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>arch</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.ModuleMakefile.finalise">
<ttclass="descname">finalise</tt><big>(</big><big>)</big><aclass="headerlink"href="#sipconfig.ModuleMakefile.finalise"title="Permalink to this definition">¶</a></dt>
<dd>This is a reimplementation of <atitle="sipconfig.Makefile.finalise"class="reference internal"href="#sipconfig.Makefile.finalise"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.finalise()</span></tt></a>.</dd></dl>
<ttclass="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ModuleMakefile.generate_macros_and_rules"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ModuleMakefile.generate_target_clean"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ModuleMakefile.generate_target_default"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ModuleMakefile.generate_target_install"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">module_as_lib</tt><big>(</big><em>mname</em><big>)</big>→ string<aclass="headerlink"href="#sipconfig.ModuleMakefile.module_as_lib"title="Permalink to this definition">¶</a></dt>
<dd><p>This gets the name of a SIP v3.x module for when it is used as a
library to be linked against. An exception will be raised if it is
<emclass="property">class </em><ttclass="descclassname">sipconfig.</tt><ttclass="descname">ParentMakefile</tt><aclass="headerlink"href="#sipconfig.ParentMakefile"title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <atitle="sipconfig.Makefile"class="reference internal"href="#sipconfig.Makefile"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile that sits above a number of other
Makefiles in sub-directories.</p>
<dlclass="method">
<dtid="sipconfig.ParentMakefile.__init__">
<ttclass="descname">__init__</tt><big>(</big><em>self</em>, <em>configuration</em>, <em>subdirs</em><spanclass="optional">[</span>, <em>dir=None</em><spanclass="optional">[</span>, <em>makefile</em><spanclass="optional">[</span>, <em>="Makefile"</em><spanclass="optional">[</span>, <em>installs=None</em><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.ParentMakefile.__init__"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ParentMakefile.generate_macros_and_rules"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ParentMakefile.generate_target_clean"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ParentMakefile.generate_target_default"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ParentMakefile.generate_target_install"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><ttclass="descclassname">sipconfig.</tt><ttclass="descname">ProgramMakefile</tt><aclass="headerlink"href="#sipconfig.ProgramMakefile"title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <atitle="sipconfig.Makefile"class="reference internal"href="#sipconfig.Makefile"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile to build an executable program.</p>
<dlclass="method">
<dtid="sipconfig.ProgramMakefile.__init__">
<ttclass="descname">__init__</tt><big>(</big><em>configuration</em><spanclass="optional">[</span>, <em>build_file=None</em><spanclass="optional">[</span>, <em>install_dir=None</em><spanclass="optional">[</span>, <em>console=0</em><spanclass="optional">[</span>, <em>qt=0</em><spanclass="optional">[</span>, <em>opengl=0</em><spanclass="optional">[</span>, <em>python=0</em><spanclass="optional">[</span>, <em>threaded=0</em><spanclass="optional">[</span>, <em>warnings=None</em><spanclass="optional">[</span>, <em>debug=0</em><spanclass="optional">[</span>, <em>dir=None</em><spanclass="optional">[</span>, <em>makefile="Makefile"</em><spanclass="optional">[</span>, <em>installs=None</em><spanclass="optional">[</span>, <em>universal=None</em><spanclass="optional">[</span>, <em>arch=None</em><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.ProgramMakefile.__init__"title="Permalink to this definition">¶</a></dt>
<trclass="field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><em>configuration</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>build_file</em>– the name of the optional build file. Build files are generated
using the <aclass="reference external"href="command_line.html#cmdoption-sip-b"><emclass="xref">-b</em></a> SIP command line option.</li>
<li><em>install_dir</em>– the name of the directory where the executable program will be
optionally installed.</li>
<li><em>console</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>qt</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>opengl</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>python</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>threaded</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>warnings</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>debug</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>dir</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>makefile</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>installs</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>universal</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>arch</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.ProgramMakefile.build_command">
<ttclass="descname">build_command</tt><big>(</big><em>source</em><big>)</big>→ string, string<aclass="headerlink"href="#sipconfig.ProgramMakefile.build_command"title="Permalink to this definition">¶</a></dt>
<dd><p>This creates a single command line that will create an executable
<trclass="field"><thclass="field-name">Parameter:</th><tdclass="field-body"><em>source</em>– the name of the source file.</td>
</tr>
<trclass="field"><thclass="field-name">Returns:</th><tdclass="field-body">a tuple of the name of the executable that will be created and the
command line.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.ProgramMakefile.finalise">
<ttclass="descname">finalise</tt><big>(</big><big>)</big><aclass="headerlink"href="#sipconfig.ProgramMakefile.finalise"title="Permalink to this definition">¶</a></dt>
<dd>This is a reimplementation of <atitle="sipconfig.Makefile.finalise"class="reference internal"href="#sipconfig.Makefile.finalise"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.finalise()</span></tt></a>.</dd></dl>
<ttclass="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ProgramMakefile.generate_macros_and_rules"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_clean</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ProgramMakefile.generate_target_clean"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_default</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ProgramMakefile.generate_target_default"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.ProgramMakefile.generate_target_install"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><ttclass="descclassname">sipconfig.</tt><ttclass="descname">PythonModuleMakefile</tt><aclass="headerlink"href="#sipconfig.PythonModuleMakefile"title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <atitle="sipconfig.Makefile"class="reference internal"href="#sipconfig.Makefile"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile that installs a pure Python module.</p>
<dlclass="method">
<dtid="sipconfig.PythonModuleMakefile.__init__">
<ttclass="descname">__init__</tt><big>(</big><em>self</em>, <em>configuration</em>, <em>dstdir</em><spanclass="optional">[</span>, <em>srcdir=None</em><spanclass="optional">[</span>, <em>dir=None</em><spanclass="optional">[</span>, <em>makefile="Makefile"</em><spanclass="optional">[</span>, <em>installs=None</em><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><spanclass="optional">]</span><big>)</big><aclass="headerlink"href="#sipconfig.PythonModuleMakefile.__init__"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_macros_and_rules</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.PythonModuleMakefile.generate_macros_and_rules"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">generate_target_install</tt><big>(</big><em>mfile</em><big>)</big><aclass="headerlink"href="#sipconfig.PythonModuleMakefile.generate_target_install"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><ttclass="descclassname">sipconfig.</tt><ttclass="descname">SIPModuleMakefile</tt><aclass="headerlink"href="#sipconfig.SIPModuleMakefile"title="Permalink to this definition">¶</a></dt>
<dd><p>This class is derived from <atitle="sipconfig.ModuleMakefile"class="reference internal"href="#sipconfig.ModuleMakefile"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.ModuleMakefile</span></tt></a>.</p>
<p>This class encapsulates a Makefile to build a SIP generated Python
<trclass="field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><em>configuration</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>build_file</em>– see <atitle="sipconfig.ModuleMakefile.__init__"class="reference internal"href="#sipconfig.ModuleMakefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><em>install_dir</em>– see <atitle="sipconfig.ModuleMakefile.__init__"class="reference internal"href="#sipconfig.ModuleMakefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><em>static</em>– see <atitle="sipconfig.ModuleMakefile.__init__"class="reference internal"href="#sipconfig.ModuleMakefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><em>console</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>qt</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>opengl</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>threaded</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>warnings</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>debug</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>dir</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>makefile</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>installs</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>strip</em>– see <atitle="sipconfig.ModuleMakefile.__init__"class="reference internal"href="#sipconfig.ModuleMakefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><em>export_all</em>– see <atitle="sipconfig.ModuleMakefile.__init__"class="reference internal"href="#sipconfig.ModuleMakefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.ModuleMakefile.__init__()</span></tt></a>.</li>
<li><em>universal</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>arch</em>– see <atitle="sipconfig.Makefile.__init__"class="reference internal"href="#sipconfig.Makefile.__init__"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.__init__()</span></tt></a>.</li>
<li><em>prot_is_public</em>– is set if <ttclass="docutils literal"><spanclass="pre">protected</span></tt> should be redefined as <ttclass="docutils literal"><spanclass="pre">public</span></tt> when
compiling the generated module.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="sipconfig.SIPModuleMakefile.finalise">
<ttclass="descname">finalise</tt><big>(</big><big>)</big><aclass="headerlink"href="#sipconfig.SIPModuleMakefile.finalise"title="Permalink to this definition">¶</a></dt>
<dd>This is a reimplementation of <atitle="sipconfig.Makefile.finalise"class="reference internal"href="#sipconfig.Makefile.finalise"><ttclass="xref docutils literal"><spanclass="pre">sipconfig.Makefile.finalise()</span></tt></a>.</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<divclass="sphinxsidebar">
<divclass="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<pclass="topless"><ahref="python_api.html"
title="previous chapter">Python API for Applications</a></p>
<h4>Next topic</h4>
<pclass="topless"><ahref="distutils.html"
title="next chapter">Building Your Extension with distutils</a></p>
