oak-wat 0.0.11

WebAssembly Text (WAT) language parser with support for web platform development and portable code generation.
Documentation
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
#![doc = include_str!("readme.md")]
use oak_core::source::{SourceBuffer, ToSource};

/// Root node of the WAT AST.
#[derive(Clone, Debug)]
pub struct WatRoot {
    /// Items in the WAT file.
    pub items: Vec<WatItem>,
}

impl ToSource for WatRoot {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        for item in &self.items {
            item.to_source(buffer);
            buffer.push("\n")
        }
    }
}

/// An item in a WAT file.
#[derive(Clone, Debug)]
pub enum WatItem {
    /// A module definition.
    Module(WatModule),
}

impl ToSource for WatItem {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        match self {
            WatItem::Module(m) => m.to_source(buffer),
        }
    }
}

/// A WebAssembly module.
#[derive(Clone, Debug)]
pub struct WatModule {
    /// Optional name of the module.
    pub name: Option<String>,
    /// Fields within the module.
    pub items: Vec<WatModuleField>,
}

impl ToSource for WatModule {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(module");
        if let Some(name) = &self.name {
            buffer.push(" ");
            buffer.push(name)
        }
        for item in &self.items {
            buffer.push("\n  ");
            item.to_source(buffer)
        }
        buffer.push(")")
    }
}

/// A field within a WebAssembly module.
#[derive(Clone, Debug)]
pub enum WatModuleField {
    /// A function definition.
    Func(WatFunc),
    /// An import definition.
    Import(WatImport),
    /// An export definition.
    Export(WatExport),
    /// A type definition.
    Type(WatType),
    /// A table definition.
    Table(WatTable),
    /// A memory definition.
    Memory(WatMemory),
    /// A global variable definition.
    Global(WatGlobal),
}

impl ToSource for WatModuleField {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        match self {
            WatModuleField::Func(f) => f.to_source(buffer),
            WatModuleField::Import(i) => i.to_source(buffer),
            WatModuleField::Export(e) => e.to_source(buffer),
            WatModuleField::Type(t) => t.to_source(buffer),
            WatModuleField::Table(t) => t.to_source(buffer),
            WatModuleField::Memory(m) => m.to_source(buffer),
            WatModuleField::Global(g) => g.to_source(buffer),
        }
    }
}

/// A WebAssembly function.
#[derive(Clone, Debug)]
pub struct WatFunc {
    /// Optional name of the function.
    pub name: Option<String>,
    /// Parameters of the function.
    pub params: Vec<WatParam>,
    /// Result types of the function.
    pub results: Vec<WatResult>,
    /// Local variables of the function.
    pub locals: Vec<WatLocal>,
    /// Instructions in the function body.
    pub body: Vec<WatInstruction>,
}

impl ToSource for WatFunc {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(func");
        if let Some(name) = &self.name {
            buffer.push(" ");
            buffer.push(name)
        }
        for param in &self.params {
            buffer.push(" ");
            param.to_source(buffer)
        }
        for result in &self.results {
            buffer.push(" ");
            result.to_source(buffer)
        }
        for local in &self.locals {
            buffer.push(" ");
            local.to_source(buffer)
        }
        for instr in &self.body {
            buffer.push("\n    ");
            instr.to_source(buffer)
        }
        buffer.push(")")
    }
}

/// A parameter in a WAT function.
#[derive(Clone, Debug)]
pub struct WatParam {
    /// Optional name of the parameter.
    pub name: Option<String>,
    /// Type of the parameter.
    pub ty: WatTypeKind,
}

impl ToSource for WatParam {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(param");
        if let Some(name) = &self.name {
            buffer.push(" ");
            buffer.push(name)
        }
        buffer.push(" ");
        self.ty.to_source(buffer);
        buffer.push(")")
    }
}

/// A result type in a WAT function.
#[derive(Clone, Debug)]
pub struct WatResult {
    /// Type of the result.
    pub ty: WatTypeKind,
}

impl ToSource for WatResult {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(result ");
        self.ty.to_source(buffer);
        buffer.push(")")
    }
}

/// A local variable in a WAT function.
#[derive(Clone, Debug)]
pub struct WatLocal {
    /// Optional name of the local variable.
    pub name: Option<String>,
    /// Type of the local variable.
    pub ty: WatTypeKind,
}

impl ToSource for WatLocal {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(local");
        if let Some(name) = &self.name {
            buffer.push(" ");
            buffer.push(name)
        }
        buffer.push(" ");
        self.ty.to_source(buffer);
        buffer.push(")")
    }
}

/// Supported types in WAT.
#[derive(Clone, Debug)]
pub enum WatTypeKind {
    /// 32-bit integer.
    I32,
    /// 64-bit integer.
    I64,
    /// 32-bit float.
    F32,
    /// 64-bit float.
    F64,
}

impl ToSource for WatTypeKind {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        match self {
            WatTypeKind::I32 => buffer.push("i32"),
            WatTypeKind::I64 => buffer.push("i64"),
            WatTypeKind::F32 => buffer.push("f32"),
            WatTypeKind::F64 => buffer.push("f64"),
        }
    }
}

/// A WebAssembly instruction.
#[derive(Clone, Debug)]
pub enum WatInstruction {
    /// unreachable
    Unreachable,
    /// nop
    Nop,
    /// drop
    Drop,
    /// select
    Select,
    /// return
    Return,
    /// local.get
    LocalGet(String),
    /// local.set
    LocalSet(String),
    /// local.tee
    LocalTee(String),
    /// global.get
    GlobalGet(String),
    /// global.set
    GlobalSet(String),
    /// i32.const
    I32Const(i32),
    /// i64.const
    I64Const(i64),
    /// f32.const
    F32Const(f32),
    /// f64.const
    F64Const(f64),
    /// i32.add
    I32Add,
    /// i32.sub
    I32Sub,
    /// i32.mul
    I32Mul,
    /// i64.add
    I64Add,
    /// i64.sub
    I64Sub,
    /// i64.mul
    I64Mul,
    /// Other instruction
    Other(String, Vec<String>),
}

impl ToSource for WatInstruction {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        match self {
            WatInstruction::Unreachable => buffer.push("unreachable"),
            WatInstruction::Nop => buffer.push("nop"),
            WatInstruction::Drop => buffer.push("drop"),
            WatInstruction::Select => buffer.push("select"),
            WatInstruction::Return => buffer.push("return"),
            WatInstruction::LocalGet(id) => {
                buffer.push("local.get ");
                buffer.push(id);
            }
            WatInstruction::LocalSet(id) => {
                buffer.push("local.set ");
                buffer.push(id);
            }
            WatInstruction::LocalTee(id) => {
                buffer.push("local.tee ");
                buffer.push(id);
            }
            WatInstruction::GlobalGet(id) => {
                buffer.push("global.get ");
                buffer.push(id);
            }
            WatInstruction::GlobalSet(id) => {
                buffer.push("global.set ");
                buffer.push(id);
            }
            WatInstruction::I32Const(val) => {
                buffer.push("i32.const ");
                buffer.push(&val.to_string());
            }
            WatInstruction::I64Const(val) => {
                buffer.push("i64.const ");
                buffer.push(&val.to_string());
            }
            WatInstruction::F32Const(val) => {
                buffer.push("f32.const ");
                buffer.push(&val.to_string());
            }
            WatInstruction::F64Const(val) => {
                buffer.push("f64.const ");
                buffer.push(&val.to_string());
            }
            WatInstruction::I32Add => buffer.push("i32.add"),
            WatInstruction::I32Sub => buffer.push("i32.sub"),
            WatInstruction::I32Mul => buffer.push("i32.mul"),
            WatInstruction::I64Add => buffer.push("i64.add"),
            WatInstruction::I64Sub => buffer.push("i64.sub"),
            WatInstruction::I64Mul => buffer.push("i64.mul"),
            WatInstruction::Other(name, args) => {
                buffer.push(name);
                for arg in args {
                    buffer.push(" ");
                    buffer.push(arg);
                }
            }
        }
    }
}

/// A WebAssembly import.
#[derive(Clone, Debug)]
pub struct WatImport {
    /// Module name being imported from.
    pub module: String,
    /// Field name being imported.
    pub name: String,
    /// Kind of import (e.g., "func", "memory").
    pub kind: String,
}

impl ToSource for WatImport {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(import \"");
        buffer.push(&self.module);
        buffer.push("\" \"");
        buffer.push(&self.name);
        buffer.push("\" (");
        buffer.push(&self.kind);
        buffer.push("))")
    }
}

/// A WebAssembly export.
#[derive(Clone, Debug)]
pub struct WatExport {
    /// Name being exported as.
    pub name: String,
    /// Kind of export (e.g., "func", "memory").
    pub kind: String,
    /// ID of the exported item (index or name).
    pub id: String,
}

impl ToSource for WatExport {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(export \"");
        buffer.push(&self.name);
        buffer.push("\" (");
        buffer.push(&self.kind);
        buffer.push(" ");
        buffer.push(&self.id);
        buffer.push("))")
    }
}

/// A WebAssembly type definition.
#[derive(Clone, Debug)]
pub struct WatType {
    /// Optional name of the type.
    pub id: Option<String>,
}

impl ToSource for WatType {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(type");
        if let Some(id) = &self.id {
            buffer.push(" ");
            buffer.push(id)
        }
        buffer.push(")")
    }
}

/// A WebAssembly table definition.
#[derive(Clone, Debug)]
pub struct WatTable {
    /// Optional ID of the table.
    pub id: Option<String>,
    /// Span of the table.
    pub span: oak_core::Range<usize>,
}

impl ToSource for WatTable {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(table");
        if let Some(id) = &self.id {
            buffer.push(" ");
            buffer.push(id)
        }
        buffer.push(")")
    }
}

/// A WebAssembly memory definition.
#[derive(Clone, Debug)]
pub struct WatMemory {
    /// Optional ID of the memory.
    pub id: Option<String>,
    /// Span of the memory.
    pub span: oak_core::Range<usize>,
}

impl ToSource for WatMemory {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(memory");
        if let Some(id) = &self.id {
            buffer.push(" ");
            buffer.push(id)
        }
        buffer.push(")")
    }
}

/// A WebAssembly global variable definition.
#[derive(Clone, Debug)]
pub struct WatGlobal {
    /// Optional name of the global variable.
    pub id: Option<String>,
    /// Type of the global variable.
    pub ty: WatTypeKind,
    /// Whether the global variable is mutable.
    pub mutable: bool,
}

impl ToSource for WatGlobal {
    fn to_source(&self, buffer: &mut SourceBuffer) {
        buffer.push("(global");
        if let Some(id) = &self.id {
            buffer.push(" ");
            buffer.push(id)
        }
        buffer.push(" ");
        if self.mutable {
            buffer.push("(mut ");
            self.ty.to_source(buffer);
            buffer.push(")");
        }
        else {
            self.ty.to_source(buffer);
        }
        buffer.push(")")
    }
}