List

Explore
View source
Playground

Loading ....

YAML
JSON

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

title: ethdebug/format/pointer/collection/list
description: |
  An ordered list of pointers, indexed starting at zero.
type: object
properties:
  name:
    $ref: "schema:ethdebug/format/pointer/collection#/$defs/Name"

  list:
    type: object
    properties:
      count:
        description: |
          The size of the list that this collection represents.
        $ref: "schema:ethdebug/format/pointer/expression"
      each:
        description: |
          An identifier name whose value as an expression resolves to the index
          in the list. Its value is an integer.
        $ref: "schema:ethdebug/format/pointer/identifier"
      is:
        description: |
          The dynamically-generated pointer repeated as a list
        $ref: "schema:ethdebug/format/pointer"
    required:
      - count
      - each
      - is
    additionalProperties: false

required:
  - list

additionalProperties: false

examples:
  - list:
      count: 5
      each: "index"
      is:
        location: memory
        offset: "index"
        length: 1

  - # example: a named list. each element's regions have the path
    # ["items", index], e.g. ["items", 0] for the first "item" region
    name: "items"
    list:
      count: 3
      each: "index"
      is:
        name: "item"
        location: memory
        offset:
          ~product: ["index", ~wordsize]
        length: ~wordsize

ethdebug/format/pointer/collection/list
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schema:ethdebug/format/pointer/collection/list",
  "title": "ethdebug/format/pointer/collection/list",
  "description": "An ordered list of pointers, indexed starting at zero.\n",
  "type": "object",
  "properties": {
    "name": {
      "$ref": "schema:ethdebug/format/pointer/collection#/$defs/Name"
    },
    "list": {
      "type": "object",
      "properties": {
        "count": {
          "description": "The size of the list that this collection represents.\n",
          "$ref": "schema:ethdebug/format/pointer/expression"
        },
        "each": {
          "description": "An identifier name whose value as an expression resolves to the index\nin the list. Its value is an integer.\n",
          "$ref": "schema:ethdebug/format/pointer/identifier"
        },
        "is": {
          "description": "The dynamically-generated pointer repeated as a list\n",
          "$ref": "schema:ethdebug/format/pointer"
        }
      },
      "required": [
        "count",
        "each",
        "is"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "list"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "list": {
        "count": 5,
        "each": "index",
        "is": {
          "location": "memory",
          "offset": "index",
          "length": 1
        }
      }
    },
    {
      "name": "items",
      "list": {
        "count": 3,
        "each": "index",
        "is": {
          "name": "item",
          "location": "memory",
          "offset": {
            "~product": [
              "index",
              "~wordsize"
            ]
          },
          "length": "~wordsize"
        }
      }
    }
  ]
}