public inbox for ~johnnyrichard/olang-devel@lists.sr.ht
 help / color / mirror / code / Atom feed
42b1438e1d4a61b4be2daa5cf88fd38257af9f5f blob 3126 bytes (raw)

  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
 
@node Getting Started
@chapter Getting Started

Welcome to the O programming language! This chapter will introduce you to the
basics of the language's syntax. We'll cover variables, data types, operators,
control flow, and functions.

By the end of this chapter, you'll have a solid foundation in the O language
syntax and be ready to start writing your own programs. Let's dive in!

@section An olang program

An O programmin language program starts with a @code{main} function. This
function must return the program exit code.

@verbatim
fn main(): u8 {
  return 0
}
@end verbatim

To compile the program you can use @code{olc}.

@verbatim
$ olc my_prog.ol -o my_prog
$ ./my_prog
@end verbatim

@section Functions

Unlike C, O language does not require function prototypes. This means you can
call a function before it's defined, making your code more flexible and easier
to read in many cases.

@verbatim
fn main(): u8 {
  return fib(8)
}

fn add(a: u32, b: u32): u32 {
  return a + b
}

fn fib(n: u32): u32 {
  if n <= 2 {
    return n
  }

  return add(fib(n - 1), fib(n - 2))
}
@end verbatim

@section Comments

Comments starts with a @code{#}.

@verbatim
# Hi I'm a comment and I'll be ignored by the compiler.
@end verbatim

@section Variables

@verbatim
var answer: u32 = 42
@end verbatim

@section Flow control

Any non zero expr is true.

@subsection If-Else

@verbatim
if expr {
  # statement
} else if expr {
  # statement
} else {
  # statement
}
@end verbatim

@subsection While loop

@verbatim
while expr {
  # statement
}
@end verbatim

@section Primitive data types

@table @samp

@item u8

Unsigned 8 bits.

@item u16

Unsigned 16 bits.

@item u32

Unsigned 32 bits.

@item u64

Unsigned 64 bits.

@end table

@section Binary Operations

Binary operations are pretty much like C.

@subsection Logical

@table @samp

@item Equals

@verbatim
expr1 == expr2
@end verbatim

Results zero (false) or one (true).

@item Less

@verbatim
expr1 < expr2
@end verbatim

Results zero (false) or one (true).

@item Less Equal

@verbatim
expr1 <= expr2
@end verbatim

Results zero (false) or one (true).

@item Greater

@verbatim
expr1 > expr2
@end verbatim

Results zero (false) or one (true).

@item Greater Equal

@verbatim
expr1 >= expr2
@end verbatim

Results zero (false) or one (true).

@item Or

@verbatim
expr1 || expr2
@end verbatim

Results zero (false) if both are true or one (true) if any is true.

@item And

@verbatim
expr1 && expr2
@end verbatim

Results zero (false) if any is false or one (true) if both are true.

@end table

@subsection Bitwise

@table @samp

@item Shift left

@verbatim
n << bits
@end verbatim

@item Shift left

@verbatim
n >> bits
@end verbatim

@item And

@verbatim
n & bits
@end verbatim

@item Or

@verbatim
n | bits
@end verbatim

@end table

@subsection Arithmetic

@table @samp

@item Addition

@verbatim
expr1 + expr2
@end verbatim

@item Subtraction

@verbatim
expr1 - expr2
@end verbatim

@item Multiplication

@verbatim
expr1 * expr2
@end verbatim

@item Division

@verbatim
expr1 / expr2
@end verbatim

@item Remaining

@verbatim
expr1 % expr2
@end verbatim

@end table
debug log:

solving 42b1438 ...
found 42b1438 in http://lists.johnnyrichard.com/olang/20241016214328.395001-1-johnny@johnnyrichard.com/ ||
	http://lists.johnnyrichard.com/olang/20241009221652.209738-2-carlos@maniero.me/
found a68f5b1 in https://git.johnnyrichard.com/olang.git
preparing index
index prepared:
100644 a68f5b158dcd9bd3c763547347b2196229083945	docs/info/getting-started.texi

applying [1/2] http://lists.johnnyrichard.com/olang/20241016214328.395001-1-johnny@johnnyrichard.com/
diff --git a/docs/info/getting-started.texi b/docs/info/getting-started.texi
index a68f5b1..42b1438 100644

Checking patch docs/info/getting-started.texi...
Applied patch docs/info/getting-started.texi cleanly.

skipping http://lists.johnnyrichard.com/olang/20241009221652.209738-2-carlos@maniero.me/ for 42b1438
index at:
100644 42b1438e1d4a61b4be2daa5cf88fd38257af9f5f	docs/info/getting-started.texi

Code repositories for project(s) associated with this public inbox

	https://git.johnnyrichard.com/olang.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox