Skip to content

Commit

Permalink
Replace the AST definition in README.md with a link to ast.ml.
Browse files Browse the repository at this point in the history 
The README.md copy keeps going out of date with asm.ml. The ML source
code ought to be readable as documentation, since it also serves as a
specification, so if there is a readability issue with asm.ml, we
should fix it.
  • Loading branch information
@sunfishcode
sunfishcode committed Oct 1, 2015
1 parent 2ef91ef commit 4ec6b98
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 64 deletions.
45 changes: 4 additions & 41 deletions ml-proto/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,48 +106,13 @@ Here, the external format is S-expressions, but similar considerations would app

## Internal Syntax

The core language is defined in `ast.ml`, and looks as follows:

```
type var = int
type expr =
| Nop (* do nothing
| Block of expr list (* execute in sequence
| If of expr * expr * expr (* conditional
| Loop of expr (* infinite loop
| Label of expr (* labelled expression
| Break of int * expr option (* break to n-th surrounding label
| Switch of expr * arm list * expr (* switch, latter expr is default
| Call of var * expr list (* call function
| CallImport of var * expr list (* call imported function
| CallIndirect of var * expr * expr list (* call function through table
| Return of expr option (* return 0 to many value
| GetParam of var (* read parameter
| GetLocal of var (* read local variable
| SetLocal of var * expr (* write local variable
| LoadGlobal of var (* read global variable
| StoreGlobal of var * expr (* write global variable
| Load of loadop * expr (* read memory address
| Store of storeop * expr * expr (* write memory address
| Const of value (* constant
| Unary of unop * expr (* unary arithmetic operator
| Binary of binop * expr * expr (* binary arithmetic operator
| Compare of relop * expr * expr (* arithmetic comparison
| Convert of cvt * expr (* conversion
| PageSize (* return host-defined page_size
| MemorySize (* return current size of linear memory
| ResizeMemory (* resize linear memory
and arm = {value : value; expr : expr; fallthru : bool}
```

See the code for more details on the auxiliary types. It also contains ASTs for functions and modules.

The core language is defined in [ast.ml](https://github.com/WebAssembly/spec/blob/master/ml-proto/src/spec/ast.ml).

## External Syntax

The S-expression syntax is defined in `parser.mly`, the opcodes in `lexer.mll`. Here is an overview of the grammar of types, expressions, functions, and modules:
The S-expression syntax is defined in [parser.mly](https://github.com/WebAssembly/spec/blob/master/ml-proto/src/host/parser.mly), the opcodes in [lexer.mll](https://github.com/WebAssembly/spec/blob/master/ml-proto/src/host/lexer.mll).

Here is an overview of the grammar of types, expressions, functions, and modules:

```
type: i32 | i64 | f32 | f64
Expand Down Expand Up @@ -178,8 +143,6 @@ expr:
( return <expr>? )
( get_local <var> )
( set_local <var> <expr> )
( load_global <var> )
( store_global <var> <expr> )
( <type>.load((8|16)_<sign>)?(/<align>)? <expr> )
( <type>.store(/<align>)? <expr> <expr> )
( <type>.const <value> )
Expand Down
46 changes: 23 additions & 23 deletions ml-proto/spec/ast.ml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,31 +74,31 @@ type literal = value Source.phrase

type expr = expr' Source.phrase
and expr' =
| Nop
| Block of expr list
| If of expr * expr * expr
| Loop of expr
| Label of expr
| Break of var * expr option
| Switch of value_type * expr * arm list * expr
| Call of var * expr list
| CallImport of var * expr list
| CallIndirect of var * expr * expr list
| Return of expr option
| GetLocal of var
| SetLocal of var * expr
| Load of memop * expr
| Store of memop * expr * expr
| Nop (* do nothing *)
| Block of expr list (* execute in sequence *)
| If of expr * expr * expr (* conditional *)
| Loop of expr (* infinite loop *)
| Label of expr (* labelled expression *)
| Break of var * expr option (* break to n-th surrounding label *)
| Switch of value_type * expr * arm list * expr (* switch, latter expr is default *)
| Call of var * expr list (* call function *)
| CallImport of var * expr list (* call imported function *)
| CallIndirect of var * expr * expr list (* call function through table *)
| Return of expr option (* return 0 to many value *)
| GetLocal of var (* read local variable *)
| SetLocal of var * expr (* write local variable *)
| Load of memop * expr (* read memory address *)
| Store of memop * expr * expr (* write memory address *)
| LoadExtend of extendop * expr
| StoreTrunc of truncop * expr * expr
| Const of literal
| Unary of unop * expr
| Binary of binop * expr * expr
| Compare of relop * expr * expr
| Convert of cvt * expr
| PageSize
| MemorySize
| ResizeMemory of expr
| Const of literal (* constant *)
| Unary of unop * expr (* unary arithmetic operator *)
| Binary of binop * expr * expr (* binary arithmetic operator *)
| Compare of relop * expr * expr (* arithmetic comparison *)
| Convert of cvt * expr (* conversion *)
| PageSize (* return host-defined page_size *)
| MemorySize (* return current size of linear memory *)
| ResizeMemory of expr (* resize linear memory *)

and arm = arm' Source.phrase
and arm' =
Expand Down

0 comments on commit 4ec6b98

Please sign in to comment.