diff options
Diffstat (limited to 'spec')
| -rw-r--r-- | spec/README.md | 2 | ||||
| -rw-r--r-- | spec/evaluate.md | 2 | ||||
| -rw-r--r-- | spec/grammar.md | 2 | ||||
| -rw-r--r-- | spec/literal.md | 2 | ||||
| -rw-r--r-- | spec/token.md | 2 | ||||
| -rw-r--r-- | spec/types.md | 2 |
6 files changed, 12 insertions, 0 deletions
diff --git a/spec/README.md b/spec/README.md index e1039865..c372df91 100644 --- a/spec/README.md +++ b/spec/README.md @@ -1,3 +1,5 @@ +*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/spec/index.html).* + # BQN specification This directory gives a (currently incomplete) specification for BQN. The specification differs from the [documentation](../doc/README.md) in that its purpose is only to describe the exact details of BQN's operation in the most quickly accessible way, rather than to explain the core ideas of BQN functionality and how it might be used. Since it is easier to specify than to document, the specification is currently more complete than the documentation; for example, it includes nearly all primitives. diff --git a/spec/evaluate.md b/spec/evaluate.md index a555740f..556a4efb 100644 --- a/spec/evaluate.md +++ b/spec/evaluate.md @@ -1,3 +1,5 @@ +*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/spec/evaluate.html).* + This page describes the semantics of the code constructs whose grammar is given in [grammar.md](grammar.md). The formation rules there are not named, and here they are identified by either the name of the term or by copying the rule entirely if there are several alternative productions. Here we assume that the referent of each identifier, or equivalently the connections between identifiers, have been identified according to the [scoping rules](scope.md). diff --git a/spec/grammar.md b/spec/grammar.md index 58544ce8..5b411000 100644 --- a/spec/grammar.md +++ b/spec/grammar.md @@ -1,3 +1,5 @@ +*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/spec/grammar.html).* + BQN's grammar is given below. Terms are defined in a [BNF](https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form) variant. However, handling special names properly is possible but difficult in BNF, so they are explained in text along with the braced block grammar. The symbols `s`, `F`, `_m`, and `_c_` are identifier tokens with subject, function, 1-modifier, and 2-modifier classes respectively. Similarly, `sl`, `Fl`, `_ml`, and `_cl_` refer to literals and primitives of those classes. While names in the BNF here follow the identifier naming scheme, this is informative only: syntactic classes are no longer used after parsing and cannot be inspected in a running program. diff --git a/spec/literal.md b/spec/literal.md index 937363e0..9d60f067 100644 --- a/spec/literal.md +++ b/spec/literal.md @@ -1,3 +1,5 @@ +*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/spec/literal.html).* + A *literal* is a single [token](token.md) that indicates a fixed character, number, or array. While literals indicate values of a data type, [primitives](primitive.md) indicate values of an operation type: function, 1-modifier, or 2-modifier. Two types of literal deal with text. As the source code is considered to be a sequence of unicode code points ("characters"), and these code points are also used for BQN's character [data type](types.md), the representation of a text literal is very similar to its value. In a text literal, the newline character is always represented using the ASCII line feed character, code point 10. A *character literal* is enclosed with single quotes `'` and its value is identical to the single character between them. A *string literal* is enclosed in double quotes `"`, and any double quotes between them must come in pairs, as a lone double quote marks the end of the literal. The value of a string literal is a rank-1 array whose elements are the characters in between the enclosing quotes, after replacing each pair of double quotes with only one such quote. diff --git a/spec/token.md b/spec/token.md index 3c2235eb..52e46d25 100644 --- a/spec/token.md +++ b/spec/token.md @@ -1,3 +1,5 @@ +*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/spec/token.html).* + This page describes BQN's token formation rules (token formation is also called scanning). Most tokens in BQN are a single character long, but quoted characters and strings, identifiers, and numbers can consist of multiple characters, and comments, spaces, and tabs are discarded during token formation. BQN source code should be considered as a series of unicode code points, which we refer to as "characters". The separator between lines in a file is considered to be a single character, newline, even though some operating systems such as Windows typically represent it with a two-character CRLF sequence. Implementers should note that not all languages treat unicode code points as atomic, as exposing the UTF-8 or UTF-16 representation instead is common. For a language such as JavaScript that uses UTF-16, the double-struck characters `𝕨𝕎𝕩𝕏𝕗𝔽𝕘𝔾` are represented as two 16-bit surrogate characters, but BQN treats them as a single unit. diff --git a/spec/types.md b/spec/types.md index 0d142630..d0658feb 100644 --- a/spec/types.md +++ b/spec/types.md @@ -1,3 +1,5 @@ +*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/spec/types.html).* + BQN programs manipulate data of six types: - Character - Number |