Merge remote-tracking branch 'origin/master' into release

Author: actions-user

examples/sdk/README.md

@@ -0,0 +1,9 @@
+Browser SDK
+===========
+
+An [AssemblyScript](http://assemblyscript.org) example using the [AssemblyScript browser SDK](https://github.com/AssemblyScript/assemblyscript/tree/master/lib/sdk).
+
+Instructions
+------------
+
+Open [index.html](./index.html) in a browser and see the console. View the source to learn how it works.

examples/sdk/index.html

@@ -0,0 +1,59 @@
+<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"></script>
+<script>
+require([ "https://cdn.jsdelivr.net/npm/assemblyscript@latest/dist/sdk.js" ], function(sdk) {
+  const { asc } = sdk;
+  asc.ready.then(() => {
+    console.log("Running simple example...");
+    simpleExample(asc);
+    console.log("\nRunning extended example...");
+    extendedExample(asc);
+  });
+});
+
+// This uses `asc.compileString`, a convenience API useful if all one wants to
+// do is to quickly compile a single source string to WebAssembly.
+function simpleExample(asc) {
+  const { text, binary } = asc.compileString(`export function test(): void {}`, {
+    optimizeLevel: 3,
+    runtime: "none"
+  });
+  console.log(">>> TEXT >>>\n" + text);
+  console.log(">>> BINARY >>>\n" + binary.length + " bytes");
+}
+
+// The full API works very much like asc on the command line, with additional
+// environment bindings being provided to access the (virtual) file system.
+function extendedExample(asc) {
+  const stdout = asc.createMemoryStream();
+  const stderr = asc.createMemoryStream();
+  asc.main([
+    "module.ts",
+    "-O3",
+    "--runtime", "none",
+    "--binaryFile", "module.wasm",
+    "--textFile", "module.wat",
+    "--sourceMap"
+  ], {
+    stdout: stdout,
+    stderr: stderr,
+    readFile: (name, baseDir) => {
+      if (name === "module.ts") return `export function test(): void {}`;
+      return null;
+    },
+    writeFile: (name, data, baseDir) => {
+      console.log(">>> WRITE:" + name + " >>>\n" + data.length);
+    },
+    listFiles: (dirname, baseDir) => {
+      return [];
+    }
+  }, err => {
+    console.log(">>> STDOUT >>>\n" + stdout.toString());
+    console.log(">>> STDERR >>>\n" + stderr.toString());
+    if (err) {
+      console.log(">>> THROWN >>>");
+      console.log(err);
+    }
+  });
+}
+</script>
+<p>See the browser console!</p>

lib/sdk/README.md

@@ -15,6 +15,9 @@ Exports
 * **binaryen**<br />
   The version of binaryen required by the compiler.
 
+* **long**<br />
+  The version of long.js required by the compiler.
+
 * **assemblyscript**<br />
   The AssemblyScript compiler as a library.
 
@@ -27,12 +30,14 @@ Example usage
 
 ```js
 require(
-  ["https://cdn.jsdelivr.net/npm/assemblyscript@nightly/dist/sdk"],
+  ["https://cdn.jsdelivr.net/npm/assemblyscript@latest/dist/sdk"],
   function(sdk) {
-    const { binaryen, assemblyscript, asc } = sdk;
+    const { asc } = sdk;
     asc.ready.then(() => {
       asc.main(...);
     });
   }
 );
 ```
+
+There is also the [SDK example](https://github.com/AssemblyScript/assemblyscript/tree/master/examples/sdk) showing how to compile some actual code.

lib/sdk/index.js

@@ -1,18 +1,22 @@
 const BINARYEN_VERSION = "nightly";
+const LONG_VERSION = "latest";
 const ASSEMBLYSCRIPT_VERSION = "nightly";
 
 // AMD/require.js (browser)
 if (typeof define === "function" && define.amd) {
   const paths = {
     "binaryen": "https://cdn.jsdelivr.net/npm/binaryen@" + BINARYEN_VERSION + "/index",
+    "long": "https://cdn.jsdelivr.net/npm/long@" + LONG_VERSION + "/dist/long",
     "assemblyscript": "https://cdn.jsdelivr.net/npm/assemblyscript@" + ASSEMBLYSCRIPT_VERSION + "/dist/assemblyscript",
     "assemblyscript/cli/asc": "https://cdn.jsdelivr.net/npm/assemblyscript@" + ASSEMBLYSCRIPT_VERSION + "/dist/asc",
   };
   require.config({ paths });
-  define(Object.keys(paths), (binaryen, assemblyscript, asc) => ({
+  define(Object.keys(paths), (binaryen, long, assemblyscript, asc) => ({
     BINARYEN_VERSION,
+    LONG_VERSION,
     ASSEMBLYSCRIPT_VERSION,
     binaryen,
+    long,
     assemblyscript,
     asc
   }));
@@ -21,8 +25,10 @@ if (typeof define === "function" && define.amd) {
 } else if (typeof module === "object" && module.exports) {
   module.exports = {
     BINARYEN_VERSION,
+    LONG_VERSION,
     ASSEMBLYSCRIPT_VERSION,
     binaryen: require("binaryen"),
+    long: require("long"),
     assemblyscript: require("assemblyscript"),
     asc: require("assemblyscript/cli/asc")
   };

lib/sdk/tests/index.html

@@ -4,12 +4,15 @@
   if (!x) throw Error("assertion failed");
 }
 require(["../index"], function(sdk) {
-  const { BINARYEN_VERSION, ASSEMBLYSCRIPT_VERSION, binaryen, assemblyscript, asc } = sdk;
+  const { BINARYEN_VERSION, LONG_VERSION, ASSEMBLYSCRIPT_VERSION, binaryen, long, assemblyscript, asc } = sdk;
   assert(typeof BINARYEN_VERSION === "string");
+  assert(typeof LONG_VERSION === "string");
   assert(typeof ASSEMBLYSCRIPT_VERSION === "string");
   console.log("Binaryen@" + BINARYEN_VERSION);
+  console.log("Long@" + LONG_VERSION);
   console.log("AssemblyScript@" + ASSEMBLYSCRIPT_VERSION);
   assert(typeof binaryen === "object" && binaryen && typeof binaryen._BinaryenTypeNone === "function");
+  assert(typeof long === "function" && long && typeof long.fromInt === "function");
   assert(typeof assemblyscript === "object" && assemblyscript && typeof assemblyscript.parse === "function");
   assert(typeof asc === "object" && asc && typeof asc.main === "function");
   asc.ready.then(() => console.log("ready", sdk));

package-lock.json

@@ -21,7 +21,7 @@
     "url": "https://github.com/AssemblyScript/assemblyscript/issues"
   },
   "dependencies": {
-    "binaryen": "90.0.0-nightly.20200111",
+    "binaryen": "90.0.0-nightly.20200128",
     "long": "^4.0.0",
     "source-map-support": "^0.5.16",
     "ts-node": "^6.2.0"

package.json

@@ -1,11 +1,12 @@
 const path = require("path");
 const fs = require("fs");
-const pkg = require("../package.json");
+const pkg = require("../package-lock.json");
 
 fs.readFile(path.join(__dirname, "..", "lib", "sdk", "index.js"), "utf8", function(err, data) {
   if (err) throw err;
   data = data
-    .replace(/BINARYEN_VERSION = "nightly"/, "BINARYEN_VERSION = " + JSON.stringify(pkg.dependencies.binaryen))
+    .replace(/BINARYEN_VERSION = "nightly"/, "BINARYEN_VERSION = " + JSON.stringify(pkg.dependencies.binaryen.version))
+    .replace(/LONG_VERSION = "latest"/, "LONG_VERSION = " + JSON.stringify(pkg.dependencies.long.version))
     .replace(/ASSEMBLYSCRIPT_VERSION = "nightly"/, "ASSEMBLYSCRIPT_VERSION = " + JSON.stringify(pkg.version));
   fs.writeFile(path.join(__dirname, "..", "dist", "sdk.js"), data, function(err) {
     if (err) throw err;

scripts/build-sdk.js

@@ -428,7 +428,7 @@ export class Compiler extends DiagnosticEmitter {
     if (cyclicClasses.size) {
       if (options.pedantic) {
         for (let classInstance of cyclicClasses) {
-          this.info(
+          this.pedantic(
             DiagnosticCode.Type_0_is_cyclic_Module_will_include_deferred_garbage_collection,
             classInstance.identifierNode.range, classInstance.internalName
           );
@@ -504,7 +504,7 @@ export class Compiler extends DiagnosticEmitter {
     if (options.importTable) {
       module.addTableImport("0", "env", "table");
       if (options.pedantic && options.willOptimize) {
-        this.warning(
+        this.pedantic(
           DiagnosticCode.Importing_the_table_disables_some_indirect_call_optimizations,
           null
         );
@@ -513,7 +513,7 @@ export class Compiler extends DiagnosticEmitter {
     if (options.exportTable) {
       module.addTableExport("0", ExportNames.table);
       if (options.pedantic && options.willOptimize) {
-        this.warning(
+        this.pedantic(
           DiagnosticCode.Exporting_the_table_disables_some_indirect_call_optimizations,
           null
         );
@@ -5578,6 +5578,12 @@ export class Compiler extends DiagnosticEmitter {
         assert(indexedSet.signature.parameterTypes.length == 2); // parser must guarantee this
         targetType = indexedSet.signature.parameterTypes[1];     // 2nd parameter is the element
         if (indexedSet.hasDecorator(DecoratorFlags.UNSAFE)) this.checkUnsafe(expression);
+        if (!isUnchecked && this.options.pedantic) {
+          this.pedantic(
+            DiagnosticCode.Indexed_access_may_involve_bounds_checking,
+            expression.range
+          );
+        }
         break;
       }
       default: {
@@ -7220,11 +7226,18 @@ export class Compiler extends DiagnosticEmitter {
       if (targetType.is(TypeFlags.REFERENCE)) {
         let classReference = targetType.classReference;
         if (classReference) {
-          let indexedGet = classReference.lookupOverload(OperatorKind.INDEXED_GET, this.currentFlow.is(FlowFlags.UNCHECKED_CONTEXT));
+          let isUnchecked = this.currentFlow.is(FlowFlags.UNCHECKED_CONTEXT);
+          let indexedGet = classReference.lookupOverload(OperatorKind.INDEXED_GET, isUnchecked);
           if (indexedGet) {
             let thisArg = this.compileExpression(targetExpression, classReference.type,
               Constraints.CONV_IMPLICIT
             );
+            if (!isUnchecked && this.options.pedantic) {
+              this.pedantic(
+                DiagnosticCode.Indexed_access_may_involve_bounds_checking,
+                expression.range
+              );
+            }
             return this.compileCallDirect(indexedGet, [
               expression.elementExpression
             ], expression, thisArg, constraints);
@@ -7671,6 +7684,12 @@ export class Compiler extends DiagnosticEmitter {
             ], expression)
           );
           flow.freeTempLocal(temp);
+          if (this.options.pedantic) {
+            this.pedantic(
+              DiagnosticCode.Expression_compiles_to_a_dynamic_check_at_runtime,
+              expression.range
+            );
+          }
           return ret;
         } else {
           this.error(

src/compiler.ts

@@ -40,6 +40,8 @@ export enum DiagnosticCode {
   Type_0_is_cyclic_Module_will_include_deferred_garbage_collection = 900,
   Importing_the_table_disables_some_indirect_call_optimizations = 901,
   Exporting_the_table_disables_some_indirect_call_optimizations = 902,
+  Expression_compiles_to_a_dynamic_check_at_runtime = 903,
+  Indexed_access_may_involve_bounds_checking = 904,
   Unterminated_string_literal = 1002,
   Identifier_expected = 1003,
   _0_expected = 1005,
@@ -187,6 +189,8 @@ export function diagnosticCodeToString(code: DiagnosticCode): string {
     case 900: return "Type '{0}' is cyclic. Module will include deferred garbage collection.";
     case 901: return "Importing the table disables some indirect call optimizations.";
     case 902: return "Exporting the table disables some indirect call optimizations.";
+    case 903: return "Expression compiles to a dynamic check at runtime.";
+    case 904: return "Indexed access may involve bounds checking.";
     case 1002: return "Unterminated string literal.";
     case 1003: return "Identifier expected.";
     case 1005: return "'{0}' expected.";

src/diagnosticMessages.generated.ts

@@ -34,6 +34,8 @@
   "Type '{0}' is cyclic. Module will include deferred garbage collection.": 900,
   "Importing the table disables some indirect call optimizations.": 901,
   "Exporting the table disables some indirect call optimizations.": 902,
+  "Expression compiles to a dynamic check at runtime.": 903,
+  "Indexed access may involve bounds checking.": 904,
 
   "Unterminated string literal.": 1002,
   "Identifier expected.": 1003,

src/diagnosticMessages.json

@@ -24,6 +24,8 @@ export {
 
 /** Indicates the category of a {@link DiagnosticMessage}. */
 export enum DiagnosticCategory {
+  /** Overly pedantic message. */
+  PEDANTIC,
   /** Informatory message. */
   INFO,
   /** Warning message. */
@@ -35,6 +37,7 @@ export enum DiagnosticCategory {
 /** Returns the string representation of the specified diagnostic category. */
 export function diagnosticCategoryToString(category: DiagnosticCategory): string {
   switch (category) {
+    case DiagnosticCategory.PEDANTIC: return "PEDANTIC";
     case DiagnosticCategory.INFO: return "INFO";
     case DiagnosticCategory.WARNING: return "WARNING";
     case DiagnosticCategory.ERROR: return "ERROR";
@@ -51,12 +54,15 @@ export const COLOR_BLUE: string = "\u001b[96m";
 export const COLOR_YELLOW: string = "\u001b[93m";
 /** ANSI escape sequence for red foreground. */
 export const COLOR_RED: string = "\u001b[91m";
+/** ANSI escape sequence for magenta foreground. */
+export const COLOR_MAGENTA: string = "\u001b[95m";
 /** ANSI escape sequence to reset the foreground color. */
 export const COLOR_RESET: string = "\u001b[0m";
 
 /** Returns the ANSI escape sequence for the specified category. */
 export function diagnosticCategoryToColor(category: DiagnosticCategory): string {
   switch (category) {
+    case DiagnosticCategory.PEDANTIC: return COLOR_MAGENTA;
     case DiagnosticCategory.INFO: return COLOR_BLUE;
     case DiagnosticCategory.WARNING: return COLOR_YELLOW;
     case DiagnosticCategory.ERROR: return COLOR_RED;
@@ -275,6 +281,29 @@ export abstract class DiagnosticEmitter {
     // console.log(<string>new Error("stack").stack);
   }
 
+  /** Emits an overly pedantic diagnostic message. */
+  pedantic(
+    code: DiagnosticCode,
+    range: Range | null,
+    arg0: string | null = null,
+    arg1: string | null = null,
+    arg2: string | null = null
+  ): void {
+    this.emitDiagnostic(code, DiagnosticCategory.PEDANTIC, range, null, arg0, arg1, arg2);
+  }
+
+  /** Emits an overly pedantic diagnostic message with a related range. */
+  pedanticRelated(
+    code: DiagnosticCode,
+    range: Range,
+    relatedRange: Range,
+    arg0: string | null = null,
+    arg1: string | null = null,
+    arg2: string | null = null
+  ): void {
+    this.emitDiagnostic(code, DiagnosticCategory.PEDANTIC, range, relatedRange, arg0, arg1, arg2);
+  }
+
   /** Emits an informatory diagnostic message. */
   info(
     code: DiagnosticCode,

src/diagnostics.ts

@@ -766,6 +766,23 @@ export declare function _BinaryenModuleSetFeatures(module: BinaryenModuleRef, fe
 
 export declare function _BinaryenAddCustomSection(module: BinaryenModuleRef, name: usize, contents: usize, contentsSize: BinaryenIndex): void;
 
+type BinaryenSideEffects = u32;
+
+export declare function _BinaryenSideEffectNone(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectBranches(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectCalls(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectReadsLocal(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectWritesLocal(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectReadsGlobal(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectWritesGlobal(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectReadsMemory(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectWritesMemory(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectImplicitTrap(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectIsAtomic(): BinaryenSideEffects;
+export declare function _BinaryenSideEffectAny(): BinaryenSideEffects;
+
+export declare function _BinaryenExpressionGetSideEffects(expr: BinaryenExpressionRef): BinaryenSideEffects;
+
 type BinaryenRelooperRef = usize;
 type BinaryenRelooperBlockRef = usize;