1 ## oils_failures_allowed: 0
2
3 #### Open proc (any number of args)
4 shopt --set parse_proc
5
6 proc f {
7 var x = 42
8 return $x
9 }
10 # this gets called with 3 args then?
11 f a b c
12 echo status=$?
13 ## STDOUT:
14 status=42
15 ## END
16
17 #### Closed proc with no args, passed too many
18 shopt --set parse_proc
19
20 proc f() {
21 return 42
22 }
23 f
24 echo status=$?
25
26 f a b # status 2
27
28 ## status: 3
29 ## STDOUT:
30 status=42
31 ## END
32
33 #### Open proc has ARGV
34 shopt -s ysh:all
35 proc foo {
36 echo ARGV @ARGV
37 # do we care about this? I think we want to syntactically remove it from YSH
38 # but it can still be used for legacy
39 echo dollar-at "$@"
40 }
41 builtin set -- a b c
42 foo x y z
43 ## STDOUT:
44 ARGV x y z
45 dollar-at a b c
46 ## END
47
48 #### Closed proc has empty "$@" or ARGV
49 shopt -s ysh:all
50
51 proc foo(d, e, f) {
52 write params $d $e $f
53 argv.py dollar-at "$@"
54 argv.py ARGV @ARGV
55 }
56 builtin set -- a b c
57 foo x y z
58 ## STDOUT:
59 params
60 x
61 y
62 z
63 ['dollar-at', 'a', 'b', 'c']
64 ['ARGV']
65 ## END
66
67 #### Proc with default args
68 shopt --set parse_proc
69
70 proc f(x='foo') {
71 echo x=$x
72 }
73 f
74 ## STDOUT:
75 x=foo
76 ## END
77
78 #### Proc with word params
79 shopt --set parse_proc
80
81 # doesn't require ysh:all
82 proc f(x, y, z) {
83 echo $x $y $z
84 var ret = 42
85 return $ret
86 }
87 # this gets called with 3 args then?
88 f a b c
89 echo status=$?
90 ## STDOUT:
91 a b c
92 status=42
93 ## END
94
95 #### Proc with ... "rest" word params
96
97 # TODO: opts goes with this
98 # var opt = grep_opts.parse(ARGV)
99 #
100 # func(**opt) # Assumes keyword args match?
101 # parse :grep_opts :opt @ARGV
102
103 shopt -s ysh:all
104
105 proc f(...names) {
106 write names: @names
107 }
108 # this gets called with 3 args then?
109 f a b c
110 echo status=$?
111 ## STDOUT:
112 names:
113 a
114 b
115 c
116 status=0
117 ## END
118
119 #### word rest params 2
120 shopt --set ysh:all
121
122 proc f(first, ...rest) { # @ means "the rest of the arguments"
123 write --sep ' ' -- $first
124 write --sep ' ' -- @rest # @ means "splice this array"
125 }
126 f a b c
127 ## STDOUT:
128 a
129 b c
130 ## END
131
132 #### proc with typed args
133 shopt --set ysh:upgrade
134
135 # TODO: duplicate param names aren't allowed
136 proc p (a; mylist, mydict; opt Int = 42) {
137 pp line (a)
138 pp line (mylist)
139 pp line (mydict)
140 #pp line (opt)
141 }
142
143 p WORD ([1,2,3], {name: 'bob'})
144
145 echo ---
146
147 p x (:| a b |, {bob: 42}, a = 5)
148
149 ## STDOUT:
150 (Str) "WORD"
151 (List) [1,2,3]
152 (Dict) {"name":"bob"}
153 ---
154 (Str) "x"
155 (List) ["a","b"]
156 (Dict) {"bob":42}
157 ## END
158
159 #### Proc name-with-hyphen
160 shopt --set parse_proc parse_at
161
162 proc name-with-hyphen {
163 echo @ARGV
164 }
165 name-with-hyphen x y z
166 ## STDOUT:
167 x y z
168 ## END
169
170 #### Proc with block arg
171 shopt --set ysh:upgrade
172
173 # TODO: Test more of this
174 proc f(x, y ; ; ; block) {
175 echo f word $x $y
176
177 if (block) {
178 eval (block)
179 }
180 }
181 f a b { echo FFF }
182
183 # With varargs and block
184 shopt --set parse_proc
185
186 proc g(x, y, ...rest ; ; ; block) {
187 echo g word $x $y
188 echo g rest @rest
189
190 if (block) {
191 eval (block)
192 }
193 }
194 g a b c d {
195 echo GGG
196 }
197
198 ## STDOUT:
199 f word a b
200 FFF
201 g word a b
202 g rest c d
203 GGG
204 ## END
205
206 #### proc returning wrong type
207 shopt --set parse_proc
208
209 # this should print an error message
210 proc f {
211 var a = %(one two)
212 return $a
213 }
214 f
215 ## status: 3
216 ## STDOUT:
217 ## END
218
219 #### proc returning invalid string
220 shopt --set parse_proc
221
222 # this should print an error message
223 proc f {
224 var s = 'not an integer status'
225 return $s
226 }
227 f
228 ## status: 1
229 ## STDOUT:
230 ## END
231
232 #### 'return' doesn't accept expressions
233 proc p {
234 return 1 + 2
235 }
236 p
237 ## status: 2
238 ## STDOUT:
239 ## END
240
241 #### procs are in same namespace as shell functions
242 shopt --set parse_proc
243
244 myfunc() {
245 echo hi
246 }
247
248 proc myproc {
249 echo hi
250 }
251
252 declare -F
253 ## STDOUT:
254 declare -f myfunc
255 declare -f myproc
256 ## END
257
258
259 #### Nested proc is disallowed at parse time
260 shopt --set parse_proc
261
262 # NOTE: we can disallow this in Oil statically ...
263 proc f {
264 proc g {
265 echo 'G'
266 }
267 g
268 }
269 f
270 g
271 ## status: 2
272 ## stdout-json: ""
273
274 #### Procs defined inside compound statements (with redefine_proc)
275
276 shopt --set ysh:upgrade
277 shopt --set redefine_proc_func
278
279 for x in 1 2 {
280 proc p {
281 echo 'loop'
282 }
283 }
284 p
285
286 {
287 proc p {
288 echo 'brace'
289 }
290 }
291 p
292
293 ## STDOUT:
294 loop
295 brace
296 ## END
297
298 #### Block can be passed literally, or as expression in third arg group
299 shopt --set ysh:upgrade
300
301 proc p ( ; ; ; block) {
302 eval (block)
303 }
304
305 p { echo literal }
306
307 var block = ^(echo expression)
308 p (; ; block)
309
310 ## STDOUT:
311 literal
312 expression
313 ## END
314
315 #### Pass through all 4 kinds of args
316
317 shopt --set ysh:upgrade
318
319 proc p2 (...words; ...typed; ...named; block) {
320 pp line (words)
321 pp line (typed)
322 pp line (named)
323 #pp line (block)
324 # To avoid <Block 0x??> - could change pp line
325 echo $[type(block)]
326 }
327
328 proc p1 (...words; ...typed; ...named; block) {
329 p2 @words (...typed; ...named; block)
330 }
331
332 p2 a b ('c', 'd', n=99) {
333 echo literal
334 }
335 echo
336
337 # Same thing
338 var block = ^(echo expression)
339
340 # Note: you need the second explicit ;
341
342 p2 a b ('c', 'd'; n=99; block)
343 echo
344
345 # what happens when you do this?
346 p2 a b ('c', 'd'; n=99; block) {
347 echo duplicate
348 }
349
350 ## status: 1
351 ## STDOUT:
352 (List) ["a","b"]
353 (List) ["c","d"]
354 (Dict) {"n":99}
355 Block
356
357 (List) ["a","b"]
358 (List) ["c","d"]
359 (Dict) {"n":99}
360 Command
361
362 ## END
363
364 #### Global and local ARGV, like "$@"
365 shopt -s parse_at
366 argv.py "$@"
367 argv.py @ARGV
368 #argv.py "${ARGV[@]}" # not useful, but it works!
369
370 set -- 'a b' c
371 argv.py "$@"
372 argv.py @ARGV # separate from the argv stack
373
374 f() {
375 argv.py "$@"
376 argv.py @ARGV # separate from the argv stack
377 }
378 f 1 '2 3'
379 ## STDOUT:
380 []
381 []
382 ['a b', 'c']
383 []
384 ['1', '2 3']
385 []
386 ## END
387
388
389 #### Mutating global ARGV
390
391 $SH -c '
392 shopt -s ysh:upgrade
393
394 argv.py global @ARGV
395
396 # should not be ignored
397 call ARGV->append("GG")
398
399 argv.py global @ARGV
400 '
401 ## STDOUT:
402 ['global']
403 ['global', 'GG']
404 ## END
405
406 #### Mutating local ARGV
407
408 $SH -c '
409 shopt -s ysh:upgrade
410
411 argv.py global @ARGV
412
413 proc p {
414 argv.py @ARGV
415 call ARGV->append("LL")
416 argv.py @ARGV
417 }
418
419 p local @ARGV
420
421 argv.py global @ARGV
422
423 ' dummy0 'a b' c
424
425 ## STDOUT:
426 ['global', 'a b', 'c']
427 ['local', 'a b', 'c']
428 ['local', 'a b', 'c', 'LL']
429 ['global', 'a b', 'c']
430 ## END
431
432
433 #### typed proc allows all kinds of args
434 shopt -s ysh:upgrade
435
436 typed proc p (w; t; n; block) {
437 pp line (w)
438 pp line (t)
439 pp line (n)
440 echo $[type(block)]
441 }
442
443 p word (42, n=99) {
444 echo block
445 }
446
447
448 ## STDOUT:
449 (Str) "word"
450 (Int) 42
451 (Int) 99
452 Block
453 ## END