-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
executable file
·292 lines (259 loc) · 14.9 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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Birdee Language</title>
<link href="css/bootstrap-custom.min.css" rel="stylesheet">
<link href="css/font-awesome.min.css" rel="stylesheet">
<link href="css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<script src="js/jquery-1.10.2.min.js" defer></script>
<script src="js/bootstrap-3.0.3.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="homepage">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href=".">Birdee Language</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="active">
<a href=".">Welcome</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Birdee Language Mannual <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="Birdee Language Mannual/0010HelloWorld/">1. Hello world!</a>
</li>
<li >
<a href="Birdee Language Mannual/0020Basics/">2. Language Basics</a>
</li>
<li >
<a href="Birdee Language Mannual/0030FlowControl/">3. Flow Control</a>
</li>
<li >
<a href="Birdee Language Mannual/0040ScopeAndName/">4. Scope and names</a>
</li>
<li >
<a href="Birdee Language Mannual/0050Array/">5. Array</a>
</li>
<li >
<a href="Birdee Language Mannual/0060Class/">6. Class</a>
</li>
<li >
<a href="Birdee Language Mannual/0070Import/">7. Modules and Imports</a>
</li>
<li >
<a href="Birdee Language Mannual/0080Template/">8. Templates</a>
</li>
<li >
<a href="Birdee Language Mannual/0090Script/">9. Compile-time scripts</a>
</li>
<li >
<a href="Birdee Language Mannual/0100Cpp/">10. Interoperability with C/C++</a>
</li>
<li >
<a href="Birdee Language Mannual/0110Functional/">11. Functional Programming</a>
</li>
<li >
<a href="Birdee Language Mannual/0120Exception/">12. Exception handling</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Python Binding <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="Python Binding/0010.Overview/">Python binding for Birdee</a>
</li>
<li >
<a href="Python Binding/0020.Functions/">Birdee binding Functions for Python</a>
</li>
<li >
<a href="Python Binding/0030.Classes/">Binding classes</a>
</li>
<li >
<a href="Python Binding/0040.HighLevelAPI/">High level APIs</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tools <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="Tools/Birdee-playground-(REPL)/">Birdee playground</a>
</li>
<li >
<a href="Tools/Compiler-command-line-mannual/">Command line arguments for compiler (birdeec)</a>
</li>
<li >
<a href="Tools/bbuild/">The automatic building tool for Birdee - bbuild</a>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="disabled">
<a rel="next" >
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="Birdee Language Mannual/0010HelloWorld/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#welcome">Welcome</a></li>
<li><a href="#language-mannual">Language mannual</a></li>
<li><a href="#getting-birdee">Getting Birdee</a></li>
<li><a href="#whats-in-the-birdee-toolkit">What's in the Birdee toolkit?</a></li>
<li><a href="#tips-on-running-compiled-birdee-programs">Tips on running compiled Birdee programs</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="welcome">Welcome</h1>
<p>Birdee is a new programming language with C++-level performance and with light-weighted & managed runtime. </p>
<h2 id="language-mannual">Language mannual</h2>
<p>Please follow the links in the navigation bar.</p>
<h2 id="getting-birdee">Getting Birdee</h2>
<h3 id="building-birdee-from-scratch">Building Birdee from scratch</h3>
<p>Please follow the instructions in the <a href="https://github.com/Birdee-lang/Birdee2/blob/master/BUILDME.md">link</a>.</p>
<h3 id="pre-compiled-birdee">Pre-compiled Birdee</h3>
<p>Please follow the <a href="https://github.com/Birdee-lang/Birdee2/releases">link</a> to download the pre-built Birdee.</p>
<p>For Windows version, just unzip and add the unzipped directory to the environment variable as <code>BIRDEE_HOME</code>. In the directory pointed by <code>BIRDEE_HOME</code>, there should be directories named <code>bin</code>, <code>pylib</code>, <code>blib</code> and <code>src</code>. Also, Birdee compiler depends on a specific version of Python (e.g. 3.7).</p>
<p>For Linux Debian systems, use <code>sudo dpkg -i birdee_xxxx.deb</code> to install and <code>sudo dpkg -r birdee</code> to remove. This package requires libpython3.7-dev, libgc-dev and LLVM-6.0 to be installed. Remember to add <code>/usr/bin/birdee0.1</code> to the environment variable as <code>BIRDEE_HOME</code>.</p>
<h2 id="whats-in-the-birdee-toolkit">What's in the Birdee toolkit?</h2>
<p>Birdee provides several useful tools to help develop Birdee programs.</p>
<h3 id="birdee-compiler">Birdee compiler</h3>
<p>The compiler compiles a single Birdee module source file (*.bdm) into an native object file (*.o or *.obj) or LLVM IR file. The outcome of the compiler can be further linked into an executable file by external linkers (e.g. ld on Linux, link.exe of MSVC). Please note that Birdee compiler alone will not help you link the Birdee modules. You should link the modules by yourself or by the auto-building tool "bbuild". For more information on the compiler command line arguments, please refer to <a href="Tools/Compiler-command-line-mannual/">here</a>.</p>
<p>Besides the object files, the Birdee compiler will generate an meta-data file (*.bmm), for the compiled module, which is in JSON format. It contains information on the exported variables, classes and the function definitions of the module. This overcomes the issue that native object files will lose the important meta-data of the source code.</p>
<h3 id="birdee-auto-building-tool-bbuild">Birdee auto-building tool - bbuild</h3>
<p>bbuild is a Python-based auto-building tool provided by Birdee, to compile multiple Birdee modules and optionally link them into an executable/shared object file. It can</p>
<ul>
<li>Parse the <code>import</code> dependency of the Birdee modules, and automatically find the source code (or compiled object files) of dependent modules.</li>
<li>Automatically compile the modules from the source files.</li>
<li>Optionally link the object files into an executable/shared object file</li>
</ul>
<p>For more information on bbuild, please follow the <a href="Tools/bbuild/">link</a>.</p>
<h3 id="birdee-playground-repl">Birdee playground (REPL)</h3>
<p>To help to learn Birdee language and try Birdee programs, we provide a playground program, where you can simply type Birdee code and instantly see the results without compiling the whole program using the compiler. For each line of code you input, the playground will compile and execute it and prints the execution results on the console. Please follow the <a href="Tools/Birdee-playground-(REPL)/">link</a> to try it.</p>
<h2 id="tips-on-running-compiled-birdee-programs">Tips on running compiled Birdee programs</h2>
<p>On Linux, a compiled Birdee application has an additional dependency on libgc. Please make sure it is installed on the system where the application runs.</p>
<h3 id="run-birdee-programs-on-windows">Run Birdee programs on Windows!</h3>
<p>To run Birdee programs that are compiled with Birdee compiler on Windows, make sure "gc_64.dll" is in DLL search path (e.g. where the ".exe" file is). If you use exceptions in your Birdee program, make sure "libgcc_s_seh-1.dll" and "libwinpthread-1.dll" are also in DLL search path.</p>
<p>If you use the pre-compiled binaries of Birdee, these DLLs can be found in the "bin" directory. These DLL files can also be downloaded via the following links. <a href="https://pan.baidu.com/s/1FWnHpQkxj5PC4DP1PEMRlg">BaiduYun</a> or <a href="https://drive.google.com/open?id=1GIH-YDe2IFMnaYE91uOXAJlnXJjX3PvT">GoogleDrive</a>. Note that "libgcc_s_seh-1.dll" and "libwinpthread-1.dll" are extracted from mingw64.</p></div>
</div>
<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = ".",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="js/base.js" defer></script>
<script src="search/main.js" defer></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="Keyboard Shortcuts Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Keyboard Shortcuts</h4>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>
<!--
MkDocs version : 1.0.4
Build Date UTC : 2020-02-16 15:40:40
-->