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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<title>Nine Nines: Xerl: two modules</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=7" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li class="active"><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents">
<div class="container">
<div class="row">
<div class="span9 maincol">
<article class="blog_item">
<header>
<h1 class="lined-header"><span>Xerl: two modules</span></h1>
<p class="date">
<span class="year">2013</span>
<span class="day-month">03 Feb</span>
</p>
</header>
<p>Everything is an expression.</p>
<p>This sentence carries profound meaning. We will invoke it many times over the course of these articles.</p>
<p>If everything is an expression, then the language shouldn't have any problem with me defining two modules in the same source file.</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><font color="#FF6600">mod</font> <font color="#FF6600">first_module</font>
<b><font color="#0000FF">begin</font></b>
<b><font color="#0000FF">end</font></b>
<font color="#FF6600">mod</font> <font color="#FF6600">second_module</font>
<b><font color="#0000FF">begin</font></b>
<b><font color="#0000FF">end</font></b></tt></pre>
</div></div>
<p>Likewise, it shouldn't have any problem with me defining a module inside another module.</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><font color="#FF6600">mod</font> <font color="#FF6600">out_module</font>
<b><font color="#0000FF">begin</font></b>
<font color="#FF6600">mod</font> <font color="#FF6600">in_module</font>
<b><font color="#0000FF">begin</font></b>
<b><font color="#0000FF">end</font></b>
<b><font color="#0000FF">end</font></b></tt></pre>
</div></div>
<p>Of course, in the context of the Erlang VM, these two snippets are equivalent; there is nothing preventing you from calling the <code>in_module</code> module from any other module. The <code>mod</code> instruction means a module should be created in the Erlang VM, with no concept of scope attached.</p>
<p>Still we need to handle both. To do this we will add a step between the parser and the code generator that will walk over the abstract syntax tree, from here onward shortened as <em>AST</em>, and transform the AST by executing it where applicable.</p>
<p>What happens when you execute a <code>mod</code> instruction? A module is created. Since we are compiling, that simply means the compiler will branch out and create a module.</p>
<p>If everything is an expression, does that mean this will allow me to create modules at runtime using the same syntax? Yes, but let's not get ahead of ourselves yet.</p>
<p>For now we will just iterate over the AST, and will compile a module for each <code>mod</code> found. Modules cannot contain expressions yet, so there's no need to recurse over it at this point. This should solve the compilation of our first snippet.</p>
<p>The <code>compile/1</code> function becomes:</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">compile</font></b>(<font color="#009900">Filename</font>) <font color="#990000">-></font>
<b><font color="#000000">io:format</font></b>(<font color="#FF0000">"Compiling ~s...~n"</font>, [<font color="#009900">Filename</font>]),
{<font color="#FF6600">ok</font>, <font color="#009900">Src</font>} <font color="#990000">=</font> <b><font color="#000000">file:read_file</font></b>(<font color="#009900">Filename</font>),
{<font color="#FF6600">ok</font>, <font color="#009900">Tokens</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">xerl_lexer:string</font></b>(<b><font color="#000080">binary_to_list</font></b>(<font color="#009900">Src</font>)),
{<font color="#FF6600">ok</font>, <font color="#009900">Exprs</font>} <font color="#990000">=</font> <b><font color="#000000">xerl_parser:parse</font></b>(<font color="#009900">Tokens</font>),
<b><font color="#000000">execute</font></b>(<font color="#009900">Filename</font>, <font color="#009900">Exprs</font>, [])<font color="#990000">.</font>
<b><font color="#000000">execute</font></b>(<font color="#990000">_</font>, [], <font color="#009900">Modules</font>) <font color="#990000">-></font>
<b><font color="#000000">io:format</font></b>(<font color="#FF0000">"Done...~n"</font>),
{<font color="#FF6600">ok</font>, <b><font color="#000000">lists:reverse</font></b>(<font color="#009900">Modules</font>)};
<b><font color="#000000">execute</font></b>(<font color="#009900">Filename</font>, [<font color="#009900">Expr</font> <font color="#990000">=</font> {<font color="#FF6600">mod</font>, <font color="#990000">_</font>, {<b><font color="#000080">atom</font></b>, <font color="#990000">_</font>, <font color="#009900">Name</font>}, []}|<font color="#009900">Tail</font>], <font color="#009900">Modules</font>) <font color="#990000">-></font>
{<font color="#FF6600">ok</font>, [<font color="#009900">Core</font>]} <font color="#990000">=</font> <b><font color="#000000">xerl_codegen:exprs</font></b>([<font color="#009900">Expr</font>]),
{<font color="#FF6600">ok</font>, [{<font color="#009900">Name</font>, []}]} <font color="#990000">=</font> <b><font color="#000000">core_lint:module</font></b>(<font color="#009900">Core</font>),
<b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<b><font color="#000000">core_pp:format</font></b>(<font color="#009900">Core</font>)]),
{<font color="#FF6600">ok</font>, <font color="#990000">_</font>, <font color="#009900">Beam</font>} <font color="#990000">=</font> <b><font color="#000000">compile:forms</font></b>(<font color="#009900">Core</font>,
[<b><font color="#000080">binary</font></b>, <font color="#FF6600">from_core</font>, <font color="#FF6600">return_errors</font>, {<font color="#FF6600">source</font>, <font color="#009900">Filename</font>}]),
{<font color="#FF6600">module</font>, <font color="#009900">Name</font>} <font color="#990000">=</font> <b><font color="#000000">code:load_binary</font></b>(<font color="#009900">Name</font>, <font color="#009900">Filename</font>, <font color="#009900">Beam</font>),
<b><font color="#000000">execute</font></b>(<font color="#009900">Filename</font>, <font color="#009900">Tail</font>, [<font color="#009900">Name</font>|<font color="#009900">Modules</font>])<font color="#990000">.</font></tt></pre>
</div></div>
<p>Running this compiler over the first snippet yields the following result:</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><font color="#009900">Compiling</font> <b><font color="#000000">test</font></b><font color="#990000">/</font><b><font color="#000000">mod_SUITE_data</font></b><font color="#990000">/</font><font color="#FF6600">two_modules</font><font color="#990000">.</font><font color="#FF6600">xerl</font><font color="#990000">...</font>
<font color="#FF6600">module</font> <font color="#FF6600">'first_module'</font> [<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">0</font>,
<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">1</font>]
<font color="#FF6600">attributes</font> []
<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">0</font> <font color="#990000">=</font>
<b><font color="#0000FF">fun</font></b> () <font color="#990000">-></font>
<b><font color="#000080">call</font></b> <font color="#FF6600">'erlang'</font><font color="#990000">:</font><font color="#FF6600">'get_module_info'</font>
(<font color="#FF6600">'first_module'</font>)
<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">1</font> <font color="#990000">=</font>
<b><font color="#0000FF">fun</font></b> (<font color="#009900">Key</font>) <font color="#990000">-></font>
<b><font color="#000080">call</font></b> <font color="#FF6600">'erlang'</font><font color="#990000">:</font><font color="#FF6600">'get_module_info'</font>
(<font color="#FF6600">'first_module'</font>, <font color="#009900">Key</font>)
<b><font color="#0000FF">end</font></b>
<font color="#FF6600">module</font> <font color="#FF6600">'second_module'</font> [<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">0</font>,
<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">1</font>]
<font color="#FF6600">attributes</font> []
<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">0</font> <font color="#990000">=</font>
<b><font color="#0000FF">fun</font></b> () <font color="#990000">-></font>
<b><font color="#000080">call</font></b> <font color="#FF6600">'erlang'</font><font color="#990000">:</font><font color="#FF6600">'get_module_info'</font>
(<font color="#FF6600">'second_module'</font>)
<font color="#FF6600">'module_info'</font><font color="#990000">/</font><font color="#993399">1</font> <font color="#990000">=</font>
<b><font color="#0000FF">fun</font></b> (<font color="#009900">Key</font>) <font color="#990000">-></font>
<b><font color="#000080">call</font></b> <font color="#FF6600">'erlang'</font><font color="#990000">:</font><font color="#FF6600">'get_module_info'</font>
(<font color="#FF6600">'second_module'</font>, <font color="#009900">Key</font>)
<b><font color="#0000FF">end</font></b>
<font color="#009900">Done</font><font color="#990000">...</font>
{<font color="#FF6600">ok</font>,[<font color="#FF6600">first_module</font>,<font color="#FF6600">second_module</font>]}</tt></pre>
</div></div>
<p>Everything looks fine. And we can check that the two modules have been loaded into the VM:</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><font color="#993399">9</font><font color="#990000">></font> <font color="#FF6600">m</font>(<font color="#FF6600">first_module</font>)<font color="#990000">.</font>
<font color="#009900">Module</font> <font color="#FF6600">first_module</font> <font color="#FF6600">compiled</font><font color="#990000">:</font> <font color="#009900">Date</font><font color="#990000">:</font> <font color="#009900">February</font> <font color="#993399">2</font> <font color="#993399">2013</font>, <font color="#009900">Time</font><font color="#990000">:</font> <font color="#993399">14.56</font>
<font color="#009900">Compiler</font> <font color="#FF6600">options</font><font color="#990000">:</font> [<font color="#FF6600">from_core</font>]
<font color="#009900">Object</font> <b><font color="#000000">file: test</font></b><font color="#990000">/</font><b><font color="#000000">mod_SUITE_data</font></b><font color="#990000">/</font><font color="#FF6600">two_modules</font><font color="#990000">.</font><font color="#FF6600">xerl</font>
<font color="#009900">Exports</font><font color="#990000">:</font>
<b><font color="#000080">module_info</font></b><font color="#990000">/</font><font color="#993399">0</font>
<b><font color="#000080">module_info</font></b><font color="#990000">/</font><font color="#993399">1</font>
<font color="#FF6600">ok</font>
<font color="#993399">10</font><font color="#990000">></font> <font color="#FF6600">m</font>(<font color="#FF6600">second_module</font>)<font color="#990000">.</font>
<font color="#009900">Module</font> <font color="#FF6600">second_module</font> <font color="#FF6600">compiled</font><font color="#990000">:</font> <font color="#009900">Date</font><font color="#990000">:</font> <font color="#009900">February</font> <font color="#993399">2</font> <font color="#993399">2013</font>, <font color="#009900">Time</font><font color="#990000">:</font> <font color="#993399">14.56</font>
<font color="#009900">Compiler</font> <font color="#FF6600">options</font><font color="#990000">:</font> [<font color="#FF6600">from_core</font>]
<font color="#009900">Object</font> <b><font color="#000000">file: test</font></b><font color="#990000">/</font><b><font color="#000000">mod_SUITE_data</font></b><font color="#990000">/</font><font color="#FF6600">two_modules</font><font color="#990000">.</font><font color="#FF6600">xerl</font>
<font color="#009900">Exports</font><font color="#990000">:</font>
<b><font color="#000080">module_info</font></b><font color="#990000">/</font><font color="#993399">0</font>
<b><font color="#000080">module_info</font></b><font color="#990000">/</font><font color="#993399">1</font>
<font color="#FF6600">ok</font></tt></pre>
</div></div>
<p>So far so good!</p>
<p>What about the second snippet? It brings up many questions. What happens once a <code>mod</code> expression has been executed at compile time? If it's an expression then it has to have a result, right? Right. We are still a bit lacking with expressions for now, though, so let's get back to it after we add more.</p>
<ul><li><a href="https://github.com/extend/xerl/blob/0.2/">View the source</a>
</li>
</ul>
</article>
</div>
<div class="span3 sidecol">
<h3>More articles</h3>
<ul id="articles-nav" class="extra_margin">
<li><a href="https://ninenines.eu/articles/merry-christmas-2019/">Merry Christmas 2019: New Beginnings</a></li>
<li><a href="https://ninenines.eu/articles/github-sponsors/">GitHub Sponsors</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.7.0/">Cowboy 2.7</a></li>
<li><a href="https://ninenines.eu/articles/gun-2.0.0-pre.1/">Gun 2.0 pre-release 1</a></li>
<li><a href="https://ninenines.eu/articles/erlang-meetup-10-septembre-2019/">Erlang meetup: 10 septembre 2019</a></li>
<li><a href="https://ninenines.eu/articles/ranch-2.0.0-rc.1/">Ranch 2.0 release candidate 1</a></li>
<li><a href="https://ninenines.eu/articles/joe_the_rubber_duck/">Joe Armstrong the rubber duck</a></li>
<li><a href="https://ninenines.eu/articles/merry-christmas-2018/">Merry Christmas 2018: A Recap</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.6.0/">Cowboy 2.6</a></li>
<li><a href="https://ninenines.eu/articles/ranch-1.7.0/">Ranch 1.7</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.5.0/">Cowboy 2.5</a></li>
<li><a href="https://ninenines.eu/articles/gun-1.3.0/">Gun 1.3</a></li>
<li><a href="https://ninenines.eu/articles/gun-1.2.0/">Gun 1.2</a></li>
<li><a href="https://ninenines.eu/articles/ranch-1.6.0/">Ranch 1.6</a></li>
<li><a href="https://ninenines.eu/articles/gun-1.0.0/">Gun 1.0</a></li>
<li><a href="https://ninenines.eu/articles/asciideck/">Asciideck: Asciidoc for Erlang</a></li>
<li><a href="https://ninenines.eu/articles/gun-1.0.0-rc.1/">Gun 1.0 release candidate 1</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.4.0/">Cowboy 2.4</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.3.0/">Cowboy 2.3</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.2.0/">Cowboy 2.2</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.1.0/">Cowboy 2.1</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.0.0/">Cowboy 2.0</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.0.0-rc.2/">Cowboy 2.0 release candidate 2</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.0.0-rc.1/">Cowboy 2.0 release candidate 1</a></li>
<li><a href="https://ninenines.eu/articles/the-elephant-in-the-room/">The elephant in the room</a></li>
<li><a href="https://ninenines.eu/articles/dont-let-it-crash/">Don't let it crash</a></li>
<li><a href="https://ninenines.eu/articles/cowboy-2.0.0-pre.4/">Cowboy 2.0 pre-release 4</a></li>
<li><a href="https://ninenines.eu/articles/ranch-1.3/">Ranch 1.3</a></li>
<li><a href="https://ninenines.eu/articles/ml-archives/">Mailing list archived</a></li>
<li><a href="https://ninenines.eu/articles/website-update/">Website update</a></li>
<li><a href="https://ninenines.eu/articles/erlanger-playbook-september-2015-update/">The Erlanger Playbook September 2015 Update</a></li>
<li><a href="https://ninenines.eu/articles/erlanger-playbook/">The Erlanger Playbook</a></li>
<li><a href="https://ninenines.eu/articles/erlang-validate-utf8/">Validating UTF-8 binaries with Erlang</a></li>
<li><a href="https://ninenines.eu/articles/on-open-source/">On open source</a></li>
<li><a href="https://ninenines.eu/articles/the-story-so-far/">The story so far</a></li>
<li><a href="https://ninenines.eu/articles/cowboy2-qs/">Cowboy 2.0 and query strings</a></li>
<li><a href="https://ninenines.eu/articles/january-2014-status/">January 2014 status</a></li>
<li><a href="https://ninenines.eu/articles/farwest-funded/">Farwest got funded!</a></li>
<li><a href="https://ninenines.eu/articles/erlang.mk-and-relx/">Build Erlang releases with Erlang.mk and Relx</a></li>
<li><a href="https://ninenines.eu/articles/xerl-0.5-intermediate-module/">Xerl: intermediate module</a></li>
<li><a href="https://ninenines.eu/articles/xerl-0.4-expression-separator/">Xerl: expression separator</a></li>
<li><a href="https://ninenines.eu/articles/erlang-scalability/">Erlang Scalability</a></li>
<li><a href="https://ninenines.eu/articles/xerl-0.3-atomic-expressions/">Xerl: atomic expressions</a></li>
<li><a href="https://ninenines.eu/articles/xerl-0.2-two-modules/">Xerl: two modules</a></li>
<li><a href="https://ninenines.eu/articles/xerl-0.1-empty-modules/">Xerl: empty modules</a></li>
<li><a href="https://ninenines.eu/articles/ranch-ftp/">Build an FTP Server with Ranch in 30 Minutes</a></li>
<li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li>
</ul>
<h3>Feedback</h3>
<p>Feel free to <a href="mailto:[email protected]">email us</a>
if you found any mistake or need clarification on any of the
articles.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2018</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
