Make Pipes closeable. (#78)

Author: floitsch

src/file.toit

@@ -67,7 +67,7 @@ DIRECTORY-SYMBOLIC-LINK ::= 7
 An open file with a current position.  Corresponds in many ways to a file
   descriptor in Posix.
 */
-class Stream extends Object with io.InMixin io.OutMixin implements old-reader.Reader:
+class Stream extends Object with io.CloseableInMixin io.CloseableOutMixin implements old-reader.Reader:
   fd_ := ?
 
   constructor.internal_ .fd_:
@@ -148,6 +148,12 @@ class Stream extends Object with io.InMixin io.OutMixin implements old-reader.Re
   try-write_ data/io.Data from/int to/int -> int:
     return write-to-descriptor_ fd_ data from to
 
+  close-reader_ -> none:
+    close
+
+  close-writer_ -> none:
+    close
+
   close -> none:
     close_ fd_
 

src/pipe.toit

@@ -53,14 +53,38 @@ get-numbered-pipe fd/int:
   else:
     return OpenPipe.from-std_ (fd-to-pipe_ pipe-resource-group_ fd)
 
-class OpenPipe extends Object with io.InMixin io.OutMixin implements old-reader.Reader:
+class OpenPipeReader_ extends io.CloseableReader:
+  pipe_/OpenPipe
+
+  constructor .pipe_:
+
+  read_ -> ByteArray?:
+    return pipe_.read_
+
+  close_ -> none:
+    pipe_.close
+
+class OpenPipeWriter extends io.CloseableWriter:
+  pipe_/OpenPipe
+
+  constructor .pipe_:
+
+  try-write_ data/io.Data from/int to/int -> int:
+    return pipe_.try-write_ data from to
+
+  close_ -> none:
+    pipe_.close
+
+class OpenPipe implements old-reader.Reader:
   resource_ := ?
   state_ := ?
   pid := null
   child-process-name_ /string?
   input_ /int := UNKNOWN-DIRECTION_
 
   fd := -1  // Other end of descriptor, for child process.
+  in_ /OpenPipeReader_? := null
+  out_ /OpenPipeWriter? := null
 
   constructor input/bool --child-process-name="child process":
     group := pipe-resource-group_
@@ -70,11 +94,29 @@ class OpenPipe extends Object with io.InMixin io.OutMixin implements old-reader.
     resource_ = pipe-pair[0]
     fd = pipe-pair[1]
     state_ = monitor.ResourceState_ pipe-resource-group_ resource_
+    if input:
+      in_ = null
+      out_ = OpenPipeWriter this
+    else:
+      in_ = OpenPipeReader_ this
+      out_ = null
 
   constructor.from-std_ .resource_:
     group := pipe-resource-group_
     child-process-name_ = null
     state_ = monitor.ResourceState_ pipe-resource-group_ resource_
+    in_ = OpenPipeReader_ this
+    out_ = OpenPipeWriter this
+
+  in -> io.CloseableReader:
+    if not in_:
+      throw "use of output pipe as input"
+    return in_
+
+  out -> io.CloseableWriter:
+    if not out_:
+      throw "use of input pipe as output"
+    return out_
 
   /**
   Deprecated. Use 'read' on $in instead.
@@ -83,8 +125,6 @@ class OpenPipe extends Object with io.InMixin io.OutMixin implements old-reader.
     return in.read
 
   read_ -> ByteArray?:
-    if input_ == PARENT-TO-CHILD_:
-      throw "read from an output pipe"
     while true:
       state_.wait-for-state READ-EVENT_ | CLOSE-EVENT_
       result := read-from-pipe_ resource_
@@ -104,16 +144,14 @@ class OpenPipe extends Object with io.InMixin io.OutMixin implements old-reader.
     return try-write_ x from to
 
   try-write_ data/io.Data from/int to/int -> int:
-    if input_ == CHILD-TO-PARENT_:
-      throw "write to an input pipe"
     if from == to: return 0
     state_.wait-for-state WRITE-EVENT_ | ERROR-EVENT_
     bytes-written := write-to-pipe_ resource_ data from to
     if bytes-written == 0: state_.clear-state WRITE-EVENT_
     return bytes-written
 
   close:
-    close_ resource_
+    close-resource_ resource_
     if state_:
       state_.dispose
       state_ = null
@@ -158,10 +196,10 @@ write-to-pipe_ pipe data/io.Data from to:
 read-from-pipe_ pipe:
   #primitive.pipe.read
 
-close_ pipe:
-  return close_ pipe pipe-resource-group_
+close-resource_ pipe:
+  return close-resource_ pipe pipe-resource-group_
 
-close_ pipe resource-group:
+close-resource_ pipe resource-group:
   #primitive.pipe.close
 
 /// Use the stdin/stdout/stderr that the parent Toit process has.

tests/file_test.toit

@@ -67,7 +67,7 @@ main:
 
       try:
         test-out.out.write test-contents
-        test-out.close
+        test-out.out.close
 
         10000.repeat:
           file.read-content filename
@@ -83,7 +83,7 @@ main:
 
       test-out = file.Stream.for-write filename
       try:
-        test-out.close
+        test-out.out.close
         expect-equals
           ByteArray 0
           file.read-content filename
@@ -98,7 +98,7 @@ main:
         from := 5
         to := 7
         test-out.out.write test-contents from to
-        test-out.close
+        test-out.out.close
 
         read-back := (file.read-content filename).to-string
 
@@ -150,7 +150,7 @@ main:
 
       test-out = file.Stream filename file.CREAT | file.WRONLY 0x1ff
       test-out.out.write test-contents
-      test-out.close
+      test-out.out.close
 
       expect-equals test-contents.size (file.size filename)
       chdir ".."
@@ -189,7 +189,7 @@ test-recursive test-dir:
   paths.do:
     stream := file.Stream.for-write it
     stream.out.write it
-    stream.close
+    stream.out.close
 
   paths.do:
     expect (file.is-file it)

tests/pipe_test_slow.toit

@@ -168,7 +168,7 @@ main args:
   tar-exit-code := (platform == PLATFORM-LINUX) ? 2 : 1
   expect-error "tar: exited with status $tar-exit-code":
     p := pipe.to "tar" "-xvf" "-" "foo.txt"
-    p.close  // Close without sending a valid tar file.
+    p.out.close  // Close without sending a valid tar file.
 
   task:: long-running-sleep
 
@@ -201,7 +201,7 @@ pipe-large-file:
     o := pipe.to [md5sum]
     for i := 0; i < 100; i++:
       o.out.write buffer
-    o.close
+    o.out.close
 
 write-closed-stdin-exception:
   if file.is-file "/usr/bin/true":