-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
308 lines (285 loc) · 14.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!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>XDress — xdress 0.4 documentation</title>
<link rel="stylesheet" href="_static/numpy_friendly.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.4',
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/jquery.cookie.js"></script>
<script type="text/javascript" src="_static/cloud.js"></script>
<link rel="top" title="xdress 0.4 documentation" href="#" />
<link rel="next" title="Tutorial" href="tutorial.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"><script type="text/javascript">
var ga_enabled = !$.cookie('disable-ga');
if(ga_enabled){
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-41934829-1']);
_gaq.push(['_setCookiePath', '/']);
_gaq.push(['_setDetectFlash', false]);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
}
</script>
</head>
<body>
<div class="relbar-top">
<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="np-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
accesskey="N">next</a> </li>
<li><a href="#">xdress 0.4 documentation</a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="xdress">
<h1>XDress<a class="headerlink" href="#xdress" title="Permalink to this headline">¶</a></h1>
<p>XDress is an automatic wrapper generator for C/C++ written in pure Python. Currently,
xdress may generate Python bindings (via Cython) for C++ classes & functions
and in-memory wrappers for C++ standard library containers (sets, vectors, maps).
In the future, other tools and bindings will be supported.</p>
<p>The main enabling feature of xdress is a dynamic type system that was designed with
the purpose of API generation in mind.</p>
<p><a class="reference external" href="http://xdress.xyz/latest">Go here for the latest version of the docs!</a></p>
<p><a class="reference internal" href="previous/index.html#previous-versions"><em>Go here for previous versions of the code & documentation.</em></a></p>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="advtut.html">Advanced Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="libclang.html">Using libclang</a></li>
<li class="toctree-l1"><a class="reference internal" href="libref/index.html">Library Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="rcdocs.html">Run Control Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="previous/index.html">Previous Versions</a></li>
<li class="toctree-l1"><a class="reference internal" href="other/index.html">Other Documentation Material</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
</ul>
</div>
<div class="section" id="installation">
<h3>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h3>
<p>Since xdress is pure Python code, the <tt class="docutils literal"><span class="pre">pip</span></tt> or <tt class="docutils literal"><span class="pre">easy_install</span></tt> may be used
to grab and install the code:</p>
<div class="highlight-python"><pre>$ pip install xdress
$ easy_install xdress</pre>
</div>
<p>The source code repository for xdress may be found at the
<a class="reference external" href="http://github.com/xdress/xdress">GitHub project site</a>.
You may simply clone the development branch using git:</p>
<div class="highlight-python"><pre>git clone git://github.com/xdress/xdress.git</pre>
</div>
<p>Also, if you wish to have the optional BASH completion, please add the
following lines to your <tt class="docutils literal"><span class="pre">~/.bashrc</span></tt> file:</p>
<div class="highlight-python"><pre># Enable completion for xdress
eval "$(register-python-argcomplete xdress)"</pre>
</div>
</div>
<div class="section" id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h3>
<p>XDress currently has the following external dependencies,</p>
<p><em>Run Time:</em></p>
<blockquote>
<div><ol class="arabic simple">
<li><a class="reference external" href="http://llvm.org/releases/">Clang/LLVM</a>, optional for C/C++</li>
<li><a class="reference external" href="https://bitbucket.org/eliben/pycparser">pycparser</a>, optional for C</li>
<li><a class="reference external" href="http://www.gccxml.org/HTML/Index.html">GCC-XML</a>, optional for C++</li>
<li><a class="reference external" href="http://www.doxygen.org/">dOxygen</a>, optional for docstrings</li>
<li><a class="reference external" href="http://lxml.de/">lxml</a>, optional (but nice!)</li>
<li><a class="reference external" href="https://argcomplete.readthedocs.org/en/latest/">argcomplete</a>, optional for BASH completion</li>
</ol>
</div></blockquote>
<p><em>Compile Time:</em></p>
<blockquote>
<div><ol class="arabic simple">
<li><a class="reference external" href="http://cython.org/">Cython</a></li>
<li><a class="reference external" href="http://numpy.scipy.org/">NumPy</a></li>
</ol>
</div></blockquote>
<p><em>Test Time:</em></p>
<blockquote>
<div><ol class="arabic simple">
<li><a class="reference external" href="https://nose.readthedocs.org/en/latest/">nose</a></li>
<li><a class="reference external" href="http://www.cmake.org/">CMake</a>, optional for integration tests</li>
</ol>
</div></blockquote>
</div>
<div class="section" id="examples-of-use">
<h3>Examples of Use<a class="headerlink" href="#examples-of-use" title="Permalink to this headline">¶</a></h3>
<p>To see examples of xdress in action (and sample run control files), here are a
few places to look:</p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/xdress/xdress/tree/master/tests/cproj">xdress/tests/cproj</a>:
This is a fully functioning sample C project which uses xdress locally.</li>
<li><a class="reference external" href="https://github.com/xdress/xdress/tree/master/tests/cppproj">xdress/tests/cppproj</a>:
This is a fully functioning sample C++ project which uses xdress locally.</li>
<li><a class="reference external" href="http://pynesim.org/">PyNE</a>: This uses xdress to generate STL container wrappers.</li>
<li><a class="reference external" href="http://bright-dev.github.com/">Bright</a>: This uses xdress to automatically
wrap a suite of interacting C++ class. This was the motivating use case for the
xdress project.</li>
</ul>
</div>
<div class="section" id="testing">
<h3>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3>
<p>XDress has two major test types: unit tests which test library functionality and
integration tests which test the command line tool, the parsers, compilers, etc.
The unit tests are generally fast while the integration are slower. From the
<cite>tests/</cite> directory you may use nose to run the tests together or individually:</p>
<div class="highlight-python"><pre># Go into the tests dir
$ cd tests
# Run just the unit tests
tests $ nosetests -a unit
# Run just the integration tests
tests $ nosetests -a integration
# Run all of the tests together
tests $ nosetests</pre>
</div>
<p>Note that the integration tests require CMake in order to build the sample
projects.</p>
</div>
<div class="section" id="contact-us">
<h3>Contact Us<a class="headerlink" href="#contact-us" title="Permalink to this headline">¶</a></h3>
<p>If you have questions or comments, please sign up for the the mailing list
at <a class="reference external" href="https://groups.google.com/forum/#!forum/xdress">https://groups.google.com/forum/#!forum/xdress</a> and send an email to
<a class="reference external" href="mailto:xdress%40googlegroups.com">xdress<span>@</span>googlegroups<span>.</span>com</a>. Alternatively, please contact the authors directly or
open an issue on GitHub.</p>
</div>
<div class="section" id="contributing">
<h3>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h3>
<p>We highly encourage contributions to xdress! If you would like to contribute,
it is as easy as forking the repository on GitHub, making your changes, and
issuing a pull request. If you have any questions about this process don’t
hesitate to ask the mailing list (<a class="reference external" href="mailto:xdress%40googlegroups.com">xdress<span>@</span>googlegroups<span>.</span>com</a>).</p>
</div>
<div class="section" id="helpful-links">
<h3>Helpful Links<a class="headerlink" href="#helpful-links" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><a class="reference external" href="http://xdress.xyz">Documentation</a></li>
<li><a class="reference external" href="https://groups.google.com/forum/#!forum/xdress">Mailing list website</a></li>
<li><a class="reference external" href="mailto:xdress%40googlegroups.com">Mailing list address</a></li>
<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>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="_static/HooverJoven.jpg" alt="Logo"/>
</a></p>
<div class="sphinxlocaltoc">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">XDress</a><ul>
<li><a class="reference internal" href="#contents">Contents</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#examples-of-use">Examples of Use</a></li>
<li><a class="reference internal" href="#testing">Testing</a></li>
<li><a class="reference internal" href="#contact-us">Contact Us</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a></li>
<li><a class="reference internal" href="#helpful-links">Helpful Links</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<h4>Next topic</h4>
<p class="topless"><a href="tutorial.html"
title="next chapter">Tutorial</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="relbar-bottom">
<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="np-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
>next</a> </li>
<li><a href="#">xdress 0.4 documentation</a> »</li>
</ul>
</div>
</div>
<div class="footer">
© Copyright 2013, Anthony Scopatz.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div><script type="text/javascript">
if(ga_enabled){
document.write("<div class=\"footer\">This page uses <a href=\"http://analytics.google.com\">Google Analytics</a> to collect statistics. ");
document.write("Click <button title=\"set cookie to disable analytics for this site\" class=\"link\" onclick=\"$.cookie('disable-ga', 'true', {expires: 3650, path: '/'}); window.location.reload(); return false; \">here</button> to disable analytics for this site.");
document.write("</div>");
}else{
document.write("<div class=\"footer\">Google Analytics has been disabled. ");
document.write("Click <button title=\"set cookie to re-enable analytics for this site\" class=\"link\" onclick=\"$.cookie('disable-ga', null, {path: '/'}); window.location.reload(); return false; \">here</button> to re-enable analytics for this site.");
};
</script>
<!-- cloud_sptheme 1.4 -->
</body>
</html>