mxjson

Murex-flavoured JSON (deprecated)

Description

This format has been deprecated in favour of %{} constructors.

mxjson is an extension to JSON designed to integrate more seamlessly when use as a configuration file. Thus mxjson supports comments and Murex code blocks embedded into the JSON schema.

mxjson is a format that is pre-parsed into a valid JSON format.

mxjson isn't a Murex data-type in that you cannot marshal and unmarshal mxjson files. Currently it is a format that is only supported by a small subset of Murex builtins (eg config and autocomplete) where config might embed Murex code blocks.

mxjson features the following enhancements:

Line Comments

Line comments are prefixed with a 'hash', #, just like with regular Murex code.

Block Quotation

Code blocks are quoted with (, ). For example, below "ExampleFunction" uses the ({ block quote }) method.

{
    "ExampleFunction": ({
        out "This is an example Murex function"
        if { =1==2 } then {
            err "The laws of the universe are broken"
        }
    })
}

Any block quoted by this method will be converted to the following valid JSON:

{
    "ExampleFunction": "\n    out \"This is an example Murex function\"\n    if { =1==2 } then {\n        err \"The laws of the universe are broken\"\n    }"
}

See Also

• Code Block Parsing: Overview of how code blocks are parsed
• Define Type (cast): Alters the data-type of the previous function without altering its output
• Get Nested Element ([[ Element ]]): Outputs an element from a nested structure
• Open File (open): Open a file with a preferred handler
• Prettify JSON: Prettifies JSON to make it human readable
• Reformat Data type (format): Reformat one data-type into another data-type
• Shell Configuration And Settings (config): Query or define Murex runtime settings
• Shell Runtime (runtime): Returns runtime information on the internal state of Murex
• Tab Autocompletion (autocomplete): Set definitions for tab-completion in the command line
• %(Brace Quote): Initiates or terminates a string (variables expanded)
• %[] Array Builder: Quickly generate arrays
• %{} Object Builder: Quickly generate objects (dictionaries / maps)
• hcl: HashiCorp Configuration Language (HCL)
• json: JavaScript Object Notation (JSON)
• jsonc: Concatenated JSON
• jsonl: JSON Lines
• toml: Tom's Obvious, Minimal Language (TOML)
• yaml: YAML Ain't Markup Language (YAML)
• { Curly Brace }: Initiates or terminates a code block
• index: Outputs an element from an array, map or table

Read more about type hooks

• ReadIndex() (type): Data type handler for the index, [, builtin
• ReadNotIndex() (type): Data type handler for the bang-prefixed index, ![, builtin
• ReadArray() (type): Read from a data type one array element at a time
• WriteArray() (type): Write a data type, one array element at a time
• ReadMap() (type): Treat data type as a key/value structure and read its contents
• Marshal() (type): Converts structured memory into a structured file format (eg for stdio)
• Unmarshal() (type): Converts a structured file format into structured memory

---

This document was generated from builtins/types/json/mxjson_doc.yaml.