AARCHMRS Schema 2.7.4

↚ Home

Instruction.OperationAlias object

OperationAlias contains human-readable descriptions and a link to the Operation that contains the relevant ASL operation pseudocode.

object

Properties Type Description
_meta Meta

Metadata

See Meta for more information.
_type
Enum
Instruction.OperationAlias
brief OperationAbstract
See definitions.brief in OperationAbstract for more information.
description OperationAbstract
See definitions.description in OperationAbstract for more information.
operation_id AST.Identifier

The ID of the Operation that stores the descriptions and pseudocode for this OperationAlias. The Operation is a value in the operations property of the top-level Instruction.Instructions element, and this operation_id matches its key.

See definitions.c_identifier_regex in AST.Identifier for more information.
title OperationAbstract
See definitions.title in OperationAbstract for more information.
Additional Properties
Not Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "Instruction.OperationAlias", 
    "operation_id": "SBC", 
    "description": "Negate with Carry negates the sum of a register value and the value of NOT (Carry flag), and writes the result to the destination register.", 
    "brief": "NGC", 
    "title": "NGC"
}

Schema http://json-schema.org/draft-04/schema#

{
  "type": "object",
  "info": [
    [
      "$(~Instruction.OperationAlias) contains human-readable descriptions and a link to the $(~Instruction.Operation)",
      "that contains the relevant ASL operation pseudocode."
    ]
  ],
  "properties": {
    "_meta": {
      "$ref": "../Meta.json",
      "info": [
        "Metadata"
      ]
    },
    "_type": {
      "enum": [
        "Instruction.OperationAlias"
      ]
    },
    "operation_id": {
      "info": [
        [
          "The ID of the $(~Instruction.Operation) that stores the descriptions and pseudocode for",
          "this $(~Instruction.OperationAlias). The $(~Instruction.Operation) is a value in the `operations`",
          "property of the top-level `Instruction.Instructions` element, and this",
          "operation_id matches its key."
        ]
      ],
      "$ref": "../AST/Identifier.json#/definitions/c_identifier_regex"
    },
    "description": {
      "$ref": "OperationAbstract.json#/definitions/description"
    },
    "brief": {
      "$ref": "OperationAbstract.json#/definitions/brief"
    },
    "title": {
      "$ref": "OperationAbstract.json#/definitions/title"
    }
  },
  "required": [
    "operation_id",
    "brief",
    "title",
    "description"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "_type": "Instruction.OperationAlias",
      "operation_id": "SBC",
      "description": "Negate with Carry negates the sum of a register value and the value of NOT (Carry flag), and writes the result to the destination register.",
      "brief": "NGC",
      "title": "NGC"
    }
  ],
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Instruction.OperationAlias"
}