f786f6dc7554257b2daf27a4e804a7926f060e03
1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2004-2008 Jean Privat <jean@pryen.org>
4 # Copyright 2008 Floréal Morandat <morandat@lirmm.fr>
5 # Copyright 2008 Jean-Sébastien Gélinas <calestar@gmail.com>
7 # This file is free software, which comes along with NIT. This software is
8 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
9 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
10 # PARTICULAR PURPOSE. You can modify it is you want, provided this header
11 # is kept unaltered, and a notification of the changes is added.
12 # You are allowed to redistribute it and sell it, alone or is a part of
15 # File manipulations (create, read, write, etc.)
19 intrude import text
::ropes
27 #include <sys/types.h>
35 # `Stream` used to interact with a File or FileDescriptor
36 abstract class FileStream
38 # The path of the file.
39 var path
: nullable String = null
42 private var file
: nullable NativeFile = null
44 # The status of a file. see POSIX stat(2).
46 # var f = new FileReader.open("/etc/issue")
47 # assert f.file_stat.is_file
49 # Return null in case of error
50 fun file_stat
: nullable FileStat
52 var stat
= _file
.file_stat
53 if stat
.address_is_null
then return null
54 return new FileStat(stat
)
57 # File descriptor of this file
58 fun fd
: Int do return _file
.fileno
62 if _file
== null then return
63 if _file
.address_is_null
then
64 if last_error
!= null then return
65 last_error
= new IOError("Cannot close unopened file")
68 var i
= _file
.io_close
70 last_error
= new IOError("Close failed due to error {sys.errno.strerror}")
75 # Sets the buffering mode for the current FileStream
77 # If the buf_size is <= 0, its value will be 512 by default
79 # The mode is any of the buffer_mode enumeration in `Sys`:
83 fun set_buffering_mode
(buf_size
, mode
: Int) do
84 if buf_size
<= 0 then buf_size
= 512
85 if _file
.set_buffering_type
(buf_size
, mode
) != 0 then
86 last_error
= new IOError("Error while changing buffering type for FileStream, returned error {sys.errno.strerror}")
91 # `Stream` that can read from a File
98 # Open the same file again.
99 # The original path is reused, therefore the reopened file can be a different file.
101 # var f = new FileReader.open("/etc/issue")
102 # var l = f.read_line
104 # assert l == f.read_line
107 if not eof
and not _file
.address_is_null
then close
109 _file
= new NativeFile.io_open_read
(path
.to_cstring
)
110 if _file
.address_is_null
then
111 last_error
= new IOError("Error: Opening file at '{path.as(not null)}' failed with '{sys.errno.strerror}'")
126 redef fun fill_buffer
128 var nb
= _file
.io_read
(_buffer
, _buffer_capacity
)
138 redef var end_reached
= false
140 # Open the file at `path` for reading.
142 # var f = new FileReader.open("/etc/issue")
143 # assert not f.end_reached
146 # In case of error, `last_error` is set
148 # f = new FileReader.open("/fail/does not/exist")
149 # assert f.end_reached
150 # assert f.last_error != null
151 init open
(path
: String)
155 _file
= new NativeFile.io_open_read
(path
.to_cstring
)
156 if _file
.address_is_null
then
157 last_error
= new IOError("Error: Opening file at '{path}' failed with '{sys.errno.strerror}'")
162 # Creates a new File stream from a file descriptor
164 # This is a low-level method.
165 init from_fd
(fd
: Int) do
168 _file
= fd
.fd_to_stream
(read_only
)
169 if _file
.address_is_null
then
170 last_error
= new IOError("Error: Converting fd {fd} to stream failed with '{sys.errno.strerror}'")
176 # `Stream` that can write to a File
181 redef fun write_bytes
(s
) do
182 if last_error
!= null then return
183 if not _is_writable
then
184 last_error
= new IOError("cannot write to non-writable stream")
187 write_native
(s
.items
, s
.length
)
192 if last_error
!= null then return
193 if not _is_writable
then
194 last_error
= new IOError("cannot write to non-writable stream")
197 for i
in s
.substrings
do write_native
(i
.to_cstring
, i
.length
)
200 redef fun write_byte
(value
)
202 if last_error
!= null then return
203 if not _is_writable
then
204 last_error
= new IOError("Cannot write to non-writable stream")
207 if _file
.address_is_null
then
208 last_error
= new IOError("Writing on a null stream")
213 var err
= _file
.write_byte
(value
)
216 last_error
= new IOError("Problem writing a byte: {err}")
225 redef var is_writable
= false
227 # Write `len` bytes from `native`.
228 private fun write_native
(native
: NativeString, len
: Int)
230 if last_error
!= null then return
231 if not _is_writable
then
232 last_error
= new IOError("Cannot write to non-writable stream")
235 if _file
.address_is_null
then
236 last_error
= new IOError("Writing on a null stream")
240 var err
= _file
.io_write
(native
, len
)
243 last_error
= new IOError("Problem in writing : {err} {len} \n")
247 # Open the file at `path` for writing.
248 init open
(path
: String)
250 _file
= new NativeFile.io_open_write
(path
.to_cstring
)
253 if _file
.address_is_null
then
254 last_error
= new IOError("Error: Opening file at '{path}' failed with '{sys.errno.strerror}'")
259 # Creates a new File stream from a file descriptor
260 init from_fd
(fd
: Int) do
262 _file
= fd
.fd_to_stream
(wipe_write
)
264 if _file
.address_is_null
then
265 last_error
= new IOError("Error: Opening stream from file descriptor {fd} failed with '{sys.errno.strerror}'")
272 # Creates a file stream from a file descriptor `fd` using the file access `mode`.
274 # NOTE: The `mode` specified must be compatible with the one used in the file descriptor.
275 private fun fd_to_stream
(mode
: NativeString): NativeFile is extern "file_int_fdtostream"
278 # Constant for read-only file streams
279 private fun read_only
: NativeString do return once
"r".to_cstring
281 # Constant for write-only file streams
283 # If a stream is opened on a file with this method,
284 # it will wipe the previous file if any.
285 # Else, it will create the file.
286 private fun wipe_write
: NativeString do return once
"w".to_cstring
288 ###############################################################################
290 # Standard input stream.
292 # The class of the default value of `sys.stdin`.
297 _file
= new NativeFile.native_stdin
303 struct pollfd fd = {0, POLLIN, 0};
304 int res = poll(&fd, 1, 0);
306 perror("Error poll stdin");
313 # Standard output stream.
315 # The class of the default value of `sys.stdout`.
319 _file
= new NativeFile.native_stdout
322 set_buffering_mode
(256, sys
.buffer_mode_line
)
326 # Standard error stream.
328 # The class of the default value of `sys.stderr`.
332 _file
= new NativeFile.native_stderr
338 ###############################################################################
341 # Like `write_to` but take care of creating the file
342 fun write_to_file
(filepath
: String)
344 var stream
= new FileWriter.open
(filepath
)
350 # Utility class to access file system services
352 # Usually created with `Text::to_path`.
355 private var path
: String
358 redef fun to_s
do return path
360 # Name of the file name at `to_s`
363 # var path = "/tmp/somefile".to_path
364 # assert path.filename == "somefile"
366 var filename
: String = path
.basename
("") is lazy
368 # Does the file at `path` exists?
369 fun exists
: Bool do return stat
!= null
371 # Information on the file at `self` following symbolic links
373 # Returns `null` if there is no file at `self`.
375 # assert "/etc/".to_path.stat.is_dir
376 # assert "/etc/issue".to_path.stat.is_file
377 # assert "/fail/does not/exist".to_path.stat == null
380 # var p = "/tmp/".to_path
382 # if stat != null then # Does `p` exist?
383 # print "It's size is {stat.size}"
384 # if stat.is_dir then print "It's a directory"
387 fun stat
: nullable FileStat
389 var stat
= path
.to_cstring
.file_stat
390 if stat
.address_is_null
then return null
391 return new FileStat(stat
)
394 # Information on the file or link at `self`
396 # Do not follow symbolic links.
397 fun link_stat
: nullable FileStat
399 var stat
= path
.to_cstring
.file_lstat
400 if stat
.address_is_null
then return null
401 return new FileStat(stat
)
404 # Delete a file from the file system, return `true` on success
405 fun delete
: Bool do return path
.to_cstring
.file_delete
407 # Copy content of file at `path` to `dest`
413 var output
= dest
.open_wo
415 while not input
.eof
do
416 var buffer
= input
.read
(1024)
424 # Open this file for reading
426 # Require: `exists and not link_stat.is_dir`
427 fun open_ro
: FileReader
429 # TODO manage streams error when they are merged
430 return new FileReader.open
(path
)
433 # Open this file for writing
435 # Require: `not exists or not stat.is_dir`
436 fun open_wo
: FileWriter
438 # TODO manage streams error when they are merged
439 return new FileWriter.open
(path
)
442 # Read all the content of the file
445 # var content = "/etc/issue".to_path.read_all
449 # See `Reader::read_all` for details.
450 fun read_all
: String do return read_all_bytes
.to_s
452 fun read_all_bytes
: Bytes
455 var res
= s
.read_all_bytes
460 # Read all the lines of the file
463 # var lines = "/etc/passwd".to_path.read_lines
465 # print "{lines.length} users"
468 # var fields = l.split(":")
469 # print "name={fields[0]} uid={fields[2]}"
473 # See `Reader::read_lines` for details.
474 fun read_lines
: Array[String]
477 var res
= s
.read_lines
482 # Return an iterator on each line of the file
485 # for l in "/etc/passwd".to_path.each_line do
486 # var fields = l.split(":")
487 # print "name={fields[0]} uid={fields[2]}"
491 # Note: the stream is automatically closed at the end of the file (see `LineIterator::close_on_finish`)
493 # See `Reader::each_line` for details.
494 fun each_line
: LineIterator
497 var res
= s
.each_line
498 res
.close_on_finish
= true
503 # Lists the name of the files contained within the directory at `path`
505 # Require: `exists and is_dir`
506 fun files
: Array[Path]
508 var files
= new Array[Path]
509 for filename
in path
.files
do
510 files
.add
new Path(path
/ filename
)
515 # Delete a directory and all of its content, return `true` on success
517 # Does not go through symbolic links and may get stuck in a cycle if there
518 # is a cycle in the file system.
522 for file
in self.files
do
523 var stat
= file
.link_stat
525 ok
= file
.rmdir
and ok
527 ok
= file
.delete
and ok
531 # Delete the directory itself
532 if ok
then ok
= path
.to_cstring
.rmdir
and ok
537 redef fun ==(other
) do return other
isa Path and path
.simplify_path
== other
.path
.simplify_path
538 redef fun hash
do return path
.simplify_path
.hash
541 # Information on a file
543 # Created by `Path::stat` and `Path::link_stat`.
545 # The information within this class is gathered when the instance is initialized
546 # it will not be updated if the targeted file is modified.
552 # The low-level status of a file
555 private var stat
: NativeFileStat
557 private var finalized
= false
561 if not finalized
then
567 # Returns the last access time in seconds since Epoch
568 fun last_access_time
: Int
574 # Returns the last access time
576 # alias for `last_access_time`
577 fun atime
: Int do return last_access_time
579 # Returns the last modification time in seconds since Epoch
580 fun last_modification_time
: Int
586 # Returns the last modification time
588 # alias for `last_modification_time`
589 fun mtime
: Int do return last_modification_time
592 # Size of the file at `path`
599 # Is self a regular file and not a device file, pipe, socket, etc.?
606 # Alias for `is_file`
607 fun is_reg
: Bool do return is_file
609 # Is this a directory?
616 # Is this a symbolic link?
623 # FIXME Make the following POSIX only? or implement in some other way on Windows
625 # Returns the last status change time in seconds since Epoch
626 fun last_status_change_time
: Int
632 # Returns the last status change time
634 # alias for `last_status_change_time`
635 fun ctime
: Int do return last_status_change_time
637 # Returns the permission bits of file
644 # Is this a character device?
651 # Is this a block device?
658 # Is this a FIFO pipe?
665 # Is this a UNIX socket
674 # Access file system related services on the path at `self`
675 fun to_path
: Path do return new Path(to_s
)
679 # return true if a file with this names exists
680 fun file_exists
: Bool do return to_cstring
.file_exists
682 # The status of a file. see POSIX stat(2).
683 fun file_stat
: nullable FileStat
685 var stat
= to_cstring
.file_stat
686 if stat
.address_is_null
then return null
687 return new FileStat(stat
)
690 # The status of a file or of a symlink. see POSIX lstat(2).
691 fun file_lstat
: nullable FileStat
693 var stat
= to_cstring
.file_lstat
694 if stat
.address_is_null
then return null
695 return new FileStat(stat
)
698 # Remove a file, return true if success
699 fun file_delete
: Bool do return to_cstring
.file_delete
701 # Copy content of file at `self` to `dest`
702 fun file_copy_to
(dest
: String) do to_path
.copy
(dest
.to_path
)
704 # Remove the trailing extension `ext`.
706 # `ext` usually starts with a dot but could be anything.
708 # assert "file.txt".strip_extension(".txt") == "file"
709 # assert "file.txt".strip_extension("le.txt") == "fi"
710 # assert "file.txt".strip_extension("xt") == "file.t"
712 # if `ext` is not present, `self` is returned unmodified.
714 # assert "file.txt".strip_extension(".tar.gz") == "file.txt"
715 fun strip_extension
(ext
: String): String
717 if has_suffix
(ext
) then
718 return substring
(0, length
- ext
.length
)
723 # Extract the basename of a path and remove the extension
725 # assert "/path/to/a_file.ext".basename(".ext") == "a_file"
726 # assert "path/to/a_file.ext".basename(".ext") == "a_file"
727 # assert "path/to".basename(".ext") == "to"
728 # assert "path/to/".basename(".ext") == "to"
729 # assert "path".basename("") == "path"
730 # assert "/path".basename("") == "path"
731 # assert "/".basename("") == "/"
732 # assert "".basename("") == ""
733 fun basename
(ext
: String): String
735 var l
= length
- 1 # Index of the last char
736 while l
> 0 and self.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
737 if l
== 0 then return "/"
738 var pos
= chars
.last_index_of_from
('/', l
)
741 n
= substring
(pos
+1, l-pos
)
743 return n
.strip_extension
(ext
)
746 # Extract the dirname of a path
748 # assert "/path/to/a_file.ext".dirname == "/path/to"
749 # assert "path/to/a_file.ext".dirname == "path/to"
750 # assert "path/to".dirname == "path"
751 # assert "path/to/".dirname == "path"
752 # assert "path".dirname == "."
753 # assert "/path".dirname == "/"
754 # assert "/".dirname == "/"
755 # assert "".dirname == "."
758 var l
= length
- 1 # Index of the last char
759 while l
> 0 and self.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
760 var pos
= chars
.last_index_of_from
('/', l
)
762 return substring
(0, pos
)
763 else if pos
== 0 then
770 # Return the canonicalized absolute pathname (see POSIX function `realpath`)
771 fun realpath
: String do
772 var cs
= to_cstring
.file_realpath
773 var res
= cs
.to_s_with_copy
774 # cs.free_malloc # FIXME memory leak
778 # Simplify a file path by remove useless `.`, removing `//`, and resolving `..`
780 # * `..` are not resolved if they start the path
781 # * starting `.` is simplified unless the path is empty
782 # * starting `/` is not removed
783 # * trailing `/` is removed
785 # Note that the method only work on the string:
787 # * no I/O access is performed
788 # * the validity of the path is not checked
791 # assert "some/./complex/../../path/from/../to/a////file//".simplify_path == "path/to/a/file"
792 # assert "../dir/file".simplify_path == "../dir/file"
793 # assert "dir/../../".simplify_path == ".."
794 # assert "dir/..".simplify_path == "."
795 # assert "//absolute//path/".simplify_path == "/absolute/path"
796 # assert "//absolute//../".simplify_path == "/"
797 # assert "/".simplify_path == "/"
798 # assert "../".simplify_path == ".."
799 # assert "./".simplify_path == "."
800 # assert "././././././".simplify_path == "."
801 # assert "./../dir".simplify_path == "../dir"
802 # assert "./dir".simplify_path == "dir"
804 fun simplify_path
: String
806 var a
= self.split_with
("/")
807 var a2
= new Array[String]
809 if x
== "." and not a2
.is_empty
then continue # skip `././`
810 if x
== "" and not a2
.is_empty
then continue # skip `//`
811 if x
== ".." and not a2
.is_empty
and a2
.last
!= ".." then
812 if a2
.last
== "." then # do not skip `./../`
813 a2
.pop
# reduce `./../` in `../`
814 else # reduce `dir/../` in `/`
818 else if not a2
.is_empty
and a2
.last
== "." then
819 a2
.pop
# reduce `./dir` in `dir`
823 if a2
.is_empty
then return "."
824 if a2
.length
== 1 and a2
.first
== "" then return "/"
828 # Correctly join two path using the directory separator.
830 # Using a standard "{self}/{path}" does not work in the following cases:
833 # * `path` starts with `'/'`.
835 # This method ensures that the join is valid.
837 # assert "hello".join_path("world") == "hello/world"
838 # assert "hel/lo".join_path("wor/ld") == "hel/lo/wor/ld"
839 # assert "".join_path("world") == "world"
840 # assert "hello".join_path("/world") == "/world"
841 # assert "hello/".join_path("world") == "hello/world"
842 # assert "hello/".join_path("/world") == "/world"
844 # Note: You may want to use `simplify_path` on the result.
846 # Note: This method works only with POSIX paths.
847 fun join_path
(path
: String): String
849 if path
.is_empty
then return self
850 if self.is_empty
then return path
851 if path
.chars
[0] == '/' then return path
852 if self.last
== '/' then return "{self}{path}"
853 return "{self}/{path}"
856 # Convert the path (`self`) to a program name.
858 # Ensure the path (`self`) will be treated as-is by POSIX shells when it is
859 # used as a program name. In order to do that, prepend `./` if needed.
861 # assert "foo".to_program_name == "./foo"
862 # assert "/foo".to_program_name == "/foo"
863 # assert "".to_program_name == "./" # At least, your shell will detect the error.
864 fun to_program_name
: String do
865 if self.has_prefix
("/") then
872 # Alias for `join_path`
874 # assert "hello" / "world" == "hello/world"
875 # assert "hel/lo" / "wor/ld" == "hel/lo/wor/ld"
876 # assert "" / "world" == "world"
877 # assert "/hello" / "/world" == "/world"
879 # This operator is quite useful for chaining changes of path.
880 # The next one being relative to the previous one.
884 # var c = "baz/foobar"
885 # assert a/b/c == "/bar/baz/foobar"
886 fun /(path
: String): String do return join_path
(path
)
888 # Returns the relative path needed to go from `self` to `dest`.
890 # assert "/foo/bar".relpath("/foo/baz") == "../baz"
891 # assert "/foo/bar".relpath("/baz/bar") == "../../baz/bar"
893 # If `self` or `dest` is relative, they are considered relatively to `getcwd`.
895 # In some cases, the result is still independent of the current directory:
897 # assert "foo/bar".relpath("..") == "../../.."
899 # In other cases, parts of the current directory may be exhibited:
901 # var p = "../foo/bar".relpath("baz")
902 # var c = getcwd.basename("")
903 # assert p == "../../{c}/baz"
905 # For path resolution independent of the current directory (eg. for paths in URL),
906 # or to use an other starting directory than the current directory,
907 # just force absolute paths:
909 # var start = "/a/b/c/d"
910 # var p2 = (start/"../foo/bar").relpath(start/"baz")
911 # assert p2 == "../../d/baz"
914 # Neither `self` or `dest` has to be real paths or to exist in directories since
915 # the resolution is only done with string manipulations and without any access to
916 # the underlying file system.
918 # If `self` and `dest` are the same directory, the empty string is returned:
920 # assert "foo".relpath("foo") == ""
921 # assert "foo/../bar".relpath("bar") == ""
923 # The empty string and "." designate both the current directory:
925 # assert "".relpath("foo/bar") == "foo/bar"
926 # assert ".".relpath("foo/bar") == "foo/bar"
927 # assert "foo/bar".relpath("") == "../.."
928 # assert "/" + "/".relpath(".") == getcwd
929 fun relpath
(dest
: String): String
932 var from
= (cwd
/self).simplify_path
.split
("/")
933 if from
.last
.is_empty
then from
.pop
# case for the root directory
934 var to
= (cwd
/dest
).simplify_path
.split
("/")
935 if to
.last
.is_empty
then to
.pop
# case for the root directory
937 # Remove common prefixes
938 while not from
.is_empty
and not to
.is_empty
and from
.first
== to
.first
do
943 # Result is going up in `from` with ".." then going down following `to`
944 var from_len
= from
.length
945 if from_len
== 0 then return to
.join
("/")
946 var up
= "../"*(from_len-1
) + ".."
947 if to
.is_empty
then return up
948 var res
= up
+ "/" + to
.join
("/")
952 # Create a directory (and all intermediate directories if needed)
954 # Return an error object in case of error.
956 # assert "/etc/".mkdir != null
957 fun mkdir
: nullable Error
959 var dirs
= self.split_with
("/")
960 var path
= new FlatBuffer
961 if dirs
.is_empty
then return null
962 if dirs
[0].is_empty
then
963 # it was a starting /
966 var error
: nullable Error = null
968 if d
.is_empty
then continue
971 var res
= path
.to_s
.to_cstring
.file_mkdir
972 if not res
and error
== null then
973 error
= new IOError("Cannot create directory `{path}`: {sys.errno.strerror}")
979 # Delete a directory and all of its content, return `true` on success
981 # Does not go through symbolic links and may get stuck in a cycle if there
982 # is a cycle in the filesystem.
984 # Return an error object in case of error.
986 # assert "/fail/does not/exist".rmdir != null
987 fun rmdir
: nullable Error
989 var res
= to_path
.rmdir
990 if res
then return null
991 var error
= new IOError("Cannot change remove `{self}`: {sys.errno.strerror}")
995 # Change the current working directory
998 # assert getcwd == "/etc"
1000 # assert getcwd == "/"
1002 # Return an error object in case of error.
1004 # assert "/etc".chdir == null
1005 # assert "/fail/does no/exist".chdir != null
1006 # assert getcwd == "/etc" # unchanger
1007 fun chdir
: nullable Error
1009 var res
= to_cstring
.file_chdir
1010 if res
then return null
1011 var error
= new IOError("Cannot change directory to `{self}`: {sys.errno.strerror}")
1015 # Return right-most extension (without the dot)
1017 # Only the last extension is returned.
1018 # There is no special case for combined extensions.
1020 # assert "file.txt".file_extension == "txt"
1021 # assert "file.tar.gz".file_extension == "gz"
1023 # For file without extension, `null` is returned.
1024 # Hoever, for trailing dot, `""` is returned.
1026 # assert "file".file_extension == null
1027 # assert "file.".file_extension == ""
1029 # The starting dot of hidden files is never considered.
1031 # assert ".file.txt".file_extension == "txt"
1032 # assert ".file".file_extension == null
1033 fun file_extension
: nullable String
1035 var last_slash
= chars
.last_index_of
('.')
1036 if last_slash
> 0 then
1037 return substring
( last_slash
+1, length
)
1043 # Returns entries contained within the directory represented by self.
1045 # var files = "/etc".files
1046 # assert files.has("issue")
1048 # Returns an empty array in case of error
1050 # files = "/etc/issue".files
1051 # assert files.is_empty
1053 # TODO find a better way to handle errors and to give them back to the user.
1054 fun files
: Array[String]
1056 var res
= new Array[String]
1057 var d
= new NativeDir.opendir
(to_cstring
)
1058 if d
.address_is_null
then return res
1062 if de
.address_is_null
then break
1063 var name
= de
.to_s_with_copy
1064 if name
== "." or name
== ".." then continue
1073 redef class NativeString
1074 private fun file_exists
: Bool `{
1075 FILE *hdl = fopen(self,"r");
1082 private fun file_stat
: NativeFileStat `{
1084 if(stat(self, &buff) != -1) {
1085 struct stat* stat_element;
1086 stat_element = malloc(sizeof(struct stat));
1087 return memcpy(stat_element, &buff, sizeof(struct stat));
1092 private fun file_lstat
: NativeFileStat `{
1093 struct stat* stat_element;
1095 stat_element = malloc(sizeof(struct stat));
1096 res = lstat(self, stat_element);
1097 if (res == -1) return NULL;
1098 return stat_element;
1100 private fun file_mkdir
: Bool is extern "string_NativeString_NativeString_file_mkdir_0"
1101 private fun rmdir
: Bool `{ return !rmdir(self); `}
1102 private fun file_delete: Bool is extern "string_NativeString_NativeString_file_delete_0"
1103 private fun file_chdir: Bool is extern "string_NativeString_NativeString_file_chdir_0"
1104 private fun file_realpath: NativeString is extern "file_NativeString_realpath"
1107 # This class is system dependent ... must reify the vfs
1108 private extern class NativeFileStat `{ struct stat * `}
1109 # Returns the permission bits of file
1110 fun mode
: Int is extern "file_FileStat_FileStat_mode_0"
1111 # Returns the last access time
1112 fun atime
: Int is extern "file_FileStat_FileStat_atime_0"
1113 # Returns the last status change time
1114 fun ctime
: Int is extern "file_FileStat_FileStat_ctime_0"
1115 # Returns the last modification time
1116 fun mtime
: Int is extern "file_FileStat_FileStat_mtime_0"
1118 fun size
: Int is extern "file_FileStat_FileStat_size_0"
1120 # Returns true if it is a regular file (not a device file, pipe, sockect, ...)
1121 fun is_reg
: Bool `{ return S_ISREG(self->st_mode); `}
1123 # Returns true if it is a directory
1124 fun is_dir: Bool `{ return S_ISDIR(self->st_mode); `}
1126 # Returns true if it is a character device
1127 fun is_chr
: Bool `{ return S_ISCHR(self->st_mode); `}
1129 # Returns true if it is a block device
1130 fun is_blk: Bool `{ return S_ISBLK(self->st_mode); `}
1132 # Returns true if the type is fifo
1133 fun is_fifo
: Bool `{ return S_ISFIFO(self->st_mode); `}
1135 # Returns true if the type is a link
1136 fun is_lnk: Bool `{ return S_ISLNK(self->st_mode); `}
1138 # Returns true if the type is a socket
1139 fun is_sock
: Bool `{ return S_ISSOCK(self->st_mode); `}
1142 # Instance of this class are standard FILE * pointers
1143 private extern class NativeFile `{ FILE* `}
1144 fun io_read
(buf
: NativeString, len
: Int): Int is extern "file_NativeFile_NativeFile_io_read_2"
1145 fun io_write
(buf
: NativeString, len
: Int): Int is extern "file_NativeFile_NativeFile_io_write_2"
1146 fun write_byte
(value
: Int): Int `{
1147 unsigned char b = (unsigned char)value;
1148 return fwrite(&b, 1, 1, self);
1150 fun io_close
: Int is extern "file_NativeFile_NativeFile_io_close_0"
1151 fun file_stat
: NativeFileStat `{
1153 if(fstat(fileno(self), &buff) != -1) {
1154 struct stat* stat_element;
1155 stat_element = malloc(sizeof(struct stat));
1156 return memcpy(stat_element, &buff, sizeof(struct stat));
1161 fun fileno
: Int `{ return fileno(self); `}
1163 # Flushes the buffer, forcing the write operation
1164 fun flush: Int is extern "fflush"
1165 # Used to specify how the buffering will be handled for the current stream.
1166 fun set_buffering_type(buf_length: Int, mode: Int): Int is extern "file_NativeFile_NativeFile_set_buffering_type_0"
1168 new io_open_read(path: NativeString) is extern "file_NativeFileCapable_NativeFileCapable_io_open_read_1"
1169 new io_open_write(path: NativeString) is extern "file_NativeFileCapable_NativeFileCapable_io_open_write_1"
1170 new native_stdin is extern "file_NativeFileCapable_NativeFileCapable_native_stdin_0"
1171 new native_stdout is extern "file_NativeFileCapable_NativeFileCapable_native_stdout_0"
1172 new native_stderr is extern "file_NativeFileCapable_NativeFileCapable_native_stderr_0"
1175 # Standard `DIR*` pointer
1176 private extern class NativeDir `{ DIR* `}
1179 new opendir
(path
: NativeString) `{ return opendir(path); `}
1182 fun closedir `{ closedir(self); `}
1184 # Read the next directory entry
1185 fun readdir
: NativeString `{
1188 if (!de) return NULL;
1196 var stdin
: PollableReader = new Stdin is protected writable, lazy
1199 var stdout
: Writer = new Stdout is protected writable, lazy
1201 # Standard output for errors
1202 var stderr
: Writer = new Stderr is protected writable, lazy
1204 # Enumeration for buffer mode full (flushes when buffer is full)
1205 fun buffer_mode_full
: Int is extern "file_Sys_Sys_buffer_mode_full_0"
1206 # Enumeration for buffer mode line (flushes when a `\n` is encountered)
1207 fun buffer_mode_line
: Int is extern "file_Sys_Sys_buffer_mode_line_0"
1208 # Enumeration for buffer mode none (flushes ASAP when something is written)
1209 fun buffer_mode_none
: Int is extern "file_Sys_Sys_buffer_mode_none_0"
1211 # returns first available stream to read or write to
1212 # return null on interruption (possibly a signal)
1213 protected fun poll
( streams
: Sequence[FileStream] ) : nullable FileStream
1215 var in_fds
= new Array[Int]
1216 var out_fds
= new Array[Int]
1217 var fd_to_stream
= new HashMap[Int,FileStream]
1220 if s
isa FileReader then in_fds
.add
( fd
)
1221 if s
isa FileWriter then out_fds
.add
( fd
)
1223 fd_to_stream
[fd
] = s
1226 var polled_fd
= intern_poll
( in_fds
, out_fds
)
1228 if polled_fd
== null then
1231 return fd_to_stream
[polled_fd
]
1235 private fun intern_poll
(in_fds
: Array[Int], out_fds
: Array[Int]): nullable Int
1236 import Array[Int].length
, Array[Int].[], Int.as(nullable Int) `{
1237 int in_len, out_len, total_len;
1238 struct pollfd *c_fds;
1240 int first_polled_fd = -1;
1243 in_len = Array_of_Int_length( in_fds );
1244 out_len = Array_of_Int_length( out_fds );
1245 total_len = in_len + out_len;
1246 c_fds = malloc( sizeof(struct pollfd) * total_len );
1249 for ( i=0; i<in_len; i ++ ) {
1251 fd = Array_of_Int__index( in_fds, i );
1254 c_fds[i].events = POLLIN;
1257 /* output streams */
1258 for ( i=0; i<out_len; i ++ ) {
1260 fd = Array_of_Int__index( out_fds, i );
1263 c_fds[i].events = POLLOUT;
1266 /* poll all fds, unlimited timeout */
1267 result = poll( c_fds, total_len, -1 );
1270 /* analyse results */
1271 for ( i=0; i<total_len; i++ )
1272 if ( c_fds[i].revents & c_fds[i].events || /* awaited event */
1273 c_fds[i].revents & POLLHUP ) /* closed */
1275 first_polled_fd = c_fds[i].fd;
1279 return Int_as_nullable( first_polled_fd );
1281 else if ( result < 0 )
1282 fprintf( stderr, "Error in Stream:poll: %s\n", strerror( errno ) );
1289 # Print `objects` on the standard output (`stdout`).
1290 fun printn
(objects
: Object...)
1292 sys
.stdout
.write
(objects
.plain_to_s
)
1295 # Print an `object` on the standard output (`stdout`) and add a newline.
1296 fun print
(object
: Object)
1298 sys
.stdout
.write
(object
.to_s
)
1299 sys
.stdout
.write
("\n")
1302 # Print `object` on the error output (`stderr` or a log system)
1303 fun print_error
(object
: Object)
1305 sys
.stderr
.write object
.to_s
1306 sys
.stderr
.write
"\n"
1309 # Read a character from the standard input (`stdin`).
1312 var c
= sys
.stdin
.read_char
1313 if c
== null then return '\1'
1317 # Read a line from the standard input (`stdin`).
1320 return sys
.stdin
.read_line
1323 # Return the working (current) directory
1324 fun getcwd
: String do return file_getcwd
.to_s
1325 private fun file_getcwd
: NativeString is extern "string_NativeString_NativeString_file_getcwd_0"