Commit Graph

67 Commits

Author SHA1 Message Date
Alessandro Coglio
7d21990db1 [ABNF] Tweak documentation. 2021-05-12 19:13:23 -07:00
Alessandro Coglio
566365e501 [ABNF] Move a rule a bit within the file.
No changes to rules.

Just putting two rules close that are somewhat related (as they are used to
define comments).
2021-05-12 19:11:31 -07:00
Alessandro Coglio
7e378545e0 [ABNF] Replace format strings with string literals.
Given that we have string literals now, there is no need for the special notion
of format strings. Some other grammar rules go away as they were only involved
in the definition of format strings.

The well-formedness of containers in format strings is now delegated to the
static semantics of Leo: at the grammar level, any string literals is accepted
in console print calls.
2021-05-12 19:08:02 -07:00
Alessandro Coglio
e304866696 [ABNF] Add string literals.
These are a new kind of literals that denote arrays of characters, which is how
we initially represent strings in Leo.
2021-05-12 19:04:42 -07:00
Alessandro Coglio
d869e17033 [ABNF] Add character literals.
These are a new kind of literals that denote char values.
2021-05-12 18:41:58 -07:00
Alessandro Coglio
19d3bf0125 [ABNF] Add char type.
This is a new scalar type for characters.
2021-05-12 18:22:08 -07:00
Alessandro Coglio
7ac1de7353 [ABNF] Expand some doc and break some lines.
Explain the new syntax for circuit member variables.

Explain the tighter syntax for import declarations.

Keep lines to 80 columns max, so that they fit well in the figures in the LaTeX
document.
2021-05-07 21:33:15 -07:00
gluax
f32a1e9ddb merge master, add a parser test to try and improve code coverage 2021-05-07 13:34:10 -04:00
gluax
29ca0d9a12 no empty import lists, star is a span, grammar fix 2021-05-05 16:10:51 -04:00
gluax
f4c9c2c1f0 update grammar readme after master merge 2021-05-05 13:18:13 -04:00
Alessandro Coglio
8df12668c0 [ABNF] Fix (comment in) rule for identifiers.
Now the comment says that an identifier must not only be distinct from a
keyword, but also not be or start with 'aleo1'. Even though the grammar does not
capture these extra-grammatical requirements, we use comments to at least
mention them prominently.
2021-05-03 21:41:20 -07:00
Alessandro Coglio
5288f2e2f0 [ABNF] Fix rule for import declarations.
The final semicolon was missing.

See https://developer.aleo.org/developer/language/imports.
2021-05-01 18:41:56 -07:00
gluax
c8f1d9913c rename grammar rule as suggested 2021-04-30 12:07:35 -04:00
Alessandro Coglio
2060d0d249 [ABNF] Improve documentation and layout.
Explain better variable and constant declarations.

Leave one blank line between the rules for variable and constant declarations
(not necessary for ABNF, but consistent with the rest of the file and actually
expected by the ABNF-to-LaTeX converter).

Limit lines to 80 columns, by putting the rules for variable and constant
declarations over two lines each, with proper indentation.
2021-04-29 18:16:30 -07:00
gluax
e0cf988261 hacky, but optional comma only allowed on last member variable 2021-04-29 15:22:17 -04:00
gluax
282cbb8840 optional comma at end of member variables 2021-04-29 14:10:22 -04:00
gluax
30d80d191f require comma or semi-colon for now 2021-04-29 14:03:29 -04:00
Alessandro Coglio
ccbf36e6ec Merge and resolve conflict on generated README.md.
(Since the file is generated, I've simply re-generated it to resolve the
conflict.)
2021-04-28 21:57:34 -07:00
Collin Chin
aaa42bba4c
Merge pull request #705 from AleoHQ/feature/485-defines
Feature/485 global consts
2021-04-28 14:06:40 -07:00
gluax
26d569c92a declaration refactor as suggested 2021-04-28 12:41:42 -04:00
Alessandro Coglio
0882100526 [ABNF] Trim some documentation.
The removed text is more of an internal discussion that actual documentation, so
it seems best to keep things slightly more concise.
2021-04-27 22:45:27 -07:00
Alessandro Coglio
244e1a49ee [ABNF] Fix typo in documentation. 2021-04-26 20:30:15 -07:00
gluax
438c20c14d merge master, resolve conflicts, login test is failing 2021-04-26 14:43:21 -04:00
Alessandro Coglio
df6c4d586c [ABNF] Use markdown in doc comments, and a few fixes.
By using markdown in the documentation comments of the grammar, the markdown
file generated from the grammar includes those markdown features in the text,
making it more readable and better-looking.

Also fixed a few typos in the documentation comments.

Also updated a few documentation comments that were out of date after making
changes to the grammar.

Also removed a now-obsolete grammar rule for "input" parameters of functions.
2021-04-21 22:33:52 -07:00
Alessandro Coglio
02f8736d03 [ABNF] Add some documentation.
For both uniformity and clarity of reference from other documentation comments,
add some documentation comments next to every single character definition.

No change to the grammar itself.
2021-04-21 21:56:27 -07:00
Alessandro Coglio
ac5ca5058a [ABNF] Edit some doc comments for consistency.
No change to the grammar, just some edits in comments.
2021-04-21 10:44:40 -07:00
Alessandro Coglio
e08d1f7f36 [ABNF] Move two rules and add some comments.
This does not change the grammar, just its presentation in the file.
2021-04-21 10:39:37 -07:00
Collin Chin
25cabe57e2
Merge branch 'master' into feature/abnf-doc-update 2021-04-21 08:46:01 -07:00
Alessandro Coglio
964883a535 [ABNF] Add full copyright/licensing notice.
Make the change to the .txt file.
2021-04-20 15:52:08 -07:00
Alessandro Coglio
7cfa7d6a54 [ABNF] Move the format note to the end of the file.
Make this change on the .txt file.
2021-04-20 15:46:48 -07:00
Alessandro Coglio
62932ceef2 [ABNF] Update documentation of format strings.
The documentation comments were out of date.
2021-04-19 23:24:43 -07:00
gluax
6e595bd845 remove escaped double quote for now, address(...) removed 2021-04-14 17:43:02 -04:00
gluax
cf36a6bfe7 non-ambigious format strings, escaped double quotes allowed 2021-04-14 17:11:02 -04:00
gluax
1803925b08 semi-colon after return statements are required 2021-04-14 16:59:07 -04:00
gluax
bd9297499e trailing comma in circuit construction expression 2021-04-14 16:19:55 -04:00
gluax
124235c15d remove cast-expression from abnf for now 2021-04-14 16:17:57 -04:00
gluax
11c78da916 formatted string -> renamed format string 2021-04-14 16:15:27 -04:00
gluax
91634d6479 implicit input, removed from function input 2021-04-14 16:00:19 -04:00
Alessandro Coglio
f26114afa5 [ABNF] Make ** right-associative.
As agreed on Slack.
2021-04-09 13:01:59 -07:00
Alessandro Coglio
f19af30f0e [ABNF] Fix rule for affine group literals.
This was

affine-group-literal = "(" group-coordinate "," group-coordinate ")" %s"group"

instead of

affine-group-literal = "(" group-coordinate "," group-coordinate %s")group"

(note the different ending).

This change should have been part of the PR for whitespace in group literals,
but apparently I failed to do that, along with the other changes.

This commit rectifies that omission.
2021-04-06 16:39:07 -07:00
Alessandro Coglio
7da8a3c033 [ABNF] Improve consistency of documentation. 2021-04-06 16:37:18 -07:00
Alessandro Coglio
5f85308444 [ABNF] Improve the syntactic grammar section documentation.
Update some comments that were now out of date.

Clarify some text.

Fix some typos.
2021-04-06 16:35:47 -07:00
Alessandro Coglio
f0bac48093 [ABNF] Improve lexical grammar documentation.
Fix some typos, clarify some text, remove/update some obsolete references.
2021-04-06 16:03:28 -07:00
Alessandro Coglio
e035743f96 [ABNF] Improve naming convention section of documentation.
Some tweaks and some clarifications.
2021-04-06 15:19:41 -07:00
Alessandro Coglio
fdaab572f9 [ABNF] Improve operator precedence section of documentation.
Fix a typo. Tweak some text layout.
2021-04-06 15:14:08 -07:00
Alessandro Coglio
11c0d60021 [ABNF] Improve structure section of documentation.
Make this more concise and clear by just presenting the lexical and syntactic
grammar as the way we define the Leo syntax, as opposed to discussing
alternatives like PEGs.
2021-04-06 14:59:52 -07:00
Alessandro Coglio
c7fb2905c0 [ABNF] Improve background section of documentation.
Explicate references to RFCs a bit.

Use the term 'sequence of terminals' instead of 'string' to avoid any confusion.

(Still use 'string' to refer to the actual strings in double quotes that are
part of the ABNF notation itself.)
2021-04-06 14:45:23 -07:00
Alessandro Coglio
742e3b33ea [ABNF] Improve introduction section of documentation.
Update to say that grammar is no longer just a draft.

Put primary motivation and purpose of grammar first.

Mention use in formalization second, and slightly simplify that part, given that
the formalization is not public yet.
2021-04-06 14:43:55 -07:00
Alessandro Coglio
48635e5dbe [ABNF] Fix typos in documentation. 2021-04-06 14:22:15 -07:00
Alessandro Coglio
880f2cd200 [ABNF] Remove explicit author info, as discussed. 2021-04-05 21:55:19 -07:00