From 8ab1c1eaaf25e0688d893a70708aba31188f76d1 Mon Sep 17 00:00:00 2001 From: JF Bastien Date: Mon, 8 Jun 2015 17:46:01 +0200 Subject: Split out text format into its own document. --- TextFormat.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 TextFormat.md (limited to 'TextFormat.md') diff --git a/TextFormat.md b/TextFormat.md new file mode 100644 index 0000000..1ce2bb4 --- /dev/null +++ b/TextFormat.md @@ -0,0 +1,22 @@ +# Text Format + +The purpose of this text format is to support: +* View Source on a WebAssembly module, thus fitting into the Web (where every + source can be viewed) in a natural way. +* Presentation in browser development tools when source maps aren't present + (which is necessarily the case with the MVP). +* Writing WebAssembly code directly for reasons including pedagogical, + experimental, debugging, optimization, and testing of the spec itself. +* The text format is equivalent and isomorphic to the + [binary format](BinaryEncoding.md). +* The text format will be standardized, but only for tooling purposes: + * Compilers will support this format for `.S` and inline assembly. + * Debuggers and profilers will present binary code using this textual format. + * Browsers will not parse the textual format on regular web content in order + to implement WebAssembly semantics. +* Given that the code representation is actually an + [Abstract Syntax Tree](ASTSemantics.md), the syntax would contain nested + statements and expressions (instead of the linear list of instructions most + assembly languages have). +* There is no requirement to use JavaScript syntax; this format is not intended + to be evaluated or translated directly into JavaScript. -- cgit v1.2.3 From 34c726663829d4e87f0129ea3c1213aa44a132d8 Mon Sep 17 00:00:00 2001 From: JF Bastien Date: Mon, 8 Jun 2015 19:46:46 +0200 Subject: Un-bullet the text format. --- TextFormat.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) (limited to 'TextFormat.md') diff --git a/TextFormat.md b/TextFormat.md index 1ce2bb4..0a64157 100644 --- a/TextFormat.md +++ b/TextFormat.md @@ -7,16 +7,19 @@ The purpose of this text format is to support: (which is necessarily the case with the MVP). * Writing WebAssembly code directly for reasons including pedagogical, experimental, debugging, optimization, and testing of the spec itself. -* The text format is equivalent and isomorphic to the - [binary format](BinaryEncoding.md). -* The text format will be standardized, but only for tooling purposes: - * Compilers will support this format for `.S` and inline assembly. - * Debuggers and profilers will present binary code using this textual format. - * Browsers will not parse the textual format on regular web content in order - to implement WebAssembly semantics. -* Given that the code representation is actually an - [Abstract Syntax Tree](ASTSemantics.md), the syntax would contain nested - statements and expressions (instead of the linear list of instructions most - assembly languages have). -* There is no requirement to use JavaScript syntax; this format is not intended - to be evaluated or translated directly into JavaScript. + +The text format is equivalent and isomorphic to the [binary format](BinaryEncoding.md). + +The text format will be standardized, but only for tooling purposes: +* Compilers will support this format for `.S` and inline assembly. +* Debuggers and profilers will present binary code using this textual format. +* Browsers will not parse the textual format on regular web content in order to + implement WebAssembly semantics. + +Given that the code representation is actually an +[Abstract Syntax Tree](ASTSemantics.md), the syntax would contain nested +statements and expressions (instead of the linear list of instructions most +assembly languages have). + +There is no requirement to use JavaScript syntax; this format is not intended to +be evaluated or translated directly into JavaScript. -- cgit v1.2.3