-
-
Notifications
You must be signed in to change notification settings - Fork 299
/
builtin_fn_io.go
859 lines (793 loc) · 17.9 KB
/
builtin_fn_io.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
package eval
import (
"encoding/json"
"fmt"
"io"
"io/ioutil"
"os"
"strconv"
"strings"
"github.com/elves/elvish/pkg/diag"
"github.com/elves/elvish/pkg/eval/vals"
"github.com/elves/elvish/pkg/strutil"
)
// Input and output.
func init() {
addBuiltinFns(map[string]interface{}{
// Value output
"put": put,
// Bytes input
"read-upto": readUpto,
"read-line": readLine,
// Bytes output
"print": print,
"echo": echo,
"pprint": pprint,
"repr": repr,
"show": show,
"printf": printf,
// Only bytes or values
//
// These are now implemented as commands forwarding one part of input to
// output and discarding the other. A future optimization the evaler can
// do is to connect the relevant parts directly together without any
// kind of forwarding.
"only-bytes": onlyBytes,
"only-values": onlyValues,
// Bytes to value
"slurp": slurp,
"from-lines": fromLines,
"from-json": fromJSON,
// Value to bytes
"to-lines": toLines,
"to-json": toJSON,
// File and pipe
"fopen": fopen,
"fclose": fclose,
"pipe": pipe,
"prclose": prclose,
"pwclose": pwclose,
})
}
//elvdoc:fn put
//
// ```elvish
// put $value...
// ```
//
// Takes arbitrary arguments and write them to the structured stdout.
//
// Examples:
//
// ```elvish-transcript
// ~> put a
// ▶ a
// ~> put lorem ipsum [a b] { ls }
// ▶ lorem
// ▶ ipsum
// ▶ [a b]
// ▶ <closure 0xc4202607e0>
// ```
//
// Etymology: Various languages, in particular
// [C](https://manpages.debian.org/stretch/manpages-dev/puts.3.en.html) and
// [Ruby](https://ruby-doc.org/core-2.2.2/IO.html#method-i-puts) as `puts`.
func put(fm *Frame, args ...interface{}) {
out := fm.OutputChan()
for _, a := range args {
out <- a
}
}
//elvdoc:fn read-upto
//
// ```elvish
// read-upto $delim
// ```
//
// Reads byte input until `$delim` or end-of-file is encountered, and outputs
// the part of the input read as a string value. The output contains the
// trailing `$delim`, unless `read-upto` terminated at end-of-file.
//
// The `$delim` argument must be a single rune in the ASCII range.
//
// Examples:
//
// ```elvish-transcript
// ~> echo "a,b,c" | read-upto ","
// ▶ 'a,'
// ~> echo "foo\nbar" | read-upto "\n"
// ▶ "foo\n"
// ~> echo "a.elv\x00b.elv" | read-upto "\x00"
// ▶ "a.elv\x00"
// ~> print "foobar" | read-upto "\n"
// ▶ foobar
// ```
func readUpto(fm *Frame, last string) (string, error) {
if len(last) != 1 {
return "", ErrArgs
}
in := fm.InputFile()
var buf []byte
for {
var b [1]byte
_, err := in.Read(b[:])
if err != nil {
if err == io.EOF {
break
}
return "", err
}
buf = append(buf, b[0])
if b[0] == last[0] {
break
}
}
return string(buf), nil
}
//elvdoc:fn read-line
//
// ```elvish
// read-line
// ```
//
// Reads a single line from byte input, and writes the line to the value output,
// stripping the line ending. A line can end with `"\r\n"`, `"\n"`, or end of
// file. Examples:
//
// ```elvish-transcript
// ~> print line | read-line
// ▶ line
// ~> print "line\n" | read-line
// ▶ line
// ~> print "line\r\n" | read-line
// ▶ line
// ~> print "line-with-extra-cr\r\r\n" | read-line
// ▶ "line-with-extra-cr\r"
// ```
func readLine(fm *Frame) (string, error) {
s, err := readUpto(fm, "\n")
if err != nil {
return "", err
}
return strutil.ChopLineEnding(s), nil
}
//elvdoc:fn print
//
// ```elvish
// print &sep=' ' $value...
// ```
//
// Like `echo`, just without the newline.
//
// @cf echo
//
// Etymology: Various languages, in particular
// [Perl](https://perldoc.perl.org/functions/print.html) and
// [zsh](http://zsh.sourceforge.net/Doc/Release/Shell-Builtin-Commands.html), whose
// `print`s do not print a trailing newline.
type printOpts struct{ Sep string }
func (o *printOpts) SetDefaultOptions() { o.Sep = " " }
func print(fm *Frame, opts printOpts, args ...interface{}) {
out := fm.OutputFile()
for i, arg := range args {
if i > 0 {
out.WriteString(opts.Sep)
}
out.WriteString(vals.ToString(arg))
}
}
//elvdoc:fn printf
//
// ```elvish
// printf $template $value...
// ```
//
// Prints values to the byte stream according to a template.
//
// Like [`print`](#print), this command does not add an implicit newline; use
// an explicit `"\n"` in the formatting template instead.
//
// See Go's [`fmt`](https://golang.org/pkg/fmt/#hdr-Printing) package for
// details about the formatting verbs and the various flags that modify the
// default behavior, such as padding and justification.
//
// Unlike Go, each formatting verb has a single associated internal type, and
// accepts any argument that can reasonably be converted to that type:
//
// - The verbs `%s`, `%q` and `%v` convert the corresponding argument to a
// string in different ways:
//
// - `%s` uses [to-string](#to-string) to convert a value to string.
//
// - `%q` uses [repr](#repr) to convert a value to string.
//
// - `%v` is equivalent to `%s`, and `%#v` is equivalent to `%q`.
//
// - The verb `%t` first convert the corresponding argument to a boolean using
// [bool](#bool), and then uses its Go counterpart to format the boolean.
//
// - The verbs `%b`, `%c`, `%d`, `%o`, `%O`, `%x`, `%X` and `%U` first convert
// the corresponding argument to an integer using an internal algorithm, and
// use their Go counterparts to format the integer.
//
// - The verbs `%e`, `%E`, `%f`, `%F`, `%g` and `%G` first convert the
// corresponding argument to a floating-point number using
// [float64](#float64), and then use their Go counterparts to format the
// number.
//
// The special verb `%%` prints a literal `%` and consumes no argument.
//
// Verbs not documented above are not supported.
//
// Examples:
//
// ```elvish-transcript
// ~> printf "%10s %.2f\n" Pi $math:pi
// Pi 3.14
// ~> printf "%-10s %.2f %s\n" Pi $math:pi $math:pi
// Pi 3.14 3.141592653589793
// ~> printf "%d\n" 0b11100111
// 231
// ~> printf "%08b\n" 231
// 11100111
// ~> printf "list is: %q\n" [foo bar 'foo bar']
// list is: [foo bar 'foo bar']
// ```
//
// **Note**: Compared to the [POSIX `printf`
// command](https://pubs.opengroup.org/onlinepubs/007908799/xcu/printf.html)
// found in other shells, there are 3 key differences:
//
// - The behavior of the formatting verbs are based on Go's
// [`fmt`](https://golang.org/pkg/fmt/) package instead of the POSIX
// specification.
//
// - The number of arguments after the formatting template must match the number
// of formatting verbs. The POSIX command will repeat the template string to
// consume excess values; this command does not have that behavior.
//
// - This command does not interpret escape sequences such as `\n`; just use
// [double-quoted strings](language.html#double-quoted-string).
//
// @cf print echo pprint repr
func printf(fm *Frame, template string, args ...interface{}) {
wrappedArgs := make([]interface{}, len(args))
for i, arg := range args {
wrappedArgs[i] = formatter{arg}
}
fmt.Fprintf(fm.OutputFile(), template, wrappedArgs...)
}
type formatter struct {
wrapped interface{}
}
func (f formatter) Format(state fmt.State, r rune) {
wrapped := f.wrapped
switch r {
case 's':
writeFmt(state, 's', vals.ToString(wrapped))
case 'q':
// TODO: Support using the precision flag to specify indentation.
writeFmt(state, 's', vals.Repr(wrapped, vals.NoPretty))
case 'v':
var s string
if state.Flag('#') {
s = vals.Repr(wrapped, vals.NoPretty)
} else {
s = vals.ToString(wrapped)
}
writeFmt(state, 's', s)
case 't':
writeFmt(state, 't', vals.Bool(wrapped))
case 'b', 'c', 'd', 'o', 'O', 'x', 'X', 'U':
var i int
if err := vals.ScanToGo(wrapped, &i); err != nil {
fmt.Fprintf(state, "%%!%c(%s)", r, err.Error())
return
}
writeFmt(state, r, i)
case 'e', 'E', 'f', 'F', 'g', 'G':
var f float64
if err := vals.ScanToGo(wrapped, &f); err != nil {
fmt.Fprintf(state, "%%!%c(%s)", r, err.Error())
return
}
writeFmt(state, r, f)
default:
fmt.Fprintf(state, "%%!%c(unsupported formatting verb)", r)
}
}
// Writes to State using the flag it stores, but with a potentially different
// verb and value.
func writeFmt(state fmt.State, v rune, val interface{}) {
// Reconstruct the verb string.
var sb strings.Builder
sb.WriteRune('%')
for _, f := range "+-# 0" {
if state.Flag(int(f)) {
sb.WriteRune(f)
}
}
if w, ok := state.Width(); ok {
sb.WriteString(strconv.Itoa(w))
}
if p, ok := state.Precision(); ok {
sb.WriteRune('.')
sb.WriteString(strconv.Itoa(p))
}
sb.WriteRune(v)
fmt.Fprintf(state, sb.String(), val)
}
//elvdoc:fn echo
//
// ```elvish
// echo &sep=' ' $value...
// ```
//
// Print all arguments, joined by the `sep` option, and followed by a newline.
//
// Examples:
//
// ```elvish-transcript
// ~> echo Hello elvish
// Hello elvish
// ~> echo "Hello elvish"
// Hello elvish
// ~> echo &sep=, lorem ipsum
// lorem,ipsum
// ```
//
// Notes: The `echo` builtin does not treat `-e` or `-n` specially. For instance,
// `echo -n` just prints `-n`. Use double-quoted strings to print special
// characters, and `print` to suppress the trailing newline.
//
// @cf print
//
// Etymology: Bourne sh.
func echo(fm *Frame, opts printOpts, args ...interface{}) {
print(fm, opts, args...)
fm.OutputFile().WriteString("\n")
}
//elvdoc:fn pprint
//
// ```elvish
// pprint $value...
// ```
//
// Pretty-print representations of Elvish values. Examples:
//
// ```elvish-transcript
// ~> pprint [foo bar]
// [
// foo
// bar
// ]
// ~> pprint [&k1=v1 &k2=v2]
// [
// &k2=
// v2
// &k1=
// v1
// ]
// ```
//
// The output format is subject to change.
//
// @cf repr
func pprint(fm *Frame, args ...interface{}) {
out := fm.OutputFile()
for _, arg := range args {
out.WriteString(vals.Repr(arg, 0))
out.WriteString("\n")
}
}
//elvdoc:fn repr
//
// ```elvish
// repr $value...
// ```
//
// Writes representation of `$value`s, separated by space and followed by a
// newline. Example:
//
// ```elvish-transcript
// ~> repr [foo 'lorem ipsum'] "aha\n"
// [foo 'lorem ipsum'] "aha\n"
// ```
//
// @cf pprint
//
// Etymology: [Python](https://docs.python.org/3/library/functions.html#repr).
func repr(fm *Frame, args ...interface{}) {
out := fm.OutputFile()
for i, arg := range args {
if i > 0 {
out.WriteString(" ")
}
out.WriteString(vals.Repr(arg, vals.NoPretty))
}
out.WriteString("\n")
}
//elvdoc:fn show
//
// ```elvish
// show $e
// ```
//
// Shows the value to the output, which is assumed to be a VT-100-compatible
// terminal.
//
// Currently, the only type of value that can be showed is exceptions, but this
// will likely expand in future.
//
// Example:
//
// ```elvish-transcript
// ~> e = ?(fail lorem-ipsum)
// ~> show $e
// Exception: lorem-ipsum
// [tty 3], line 1: e = ?(fail lorem-ipsum)
// ```
func show(fm *Frame, v diag.Shower) {
fm.OutputFile().WriteString(v.Show(""))
fm.OutputFile().WriteString("\n")
}
const bytesReadBufferSize = 512
//elvdoc:fn only-bytes
//
// ```elvish
// only-bytes
// ```
//
// Passes byte input to output, and discards value inputs.
//
// Example:
//
// ```elvish-transcript
// ~> { put value; echo bytes } | only-bytes
// bytes
// ```
func onlyBytes(fm *Frame) error {
// Discard values in a goroutine.
valuesDone := make(chan struct{})
go func() {
for range fm.InputChan() {
}
close(valuesDone)
}()
// Make sure the goroutine has finished before returning.
defer func() { <-valuesDone }()
// Forward bytes.
buf := make([]byte, bytesReadBufferSize)
for {
nr, errRead := fm.InputFile().Read(buf[:])
if nr > 0 {
// Even when there are write errors, we will continue reading. So we
// ignore the error.
fm.OutputFile().Write(buf[:nr])
}
if errRead != nil {
if errRead == io.EOF {
return nil
}
return errRead
}
}
}
//elvdoc:fn only-values
//
// ```elvish
// only-values
// ```
//
// Passes value input to output, and discards byte inputs.
//
// Example:
//
// ```elvish-transcript
// ~> { put value; echo bytes } | only-values
// ▶ value
// ```
func onlyValues(fm *Frame) error {
// Forward values in a goroutine.
valuesDone := make(chan struct{})
go func() {
for v := range fm.InputChan() {
fm.OutputChan() <- v
}
close(valuesDone)
}()
// Make sure the goroutine has finished before returning.
defer func() { <-valuesDone }()
// Discard bytes.
buf := make([]byte, bytesReadBufferSize)
for {
_, errRead := fm.InputFile().Read(buf[:])
if errRead != nil {
if errRead == io.EOF {
return nil
}
return errRead
}
}
}
//elvdoc:fn slurp
//
// ```elvish
// slurp
// ```
//
// Reads bytes input into a single string, and put this string on structured
// stdout.
//
// Example:
//
// ```elvish-transcript
// ~> echo "a\nb" | slurp
// ▶ "a\nb\n"
// ```
//
// Etymology: Perl, as
// [`File::Slurp`](http://search.cpan.org/~uri/File-Slurp-9999.19/lib/File/Slurp.pm).
func slurp(fm *Frame) (string, error) {
b, err := ioutil.ReadAll(fm.InputFile())
return string(b), err
}
//elvdoc:fn from-lines
//
// ```elvish
// from-lines
// ```
//
// Splits byte input into lines, and writes them to the value output. Value
// input is ignored.
//
// ```elvish-transcript
// ~> { echo a; echo b } | from-lines
// ▶ a
// ▶ b
// ~> { echo a; put b } | from-lines
// ▶ a
// ```
//
// @cf to-lines
func fromLines(fm *Frame) {
linesToChan(fm.InputFile(), fm.OutputChan())
}
//elvdoc:fn from-json
//
// ```elvish
// from-json
// ```
//
// Takes bytes stdin, parses it as JSON and puts the result on structured stdout.
// The input can contain multiple JSONs, which can, but do not have to, be
// separated with whitespaces.
//
// Examples:
//
// ```elvish-transcript
// ~> echo '"a"' | from-json
// ▶ a
// ~> echo '["lorem", "ipsum"]' | from-json
// ▶ [lorem ipsum]
// ~> echo '{"lorem": "ipsum"}' | from-json
// ▶ [&lorem=ipsum]
// ~> # multiple JSONs running together
// echo '"a""b"["x"]' | from-json
// ▶ a
// ▶ b
// ▶ [x]
// ~> # multiple JSONs separated by newlines
// echo '"a"
// {"k": "v"}' | from-json
// ▶ a
// ▶ [&k=v]
// ```
//
// @cf to-json
func fromJSON(fm *Frame) error {
in := fm.InputFile()
out := fm.OutputChan()
dec := json.NewDecoder(in)
for {
var v interface{}
err := dec.Decode(&v)
if err != nil {
if err == io.EOF {
return nil
}
return err
}
converted, err := fromJSONInterface(v)
if err != nil {
return err
}
out <- converted
}
}
// Converts a interface{} that results from json.Unmarshal to an Elvish value.
func fromJSONInterface(v interface{}) (interface{}, error) {
switch v := v.(type) {
case nil, bool, string:
return v, nil
case float64:
return v, nil
case []interface{}:
vec := vals.EmptyList
for _, elem := range v {
converted, err := fromJSONInterface(elem)
if err != nil {
return nil, err
}
vec = vec.Cons(converted)
}
return vec, nil
case map[string]interface{}:
m := vals.EmptyMap
for key, val := range v {
convertedVal, err := fromJSONInterface(val)
if err != nil {
return nil, err
}
m = m.Assoc(key, convertedVal)
}
return m, nil
default:
return nil, fmt.Errorf("unexpected json type: %T", v)
}
}
//elvdoc:fn to-lines
//
// ```elvish
// to-lines $input?
// ```
//
// Writes each value input to a separate line in the byte output. Byte input is
// ignored.
//
// ```elvish-transcript
// ~> put a b | to-lines
// a
// b
// ~> to-lines [a b]
// a
// b
// ~> { put a; echo b } | to-lines
// b
// a
// ```
//
// @cf from-lines
func toLines(fm *Frame, inputs Inputs) {
out := fm.OutputFile()
inputs(func(v interface{}) {
fmt.Fprintln(out, vals.ToString(v))
})
}
//elvdoc:fn to-json
//
// ```elvish
// to-json
// ```
//
// Takes structured stdin, convert it to JSON and puts the result on bytes stdout.
//
// ```elvish-transcript
// ~> put a | to-json
// "a"
// ~> put [lorem ipsum] | to-json
// ["lorem","ipsum"]
// ~> put [&lorem=ipsum] | to-json
// {"lorem":"ipsum"}
// ```
//
// @cf from-json
func toJSON(fm *Frame, inputs Inputs) error {
encoder := json.NewEncoder(fm.OutputFile())
var errEncode error
inputs(func(v interface{}) {
if errEncode != nil {
return
}
errEncode = encoder.Encode(v)
})
return errEncode
}
//elvdoc:fn fopen
//
// ```elvish
// fopen $filename
// ```
//
// Open a file. Currently, `fopen` only supports opening a file for reading. File
// must be closed with `fclose` explicitly. Example:
//
// ```elvish-transcript
// ~> cat a.txt
// This is
// a file.
// ~> f = (fopen a.txt)
// ~> cat < $f
// This is
// a file.
// ~> fclose $f
// ```
//
// @cf fclose
func fopen(name string) (vals.File, error) {
// TODO support opening files for writing etc as well.
return os.Open(name)
}
//elvdoc:fn fclose
//
// ```elvish
// fclose $file
// ```
//
// Close a file opened with `fopen`.
//
// @cf fopen
func fclose(f vals.File) error {
return f.Close()
}
//elvdoc:fn pipe
//
// ```elvish
// pipe
// ```
//
// Create a new Unix pipe that can be used in redirections.
//
// A pipe contains both the read FD and the write FD. When redirecting command
// input to a pipe with `<`, the read FD is used. When redirecting command output
// to a pipe with `>`, the write FD is used. It is not supported to redirect both
// input and output with `<>` to a pipe.
//
// Pipes have an OS-dependent buffer, so writing to a pipe without an active reader
// does not necessarily block. Pipes **must** be explicitly closed with `prclose`
// and `pwclose`.
//
// Putting values into pipes will cause those values to be discarded.
//
// Examples (assuming the pipe has a large enough buffer):
//
// ```elvish-transcript
// ~> p = (pipe)
// ~> echo 'lorem ipsum' > $p
// ~> head -n1 < $p
// lorem ipsum
// ~> put 'lorem ipsum' > $p
// ~> head -n1 < $p
// # blocks
// # $p should be closed with prclose and pwclose afterwards
// ```
//
// @cf prclose pwclose
func pipe() (vals.Pipe, error) {
r, w, err := os.Pipe()
return vals.NewPipe(r, w), err
}
//elvdoc:fn prclose
//
// ```elvish
// prclose $pipe
// ```
//
// Close the read end of a pipe.
//
// @cf pwclose pipe
func prclose(p vals.Pipe) error {
return p.ReadEnd.Close()
}
//elvdoc:fn pwclose
//
// ```elvish
// pwclose $pipe
// ```
//
// Close the write end of a pipe.
//
// @cf prclose pipe
func pwclose(p vals.Pipe) error {
return p.WriteEnd.Close()
}