Pointer templates

This format provides the concept of a pointer template to allow deduplicating representations. Pointer templates are defined to specify the variables they expect in scope and the pointer definition that uses those variables.

Explore
View source
Playground

Loading ....

YAML
JSON

ethdebug/format/pointer/template
$schema: "https://json-schema.org/draft/2020-12/schema"
$id: "schema:ethdebug/format/pointer/template"

title: ethdebug/format/pointer/template
description: |
  A schema for representing a pointer defined in terms of some variables whose
  values are to be provided when invoking the template.

type: object
properties:
  expect:
    title: Template variables
    description: |
      An array of variable identifiers used in the definition of the
      pointer template.

      A template does not give these variables values. Each one takes the
      value, and so the sort, of the variable with that identifier in scope
      where the template is referenced.
    type: array
    items:
      $ref: "schema:ethdebug/format/pointer/identifier"

  for:
    $ref: "schema:ethdebug/format/pointer"

required:
  - expect
  - for

additionalProperties: false

examples:
  - expect: ["slot"]
    for:
      location: storage
      slot: "slot"

ethdebug/format/pointer/template
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schema:ethdebug/format/pointer/template",
  "title": "ethdebug/format/pointer/template",
  "description": "A schema for representing a pointer defined in terms of some variables whose\nvalues are to be provided when invoking the template.\n",
  "type": "object",
  "properties": {
    "expect": {
      "title": "Template variables",
      "description": "An array of variable identifiers used in the definition of the\npointer template.\n\nA template does not give these variables values. Each one takes the\nvalue, and so the sort, of the variable with that identifier in scope\nwhere the template is referenced.\n",
      "type": "array",
      "items": {
        "$ref": "schema:ethdebug/format/pointer/identifier"
      }
    },
    "for": {
      "$ref": "schema:ethdebug/format/pointer"
    }
  },
  "required": [
    "expect",
    "for"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "expect": [
        "slot"
      ],
      "for": {
        "location": "storage",
        "slot": "slot"
      }
    }
  ]
}