Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Add syntax highlighting to MarkDown code blocks #482

Merged
merged 1 commit into from
Dec 13, 2024
Merged

[DOC] Add syntax highlighting to MarkDown code blocks #482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Allow to use aliased named references for actions of RHS in parameterizing rules.

```
```yacc
%rule sum(X, Y): X[summand] '+' Y[addend] { $$ = $summand + $addend }
;
```
Expand All @@ -18,7 +18,7 @@ https://github.com/ruby/lrama/pull/410

Allow to use named references for actions of RHS in parameterizing rules caller side.

```
```yacc
opt_nl: '\n'?[nl] <str> { $$ = $nl; }
;
```
Expand All @@ -29,7 +29,7 @@ https://github.com/ruby/lrama/pull/414

Allow to define parameterizing rules in the middle of the grammar.

```
```yacc
%rule defined_option(X): /* empty */
| X
;
Expand All @@ -52,8 +52,8 @@ https://github.com/ruby/lrama/pull/420
Support to report unused terminal symbols.
Run `exe/lrama --report=terms` to show unused terminal symbols.

```
❯ exe/lrama --report=terms sample/calc.y
```console
$ exe/lrama --report=terms sample/calc.y
11 Unused Terms
0 YYerror
1 YYUNDEF
Expand All @@ -74,8 +74,8 @@ https://github.com/ruby/lrama/pull/439
Support to report unused rules.
Run `exe/lrama --report=rules` to show unused rules.

```
❯ exe/lrama --report=rules sample/calc.y
```console
$ exe/lrama --report=rules sample/calc.y
3 Unused Rules
0 unused_option
1 unused_list
Expand All @@ -96,8 +96,8 @@ https://github.com/ruby/lrama/pull/446
Support to warning redefined parameterizing rules.
Run `exe/lrama -W` or `exe/lrama --warnings` to show redefined parameterizing rules.

```
❯ exe/lrama -W sample/calc.y
```console
$ exe/lrama -W sample/calc.y
parameterizing rule redefined: redefined_method(X)
parameterizing rule redefined: redefined_method(X)
```
Expand All @@ -117,7 +117,7 @@ https://github.com/ruby/lrama/pull/457

Allow to specify tag on callee side of parameterizing rules.

```
```yacc
%union {
int i;
}
Expand All @@ -130,7 +130,7 @@ Allow to specify tag on callee side of parameterizing rules.

Allow to use named references for actions of RHS in parameterizing rules.

```
```yacc
%rule option(number): /* empty */
| number { $$ = $number; }
;
Expand All @@ -142,7 +142,7 @@ Allow to use named references for actions of RHS in parameterizing rules.

Allow to nested parameterizing rules with tag.

```
```yacc
%union {
int i;
}
Expand Down Expand Up @@ -179,8 +179,8 @@ User can use `'symbol'?`, `'symbol'+` and `'symbol'*` in RHS of user defined par
Support trace actions for debugging.
Run `exe/lrama --trace=actions` to show grammar rules with actions.

```
❯ exe/lrama --trace=actions sample/calc.y
```console
$ exe/lrama --trace=actions sample/calc.y
Grammar rules with actions:
$accept -> list, YYEOF {}
list -> ε {}
Expand All @@ -199,7 +199,7 @@ expr -> '(', expr, ')' { $$ = $2; }
Support inlining for rules.
The `%inline` directive causes all references to symbols to be replaced with its definition.

```
```yacc
%rule %inline op: PLUS { + }
| TIMES { * }
;
Expand All @@ -213,7 +213,7 @@ expr : number { $$ = $1; }

as same as

```
```yacc
expr : number { $$ = $1; }
| expr '+' expr { $$ = $1 + $3; }
| expr '*' expr { $$ = $1 * $3; }
Expand All @@ -226,7 +226,7 @@ expr : number { $$ = $1; }

User can specify the type of mid rule action by tag (`<bar>`) instead of specifying it with in an action.

```
```yacc
primary: k_case expr_value terms?
{
$<val>$ = p->case_labels;
Expand All @@ -241,7 +241,7 @@ primary: k_case expr_value terms?

can be written as

```
```yacc
primary: k_case expr_value terms?
{
$$ = p->case_labels;
Expand All @@ -266,7 +266,7 @@ Bison supports this feature from 3.1.

Support `preceded`, `terminated` and `delimited` rules.

```
```text
program: preceded(opening, X)

// Expanded to
Expand Down Expand Up @@ -302,7 +302,7 @@ In general, these resources are freed by actions or after parsing.
However if syntax error happens in parsing, these codes may not be executed.
Codes associated to `%destructor` are executed when semantic value is popped from the stack by an error.

```
```yacc
%token <val1> NUM
%type <val2> expr2
%type <val3> expr
Expand Down Expand Up @@ -350,7 +350,7 @@ Lrama provides these five callbacks. Registered functions are called when each e
User also needs to access semantic value of their stack in grammar action. `$:n` provides the way to access to it. `$:n` is translated to the minus index from the top of the stack.
For example

```
```yacc
primary: k_if expr_value then compstmt if_tail k_end
{
/*% ripper: if!($:2, $:4, $:5) %*/
Expand All @@ -375,7 +375,7 @@ https://github.com/ruby/lrama/pull/344

Allow to pass an instantiated rule to other parameterizing rules.

```
```yacc
%rule constant(X) : X
;

Expand All @@ -392,7 +392,7 @@ program : option(constant(number)) // Nested rule

Allow to use nested parameterizing rules when define parameterizing rules.

```
```yacc
%rule option(x) : /* empty */
| X
;
Expand All @@ -419,7 +419,7 @@ https://github.com/ruby/lrama/pull/337

Allow to define parameterizing rule by `%rule` directive.

```
```yacc
%rule pair(X, Y): X Y { $$ = $1 + $2; }
;

Expand All @@ -442,7 +442,7 @@ https://github.com/ruby/lrama/pull/285
Allow to specify type of rules by specifying tag, `<i>` in below example.
Tag is post-modification style.

```
```yacc
%union {
int i;
}
Expand All @@ -469,7 +469,7 @@ https://github.com/ruby/lrama/pull/197

Support `separated_list` and `separated_nonempty_list` parameterizing rules.

```
```text
program: separated_list(',', number)

// Expanded to
Expand Down Expand Up @@ -500,7 +500,7 @@ https://github.com/ruby/lrama/pull/204
Parameterizing rules are template of rules.
It's very common pattern to write "list" grammar rule like:

```
```yacc
opt_args: /* none */
| args
;
Expand Down Expand Up @@ -555,7 +555,7 @@ https://github.com/ruby/lrama/pull/44
Instead of positional references like `$1` or `$$`,
named references allow to access to symbol by name.

```
```yacc
primary: k_class cpath superclass bodystmt k_end
{
$primary = new_class($cpath, $bodystmt, $superclass);
Expand All @@ -564,7 +564,7 @@ primary: k_class cpath superclass bodystmt k_end

Alias name can be declared.

```
```yacc
expr[result]: expr[ex-left] '+' expr[ex.right]
{
$result = $[ex-left] + $[ex.right];
Expand Down
Loading