Source range schema

Explore

Loading ....

View source

YAML

ethdebug/format/materials/source-range

$schema: "https://json-schema.org/draft/2020-12/schema"
$id: "schema:ethdebug/format/materials/source-range"

title: ethdebug/format/materials/source-range
description: |
  A range of bytes in a particular source.

  Note that this refers to the bytes range in the original character encoding
  for the source, not the character encoding used for strings in this JSON
  format (UTF-8). For compilers that support input sources in encodings other
  than this format's transmission encoding, compilers **must** address source
  ranges in this original encoding, and debuggers **must** re-encode source
  contents obtained from this format _before_ performing any range addressing.

  (Compilers that only accept UTF-8 or ASCII are naturally exempt from this
  concern.)

type: object
properties:
  compilation:
    title: Compilation reference by ID
    $ref: "schema:ethdebug/format/materials/reference"

  source:
    title: Source reference by ID
    $ref: "schema:ethdebug/format/materials/reference"

  range:
    title: Bytes range within source contents
    description: |
      Ranges that span the entire source contents **may** omit this field
      as a shorthand. This field is otherwise **required**.
    type: object
    properties:
      offset:
        description: |
          Byte offset at beginning of range.
        $ref: "schema:ethdebug/format/data/unsigned"

      length:
        description: Number of bytes contained in range
        $ref: "schema:ethdebug/format/data/unsigned"

    unevaluatedProperties: false

    required:
      - offset
      - length

unevaluatedProperties: false

required:
  - source

examples:
  - source:
      id: 5
    range:
      offset: 20
      length: 100

JSON

ethdebug/format/materials/source-range

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schema:ethdebug/format/materials/source-range",
  "title": "ethdebug/format/materials/source-range",
  "description": "A range of bytes in a particular source.\n\nNote that this refers to the bytes range in the original character encoding\nfor the source, not the character encoding used for strings in this JSON\nformat (UTF-8). For compilers that support input sources in encodings other\nthan this format's transmission encoding, compilers **must** address source\nranges in this original encoding, and debuggers **must** re-encode source\ncontents obtained from this format _before_ performing any range addressing.\n\n(Compilers that only accept UTF-8 or ASCII are naturally exempt from this\nconcern.)\n",
  "type": "object",
  "properties": {
    "compilation": {
      "title": "Compilation reference by ID",
      "$ref": "schema:ethdebug/format/materials/reference"
    },
    "source": {
      "title": "Source reference by ID",
      "$ref": "schema:ethdebug/format/materials/reference"
    },
    "range": {
      "title": "Bytes range within source contents",
      "description": "Ranges that span the entire source contents **may** omit this field\nas a shorthand. This field is otherwise **required**.\n",
      "type": "object",
      "properties": {
        "offset": {
          "description": "Byte offset at beginning of range.\n",
          "$ref": "schema:ethdebug/format/data/unsigned"
        },
        "length": {
          "description": "Number of bytes contained in range",
          "$ref": "schema:ethdebug/format/data/unsigned"
        }
      },
      "unevaluatedProperties": false,
      "required": [
        "offset",
        "length"
      ]
    }
  },
  "unevaluatedProperties": false,
  "required": [
    "source"
  ],
  "examples": [
    {
      "source": {
        "id": 5
      },
      "range": {
        "offset": 20,
        "length": 100
      }
    }
  ]
}

Playground

Loading...