-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
302 lines (190 loc) · 13.1 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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Pa_ppx Documentation — Pa_ppx documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="intro.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Pa_ppx
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Built-in PPX Rewriters</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Pa_ppx</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Pa_ppx Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/camlp5/camlp5/blob/master/docindex.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="pa-ppx-documentation">
<h1>Pa_ppx Documentation<a class="headerlink" href="#pa-ppx-documentation" title="Permalink to this headline">¶</a></h1>
<p>This is the documentation for the <a class="reference external" href="https://github.com/chetmurthy/pa_ppx">pa_ppx</a> project, a re-implementation
of many “standard” PPX rewriters, but using <a class="reference external" href="https://github.com/camlp5/camlp5">Camlp5</a> infrastructure.</p>
<p>You can learn more about <code class="docutils literal"><span class="pre">pa_ppx</span></code> at <a class="reference internal" href="intro.html#introduction"><span class="std std-ref">Introduction</span></a> but
quickly, <code class="docutils literal"><span class="pre">pa_ppx</span></code> provides implementations of</p>
<ol class="arabic simple">
<li>all of <code class="docutils literal"><span class="pre">ppx_deriving</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.deriving_plugins.{enum,eq,fold,iter,make,map,ord,show}</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_import</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.import</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_deriving_yojson</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.deriving_plugins.yojson</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_sexp_conv</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.deriving_plugins.sexp</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_inline_test</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.inline_test</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_expect_test</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.expect_test</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_assert</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.assert</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_here</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.here</span></code></li>
<li><code class="docutils literal"><span class="pre">ppx_deriving_protobuf</span></code>: <code class="docutils literal"><span class="pre">pa_ppx.deriving_plugins.protobuf</span></code></li>
</ol>
<p>and a few other experimental PPX rewriters. For many of the
re-implementations, there are extensions beyond what the original
implementation provided (e.g. support everywhere possible, for
extensible variants and exceptions, better type-import suppor). All
of this is built on an infrastructure for writing PPX rewriters, based
on Camlp5.</p>
<div class="section" id="rationale-for-pa-ppx">
<h2>Rationale for <code class="docutils literal"><span class="pre">pa_ppx</span></code><a class="headerlink" href="#rationale-for-pa-ppx" title="Permalink to this headline">¶</a></h2>
<p>One can think of this project as an experiment to prove the following
thesis:</p>
<blockquote>
<div><p>To build an effective and usable macro-preprocessor system for a
language with the rich and complex AST structure of Ocaml, one
needs to provide facilities for manipulating the AST using the
surface syntax, not merely the syntax of data-types in the
language; this requires both <em>patterns</em> and <em>expressions</em> freely
usable in code (for matching and constructing AST fragments) with
placeholders (anti-quotations) of all types, for binding sub-trees
and introducing computed fragments, again of all types that appear
in the AST. Contrast this with the approach of <a class="reference external" href="https://github.com/ocaml-ppx/ppx_tools/blob/master/ppx_metaquot.ml">ppx_metaquot</a>
(project <a class="reference external" href="https://github.com/ocaml-ppx/ppx_tools">ppx_tools</a> )
where anti-quotations are of only a small number of types.</p>
<p>A flexible and <em>transparent</em> mechanism for introducing rewriting
code into the system is also necessary.</p>
<p>In this project, we’re trying to prove this thesis by using
Camlp5: specifically its system of <strong>quotations</strong> and
<strong>antiquotations</strong> for <em>patterns</em> and <em>expressions</em>, as well as
<strong>extensible functions</strong> as the chief mechanism for introducing
new rewriters into the system.</p>
<p>The <em>transparency</em> and <em>comprehensibility</em> of the resulting
examples, is a major point of the exercise. But also, I think
that this approach produces more <em>usable</em> rewriters.</p>
</div></blockquote>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#building-and-installing">Building and Installing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#organization-of-findlib-packages">Organization of Findlib Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#using-pa-ppx-ppx-rewriters">Using <code class="docutils literal"><span class="pre">pa_ppx</span></code> PPX Rewriters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#batch-compilation-with-make">Batch compilation with Make</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#batch-compilation-with-dune">Batch compilation with Dune</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#in-the-toplevel">In the toplevel</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#writing-new-ppx-rewriters-upon-pa-ppx">Writing new PPX Rewriters upon Pa_ppx</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#an-example-ppx-rewriter-based-on-pa-ppx">An Example PPX Rewriter based on Pa_ppx</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#troubleshooting-ppx-rewriter-invocations">Troubleshooting PPX Rewriter Invocations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#debugging-using-not-ocamlfind-preprocess">Debugging using <code class="docutils literal"><span class="pre">not-ocamlfind</span> <span class="pre">preprocess</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#debugging-using-the-ocaml-toplevel">Debugging using the ocaml toplevel</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Built-in PPX Rewriters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="builtins.html#type-decl-related-rewriters-deriving-and-import">Type-Decl-Related Rewriters (<code class="docutils literal"><span class="pre">deriving</span></code> and <code class="docutils literal"><span class="pre">import</span></code>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="builtins.html#test-related-rewriters">Test-Related Rewriters</a></li>
<li class="toctree-l2"><a class="reference internal" href="builtins.html#miscellaneous-standard-rewriters">Miscellaneous Standard Rewriters</a></li>
<li class="toctree-l2"><a class="reference internal" href="builtins.html#useful-pa-ppx-only-rewriters">Useful <code class="docutils literal"><span class="pre">Pa_ppx</span></code>-only Rewriters</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#why-isn-t-this-project-compatible-with-ppxlib-and-other-standard-ppx-rewriter-infrastructure">Why isn’t this project compatible with <code class="docutils literal"><span class="pre">ppxlib</span></code> and other standard PPX rewriter infrastructure?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#why-do-the-packages-for-pa-ppx-have-different-names-than-the-equivalents-from-jane-street-et-al">Why do the packages for <code class="docutils literal"><span class="pre">pa_ppx</span></code> have different names than the equivalents from Jane Street et. al. ?</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Chet Murthy. All rights reserved.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>