Add gather context operator

Author: gnidan

packages/format/src/types/program/context.test.ts

@@ -22,6 +22,10 @@ testSchemaGuards("ethdebug/format/program/context", [
     schema: "schema:ethdebug/format/program/context/pick",
     guard: Context.isPick
   },
+  {
+    schema: "schema:ethdebug/format/program/context/gather",
+    guard: Context.isGather
+  },
   {
     schema: "schema:ethdebug/format/program/context/frame",
     guard: Context.isFrame

packages/format/src/types/program/context.ts

@@ -7,6 +7,7 @@ export type Context =
   | Context.Variables
   | Context.Remark
   | Context.Pick
+  | Context.Gather
   | Context.Frame;
 
 export const isContext = (value: unknown): value is Context => [
@@ -15,6 +16,7 @@ export const isContext = (value: unknown): value is Context => [
   Context.isRemark,
   Context.isPick,
   Context.isFrame,
+  Context.isGather,
 ].some(guard => guard(value));
 
 export namespace Context {
@@ -90,6 +92,15 @@ export namespace Context {
       "pick" in value && value.pick instanceof Array &&
       value.pick.every(isContext);
 
+  export interface Gather {
+    gather: Context[];
+  }
+
+  export const isGather = (value: unknown): value is Pick =>
+    typeof value === "object" && !!value &&
+      "gather" in value && value.gather instanceof Array &&
+      value.gather.every(isContext);
+
   export interface Frame {
     frame: string;
   }

packages/web/spec/program/context/gather.mdx

@@ -0,0 +1,11 @@
+---
+sidebar_position: 7
+---
+
+import SchemaViewer from "@site/src/components/SchemaViewer";
+
+# Gather multiple contexts
+
+<SchemaViewer
+  schema={{ id: "schema:ethdebug/format/program/context/gather" }}
+  />

packages/web/src/schemas.ts

@@ -215,7 +215,7 @@ const programSchemaIndex: SchemaIndex = {
   },
 
   ...(
-    ["code", "variables", "remark", "pick", "frame"].map(name => ({
+    ["code", "variables", "remark", "pick", "gather", "frame"].map(name => ({
       [`schema:ethdebug/format/program/context/${name}`]: {
         href: `/spec/program/context/${name}`
       }

schemas/program/context.schema.yaml

@@ -38,6 +38,10 @@ allOf:
       required: ["pick"]
     then:
       $ref: "schema:ethdebug/format/program/context/pick"
+  - if:
+      required: ["gather"]
+    then:
+      $ref: "schema:ethdebug/format/program/context/gather"
   - if:
       required: ["frame"]
     then:

schemas/program/context/gather.schema.yaml

@@ -0,0 +1,58 @@
+$schema: "https://json-schema.org/draft/2020-12/schema"
+$id: "schema:ethdebug/format/program/context/gather"
+
+title: ethdebug/format/program/context/gather
+description: |
+  A context specifying the `"gather"` property with a list of contexts
+  indicates that all specified contexts apply simultaneously.
+
+type: object
+properties:
+  gather:
+    title: Contexts to gather
+    type: array
+    items:
+      $ref: "schema:ethdebug/format/program/context"
+    minItems: 2
+    additionalItems: false
+required:
+  - gather
+
+examples:
+  - gather:
+      - frame: "ir"
+        code:
+          source:
+            id: 0
+          range:
+            offset: 8
+            length: 11
+      - frame: "source"
+        code:
+          source:
+            id: 3
+          range:
+            offset: 113
+            length: 19
+  - gather:
+    - variables:
+      - identifier: x
+        declaration:
+          source:
+            id: 5
+          range:
+            offset: 10
+            length: 56
+        type:
+          kind: string
+    - variables:
+      - identifier: x
+        declaration:
+          source:
+            id: 5
+          range:
+            offset: 10
+            length: 56
+        pointer:
+          location: storage
+          slot: 0