OILS / spec / ysh-proc.test.sh View on Github | oilshell.org

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