Skip to content

Commit 685303b

Browse files
committed
[skip ci] doc: update generated wiki pages (wiki/Capabilities,wiki/Dataflow Graph,wiki/Search API,wiki/Interface,wiki/Control Flow Graph,wiki/Linting and Testing,wiki/Core,README)
1 parent 106edac commit 685303b

8 files changed

+828
-291
lines changed

README.md

+61-13
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ It offers a wide variety of features, for example:
140140
141141
142142
```text
143-
https://mermaid.live/view#base64:eyJjb2RlIjoiZmxvd2NoYXJ0IEJUXG4gICAgMChbXCJgIzkxO1JTeW1ib2wjOTM7IHRlc3RcbiAgICAgICgwKVxuICAgICAgKjEuMS00KmBcIl0pXG4gICAgMShbXCJgIzkxO1JTeW1ib2wjOTM7IHRlc3RmaWxlc1xuICAgICAgKDEpXG4gICAgICAqMS42LTE0KmBcIl0pXG4gICAgMltbXCJgIzkxO1JCaW5hcnlPcCM5MzsgL1xuICAgICAgKDIpXG4gICAgICAqMS4xLTE0KlxuICAgICgwLCAxKWBcIl1dXG4gICAgMyhbXCJgIzkxO1JTeW1ib2wjOTM7IGV4YW1wbGUuUlxuICAgICAgKDMpXG4gICAgICAqMS4xNi0yNCpgXCJdKVxuICAgIDRbW1wiYCM5MTtSQmluYXJ5T3AjOTM7IC9cbiAgICAgICg0KVxuICAgICAgKjEuMS0yNCpcbiAgICAoMiwgMylgXCJdXVxuICAgIDIgLS0+fFwicmVhZHMsIGFyZ3VtZW50XCJ8IDBcbiAgICAyIC0tPnxcInJlYWRzLCBhcmd1bWVudFwifCAxXG4gICAgNCAtLT58XCJyZWFkcywgYXJndW1lbnRcInwgMlxuICAgIDQgLS0+fFwicmVhZHMsIGFyZ3VtZW50XCJ8IDMiLCJtZXJtYWlkIjp7ImF1dG9TeW5jIjp0cnVlfX0=
143+
https://mermaid.live/view#base64:eyJjb2RlIjoiZmxvd2NoYXJ0IEJUXG4gICAgMChbXCJgIzkxO1JTeW1ib2wjOTM7IHRlc3RcbiAgICAgICgwKVxuICAgICAgKjEuMS00KmBcIl0pXG4gICAgMShbXCJgIzkxO1JTeW1ib2wjOTM7IHRlc3RmaWxlc1xuICAgICAgKDEpXG4gICAgICAqMS42LTE0KmBcIl0pXG4gICAgMltbXCJgIzkxO1JCaW5hcnlPcCM5MzsgL1xuICAgICAgKDIpXG4gICAgICAqMS4xLTE0KlxuICAgICgwLCAxKWBcIl1dXG4gICAgYnVpbHQtaW46X1tcImBCdWlsdC1Jbjpcbi9gXCJdXG4gICAgMyhbXCJgIzkxO1JTeW1ib2wjOTM7IGV4YW1wbGUuUlxuICAgICAgKDMpXG4gICAgICAqMS4xNi0yNCpgXCJdKVxuICAgIDRbW1wiYCM5MTtSQmluYXJ5T3AjOTM7IC9cbiAgICAgICg0KVxuICAgICAgKjEuMS0yNCpcbiAgICAoMiwgMylgXCJdXVxuICAgIDIgLS0+fFwicmVhZHMsIGFyZ3VtZW50XCJ8IDBcbiAgICAyIC0tPnxcInJlYWRzLCBhcmd1bWVudFwifCAxXG4gICAgMiAtLi0+fFwicmVhZHNcInwgYnVpbHQtaW46X1xuICAgIGxpbmtTdHlsZSAyIHN0cm9rZTpncmF5O1xuICAgIDQgLS0+fFwicmVhZHMsIGFyZ3VtZW50XCJ8IDJcbiAgICA0IC0tPnxcInJlYWRzLCBhcmd1bWVudFwifCAzXG4gICAgNCAtLi0+fFwicmVhZHNcInwgYnVpbHQtaW46X1xuICAgIGxpbmtTdHlsZSA1IHN0cm9rZTpncmF5OyIsIm1lcm1haWQiOnsiYXV0b1N5bmMiOnRydWV9fQ==
144144
```
145145
146146
@@ -162,6 +162,8 @@ It offers a wide variety of features, for example:
162162
(2)
163163
*1.1-8*
164164
(0, 1)`"]]
165+
built-in:_-["`Built-In:
166+
#60;#45;`"]
165167
4{{"`#91;RNumber#93; 1
166168
(4)
167169
*2.12*`"}}
@@ -208,14 +210,20 @@ It offers a wide variety of features, for example:
208210
(18)
209211
*6.14-16*
210212
(16, 17)`"]]
213+
built-in:-["`Built-In:
214+
#45;`"]
211215
19[["`#91;RExpressionList#93; (
212216
(19)
213217
*6.13*
214218
(18)`"]]
219+
built-in:_["`Built-In:
220+
(`"]
215221
20[["`#91;RBinaryOp#93; #58;
216222
(20)
217223
*6.11-17*
218224
(13, 19)`"]]
225+
built-in::["`Built-In:
226+
#58;`"]
219227
24(["`#91;RSymbol#93; sum
220228
(24, :may:36+)
221229
*7.10-12*`"])
@@ -265,12 +273,16 @@ It offers a wide variety of features, for example:
265273
(36)
266274
*6.1-9.1*
267275
(12, 20, 35)`"]]
276+
built-in:for["`Built-In:
277+
for`"]
268278
38{{"`#91;RString#93; #34;Sum#58;#34;
269279
(38)
270280
*11.5-10*`"}}
271281
40(["`#91;RSymbol#93; sum
272282
(40)
273283
*11.13-15*`"])
284+
built-in:sum["`Built-In:
285+
sum`"]
274286
42{{"`#91;RString#93; #34;
275287
#34;
276288
(42)
@@ -279,6 +291,8 @@ It offers a wide variety of features, for example:
279291
(44)
280292
*11.1-22*
281293
(38, 40, 42)`"]]
294+
built-in:cat["`Built-In:
295+
cat`"]
282296
46{{"`#91;RString#93; #34;Product#58;#34;
283297
(46)
284298
*12.5-14*`"}}
@@ -297,87 +311,121 @@ It offers a wide variety of features, for example:
297311
0 -->|"defined-by"| 2
298312
2 -->|"argument"| 1
299313
2 -->|"returns, argument"| 0
314+
2 -.->|"reads"| built-in:_-
315+
linkStyle 4 stroke:gray;
300316
3 -->|"defined-by"| 4
301317
3 -->|"defined-by"| 5
302318
5 -->|"argument"| 4
303319
5 -->|"returns, argument"| 3
320+
5 -.->|"reads"| built-in:_-
321+
linkStyle 9 stroke:gray;
304322
6 -->|"defined-by"| 7
305323
6 -->|"defined-by"| 8
306324
8 -->|"argument"| 7
307325
8 -->|"returns, argument"| 6
326+
8 -.->|"reads"| built-in:_-
327+
linkStyle 14 stroke:gray;
308328
9 -->|"defined-by"| 10
309329
9 -->|"defined-by"| 11
310330
11 -->|"argument"| 10
311331
11 -->|"returns, argument"| 9
332+
11 -.->|"reads"| built-in:_-
333+
linkStyle 19 stroke:gray;
312334
12 -->|"defined-by"| 20
313335
16 -->|"reads"| 9
314336
18 -->|"reads, argument"| 16
315337
18 -->|"reads, argument"| 17
338+
18 -.->|"reads"| built-in:-
339+
linkStyle 24 stroke:gray;
316340
19 -->|"returns, argument"| 18
341+
19 -.->|"reads"| built-in:_
342+
linkStyle 26 stroke:gray;
317343
20 -->|"reads, argument"| 13
318344
20 -->|"reads, argument"| 19
345+
20 -.->|"reads"| built-in::
346+
linkStyle 29 stroke:gray;
319347
24 -->|"reads"| 0
320348
24 -->|"reads"| 23
321349
24 -->|"CD-True"| 36
322-
linkStyle 25 stroke:gray,color:gray;
350+
linkStyle 32 stroke:gray,color:gray;
323351
25 -->|"reads"| 12
324352
25 -->|"CD-True"| 36
325-
linkStyle 27 stroke:gray,color:gray;
353+
linkStyle 34 stroke:gray,color:gray;
326354
26 -->|"reads, argument"| 24
327355
26 -->|"reads, argument"| 25
356+
26 -.->|"reads"| built-in:_
357+
linkStyle 37 stroke:gray;
328358
26 -->|"CD-True"| 36
329-
linkStyle 30 stroke:gray,color:gray;
359+
linkStyle 38 stroke:gray,color:gray;
330360
27 -->|"reads"| 6
331361
27 -->|"CD-True"| 36
332-
linkStyle 32 stroke:gray,color:gray;
362+
linkStyle 40 stroke:gray,color:gray;
333363
28 -->|"reads, argument"| 26
334364
28 -->|"reads, argument"| 27
365+
28 -.->|"reads"| built-in:_
366+
linkStyle 43 stroke:gray;
335367
28 -->|"CD-True"| 36
336-
linkStyle 35 stroke:gray,color:gray;
368+
linkStyle 44 stroke:gray,color:gray;
337369
23 -->|"defined-by"| 28
338370
23 -->|"defined-by"| 29
339371
29 -->|"argument"| 28
340372
29 -->|"returns, argument"| 23
373+
29 -.->|"reads"| built-in:_-
374+
linkStyle 49 stroke:gray;
341375
29 -->|"CD-True"| 36
342-
linkStyle 40 stroke:gray,color:gray;
376+
linkStyle 50 stroke:gray,color:gray;
343377
31 -->|"reads"| 3
344378
31 -->|"reads"| 30
345379
31 -->|"CD-True"| 36
346-
linkStyle 43 stroke:gray,color:gray;
380+
linkStyle 53 stroke:gray,color:gray;
347381
32 -->|"reads"| 12
348382
32 -->|"CD-True"| 36
349-
linkStyle 45 stroke:gray,color:gray;
383+
linkStyle 55 stroke:gray,color:gray;
350384
33 -->|"reads, argument"| 31
351385
33 -->|"reads, argument"| 32
386+
33 -.->|"reads"| built-in:_
387+
linkStyle 58 stroke:gray;
352388
33 -->|"CD-True"| 36
353-
linkStyle 48 stroke:gray,color:gray;
389+
linkStyle 59 stroke:gray,color:gray;
354390
30 -->|"defined-by"| 33
355391
30 -->|"defined-by"| 34
356392
34 -->|"argument"| 33
357393
34 -->|"returns, argument"| 30
394+
34 -.->|"reads"| built-in:_-
395+
linkStyle 64 stroke:gray;
358396
34 -->|"CD-True"| 36
359-
linkStyle 53 stroke:gray,color:gray;
397+
linkStyle 65 stroke:gray,color:gray;
360398
35 -->|"argument"| 29
361399
35 -->|"returns, argument"| 34
400+
35 -.->|"reads"| built-in:_
401+
linkStyle 68 stroke:gray;
362402
35 -->|"CD-True"| 36
363-
linkStyle 56 stroke:gray,color:gray;
403+
linkStyle 69 stroke:gray,color:gray;
364404
36 -->|"reads, argument"| 12
365405
36 -->|"reads, argument"| 20
366406
36 -->|"argument, non-standard-evaluation"| 35
407+
36 -.->|"reads"| built-in:for
408+
linkStyle 73 stroke:gray;
367409
40 -->|"reads"| 0
368410
40 -->|"reads"| 23
411+
40 -.->|"reads"| built-in:sum
412+
linkStyle 76 stroke:gray;
369413
44 -->|"argument"| 38
370414
44 -->|"reads, argument"| 40
371415
44 -->|"argument"| 42
416+
44 -.->|"reads"| built-in:cat
417+
linkStyle 80 stroke:gray;
372418
48 -->|"reads"| 3
373419
48 -->|"reads"| 30
374420
52 -->|"argument"| 46
375421
52 -->|"reads, argument"| 48
376422
52 -->|"argument"| 50
423+
52 -.->|"reads"| built-in:cat
424+
linkStyle 86 stroke:gray;
377425
```
378426
379427
380-
(The analysis required _22.08 ms_ (including parse and normalize, using the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
428+
(The analysis required _24.08 ms_ (including parse and normalize, using the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
381429
382430
383431

wiki/Capabilities.md

+25-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-capabilities-markdown.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-capabilities-markdown.ts)' on 2025-03-22, 16:47:09 UTC presenting an overview of flowR's current capabilities (v2.2.12). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-capabilities-markdown.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-capabilities-markdown.ts)' on 2025-04-30, 19:45:57 UTC presenting an overview of flowR's current capabilities (v2.2.12). Please do not edit this file/wiki page directly._
22

33
Each capability has an id that can be used to link to it (use the link symbol to get a direct link to the capability).
44
The internal id is also mentioned in the capability description. This id can be used to reference the capability in a labeled test within flowR.
@@ -49,20 +49,26 @@ Besides, we use colored bullets like this:
4949
> 10["`**function** (L. 1)
5050
> *RFunctionDefinition*`"]
5151
>
52-
> subgraph "flow-10" ["function(x) #123; get(#34;x#34;) #125; (L. 1)"]
52+
> subgraph "flow-10" ["??"]
5353
> 1["`**x** (L. 1)
5454
> *RSymbol*`"]
5555
> 6(["`**#34;x#34;** (L. 1)
5656
> *RString*`"])
5757
> 8[["`**get** (L. 1)
5858
> *RFunctionCall*`"]]
59+
> built-in:get["`Built-In:
60+
> get`"]
5961
> 9[["`**#123;**
6062
> *RExpressionList*`"]]
63+
> built-in:_["`Built-In:
64+
> #123;`"]
6165
> end
6266
> 0["`**#34;f#34;** (L. 1)
6367
> *RString*`"]
6468
> 11[["`**#60;#45;** (L. 1)
6569
> *RBinaryOp*`"]]
70+
> built-in:_-["`Built-In:
71+
> #60;#45;`"]
6672
> 13{{"`**2** (L. 2)
6773
> *RNumber*`"}}
6874
> 12["`**#96;y x#96;** (L. 2)
@@ -77,22 +83,34 @@ Besides, we use colored bullets like this:
7783
> *RFunctionCall*`"]]
7884
> 21[["`**#43;** (L. 3)
7985
> *RBinaryOp*`"]]
86+
> built-in:_["`Built-In:
87+
> #43;`"]
8088
> 23[["`**print** (L. 3)
8189
> *RFunctionCall*`"]]
90+
> built-in:print["`Built-In:
91+
> print`"]
8292
> 1 -->|"defined-by-on-call"| 18
8393
> 6 -->|"reads"| 1
8494
> 8 -->|"reads, argument"| 6
95+
> 8 -.->|"reads"| built-in:get
96+
> linkStyle 3 stroke:gray;
8597
> 9 -->|"returns, argument"| 8
98+
> 9 -.->|"reads"| built-in:_
99+
> linkStyle 5 stroke:gray;
86100
> 10 -.-|function| flow-10
87101
>
88102
> 0 -->|"defined-by"| 10
89103
> 0 -->|"defined-by"| 11
90104
> 11 -->|"argument"| 10
91105
> 11 -->|"returns, argument"| 0
106+
> 11 -.->|"reads"| built-in:_-
107+
> linkStyle 11 stroke:gray;
92108
> 12 -->|"defined-by"| 13
93109
> 12 -->|"defined-by"| 14
94110
> 14 -->|"argument"| 13
95111
> 14 -->|"returns, argument"| 12
112+
> 14 -.->|"reads"| built-in:_-
113+
> linkStyle 16 stroke:gray;
96114
> 16 -->|"reads"| 12
97115
> 18 -->|"defines-on-call"| 1
98116
> 20 -->|"argument"| 18
@@ -101,15 +119,19 @@ Besides, we use colored bullets like this:
101119
> 20 -->|"calls"| 10
102120
> 21 -->|"reads, argument"| 16
103121
> 21 -->|"reads, argument"| 20
122+
> 21 -.->|"reads"| built-in:_
123+
> linkStyle 25 stroke:gray;
104124
> 23 -->|"reads, returns, argument"| 21
125+
> 23 -.->|"reads"| built-in:print
126+
> linkStyle 27 stroke:gray;
105127
> ```
106128
>
107129
>
108130
> <details>
109131
>
110132
> <summary style="color:gray">R Code of the (simplified) Dataflow Graph</summary>
111133
>
112-
> The analysis required _15.91 ms_ (including parse and normalize, using the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.
134+
> The analysis required _17.70 ms_ (including parse and normalize, using the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.
113135
> We encountered unknown side effects (with ids: 23 (linked)) during the analysis.
114136
>
115137
>

0 commit comments

Comments
 (0)