forked from jeffreykegler/Marpa-web-site
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlibmarpa.html
191 lines (189 loc) · 7.56 KB
/
libmarpa.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
<html>
<head>
<link rel="alternate" title="Ocean of Awareness RSS" type="application/rss+xml" title="RSS" href="http://jeffreykegler.github.com/Ocean-of-Awareness-blog/index.rss" />
<title>
Libmarpa
</title>
<style type="text/css">
strong {font-weight: 700;}
</style>
</head>
<body>
<!-- TITLE -->
<div
style="color:white;background-color:#38B0C0;padding:1em;clear:left;text-align:center;">
<h1>
Libmarpa
</h1>
</div>
<!-- HEADER -->
<div style="margin:0;padding:10px 30px 10px 10px;width:150px;float:left;border-right:2px solid #38B0C0">
<h2>
Libmarpa
</h2>
<h3>Libmarpa Resources</h3>
<p>
<a href="http://jeffreykegler.github.com/Marpa-web-site/libmarpa_api/stable/index.html">
The Libmarpa API document (HTML)</a>.
</p>
<a href="http://jeffreykegler.github.com/Marpa-web-site/libmarpa_api/stable/api_one_page.html">
The Libmarpa API document (one-page HTML)</a>.
</p>
<p>
<a href="https://docs.google.com/file/d/0B9_mR_M2zOc4ZkpJN0RaaGlkckU/edit?usp=sharing">
The Libmarpa API document (PDF)</a>.
<h3>Other Resources</h3>
<p>
<a href="http://www.jeffreykegler.com/">
Jeffrey Kegler's website
</a>
<p>
<a href="https://twitter.com/jeffreykegler" class="twitter-follow-button" data-show-count="false">Follow @jeffreykegler</a>
</p>
<p style="text-align:center">
<!-- Place this code where you want the badge to render. -->
<a href="//plus.google.com/101567692867247957860?prsrc=3" rel="publisher" style="text-decoration:none;">
<img src="//ssl.gstatic.com/images/icons/gplus-32.png" alt="Google+" style="border:0;width:32px;height:32px;"/></a>
</p>
<p>
<a href="http://jeffreykegler.github.com/Marpa-web-site/">
The main web site for Marpa</a>
</p>
<p>
The Ocean of Awareness blog:
<a href="http://jeffreykegler.github.com/Ocean-of-Awareness-blog">
home page</a>,
<a href="http://jeffreykegler.github.com/Ocean-of-Awareness-blog/metapages/chronological.html">
chronological index</a>,
and
<a href="http://jeffreykegler.github.com/Ocean-of-Awareness-blog/metapages/annotated.html">
annotated index</a>.
</p>
<p>Distribution:
<a href="http://search.cpan.org/dist/Marpa-R2/">CPAN</a>
| <a href="https://metacpan.org/module/Marpa::R2">MetaCPAN</a></p>
<p>Mailing List (quite active):
<a href="https://groups.google.com/forum/?hl=en&fromgroups#%21forum/marpa-parser">[email protected]</a>
</p>
<p>
Code repository:
<a href="https://github.com/jeffreykegler/Marpa--R2">
github</a></p>
</div>
<!-- BODY -->
<div style="margin-left:190px;border-left:2px solid #38B0C0;padding:25px;">
<h2>About Libmarpa</h2>
<p>
Libmarpa is the C language library that implements the parse engine
at the core of Marpa.
It is used by
<a href="https://metacpan.org/module/Marpa::R2">
Marpa::R2</a>,
the Perl CPAN module,
but it is completely separate,
and resides in
<a href="https://github.com/jeffreykegler/libmarpa">
its own github repo</a>.
<h2>Installing Libmarpa</h2>
<p>These instructions desribe how to install the separate Libmarpa.
Unless reading Libmarpa is your only interest,
you'll also want to install Marpa::R2.
All of Libmarpa's tests are in Marpa::R2,
and you really do not want to work with
Libmarpa without the ability to test it
on your configuration.
To install Libmarpa:
<ul>
<li>
Clone
<a href="https://github.com/jeffreykegler/libmarpa">
the github repo</a>.
<li>
At the top level, <tt>make dists</tt>.
Be aware that Libmarpa requires a lot of associated software,
including Knuth's literate programming system, Cweb.
All the software is freely available and open-source,
but getting it all together
may be complicated. Sorry.
<li>
This done, there will be three very standard autotools distribution
directory at the top level:
<ul>
<li><tt>dist/</tt>, for building the library itself, and containing the code.
<li><tt>doc_dist/</tt>, for building the documentation,
including a multi-page HTML version of the HTML.
<li><tt>doc1_dist/</tt>,
for building a one-page HTML version of the documentation.
</ul>
Proceed as you would with any other standard autotools distribution directories.
</ul>
<h2>Documentation</h2>
<p>In reading and working with Libmarpa, the following documents will be useful:
<ul>
<li>The Libmarpa API document, which is online in
<a href="http://jeffreykegler.github.com/Marpa-web-site/libmarpa_api/stable/index.html">
HTML</a>,
<a href="http://jeffreykegler.github.com/Marpa-web-site/libmarpa_api/stable/api_one_page.html">
one-page HTML</a>,
and
<a href="https://docs.google.com/file/d/0B9_mR_M2zOc4ZkpJN0RaaGlkckU/edit?usp=sharing">
PDF</a> versions.
<li>
The Marpa theory paper which,
<a href="https://www.academia.edu/10341474/Marpa_A_practical_general_parser_the_recognizer">
The Marpa theory paper</a>,
which has the formal description,
a proof of correctness,
and proofs of my complexity claims.
Pseudo-code for the Marpa parse engine is also included.
<li>
<a href="https://drive.google.com/open?id=0B9_mR_M2zOc4NHVuLWxtSm84V0U&authuser=0">
The code in PDF format</a>, produced via Knuth's Cweb system.
My apologies in advance for this.
Someday it may be a book, as intended by Knuth.
For now, I use the commentary primarily to store extensive notes on the
time and speed complexity,
and on comparisons with alternative implementations.
Some sections also have comments on the actual flow of the code,
but not all.
To have a chance of understanding the code, you'll
want to be familiar with the Libmarpa API,
with Earley's algorithm,
and at least the pseudo-code in the theory paper.
</ul>
<h2>Working on Libmarpa</h2>
<p>
I worked hard to limit the prerequisites needed to
configure, compile and run Libmarpa.
Working on Libmarpa's internals is another matter.
Libmarpa is literate programming --
and work on Libmarpa's internals requires,
among other things,
Knuth's CWeb and therefore Tex.
<p>
Libmarpa is highly mathematical code.
Its internals are, frankly, daunting.
For me, Marpa has a real beauty,
but nobody could claim it achieves that beauty through simplicity.
I once had hopes that reading
Marpa would be like experiencing the effortless
power of a late Picasso.
But Angkor Wat and Hieronymous Bosch show that beauty
comes in many forms.
</div>
<!-- FOOTER -->
<div style="border-top:thick solid #38B0C0;clear:left;padding:1em;">
</div>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-33430331-1");
pageTracker._trackPageview();
} catch(err) {}
</script>
</body>
</html>