stdlib/strings: Moved Buffer to FlatBuffer, Buffer is now abstract.
[nit.git] / lib / standard / exec.nit
index a9f59da..166cef4 100644 (file)
@@ -5,56 +5,61 @@
 #
 # This file is free software, which comes along with NIT.  This software is
 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without  even  the implied warranty of  MERCHANTABILITY or  FITNESS FOR A 
+# without  even  the implied warranty of  MERCHANTABILITY or  FITNESS FOR A
 # PARTICULAR PURPOSE.  You can modify it is you want,  provided this header
 # is kept unaltered, and a notification of the changes is added.
 # You  are  allowed  to  redistribute it and sell it, alone or is a part of
 # another product.
 
-# This module handle simple system calls
-# Standard input and output can be handleb trougth streams.
-package exec 
+# Invocation and management of operating system sub-processes.
+# Standard input and output can be handled through streams.
+module exec
 
 import stream
 
-# Simple sub-processus
+# Simple sub-process
 class Process
-       # The pid of the processus
-       fun id: Int do return _data.id
+       # The pid of the process
+       fun id: Int do return data.id
 
-       # Is the processus finished?
-       fun is_finished: Bool do return _data.is_finished
+       # Is the process finished?
+       fun is_finished: Bool do return data.is_finished
 
-       # wait the terminaison of the process
+       # Wait the termination of the process
        fun wait
        do
-               _data.wait
+               data.wait
                assert is_finished
        end
-       
+
        # The status once finished
        fun status: Int
        do
                assert is_finished
-               return _data.status
+               return data.status
        end
 
-       # launch a command with some arguments
+       # Launch a command with some arguments
        init(command: String, arguments: String...)
        do
                execute(command, arguments, 0)
        end
 
-       # launch a simple command without arguments
+       # Launch a simple command without arguments
        init init_(command: String)
        do
                execute(command, null, 0)
        end
 
-       # Internal code to handle execusion
+       init from_a(command: String, arguments: Array[String])
+       do
+               execute(command, arguments, 0)
+       end
+
+       # Internal code to handle execution
        protected init execute(command: String, arguments: nullable Array[String], pipeflags: Int)
        do
-               var args = new Buffer
+               var args = new FlatBuffer
                var l = 1 # Number of elements in args
                args.append(command)
                if arguments != null then
@@ -64,60 +69,72 @@ class Process
                        end
                        l += arguments.length
                end
-               _data = basic_exec_execute(command.to_cstring, args.to_s.to_cstring, l, pipeflags)
+               data = basic_exec_execute(command.to_cstring, args.to_s.to_cstring, l, pipeflags)
        end
-       
-       var _data: NativeProcess
+
+       private var data: NativeProcess
        private fun basic_exec_execute(p: NativeString, av: NativeString, ac: Int, pf: Int): NativeProcess is extern "exec_Process_Process_basic_exec_execute_4"
 end
 
-# stdout of the processus is readable
+# stdout of the process is readable
 class IProcess
        super Process
        super IStream
-       var _in: FDIStream
-       
-       redef fun close do _in.close
-       
-       redef fun read_char do return _in.read_char
+       var stream_in: FDIStream
 
-       redef fun eof do return _in.eof
+       redef fun close do stream_in.close
+
+       redef fun read_char do return stream_in.read_char
+
+       redef fun eof do return stream_in.eof
 
        init(command: String, arguments: String...)
        do
                execute(command, arguments, 2)
-               _in = new FDIStream(_data.out_fd)
+               stream_in = new FDIStream(data.out_fd)
        end
-       
+
        init init_(command: String)
        do
                execute(command, null, 2)
-               _in = new FDIStream(_data.out_fd)
+               stream_in = new FDIStream(data.out_fd)
+       end
+
+       init from_a(command: String, arguments: Array[String])
+       do
+               execute(command, arguments, 2)
+               stream_in = new FDIStream(data.out_fd)
        end
 end
 
-# stdin of the processus is writable
+# stdin of the process is writable
 class OProcess
        super Process
        super OStream
-       var _out: OStream
+       var stream_out: OStream
+
+       redef fun close do stream_out.close
 
-       redef fun close do _out.close
+       redef fun is_writable do return stream_out.is_writable
 
-       redef fun is_writable do return _out.is_writable
+       redef fun write(s) do stream_out.write(s)
 
-       redef fun write(s) do _out.write(s)
-       
        init(command: String, arguments: String...)
        do
                execute(command, arguments, 1)
-               _out = new FDOStream(_data.in_fd)
+               stream_out = new FDOStream(data.in_fd)
        end
-       
+
        init init_(command: String)
        do
                execute(command, null, 1)
-               _out = new FDOStream(_data.in_fd)
+               stream_out = new FDOStream(data.in_fd)
+       end
+
+       init from_a(command: String, arguments: Array[String])
+       do
+               execute(command, arguments, 1)
+               stream_out = new FDOStream(data.in_fd)
        end
 end
 
@@ -129,30 +146,37 @@ class IOProcess
 
        redef fun close
        do
-               _in.close
-               _out.close
+               stream_in.close
+               stream_out.close
        end
 
        init(command: String, arguments: String...)
        do
                execute(command, arguments, 3)
-               _in = new FDIStream(_data.out_fd)
-               _out = new FDOStream(_data.in_fd)
+               stream_in = new FDIStream(data.out_fd)
+               stream_out = new FDOStream(data.in_fd)
        end
-       
+
        init init_(command: String)
        do
                execute(command, null, 3)
-               _in = new FDIStream(_data.out_fd)
-               _out = new FDOStream(_data.in_fd)
+               stream_in = new FDIStream(data.out_fd)
+               stream_out = new FDOStream(data.in_fd)
+       end
+
+       init from_a(command: String, arguments: Array[String])
+       do
+               execute(command, arguments, 3)
+               stream_in = new FDIStream(data.out_fd)
+               stream_out = new FDOStream(data.in_fd)
        end
 end
 
 redef class Sys
-       # Execute a shell command and return it's error code
+       # Execute a shell command and return its error code
        fun system(command: String): Int
        do
-               return command.to_cstring.system        
+               return command.to_cstring.system
        end
 end