NAME
Muldis::D::Dialect::PTMD_STD - How to format Plain Text Muldis D
VERSION
This document is Muldis::D::Dialect::PTMD_STD version 0.129.0.
PREFACE
This document is part of the Muldis D language specification, whose root document is Muldis::D; you should read that root document before you read this one, which provides subservient details.
DESCRIPTION
This document outlines the grammar of the Plain Text Muldis D standard dialect named PTMD_STD. The fully-qualified name of this Muldis D standard dialect is Muldis_D:"http://muldis.com":0.129.0:PTMD_STD.
This dialect is designed to exactly match the Muldis D system catalog (the possible representation of Muldis D code that is visible to or updateable by Muldis D programs at runtime) as to what non-critical metadata it explicitly stores; so code in the PTMD_STD dialect should be round-trippable with the system catalog with the result maintaining all the details that were started with. Since it matches the system catalog, this dialect should be able to exactly represent all possible Muldis D base language code (and probably all extensions too), rather than a subset of it. That said, the PTMD_STD dialect does provide a choice of multiple syntax options for writing Muldis D value literals and DBMS entity (eg type and routine) declarations, so several very distinct PTMD_STD code artifacts may parse into the same system catalog entries. There is even a considerable level of abstraction in some cases, so that it is easier for programmers to write and understand typical PTMD_STD code, and so that this code isn't absurdly verbose.
This dialect is designed to be as small as possible while meeting the above criteria, and is designed such that a parser that handles all of this dialect can be fairly small and simple. Likewise, a code generator for this dialect from the system catalog can be fairly small and simple.
A significant quality of the PTMD_STD dialect is that it is designed to work easily for a single-pass parser, or at least a single-pass lexer; all the context that one needs to know for how to parse or lex any arbitrary substring of code is provided by prior code, or any required lookahead is just by a few characters in general. Therefore, a PTMD_STD parser can easily work on a streaming input like a file-handle where you can't go back earlier in the stream. Often this means a parser can work with little RAM.
Also the dialect is designed that any amount of whitespace can be added or omitted next to most non-alphanumeric characters (which happen to be next to alphanumeric tokens) without that affecting the meaning of the code at all, except obviously for within character string literals. And long binary or character or numeric or identifier strings can be split into arbitrary-size substrings, without affecting the meaning. And many elements are identified by name rather than ordinal position, so to some degree the order they appear has no effect on the meaning. So programmers can easily format (separate, indent, linewrap, order) code how they like, and making an automated code reformatter shouldn't be difficult. Often, named elements can also be omitted entirely for brevity, in which case the parser would use context to supply default values for those elements.
Given that plain text is (more or less) universally unambiguously portable between all general purpose languages that could be used to implement a DBMS, it is expected that every single Muldis D implementation will natively accept input in the PTMD_STD dialect, which isn't dependent on any specific host language and should be easy enough to process, so it should be considered the safest official Muldis D dialect to write in by default, when you don't have a specific reason to use some other dialect.
See also the dialects HDMD_Perl6_STD and HDMD_Perl5_STD, which are derived directly from PTMD_STD, and represent possible Perl 6 and 5 concrete syntax trees for it; in fact, most of the details in common with those other dialects are described just in the current file, for all 3 dialects.
GENERAL STRUCTURE
A PTMD_STD Muldis D code file consists just of a Muldis D depot definition, which begins with a language name declaration, and then has a Database value literal defining the depot's catalog, and finally has, optionally, a Database value literal defining the depot's data. This is conceptually what a PTMD_STD file is, and it can even be that literally, but PTMD_STD provides a canonical further abstraction for defining the depot's catalog, which should be used when doing data-definition. And so you typically use syntax resembling routine and type declarations in a general purpose programming language, where simply declaring such an entity will cause it to be part of the system catalog. Fundamentally every Muldis D depot is akin to a code library, and a Muldis D "main program" is nothing more than a depot having a procedure that is designated to execute automatically after a mount event of its host depot.
As a special extension feature, a PTMD_STD Muldis D code file may alternately consist just of a (language-qualified) Muldis D value literal, which mainly is intended for use in mixed-language environments as an interchange format for data values between Muldis D and other languages.
The grammar in this file is formatted as a hybrid between various BNF flavors and Perl 6 rules (see http://perlcabal.org/syn/S05.html for details on the latter) with further changes. It is only meant to be illustrative and human readable, and would need significant changes to actually be a functional parser, which are different for each parser toolkit.
The grammar consists mainly of named tokens which define matching rules. Loosely speaking, each parser match of a token corresponds to a capture node or node element in the concrete syntax tree resulting from the parse; in practice, the parser may make various alterations to the match when generating a node, such as adding guide keywords corresponding to the token name, or by merging series of trivial tokens or doing escaped character substitutions. No explicit capture syntax such as parenthesis is used in the grammar.
To help understand the grammar in this file, here are a few guidelines: 1. The grammar is exactly the same as that of a Perl 6 rule except where these guidelines state otherwise; this includes that square brackets mean grouping not optionality, and that when multiple sub-pattern alternatives match, the one that is the longest wins. 2. The grammar portion that actually declares a token, that is what associates a token name with its definition body, is formatted like EBNF, as <footok> ::= ... rather than the Perl 6 way like token footok { ... } or rule footok { ... }. 3. All non-quoted whitespace is not significant and just is formatting the grammar itself; rather, whitespace rules in the grammar are spelled out explicitly such as with <ws>? (optional whitespace) and <ws> (mandatory whitespace) and <unspace> (nothing at all may go here except a pair of backslashes (\) surrounding an optional run of whitespace, which would be stripped). 4. The meanings of <ws> and <unspace> are explicitly defined in this file's grammar and do not match the <ws> and <unspace> that are defined by Perl 6; this file's versions are simpler for one thing.
The root grammar token for the entire dialect is Muldis_D.
START
Grammar:
<Muldis_D> ::=
<language_name> <ws> [<value> | <depot>]A Muldis_D node has 2 ordered elements where the first element is a language_name node and the second element is either a value node or a depot node.
See the pod sections in this file named "LANGUAGE NAME", "VALUE LITERALS AND SELECTORS", and "DEPOT SPECIFICATION", for more details about the aforementioned tokens/nodes.
When Muldis D is being compiled and invoked piecemeal, such as because the Muldis D implementing virtual machine (VM) is attached to an interactive user terminal, or the VM is embedded in a host language where code in the host language invokes Muldis D code at various times, many value may be fed to the VM directly for inter-language exchange, and not every one would then have its own language_name. Usually a language_name would be supplied to the Muldis D VM just once as a VM configuration step, which provides a context for further interaction with the VM that just involves Muldis D code that isn't itself qualified with a language_name.
LANGUAGE NAME
Grammar:
<language_name> ::=
<ln_base_name>
<unspace> ':' <ln_base_authority>
<unspace> ':' <ln_base_version_number>
<unspace> ':' <ln_dialect>
<unspace> ':' <ln_extensions>
<ln_base_name> ::=
Muldis_D
<ln_base_authority> ::=
<ln_elem_str>
<ln_base_version_number> ::=
<ln_elem_str>
<ln_dialect> ::=
PTMD_STD
<ln_elem_str> ::=
<nonquoted_ln_elem_str> | <quoted_ln_elem_str>
<nonquoted_ln_elem_str> ::=
<[ a..z A..Z 0..9 _ - \. ]>+
<quoted_ln_elem_str> ::=
'"'
[<[\ ..~]-[\\"]> | '\b'|'\a'|'\q'|'\g'|'\h'|'\s' | <unspace>]+
'"'
<ln_extensions> ::=
'{' <ws>?
catalog_abstraction_level <ws>? '=>' <ws>? <cat_abstr_level>
<ws>? ',' <ws>? op_char_repertoire <ws>? '=>' <ws>? <op_cr>
[<ws>? ',' <ws>? standard_syntax_extensions
<ws>? => <ws>? <std_syn_ext_list>]?
<ws>? '}'
<cat_abstr_level> ::=
the_floor
| code_as_data
| plain_rtn_inv
| rtn_inv_alt_syn
<op_cr> ::=
basic | extended
<std_syn_ext_list> ::=
'{' <ws>?
[<std_syn_ext_list_item> ** [<ws>? ',' <ws>?]]?
<ws>? '}'
<std_syn_ext_list_item> ::=
''Please interpret the '' under <std_syn_ext_list_item> as a placeholder and that there are currently zero valid list items.
As per the VERSIONING pod section of Muldis::D, code written in Muldis D must start by declaring the fully-qualified Muldis D language name it is written in. The PTMD_STD dialect formats this name as a language_name node having 5 ordered elements:
ln_base_name-
This is the Muldis D language base name; it is simply the bareword character string
Muldis_D. -
This is the base authority; it is a character string formatted as per a specific-context
Namevalue literal, except that it must be nonempty and it is expressly limited to using non-control characters in the ASCII repertoire, and its nonquoted variant has fewer limitations thanName's; it is typically the delimited character stringhttp://muldis.com. ln_base_version_number-
This is the base version number; it is a character string formatted as per
ln_base_authority; it is typically a character string like0.129.0. ln_dialect-
This is the dialect name; it is simply the bareword character string
PTMD_STD. ln_extensions-
This is a set of chosen pragma/parser-config options, which is formatted similarly to a
TupleSCVL. The only 2 mandatory pragmas arecatalog_abstraction_level(see the "CATALOG ABSTRACTION LEVELS" pod section) andop_char_repertoire(see "OPERATOR CHARACTER REPERTOIRE"). The only optional pragma isstandard_syntax_extensions(see the "STANDARD SYNTAX EXTENSIONS" pod section). Other pragmas may be added later, which would likely be optional.
Examples:
Muldis_D:"http://muldis.com":0.129.0:PTMD_STD:{
catalog_abstraction_level => rtn_inv_alt_syn,
op_char_repertoire => extended
}
Muldis_D:"http://muldis.com":0.129.0:PTMD_STD:{
catalog_abstraction_level => rtn_inv_alt_syn,
op_char_repertoire => extended,
standard_syntax_extensions => {}
}CATALOG ABSTRACTION LEVELS
The catalog_abstraction_level pragma determines with a broad granularity how large the effective Muldis D grammar is that a programmer may employ with their Muldis D code.
The catalog abstraction level of some Muldis D code is a measure of how much or how little that code would resemble the system catalog data that the code would parse into. The lower the abstraction level, the smaller and simpler the used Muldis D grammar is and the more like data structure literals it is; the higher the abstraction level, the larger and more complicated the Muldis D grammar is and the more like general-purpose-language typical code it is.
There are currently 4 specified catalog abstraction levels, which when arranged from lowest to highest amount of abstraction, are: the_floor, code_as_data, plain_rtn_inv, rtn_inv_alt_syn. Every abstraction level has a proper superset of the grammar of every other abstraction level that is lower than itself, so for example any code that is valid code_as_data is also valid plain_rtn_inv, and so on.
Choosing an abstraction level to write Muldis D code against is all a matter of trade-offs, perhaps mainly between advantages for Muldis D implementors and advantages for Muldis D users. Lower levels have benefits such as that it takes less programmer effort to create a Muldis D code parser or generator that just has to support that level, and such a parser/generator could be made more quickly and occupy a smallar resource footprint. On the other side, higher levels have benefits such that any Muldis D code itself can be immensely more terse and readable (and writable), as well as have a much stronger resemblence to typical general-purpose programming languages, which also caries the benefit that a lot more of a programmer's preconceptions about what they should be able to write in a language is more likely to just work in Muldis D, and users can adopt it with less re-training. Essentially, lower abstraction levels are more like machine code while higher levels are more like human language. It may not need to be said that while a lower level may be for a Muldis D implementer an easier thing to make run, it would conversely tend to be more difficult for them to write a test suite for, being more verbose.
It should be emphasized that all catalog abstration levels are completely expressive, and everything a user can do with one, they can do with the others, and code is round-trippable between all of them without loss of behaviour. The choice is simply about the syntax to accomplish something.
Specifying the catalog_abstraction_level pragma in a language_name node is mandatory, since there is no obvious abstraction level to use implicitly when one isn't specified.
the_floor
When the catalog_abstraction_level pragma is the_floor, then the following grammar definitions are in effect:
<value> ::=
<value__the_floor>
<catalog> ::=
<catalog__code_as_data>
<expr> ::=
<value__the_floor>This abstraction level exists more as an academic exercise and is not intended to actually be used. It is meant to be analogous to those academic programming languages whose main design goal, in addition to still being programmatically complete, is to have the absolute smallest grammar at all costs, also analogous to an extreme-RISC machine. This level is like code_as_data except that it has the absolute minimum of value literal syntaxes rather than all of them, essentially just having a single node kind apiece to cover all scalars, tuples, relations. This level is also so minimal that many representation alternatives of the system catalog itself are being ignored, such as the more concise alternatives the system catalog itself provides to represent selectors of set/array/bag values or any system-defined scalar types not in terms of possreps.
Examples:
Muldis_D:"http://muldis.com":0.129.0:PTMD_STD:{
catalog_abstraction_level => the_floor,
op_char_repertoire => basic
}
List:[3,
List:[
List:[1,-4,List:[102,111,111,100]],
List:[1,-4,List:[113,116,121]],
],
List:[
List:[
List:[4,
List:[
List:[1,-4,List:[115,121,115]],
List:[1,-4,List:[115,116,100]],
List:[1,-4,List:[67,111,114,101]],
List:[1,-4,List:[84,121,112,101]],
List:[1,-4,List:[84,101,120,116]],
],
List:[1,-4,List:[110,102,100,95,99,111,100,101,115]],
List:[2,
List:[List:[1,-4,List:[]]],
List:[List:[1,-4,List:[67,97,114,114,111,116,115]]]
]
],
100
],
List:[
List:[4,
List:[
List:[1,-4,List:[115,121,115]],
List:[1,-4,List:[115,116,100]],
List:[1,-4,List:[67,111,114,101]],
List:[1,-4,List:[84,121,112,101]],
List:[1,-4,List:[84,101,120,116]],
],
List:[1,-4,List:[110,102,100,95,99,111,100,101,115]],
List:[2,
List:[List:[1,-4,List:[]]],
List:[List:[1,-4,List:[75,105,119,105,115]]]
]
],
30
]
]
]code_as_data
When the catalog_abstraction_level pragma is code_as_data, then the following grammar definitions are in effect:
<value> ::=
<value__code_as_data>
<catalog> ::=
<catalog__code_as_data>
<expr> ::=
<value__code_as_data>This abstraction level is the best one for when you want to write code in exactly the same form as it would take in the system catalog, and at the same time use all the relatively consise alternatives the system catalog itself provides for value literals and selectors. With this abstraction level, a depot consists simply of a language name plus one or two database value literals. The format for specifying a system catalog is exactly the same as the format for specifying the user data of a database. All a Muldis D parser/generator has to know is how to parse static Muldis D value literals and its done. That said, code_as_data includes all of the special grammar dealing with value literals, including those for many specific scalar or nonscalar types. This level is analogous to a high-level assembly language in a way; what you say in code is exactly what you get in the system catalog, but your code would be too verbose for the tastes of someone preferring normal high-level language code.
Code written to the code_as_data level can employ all of the language grammar constructs described in these main pod sections: "VALUE LITERALS AND SELECTORS", "OPAQUE VALUE LITERALS", "COLLECTION VALUE SELECTORS".
Examples:
Muldis_D:"http://muldis.com":0.129.0:PTMD_STD:{
catalog_abstraction_level => code_as_data,
op_char_repertoire => basic
}
Relation:{
{ food => 'Carrots', qty => 100 },
{ food => 'Kiwis', qty => 30 }
}
Muldis_D:"http://muldis.com":0.129.0:PTMD_STD:{
catalog_abstraction_level => code_as_data,
op_char_repertoire => basic
}
depot-catalog Database:Depot:{
functions => Relation:{
{
name => Name:cube,
material => Tuple:Function:{
result_type => PNSQNameChain:Int,
params => Relation:NameTypeMap:{
{ name => Name:topic, type => PNSQNameChain:Int }
},
expr => Database:ExprNodeSet:{
sca_val_exprs => Relation:{
{ name => Name:INT_3, value => 3 }
},
func_invo_exprs => Relation:{
{
name => Name:"",
function => PNSQNameChain:Integer.power,
args => Relation:NameExprMap:{
{ name => Name:radix, expr => Name:topic },
{ name => Name:exponent, expr => Name:INT_3 }
}
}
}
}
}
}
}
}plain_rtn_inv
When the catalog_abstraction_level pragma is plain_rtn_inv, then the following grammar definitions are in effect:
<value> ::=
<value__code_as_data>
<catalog> ::=
<catalog__plain_rtn_inv>
<expr> ::=
<expr__plain_rtn_inv>
<update_stmt> ::=
<update_stmt__plain_rtn_inv>
<proc_stmt> ::=
<proc_stmt__plain_rtn_inv>This abstraction level is the lowest one that can be recommended for general use, and every Muldis D implementation that is expected to be directly used by programmers (in contrast to its main use just being by way of wrapper APIs or code generators) should support at least this level, even if that implementation is being touted as "minimal". This abstraction level has the simplest grammar that could reasonably be considered as like that of a general purpose programming language. Unlike the code_as_data level, the plain_rtn_inv level makes everything that isn't conceptually a value literal or selector look like typical routine or type declarations or value expressions or statements, just as programmers typically expect.
One of Muldis D's primary features is that, as much as possible, the system-defined language features are defined in terms of ordinary types and routines. This means for one thing that users are empowered to create their own types and routines with all of the capabilities, flexibility, and syntax as the language's built-in features have. This also means that it should be relatively simple to parse Muldis D code because the vast majority of language features don't have their own special syntax to account for, and the "Generic Function Invocation Expressions" syntax covers most of them, in terms of the common prefix/polish notation that in practice most invocations of user-defined routines are formatted as anyway.
The plain_rtn_inv abstraction level is all about having code that looks like general purpose programming language code but that everything looks like user-defined routines and types. The code is mostly just nested invocations of functions or procedures in basic polish notation, and both that code and material declarations have a C-language-like syntax.
It is expected that every Muldis D implementation which supports at least the plain_rtn_inv level will, as much as is reasonably possible, preserve all non-behaviour-affecting metadata that is directly supported for storage by the system catalog itself, as described in "SOURCE CODE METADATA" in Muldis::D::Basics. Primarily this means preserving non-value code comments, and preserving the declared relative ordinal position of code elements.
Code written to the plain_rtn_inv level can employ all of the language grammar constructs that code_as_data can, plus all of those described in these main pod sections: "MATERIAL SPECIFICATION", "GENERIC VALUE EXPRESSIONS", "GENERIC UPDATER OR RECIPE STATEMENTS", "GENERIC PROCEDURE STATEMENTS".
Examples:
Muldis_D:"http://muldis.com":0.129.0:PTMD_STD:{
catalog_abstraction_level => plain_rtn_inv,
op_char_repertoire => basic
}
depot-catalog {
function cube (Int <-- $topic : Int) {
Integer.power( radix => $topic, exponent => 3 )
}
}rtn_inv_alt_syn
When the catalog_abstraction_level pragma is rtn_inv_alt_syn, then the following grammar definitions are in effect:
<value> ::=
<value__code_as_data>
<catalog> ::=
<catalog__plain_rtn_inv>
<expr> ::=
<expr__rtn_inv_alt_syn>
<update_stmt> ::=
<update_stmt__rtn_inv_alt_syn>
<proc_stmt> ::=
<proc_stmt__rtn_inv_alt_syn>This abstraction level is the highest one and is the most recommended one for general use, assuming that all the Muldis D implementations you want to use support it. The expectation is that, in general, minimal Muldis D implementations won't support it but non-minimal ones would, so code written to it may not be the most universally portable as-is but should be portable in most common environments.
In practice a huge payoff of improved user code brevity and readability (and writability) is gained by the rtn_inv_alt_syn abstraction level over the plain_rtn_inv level by adding special syntax for a lot of commonly used built-in routines, such as infix syntax for common math operators or postcircumfix syntax for attribute accessors. The tradeoff for this user code brevity is a significant amount of extra complexity in parsers, due to all the extra special cases, though this complexity can be mitigated somewhat by standardizing these additions in format where possible. These 2 highest levels both look like a general purpose programming language, but rtn_inv_alt_syn is a lot more concise.
In particular, rtn_inv_alt_syn is probably the only Muldis D dialect that conceivably can match or beat the conciseness of a majority of general purpose programming languages, and would probably be the most preferred abstraction level for developers. This fact would also help to drive a majority of implementations to support this greatest complexity level. And even then, this most complex of standard Muldis D grammars still generally has simpler grammar rules than a lot of general languages, even if this difference is more subtle. It certainly is simpler and more easier to parse grammar than SQL in its general case.
Code written to the rtn_inv_alt_syn level can employ all of the language grammar constructs that plain_rtn_inv can, plus all of those described in these main pod sections: "FUNCTION INVOCATION ALTERNATE SYNTAX EXPRESSIONS", "IMPERATIVE INVOCATION ALTERNATE SYNTAX STATEMENTS".
Examples:
Muldis_D:"http://muldis.com":0.129.0:PTMD_STD:{
catalog_abstraction_level => rtn_inv_alt_syn,
op_char_repertoire => basic
}
depot-catalog {
function cube (Int <-- $topic : Int) {
$topic exp 3
}
}OPERATOR CHARACTER REPERTOIRE
The op_char_repertoire pragma determines primarily whether or not the various routine invocation alternate syntaxes, herein called operators, may be composed of only ASCII characters or also other Unicode characters, and this pragma determines secondarily whether or not a few special value literals (effectively nullary operators) composed of non-ASCII Unicode characters may exist.
There are currently 2 specified operator character repertoires: basic, extended. The latter is a proper superset of the former.
The op_char_repertoire pragma is generally orthogonal to the catalog_abstraction_level pragma, so you can combine any value of the latter with any value of the former. However, in practice the operator character repertoire setting will have no effect at all when the catalog abstraction level is the_floor, and it will otherwise have very little effect except when the catalog abstraction level is rtn_inv_alt_syn. To be specific, what the op_char_repertoire pragma primarily affects is special operator call syntaxes provided only by rtn_inv_alt_syn, and what the former secondarily affects is special value literals provided by code_as_data plus greater catalog abstraction levels.
Specifying the op_char_repertoire pragma in a language_name node is mandatory, since there is no obviously best setting to use implicitly when one isn't specified.
basic
The basic operator character repertoire is the smallest one, and it only supports writing the proper subset of defined operator invocations and special value literals that are composed of just 7-bit ASCII characters. This repertoire can be recommended for general use, especially since code written to it should be the most universally portable as-is (with respect to operator character repertoires), including full support even by minimal Muldis D implementations and older text editors.
When the op_char_repertoire pragma is basic, then the following grammar definitions are in effect:
<Singleton_payload> ::=
<Singleton_payload__op_cr_basic>
<Bool_payload> ::=
<Bool_payload__op_cr_basic>
<maybe_Nothing> ::=
<maybe_Nothing__op_cr_basic>
<comm_infix_reduce_op> ::=
<comm_infix_reduce_op__op_cr_basic>
<sym_dyadic_infix_op> ::=
<sym_dyadic_infix_op__op_cr_basic>
<nonsym_dyadic_infix_op> ::=
<nonsym_dyadic_infix_op__op_cr_basic>
<monadic_prefix_op> ::=
<monadic_prefix_op__op_cr_basic>
<dyadic_compare_op> ::=
<dyadic_compare_op__op_cr_basic>
<imp_nonsym_dyadic_infix_op> ::=
<imp_nonsym_dyadic_infix_op__op_cr_basic>extended
The extended operator character repertoire is the largest one, and it supports the entire set of defined operator invocations and special value literals, many of which are composed of Unicode characters outside the 7-bit ASCII repertoire. This is the most recommended repertoire for general use, assuming that all the Muldis D implementations and source code text editors you want to use support it. The expectation is that, in general, minimal Muldis D implementations and older text editors won't support it but non-minimal ones would, so code written to it may not be the most universally portable as-is but should be portable in most common and modern environments.
In practice the main payoff of extended is that user code can exploit the wide range of symbols that Unicode provides which are the canonical means of writing various math or logic or relational et al operators in the wider world, and which programmers would likely have written with all along if it weren't for the large limitations of legacy computer systems which practically forced them to use various approximations instead. While you can always write with ASCII approximations, using extended means you often don't have to, and your code can be a lot more readable as a result, at least to the practitioners of the domains that the symbols come from, and the code is otherwise more terse and arguably appears more attractive.
When the op_char_repertoire pragma is extended, then the following grammar definitions are in effect:
<Singleton_payload> ::=
<Singleton_payload__op_cr_extended>
<Bool_payload> ::=
<Bool_payload__op_cr_extended>
<maybe_Nothing> ::=
<maybe_Nothing__op_cr_extended>
<comm_infix_reduce_op> ::=
<comm_infix_reduce_op__op_cr_extended>
<sym_dyadic_infix_op> ::=
<sym_dyadic_infix_op__op_cr_extended>
<nonsym_dyadic_infix_op> ::=
<nonsym_dyadic_infix_op__op_cr_extended>
<monadic_prefix_op> ::=
<monadic_prefix_op__op_cr_extended>
<dyadic_compare_op> ::=
<dyadic_compare_op__op_cr_extended>
<imp_nonsym_dyadic_infix_op> ::=
<imp_nonsym_dyadic_infix_op__op_cr_extended>STANDARD SYNTAX EXTENSIONS
The standard_syntax_extensions pragma declares which optional portions of the Muldis D grammar a programmer may employ with their Muldis D code.
There are currently no specified standard syntax extensions. These are all mutually independent and any or all may be used at once.
While each standard syntax extension is closely related to a Muldis D language extension, you can use the latter's types and routines without declaring the former; you only declare you are using a standard syntax extension if you want the Muldis D parser to recognize special syntax specific to those types and routines, and otherwise you just use them using the generic syntax provided for all types and routines.
The standard_syntax_extensions pragma is generally orthogonal to the catalog_abstraction_level pragma, so you can combine any value of the latter with any value-list of the former. However, in practice all standard syntax extensions will have no effect when the catalog abstraction level is the_floor, and some of their features may only take effect when the catalog abstraction level is rtn_inv_alt_syn, as is appropriate.
Specifying the standard_syntax_extensions pragma in a language_name node is optional, and when omitted it defaults to the empty set, meaning no extensions may be used.
VALUE LITERALS AND SELECTORS
Grammar:
<value__the_floor> ::=
<Int>
| <List>
<value__code_as_data> ::=
<opaque_value_literal>
| <coll_value_selector>
<opaque_value_literal> ::=
<Singleton>
| <Bool>
| <Order>
| <RoundMeth>
| <Int>
| <Rat>
| <Blob>
| <Text>
| <Name>
| <NameChain>
| <PNSQNameChain>
| <Comment>
| <RatRoundRule>
<coll_value_selector> ::=
<Scalar>
| <Tuple>
| <Database>
| <Relation>
| <Set>
| <Maybe>
| <Array>
| <Bag>
| <SPInterval>
| <MPInterval>
| <List>A value node is a Muldis D value literal, which is a common special case of a Muldis D value selector.
Unlike value selectors in general, which must be composed beneath a depot because they actually represent a Muldis D value expression tree of a function or updater or recipe or type definition, a value node does not represent an expression tree, but rather a value constant; by definition, a value can be completely evaluated at compile time. A Muldis_D node with a value second element is hence just a serialized Muldis D value.
The PTMD_STD grammar subsection for value literals (having the root grammar token value) is completely self-defined and can be used in isolation from the wider grammar as a Muldis D sub-language; for example, a hosted-data Muldis D implementation may have an object representing a Muldis D value, which is initialized using code written in that sub-language.
Every grammar token, and corresponding capture node, representing a Muldis D value literal is similarly formatted and has 1-3 elements; the following pod section "Value Literal Common Elements" describes the similarities once for all of them, in terms of an alternate value token definition which is called x_value. And then the other pod sections specific to each kind of value literal then just focus on describing their unique aspects, namely their payloads.
An opaque_value_literal node represents a conceptually opaque Muldis D value, such that every one of these values is defined with its own literal syntax that is compact and doesn't look like a collection of other nodes; this includes the basic numeric and string literals.
A coll_value_selector node represents a conceptually transparent Muldis D value, such that every one of these values is defined visibly in terms of a collection of other nodes; this includes the basic tuple and relation selectors.
Value Literal Common Elements
A generic context value literal (or GCVL) is a value literal that can be properly interpreted in a context that is expecting a value but has no expectation that said value belongs to a specific data type; in the general case, a GCVL includes explicit value kind metadata (such as, "this is an Int" or "this is a Name"); but with a few specific data types (see the value_kind node description for details) that metadata may be omitted for brevity because the main literal has mutually uniquely identifying characteristics. For example, each element of a generic Muldis D collection value, such as a member of an array or tuple, could potentially have any type at all. In contrast, a specific context value literal (or SCVL) is a value literal that does not include explicit value kind metadata, even when the main literal doesn't have uniquely identifying characteristics, because the context of its use supplies said metadata. For example, in a tuple value literal it is assumed that a value literal in an attribute name position must denote a Name. The grammar token value|x_value denotes a GCVL, as do most short-named grammar tokens, like Int or Name; in contrast, a grammar token containing value_payload denotes a SCVL, like Int_payload or Name_payload.
Every GCVL has 1-3 elements, illustrated by this grammar:
<x_value> ::=
[
<value_kind> ':' <unspace>
[<type_name> ':' <unspace>]?
]?
<value_payload>
<value_kind> ::=
Singleton
| Bool
| Order
| RoundMeth
| Int | NNInt | PInt
| Rat | NNRat | PRat
| Blob | OctetBlob
| Text
| Name
| NameChain
| PNSQNameChain
| Comment
| RatRoundRule
| DH? Scalar
| DH? Tuple
| Database
| DH? Relation
| DH? Set
| DH? [Maybe | Single]
| DH? Array
| DH? Bag
| DH? SPInterval
| DH? MPInterval
| List
<type_name> ::=
<PNSQNameChain_payload>
<value_payload> ::=
<Singleton_payload>
| <Bool_payload>
| <Order_payload>
| <RoundMeth_payload>
| <Int_payload>
| <Rat_payload>
| <Blob_payload>
| <Text_payload>
| <Name_payload>
| <NameChain_payload>
| <PNSQNameChain_payload>
| <Comment_payload>
| <RatRoundRule_payload>
| <Scalar_payload>
| <Tuple_payload>
| <Database_payload>
| <Relation_payload>
| <Set_payload>
| <Maybe_payload>
| <Array_payload>
| <Bag_payload>
| <SPInterval_payload>
| <MPInterval_payload>
| <List_payload>So a x_value|value node has 1-3 elements in general:
value_kind-
This is a character string of the format
<[A..Z]> <[ a..z A..Z ]>+; it identifies the data type of the value literal in broad terms and is the only external metadata ofvalue_payloadgenerally necessary to interpret the latter; what grammars are valid forvalue_payloaddepend just onvalue_kind.For all values of just the 9 data types [
Singleton,Bool,Order,RoundMeth,Int,Rat,Blob,Text,Comment], thevalue_kindportion of a GCVL may be omitted for brevity, but the code parser should still be able to infer it easily by examining the first few characters of thevalue_payload, which for each of said 9 data types has a mutually uniquely identifying format, which is also distinct from all possiblevalue_kind. Note that omission ofvalue_kindis only allowed when the GCVL doesn't include atype_nameelement.For just these certain special values of other data types, the same option of omitting the
value_kind(andtype_name) applies:Tuple:D0,Relation:D0C0,Relation:D0C1,Maybe:Nothing. type_name-
This is a Muldis D data type name, for example
sys.std.Core.Type.Int; it identifies a specific subtype of the generic type denoted byvalue_kind, and serves as an assertion that the Muldis D value denoted byvalue_payloadis a member of the named subtype. Iffvalue_kindis[|DH]Scalarthentype_nameis mandatory; otherwise,type_nameis optional for allvalue, except thattype_namemust be omitted whenvalue_kindis one of the 3 [Singleton,Bool,Order]; this isn't because those 3 types can't be subtyped, but because in practice doing so isn't useful.How a Muldis D parser treats a
valuenode with atype_nameelement depends on the wider context. In the general case where thevalueis anexprbeneath the context of adepotnode, thevalueis treated as if it had an extra parentfunc_invonode that invokes thetreatedfunction and whose 2 argument nodes are as follows:topicgets thevaluewithout thetype_nameelement, andasgets thetype_nameelement. This means that in general thetype_nameassertion is done at runtime. In the common special case where bothvalueis anopaque_value_literalandtype_namerefers to a system-defined type, then thetype_nameassertion is done at compile time, and then thetype_nameelement is simply eliminated, so thevalueends up simply as itself with no newfunc_invoparent.In another common special case, iff a
valuenode with atype_nameelement is acoll_value_selectorand itstype_namenames a system-defined tuple type or relation type with a specified set of attributes, then the parser will automatically generate any missing attribute values of thevaluenode, where each has the default value of its declared type as pertype_name. This will be done prior to the other use oftype_namewhich applies a constraint, so the latter acts as if the original code had specified the missing attributes. In the case of the type being a relation type, the relation value literal doesn't even need to be well-formed (have the attributes per tuple) in the code, as the attribute generation is done per tuple. Since it only works for system-defined types, this special case is primarily useful for code involving values that represent code. value_payload-
This is mandatory for all
value.
For GCVL and SCVL examples, see the subsequent documentation sections.
OPAQUE VALUE LITERALS
See also the definition of the catalog data type sys.std.Core.Type.Cat.OVLScaValExprNodeSet, a tuple of which is what every kind of opaque_value_literal node distills to when it is beneath the context of a depot node, as it describes some semantics.
Singleton Literals
Grammar:
<Singleton> ::=
[Singleton ':' <unspace>]?
<Singleton_payload>
<Singleton_payload__op_cr_basic> ::=
'-Inf' | Inf
<Singleton_payload__op_cr_extended> ::=
<Singleton_payload__op_cr_basic>
| '-∞' | '∞'A Singleton node represents a value of any of the singleton scalar types that sys.std.Core.Type.Cat.Singleton is a union over.
Some of the keywords are aliases for each other:
keyword | aliases
--------+--------
-Inf | -∞
Inf | ∞These are the singleton types corresponding to the keywords:
-Inf -> sys.std.Core.Type.Cat."-Inf"
Inf -> sys.std.Core.Type.Cat.InfExamples:
Singleton:-Inf
∞Boolean Literals
Grammar:
<Bool> ::=
[Bool ':' <unspace>]?
<Bool_payload>
<Bool_payload__op_cr_basic> ::=
False | True
<Bool_payload__op_cr_extended> ::=
<Bool_payload__op_cr_basic>
| ⊥ | ⊤A Bool node represents a logical boolean value. It is interpreted as a Muldis D sys.std.Core.Type.Bool value as follows: The Bool_payload is a bareword character string formatted as per a Name SCVL, and it maps directly to the matching unqualified declared name of one of the Bool.* singleton types that the Bool type is defined as a union over.
Some of the keywords are aliases for each other:
keyword | aliases
--------+--------
False | ⊥
True | ⊤Examples:
Bool:True
False
⊤
⊥Order-Determination Literals
Grammar:
<Order> ::=
[Order ':' <unspace>]?
<Order_payload>
<Order_payload> ::=
Increase | Same | DecreaseAn Order node represents an order-determination. It is interpreted as a Muldis D sys.std.Core.Type.Cat.Order value as follows: The Order_payload is a bareword character string formatted as per a Name SCVL, and it maps directly to the matching unqualified declared name of one of the Order.* singleton types that the Order type is defined as a union over.
Examples:
Order:Same
DecreaseRounding Method Literals
Grammar:
<RoundMeth> ::=
[
RoundMeth ':' <unspace>
[<type_name> ':' <unspace>]?
]?
<RoundMeth_payload>
<RoundMeth_payload> ::=
Down | Up | ToZero | ToInf
| HalfDown | HalfUp | HalfToZero | HalfToInf
| HalfEvenA RoundMeth node represents a rounding method. It is interpreted as a Muldis D sys.std.Core.Type.Cat.RoundMeth value as follows: The RoundMeth_payload is a bareword character string formatted as per a Name SCVL, and it maps directly to the matching unqualified declared name of one of the RoundMeth.* singleton types that the RoundMeth type is defined as a union over.
Examples:
RoundMeth:HalfUp
ToZeroGeneral Purpose Integer Numeric Literals
Grammar:
<Int> ::=
[
[Int | NNInt | PInt] ':' <unspace>
[<type_name> ':' <unspace>]?
]?
<Int_payload>
<Int_payload> ::=
<num_max_col_val> ';' <unspace> <int_body>
| <d_int_body>
<num_max_col_val> ::=
<pint_head>
<int_body> ::=
0 | '-'?<pint_body>
<nnint_body> ::=
0 | <pint_body>
<pint_body> ::=
<pint_head> <pint_tail>?
<pint_head> ::=
<[ 1..9 A..Z ]>
<pint_tail> ::=
[[_?<[ 0..9 A..Z ]>+]+] ** <unspace>
<d_int_body> ::=
0 | '-'?<d_pint_body>
<d_nnint_body> ::=
0 | <d_pint_body>
<d_pint_body> ::=
<d_pint_head> <d_pint_tail>?
<d_pint_head> ::=
<[ 1..9 ]>
<d_pint_tail> ::=
[[_?<[ 0..9 ]>+]+] ** <unspace>An Int node represents an integer numeric value. It is interpreted as a Muldis D sys.std.Core.Type.Int value as follows:
If the Int_payload is composed of a num_max_col_val plus int_body, then the int_body is interpreted as a base-N integer where N might be between 2 and 36, and the num_max_col_val says which possible value of N to use. Assuming all int_body column values are between zero and N-minus-one, the num_max_col_val contains that N-minus-one. So to specify, eg, bases [2,8,10,16], use num_max_col_val of [1,7,9,F].
If the Int_payload is a d_int_body, then it is interpreted as a base 10 integer.
Fundamentally the body part of an Int node consists of a string of digits and uppercased (but not lowercased) letters, where each digit (0..9) represents its own number and each letter (A..Z) represents a number in [10..35]. A body may optionally contain underscore characters (_), which exist just to help with visual formatting, such as for 10_000_000, and these are ignored/stripped by the parser. A body may optionally be split into 1..N segments where each pair of consecutive segments is separated by an unspace token, which is a pair of backslashes (\) surrounding an optional run of whitespace; this segmenting ability is provided to support code that contains very long numeric literals while still being well formatted (no extra long lines); the unspace tokens are also ignored/stripped by the parser, and the body is interpreted as if all its alphanumeric characters were contiguous.
If the value_kind of a value node is NNInt or PInt rather than Int, then the value node is interpreted simply as an Int node whose type_name is NNInt or PInt, and the allowed body is appropriately further restricted.
Examples:
Int:1;11001001 # binary #
7;0 # octal #
7;644 # octal #
-34 # decimal #
42 # decimal #
F;DEADBEEF # hexadecimal #
Z;-HELLOWORLD # base-36 #
3;301 # base-4 #
B;A09B # base-12 #General Purpose Rational Numeric Literals
Grammar:
<Rat> ::=
[
[Rat | NNRat | PRat] ':' <unspace>
[<type_name> ':' <unspace>]?
]?
<Rat_payload>
<Rat_payload> ::=
<num_max_col_val> ';' <unspace> <rat_body>
| <d_rat_body>
<rat_body> ::=
<int_body> <unspace> '.' <pint_tail>
| <int_body> <unspace> '/' <pint_body>
| <int_body> <unspace> '*' <pint_body> <unspace> '^' <int_body>
<d_rat_body> ::=
<d_int_body> <unspace> '.' <d_pint_tail>
| <d_int_body> <unspace> '/' <d_pint_body>
| <d_int_body> <unspace> '*' <d_pint_body>
<unspace> '^' <d_int_body>A Rat node represents a rational numeric value. It is interpreted as a Muldis D sys.std.Core.Type.Rat value as follows:
Fundamentally a Rat node is formatted and interpreted like an Int node, and any similarities won't be repeated here. The differences of interpreting a Rat_payload being composed of a num_max_col_val plus rat_body versus the Rat_payload being a d_rat_body are as per the corresponding differences of interpreting an Int_payload. Also interpreting a NNRat or PRat is as per a NNInt or PInt.
If the body part of a Rat node contains a radix point (.), then it is interpreted as is usual for a programming language with such a literal.
If the body part of a Rat node contains a solidus (/), then the rational's value is interpreted as the leading integer (a numerator) divided by the trailing positive integer (a denominator); that is, the two integers collectively map to the ratio possrep of the Rat type.
If the body part of a Rat node contains a asterisk (*) plus a circumflex accent (^), then the rational's value is interpreted as the leading integer (a mantissa) multiplied by the result of the middle positive integer (a radix) taken to the power of the trailing integer (an exponent); that is, the three integers collectively map to the float possrep of the Rat type.
Examples:
Rat:1;-1.1
-1.5 # same val as prev #
3.14159
A;0.0
F;DEADBEEF.FACE
Z;0.000AZE
Rat:6;500001/1000
B;A09B/A
Rat:1;1011101101*10^-11011
45207196*10^37
1/43
314159*10^-5General Purpose Binary String Literals
Grammar:
<Blob> ::=
[
[Blob | OctetBlob] ':' <unspace>
[<type_name> ':' <unspace>]?
]?
<Blob_payload>
<Blob_payload> ::=
<blob_max_col_val> ';' <unspace> <blob_body>
<blob_max_col_val> ::=
<[137F]>
<blob_body> ::=
'\''
[<[ 0..9 A..F ]> | <unspace>]*
'\''A Blob node represents a general purpose bit string. It is interpreted as a Muldis D sys.std.Core.Type.Blob value as follows: Fundamentally the body part of a Blob node consists of a delimited string of digits and uppercased (but not lowercased) letters, where each digit (0..9) represents its own number and each letter (A..F) represents a number in [10..15]; this string is qualified with a blob_max_col_val character ([137F]), similarly to how an int_body is qualified by a num_max_col_val. Each character of the delimited string specifies a sequence of one of [1,2,3,4] bits, depending on whether blob_max_col_val is [1,3,7,F]. If the value_kind of a value node is OctetBlob rather than Blob, then the value node is interpreted simply as a Blob node whose type_name is OctetBlob, and the delimited string is appropriately further restricted.
Examples:
Blob:1;'00101110100010' # binary #
3;''
F;'A705E' # hexadecimal #
7;'523504376'General Purpose Character String Literals
Grammar:
<Text> ::=
[
Text ':' <unspace>
[<type_name> ':' <unspace>]?
]?
<Text_payload>
<Text_payload> ::=
'\''
[<-[\\\'\t\n\f\r]> | <escaped_char> | <unspace>]*
'\''
<escaped_char> ::=
'\b' | '\a' | '\q' | '\g' | '\h'
| '\s'
| '\t' | '\n' | '\f' | '\r'
| '\c<' [
[<[ A..Z ]>+] ** ' '
| [0 | <[ 1..9 ]> <[ 0..9 ]>*]
| <[ 1..9 A..Z ]> ';' [0 | <[ 1..9 A..Z ]> <[ 0..9 A..Z ]>*]
] '>'
<unspace> ::=
'\\' <ws> '\\'
<ws> ::=
<[\ \t\n\f\r]>+A Text node represents a general purpose character string. It is interpreted as a Muldis D sys.std.Core.Type.Text value as follows:
The Text_payload is interpreted generally as is usual for a programming language with such a delimited character string literal.
A Text_payload may optionally be split into 1..N segments where each pair of consecutive segments is separated by an unspace token, which is a pair of backslashes (\) surrounding an optional run of whitespace; this segmenting ability is provided to support code that contains long value literals while still being well formatted (no extra long lines); the unspace tokens are ignored/stripped by the parser, and the Text_payload is interpreted as if it just consisted of the rest of the delimited string contiguously.
All Muldis D delimited character string literals (generally the 3 Text, Name, Comment) may contain some characters denoted with escape sequences rather than literally. The Muldis D parser would substitute the escape sequences with the characters they represent, so the resulting character string values don't contain those escape sequences. Currently there are 2 classes of escape sequences, called simple and complex.
The meanings of the simple escape sequences are:
Esc | Unicode | Unicode | Chr | Literal character used
Seq | Codepoint | Character Name | Lit | for when not escaped
----+-----------+-----------------+-----+------------------------------
\b | F;5C | REVERSE SOLIDUS | \ | esc seq lead (aka backslash)
\a | F;27 | APOSTROPHE | ' | delim Text literals
\q | F;22 | QUOTATION MARK | " | delim quoted Name literals
\g | F;60 | GRAVE ACCENT | ` | delim as-val Comment literals
\h | F;23 | NUMBER SIGN | # | dlm no-val Comment (aka hash)
\s | F;20 | SPACE | | space char
\t | F;9 | CHAR... TAB... | | control char horizontal tab
\n | F;A | LINE FEED (LF) | | ctrl char line feed / newline
\f | F;C | FORM FEED (FF) | | control char form feed
\r | F;D | CARR. RET. (CR) | | control char carriage returnOne design decision of PTMD_STD that is distinct from typical other languages is that an escape sequence for any character used as a delimiter never contains that literal character. For example, while in SQL or Perl character strings delimited by ', they typically escape literal apostrophes/single-quotes as '' or \'; while this is unambiguous, the task of parsing such code is considerably more difficult than it could be. In contrast, while in PTMD_STD character strings delimited by ', a literal of the same is escaped with \a; so parsing such code is an order of magnitude easier because the parser doesn't have to understand the internals of any character string literal in order to separate out the character string from its surrounding code.
Another design decision of PTMD_STD that is distinct at least from Perl is that non-"space" whitespace characters in character string literals must never appear literally (except within an unspace token), but must instead be denoted with escape sequences. The main reason for this is to ensure that the actual values being selected by the string literals were not variable per the kind of linebreaks used to format the Muldis D source code itself.
There is currently just one complex escape sequence, of the format \c<...>, that supports specifying characters in terms of their Unicode abstract codepoint name or number. If the ... consists of just uppercased (not lowercased) letters and the space character, then the ... is interpreted as a Unicode character name. If the ... looks like an Int_payload, sans that underscores and unspace aren't allowed here, then the ... is interpreted as a Unicode abstract codepoint number. One reason for this feature is to empower more elegant passing of Unicode-savvy PTMD_STD source code through a communications channel that is more limited, such as to 7-bit ASCII.
Examples:
Text:'Ceres'
'サンプル'
''
'Perl'
'\c<LATIN SMALL LETTER OU>\c<F;263A>\c<65>'DBMS Entity Name Literals
Grammar:
<Name> ::=
Name ':' <unspace>
[<type_name> ':' <unspace>]?
<Name_payload>
<Name_payload> ::=
<nonquoted_name_str> | <quoted_name_str>
<nonquoted_name_str> ::=
<[ a..z A..Z _ ]><[ a..z A..Z 0..9 _ - ]>*
<quoted_name_str> ::=
'"'
[<-[\\\"\t\n\f\r]> | <escaped_char> | <unspace>]*
'"'
<NameChain> ::=
NameChain ':' <unspace>
[<type_name> ':' <unspace>]?
<NameChain_payload>
<NameChain_payload> ::=
<nc_nonempty> | <nc_empty>
<nc_nonempty> ::=
<Name_payload> ** [<unspace> '.']
<nc_empty> ::=
'[]'
<PNSQNameChain> ::=
PNSQNameChain ':' <unspace>
[<type_name> ':' <unspace>]?
<PNSQNameChain_payload>
<PNSQNameChain_payload> ::=
<nc_nonempty>A Name node represents a canonical short name for any kind of DBMS entity when declaring it; it is a character string type, that is disjoint from Text. It is interpreted as a Muldis D sys.std.Core.Type.Cat.Name value as follows:
Fundamentally a Name node is formatted and interpreted like a Text node, and any similarities won't be repeated here. Unlike a Text_payload literal which must always be delimited, a Name_payload has 2 variants, one delimited (quoted_name_str) and one not (nonquoted_name_str). The delimited Name_payload form differs from Text_payload only in that the string is delimited by double-quotes rather than apostrophes/single-quotes.
A nonquoted_name_str is composed of a single alphabetic or underscore character followed by zero or more characters that are each alphanumeric or underscore or hyphen. It can not be segmented, so you will have to use the quoted_name_str equivalent if you want a segmented string. The definitions of alphabetic and numeric in this context are expressly limited to the ASCII repertoire, for various reasons including simplicity and a better degree of security; if you want to include any other Unicode alphanumeric characters, you will have to use a quoted_name_str.
A NameChain node represents a canonical long name for invoking a DBMS entity in some contexts; it is conceptually a sequence of entity short names. This node is interpreted as a Muldis D sys.std.Core.Type.Cat.NameChain value as follows: A NameChain_payload has 2 variants, one that defines a nonempty chain (nc_nonempty) and one that defines an empty chain (nc_empty). A nc_nonempty consists of a sequence of 1 or more Name_payload where the elements of the sequence are separated by period (.) tokens; each element of the sequence, in order, defines an element of the array possrep's attribute of the result NameChain value. A nc_empty consists simply of the special syntax of [].
Fundamentally a PNSQNameChain node is exactly the same as a NameChain node in format and interpretation, with the primary difference being that it may only define NameChain values that are also values of the proper subtype sys.std.Core.Type.Cat.PNSQNameChain, all of which are nonempty chains. Now that distinction alone wouldn't be enough rationale to have these 2 distinct node kinds, and so the secondary difference between the 2 provides that rationale; the PNSQNameChain node supports a number of chain value shorthands while the NameChain node supports none.
Strictly speaking, a Muldis D PNSQNameChain value is supposed to have at least 1 element in its sequence, and the first element of any sequence must be one of these 5 Name values, which is a top-level namespace: sys, mnt, fed, nlx, rtn. (Actually, type is a 6th option, but that will be treated separately in this discussion.) In the general case, a PNSQNameChain_payload must be written out in full, so it is completely unambiguous (and is clearly self-documenting), and it is always the case that a PNSQNameChain value in the system catalog is written out in full. But the PTMD_STD grammar also has a few commonly used special cases where a PNSQNameChain_payload may be a much shorter substring of its complete version, such that a simple parser, with no knowledge of any user-defined entities besides said shorter PNSQNameChain_payload in isolation, can still unambiguously resolve it to its complete version; exploiting these typically makes for code that is a lot less verbose, and much easier to write or read.
The first special case involves any context where a type or routine is being referenced by name. In such a context, when the referenced entity is a standard system-defined type or routine, programmers may omit any number of consecutive leading chain elements from such a PNSQNameChain_payload, so long as the remaining unqualified chain is distinct among all standard system-defined (sys.std-prefix) DBMS entities (but that as an exception, a non-distinct abbreviation is allowed iff exactly 1 of the candidate entities is in the language core, sys.std.Core-prefix, in which case that 1 is unambiguously the entity that is resolved to; or, when more than 1 of the candidate entities is in the language core, and iff exactly 1 of those in-core candidates is a virtual routine and all of the other in-core candidates are routines that implement said virtual routine either directly or indirectly, then a non-distinct abbreviation is allowed and that 1 virtual is unambiguously the entity that is resolved to). For any system-defined entities whose names have trailing empty-string chain elements, those elements are ignored when determining a match for a PNSQNameChain_payload, similarly to how specifying those elements is not required in a fully-qualified PNSQNameChain to resolve it. This feature has no effect on the namespace prefixes like type or tuple_from or array_of; one still writes those as normal prepended to the otherwise shortened chains. When a PNSQNameChain_payload, whose context indicates it is a type or routine invocation, is encountered by the parser, and its existing first chain element isn't one of the other 6 top-level namespaces, then the parser will assume it is an unqualified chain in the sys namespace and lookup the best / only match from the known sys.std DBMS entities, to resolve to. So for example, one can just write Int rather than sys.std.Core.Type.Int, Array rather than sys.std.Core.Type.Array."", is_identical rather than sys.std.Core.Universal.is_identical, Tuple.attr rather than sys.std.Core.Tuple.attr, fetch_curr_instant rather than sys.std.Temporal.Instant.fetch_curr_instant, array_of.Rat rather than array_of.sys.std.Core.Type.Rat, and so on. In fact, the Muldis D spec itself uses such abbreviations frequently.
The second special case involves any context where a type is being referenced using the type namespace prefix feature described in "Referencing Data Types" in Muldis::D::Basics. In such a context, when the namespace prefix contains either of the optional chain elements [|dh_]tuple_from or [|dh_][set|maybe|single|array|bag|[s|m]p_interval]_of, programmers may omit the single prefix-leading type chain element. So for example, one can just write array_of.Rat rather than type.array_of.Rat, or tuple_from.var.nlx.myrelvar rather than type.tuple_from.var.nlx.myrelvar. This second special case is completely orthogonal to which of the 5 normal top-level namespaces is in use (implicitly or explicitly) by the chain being prefixed, and works for all 5 of them.
Examples:
Name:login_pass
Name:"First Name"
NameChain:gene.sorted_person_name
NameChain:stats."samples by order"
NameChain:[]
PNSQNameChain:fed.data.the_db.gene.sorted_person_names
PNSQNameChain:fed.data.the_db.stats."samples by order"Code Comment Literals
Grammar:
<Comment> ::=
[
Comment ':' <unspace>
[<type_name> ':' <unspace>]?
]?
<Comment_payload>
<Comment_payload> ::=
'`'
[<-[\\\`\t\n\f\r]> | <escaped_char> | <unspace>]*
'`'
<non_value_comment> ::=
[
'#' ** 2..*
| '#' ' '*
[<-[\\\#\t\n\f\r]> | <escaped_char> | <unspace>]*
' '* '#'
] ** <ws>A Comment node represents the text of a Muldis D code comment; it is a character string type, that is disjoint from both Text and Name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.Comment value as follows:
Fundamentally a Comment node is formatted and interpreted like a Text node, and any similarities won't be repeated here. The Comment_payload differs from Text_payload only in that the string is delimited by backticks/grave-accents (`) rather than apostrophes/single-quotes.
A non_value_comment node is also interpreted as a Muldis D sys.std.Core.Type.Cat.Comment value in essentially the same way as a Comment, but for a few formatting differences described further below. The primary reason for both Comment and non_value_comment to exist is so that code comments can be placed in Muldis D code in very different ways without there being any confusion on interpretation.
A Comment node is used when the comment is normal data that is an integral part of the Muldis D code proper, same as every part of the code that isn't a comment, such as when the comment is an expr or value node.
A non_value_comment node, in contrast, is strictly not part of the code proper; Muldis D code can contain these almost anywhere as metadata for the code, and in large part it is treated as if it were part of the insignificant whitespace; that all being said, generally speaking any non_value_comment is retained in the parse tree adjusted to live in the contextually nearest place where a resulting system catalog node has a scm_comment attribute. Details of determining the contextually nearest place for these comments to go is pending.
Syntactically, a non_value_comment node differs from Comment_payload only in that each string segment is delimited by number-signs/hash-marks rather than backticks/grave-accents, and also that:
Note that any leading or trailing space (F;20) characters inside the # delimiters of a non_value_comment are also part of the delimiters, and are not part of the selected Comment value; if you want to denote a Comment value with leading or trailing space chars, you must write those space chars in an escaped form such as with \s.
Note that a run of 3+ # is equivalent to exactly 2 adjacent ones, which denotes an empty comment segment. This feature exists to empower things like making visual dividing lines in the code just out of hash-marks.
Note that the hash-mark does have other uses in PTMD_STD code besides delimiting comments, so since non_value_comment may conceptually be placed almost anywhere in code, the other parts of the grammar that specifically enable this need to ensure appropriate measures are taken to avoid ambiguity, for example mandating that the comments are bounded by whitespace.
Examples (the first 2 are as values, the third is not as a value):
Comment:`This does something.`
`So does this.`
# And also this. #Rational Rounding Rule Literals
Grammar:
<RatRoundRule> ::=
RatRoundRule ':' <unspace>
[<type_name> ':' <unspace>]?
<RatRoundRule_payload>
<RatRoundRule_payload> ::=
'[' <ws>?
<radix> <ws>? ',' <ws>? <min_exp> <ws>? ',' <ws>? <round_meth>
<ws>? ']'
<radix> ::=
<Int_payload>
<min_exp> ::=
<Int_payload>
<round_meth> ::=
<RoundMeth_payload>A RatRoundRule node represents a rational rounding rule. It is interpreted as a Muldis D sys.std.Core.Type.Cat.RatRoundRule value whose attributes are defined by the RatRoundRule_payload. A RatRoundRule_payload consists mainly of a bracket-delimited sequence of 3 comma-separated elements, which correspond in order to the 3 attributes: radix (a PInt2_N), min_exp (an Int), and round_meth (a RoundMeth). Each of radix and min_exp must qualify as a valid Int_payload, and round_meth must qualify as a valid RoundMeth_payload.
Examples:
RatRoundRule:[10,-2,HalfEven]
RatRoundRule:[2,-7,ToZero]COLLECTION VALUE SELECTORS
Note that, with each of the main value selector nodes documented in this main POD section (members of coll_value_selector etc), any occurrences of child expr nodes should be read as being value nodes instead in contexts where instances of the main nodes are being composed beneath value nodes. That is, any expr node options beyond what value options exist are only valid within a depot node.
Scalar Selectors
Grammar:
<Scalar> ::=
DH? Scalar ':' <unspace>
<type_name> ':' <unspace>
<Scalar_payload>
<Scalar_payload> ::=
<possrep_name> ';' <unspace> <possrep_attrs>
| <possrep_attrs>
<possrep_name> ::=
<Name_payload>
<possrep_attrs> ::=
<tuple_list>A Scalar node represents a literal or selector invocation for a not-Int|String scalar subtype value. It is interpreted as a Muldis D sys.std.Core.Type.Scalar subtype value whose declared type is specified by the node's (mandatory for Scalar) type_name and whose attributes are defined by the Scalar_payload. If the Scalar_payload is just a possrep_attrs, then it is interpreted as if it also had an explicit possrep_name that is the empty string. The possrep_attrs is interpreted specifically as attributes of the declared type's possrep which is specified by the possrep_name. Each name+expr pair of the possrep_attrs defines a named possrep attribute of the new scalar; the pair's name and expr specify, respectively, the possrep attribute name, and the possrep attribute value. If the value_kind of a value node is DHScalar rather than Scalar, then the value node is interpreted simply as a Scalar node that is appropriately further restricted; the type_name must name a DHScalar subtype, and the possrep_attrs must specify only deeply homogeneous typed attribute values.
See also the definition of the catalog data type sys.std.Core.Type.Cat.ScaSelExprNodeSet, a tuple of which is what a Scalar node distills to when it is beneath the context of a depot node, as it describes some semantics.
Examples:
Scalar:Name:{ "" => 'the_thing' }
Scalar:Rat:float;{
mantissa => 45207196,
radix => 10,
exponent => 37
}
Scalar:fed.lib.the_db.UTCDateTime:datetime;{
year => 2003,
month => 10,
day => 26,
hour => 1,
minute => 30,
second => 0.0
}
Scalar:fed.lib.the_db.WeekDay:name;{
"" => "monday"
}
Scalar:fed.lib.the_db.WeekDay:number;{
"" => 5
}Tuple Selectors
Grammar:
<Tuple> ::=
DH? Tuple ':' <unspace>
[<type_name> ':' <unspace>]?
<Tuple_payload>
<Tuple_payload> ::=
<tuple_list> | <tuple_D0>
<tuple_list> ::=
'{' <ws>?
[[<nonord_atvl> | <same_named_nonord_atvl>]
** [<ws>? ',' <ws>?]]?
<ws>? '}'
<nonord_atvl> ::=
<attr_name> <ws>? '=>' <ws>? <expr>
<attr_name> ::=
<Name_payload>
<same_named_nonord_atvl> ::=
<data_sigil> <pair_cosigil> <attr_name>
<pair_cosigil> ::=
'>'
<tuple_D0> ::=
D0A Tuple node represents a literal or selector invocation for a tuple value. It is interpreted as a Muldis D sys.std.Core.Type.Tuple value whose attributes are defined by the Tuple_payload.
Iff the Tuple_payload is a tuple_list then each name+expr pair (nonord_atvl) of the Tuple_payload defines a named attribute of the new tuple; the pair's name and expr specify, respectively, the attribute name, and the attribute value. If the value_kind of a value node is DHTuple rather than Tuple, then the value node is interpreted simply as a Tuple node that is appropriately further restricted; the Tuple_payload must specify only deeply homogeneous typed attribute values.
Iff the Tuple_payload is a tuple_D0 then the Tuple node is interpreted as the special value Tuple:D0 aka D0, which is the only Tuple value with exactly zero attributes. Note that this is just an alternative syntax, as tuple_list can select that value too.
A special shorthand for nonord_atvl also exists, same_named_nonord_atvl, which may be used only if the expr of the otherwise-nonord_atvl is an expr_name and that expr_name is identical to the attr_name. In this situation, the identical name can be specified just once, which is the shorthand; for example, the attribute foo => $foo may alternately be written out as $>foo (the > being meant to evoke the =>). This shorthand is to help with the possibly common situation where attributes of a tuple (or relation or scalar) selection are being valued from same-named expression nodes / etc. (This shorthand is like Perl 6's :$a being short for a => $a.)
See also the definition of the catalog data type sys.std.Core.Type.Cat.TupSelExprNodeSet, a tuple of which is what a Tuple node distills to when it is beneath the context of a depot node, as it describes some semantics.
Examples:
Tuple:{}
Tuple:D0 # same as previous #
D0 # same as previous #
Tuple:type.tuple_from.var.fed.data.the_db.account.users:{
login_name => 'hartmark',
login_pass => 'letmein',
is_special => True
}
Tuple:{
name => 'Michelle',
age => 17
}
Tuple:{ w => 'foo', $>x, y => 4, $>z }Database Selectors
Grammar:
<Database> ::=
Database ':' <unspace>
[<type_name> ':' <unspace>]?
<Database_payload>
<Database_payload> ::=
<Tuple_payload>A Database node represents a literal or selector invocation for a 'database' value. It is interpreted as a Muldis D sys.std.Core.Type.Database value whose attributes are defined by the Database_payload. Each name+relation pair of the Database_payload defines a named attribute of the new 'database'; the pair's name and relation specify, respectively, the attribute name, and the attribute value. While this grammar mentions that Database_payload is a Tuple_payload, it is in fact significantly further restricted, such that every attribute value of the Database can only be a DHRelation.
See also the definition of the catalog data type sys.std.Core.Type.Cat.TupSelExprNodeSet, a tuple of which is what a Database node distills to same as when Tuple does.
Relation Selectors
Grammar:
<Relation> ::=
DH? Relation ':' <unspace>
[<type_name> ':' <unspace>]?
<Relation_payload>
<Relation_payload> ::=
<r_empty_body_payload>
| <r_nonordered_attr_payload>
| <r_ordered_attr_payload>
| <relation_D0>
<r_empty_body_payload> ::=
'{' <ws>?
[<attr_name> ** [<ws>? ',' <ws>?]]?
<ws>? '}'
<r_nonordered_attr_payload> ::=
'{' <ws>?
[<tuple_list> ** [<ws>? ',' <ws>?]]?
<ws>? '}'
<r_ordered_attr_payload> ::=
'[' <ws>?
[<attr_name> ** [<ws>? ',' <ws>?]]?
<ws>? ']'
';' <unspace>
'{' <ws>?
[<ordered_tuple_attrs> ** [<ws>? ',' <ws>?]]?
<ws>? '}'
<ordered_tuple_attrs> ::=
'[' <ws>?
[<expr> ** [<ws>? ',' <ws>?]]?
<ws>? ']'
<relation_D0> ::=
D0C0 | D0C1A Relation node represents a literal or selector invocation for a relation value. It is interpreted as a Muldis D sys.std.Core.Type.Relation value whose attributes and tuples are defined by the Relation_payload, which is interpreted as follows:
Iff the Relation_payload is composed of just a nonord_list_[open|close] pair with zero elements between them, then it defines the only relation value having zero attributes and zero tuples.
Iff the Relation_payload is a r_empty_body_payload with at least one attr_name element, then it defines the attribute names of a relation having zero tuples.
Iff the Relation_payload is a r_nonordered_attr_payload with at least one tuple_list element, then each element defines a tuple of the new relation; every tuple_list must define a tuple of the same degree and have the same attribute names as its sibling tuple_list; these are the degree and attribute names of the relation as a whole, which is its heading for the current purposes.
Iff the Relation_payload is a r_ordered_attr_payload, then: The new relation value's attribute names are defined by the attr_name elements, and the relation body's tuples' attribute values are defined by the ordered_tuple_attrs elements. This format is meant to be the most compact of the generic relation selector formats, as the attribute names only appear once for the relation rather than repeating for each tuple. As a trade-off, the attribute values per tuple from all of the ordered_tuple_attrs elements must appear in the same order as their corresponding attribute names appear in the collection of attr_name elements, as the names and values in the relation literal are matched up by ordinal position here.
Iff the Relation_payload is a relation_D0 then the Relation node is interpreted as one of the 2 special values Relation:d[0|1] aka d[0|1], which are the only Relation values with exactly zero attributes. Note that this is just an alternative syntax, as other Relation_payload formats can select those values too.
If the value_kind of a value node is DHRelation rather than Relation, then the value node is interpreted simply as a Relation node that is appropriately further restricted; the Relation_payload specify only deeply homogeneous typed attribute values.
See also the definition of the catalog data type sys.std.Core.Type.Cat.RelSelExprNodeSet, a tuple of which is what a Relation node distills to when it is beneath the context of a depot node, as it describes some semantics.
Examples:
Relation:{} # zero attrs + zero tuples #
Relation:D0C0 # same as previous #
Relation:{ x, y, z } # 3 attrs + zero tuples #
Relation:{ {} } # zero attrs + 1 tuple #
D0C1 # same as previous #
Relation:{
{
login_name => 'hartmark',
login_pass => 'letmein',
is_special => True
}
} # 3 attrs + 1 tuple #
Relation:fed.lib.the_db.gene.Person:[ name, age ];{
[ 'Michelle', 17 ]
} # 2 attrs + 1 tuple #Set Selectors
Grammar:
<Set> ::=
DH? Set ':' <unspace>
[<type_name> ':' <unspace>]?
<Set_payload>
<Set_payload> ::=
'{' <ws>?
[<expr> ** [<ws>? ',' <ws>?]]?
<ws>? '}'A Set node represents a literal or selector invocation for a set value. It is interpreted as a Muldis D sys.std.Core.Type.Set value whose elements are defined by the Set_payload. Each expr of the Set_payload defines a unary tuple of the new set; each expr defines the value attribute of the tuple. If the value_kind of a value node is DHSet rather than Set, then the value node is further restricted.
See also the definition of the catalog data type sys.std.Core.Type.Cat.SetSelExprNodeSet, a tuple of which is what a Set node distills to when it is beneath the context of a depot node, as it describes some semantics.
Examples:
Set:fed.lib.the_db.account.Country_Names:{
'Canada',
'Spain',
'Jordan',
'Thailand'
}
Set:{
3,
16,
85
}Maybe Selectors
Grammar:
<Maybe> ::=
DH? [Maybe | Single] ':' <unspace>
[<type_name> ':' <unspace>]?
<Maybe_payload>
<Maybe_payload> ::=
<maybe_list> | <maybe_Nothing>
<maybe_list> ::=
'{' <ws>? <expr> <ws>? '}'
<maybe_Nothing__op_cr_basic> ::=
Nothing
<maybe_Nothing__op_cr_extended> ::=
<maybe_Nothing__op_cr_basic>
| '∅'A Maybe node represents a literal or selector invocation for a maybe value. It is interpreted as a Muldis D sys.std.Core.Type.Maybe value whose elements are defined by the Maybe_payload.
Iff the Maybe_payload is a maybe_list then it defines either zero or one expr; in the case of one, the expr defines the unary tuple of the new maybe, which is a 'single'; the expr defines the value attribute of the tuple. If the value_kind of a value node is DHMaybe or [|DH]Single rather than Maybe, then the value node is further restricted, either to having only deeply homogeneous resulting expr or to having exactly one expr, as appropriate.
Iff the Maybe_payload is a maybe_Nothing then the Maybe node is interpreted as the special value Maybe:Nothing, aka Nothing, aka empty set, aka ∅, which is the only Maybe value with zero elements. Note that this is just an alternative syntax, as set_expr_list can select that value too. As a further restriction, the value_kind must be just one of [|DH]Maybe when the Maybe_payload is a maybe_Nothing.
See also the definition of the catalog data type sys.std.Core.Type.Cat.SetSelExprNodeSet, a tuple of which is what a Maybe node distills to same as when Set does.
Examples:
Maybe:{ 'I know this one!' }
Maybe:Nothing
Maybe:∅
Nothing
∅Array Selectors
Grammar:
<Array> ::=
DH? Array ':' <unspace>
[<type_name> ':' <unspace>]?
<Array_payload>
<Array_payload> ::=
'[' <ws>?
[<expr> ** [<ws>? ',' <ws>?]]?
<ws>? ']'An Array node represents a literal or selector invocation for an array value. It is interpreted as a Muldis D sys.std.Core.Type.Array value whose elements are defined by the Array_payload. Each expr of the Array_payload defines a binary tuple of the new sequence; the expr defines the value attribute of the tuple, and the index attribute of the tuple is generated such that the first expr gets an index of zero and subsequent ones get consecutive higher integer values. If the value_kind of a value node is DHArray rather than Array, then the value node is further restricted.
See also the definition of the catalog data type sys.std.Core.Type.Cat.ArySelExprNodeSet, a tuple of which is what an Array node distills to when it is beneath the context of a depot node, as it describes some semantics.
Examples:
Array:[
'Alphonse',
'Edward',
'Winry'
]
Array:fed.lib.the_db.stats.Samples_By_Order:[
57,
45,
63,
61
]Bag Selectors
Grammar:
<Bag> ::=
DH? Bag ':' <unspace>
[<type_name> ':' <unspace>]?
<Bag_payload>
<Bag_payload> ::=
<bag_payload_counted_values>
| <bag_payload_repeated_values>
<bag_payload_counted_values> ::=
'{' <ws>?
[[<expr> <ws>? '=>' <ws>? <count>] ** [<ws>? ',' <ws>?]]?
<ws>? '}'
<count> ::=
<num_max_col_val> ';' <unspace> <pint_body>
| <d_pint_body>
<bag_payload_repeated_values> ::=
'{' <ws>?
[<expr> ** [<ws>? ',' <ws>?]]?
<ws>? '}'A Bag node represents a literal or selector invocation for a bag value. It is interpreted as a Muldis D sys.std.Core.Type.Bag value whose elements are defined by the Bag_payload, which is interpreted as follows:
Iff the Bag_payload is composed of just a nonord_list_[open|close] pair with zero elements between them, then it defines the only bag value having zero elements.
Iff the Bag_payload is a bag_payload_counted_values with at least one expr/count-pair element, then each pair defines a binary tuple of the new bag; the expr defines the value attribute of the tuple, and the count defines the count attribute.
Iff the Bag_payload is a bag_payload_repeated_values with at least one expr element, then each expr contributes to a binary tuple of the new bag; the expr defines the value attribute of the tuple. The bag has 1 tuple for every distinct (after normalization or evaluation) expr and expr-derived value in the Bag_payload, and the count attribute of that tuple says how many instances of said value there were.
See also the definition of the catalog data type sys.std.Core.Type.Cat.BagSelExprNodeSet, a tuple of which is what a Bag node distills to when it is beneath the context of a depot node, as it describes some semantics.
Further concerning bag_payload_counted_values, because of how BagSelExprNodeSet is defined, a count has to be a compile time constant, since an integer is stored in the system catalog rather than the name of an expression node like with value; if you actually want the bag value being selected at runtime to have runtime-determined count values, then you must use a Relation node rather than a Bag node.
Examples:
Bag:fed.lib.the_db.inventory.Fruit:{
'Apple' => 500,
'Orange' => 300,
'Banana' => 400
}
Bag:{
'Foo',
'Quux',
'Foo',
'Bar',
'Baz',
'Baz'
}Interval Selectors
Grammar:
<SPInterval> ::=
DH? SPInterval ':' <unspace>
[<type_name> ':' <unspace>]?
<SPInterval_payload>
<SPInterval_payload> ::=
'{' <ws>?
<interval>
<ws>? '}'
<interval> ::=
<interval_range> | <interval_single>
<interval_range> ::=
<min> <ws>? <interval_boundary_kind> <ws>? <max>
<min> ::=
<expr>
<max> ::=
<expr>
<interval_boundary_kind> ::=
'..' | '..^' | '^..' | '^..^'
<interval_single> ::=
<expr>
<MPInterval> ::=
DH? MPInterval ':' <unspace>
[<type_name> ':' <unspace>]?
<MPInterval_payload>
<MPInterval_payload> ::=
'{' <ws>?
[<interval> ** [<ws>? ',' <ws>?]]?
<ws>? '}'An SPInterval node represents a literal or selector invocation for a single-piece interval value. It is interpreted as a Muldis D sys.std.Core.Type.SPInterval value whose attributes are defined by the SPInterval_payload. Each of min and max is an expr node that defines the min and max attribute value, respectively, of the new single-piece interval. Each of the 4 interval_boundary_kind values .., ..^, ^.., ^..^ corresponds to one of the 4 possible combinations of excludes_min and excludes_max values that the new single-piece interval can have, which in order are: [False,False], [False,True], [True,False], [True,True].
A special shorthand for interval_range also exists, interval_single, which is to help with the possibly common situation where an interval is a singleton, meaning the interval has exactly 1 value; the shorthand empowers that value to be specified just once rather than twice. Iff the interval is an interval_single, then the interval is treated as if it was instead an interval_range whose min and max are both identical to the interval_single and whose interval_boundary_kind is ... For example, the interval 6 is shorthand for 6..6.
An MPInterval node represents a literal or selector invocation for a multi-piece interval value. It is interpreted as a Muldis D sys.std.Core.Type.MPInterval value whose elements are defined by the MPInterval_payload. Each interval of the MPInterval_payload defines a 4-ary tuple, representing a single-piece interval, of the new multi-piece interval.
See also the definition of the 2 catalog data types sys.std.Core.Type.Cat.[S|M]PIvlSelExprNodeSet, a tuple of which is what an [S|M]PInterval node distills to, respectively, when it is beneath the context of a depot node, as it describes some semantics.
Examples:
SPInterval:{1..10}
SPInterval:{2.7..^9.3}
SPInterval:{'a'^..'z'}
SPInterval:{UTCInstant:[2002,12,6,,,] ^..^ UTCInstant:[2002,12,20,,,]}
SPInterval:{'abc'} # 1 element #
MPInterval:{} # zero elements #
MPInterval:{1..10} # 10 elements #
MPInterval:{1..3,6,8..9} # 6 elements #
MPInterval:{-Inf..3,14..21,29..Inf} # all Int besides {4..13,22..28} #Low Level List Selectors
Grammar:
<List> ::=
List ':' <unspace>
[<type_name> ':' <unspace>]?
<List_payload>
<List_payload> ::=
'[' <ws>?
[<expr> ** [<ws>? ',' <ws>?]]?
<ws>? ']'A List node represents a literal or selector invocation for a low-level list value. It is interpreted as a Muldis D sys.std.Core.Type.Cat.List value whose elements are defined by the List_payload. Each expr of the List_payload defines an element of the new list, where the elements keep the same order.
See also the definition of the catalog data type sys.std.Core.Type.Cat.ListSelExprNodeSet, a tuple of which is what a List node distills to when it is beneath the context of a depot node, as it describes some semantics.
Examples:
# Nonstructure : Unicode abstract codepoints = 'Perl' #
List:[80,101,114,109]
# UCPString : Unicode abstract codepoints = 'Perl' #
List:[1,-4,List:[80,101,114,109]]
# Tuple:{} #
List:[2,List:[],List:[]]
# Relation:{} #
List:[3,List:[],List:[]]
# Set:{17,42,5} #
List:[3,
List:[List:[1,-4,List:[118,97,108,117,101]]],
List:[
List:[17],
List:[42],
List:[5]
]
]
# Nothing #
List:[3,
List:[List:[1,-4,List:[118,97,108,117,101]]],
List:[]
]
# Text : 'Perl' #
List:[4,
# type name : 'sys.std.Core.Type.Text' #
List:[
List:[1,-4,List:[115,121,115]],
List:[1,-4,List:[115,116,100]],
List:[1,-4,List:[67,111,114,101]],
List:[1,-4,List:[84,121,112,101]],
List:[1,-4,List:[84,101,120,116]],
],
# possrep name : 'nfd_codes' #
List:[1,-4,List:[110,102,100,95,99,111,100,101,115]],
# possrep attributes : Tuple:{""=>"Perl"} #
List:[2,
List:[List:[1,-4,List:[]]],
List:[List:[1,-4,List:[80,101,114,109]]]
]
]DEPOT SPECIFICATION
Grammar:
<depot> ::=
<depot_catalog>
[<ws> <depot_data>]?
<depot_catalog> ::=
'depot-catalog' <ws> <catalog>
<depot_data> ::=
'depot-data' <ws> <Database>
<catalog__code_as_data> ::=
<Database>
<catalog__plain_rtn_inv> ::=
<catalog__code_as_data>
| <depot_catalog_payload>
<depot_catalog_payload> ::=
'{' <ws>?
[[
<subdepot>
| <named_material>
| <self_local_dbvar_type>
] ** <ws>]?
<ws>? '}'
<subdepot> ::=
subdepot <ws> <subdepot_declared_name> <ws> <depot_catalog_payload>
<subdepot_declared_name> ::=
<Name_payload>
<self_local_dbvar_type> ::=
'self-local-dbvar-type' <ws> <PNSQNameChain_payload>A depot node specifies a single complete depot, which is the widest scope user-defined DBMS entity that is a completely self-defined, and doesn't rely on any user-defined entities external to itself to be unambiguously understood. A depot node defines a (possibly empty) system catalog database, holding user material (routine and type) definitions, plus optionally a normal-user-data database.
A depot_catalog_payload node in the PTMD_STD grammar is interpreted as a Muldis D sys.std.Core.Type.Cat.Depot value (which is also a Database value) whose attributes are defined by its child elements.
A subdepot node specifies a single public entity namespace under a depot and all of the subdepot nodes under a depot comprise a hierarchy of such namespaces.
But a subdepot node doesn't have a corresponding data type for its entire content like with a depot_catalog_payload; rather, a subdepot node hierarchy is stored flattened in the system catalog, such that each tuple of the subdepots attribute from the parent Depot names one subdepot that exists, and all the subdepot's materials are flattened into tuples of the materials-defining attributes of the Depot.
A self_local_dbvar_type node specifies what the normal-user-data database has as its declared data type. The value of the data attribute of the parent Depot is determined from this node. Iff self_local_dbvar_type is not specified then depot_data must be omitted; iff self_local_dbvar_type is specified then depot_data must be present. The most liberal value of self_local_dbvar_type is simply Database, meaning depot_data may define any database value at all. A depot_catalog_payload may have at most 1 self_local_dbvar_type.
Examples:
# A completely empty depot that doesn't have a self-local dbvar. #
depot-catalog {}
# Empty depot with self-local dbvar with unrestricted allowed values. #
depot-catalog {
self-local-dbvar-type Database
}
depot-data Database:{}
# A depot having just one function and no dbvar. #
depot-catalog {
function cube (Int <-- $topic : Int) {
$topic exp 3
}
}MATERIAL SPECIFICATION
Grammar:
<material> ::=
<function>
| <updater>
| <recipe>
| <procedure>
| <scalar_type>
| <tuple_type>
| <relation_type>
| <domain_type>
| <subset_type>
| <mixin_type>
| <key_constr>
| <distrib_key_constr>
| <subset_constr>
| <distrib_subset_constr>
| <stim_resp_rule>A material node specifies a new material (routine or type) that lives in a depot or subdepot.
A material node in the PTMD_STD grammar corresponds directly to a tuple of a (routine or type defining) attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a material specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. Or more specifically, an entire tree of PTMD_STD material nodes corresponds to a set of said attribute tuples, one attribute tuple per material node. In the nonsugared form, every material node has an explicitly designated name, and all child nodes are not declared inline with their parent nodes but rather are declared in parallel with them, and the parents refer to their children by their names. A feature of the PTMD_STD grammar is that material nodes may be declared without explicit names, such that the parser would generate names for them when deriving system catalog entries, and that is why PTMD_STD supports, and encourages the use of for code brevity/readability, the use of inline-declared material nodes, especially so when the material in question is a simple function or type that is only being used in one place, such as a typical value-filter function or a typical subset type.
When a material node is contained within another material node, the first material is conceptually part of the implementation of the second material; the first material is hereafter referred to as an inner material for this inter-material relationship. When a material node is not contained within any other material node, but rather is directly contained within a depot_catalog_payload node, then this material is hereafter referred to as an outer material. Both inner and outer material nodes may contain 0..N other (inner) material nodes.
When a material node defines an outer material foo directly within a subdepot (or depot) bar, and foo has no child inner materials, then the material definition will be stored in the system catalog exactly as conceived, as a new material named foo directly in the subdepot bar. For example, the outer material will have the name fed.lib.mydb.bar.foo.
In contrast, when said material node has at least one child inner material baz, then what happens in the system catalog instead is that a new subdepot named foo is created directly in the subdepot bar and every one of the whole hierarchy of said material nodes is stored directly in the subdepot foo; the outer material is stored under the name that is the empty string, and its inner materials are stored under their own names. For example, the outer material will have the name fed.lib.mydb.bar.foo."" and the inner will be named fed.lib.mydb.bar.foo.baz. Such a material hierarchy is stored in a flat namespace so it is required for all inner materials having a common outer material to have distinct declaration names, none of which are the empty string, regardless of whether any of them was declared inside another inner material node or directly inside the common outer node.
It is mandatory for outer material nodes to have explicitly specified declaration names, because they are expected to be invoked by name in the general case, like any public routine or type. An inner material may optionally have an explicitly specified declaration name, for either self-documentation purposes or in case it might be invoked by name; however an inner material may also be anonymous, in which case it may only be used inline with its declaration, or by way of an AbsPathMaterialNC value which is defined inline with the material's declaration. When an inner material is declared as anonymous, it still actually has a name in the system catalog (all materials in the system catalog are named), but that name is generated by the PTMD_STD parser; strictly speaking this material could still be invoked by that name like an explicitly named one, but that would not be a good practice; use explicit names if you want to invoke by name. Strictly speaking, the algorithm to generate material names should be fully deterministic, but the names would be non-descriptive so akin to random.
Material Specification Common Elements
Every material has 2-3 elements, illustrated by this grammar:
<x_material> ::=
<named_material> | <anon_material>
<named_material> ::=
<material_kind> <ws> <material_declared_name>
<ws> <material_payload>
<anon_material> ::=
<material_kind> <ws> <material_payload>
<material_kind> ::=
function
| 'named-value'
| 'value-map'
| 'value-map-unary'
| 'value-filter'
| 'value-constraint'
| 'transition-constraint'
| 'value-reduction'
| 'order-determination'
| updater
| recipe
| procedure
| 'system-service'
| transaction
| 'scalar-type'
| 'tuple-type'
| 'database-type'
| 'relation-type'
| 'domain-type'
| 'subset-type'
| 'mixin-type'
| 'key-constraint'
| 'primary-key'
| 'distrib-key-constraint'
| 'distrib-primary-key'
| 'subset-constraint'
| 'distrib-subset-constraint'
| 'stimulus-response-rule'
<material_declared_name> ::=
<Name_payload>
<material_payload> ::=
<function_payload>
| <updater_payload>
| <recipe_payload>
| <procedure_payload>
| <scalar_type_payload>
| <tuple_type_payload>
| <relation_type_payload>
| <domain_type_payload>
| <subset_type_payload>
| <mixin_type_payload>
| <key_constr_payload>
| <distrib_key_constr_payload>
| <subset_constr_payload>
| <distrib_subset_constr_payload>
| <stim_resp_rule_payload>So a x_material|material node has 2-3 elements in general:
material_kind-
This is a character string of the format
[<[ a..z ]>+] ** '-'; it identifies the kind of the material and is the only external metadata ofmaterial_payloadgenerally necessary to interpret the latter; what grammars are valid formaterial_payloaddepend just onmaterial_kind. material_declared_name-
This is the declared name of the material within the namespace defined by its subdepot (or depot). It is explicitly specified iff the
materialis anamed_material material_payload-
This is mandatory for all
material. It specifies the entire material sans its name. Format varies withmaterial_kind.
For material examples, see the subsequent documentation sections.
Note that, for simplicity, the subsequent sections assume for now that named_material is the only valid option, and so the material_declared_name isn't optional, and the only way to embed a material in another is using a with_clause.
Function Specification
Grammar:
<function> ::=
<function_kind>
<ws> <material_declared_name>
<ws> <function_payload>
<function_kind> ::=
function
| 'named-value'
| 'value-map'
| 'value-map-unary'
| 'value-filter'
| 'value-constraint'
| 'transition-constraint'
| 'value-reduction'
| 'order-determination'
<function_payload> ::=
<function_heading> <ws> <function_body>
<function_heading> ::=
<func_signature> [<ws> <implements_clause>]*
<func_signature> ::=
'(' <ws>?
<result_type> <ws>? '<--'
[<ws>? <func_param> ** [<ws>? ',' <ws>?]]?
<ws>? ')'
<result_type> ::=
<type_name>
<func_param> ::=
<ro_reg_param>
<function_body> ::=
<nonempty_function_body> | <empty_atomic_body>
<nonempty_function_body> ::=
'{' <ws>?
[[<with_clause> | <named_expr>] <ws>]*
<expr>
<ws>? '}'A function node specifies a new function that lives in a depot or subdepot. A function node in the PTMD_STD grammar corresponds directly to a tuple of the functions attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a function specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The functions tuple has 2 primary attributes, name and material, which are valued from the function node's material_declared_name and function_payload elements, respectively.
A function_payload specifies an entire function besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.Function value. The function_heading element specifies the function's public interface, which is these 5 attributes of the new Function: result_type, params, opt_params, dispatch_params, implements. The function_body element specifies the function's implementation, which is the 1 attribute expr of the new Function.
The function_kind has no impact at all on the interpretation of a function. However, it can serve to apply additional constraints on the allowed values of the resulting Function, in the manner of simple subset-type constraints, and similarly it can serve to add self-documentation to the intended purpose or use of the function. Iff function_kind is function then there are no such subset-type constraints applied, as the node is simply denoting a generic function; any other value of function_kind means that the node is denoting a value of a proper subtype of Function, and so that subtype's respective constraints are applied to the new Function. The various function_kind map to Function subtypes as follows:
function kind | catalog data type
----------------------+------------------
function | Function
named-value | NamedValFunc
value-map | ValMapFunc
value-map-unary | ValMapUFunc
value-filter | ValFiltFunc
value-constraint | ValConstrFunc
transition-constraint | TransConstrFunc
value-reduction | ValRedFunc
order-determination | OrdDetFuncThe function_heading's result_type is interpreted as the Function's result_type attribute.
Any of these kinds of components of a function node are interpreted in exactly the same manner as for an updater node, as a Function is to an Updater: ro_reg_param (but that the Function attribute is named params rather than ro_params), implements_clause, empty_atomic_body, with_clause, named_expr.
A nonempty_function_body must have at least one expr, because a function must by definition result in a value, and that expr says what this result value is. Said result-determining expr must either not be a named_expr or it must be a named_expr whose direct expr_name is the empty string; the latter option is saying explicitly what the parser would otherwise name the expr implicitly. A nonempty_function_body may have at most one expr that isn't a named_expr, because it can only have one result-determining expr.
Examples:
function cube (Int <-- $topic : Int) {
$topic exp 3
}Updater Specification
Grammar:
<updater> ::=
updater
<ws> <material_declared_name>
<ws> <updater_payload>
<updater_payload> ::=
<updater_heading> <ws> <updater_body>
<updater_heading> ::=
<upd_signature> [<ws> <implements_clause>]*
<upd_signature> ::=
'(' <ws>?
<upd_param> ** [<ws>? ',' <ws>?]
<ws>? ')'
<upd_param> ::=
<upd_reg_param> | <ro_reg_param>
<updater_body> ::=
<nonempty_updater_or_recipe_body> | <empty_atomic_body>An updater node specifies a new updater that lives in a depot or subdepot. An updater node in the PTMD_STD grammar corresponds directly to a tuple of the updaters attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how an updater specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The updaters tuple has 2 primary attributes, name and material, which are valued from the updater node's material_declared_name and updater_payload elements, respectively.
An updater_payload specifies an entire updater besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.Updater value. The updater_heading element specifies the updater's public interface, which is these 5 attributes of the new Updater: upd_params, ro_params, opt_params, dispatch_params, implements. The updater_body element specifies the updater's implementation, which is the 2 attributes exprs and stmt of the new Updater.
Any of these kinds of components of an updater node are interpreted in exactly the same manner as for a recipe node, as an Updater is to a Recipe: upd_reg_param, ro_reg_param, implements_clause, empty_atomic_body, with_clause, update_stmt, named_expr, expr. In fact, the only structural difference between an updater and a recipe is that a recipe has global parameters and an updater doesn't.
Examples:
updater make_coprime (&$a : NNInt, &$b : NNInt) {
with function gcd (NNInt <-- $a : NNInt, $b : NNInt) {
$b = 0 ?? $a !! rtn( a => $b, b => $a mod $b round Down )
}
$gcd ::= nlx.lib.gcd( $>a, $>b )
$a := $a div $gcd round Down
$b := $b div $gcd round Down
}Recipe Specification
Grammar:
<recipe> ::=
recipe
<ws> <material_declared_name>
<ws> <recipe_payload>
<recipe_payload> ::=
<recipe_heading> <ws> <recipe_body>
<recipe_heading> ::=
<rcp_signature> [<ws> <implements_clause>]*
<rcp_signature> ::=
'(' <ws>?
<rcp_param> ** [<ws>? ',' <ws>?]
<ws>? ')'
<rcp_param> ::=
<upd_reg_param>
| <ro_reg_param>
| <upd_global_param>
| <ro_global_param>
<upd_reg_param> ::=
<upd_cosigil> <ro_reg_param>
<upd_cosigil> ::=
'&'
<ro_reg_param> ::=
<param_name> <param_flag>? <ws>? ':' <ws>? <type_name>
<param_name> ::=
<lex_entity_name>
<lex_entity_name> ::=
<data_sigil> <Name_payload>
<data_sigil> ::=
'$'
<param_flag> ::=
<opt_param_flag> | <dispatch_param_flag>
<opt_param_flag> ::=
'?'
<dispatch_param_flag> ::=
'@'
<upd_global_param> ::=
<upd_cosigil> <ro_global_param>
<ro_global_param> ::=
<param_name> <ws>? <infix_bind_op> <ws>? <global_var_name>
<infix_bind_op> ::=
'::='
<global_var_name> ::=
<PNSQNameChain_payload>
<implements_clause> ::=
implements <ws> <routine_name>
<routine_name> ::=
<PNSQNameChain_payload>
<recipe_body> ::=
<nonempty_updater_or_recipe_body> | <empty_atomic_body>
<nonempty_updater_or_recipe_body> ::=
'{' <ws>?
[[<with_clause> | <named_expr> | <update_stmt>] <ws>]*
<update_stmt>
<ws>? '}'
<with_clause> ::=
with <ws> <named_material>
<empty_atomic_body> ::=
'{' <ws>? '...' <ws>? '}'A recipe node specifies a new recipe that lives in a depot or subdepot. A recipe node in the PTMD_STD grammar corresponds directly to a tuple of the recipes attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a recipe specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The recipes tuple has 2 primary attributes, name and material, which are valued from the recipe node's material_declared_name and recipe_payload elements, respectively.
A recipe_payload specifies an entire recipe besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.Recipe value. The recipe_heading element specifies the recipe's public interface, which is these 7 attributes of the new Recipe: upd_params, ro_params, opt_params, upd_global_params, ro_global_params, dispatch_params, implements. The recipe_body element specifies the recipe's implementation, which is the 2 attributes exprs and stmt of the new Recipe.
Iff the recipe_heading has at least one upd_reg_param or ro_reg_param, then the recipe has one or more regular parameters, which are what another routine can explicitly supply arguments for in an invocation of the recipe; each regular parameter is either subject-to-update or read-only. Each upd_reg_param is primarily interpreted as a tuple of the Recipe's upd_params attribute, and each ro_reg_param is primarily interpreted as a tuple of the Recipe's ro_params attribute; for each tuple, the param_name and type_name, respectively, of the upd_reg_param or ro_reg_param provide the tuple's name and type attribute. Iff any of the parameters have an opt_param_flag, then those parameters are optional to supply arguments for; for each parameter with an opt_param_flag, the Recipe's opt_params attribute has a tuple with the parameter's param_name. Iff any of the parameters have a dispatch_param_flag, then the recipe is being explicitly declared to be a virtual recipe, and so the recipe_body must be empty_atomic_body; for each parameter with a dispatch_param_flag, the Recipe's dispatch_params attribute has a tuple with the parameter's param_name.
Iff the recipe_heading has at least one upd_global_param or ro_global_param, then the recipe has one or more global parameters, which are lexical aliases for global variables; each global parameter is either subject-to-update or read-only. Each upd_global_param is primarily interpreted as a tuple of the Recipe's upd_global_params attribute, and each ro_global_param is primarily interpreted as a tuple of the Recipe's ro_global_params attribute; for each tuple, the param_name and global_var_name, respectively, of the upd_global_param or ro_global_param provide the tuple's name and global attribute.
Iff the recipe_heading has at least one implements_clause, then the recipe is explicitly declaring that it implements one or more virtual recipe, one being named by each implements_clause. Each implements_clause is interpreted as a tuple of the Recipe's implements attribute.
Iff the recipe_body is an empty_atomic_body, then the Recipe's exprs and stmt attributes are both empty.
Iff the recipe_body has at least one with_clause, then the recipe is explicitly declaring that it has one or more inner materials, such that the other materials are conceptually part of the implementation of the recipe; each with_clause specifies one inner material in its named_material element. A with_clause is not interpreted as any part of the Recipe but rather results in other additions to its parent Depot, in a manner similar to as if the named_material were specified externally of the recipe node; but see the "MATERIAL SPECIFICATION" main description for details on the complete effects of specifying an inner material.
A nonempty_updater_or_recipe_body must have at least one update_stmt, because a recipe must by definition update at least one of its (regular or global) parameters, though possibly to the same value it already has, lest it otherwise be an unconditional no-op. Each update_stmt is interpreted as a tuple of the Recipe's stmt attribute.
Iff the recipe_body directly has at least one named_expr, then each such named_expr is interpreted as a tuple of an attribute of the Recipe's exprs attribute such that said tuple's name is explicitly user-defined rather than generated by the parser. Any expr contained in a recipe_body by way of one of its direct update_stmt or named_expr will similarly be interpreted as a tuple of an attribute of the Recipe's exprs attribute, where said tuple's name is either user-defined or generated as appropriate for the kind of expr.
Examples:
recipe count_heads (&$count : NNInt, $search : Text,
$people ::= $fed.data.db1.people) {
with value-filter filt (Bool <-- $topic : Tuple, $search : Text) {
$.name like ('%' ~ $search ~ '%')
}
$count := r# ($people where <nlx.lib.filt>( $>search ))
}Procedure Specification
Grammar:
<procedure> ::=
<procedure_kind>
<ws> <material_declared_name>
<ws> <procedure_payload>
<procedure_kind> ::=
procedure | 'system-service' | transaction
<procedure_payload> ::=
<procedure_heading> <ws> <procedure_body>
<procedure_heading> ::=
<proc_signature> [<ws> <implements_clause>]*
<proc_signature> ::=
'(' <ws>?
[<proc_param> ** [<ws>? ',' <ws>?]]?
<ws>? ')'
<proc_param> ::=
<upd_reg_param> | <ro_reg_param>
<procedure_body> ::=
<nonempty_procedure_body> | <empty_procedure_body>
<nonempty_procedure_body> ::=
<nonempty_procedure_body_or_compound_stmt>
<nonempty_procedure_body_or_compound_stmt> ::=
'[' <ws>?
[[<with_clause> | <proc_var> | <proc_stmt>] <ws>]*
<ws>? ']'
<proc_var> ::=
var <ws> <var_name> <ws>? ':' <ws>? <type_name>
<empty_procedure_body> ::=
'[' <ws>? '...' <ws>? ']'A procedure node specifies a new procedure that lives in a depot or subdepot. A procedure node in the PTMD_STD grammar corresponds directly to a tuple of the procedures attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a procedure specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The procedures tuple has 2 primary attributes, name and material, which are valued from the procedure node's material_declared_name and procedure_payload elements, respectively.
A procedure_payload specifies an entire procedure besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.Procedure value. The procedure_heading element specifies the procedure's public interface, which is these 7 attributes of the new Procedure: upd_params, ro_params, opt_params, dispatch_params, implements, is_system_service, is_transaction. The procedure_body element specifies the procedure's implementation, which is the 2 attributes vars and stmt of the new Procedure.
The procedure_kind element of a procedure node is the sole determinant of the values of the is_system_service and is_transaction attributes of the resulting Procedure; for each valid combination there also exists a Procedure subtype. It also can serve to add self-documentation to the intended purpose or use of the procedure. The various procedure_kind map to attribute values and Procedure subtypes as follows:
procedure kind | is_system_service | is_transaction | catalog data type
---------------+-------------------+----------------+------------------
procedure | Bool:False | Bool:False | Procedure
system-service | Bool:True | Bool:True | SystemService
transaction | Bool:False | Bool:True | TransactionAny of these kinds of components of a procedure node are interpreted in exactly the same manner as for an updater node, as a Procedure is to an Updater: upd_reg_param, ro_reg_param, implements_clause, empty_procedure_body (as per empty_atomic_body), with_clause.
Iff the procedure_body has at least one proc_var, then the procedure has one or more regular lexical variables, whose names are explicitly user-defined rather than generated by the parser, which are the exclusive means (besides its own subject-to-update parameters) for a procedure to directly shuttle transient data between its statements for use as their arguments or logic branch conditions. Each proc_var is interpreted as a tuple of the Procedure's vars attribute; for each tuple, the var_name and type_name, respectively, of the proc_var provide the tuple's name and type attribute.
Each proc_stmt of a nonempty_procedure_body is interpreted as a tuple of an attribute of the the Procedure's stmt attribute. A proc_stmt may also, and typically does, also have nested proc_stmt, thereby forming a tree, and that tree is flattened with each nested proc_stmt becoming its own tuple under stmt like with the first. In fact, all of a procedure's statements form a single statement tree, and the root node of this tree is an implicit compound statement node (whose name is the empty string) whose direct child statements are all of the direct child proc_stmt elements of the nonempty_procedure_body, in order. Iff a nonempty_procedure_body has no proc_stmt member elements, then the procedure has a defined body that is an unconditional no-op.
Examples:
procedure print_curr_time () [
var $now : Instant
fetch_curr_instant( &$now )
var $message : Text
{
$message := 'The current time is: '
~ nlx.par.lib.utils.time_as_text( time => $now )
}
write_Text_line( $message )
]Scalar Type Specification
Grammar:
<scalar_type> ::=
'scalar-type'
<ws> <material_declared_name>
<ws> <scalar_type_payload>
<scalar_type_payload> ::=
'{' <ws>?
[
<with_clause>
| <composes_clause>
| <base_type_clause>
| <subtype_constraint_clause>
| <possrep>
| <possrep_map>
| <default_clause>
] ** <ws>
<ws>? '}'
<subtype_constraint_clause> ::=
'subtype-constraint' <ws> <routine_name>
<possrep> ::=
possrep <ws>
<possrep_name> <ws>
'{' <ws>?
<tuple_type_clause>
[<ws> <is_base_clause>]?
<ws>? '}'
<is_base_clause> ::=
'is-base'
<possrep_map> ::=
'possrep-map' <ws>
'{' <ws>?
<p2> <ws> from <ws> <p1>
<ws> using <ws> <routine_name>
<ws> 'reverse-using' <ws> <routine_name>
<ws>? '}'
<p1> ::=
<possrep_name>
<p2> ::=
<possrep_name>A scalar_type node specifies a new scalar type that lives in a depot or subdepot. A scalar_type node in the PTMD_STD grammar corresponds directly to a tuple of the scalar_types attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a scalar type specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The scalar_types tuple has 2 primary attributes, name and material, which are valued from the scalar_type node's material_declared_name and scalar_type_payload elements, respectively.
A scalar_type_payload specifies an entire scalar type besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.ScalarType value.
TODO: The remaining description.
TODO: Examples.
Tuple Type Specification
Grammar:
<tuple_type> ::=
<tuple_type_kind>
<ws> <material_declared_name>
<ws> <tuple_type_payload>
<tuple_type_kind> ::=
'tuple-type' | 'database-type'
<tuple_type_payload> ::=
'{' <ws>?
[
<with_clause>
| <composes_clause>
| <base_type_clause>
| <tuple_attr>
| <virtual_attr_map>
| <constraint_clause>
| <default_clause>
] ** <ws>
<ws>? '}'
<tuple_attr> ::=
attr <ws> <attr_name_lex> <ws>? ':' <ws>? <type_name>
<attr_name_lex> ::=
<lex_entity_name>
<virtual_attr_map> ::=
'virtual-attr-map' <ws>
'{' <ws>?
'determinant-attrs' <ws> <aliased_attr_list>
<ws> 'dependent-attrs' <ws> <aliased_attr_list>
<ws> 'map-function' <ws> <routine_name>
[<ws> <is_updateable_clause>]?
<ws>? '}'
<aliased_attr_list> ::=
'{' <ws>?
[[<aliased_attr_pair> | <same_named_nonord_atvl>]
** [<ws>? ',' <ws>?]]?
<ws>? '}'
<aliased_attr_pair> ::=
<attr_name_lex> <ws>? '=>' <ws>? <attr_nc_lex>
<is_updateable_clause> ::=
'is-updateable'A tuple_type node specifies a new tuple type that lives in a depot or subdepot. A tuple_type node in the PTMD_STD grammar corresponds directly to a tuple of the tuple_types attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a tuple type specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The tuple_types tuple has 2 primary attributes, name and material, which are valued from the tuple_type node's material_declared_name and tuple_type_payload elements, respectively.
A tuple_type_payload specifies an entire tuple type besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.TupleType value.
The tuple_type_kind has no impact at all on the interpretation of a tuple_type. However, it can serve to apply additional constraints on the allowed values of the resulting TupleType, in the manner of simple subset-type constraints, and similarly it can serve to add self-documentation to the intended purpose or use of the tuple type. Iff tuple_type_kind is tuple-type then there are no such subset-type constraints applied, as the node is simply denoting a generic tuple type; iff tuple_type_kind is database-type then there is a constraint applied such that the node is denoting a database type.
TODO: The remaining description.
Examples:
# db schema with 3 relvars, 2 subset constrs, the 5 def separately #
database-type CD_DB {
attr $artists : nlx.lib.Artists
attr $cds : nlx.lib.CDs
attr $tracks : nlx.lib.Tracks
constraint nlx.lib.sc_artist_has_cds
constraint nlx.lib.sc_cd_has_tracks
}
# relation type using tuple virtual-attr-map for case-insen key attr #
# where primary text data is case-sensitive, case-preserving #
relation-type Locations {
tuple-type nlx.lib.Location
with tuple-type Location {
attr $loc_name : Text
attr $loc_name_uc : Text
virtual-attr-map {
determinant-attrs { $>loc_name }
dependent-attrs { $>loc_name_uc }
map-function nlx.lib.uc_loc_name
}
with value-map-unary uc_loc_name (Tuple <-- $topic : Tuple) {
Tuple:{ loc_name_uc => upper( $.loc_name ) }
}
}
constraint nlx.lib.sk_loc_name_uc
with key-constraint sk_loc_name_uc { $loc_name_uc }
}
# db schema with 2 real relvars, 1 virtual relvar; all are updateable #
# real $products has attrs { product_id, name } #
# real $sales has attrs { product_id, qty } #
# virtual $combines has attrs { product_id, name, qty } #
database-type DB {
attr $products : nlx.lib.Products
attr $sales : nlx.lib.Sales
attr $combines : nlx.lib.Combines
virtual-attr-map {
determinant-attrs { $>products, $>sales }
dependent-attrs { $>combines }
map-function nlx.lib.combine_p_s
is-updateable
}
with value-map-unary combine_p_s (Database <-- $topic : Database) {
Database:{ combines => $.products join $.sales }
}
}Relation Type Specification
Grammar:
<relation_type> ::=
'relation-type'
<ws> <material_declared_name>
<ws> <relation_type_payload>
<relation_type_payload> ::=
'{' <ws>?
[
<with_clause>
| <composes_clause>
| <base_type_clause>
| <tuple_type_clause>
| <constraint_clause>
| <default_clause>
] ** <ws>
<ws>? '}'
<tuple_type_clause> ::=
tuple-type <ws> <type_name>A relation_type node specifies a new relation type that lives in a depot or subdepot. A relation_type node in the PTMD_STD grammar corresponds directly to a tuple of the relation_types attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a relation type specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The relation_types tuple has 2 primary attributes, name and material, which are valued from the relation_type node's material_declared_name and relation_type_payload elements, respectively.
A relation_type_payload specifies an entire relation type besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.RelationType value.
TODO: The remaining description.
Examples:
relation-type Artists {
with tuple-type Artist {
attr $artist_id : Int
attr $artist_name : Text
}
with primary-key pk_artist_id { $artist_id }
with key-constraint sk_artist_name { $artist_name }
tuple-type nlx.lib.Artist
constraint nlx.lib.pk_artist_id
constraint nlx.lib.sk_artist_name
}
relation-type CDs {
with tuple-type CD {
attr $cd_id : Int
attr $artist_id : Int
attr $cd_title : Text
}
with primary-key pk_cd_id { $cd_id }
with key-constraint sk_cd_title { $cd_title }
tuple-type nlx.lib.CD
constraint nlx.lib.pk_cd_id
constraint nlx.lib.sk_cd_title
}Domain Type Specification
Grammar:
<domain_type> ::=
'domain-type'
<ws> <material_declared_name>
<ws> <domain_type_payload>
<domain_type_payload> ::=
'{' <ws>?
[
<with_clause>
| <composes_clause>
| <domain_sources>
| <domain_filters>
| <constraint_clause>
| <default_clause>
] ** <ws>
<ws>? '}'
<domain_sources> ::=
['source-union' | 'source-intersection'] <ws>
'{' <ws>?
<type_name> ** [<ws>? ',' <ws>?]
<ws>? '}'
<domain_filters> ::=
['filter-union' | 'filter-intersection'] <ws>
'{' <ws>?
[<type_name> ** [<ws>? ',' <ws>?]]?
<ws>? '}'A domain_type node specifies a new domain type that lives in a depot or subdepot. A domain_type node in the PTMD_STD grammar corresponds directly to a tuple of the domain_types attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a domain type specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The domain_types tuple has 2 primary attributes, name and material, which are valued from the domain_type node's material_declared_name and domain_type_payload elements, respectively.
A domain_type_payload specifies an entire domain type besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.DomainType value.
TODO: The remaining description.
TODO: Examples.
Subset Type Specification
Grammar:
<subset_type> ::=
'subset-type'
<ws> <material_declared_name>
<ws> <subset_type_payload>
<subset_type_payload> ::=
<subset_type_pl_long> | <subset_type_pl_short>
<subset_type_pl_long> ::=
'{' <ws>?
[
<with_clause>
| <composes_clause>
| <base_type_clause>
| <constraint_clause>
| <default_clause>
] ** <ws>
<ws>? '}'
<base_type_clause> ::=
['base-type' | of] <ws> <type_name>
<constraint_clause> ::=
[constraint | where] <ws> <constraint_name>
<constraint_name> ::=
<PNSQNameChain_payload>
<default_clause> ::=
default <ws> <routine_name>
<subset_type_pl_short> ::=
<base_type_clause>
[<ws> <constraint_clause>]?
[<ws> <default_clause>]?A subset_type node specifies a new subset type that lives in a depot or subdepot. A subset_type node in the PTMD_STD grammar corresponds directly to a tuple of the subset_types attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a subset type specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The subset_types tuple has 2 primary attributes, name and material, which are valued from the subset_type node's material_declared_name and subset_type_payload elements, respectively.
A subset_type_payload specifies an entire subset type besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.SubsetType value.
TODO: The remaining description.
TODO: Examples.
Mixin Type Specification
Grammar:
<mixin_type> ::=
'mixin-type'
<ws> <material_declared_name>
<ws> <mixin_type_payload>
<mixin_type_payload> ::=
'{' <ws>?
[[
<with_clause>
| <composes_clause>
] ** <ws>]?
<ws>? '}'
<composes_clause> ::=
composes <ws> <type_name> [<ws> <prov_def_clause>]?
<prov_def_clause> ::=
'and-provides-its-default'A mixin_type node specifies a new mixin type that lives in a depot or subdepot. A mixin_type node in the PTMD_STD grammar corresponds directly to a tuple of the mixin_types attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a mixin type specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The mixin_types tuple has 2 primary attributes, name and material, which are valued from the mixin_type node's material_declared_name and mixin_type_payload elements, respectively.
A mixin_type_payload specifies an entire mixin type besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.MixinType value.
TODO: The remaining description.
TODO: Examples.
Key Constraint Specification
Grammar:
<key_constr> ::=
<key_constr_kind>
<ws> <material_declared_name>
<ws> <key_constr_payload>
<key_constr_kind> ::=
'key-constraint' | 'primary-key'
<key_constr_payload> ::=
'{' <ws>?
[<attr_name_lex> ** [<ws>? ',' <ws>?]]?
<ws>? '}'A key_constr node specifies a new unique key constraint or candidate key, for a relation type, that lives in a depot or subdepot. A key_constr node in the PTMD_STD grammar corresponds directly to a tuple of the key_constrs attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a unique key constraint specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The key_constrs tuple has 2 primary attributes, name and material, which are valued from the key_constr node's material_declared_name and key_constr_payload elements, respectively.
A key_constr_payload specifies an entire unique key constraint or candidate key, for a relation type, besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.KeyConstr value. Each attr_name_lex element of a key_constr_payload is interpreted as a tuple of the KeyConstr's attrs attribute. Iff there are no attr_name_lex, then we have a nullary key which restricts the relation to have a maximum of 1 tuple. The key_constr_kind element of a key_constr node is the sole determinant of the value of the is_primary attribute of the resulting KeyConstr; primary-key means Bool:True, while key-constraint means Bool:False.
Examples:
# at most one tuple allowed #
key-constraint maybe_one {}
# relation type's $artist_id attr is its primary key #
primary-key pk_artist_id { $artist_id }
# relation type has surrogate key over both name attrs #
key-constraint sk_name { $last_name, $first_name }Distributed Key Constraint Specification
TODO.
Subset Constraint Specification
Grammar:
<subset_constr> ::=
'subset-constraint'
<ws> <material_declared_name>
<ws> <subset_constr_payload>
<subset_constr_payload> ::=
'{' <ws>?
parent <ws> <parent> <ws> 'using-key' <ws> <parent_key>
<ws> child <ws> <child> <ws> 'using-attrs' <ws> <sc_attr_map>
<ws>? '}'
<parent> ::=
<attr_nc_lex>
<attr_nc_lex> ::=
<lex_entity_nc>
<lex_entity_nc> ::=
<data_sigil> <NameChain_payload>
<parent_key> ::=
<constraint_name>
<child> ::=
<attr_nc_lex>
<sc_attr_map> ::=
'{' <ws>?
[[<sc_attr_pair> | <same_named_nonord_atvl>]
** [<ws>? ',' <ws>?]]?
<ws>? '}'
<sc_attr_pair> ::=
<child_attr> <ws>? '=>' <ws>? <parent_attr>
<child_attr> ::=
<attr_name_lex>
<parent_attr> ::=
<attr_name_lex>A subset_constr node specifies a (non-distributed) subset constraint (foreign key constraint) over relation-valued attributes, for a tuple type, that lives in a depot or subdepot. A subset_constr node in the PTMD_STD grammar corresponds directly to a tuple of the subset_constrs attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a (non-distributed) subset constraint specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The subset_constrs tuple has 2 primary attributes, name and material, which are valued from the subset_constr node's material_declared_name and subset_constr_payload elements, respectively.
A subset_constr_payload specifies an entire (non-distributed) subset constraint, for a relation type, besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.SubsetConstr value.
TODO: The remaining description.
Examples:
# relation $foo must have exactly 1 tuple when $bar has at least 1 #
subset-constraint sc_mutual_inclusion {
parent $foo using-key nlx.lib.maybe_one
child $bar using-attrs {}
}
subset-constraint sc_artist_has_cds {
parent $artists using-key nlx.lib.Artists.pk_artist_id
child $cds using-attrs { $>artist_id }
}Distributed Subset Constraint Specification
TODO.
Stimulus-Response Rule Specification
Grammar:
<stim_resp_rule> ::=
'stimulus-response-rule'
<ws> <material_declared_name>
<ws> <stim_resp_rule_payload>
<stim_resp_rule_payload> ::=
when <ws> <stimulus> <ws> invoke <ws> <response>
<stimulus> ::=
'after-mount'
<response> ::=
<routine_name>A stim_resp_rule node specifies a new stimulus-response rule that lives in a depot or subdepot. A stim_resp_rule node in the PTMD_STD grammar corresponds directly to a tuple of the stim_resp_rules attribute of a value of the catalog data type sys.std.Core.Type.Cat.Depot, which is how a stimulus-response rule specification is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. The stim_resp_rules tuple has 2 primary attributes, name and material, which are valued from the stim_resp_rule node's material_declared_name and stim_resp_rule_payload elements, respectively.
A stim_resp_rule_payload specifies an entire stimulus-response rule besides its name. It is interpreted as a Muldis D sys.std.Core.Type.Cat.StimRespRule value. The stimulus and response elements specify the stimulus and response attributes, respectively, of the new StimRespRule, which is the kind of stimulus and the name of the recipe or procedure being invoked in response. Currently, after-mount is the only kind of stimulus supported; other kinds will be defined in the future.
Examples:
stimulus-response-rule bootstrap {
when after-mount
invoke main
}GENERIC VALUE EXPRESSIONS
Grammar:
<expr__plain_rtn_inv> ::=
<delim_expr>
| <expr_name>
| <named_expr>
| <value>
| <accessor>
| <func_invo>
| <if_else_expr>
| <given_when_def_expr>
| <material_ref_sel_expr>
<expr__rtn_inv_alt_syn> ::=
<expr__plain_rtn_inv>
| <func_invo_alt_syntax>
<delim_expr> ::=
'(' <ws>? <expr> <ws>? ')'
<expr_name> ::=
<lex_entity_name>
<named_expr> ::=
<expr_name> <ws> <infix_bind_op> <ws> <expr>An expr node is the general case of a Muldis D value expression tree (which normally denotes a Muldis D value selector), which must be composed beneath a depot, or specifically into a function or updater or recipe or type or constraint (etc) definition, because in the general case an expr can not be completely evaluated at compile time.
An expr node is a proper superset of a value node, and any occurrences of expr nodes in this document may optionally be substituted with value nodes on a per-instance basis.
An expr node in the PTMD_STD grammar corresponds directly to a tuple of an attribute of a value of the catalog data type sys.std.Core.Type.Cat.ExprNodeSet, which is how a value expression node is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. Or more specifically, an entire tree of PTMD_STD expr nodes corresponds to a set of said attribute tuples, one attribute tuple per expr node. In the nonsugared form, every expr node has an explicitly designated name, as per a PTMD_STD named_expr node, and all child nodes are not declared inline with their parent nodes but rather are declared in parallel with them, and the parents refer to their children by their names. A feature of the PTMD_STD grammar is that expression nodes may be declared without explicit names, such that the parser would generate names for them when deriving system catalog entries, and that is why PTMD_STD supports, and encourages the use of for code brevity/readability, the use of inline-declared expression nodes, especially so when the expr in question is an opaque_value_literal.
Iff an expr is a delim_expr, then it is interpreted simply as if it were its child expr element; the only reason that the delim_expr grammar element exists is to assist the parser in determining the boundaries of an expr where code otherwise might be ambiguous or be interpreted differently than desired due to nesting precedence rules (see "NESTING PRECEDENCE RULES" for more about those). There is never a distinct node in a parser's output for a delim_expr itself.
Iff an expr is an expr_name, then this typically means that the parent expr is having at least one of its children declared with an explicit name rather than inline, same as the corresponding system catalog entry would do, and then the expr_name is the invocation name of that child. Alternately, the expr_name may be the invocation name of one of the expression-containing routine's parameters, in which case the expr in question represents the current argument to that parameter; this also is exactly the same as a corresponding catalog entry for using an argument.
Iff an expr is a named_expr, then the expr element of the named_expr is being declared with an explicit name, and the expr_name element of the named_expr is that name. But if the expr element of the named_expr is an expr_name (or a named_expr TODO: or a param ), then the named_expr is in fact declaring a new node itself (rather than simply naming its child node), which is a tuple of a Muldis D sys.std.Core.Type.Cat.AccExprNodeSet value; the new node is simply declaring an alias for another node, namely the expr element.
Examples:
# an expr_name node #
$foo_expr
# a named_expr node #
$bar_expr ::= factorial( $foo_expr )Generic Expression Attribute Accessors
Grammar:
<accessor> ::=
<acc_via_named> | <acc_via_topic> | <acc_via_anon>
<acc_via_named> ::=
<lex_entity_nc>
<acc_via_topic> ::=
<data_sigil> '.' <NameChain_payload>
<acc_via_anon> ::=
<expr> <unspace> '.' <nc_nonempty>An accessor node represents an accessor or alias for an attribute of another, tuple-valued expression node. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.AccExprNodeSet value. If an accessor is an acc_via_named, then the NameChain_payload element specifies the target attribute of the new AccExprNodeSet. If an accessor is an acc_via_topic, then it is interpreted in exactly the same manner as for an acc_via_named except that the NameChain_payload element is interpreted with a topic element prepended to it; so for example a $.foo is treated as being $topic.foo. If an accessor is an acc_via_anon, then the target is derived from a catenation of the node name that expr has (explicitly or that will be generated for it by the parser) with the nc_nonempty in that order. Note that an acc_via_anon whose expr is an expr_name is also an acc_via_named, and vice-versa.
Examples:
# an accessor node of a named tuple-valued node #
$foo_t.bar_attr
# an accessor node of a tuple-valued node named "topic" #
$.attr # same as $topic.attr #
# an accessor node of an anonymous tuple-valued node #
nlx.lib.tuple_res_func( $arg ).quux_attrGeneric Function Invocation Expressions
Grammar:
<func_invo> ::=
<routine_name> <unspace> <func_arg_list>
<func_arg_list> ::=
'(' <ws>?
[<func_arg> ** [<ws>? ',' <ws>?]]?
<ws>? ')'
<func_arg> ::=
<named_ro_arg> | <anon_ro_arg> | <same_named_ro_arg>
<named_ro_arg> ::=
<invo_param_name> <ws>? '=>' <ws>? <expr>
<invo_param_name> ::=
<Name_payload>
<anon_ro_arg> ::=
<expr>
<same_named_ro_arg> ::=
<data_sigil> <pair_cosigil> <invo_param_name>A func_invo node represents the result of invoking a named function with specific arguments. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.FuncInvoExprNodeSet value. The routine_name element specifies the function attribute of the new FuncInvoExprNodeSet, which is the name of the function being invoked, and the func_arg_list element specifies the args attribute.
In the general case of a function invocation, all of the arguments are named, as per named_ro_arg, and formatting a func_invo node that way is always allowed. In some (common) special cases, some (which might be all) arguments may be anonymous, as per anon_ro_arg.
With just functions in the top-level namespaces sys.std, these 4 special cases apply: If a function has exactly one parameter, then it may be invoked with a single anonymous argument and the latter will bind to that parameter. Or, if a function has multiple parameters but exactly one of those is mandatory, then it may be invoked with just one anonymous argument, which is assumed to bind to the single mandatory parameter, and all optional arguments must be named. Or, if a function has multiple mandatory parameters and one of them is named topic, then it may be invoked with a single anonymous argument and the latter will bind to that parameter. Or, if a function has multiple mandatory parameters and two of them are named topic and other, then it may be invoked with two anonymous arguments and the latter will bind to those parameters in sequential order, the first one to topic and the second one to other.
With just functions in all top-level namespaces except sys.std, these 2 special cases apply (similar to the prior-mentioned latter 2): If a function invocation has either 1 or 2 anonymous arguments, then they will be treated as if they were named arguments for the topic and other parameters; the only or sequentially first argument will bind to topic, and any sequentially second argument will bind to other.
One reason for this difference between treatment of top-level namespaces is it allows the Muldis D parser to convert all the anonymous arguments to named ones (all arguments in the system catalog are named) when parsing the expression-containing routine/etc in isolation from any other user-defined entities. The other reason for this limitation is that it helps with self-documentation; programmers wanting to know an anonymous argument's parameter name won't have to look outside the language spec to find the answer.
Maybe TODO: Consider adding a language pragma to enable use of the first 4 special cases with functions in all top-level namespaces, where the cost of enabling is added implementation complexity and a reduction of the ability to parse exploiting Muldis D code piecemeal.
A special shorthand for named_ro_arg also exists, same_named_ro_arg, which may be used only if the expr of the otherwise-named_ro_arg is an expr_name and that expr_name is identical to the invo_param_name. In this situation, the identical name can be specified just once, which is the shorthand; for example, the named argument foo => $foo may alternately be written out as $>foo (the > being meant to evoke the =>). This shorthand is to help with the possibly common situation where two successive routines in a call-chain have any same-named parameters and arguments are simply being passed through. (This shorthand is like Perl 6's :$a being short for a => $a.)
Examples:
# zero params #
Nothing()
# single mandatory param #
median( Bag:{ 22, 20, 21, 20, 21, 21, 23 } )
# single mandatory param #
factorial( topic => 5 )
# two mandatory params #
frac_quotient( dividend => 43.7, divisor => 16.9 )
# same as previous #
frac_quotient( divisor => 16.9, dividend => 43.7 )
# one mandatory 'topic' param, two optional #
nlx.lib.barfunc( $mand_arg, oa1 => $opt_arg1, oa2 => $opt_arg2 )
# same as previous #
nlx.lib.barfunc( oa2 => $opt_arg2, $mand_arg, oa1 => $opt_arg1 )
# a user-defined function #
nlx.lib.foodb.bazfunc( a1 => 52, a2 => 'hello world' )
# two params named 'topic' and 'other' #
is_identical( $foo, $bar )
# invoke the lexically innermost routine with 2 args #
rtn( $x, $y )
# three named params taking 2 same-named args, 1 diff-named arg #
nlx.lib.passed_thru( $>a, b => 5, $>c )Generic If-Else Expressions
Grammar:
<if_else_expr> ::=
[
[if <ws> <if_expr> <ws> then <ws> <then_expr> <ws> else <ws>]+
| [<if_expr> <ws> '??' <ws> <then_expr> <ws> '!!' <ws>]+
]
<else_expr>
<if_expr> ::=
<expr>
<then_expr> ::=
<expr>
<else_expr> ::=
<expr>An if_else_expr node represents an N-way if-else control flow expression. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.IfElseExprNodeSet value. The whole collection of sequential 1..N if_expr + then_expr elements specifies the if_then attribute of the new IfElseExprNodeSet, which is a sequence of arbitrary but Bool-resulting if expressions, and for just the first one of those in the sequence that at runtime evaluates to Bool:True, its associated then result value is the result of the if_else_expr. The else_expr element specifies the else attribute, which determines the result value of the if_else_expr at runtime if either if_then is an empty sequence or all of its conditionals evaluate to Bool:False. (Note that while an IfElseExprNodeSet tuple can represent zero if_expr + then_expr elements, that isn't an option in this concrete grammar because such an if_else_expr is indistinguishable from the generic expr that else_expr is.)
Examples:
if $foo > 5 then $bar else $baz
if is_empty($ary) then $empty_result else $ary.[0]
if $x = ∅ or $y = ∅ then ∅
else s ((v $x) + ((v $y) exp 3)
if $val isa <Int> then $val exp 3
else if $val isa <Text> then $val x 5
else True
'My answer is: ' ~ ($maybe ?? 'yes' !! 'no')Generic Given-When-Default Expressions
Grammar:
<given_when_def_expr> ::=
given <ws> <given_expr> <ws>
[when <ws> <when_expr> <ws> then <ws> <then_expr> <ws>]*
default <ws> <default_expr>
<given_expr> ::=
<expr>
<when_expr> ::=
<expr>
<then_expr> ::=
<expr>
<default_expr> ::=
<expr>A given_when_def_expr node represents an N-way given-when-default switch control flow expression that dispatches based on matching a single value with several options. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.GivenWhenDefExprNodeSet value. The given_expr element specifies the given attribute of the new GivenWhenDefExprNodeSet, which is the control value for the expression. The whole collection of nonordered 0..N when_expr + then_expr elements specifies the when_then attribute, which is a set of when comparands; if any of these when values matches the value of given, its associated then result value is the result of the given_when_def_expr. The default_expr element specifies the default attribute, which determines the result value of the given_when_def_expr at runtime if either when_then is an empty set or none of its comparands match given.
Examples:
given $digit
when 'T' then 10
when 'E' then 11
default $digitMaterial Reference Selector Expressions
Grammar:
<material_ref_sel_expr> ::=
<material_ref>
| <curried_func>
<material_ref> ::=
'<' <material_name> '>'
<material_name> ::=
<PNSQNameChain_payload>
<curried_func> ::=
<material_ref> <unspace> <func_arg_list>A material_ref node represents a selector invocation for a value of the sys.std.Core.Type.Cat.AbsPathMaterialNC type, which is selected in terms of a value of the sys.std.Core.Type.Cat.RelPathMaterialNC type. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.APMaterialNCSelExprNodeSet value. The material_name element specifies the referencing attribute of the new APMaterialNCSelExprNodeSet, which is the name, from the point of view of the routine embedding this expression node, of the routine or type that the new AbsPathMaterialNC value is supposed to facilitate portable invoking of, from any other routine besides the embedding routine.
A material_ref node also serves as a less-verbose alternate syntax for a PNSQNameChain node, but only for PNSQNameChain values where you actually don't want a relative-path name-chain value. For any material_ref node whose material_name is already an AbsPathMaterialNC payload, a Muldis D parser will silently replace the material_ref node with a PNSQNameChain node whose payload is its material_name. In other words, you can safely use any primary namespace qualified name chain in a material_ref node and get the result that you would reasonably expect. This is primarily useful for system-defined types and routines.
A curried_func node represents a value of the sys.std.Core.Type.Cat.CurriedFuncNC type. It is a special shorthand syntax for a Tuple node that defines a tuple with 2 attributes, function and args, where the first's value is a material_ref node and the second's value is a Tuple node as per a func_invo node's argument list.
Examples:
# a higher-order function curried with 1 argument #
<nlx.lib.filter>( $>search_term )
# a reference to an updater #
<nlx.lib.swap>
# a reference to a data type #
<nlx.lib.foo_type>GENERIC UPDATER OR RECIPE STATEMENTS
Grammar:
<update_stmt__plain_rtn_inv> ::=
<imus_imp_invo>
<update_stmt__rtn_inv_alt_syn> ::=
<update_stmt__plain_rtn_inv>
| <imp_invo_alt_syntax>An update_stmt node is a single member statement of a multi-update statement, which must be composed beneath a depot, or specifically into an updater or recipe definition, because in the general case a update_stmt can not be completely evaluated at compile time. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.MultiUpdStmt value.
Generic In-Multi-Update-Statement Imperative Invocation Statements
Grammar:
<imus_imp_invo> ::=
<routine_name> <unspace> <imus_imp_arg_list>
<imus_imp_arg_list> ::=
'(' <ws>?
[<imus_imp_arg> ** [<ws>? ',' <ws>?]]?
<ws>? ')'
<imus_imp_arg> ::=
<named_upd_arg>
| <named_ro_arg>
| <anon_upd_arg>
| <anon_ro_arg>
| <same_named_upd_arg>
| <same_named_ro_arg>
<named_upd_arg> ::=
<upd_cosigil> <named_ro_arg>
<anon_upd_arg> ::=
<upd_cosigil> <anon_ro_arg>
<same_named_upd_arg> ::=
<upd_cosigil> <same_named_ro_arg>An imus_imp_invo node represents the invocation of a named updater or recipe, with specific subject-to-update or read-only arguments, as a single member statement of a multi-update statement of an updater or recipe. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.MultiUpdStmt value. The routine_name element specifies the imperative attribute of the new MultiUpdStmt, which is the name of the updater or recipe being invoked, and the imus_imp_arg_list element specifies the upd_args plus ro_args attributes, one tuple thereof per imus_imp_arg; each imus_imp_arg having an upd_cosigil yields an upd_args tuple, and each imus_imp_arg without one yields a ro_args tuple.
In the general case of an updater or recipe invocation, all of the arguments are named, as per named_[upd|ro]_arg, and formatting an imus_imp_invo node that way is always allowed. In some (common) special cases, some (which might be all) arguments may be anonymous, as per anon_[upd|ro]_arg. For further details on this, see the func_invo node kind, under "Generic Function Invocation Expressions", because the rules regarding when arguments may be anonymous or must be named are the same for all 4 main routine kinds.
The sole exception to said rules is that the rules are evaluated independently for subject-to-update arguments and read-only arguments, because those 2 argument groups and their corresponding parameters effectively have independent namespaces with respect to that the presence or absence of an upd_cosigil can always be counted on to distinguish the groups. This means, for example, that you can have an anonymous subject-to-update argument plus an anonymous read-only argument to a system-defined updater or recipe where none of the corresponding parameters are named topic.
The imus_imp_invo node kind also has the same special shorthand for named arguments, in the form of same_named_[upd|ro]_arg, as the func_invo node kind does with its same_named_ro_arg, but that imus_imp_invo's version also works with subject-to-update arguments.
Examples:
# two mandatory params, one s-t-u, one r-o #
assign( &$foo, 3 )
# same as previous #
assign( 3, &$foo )
# still same as previous but with all-named syntax #
assign( &target => $foo, v => 3 )
# three mandatory params #
nlx.lib.lookup( &$>addr, $>people, $>name )GENERIC PROCEDURE STATEMENTS
Grammar:
<proc_stmt__plain_rtn_inv> ::=
<stmt_name>
| <named_stmt>
| <compound_stmt>
| <atomic_stmt>
| <iproc_imp_invo>
| <try_catch_stmt>
| <if_else_stmt>
| <given_when_def_stmt>
| <leave_or_iterate_or_loop_stmt>
<proc_stmt__rtn_inv_alt_syn> ::=
<proc_stmt__plain_rtn_inv>
| <imp_invo_alt_syntax>
<stmt_name> ::=
<stmt_sigil> <Name_payload>
<stmt_sigil> ::=
'|'
<named_stmt> ::=
<stmt_name> <ws> <infix_bind_op> <ws> <proc_stmt>A proc_stmt node is the general case of a Muldis D statement tree, which must be composed beneath a depot, or specifically into a procedure definition, because in the general case a proc_stmt can not be completely evaluated at compile time.
A proc_stmt node in the PTMD_STD grammar corresponds directly to a tuple of an attribute of a value of the catalog data type sys.std.Core.Type.Cat.StmtNodeSet, which is how a statement node is actually represented in Muldis D's nonsugared form, which is as a component of the system catalog. Or more specifically, an entire tree of PTMD_STD proc_stmt nodes corresponds to a set of said attribute tuples, one attribute tuple per proc_stmt node. In the nonsugared form, every proc_stmt node has an explicitly designated name, as per a PTMD_STD named_stmt node, and all child nodes are not declared inline with their parent nodes but rather are declared in parallel with them, and the parents refer to their children by their names. A feature of the PTMD_STD grammar is that statement nodes may be declared without explicit names, such that the parser would generate names for them when deriving system catalog entries, and that is why PTMD_STD supports, and encourages the use of for code brevity/readability, the use of inline-declared statement nodes.
Iff a proc_stmt is an stmt_name, then this typically means that the parent proc_stmt is having at least one of its children declared with an explicit name rather than inline, same as the corresponding system catalog entry would do, and then the stmt_name is the invocation name of that child.
Note that, regarding Muldis D's feature of a statement node having an explicit name that can be referenced by "leave" and "iterate" control flow statements to leave or re-iterate the corresponding block, both SQL and Perl have native counterpart features in the form of block labels.
Examples:
# a stmt_name node #
|foo_stmt
# a named_stmt node #
|bar_stmt ::= nlx.lib.swap( &$>first, &$>second )Generic Compound Statements
Grammar:
<compound_stmt> ::=
<nonempty_procedure_body_or_compound_stmt>A compound_stmt node specifies a procedure compound statement composed of a sequence of 0..N other statements such that those other statements execute in this given sequence; it lies at the heart of what makes a procedure nonatomic, because each statement of the sequence conceptually executes at a different time. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.CompoundStmtNodeSet value. Each proc_stmt element of a compound_statement is a nested statement that is interpreted as its own tuple of an attribute of the stmt attribute of the host Procedure; for each said tuple, there exists an element of the CompoundStmtNodeSet's stmts attribute which matches the name attribute of the tuple. Any with_clause or proc_var direct elements of a compound_stmt are interpreted as if they were directly in the nonempty_procedure_body that the compound_stmt is under.
Examples:
[
var $message : Text
read_Text_line( &$message )
write_Text_line( $message )
]Procedure Atomic Statements
Grammar:
<atomic_stmt> ::=
<nonempty_updater_or_recipe_body>An atomic_stmt node is a special shorthand syntax that is equivalent to the combination of a with_clause node that defines an inner updater of a procedure plus an iproc_imp_invo node that is a procedure statement invoking said updater. It entirely takes the form of an updater body specification, which is delimited by a pair of curly braces; conceptually an atomic_stmt is analogous to a compound_stmt, the latter entirely taking the form of a procedure body; these are distinguished from each other primarily by the different delimiter characters they use. The inner updater derived from a atomic_stmt has an entirely parser-generated updater heading, which is derived from information gleaned from both the atomic_stmt node and from other parts of the procedure specification in which the latter is embedded. The inner updater has a regular parameter for every distinct expr_name node in the atomic_stmt which matches the unqualified name of either a parameter or a lexical variable of the procedure, meaning that the expr_name refers to an updater parameter rather than some updater body expression node, and the updater invocation is passing an argument to each parameter from a same-named var_name. For each updater parameter, the declared type of that parameter is identical to the declared type of the corresponding procedure parameter or lexical variable. For each updater parameter, that parameter is declared subject-to-update iff the updater uses it as an argument to a subject-to-update parameter in one of its update_stmt nodes; otherwise that parameter is declared read-only. No parameters are optional nor dispatch, and the updater doesn't implement a virtual. The unqualified name of the updater is parser-generated; see "MATERIAL SPECIFICATION".
Examples:
{
$x := $y
$y := $x
}Procedure Value Expressions
Grammar:
<proc_expr> ::=
<var_name>
| <opaque_value_literal>
| <material_ref>
| <nil_func_invo>
<var_name> ::=
<lex_entity_name>
<nil_func_invo> ::=
<routine_name> '()'A proc_expr node is the general case of a Muldis D value expression which may be composed within the body of a procedure. A proc_expr node is a proper subset of an expr node, specifically the subset of the language grammar constructs of expr that are valid for use within the body of a procedure, which is very restricted in that regard relative to the body of an atomic routine in which any expr is valid.
A var_name node has exactly the same format as an expr_name node, and it has the same interpretation as well except that it references a lexical variable or parameter of the containing procedure, rather than an expression node or parameter. A var_name node corresponds directly to the native system catalog entry that would be used where it appears in code; a routine invocation argument value in the system catalog is natively the name of a lexical variable or parameter, as are all other places in a procedure body that take an input value or store an output value.
A proc_expr that isn't a var_name is treated as a triple of distinct lexical elements of its containing procedure. The first lexical element is the declaration of a lexical variable whose name is generated by the parser; the second lexical element is a procedure statement which assigns a statically determined value to that variable; the third lexical element is a var_name that is used where the proc_expr had appeared, which names the lexical variable so that the previously assigned value can be used there. The lexical variable is effectively a temporary constant since it is assigned to only once with a value that is hard-coded and is used exactly once, and it has no user-visible name in the original code. Note that a sufficiently intelligent parser can notice if multiple such temporary variables are given the same value and optimize the code so in fact just one variable is declared, assigned to once, read multiple times.
Iff a proc_expr is an opaque_value_literal, then the second lexical element it becomes is a tuple of a Muldis D sys.std.Core.Type.Cat.OVLScaValStmtNodeSet value, and the declared type of the variable is the most-specific system-defined type of the value denoted by the opaque_value_literal.
Iff a proc_expr is an material_ref, then: Iff its material_name element is not already an AbsPathMaterialNC, then the second lexical element the proc_expr becomes is a tuple of a Muldis D sys.std.Core.Type.Cat.APMaterialNCSelStmtNodeSet value; otherwise, the second lexical element is a tuple of a OVLScaValStmtNodeSet; in either case, the declared type of the variable is AbsPathMaterialNC.
A nil_func_invo node has exactly the same format as a func_invo node whose func_arg_list is empty but that it also disallows any insignificant whitespace. Iff a proc_expr is a nil_func_invo, then the second lexical element it becomes is a tuple of a Muldis D sys.std.Core.Type.Cat.NilFuncInvoStmtNodeSet value, and the declared type of the variable is Universal.
Generic In-Procedure Imperative Invocation Statements
Grammar:
<iproc_imp_invo> ::=
<routine_name> <unspace> <iproc_imp_arg_list>
<iproc_imp_arg_list> ::=
'(' <ws>?
[<iproc_imp_arg> ** [<ws>? ',' <ws>?]]?
<ws>? ')'
<iproc_imp_arg> ::=
<iproc_named_upd_arg>
| <iproc_named_ro_arg>
| <iproc_anon_upd_arg>
| <iproc_anon_ro_arg>
| <iproc_same_named_upd_arg>
| <iproc_same_named_ro_arg>
<iproc_named_upd_arg> ::=
<upd_cosigil> <invo_param_name> <ws>? '=>' <ws>? <var_name>
<iproc_named_ro_arg> ::=
<invo_param_name> <ws>? '=>' <ws>? <proc_expr>
<iproc_anon_upd_arg> ::=
<upd_cosigil> <var_name>
<iproc_anon_ro_arg> ::=
<proc_expr>
<iproc_same_named_upd_arg> ::=
<upd_cosigil> <data_sigil> <pair_cosigil> <invo_param_name>
<iproc_same_named_ro_arg> ::=
<data_sigil> <pair_cosigil> <invo_param_name>An iproc_imp_invo node represents the invocation of a named imperative routine, with specific subject-to-update or read-only arguments, as a statement of a procedure. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.ImpInvoStmtNodeSet value. The routine_name element specifies the imperative attribute of the new ImpInvoStmtNodeSet, which is the name of the imperative routine being invoked, and the iproc_imp_arg_list element specifies the upd_args plus ro_args attributes, one tuple thereof per iproc_imp_arg; each iproc_imp_arg having an upd_cosigil yields an upd_args tuple, and each iproc_imp_arg without one yields a ro_args tuple.
For details regarding the variation of formats that an iproc_imp_arg can have, including when arguments may be anonymous or be written out in shorthand, see the imus_imp_invo node kind, under "Generic In-Multi-Update-Statement Imperative Invocation Statements", because the rules regarding these things are the same for imperatives invoked by a procedure as for imperatives invoked by an updater or recipe. The only main difference between an iproc_imp_invo and a imus_imp_invo is that the former may only name its host procedure's variables (or parameters) as arguments while the latter can use arbitrary value expressions for that.
As a common special situation, iff an iproc_imp_invo node specifies an invocation of the updater sys.std.Core.Universal.assign and that updater's v argument is specified by a proc_expr node that isn't a var_name node, then the iproc_imp_invo node is not actually interpreted as a tuple of a Muldis D ImpInvoStmtNodeSet value as in the general case. Rather, the process described in "Procedure Value Expressions", where the proc_expr node is treated as a triple of distinct lexical elements, is altered such that the lexical variable it declares just takes the name from the var_name given to the updater's target argument, rather than the variable's name being generated by the parser, and the iproc_imp_invo node simply disappears without creating a catalog statement node that reads from this variable; so ultimately the iproc_imp_invo node just creates a catalog statement that sets the variable, as a tuple of a OVLScaValStmtNodeSet or APMaterialNCSelStmtNodeSet or NilFuncInvoStmtNodeSet value. This means that the single concrete syntax of the iproc_imp_invo grammar node is used to define tuples of 4 different StmtNodeSet attributes.
Examples:
fetch_curr_instant( &$now )
prompt_Text_line( &$name, 'Enter a person\as name: ' )
Integer.fetch_random( &$rand, $interval )Generic Try-Catch Statements
Grammar:
<try_catch_stmt> ::=
try <ws> <try_stmt>
[<ws> catch <ws> <catch_stmt>]?
<try_stmt> ::=
<proc_stmt>
<catch_stmt> ::=
<proc_stmt>A try_catch_stmt node represents a try-catch control flow statement. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.TryCatchStmtNodeSet value. The try_stmt and catch_stmt elements specify the try and catch attributes, respectively, of the new TryCatchStmtNodeSet, which are the names or definitions of statements that represent the invocation of named imperative routines. The try routine is unconditionally invoked first and then iff try throws an exception then it will be caught and the catch routine, if any, will be invoked immediately after to handle it; if catch also throws an exception then it will not be caught. It is invalid for try_stmt or catch_stmt to name or define a procedure statement that isn't just a routine invocation, though the grammar itself doesn't say so; mainly the valid options are: iproc_imp_invo, atomic_stmt, imp_invo_alt_syntax, and stmt_name or named_stmt for the first 3.
Examples:
try
nlx.lib.attempt_the_work()
catch
nlx.lib.deal_with_failure()Generic If-Else Statements
Grammar:
<if_else_stmt> ::=
if <ws> <if_proc_expr> <ws> then <ws> <then_stmt>
[<ws> else <ws> if <ws> <if_proc_expr> <ws> then <ws> <then_stmt>]*
[<ws> else <ws> <else_stmt>]?
<if_proc_expr> ::=
<proc_expr>
<then_stmt> ::=
<proc_stmt>
<else_stmt> ::=
<proc_stmt>An if_else_stmt node represents an N-way if-else control flow statement. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.IfElseStmtNodeSet value. The whole collection of sequential 1..N if_proc_expr + then_stmt elements specifies the if_then attribute of the new IfElseStmtNodeSet, which is a sequence of arbitrary but Bool-valued if lexical variables (possibly sugar-coated with static-value expressions), and for just the first one of those in the sequence that at runtime is valued with Bool:True, its associated then statement is executed as if it were the whole if_else_stmt. The else_stmt element, if it is provided, specifies the else attribute, which determines the statement to execute as if it were the whole if_else_stmt at runtime if either if_then is an empty sequence or all of its conditionals are valued with Bool:False. (Note that while an IfElseStmtNodeSet tuple can represent zero if_proc_expr + then_stmt elements, that isn't an option in this concrete grammar because such an if_else_stmt is indistinguishable from the generic proc_stmt that else_stmt is.)
Examples:
if $out_of_options then
nlx.lib.give_up()
else
nlx.lib.keep_going()Generic Given-When-Default Statements
Grammar:
<given_when_def_stmt> ::=
given <ws> <given_proc_expr> <ws>
[when <ws> <when_proc_expr> <ws> then <ws> <then_stmt> <ws>]*
[default <ws> <default_stmt>]?
<given_proc_expr> ::=
<proc_expr>
<when_proc_expr> ::=
<proc_expr>
<then_stmt> ::=
<proc_stmt>
<default_stmt> ::=
<proc_stmt>A given_when_def_stmt node represents an N-way given-when-default switch control flow statement that dispatches based on matching a single value with several options. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.GivenWhenDefStmtNodeSet value. The given_proc_expr element specifies the given attribute of the new GivenWhenDefStmtNodeSet, which is the control value for the statement. The whole collection of nonordered 0..N when_proc_expr + then_stmt elements specifies the when_then attribute, which is a set of when comparands; if any of these when values matches the value of given, its associated then statement is executed as if it were the whole given_when_def_stmt. The default_stmt element specifies the default attribute, which determines the statement that is executed at runtime as if it were the whole given_when_def_stmt if either proc_when_then is an empty set or none of its comparands match given.
Examples:
given $picked_menu_item
when 'v' then
nlx.lib.screen_view_record()
when 'a' then
nlx.lib.screen_add_record()
when 'd' then
nlx.lib.screen_delete_record()
default
nlx.lib.display_bad_choice_error()Procedure Leave, Iterate, and Loop Statements
Grammar:
<leave_or_iterate_or_loop_stmt> ::=
<leave_stmt>
| <iterate_stmt>
| <loop_stmt>
<leave_stmt> ::=
leave [<ws> <stmt_name>]?
<iterate_stmt> ::=
iterate [<ws> <stmt_name>]?
<loop_stmt> ::=
loop <ws> <proc_stmt>The 3 node kinds leave_stmt, iterate_stmt, loop_stmt are all very useable independently and are also commonly used together.
A leave_stmt node represents an instruction to abnormally exit the block defined by a parent statement node (a normal exit is to simply execute to the end of the block). If the parent node in question is the root (compound) statement node for the host procedure, that is, if the parent node has the empty string as its name, then the latter will be exited; this is how a "return" statement is represented. If the parent node in question is an iterating or looping statement, then any remaining iterations it might have had are skipped, especially useful if it was an infinite loop. A leave_stmt node is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.LeaveStmtNodeSet value. The optional stmt_name element specifies the name of the parent statement node to completely abort; that name becomes the iterate attribute of the new LeaveStmtNodeSet tuple. Iff the leave_stmt has no stmt_name element then the parser will automatically generate said element with a value of the empty string, meaning it is a "return" statement.
An iterate_stmt node represents an instruction to abnormally end the current iteration of a looping block defined by a parent statement node, and then start at the beginning of the next iteration of that loop if there are any left; or, it can also be used to "redo" any non-looping parent statement. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.IterateStmtNodeSet value. The optional stmt_name element specifies the name of the parent statement node to continue execution at the beginning of; that name becomes the iterate attribute of the new IterateStmtNodeSet tuple. Iff the iterate_stmt has no stmt_name element then the parser will automatically generate said element with a value of the empty string. Having the stmt_name value of the empty string means that the root (compound) statement of the host procedure is being referenced, in which case the iterate_stmt is saying to redo the whole procedure.
A loop_stmt node represents a generic looping statement block which iterates until a child "leave" statement executes. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.LoopStmtNodeSet value. The proc_stmt element specifies the name or definition of the child statement node to be repeatedly executed; the name of that statement becomes the loop attribute of the new LoopStmtNodeSet tuple.
A loop_stmt node in combination with leave_stmt or iterate_stmt nodes is useful for a more ad-hoc means of performing nonatomic iteration as well as for effectively simulating the syntax of common "while" or "for i" loops, so Muldis D doesn't include special "while" or "for i" syntax. A loop_stmt is not an effective "for each item in list" replacement, however; Muldis D currently doesn't provide a nonatomic "foreach", but typically any tasks for such can effectively be performed in atomic code using various list-processing relational routines; if a case can be made for nonatomic "foreach" then Muldis D may gain this feature in the future.
Examples:
|lookup_person ::= loop [
prompt_Text_line( &$name, 'Enter a name to search for: ' )
given $name when '' leave |lookup_person
nlx.lib.do_search( $>name, &$>not_found, &$>report_text )
if $not_found then [
write_Text_line( 'No person matched' )
iterate |lookup_person
]
write_Text_line( $report_text )
]FUNCTION INVOCATION ALTERNATE SYNTAX EXPRESSIONS
Grammar:
<func_invo_alt_syntax> ::=
<comm_infix_reduce_op_invo>
| <noncomm_infix_reduce_op_invo>
| <sym_dyadic_infix_op_invo>
| <nonsym_dyadic_infix_op_invo>
| <monadic_prefix_op_invo>
| <monadic_postfix_op_invo>
| <postcircumfix_op_invo>
| <num_op_invo_with_round>
| <ord_compare_op_invo>
| ...A func_invo_alt_syntax node represents the result of invoking a named system-defined function with specific arguments. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.FuncInvoExprNodeSet value. A func_invo_alt_syntax node is a lot like a func_invo node in purpose and interpretation but it differs in several significant ways.
While a func_invo node can be used to invoke any function at all, a func_invo_alt_syntax node can only invoke a fraction of them, and only standard system-defined functions. While a func_invo node uses a simple common format with all functions, written in prefix notation with generally named arguments, a func_invo_alt_syntax node uses potentially unique syntax for each function, often written in infix notation, although inter-function format consistency is still applied as much as is reasonably possible.
Broadly speaking, a func_invo_alt_syntax node has 2-3 kinds of payload elements: The first is the determinant of what function to invoke, hereafter referred to as an op or keyword. The second is an ordered list of 1-N mandatory function inputs, hereafter referred to as main op args, whose elements typically have generic names like expr or lhs or rhs. The (optional) third is a named list of optional function inputs, hereafter referred to as extra op args, whose elements tend to have more purpose-specific names such as using_clause, though note that things like using_clause can be either mandatory or optional depending on the op they are being used with.
The decision of which system-defined functions get the special alternate syntax treatment partly comes down to respecting common good practices in programming languages, letting people write code more like how they're comfortable with. Most programming languages only have special syntax for a handful of their operators, such as common comparison and boolean and mathematical and string and element extraction operators, and so Muldis D mainly does likewise. Functions get special alternate syntax if they would be frequently used and the syntax would significantly aid programmers in quickly writing understandeable code.
Simple Commutative N-adic Infix Reduction Operators
Grammar:
<comm_infix_reduce_op_invo> ::=
<expr> ** [<ws> <comm_infix_reduce_op> <ws>]
<comm_infix_reduce_op__op_cr_basic> ::=
and | or | xnor | iff | xor
| '+' | '*'
| union | intersect | exclude | symdiff
| join | times | 'cross-join'
<comm_infix_reduce_op__op_cr_extended> ::=
<comm_infix_reduce_op__op_cr_basic>
| '∧' | '∨' | '↔' | '⊻' | '↮'
| '∪' | '∩' | '∆'
| '⋈' | '×'A comm_infix_reduce_op_invo node is for using infix notation to invoke a (homogeneous) commutative N-adic reduction operator function. Such a function takes exactly 1 actual argument, which is unordered-collection typed (set or bag), and the elements of that collection are the inputs of the operation; the inputs are all of the same type as each other and of the result. A single comm_infix_reduce_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines a single argument, whose value is a Set or Bag node, which has a payload expr element for each expr element of the comm_infix_reduce_op_invo, and the relative sequence of the expr elements isn't significant. A comm_infix_reduce_op_invo node requires at least 2 input value providing child nodes (expr must match at least twice), which are its 2-N main op args; if you already have your inputs in a single collection-valued node then use func_invo to invoke the function instead. If comm_infix_reduce_op matches more than once in the same comm_infix_reduce_op_invo, then all of the comm_infix_reduce_op matches must be identical / the same operator.
Some of the keywords are aliases for each other:
keyword | aliases
----------+--------
and | ∧
or | ∨
xnor | ↔ iff
xor | ⊻ ↮
union | ∪
intersect | ∩
exclude | ∆ symdiff
join | ⋈
times | × cross-joinThis table indicates which function is invoked by each keyword:
and -> Core.Boolean.and( Set:{ $expr[0], ..., $expr[n] } )
or -> Core.Boolean.or( Set:{ $expr[0], ..., $expr[n] } )
xnor -> Core.Boolean.xnor( Bag:{ $expr[0], ..., $expr[n] } )
xor -> Core.Boolean.xor( Bag:{ $expr[0], ..., $expr[n] } )
+ -> Core.Numeric.sum( Bag:{ $expr[0], ..., $expr[n] } )
* -> Core.Numeric.product( Bag:{ $expr[0], ..., $expr[n] } )
union -> Core.Relation.union( Set:{ $expr[0], ..., $expr[n] } )
intersect -> Core.Relation.intersection(
Set:{ $expr[0], ..., $expr[n] } )
exclude -> Core.Relation.exclusion( Bag:{ $expr[0], ..., $expr[n] } )
join -> Core.Relation.join( Set:{ $expr[0], ..., $expr[n] } )
times -> Core.Relation.product( Set:{ $expr[0], ..., $expr[n] } )Examples:
True and False and True
True or False or True
True xor False xor True
14 + 3 + -5
-6 * 2 * 25
4.25 + -0.002 + 1.0
69.3 * 15*2^6 * 49/23
Set:{ 1, 3, 5 } ∪ Set:{ 4, 5, 6 } ∪ Set:{ 0, 9 }
Set:{ 1, 3, 5, 7, 9 } ∩ Set:{ 3, 4, 5, 6, 7, 8 } ∩ Set:{ 2, 5, 9 }Simple Non-commutative N-adic Infix Reduction Operators
Grammar:
<noncomm_infix_reduce_op_invo> ::=
<expr> ** [<ws> <noncomm_infix_reduce_op> <ws>]
<noncomm_infix_reduce_op> ::=
'[<=>]' | '~' | '//' | '//d'A noncomm_infix_reduce_op_invo node is for using infix notation to invoke a (homogeneous) non-commutative N-adic reduction operator function. Such a function takes exactly 1 actual argument, which is ordered-collection typed (array), and the elements of that collection are the inputs of the operation; the inputs are all of the same type as each other and of the result. A single noncomm_infix_reduce_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines a single argument, whose value is an Array node, which has a payload expr element for each expr element of the noncomm_infix_reduce_op_invo, and the expr elements have the same relative sequence. A noncomm_infix_reduce_op_invo node requires at least 2 input value providing child nodes (expr must match at least twice), which are its 2-N main op args; if you already have your inputs in a single collection-valued node then use func_invo to invoke the function instead. If noncomm_infix_reduce_op matches more than once in the same noncomm_infix_reduce_op_invo, then all of the noncomm_infix_reduce_op matches must be identical / the same operator. Exception: with some of these, the actual func_arg_list derived from this has 2 actual arguments, the first a collection and the second taking a different type of value, from the last op input list element.
This table indicates which function is invoked by each keyword:
[<=>] -> Core.Cat.Order.reduction( Array:{ $expr[0], ..., $expr[n] } )
~ -> Core.Stringy.catenation( Array:{ $expr[0], ..., $expr[n] } )
// -> Core.Set.Maybe.attr_or_value(
Array:{ $expr[0], ..., $expr[n-1] }, value => $expr[n] )
//d -> Core.Set.Maybe.attr_or_default(
Array:{ $expr[0], ..., $expr[n-1] }, default => $expr[n] )Examples:
Same [<=>] Increase [<=>] Decrease
F;'DEAD' ~ 1;'10001101' ~ F;'BEEF'
'hello' ~ ' ' ~ 'world'
Array:[ 24, 52 ] ~ Array:[ -9 ] ~ Array:[ 0, 11, 24, 7 ]
$a // $b // 42
$a //d $b //d <nlx.lib.foo_type>Simple Symmetric Dyadic Infix Operators
Grammar:
<sym_dyadic_infix_op_invo> ::=
<expr> <ws> <sym_dyadic_infix_op> <ws> <expr>
<sym_dyadic_infix_op__op_cr_basic> ::=
'=' | '!='
| nand | nor
| '|-|'
| compose
<sym_dyadic_infix_op__op_cr_extended> ::=
<sym_dyadic_infix_op__op_cr_basic>
| '≠'
| '⊼' | '↑' | '⊽' | '↓'A sym_dyadic_infix_op_invo node is for using infix notation to invoke a symmetric dyadic operator function. Such a function takes exactly 2 arguments, which are the inputs of the operation; the inputs are all of the same type as each other but the result might be of either that type or a different type. A single sym_dyadic_infix_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines 2 arguments, and the 2 expr elements of the sym_dyadic_infix_op_invo supply the values of those arguments, and which arguments get which expr isn't significant.
Some of the keywords are aliases for each other:
keyword | aliases
--------+--------
!= | ≠
nand | ⊼ ↑
nor | ⊽ ↓This table indicates which function is invoked by each keyword:
= -> Core.Universal.is_identical( $expr[0], $expr[1] )
!= -> Core.Universal.is_not_identical( $expr[0], $expr[1] )
nand -> Core.Boolean.nand( $expr[0], $expr[1] )
nor -> Core.Boolean.nor( $expr[0], $expr[1] )
|-| -> Core.Numeric.abs_diff( $expr[0], $expr[1] )
compose -> Core.Relation.composition( $expr[0], $expr[1] )Examples:
$foo = $bar
$foo ≠ $bar
False nand True
15 |-| 17
7.5 |-| 9.0Simple Non-symmetric Dyadic Infix Operators
Grammar:
<nonsym_dyadic_infix_op_invo> ::=
<lhs> <ws> <nonsym_dyadic_infix_op> <ws> <rhs>
<lhs> ::=
<expr>
<rhs> ::=
<expr>
<nonsym_dyadic_infix_op__op_cr_basic> ::=
isa | '!isa' | 'not-isa' | as | asserting | assuming
| imp | implies | nimp | if | nif
| '-' | '/' | '^' | exp
| x
| where | '!where' | 'not-where'
| in-r | '!in-r' | 'not-in-r' | r-has | 'r-!has' | 'r-not-has'
| in-s | '!in-s' | 'not-in-s' | s-has | 's-!has' | 's-not-has'
| in-b | '!in-b' | 'not-in-b' | b-has | 'b-!has' | 'b-not-has'
| sub | '!sub' | 'not-sub' | super | '!super' | 'not-super'
| psub | '!psub' | 'not-psub' | psuper | '!psuper' | 'not-psuper'
| minus | except
| '!matching' | 'not-matching' | antijoin | semiminus
| matching | semijoin
| divideby
| like | '!like' | 'not-like'
<nonsym_dyadic_infix_op__op_cr_extended> ::=
<nonsym_dyadic_infix_op__op_cr_basic>
| '→' | '↛' | '←' | '↚'
| '∈r' | '¬in;r' | 'r∋' | 'r∌'
| '∈s' | '¬in;s' | 's∋' | 's∌'
| '∈b' | '¬in;b' | 'b∋' | 'b∌'
| '⊆' | '⊈' | '⊇' | '⊉'
| '⊂' | '⊄' | '⊃' | '⊅'
| '∖' | '⊿' | '⋉' | '÷'A nonsym_dyadic_infix_op_invo node is for using infix notation to invoke a non-symmetric dyadic operator function. Such a function takes exactly 2 arguments, which are the inputs of the operation; the inputs and the result may possibly be all of the same type, or they might all be of different types. A single nonsym_dyadic_infix_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines 2 arguments, and the 2 expr elements of the nonsym_dyadic_infix_op_invo supply the values of those arguments, which are associated in the appropriate sequence.
Some of the keywords are aliases for each other:
keyword | aliases
----------+--------
!isa | not-isa
imp | → implies
nimp | ↛
if | ←
nif | ↚
!where | not-where
in-r | ∈r
!in-r | ¬in;r not-in-r
r-has | r∋
r-!has | r∌ r-not-has
in-s | ∈s
!in-s | ¬in;s not-in-s
s-has | s∋
s-!has | s∌ s-not-has
in-b | ∈b
!in-b | ¬in;b not-in-b
b-has | b∋
b-!has | b∌ b-not-has
sub | ⊆
!sub | ⊈ not-sub
super | ⊇
!super | ⊉ not-super
psub | ⊂
!psub | ⊄ not-psub
psuper | ⊃
!psuper | ⊅ not-psuper
minus | ∖ except
!matching | ⊿ not-matching antijoin semiminus
matching | ⋉ semijoin
divideby | ÷
!like | not-likeThis table indicates which function is invoked by each keyword:
isa -> Core.Universal.is_value_of_type( $lhs, type => $rhs )
!isa -> Core.Universal.is_not_value_of_type( $lhs, type => $rhs )
as -> Core.Universal.treated( $lhs, as => $rhs )
asserting -> Core.Universal.assertion( $lhs, is_true => $rhs )
assuming -> sys.std.Core.Cat.curried_func_static_exten(
function => $lhs, args => $rhs )
imp -> Core.Boolean.imp( $lhs, $rhs )
nimp -> Core.Boolean.nimp( $lhs, $rhs )
if -> Core.Boolean.if( $lhs, $rhs )
nif -> Core.Boolean.nif( $lhs, $rhs )
- -> Core.Numeric.diff( minuend => $lhs, subtrahend => $rhs )
/ -> Core.Numeric.frac_quotient( dividend => $lhs, divisor => $rhs )
^ -> Core.Numeric.power_with_whole_exp( radix => $lhs,
exponent => $rhs )
exp -> Core.Integer.power( radix => $lhs, exponent => $rhs )
x -> Core.Stringy.replication( $lhs, count => $rhs )
where -> Core.Relation.restriction( $lhs, func => $rhs )
!where -> Core.Relation.cmpl_restr( $lhs, func => $rhs )
in-r -> Core.Relation.tuple_is_member( t => $lhs, r => $rhs )
!in-r -> Core.Relation.tuple_is_not_member( t => $lhs, r => $rhs )
r-has -> Core.Relation.has_member( r => $lhs, t => $rhs )
r-!has -> Core.Relation.has_not_member( r => $lhs, t => $rhs )
in-s -> Core.Set.value_is_member( value => $lhs, set => $rhs )
!in-s -> Core.Set.value_is_not_member( value => $lhs, set => $rhs )
s-has -> Core.Set.has_member( set => $lhs, value => $rhs )
s-!has -> Core.Set.has_not_member( set => $lhs, value => $rhs )
in-b -> Core.Bag.value_is_member( value => $lhs, bag => $rhs )
!in-b -> Core.Bag.value_is_not_member( value => $lhs, bag => $rhs )
b-has -> Core.Bag.has_member( bag => $lhs, value => $rhs )
b-!has -> Core.Bag.has_not_member( bag => $lhs, value => $rhs )
sub -> Core.Relation.is_subset( $lhs, $rhs )
!sub -> Core.Relation.is_not_subset( $lhs, $rhs )
super -> Core.Relation.is_superset( $lhs, $rhs )
!super -> Core.Relation.is_not_superset( $lhs, $rhs )
psub -> Core.Relation.is_proper_subset( $lhs, $rhs )
!psub -> Core.Relation.is_not_proper_subset( $lhs, $rhs )
psuper -> Core.Relation.is_proper_superset( $lhs, $rhs )
!psuper -> Core.Relation.is_not_proper_superset( $lhs, $rhs )
minus -> Core.Relation.diff( source => $lhs, filter => $rhs )
!matching -> Core.Relation.semidiff( source => $lhs, filter => $rhs )
matching -> Core.Relation.semijoin( source => $lhs, filter => $rhs )
divideby -> Core.Relation.quotient( dividend => $lhs, divisor => $rhs )
like -> Core.Text.is_like( look_in => $lhs, look_for => $rhs )
!like -> Core.Text.is_not_like( look_in => $lhs, look_for => $rhs )Note that while the is[|_not]_like functions also have an optional third parameter escape, you will have to use a func_invo node to exploit it; for simplicity, the infix like and !like don't support that customization; but most actual uses of like/etc don't use escape anyway.
Examples:
$bar isa <nlx.lib.foo_type>
$bar !isa <nlx.lib.foo_type>
$scalar as <Int>
$int asserting ($int ≠ 0)
True implies False
34 - 21
2 exp 63
9.2 - 0.1
1;101.01 / 1;11.0
'-' x 80
Set:{ 8, 4, 6, 7 } ∖ Set:{ 9, 0, 7 }
Relation:[ x, y ];{ [ 5, 6 ], [ 3, 6 ] } ÷ Relation:{ { y => 6 } }Simple Monadic Prefix Operators
Grammar:
<monadic_prefix_op_invo> ::=
<monadic_prefix_op> <ws> <expr>
<monadic_prefix_op__op_cr_basic> ::=
d | not | '!' | '||' | 'r#' | t | r | s | v
<monadic_prefix_op__op_cr_extended> ::=
<monadic_prefix_op__op_cr_basic>
| '¬'A monadic_prefix_op_invo node is for using prefix notation to invoke a monadic operator function. Such a function takes exactly 1 argument, which is the input of the operation. A single monadic_prefix_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines 1 argument, and the 1 expr element of the monadic_prefix_op_invo supplies the value of that argument.
Some of the keywords are aliases for each other:
keyword | aliases
--------+--------
not | ¬ !This table indicates which function is invoked by each keyword:
d -> Core.Universal.default( of => $expr )
not -> Core.Boolean.not( $expr )
|| -> Core.Numeric.abs( $expr )
r# -> Core.Relation.cardinality( $expr )
t -> Core.Cast.Tuple_from_Relation( $expr )
r -> Core.Cast.Relation_from_Tuple( $expr )
s -> Core.Set.Maybe.single( value => $expr )
v -> Core.Set.Maybe.attr( $expr )Examples:
d <nlx.lib.foo_type>
not True
|| -23
|| -4.59
r# Set:{ 5, -1, 2 }
t $relvar
r $tupvar
s ((v $a) + (v $b))Simple Monadic Postfix Operators
Grammar:
<monadic_postfix_op_invo> ::=
<expr> <ws> <monadic_postfix_op>
<monadic_postfix_op> ::=
'++' | '--' | 'i!'A monadic_postfix_op_invo node is for using prefix notation to invoke a monadic operator function. Such a function takes exactly 1 argument, which is the input of the operation. A single monadic_postfix_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines 1 argument, and the 1 expr element of the monadic_postfix_op_invo supplies the value of that argument.
This table indicates which function is invoked by each keyword:
++ -> Core.Ordered.Ordinal.succ( $expr )
-- -> Core.Ordered.Ordinal.pred( $expr )
i! -> Core.Integer.factorial( $expr )Examples:
13 ++
4 --
5 i!Simple Postcircumfix Operators
Grammar:
<postcircumfix_op_invo> ::=
<pcf_acc_op_invo>
| <s_pcf_op_invo> | <t_pcf_op_invo> | <r_pcf_op_invo>
| <pcf_ary_op_invo>
<pcf_acc_op_invo> ::=
<pcf_s_acc_op_invo> | <pcf_t_acc_op_invo>
<pcf_s_acc_op_invo> ::=
<expr> <unspace> '.${' [<ws>? <possrep_name> ';']? <ws>?
<attr_name>
<ws>? '}'
<pcf_t_acc_op_invo> ::=
<expr> <unspace> '.%{' <ws>? <attr_name> <ws>? '}'
<s_pcf_op_invo> ::=
<expr> <unspace> '${' [<ws>? <possrep_name> ';']? <ws>?
[<pcf_projection> | <pcf_cmpl_proj>]
<ws>? '}'
<t_pcf_op_invo> ::=
<expr> <unspace> '%{' <ws>?
[
<pcf_rename>
| <pcf_projection> | <pcf_cmpl_proj>
| <pcf_wrap> | <pcf_cmpl_wrap>
| <pcf_unwrap>
]
<ws>? '}'
<r_pcf_op_invo> ::=
<expr> <unspace> '@{' <ws>?
[
<pcf_rename>
| <pcf_projection> | <pcf_cmpl_proj>
| <pcf_wrap> | <pcf_cmpl_wrap>
| <pcf_unwrap>
| <pcf_group> | <pcf_cmpl_group>
| <pcf_ungroup>
| <pcf_count_per_group>
]
<ws>? '}'
<pcf_rename> ::=
<pcf_rename_map>
<pcf_rename_map> ::=
[<atnm_after> <ws>? '<-' <ws>? <atnm_before>] ** [<ws>? ',' <ws>?]
<atnm_after> ::=
<attr_name>
<atnm_before> ::=
<attr_name>
<pcf_projection> ::=
<pcf_atnms>?
<pcf_cmpl_proj> ::=
'!' <ws>? <pcf_atnms>
<pcf_atnms> ::=
<attr_name> ** [<ws>? ',' <ws>?]
<pcf_wrap> ::=
'%' <outer_atnm> <ws>? '<-' <ws>? <inner_atnms>
<pcf_cmpl_wrap> ::=
'%' <outer_atnm> <ws>? '<-' <ws>? '!' <ws>? <cmpl_inner_atnms>
<pcf_unwrap> ::=
<inner_atnms> <ws>? '<-' <ws>? '%' <outer_atnm>
<pcf_group> ::=
'@' <outer_atnm> <ws>? '<-' <ws>? <inner_atnms>
<pcf_cmpl_group> ::=
'@' <outer_atnm> <ws>? '<-' <ws>? '!' <ws>? <cmpl_inner_atnms>
<pcf_ungroup> ::=
<inner_atnms> <ws>? '<-' <ws>? '@' <outer_atnm>
<pcf_count_per_group> ::=
'#@' <count_atnm> <ws>? '<-' <ws>? '!' <ws>? <cmpl_inner_atnms>
<outer_atnm> ::=
<attr_name>
<count_atnm> ::=
<attr_name>
<inner_atnms> ::=
<pcf_atnms>
<cmpl_inner_atnms> ::=
<pcf_atnms>
<pcf_ary_op_invo> ::=
<pcf_ary_acc_op_invo> | <pcf_ary_slice_op_invo>
<pcf_ary_value_op_invo> ::=
<expr> <unspace> '.[' <ws>? <index> <ws>? ']'
<index> ::=
<num_max_col_val> ';' <unspace> <nnint_body>
| <d_nnint_body>
<pcf_ary_slice_op_invo> ::=
<expr> <unspace> '[' <ws>?
<min_index> <ws>? <interval_boundary_kind> <ws>? <max_index>
<ws>? ']'
<min_index> ::=
<index>
<max_index> ::=
<index>A postcircumfix_op_invo node is for using postcircumfix notation to invoke a relational operator function whose operation involves deriving a single tuple|relation from another single tuple|relation customized only by further inputs that are attribute names. Such a function takes exactly 2 (expr and pcf_rename_map|pcf_atnms) or 3 (expr and outer_atnm and inner_atnms|cmpl_inner_atnms) or 3 (expr and count_atnm and cmpl_inner_atnms) primary arguments, which are the inputs of the operation. A single postcircumfix_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines 2-3 arguments, and the 2-3 expr|pcf[_rename_map|atnms]|[outer|count]_atnm|[|cmpl_]inner_atnms elements of the postcircumfix_op_invo supply the values of those arguments, which are associated in the appropriate sequence.
This table indicates which function is invoked by each format-keyword:
.${} -> Core.Scalar.attr( $expr, possrep => $possrep_name,
name => $attr_name )
.%{} -> Core.Tuple.attr( $expr, name => $attr_name )
%{<-} -> Core.Tuple.rename( $expr,
map => Relation:{
{ after => $atnm_after[0], before => $atnm_before[0] },
...,
{ after => $atnm_after[n], before => $atnm_before[n] },
} )
@{<-} -> Core.Relation.rename( $expr,
map => Relation:{
{ after => $atnm_after[0], before => $atnm_before[0] },
...,
{ after => $atnm_after[n], before => $atnm_before[n] },
} )
${} -> Core.Scalar.projection( $expr, possrep => $possrep_name,
attr_names => Set:{ $pcf_atnms[0], ..., $pcf_atnms[n] } )
%{} -> Core.Tuple.projection( $expr,
attr_names => Set:{ $pcf_atnms[0], ..., $pcf_atnms[n] } )
@{} -> Core.Relation.projection( $expr,
attr_names => Set:{ $pcf_atnms[0], ..., $pcf_atnms[n] } )
${!} -> Core.Scalar.cmpl_proj( $expr, possrep => $possrep_name,
attr_names => Set:{ $pcf_atnms[0], ..., $pcf_atnms[n] } )
%{!} -> Core.Tuple.cmpl_proj( $expr,
attr_names => Set:{ $pcf_atnms[0], ..., $pcf_atnms[n] } )
@{!} -> Core.Relation.cmpl_proj( $expr,
attr_names => Set:{ $pcf_atnms[0], ..., $pcf_atnms[n] } )
%{%<-} -> Core.Tuple.wrap( $expr, outer => $outer_atnm,
inner => Set:{ $inner_atnms[0], ..., $inner_atnms[n] } )
@{%<-} -> Core.Relation.wrap( $expr, outer => $outer_atnm,
inner => Set:{ $inner_atnms[0], ..., $inner_atnms[n] } )
%{%<-!} -> Core.Tuple.cmpl_wrap( $expr, outer => $outer_atnm,
cmpl_inner => Set:{ $cmpl_inner_atnms[0], ... } )
@{%<-!} -> Core.Relation.cmpl_wrap( $expr, outer => $outer_atnm,
cmpl_inner => Set:{ $cmpl_inner_atnms[0], ... } )
%{<-%} -> Core.Tuple.unwrap( $expr,
inner => Set:{ $inner_atnms[0], ..., $inner_atnms[n] },
outer => $outer_atnm )
@{<-%} -> Core.Relation.unwrap( $expr,
inner => Set:{ $inner_atnms[0], ..., $inner_atnms[n] },
outer => $outer_atnm )
@{@<-} -> Core.Relation.group( $expr, outer => $outer_atnm,
inner => Set:{ $inner_atnms[0], ..., $inner_atnms[n] } )
@{@<-!} -> Core.Relation.cmpl_group( $expr, outer => $outer_atnm,
group_per => Set:{ $cmpl_inner_atnms[0], ... } )
@{<-@} -> Core.Relation.ungroup( $expr,
inner => Set:{ $inner_atnms[0], ..., $inner_atnms[n] },
outer => $outer_atnm )
@{#@<-!} -> Core.Relation.cardinality_per_group( $expr,
count_attr_name => $count_atnm,
group_per => Set:{ $cmpl_inner_atnms[0], ... } )
.[] -> Core.Array.value( $expr, $>index )
[] -> Core.Array.slice( $expr, index_interval => SPInterval:{
$min_index $interval_boundary_kind $max_index } )Examples:
$birthday.${date;day}
$pt.%{city}
$pt%{pnum<-pno, locale<-city}
$pr@{pnum<-pno, locale<-city}
$birthday${date;year,month}
$pt%{color,city}
$pr@{color,city}
$pt%{} # null projection #
$pr@{} # null projection #
$rnd_rule${!round_meth} # radix,min_exp #
$pt%{!pno,pname,weight}
$pr@{!pno,pname,weight}
$person%{%name <- fname,lname}
$people@{%name <- fname,lname}
$person%{%all_but_name <- !fname,lname}
$people@{%all_but_name <- !fname,lname}
$person%{fname,lname <- %name}
$people@{fname,lname <- %name}
$orders@{@vendors <- vendor}
$orders@{@all_but_vendors <- !vendor}
$orders@{vendor <- @vendors}
$people@{#@count_per_age_ctry <- !age,ctry}
$ary.[3]
$ary[10..14]Numeric Operators That Do Rounding
Grammar:
<num_op_invo_with_round> ::=
<num_op_invo> <ws> <rounded_with_meth_or_rule_clause>
<num_op_invo> ::=
<expr>
| <infix_num_op_invo>
| <prefix_num_op_invo>
| <postfix_num_op_invo>
<infix_num_op_invo> ::=
<lhs> <ws> <infix_num_op> <ws> <rhs>
<infix_num_op> ::=
div | mod | '**' | log
<prefix_num_op_invo> ::=
<expr> <ws> <prefix_num_op>
<prefix_num_op>
'e**'
<postfix_num_op_invo> ::=
<expr> <ws> <postfix_num_op>
<postfix_num_op>
'log-e'
<rounded_with_meth_or_rule_clause> ::=
round <ws> [<round_meth> | <round_rule>]
<round_meth> ::=
<expr>
<round_rule> ::=
<expr>A num_op_invo_with_round node is for using infix or prefix or postfix notation to invoke a rational numeric operator function whose operation involves rounding a number to one with less precision. Such a function takes exactly 1 (expr) or 2 (lhs and rhs) primary arguments, which are the inputs of the operation, plus a special round_rule argument which specifies explicitly the semantics of the numeric rounding in a declarative way (all 2 or 3 of these are main op args). A single num_op_invo_with_round node is equivalent to a single func_invo node whose func_arg_list element defines 2-3 arguments, and the expr|lhs|rhs|round_[meth|rule] elements of the num_op_invo_with_round supply the values of those arguments, which are associated in the appropriate sequence.
This table indicates which function is invoked by each keyword:
div -> Core.Numeric.whole_quotient( dividend => $lhs, divisor => $rhs,
$>round_meth )
mod -> Core.Numeric.remainder( dividend => $lhs, divisor => $rhs,
$>round_meth )
-> Core.Rational.round( $expr, $>round_rule )
** -> Core.Rational.power( radix => $lhs, exponent => $rhs,
$>round_rule )
log -> Core.Rational.log( $lhs, radix => $rhs, $>round_rule )
e** -> Core.Rational.natural_power( $expr, $>round_rule )
log-e -> Core.Rational.natural_log( $expr, $>round_rule )Examples:
5 div 3 round ToZero
5 mod 3 round ToZero
$foo round RatRoundRule:[10,-2,HalfEven]
2.0 ** 0.5 round RatRoundRule:[2,-7,ToZero]
309.1 log 5.4 round RatRoundRule:[10,-4,HalfUp]
e** 6.3 round RatRoundRule:[10,-6,Up]
17.0 log-e round RatRoundRule:[3,-5,Down]Order Comparison Operators
Grammar:
<ord_compare_op_invo> ::=
<sca_ord_det_op_invo> | <gen_compare_op_invo>
<sca_ord_det_op_invo> ::=
<lhs> <ws> '<=>' <ws> <rhs>
[<ws> <assuming_clause>]?
[<ws> <reversed_clause>]?
<gen_compare_op_invo> ::=
[
<compare_reduce_op_invo>
| <dyadic_compare_op_invo>
]
[<ws> <gen_compare_op_ordered_clause>]?
<compare_reduce_op_invo> ::=
<expr> ** [<ws> <compare_reduce_op> <ws>]
<compare_reduce_op> ::=
min | max
<dyadic_compare_op_invo> ::=
<lhs> <ws> <dyadic_compare_op> <ws> <rhs>
<dyadic_compare_op__op_cr_basic> ::=
'<' | '<=' | '>' | '>='
| in-i | '!in-i' | 'not-in-i' | i-has | 'i-!has' | 'i-not-has'
| between | '!between' | 'not-between'
<dyadic_compare_op__op_cr_extended> ::=
<dyadic_compare_op__op_cr_basic>
| '≤' | '≥'
| '∈i' | '¬in;i' | 'i∋' | 'i∌'
<gen_compare_op_ordered_clause> ::=
ordered <ws> <using_clause> | <ordered_by_clause>An ord_compare_op_invo node is for using infix notation to invoke an order comparison operator function. Such a function takes exactly 2 (lhs and rhs) or N/2+ (expr) main op args, which are the inputs of the operation, plus 2 extra op args (assuming and reversed for the <=> op, or func and assuming for any other op) which let you customize the semantics of the operation. A single ord_compare_op_invo node is equivalent to a single func_invo node whose func_arg_list element defines 2-N arguments, and the expr|lhs|rhs|func|assuming|reversed elements of the ord_compare_op_invo supply the values of those arguments, which are associated in the appropriate sequence, except for the N-adic operators which are commutative (and associative and idempotent) so the relative order of the main op args isn't significant. Details on the extra op args are pending.
TODO: Update the above paragraph because the referenced func-assuming pair isn't actually in grammar yet, as it would be within "using_clause", and "ordered_by_clause" isn't defined yet, may have parts.
Some of the keywords are aliases for each other:
keyword | aliases
--------+--------
<= | ≤
>= | ≥
in-i | ∈i | between
!in-i | ¬in;i | not-in-i | !between | not-between
i-has | i∋
i-!has | i∌ | i-not-hasThis table indicates which function is invoked by each keyword:
<=> -> Core.Ordered.order( $lhs, $rhs )
min -> Core.Ordered.min( Set:{ $expr[0], ..., $expr[n] } )
max -> Core.Ordered.max( Set:{ $expr[0], ..., $expr[n] } )
< -> Core.Ordered.is_before( $lhs, $rhs )
> -> Core.Ordered.is_after( $lhs, $rhs )
<= -> Core.Ordered.is_before_or_same( $lhs, $rhs )
>= -> Core.Ordered.is_after_or_same( $lhs, $rhs )
in-i -> Core.Interval.value_is_member( value => $lhs,
interval => $rhs )
!in-i -> Core.Interval.value_is_not_member( value => $lhs,
interval => $rhs )
i-has -> Core.Interval.has_member( interval => $lhs, value => $rhs )
i-!has -> Core.Interval.has_not_member( interval => $lhs,
value => $rhs )Details regarding the extra op args is pending. But most of the time you wouldn't be using them, so just the main args represents typical usage.
Examples (for now sans any use of extra op args, which are atypical):
$foo <=> $bar
$a min $b min $c
$a max $b max $c
$foo < $bar
$foo > $bar
$foo ≤ $bar
$foo ≥ $bar
$a ∈i SPInterval:{1..5}
$foo ¬in;i SPInterval:{$min..^$max}IMPERATIVE INVOCATION ALTERNATE SYNTAX STATEMENTS
Grammar:
<imp_invo_alt_syntax> ::=
<imp_monadic_postfix_op_invo>
| <imp_nonsym_dyadic_infix_op_invo>
| ...An imp_invo_alt_syntax node represents the invocation of a named system-defined imperative routine with specific arguments. It is interpreted as a tuple of a Muldis D sys.std.Core.Type.Cat.MultiUpdStmt or sys.std.Core.Type.Cat.ImpInvoExprNodeSet value. An imp_invo_alt_syntax node is a lot like an imus_imp_invo or iproc_imp_invo node in purpose and interpretation but it differs in several significant ways.
While an imus_imp_invo or iproc_imp_invo node can be used to invoke any imperative routine at all (except that an imus_imp_invo can't invoke a procedure), an imp_invo_alt_syntax node can only invoke a fraction of them, and only standard system-defined imperative routines. While an imus_imp_invo or iproc_imp_invo node uses a simple common format with all imperative routines, written in prefix notation with generally named arguments, an imp_invo_alt_syntax node uses potentially unique syntax for each imperative routine, often written in infix notation, although inter-imperative routine format consistency is still applied as much as is reasonably possible.
Broadly speaking, an imp_invo_alt_syntax node has 2-3 kinds of payload elements: The first is the determinant of what imperative routine to invoke, hereafter referred to as an op or keyword. The second is an ordered list of 1-N mandatory imperative routine inputs, hereafter referred to as main op args, whose elements typically have generic names like var_name or lhs_var or rhs_expr. The (optional) third is a named list of optional imperative routine inputs, hereafter referred to as extra op args, whose elements tend to have more purpose-specific names such as using_clause, though note that things like using_clause can be either mandatory or optional depending on the op they are being used with.
Note that, with each of the main imperative invocation alternate syntax statement nodes documented in this main POD section (members of imp_invo_alt_syntax etc), any occurrences of child var_name or proc_expr nodes should be read as being expr nodes instead in contexts where instances of the main nodes are being composed beneath updater or recipe nodes, and just as var_name or proc_expr nodes when composed beneath procedure nodes. This is because any argument to an imperative invocation may be any value or pseudo-variable expression (including a parameter) when that invocation is in an updater or recipe, but said argument can only be a lexical variable or parameter name when in a procedure, except that arguments to read-only parameters in a procedure may alternately be an opaque value literal or niladic function invocation, those being an abstraction over the assignment to and use of a temporary lexical variable for the argument.
Note that the imperative routines with alternate syntax include updaters, recipes, and procedures, and they are all shown in one list for simplicity. But only alternate syntax for updaters is valid in an updater, and only alternate syntax for updaters and recipes is valid in a recipe; all of these alternate syntaxes are valid in a procedure.
Imperative Simple Monadic Postfix Operators
Grammar:
<imp_monadic_postfix_op_invo> ::=
<var_name> <ws> <imp_monadic_postfix_op>
<imp_monadic_postfix_op> ::=
':=++' | ':=--'An imp_monadic_postfix_op_invo node is for using prefix notation to invoke a monadic operator imperative routine. Such a imperative routine takes exactly 1 argument, which is the input of the operation. A single imp_monadic_postfix_op_invo node is equivalent to a single imus_imp_invo or iproc_imp_invo node whose imus_imp_arg_list or iproc_imp_arg_list element defines 1 argument, and the 1 var_name element of the imp_monadic_postfix_op_invo supplies the value of that argument and takes its result.
This table indicates which imperative routine is invoked by each keyword:
:=++ -> Core.Ordered.Ordinal.assign_succ( $var_name )
:=-- -> Core.Ordered.Ordinal.assign_pred( $var_name )Examples:
$counter :=++
$countdown :=--Imperative Simple Non-symmetric Dyadic Infix Operators
Grammar:
<imp_nonsym_dyadic_infix_op_invo> ::=
<lhs_var> <ws> <imp_nonsym_dyadic_infix_op_invo> <ws> <rhs_expr>
<lhs_var> ::=
<var_name>
<rhs_expr> ::=
<proc_expr>
<imp_nonsym_dyadic_infix_op__op_cr_basic> ::=
':='
| ':=union'
| ':=where' | ':=!where' | ':=not-where'
| ':=intersect' | ':=minus' | ':=except'
| ':=!matching' | ':=not-matching' | ':=antijoin | ':=semiminus'
| ':=matching' | ':=semijoin'
| ':=exclude' | ':=symdiff'
<imp_nonsym_dyadic_infix_op__op_cr_extended> ::=
<imp_nonsym_dyadic_infix_op__op_cr_basic>
| ':=∪'
| ':=∩' | ':=∖' | ':=⊿' | ':=⋉'
| ':=∆'An imp_nonsym_dyadic_infix_op_invo node is for using infix notation to invoke a non-symmetric dyadic operator imperative routine. Such an imperative routine takes exactly 2 arguments. A single imp_nonsym_dyadic_infix_op_invo node is equivalent to a single imus_imp_invo or iproc_imp_invo node whose imus_imp_arg_list or iproc_imp_arg_list element defines 2 arguments, and the var_name plus proc_expr elements of the imp_nonsym_dyadic_infix_op_invo supply the values of those arguments, which are associated in the appropriate sequence. When using this infix syntax, the & cosigil isn't used to mark the subject-to-update argument(s).
Some of the keywords are aliases for each other:
keyword | aliases
------------+--------
:=union | :=∪
:=!where | :=not-where
:=intersect | :=∩
:=minus | :=∖ :=except
:=!matching | :=⊿ :=not-matching :=antijoin :=semiminus
:=matching | :=⋉ :=semijoin
:=exclude | :=∆ :=symdiffThis table indicates which imperative routine is invoked by each keyword:
:= -> Core.Universal.assign( &$lhs_var, $rhs_expr )
:=union -> Core.Relation.assign_union( &$lhs_var, $rhs_expr )
:=where -> Core.Relation.assign_restriction( &$lhs_var, $rhs_expr )
:=!where -> Core.Relation.assign_cmpl_restr( &$lhs_var, $rhs_expr )
:=intersect -> Core.Relation.assign_intersection( &$lhs_var,$rhs_expr )
:=minus -> Core.Relation.assign_diff( &$lhs_var, $rhs_expr )
:=!matching -> Core.Relation.assign_semidiff( &$lhs_var, $rhs_expr )
:=matching -> Core.Relation.assign_semijoin( &$lhs_var, $rhs_expr )
:=exclude -> Core.Relation.assign_exclusion( &$lhs_var, $rhs_expr )Examples:
# assign 3 to $foo #
$foo := 3
# delete every person in $people whose age is either 10 or 20 #
$people :=!matching Relation:{ { age => 10 }, { age => 20 } }NESTING PRECEDENCE RULES
This documentation section outlines Muldis D's PTMD_STD dialect's nesting precedence rules, meaning how it accepts Muldis D code lacking explicit expression delimiters and implicitly delimits the expressions therein, in a fully deterministic manner.
Unlike many languages which can have over a dozen precedence levels, such as Perl (about 24) or C, PTMD_STD only has about 7 precedence levels in the interest of simplicity, and so you will likely have to use more explicit expression delimiters to force the nesting precedence you want. That 7 figure assumes the catalog_abstraction_level pragma is rtn_inv_alt_syn; if it is plain_rtn_inv instead, then 3 of the levels can be eliminated, so then PTMD_STD has just 4; if it is code_as_data instead, then 3 more can be eliminated, leaving just 1.
Here we list the 7 levels from "tightest" to "loosest":
- Terms
-
The terms and delimited expressions and tagged delimiteds, which includes every kind of
<expr>that is also a<value>(meaning any<opaque_value_literal>and<coll_value_selector>), as well as any<non_value_comment>and<delim_expr>and<expr_name>and<func_invo>and<material_ref_sel_expr>. In general these are very simple or are entirely or mostly surrounded by some kind of delimiters. These are non-associative or associativity is not applicable. - Postfix
-
The accessors and postcircumfix operators and postfix operators, which includes every kind of
<accessor>and<postcircumfix_op_invo>and<monadic_postfix_op_invo>and<postfix_num_op_invo>and<num_op_invo> <ws> <rounded_with_rule_clause>. These are left-associative. - Prefix
-
The prefix operators, which includes every kind of
<monadic_prefix_op_invo>and<prefix_num_op_invo>. These are right-associative. - Dyadic Infix
-
The dyadic infix operators, which includes every kind of
<sym_dyadic_infix_op_invo>and<nonsym_dyadic_infix_op_invo>and<infix_num_op_invo>and every<ord_compare_op_invo>that is not also a<compare_reduce_op_invo>. These are left-associative. - Reducing Infix
-
The infix reduction operators, which includes every kind of
<comm_infix_reduce_op_invo>and<noncomm_infix_reduce_op_invo>and<compare_reduce_op_invo>. These are left-associative. - Conditional
-
Every
<if_else_expr>and<given_when_def_expr>. The??!!form is right-associative, meaning that$a ?? $b !! $c ?? $d !! $ewill parse as$a ?? $b !! ($c ?? $d !! $e)(like most languages) and not as($a ?? $b !! $c) ?? $d !! $e(like PHP). Theif-then-elseandgiven-when-defaultforms are unambiguous for associativity. - Naming
-
Every
<named_expr>, that is, associating an explicit name with an expression node/tree. These are right-associative, meaning that given a$a ::= $b ::= 5, the expression node of value5has the nameband another, alias node forbhas the namea.
Any imperative code that embeds a value expression has looser precedence than all value expressions.
SEE ALSO
Go to Muldis::D for the majority of distribution-internal references, and Muldis::D::SeeAlso for the majority of distribution-external references.
AUTHOR
Darren Duncan (darren@DarrenDuncan.net)
LICENSE AND COPYRIGHT
This file is part of the formal specification of the Muldis D language.
Muldis D is Copyright © 2002-2010, Muldis Data Systems, Inc.
See the LICENSE AND COPYRIGHT of Muldis::D for details.
TRADEMARK POLICY
The TRADEMARK POLICY in Muldis::D applies to this file too.
ACKNOWLEDGEMENTS
The ACKNOWLEDGEMENTS in Muldis::D apply to this file too.