| <!-- Copyright (c) 2010-2025 Arm Limited or its affiliates. All rights reserved. --> |
| <!-- This document is Non-confidential and licensed under the BSD 3-clause license. --> |
| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="x-ua-compatible" content="ie=edge"> |
| |
| <!--FAVICON.ico--> |
| <meta name="msapplication-TileColor" content="#2b5797"> |
| <meta name="msapplication-TileImage" content="../img/mstile-144x144.png"> |
| <link rel="icon" href="../img/favicon.ico"> |
| |
| <title>If Block - ARM Machine Readable Schema - 2.7.1</title> |
| |
| <!--CSS--> |
| <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"> |
| <link rel="stylesheet" type="text/css" href="../css/schema.css"> |
| <link rel="stylesheet" type="text/css" href="../css/hljs-github.css"> |
| </head> |
| <body> |
| <div class="container"> |
| <div class="row heading"> |
| <div class="col-md-6 pull-left"><a href="../index.html"><img src="../img/arm.svg" class="logo" /></a></div> |
| <div class="col-md-6 pull-left"><h1>AARCHMRS Schema <small>2.7.1</small></h1></div> |
| |
| <!--Show the home button--> |
| <a href="../index.html"><div class="back-to-home">↚ Home</div></a> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="row"> |
| |
| |
| |
| |
| <h2> |
| <span class="title-namespace">AST.</span><span class=" title-type">If</span> |
| |
| <!-- if oneOf is set, then type is ignored --> |
| <span class="type">object</span> |
| </h2> |
| |
| |
| |
| |
| <div class="static-markdown"><p>A model representing an ASL conditional statement. Models the following structures:</p> |
| <ul> |
| <li>Simple If statements</li> |
| </ul> |
| <pre><code>if a == '00' then |
| return '00'; |
| end |
| </code></pre> |
| <ul> |
| <li>Nested If blocks</li> |
| </ul> |
| <pre><code>if a == '00' then |
| return '00'; |
| elsif a == '01' then |
| return '01'; |
| else |
| return '11'; |
| end |
| </code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="row"> |
| |
| <div> |
| <!-- A simple object --> |
| <h3 class="type">object</h3> |
| |
| <table class="table table-hover properties"> |
| <thead> |
| <tr> |
| <th class="col-md-4">Properties</th> |
| <th class="col-md-4">Type</th> |
| <th class="col-md-4">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| |
| <!-- properties --> |
| |
| |
| <tr id="/properties/_meta" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/_meta">_meta</a> |
| </th> |
| <td class="col-md-4"> |
| <a href="../Meta_schema.html" class="schema_link">Meta</a> |
| </td> |
| <td class="col-md-4"> |
| |
| <div> |
| See |
| <a href="../Meta_schema.html" class="schema_link">Meta</a> |
| for more information. |
| </div> |
| |
| |
| |
| |
| </td> |
| </tr> |
| |
| <tr id="/properties/_type" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/_type">_type</a> |
| </th> |
| <td class="col-md-4"> |
| </td> |
| <td class="col-md-4"> |
| <dl> |
| <dt>Enum</dt> |
| <dd> |
| <code>AST.If</code> |
| </dd> |
| </dl> |
| |
| |
| |
| </td> |
| </tr> |
| |
| <tr id="/properties/condition" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/condition">condition<sup>◊</sup></a> |
| </th> |
| <td class="col-md-4"> |
| <a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a> |
| </td> |
| <td class="col-md-4"> |
| <div><p>The condition determining the branch to take.</p></div> |
| |
| <div> |
| See |
| <a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">definitions.condition</a> in |
| <a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a> |
| for more information. |
| </div> |
| |
| |
| |
| |
| </td> |
| </tr> |
| |
| <tr id="/properties/else_clause" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/else_clause">else_clause</a> |
| </th> |
| <td class="col-md-4"> |
| <div><span class="type Xof">oneOf</span> [</div> |
| |
| |
| |
| |
| <div class="items-oneOf"> |
| <a href="StatementBlock_schema.html" class="schema_link">StatementBlock</a> |
| </div> |
| <div class="items-oneOf"> |
| null |
| </div> |
| |
| |
| <div>]</div> |
| </td> |
| <td class="col-md-4"> |
| <div><p>The clause to execute if the condition is not satisfied.</p></div> |
| |
| <div> |
| |
| <!-- Can be one of following objects --> |
| |
| |
| <div class="item-type"> |
| <span><span class="type Xof">oneOf</span> <a class="title-type" href="StatementBlock_schema.html">StatementBlock</a></span> |
| |
| |
| </div> |
| <div class="item-type"> |
| <!-- type is a null --> |
| <span class="type"><span class="Xof">oneOf</span> null</span> |
| |
| |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| <div> |
| <b>Default</b> |
| <pre class="schema-json"><code class="language-json">null</code></pre> |
| </div> |
| </td> |
| </tr> |
| |
| <tr id="/properties/if_clause" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/if_clause">if_clause<sup>◊</sup></a> |
| </th> |
| <td class="col-md-4"> |
| <a href="StatementBlock_schema.html" class="schema_link">StatementBlock</a> |
| </td> |
| <td class="col-md-4"> |
| <div><p>The clause to execute if the condition is satisfied.</p></div> |
| |
| <div> |
| See |
| <a href="StatementBlock_schema.html" class="schema_link">StatementBlock</a> |
| for more information. |
| </div> |
| |
| |
| |
| |
| </td> |
| </tr> |
| |
| |
| <!-- patternProperties --> |
| |
| <!-- object property attributes --> |
| <tr> |
| <td colspan="3"> |
| <dl> |
| <dt>Additional Properties</dt> |
| <dd>Not Allowed</dd> |
| </dl> |
| </td> |
| </tr> |
| |
| <tr> |
| <td colspan="3"> |
| <dl> |
| <dt>◊ Required</dt> |
| <dd>Properties marked with ◊ are required properties.</dd> |
| </dl> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <!-- array, and it has described items --> |
| </div> |
| |
| |
| <h5>Examples</h5> |
| <div> |
| <pre class="schema-json"><code class="language-json">{ |
| "_type": "AST.If", |
| "condition": { |
| "_type": "AST.BinaryOp", |
| "left": { |
| "_type": "AST.Identifier", |
| "value": "a" |
| }, |
| "op": "==", |
| "right": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| }, |
| "if_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| } |
| ] |
| } |
| }</code></pre> |
| <pre class="schema-json"><code class="language-json">{ |
| "_type": "AST.If", |
| "condition": { |
| "_type": "AST.BinaryOp", |
| "left": { |
| "_type": "AST.Identifier", |
| "value": "a" |
| }, |
| "op": "==", |
| "right": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| }, |
| "if_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| } |
| ] |
| }, |
| "else_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.If", |
| "condition": { |
| "_type": "AST.BinaryOp", |
| "left": { |
| "_type": "AST.Identifier", |
| "value": "a" |
| }, |
| "op": "==", |
| "right": { |
| "_type": "Values.Value", |
| "value": "'01'" |
| } |
| }, |
| "if_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'01'" |
| } |
| } |
| ] |
| }, |
| "else_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'11'" |
| } |
| } |
| ] |
| } |
| } |
| ] |
| } |
| }</code></pre> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div class="row schema"> |
| <h3>Schema <small><a href="http://json-schema.org/draft-04/schema#">http://json-schema.org/draft-04/schema#</a></small></h3> |
| <pre class="schema-json"><code class="language-json">{ |
| "title": "If Block", |
| "info": [ |
| "A model representing an ASL conditional statement. Models the following structures:", |
| [ |
| "* Simple If statements", |
| "```", |
| "if a == '00' then", |
| " return '00';", |
| "end", |
| "```", |
| "* Nested If blocks", |
| "```", |
| "if a == '00' then", |
| " return '00';", |
| "elsif a == '01' then", |
| " return '01';", |
| "else", |
| " return '11';", |
| "end", |
| "```" |
| ] |
| ], |
| "examples": [ |
| { |
| "_type": "AST.If", |
| "condition": { |
| "_type": "AST.BinaryOp", |
| "left": { |
| "_type": "AST.Identifier", |
| "value": "a" |
| }, |
| "op": "==", |
| "right": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| }, |
| "if_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| } |
| ] |
| } |
| }, |
| { |
| "_type": "AST.If", |
| "condition": { |
| "_type": "AST.BinaryOp", |
| "left": { |
| "_type": "AST.Identifier", |
| "value": "a" |
| }, |
| "op": "==", |
| "right": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| }, |
| "if_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'00'" |
| } |
| } |
| ] |
| }, |
| "else_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.If", |
| "condition": { |
| "_type": "AST.BinaryOp", |
| "left": { |
| "_type": "AST.Identifier", |
| "value": "a" |
| }, |
| "op": "==", |
| "right": { |
| "_type": "Values.Value", |
| "value": "'01'" |
| } |
| }, |
| "if_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'01'" |
| } |
| } |
| ] |
| }, |
| "else_clause": { |
| "_type": "AST.StatementBlock", |
| "statements": [ |
| { |
| "_type": "AST.Return", |
| "val": { |
| "_type": "Values.Value", |
| "value": "'11'" |
| } |
| } |
| ] |
| } |
| } |
| ] |
| } |
| } |
| ], |
| "properties": { |
| "_meta": { |
| "$ref": "../Meta.json" |
| }, |
| "_type": { |
| "enum": [ |
| "AST.If" |
| ] |
| }, |
| "condition": { |
| "info": [ |
| "The condition determining the branch to take." |
| ], |
| "$ref": "../Traits/HasCondition.json#/definitions/condition" |
| }, |
| "if_clause": { |
| "info": [ |
| "The clause to execute if the condition is satisfied." |
| ], |
| "$ref": "StatementBlock.json" |
| }, |
| "else_clause": { |
| "info": [ |
| "The clause to execute if the condition is not satisfied." |
| ], |
| "default": null, |
| "oneOf": [ |
| { |
| "$ref": "StatementBlock.json" |
| }, |
| { |
| "type": "null" |
| } |
| ] |
| } |
| }, |
| "required": [ |
| "condition", |
| "if_clause" |
| ], |
| "type": "object", |
| "additionalProperties": false, |
| "$schema": "http://json-schema.org/draft-04/schema#" |
| }</code></pre> |
| </div> |
| |
| </div> |
| |
| <div class="container"> |
| <div class="footer text-right"> |
| Copyright © 2025 ARM Limited or its affiliates. All rights reserved. |
| </div> |
| </div> |
| |
| <script src="../js/highlight/highlight.js"></script> |
| <script src="../js/highlight/languages/json.min.js"></script> |
| <script src="../js/highlight/languages/django.min.js"></script> <!-- JINJA2 --> |
| <script src="../js/highlight/languages/yaml.min.js"></script> |
| <script src="../js/highlight/languages/isa.js"></script> |
| <script type="text/javascript"> |
| window.onload = function() { |
| hljs.configure({ |
| cssSelector: ".schema-json code, .includes code, pre code", |
| noHighlightRe: /^(no-?highlight|nohl)$/i, |
| }); |
| hljs.highlightAll() |
| }; |
| </script> |
| |
| </body> |
| </html> |