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`:
81 # * `buffer_mode_full`
82 # * `buffer_mode_line`
83 # * `buffer_mode_none`
84 fun set_buffering_mode
(buf_size
, mode
: Int) do
85 if buf_size
<= 0 then buf_size
= 512
86 if _file
.set_buffering_type
(buf_size
, mode
) != 0 then
87 last_error
= new IOError("Error while changing buffering type for FileStream, returned error {sys.errno.strerror}")
92 # `Stream` that can read from a File
99 # Open the same file again.
100 # The original path is reused, therefore the reopened file can be a different file.
102 # var f = new FileReader.open("/etc/issue")
103 # var l = f.read_line
105 # assert l == f.read_line
108 if not eof
and not _file
.address_is_null
then close
110 _file
= new NativeFile.io_open_read
(path
.to_cstring
)
111 if _file
.address_is_null
then
112 last_error
= new IOError("Cannot open `{path.as(not null)}`: {sys.errno.strerror}")
127 redef fun fill_buffer
129 var nb
= _file
.io_read
(_buffer
, _buffer_capacity
)
130 if last_error
== null and _file
.ferror
then
131 last_error
= new IOError("Cannot read `{path.as(not null)}`: {sys.errno.strerror}")
143 redef var end_reached
= false
145 # Open the file at `path` for reading.
147 # var f = new FileReader.open("/etc/issue")
148 # assert not f.end_reached
151 # In case of error, `last_error` is set
153 # f = new FileReader.open("/fail/does not/exist")
154 # assert f.end_reached
155 # assert f.last_error != null
156 init open
(path
: String)
160 _file
= new NativeFile.io_open_read
(path
.to_cstring
)
161 if _file
.address_is_null
then
162 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
167 # Creates a new File stream from a file descriptor
169 # This is a low-level method.
170 init from_fd
(fd
: Int) do
173 _file
= fd
.fd_to_stream
(read_only
)
174 if _file
.address_is_null
then
175 last_error
= new IOError("Error: Converting fd {fd} to stream failed with '{sys.errno.strerror}'")
181 # `Stream` that can write to a File
186 redef fun write_bytes
(s
) do
187 if last_error
!= null then return
188 if not _is_writable
then
189 last_error
= new IOError("cannot write to non-writable stream")
192 write_native
(s
.items
, 0, s
.length
)
197 if last_error
!= null then return
198 if not _is_writable
then
199 last_error
= new IOError("cannot write to non-writable stream")
202 s
.write_native_to
(self)
205 redef fun write_byte
(value
)
207 if last_error
!= null then return
208 if not _is_writable
then
209 last_error
= new IOError("Cannot write to non-writable stream")
212 if _file
.address_is_null
then
213 last_error
= new IOError("Writing on a null stream")
218 var err
= _file
.write_byte
(value
)
221 last_error
= new IOError("Problem writing a byte: {err}")
230 redef var is_writable
= false
232 # Write `len` bytes from `native`.
233 private fun write_native
(native
: NativeString, from
, len
: Int)
235 if last_error
!= null then return
236 if not _is_writable
then
237 last_error
= new IOError("Cannot write to non-writable stream")
240 if _file
.address_is_null
then
241 last_error
= new IOError("Writing on a null stream")
245 var err
= _file
.io_write
(native
, from
, len
)
248 last_error
= new IOError("Problem in writing : {err} {len} \n")
252 # Open the file at `path` for writing.
253 init open
(path
: String)
255 _file
= new NativeFile.io_open_write
(path
.to_cstring
)
258 if _file
.address_is_null
then
259 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
264 # Creates a new File stream from a file descriptor
265 init from_fd
(fd
: Int) do
267 _file
= fd
.fd_to_stream
(wipe_write
)
269 if _file
.address_is_null
then
270 last_error
= new IOError("Error: Opening stream from file descriptor {fd} failed with '{sys.errno.strerror}'")
277 # Creates a file stream from a file descriptor `fd` using the file access `mode`.
279 # NOTE: The `mode` specified must be compatible with the one used in the file descriptor.
280 private fun fd_to_stream
(mode
: NativeString): NativeFile `{
281 return fdopen(self, mode);
285 # Constant for read-only file streams
286 private fun read_only
: NativeString do return once
"r".to_cstring
288 # Constant for write-only file streams
290 # If a stream is opened on a file with this method,
291 # it will wipe the previous file if any.
292 # Else, it will create the file.
293 private fun wipe_write
: NativeString do return once
"w".to_cstring
295 ###############################################################################
297 # Standard input stream.
299 # The class of the default value of `sys.stdin`.
304 _file
= new NativeFile.native_stdin
310 struct pollfd fd = {0, POLLIN, 0};
311 int res = poll(&fd, 1, 0);
313 perror("Error poll stdin");
320 # Standard output stream.
322 # The class of the default value of `sys.stdout`.
326 _file
= new NativeFile.native_stdout
329 set_buffering_mode
(256, sys
.buffer_mode_line
)
333 # Standard error stream.
335 # The class of the default value of `sys.stderr`.
339 _file
= new NativeFile.native_stderr
345 ###############################################################################
348 # Like `write_to` but take care of creating the file
349 fun write_to_file
(filepath
: String)
351 var stream
= new FileWriter.open
(filepath
)
357 # Utility class to access file system services.
359 # Usually created with `Text::to_path`.
361 # `Path` objects does not necessarily represent existing files in a file system.
362 # They are sate-less objects that efficiently represent path information.
363 # They also provide an easy to use API on file-system services and are used to store their error status (see `last_error`)
366 private var path
: String
369 redef fun to_s
do return path
371 # Short name of the file at `to_s`
374 # var path = "/tmp/somefile".to_path
375 # assert path.filename == "somefile"
378 # The result does not depend of the file system, thus is cached for efficiency.
379 var filename
: String = path
.basename
is lazy
381 # The path simplified by removing useless `.`, removing `//`, and resolving `..`
384 # var path = "somedir/./tmp/../somefile".to_path
385 # assert path.simplified.to_s == "somedir/somefile"
388 # See `String:simplify_path` for details.
390 # The result does not depend of the file system, thus is cached for efficiency.
391 var simplified
: Path is lazy
do
392 var res
= path
.simplify_path
.to_path
397 # Return the directory part of the path.
400 # var path = "/foo/bar/baz".to_path
401 # assert path.dir.to_s == "/foo/bar"
402 # assert path.dir.dir.to_s == "/foo"
403 # assert path.dir.dir.dir.to_s == "/"
406 # See `String:dirname` for details.
408 # The result does not depend of the file system, thus is cached for efficiency.
409 var dir
: Path is lazy
do
410 return path
.dirname
.to_path
413 # Last error produced by I/O operations.
416 # var path = "/does/not/exists".to_path
417 # assert path.last_error == null
419 # assert path.last_error != null
422 # Since `Path` objects are stateless, `last_error` is reset on most operations and reflect its status.
423 var last_error
: nullable IOError = null is writable
425 # Does the file at `path` exists?
427 # If the file does not exists, `last_error` is set to the information.
428 fun exists
: Bool do return stat
!= null
430 # Information on the file at `self` following symbolic links
432 # Returns `null` if there is no file at `self`.
433 # `last_error` is updated to contains the error information on error, and null on success.
435 # assert "/etc/".to_path.stat.is_dir
436 # assert "/etc/issue".to_path.stat.is_file
437 # assert "/fail/does not/exist".to_path.stat == null
440 # var p = "/tmp/".to_path
442 # if stat != null then # Does `p` exist?
443 # print "It's size is {stat.size}"
444 # if stat.is_dir then print "It's a directory"
446 # print p.last_error.to_s
449 fun stat
: nullable FileStat
451 var stat
= path
.to_cstring
.file_stat
452 if stat
.address_is_null
then
453 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
457 return new FileStat(stat
)
460 # Information on the file or link at `self`
462 # Do not follow symbolic links.
463 fun link_stat
: nullable FileStat
465 var stat
= path
.to_cstring
.file_lstat
466 if stat
.address_is_null
then
467 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
471 return new FileStat(stat
)
474 # Delete a file from the file system.
476 # `last_error` is updated to contains the error information on error, and null on success.
479 var res
= path
.to_cstring
.file_delete
481 last_error
= new IOError("Cannot delete `{path}`: {sys.errno.strerror}")
487 # Copy content of file at `path` to `dest`.
489 # `last_error` is updated to contains the error information on error, and null on success.
494 var output
= dest
.open_wo
496 while not input
.eof
do
497 var buffer
= input
.read
(1024)
503 last_error
= input
.last_error
or else output
.last_error
506 # Open this file for reading.
509 # var file = "/etc/issue".to_path.open_ro
510 # print file.read_line
514 # Note that it is the user's responsibility to close the stream.
515 # Therefore, for simple use case, look at `read_all` or `each_line`.
517 # ENSURE `last_error == result.last_error`
518 fun open_ro
: FileReader
520 var res
= new FileReader.open
(path
)
521 last_error
= res
.last_error
525 # Open this file for writing
528 # var file = "bla.log".to_path.open_wo
529 # file.write "Blabla\n"
533 # Note that it is the user's responsibility to close the stream.
534 # Therefore, for simple use case, look at `Writable::write_to_file`.
536 # ENSURE `last_error == result.last_error`
537 fun open_wo
: FileWriter
539 var res
= new FileWriter.open
(path
)
540 last_error
= res
.last_error
544 # Read all the content of the file as a string.
547 # var content = "/etc/issue".to_path.read_all
551 # `last_error` is updated to contains the error information on error, and null on success.
552 # In case of error, the result might be empty or truncated.
554 # See `Reader::read_all` for details.
555 fun read_all
: String do return read_all_bytes
.to_s
557 # Read all the content on the file as a raw sequence of bytes.
560 # var content = "/etc/issue".to_path.read_all_bytes
564 # `last_error` is updated to contains the error information on error, and null on success.
565 # In case of error, the result might be empty or truncated.
566 fun read_all_bytes
: Bytes
569 var res
= s
.read_all_bytes
571 last_error
= s
.last_error
575 # Read all the lines of the file
578 # var lines = "/etc/passwd".to_path.read_lines
580 # print "{lines.length} users"
583 # var fields = l.split(":")
584 # print "name={fields[0]} uid={fields[2]}"
588 # `last_error` is updated to contains the error information on error, and null on success.
589 # In case of error, the result might be empty or truncated.
591 # See `Reader::read_lines` for details.
592 fun read_lines
: Array[String]
595 var res
= s
.read_lines
597 last_error
= s
.last_error
601 # Return an iterator on each line of the file
604 # for l in "/etc/passwd".to_path.each_line do
605 # var fields = l.split(":")
606 # print "name={fields[0]} uid={fields[2]}"
610 # Note: the stream is automatically closed at the end of the file (see `LineIterator::close_on_finish`)
612 # `last_error` is updated to contains the error information on error, and null on success.
614 # See `Reader::each_line` for details.
615 fun each_line
: LineIterator
618 var res
= s
.each_line
619 res
.close_on_finish
= true
620 last_error
= s
.last_error
625 # Lists the files contained within the directory at `path`.
627 # var files = "/etc".to_path.files
628 # assert files.has("/etc/issue".to_path)
630 # `last_error` is updated to contains the error information on error, and null on success.
631 # In case of error, the result might be empty or truncated.
633 # var path = "/etc/issue".to_path
635 # assert files.is_empty
636 # assert path.last_error != null
637 fun files
: Array[Path]
640 var res
= new Array[Path]
641 var d
= new NativeDir.opendir
(path
.to_cstring
)
642 if d
.address_is_null
then
643 last_error
= new IOError("Cannot list directory `{path}`: {sys.errno.strerror}")
649 if de
.address_is_null
then
650 # readdir cannot fail, so null means end of list
653 var name
= de
.to_s_with_copy
654 if name
== "." or name
== ".." then continue
655 res
.add
new Path(path
/ name
)
662 # Delete a directory and all of its content
664 # Does not go through symbolic links and may get stuck in a cycle if there
665 # is a cycle in the file system.
667 # `last_error` is updated to contains the error information on error, and null on success.
668 # The method does not stop on the first error and try to remove most file and directories.
671 # var path = "/does/not/exists/".to_path
673 # assert path.last_error != null
678 for file
in self.files
do
679 var stat
= file
.link_stat
681 last_error
= file
.last_error
690 if last_error
== null then last_error
= file
.last_error
693 # Delete the directory itself if things are fine
694 if last_error
== null then
695 if path
.to_cstring
.rmdir
then
696 last_error
= new IOError("Cannot remove `{self}`: {sys.errno.strerror}")
701 redef fun ==(other
) do return other
isa Path and simplified
.path
== other
.simplified
.path
702 redef fun hash
do return simplified
.path
.hash
705 # Information on a file
707 # Created by `Path::stat` and `Path::link_stat`.
709 # The information within this class is gathered when the instance is initialized
710 # it will not be updated if the targeted file is modified.
716 # The low-level status of a file
719 private var stat
: NativeFileStat
721 private var finalized
= false
725 if not finalized
then
731 # Returns the last access time in seconds since Epoch
732 fun last_access_time
: Int
738 # Returns the last access time
740 # alias for `last_access_time`
741 fun atime
: Int do return last_access_time
743 # Returns the last modification time in seconds since Epoch
744 fun last_modification_time
: Int
750 # Returns the last modification time
752 # alias for `last_modification_time`
753 fun mtime
: Int do return last_modification_time
756 # Size of the file at `path`
763 # Is self a regular file and not a device file, pipe, socket, etc.?
770 # Alias for `is_file`
771 fun is_reg
: Bool do return is_file
773 # Is this a directory?
780 # Is this a symbolic link?
787 # FIXME Make the following POSIX only? or implement in some other way on Windows
789 # Returns the last status change time in seconds since Epoch
790 fun last_status_change_time
: Int
796 # Returns the last status change time
798 # alias for `last_status_change_time`
799 fun ctime
: Int do return last_status_change_time
801 # Returns the permission bits of file
808 # Is this a character device?
815 # Is this a block device?
822 # Is this a FIFO pipe?
829 # Is this a UNIX socket
838 # Access file system related services on the path at `self`
839 fun to_path
: Path do return new Path(to_s
)
841 private fun write_native_to
(s
: FileWriter)
843 for i
in substrings
do s
.write_native
(i
.to_cstring
, 0, i
.length
)
848 # return true if a file with this names exists
849 fun file_exists
: Bool do return to_cstring
.file_exists
851 # The status of a file. see POSIX stat(2).
852 fun file_stat
: nullable FileStat
854 var stat
= to_cstring
.file_stat
855 if stat
.address_is_null
then return null
856 return new FileStat(stat
)
859 # The status of a file or of a symlink. see POSIX lstat(2).
860 fun file_lstat
: nullable FileStat
862 var stat
= to_cstring
.file_lstat
863 if stat
.address_is_null
then return null
864 return new FileStat(stat
)
867 # Remove a file, return true if success
868 fun file_delete
: Bool do return to_cstring
.file_delete
870 # Copy content of file at `self` to `dest`
871 fun file_copy_to
(dest
: String) do to_path
.copy
(dest
.to_path
)
873 # Remove the trailing `extension`.
875 # `extension` usually starts with a dot but could be anything.
877 # assert "file.txt".strip_extension(".txt") == "file"
878 # assert "file.txt".strip_extension("le.txt") == "fi"
879 # assert "file.txt".strip_extension("xt") == "file.t"
881 # If `extension == null`, the rightmost extension is stripped, including the last dot.
883 # assert "file.txt".strip_extension == "file"
885 # If `extension` is not present, `self` is returned unmodified.
887 # assert "file.txt".strip_extension(".tar.gz") == "file.txt"
888 fun strip_extension
(extension
: nullable String): String
890 if extension
== null then
891 extension
= file_extension
892 if extension
== null then
894 else extension
= ".{extension}"
897 if has_suffix
(extension
) then
898 return substring
(0, length
- extension
.length
)
903 # Extract the basename of a path and strip the `extension`
905 # The extension is stripped only if `extension != null`.
907 # assert "/path/to/a_file.ext".basename(".ext") == "a_file"
908 # assert "path/to/a_file.ext".basename(".ext") == "a_file"
909 # assert "path/to/a_file.ext".basename == "a_file.ext"
910 # assert "path/to".basename(".ext") == "to"
911 # assert "path/to/".basename(".ext") == "to"
912 # assert "path/to".basename == "to"
913 # assert "path".basename("") == "path"
914 # assert "/path".basename("") == "path"
915 # assert "/".basename("") == "/"
916 # assert "".basename("") == ""
917 fun basename
(extension
: nullable String): String
919 var l
= length
- 1 # Index of the last char
920 while l
> 0 and self.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
921 if l
== 0 then return "/"
922 var pos
= chars
.last_index_of_from
('/', l
)
925 n
= substring
(pos
+1, l-pos
)
928 if extension
!= null then
929 return n
.strip_extension
(extension
)
933 # Extract the dirname of a path
935 # assert "/path/to/a_file.ext".dirname == "/path/to"
936 # assert "path/to/a_file.ext".dirname == "path/to"
937 # assert "path/to".dirname == "path"
938 # assert "path/to/".dirname == "path"
939 # assert "path".dirname == "."
940 # assert "/path".dirname == "/"
941 # assert "/".dirname == "/"
942 # assert "".dirname == "."
945 var l
= length
- 1 # Index of the last char
946 while l
> 0 and self.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
947 var pos
= chars
.last_index_of_from
('/', l
)
949 return substring
(0, pos
)
950 else if pos
== 0 then
957 # Return the canonicalized absolute pathname (see POSIX function `realpath`)
958 fun realpath
: String do
959 var cs
= to_cstring
.file_realpath
960 var res
= cs
.to_s_with_copy
961 # cs.free_malloc # FIXME memory leak
965 # Simplify a file path by remove useless `.`, removing `//`, and resolving `..`
967 # * `..` are not resolved if they start the path
968 # * starting `.` is simplified unless the path is empty
969 # * starting `/` is not removed
970 # * trailing `/` is removed
972 # Note that the method only work on the string:
974 # * no I/O access is performed
975 # * the validity of the path is not checked
978 # assert "some/./complex/../../path/from/../to/a////file//".simplify_path == "path/to/a/file"
979 # assert "../dir/file".simplify_path == "../dir/file"
980 # assert "dir/../../".simplify_path == ".."
981 # assert "dir/..".simplify_path == "."
982 # assert "//absolute//path/".simplify_path == "/absolute/path"
983 # assert "//absolute//../".simplify_path == "/"
984 # assert "/".simplify_path == "/"
985 # assert "../".simplify_path == ".."
986 # assert "./".simplify_path == "."
987 # assert "././././././".simplify_path == "."
988 # assert "./../dir".simplify_path == "../dir"
989 # assert "./dir".simplify_path == "dir"
991 fun simplify_path
: String
993 var a
= self.split_with
("/")
994 var a2
= new Array[String]
996 if x
== "." and not a2
.is_empty
then continue # skip `././`
997 if x
== "" and not a2
.is_empty
then continue # skip `//`
998 if x
== ".." and not a2
.is_empty
and a2
.last
!= ".." then
999 if a2
.last
== "." then # do not skip `./../`
1000 a2
.pop
# reduce `./../` in `../`
1001 else # reduce `dir/../` in `/`
1005 else if not a2
.is_empty
and a2
.last
== "." then
1006 a2
.pop
# reduce `./dir` in `dir`
1010 if a2
.is_empty
then return "."
1011 if a2
.length
== 1 and a2
.first
== "" then return "/"
1015 # Correctly join two path using the directory separator.
1017 # Using a standard "{self}/{path}" does not work in the following cases:
1019 # * `self` is empty.
1020 # * `path` starts with `'/'`.
1022 # This method ensures that the join is valid.
1024 # assert "hello".join_path("world") == "hello/world"
1025 # assert "hel/lo".join_path("wor/ld") == "hel/lo/wor/ld"
1026 # assert "".join_path("world") == "world"
1027 # assert "hello".join_path("/world") == "/world"
1028 # assert "hello/".join_path("world") == "hello/world"
1029 # assert "hello/".join_path("/world") == "/world"
1031 # Note: You may want to use `simplify_path` on the result.
1033 # Note: This method works only with POSIX paths.
1034 fun join_path
(path
: String): String
1036 if path
.is_empty
then return self
1037 if self.is_empty
then return path
1038 if path
.chars
[0] == '/' then return path
1039 if self.last
== '/' then return "{self}{path}"
1040 return "{self}/{path}"
1043 # Convert the path (`self`) to a program name.
1045 # Ensure the path (`self`) will be treated as-is by POSIX shells when it is
1046 # used as a program name. In order to do that, prepend `./` if needed.
1048 # assert "foo".to_program_name == "./foo"
1049 # assert "/foo".to_program_name == "/foo"
1050 # assert "".to_program_name == "./" # At least, your shell will detect the error.
1051 fun to_program_name
: String do
1052 if self.has_prefix
("/") then
1059 # Alias for `join_path`
1061 # assert "hello" / "world" == "hello/world"
1062 # assert "hel/lo" / "wor/ld" == "hel/lo/wor/ld"
1063 # assert "" / "world" == "world"
1064 # assert "/hello" / "/world" == "/world"
1066 # This operator is quite useful for chaining changes of path.
1067 # The next one being relative to the previous one.
1071 # var c = "baz/foobar"
1072 # assert a/b/c == "/bar/baz/foobar"
1073 fun /(path
: String): String do return join_path
(path
)
1075 # Returns the relative path needed to go from `self` to `dest`.
1077 # assert "/foo/bar".relpath("/foo/baz") == "../baz"
1078 # assert "/foo/bar".relpath("/baz/bar") == "../../baz/bar"
1080 # If `self` or `dest` is relative, they are considered relatively to `getcwd`.
1082 # In some cases, the result is still independent of the current directory:
1084 # assert "foo/bar".relpath("..") == "../../.."
1086 # In other cases, parts of the current directory may be exhibited:
1088 # var p = "../foo/bar".relpath("baz")
1089 # var c = getcwd.basename
1090 # assert p == "../../{c}/baz"
1092 # For path resolution independent of the current directory (eg. for paths in URL),
1093 # or to use an other starting directory than the current directory,
1094 # just force absolute paths:
1096 # var start = "/a/b/c/d"
1097 # var p2 = (start/"../foo/bar").relpath(start/"baz")
1098 # assert p2 == "../../d/baz"
1101 # Neither `self` or `dest` has to be real paths or to exist in directories since
1102 # the resolution is only done with string manipulations and without any access to
1103 # the underlying file system.
1105 # If `self` and `dest` are the same directory, the empty string is returned:
1107 # assert "foo".relpath("foo") == ""
1108 # assert "foo/../bar".relpath("bar") == ""
1110 # The empty string and "." designate both the current directory:
1112 # assert "".relpath("foo/bar") == "foo/bar"
1113 # assert ".".relpath("foo/bar") == "foo/bar"
1114 # assert "foo/bar".relpath("") == "../.."
1115 # assert "/" + "/".relpath(".") == getcwd
1116 fun relpath
(dest
: String): String
1119 var from
= (cwd
/self).simplify_path
.split
("/")
1120 if from
.last
.is_empty
then from
.pop
# case for the root directory
1121 var to
= (cwd
/dest
).simplify_path
.split
("/")
1122 if to
.last
.is_empty
then to
.pop
# case for the root directory
1124 # Remove common prefixes
1125 while not from
.is_empty
and not to
.is_empty
and from
.first
== to
.first
do
1130 # Result is going up in `from` with ".." then going down following `to`
1131 var from_len
= from
.length
1132 if from_len
== 0 then return to
.join
("/")
1133 var up
= "../"*(from_len-1
) + ".."
1134 if to
.is_empty
then return up
1135 var res
= up
+ "/" + to
.join
("/")
1139 # Create a directory (and all intermediate directories if needed)
1141 # Return an error object in case of error.
1143 # assert "/etc/".mkdir != null
1144 fun mkdir
: nullable Error
1146 var dirs
= self.split_with
("/")
1147 var path
= new FlatBuffer
1148 if dirs
.is_empty
then return null
1149 if dirs
[0].is_empty
then
1150 # it was a starting /
1153 var error
: nullable Error = null
1155 if d
.is_empty
then continue
1158 var res
= path
.to_s
.to_cstring
.file_mkdir
1159 if not res
and error
== null then
1160 error
= new IOError("Cannot create directory `{path}`: {sys.errno.strerror}")
1166 # Delete a directory and all of its content, return `true` on success
1168 # Does not go through symbolic links and may get stuck in a cycle if there
1169 # is a cycle in the filesystem.
1171 # Return an error object in case of error.
1173 # assert "/fail/does not/exist".rmdir != null
1174 fun rmdir
: nullable Error
1181 # Change the current working directory
1184 # assert getcwd == "/etc"
1186 # assert getcwd == "/"
1188 # Return an error object in case of error.
1190 # assert "/etc".chdir == null
1191 # assert "/fail/does no/exist".chdir != null
1192 # assert getcwd == "/etc" # unchanger
1193 fun chdir
: nullable Error
1195 var res
= to_cstring
.file_chdir
1196 if res
then return null
1197 var error
= new IOError("Cannot change directory to `{self}`: {sys.errno.strerror}")
1201 # Return right-most extension (without the dot)
1203 # Only the last extension is returned.
1204 # There is no special case for combined extensions.
1206 # assert "file.txt".file_extension == "txt"
1207 # assert "file.tar.gz".file_extension == "gz"
1209 # For file without extension, `null` is returned.
1210 # Hoever, for trailing dot, `""` is returned.
1212 # assert "file".file_extension == null
1213 # assert "file.".file_extension == ""
1215 # The starting dot of hidden files is never considered.
1217 # assert ".file.txt".file_extension == "txt"
1218 # assert ".file".file_extension == null
1219 fun file_extension
: nullable String
1221 var last_slash
= chars
.last_index_of
('.')
1222 if last_slash
> 0 then
1223 return substring
( last_slash
+1, length
)
1229 # Returns entries contained within the directory represented by self.
1231 # var files = "/etc".files
1232 # assert files.has("issue")
1234 # Returns an empty array in case of error
1236 # files = "/etc/issue".files
1237 # assert files.is_empty
1239 # TODO find a better way to handle errors and to give them back to the user.
1240 fun files
: Array[String]
1242 var res
= new Array[String]
1243 var d
= new NativeDir.opendir
(to_cstring
)
1244 if d
.address_is_null
then return res
1248 if de
.address_is_null
then break
1249 var name
= de
.to_s_with_copy
1250 if name
== "." or name
== ".." then continue
1259 redef class FlatString
1260 redef fun write_native_to
(s
)
1262 s
.write_native
(items
, index_from
, length
)
1266 redef class NativeString
1267 private fun file_exists
: Bool `{
1268 FILE *hdl = fopen(self,"r");
1275 private fun file_stat
: NativeFileStat `{
1277 if(stat(self, &buff) != -1) {
1278 struct stat* stat_element;
1279 stat_element = malloc(sizeof(struct stat));
1280 return memcpy(stat_element, &buff, sizeof(struct stat));
1285 private fun file_lstat
: NativeFileStat `{
1286 struct stat* stat_element;
1288 stat_element = malloc(sizeof(struct stat));
1289 res = lstat(self, stat_element);
1290 if (res == -1) return NULL;
1291 return stat_element;
1294 private fun file_mkdir
: Bool `{ return !mkdir(self, 0777); `}
1296 private fun rmdir: Bool `{ return !rmdir(self); `}
1298 private fun file_delete
: Bool `{
1299 return remove(self) == 0;
1302 private fun file_chdir
: Bool `{ return !chdir(self); `}
1304 private fun file_realpath: NativeString `{ return realpath(self, NULL); `}
1307 # This class is system dependent ... must reify the vfs
1308 private extern class NativeFileStat `{ struct stat * `}
1310 # Returns the permission bits of file
1311 fun mode: Int `{ return self->st_mode; `}
1313 # Returns the last access time
1314 fun atime
: Int `{ return self->st_atime; `}
1316 # Returns the last status change time
1317 fun ctime: Int `{ return self->st_ctime; `}
1319 # Returns the last modification time
1320 fun mtime
: Int `{ return self->st_mtime; `}
1323 fun size: Int `{ return self->st_size; `}
1325 # Returns true if it is a regular file (not a device file, pipe, sockect, ...)
1326 fun is_reg
: Bool `{ return S_ISREG(self->st_mode); `}
1328 # Returns true if it is a directory
1329 fun is_dir: Bool `{ return S_ISDIR(self->st_mode); `}
1331 # Returns true if it is a character device
1332 fun is_chr
: Bool `{ return S_ISCHR(self->st_mode); `}
1334 # Returns true if it is a block device
1335 fun is_blk: Bool `{ return S_ISBLK(self->st_mode); `}
1337 # Returns true if the type is fifo
1338 fun is_fifo
: Bool `{ return S_ISFIFO(self->st_mode); `}
1340 # Returns true if the type is a link
1341 fun is_lnk: Bool `{ return S_ISLNK(self->st_mode); `}
1343 # Returns true if the type is a socket
1344 fun is_sock
: Bool `{ return S_ISSOCK(self->st_mode); `}
1347 # Instance of this class are standard FILE * pointers
1348 private extern class NativeFile `{ FILE* `}
1349 fun io_read
(buf
: NativeString, len
: Int): Int `{
1350 return fread(buf, 1, len, self);
1353 fun io_write
(buf
: NativeString, from
, len
: Int): Int `{
1354 return fwrite(buf+from, 1, len, self);
1357 fun write_byte
(value
: Byte): Int `{
1358 unsigned char b = (unsigned char)value;
1359 return fwrite(&b, 1, 1, self);
1362 fun io_close
: Int `{ return fclose(self); `}
1364 fun file_stat: NativeFileStat `{
1366 if(fstat
(fileno
(self), &buff
) != -1) {
1367 struct stat
* stat_element
;
1368 stat_element
= malloc
(sizeof
(struct stat
));
1369 return memcpy
(stat_element
, &buff
, sizeof
(struct stat
));
1374 fun ferror: Bool `{ return ferror(self); `}
1376 fun fileno
: Int `{ return fileno(self); `}
1378 # Flushes the buffer, forcing the write operation
1379 fun flush: Int `{ return fflush(self); `}
1381 # Used to specify how the buffering will be handled for the current stream.
1382 fun set_buffering_type
(buf_length
: Int, mode
: Int): Int `{
1383 return setvbuf(self, NULL, mode, buf_length);
1386 new io_open_read
(path
: NativeString) `{ return fopen(path, "r"); `}
1388 new io_open_write(path: NativeString) `{ return fopen(path, "w"); `}
1390 new native_stdin
`{ return stdin; `}
1392 new native_stdout `{ return stdout; `}
1394 new native_stderr
`{ return stderr; `}
1397 # Standard `DIR*` pointer
1398 private extern class NativeDir `{ DIR* `}
1401 new opendir
(path
: NativeString) `{ return opendir(path); `}
1404 fun closedir `{ closedir(self); `}
1406 # Read the next directory entry
1407 fun readdir
: NativeString `{
1410 if (!de) return NULL;
1418 var stdin
: PollableReader = new Stdin is protected writable, lazy
1421 var stdout
: Writer = new Stdout is protected writable, lazy
1423 # Standard output for errors
1424 var stderr
: Writer = new Stderr is protected writable, lazy
1426 # Enumeration for buffer mode full (flushes when buffer is full)
1427 fun buffer_mode_full
: Int `{ return _IOFBF; `}
1429 # Enumeration for buffer mode line (flushes when a `\n
` is encountered)
1430 fun buffer_mode_line: Int `{ return _IONBF; `}
1432 # Enumeration for buffer mode none (flushes ASAP when something is written)
1433 fun buffer_mode_none
: Int `{ return _IOLBF; `}
1435 # returns first available stream to read or write to
1436 # return null on interruption (possibly a signal)
1437 protected fun poll( streams : Sequence[FileStream] ) : nullable FileStream
1439 var in_fds = new Array[Int]
1440 var out_fds = new Array[Int]
1441 var fd_to_stream = new HashMap[Int,FileStream]
1444 if s isa FileReader then in_fds.add( fd )
1445 if s isa FileWriter then out_fds.add( fd )
1447 fd_to_stream[fd] = s
1450 var polled_fd = intern_poll( in_fds, out_fds )
1452 if polled_fd == null then
1455 return fd_to_stream[polled_fd]
1459 private fun intern_poll(in_fds: Array[Int], out_fds: Array[Int]): nullable Int
1460 import Array[Int].length, Array[Int].[], Int.as(nullable Int) `{
1461 int in_len
, out_len
, total_len
;
1462 struct pollfd
*c_fds
;
1464 int first_polled_fd
= -1;
1467 in_len
= Array_of_Int_length( in_fds
);
1468 out_len
= Array_of_Int_length( out_fds
);
1469 total_len
= in_len
+ out_len
;
1470 c_fds
= malloc
( sizeof
(struct pollfd
) * total_len
);
1473 for ( i
=0; i
<in_len
; i
++ ) {
1475 fd
= Array_of_Int__index( in_fds
, i
);
1478 c_fds
[i
].events
= POLLIN;
1481 /* output streams
*/
1482 for ( i
=0; i
<out_len
; i
++ ) {
1484 fd
= Array_of_Int__index( out_fds
, i
);
1487 c_fds
[i
].events
= POLLOUT;
1490 /* poll all fds
, unlimited timeout
*/
1491 result
= poll
( c_fds
, total_len
, -1 );
1494 /* analyse results
*/
1495 for ( i
=0; i
<total_len
; i
++ )
1496 if ( c_fds
[i
].revents
& c_fds
[i
].events
|| /* awaited event
*/
1497 c_fds
[i
].revents
& POLLHUP ) /* closed
*/
1499 first_polled_fd
= c_fds
[i
].fd
;
1503 return Int_as_nullable( first_polled_fd
);
1505 else if ( result
< 0 )
1506 fprintf
( stderr
, "Error in Stream:poll: %s\n", strerror
( errno
) );
1513 # Print `objects
` on the standard output (`stdout
`).
1514 fun printn(objects: Object...)
1516 sys.stdout.write(objects.plain_to_s)
1519 # Print an `object
` on the standard output (`stdout
`) and add a newline.
1520 fun print(object: Object)
1522 sys.stdout.write(object.to_s)
1523 sys.stdout.write("\n")
1526 # Print `object
` on the error output (`stderr
` or a log system)
1527 fun print_error(object: Object)
1529 sys.stderr.write object.to_s
1530 sys.stderr.write "\n"
1533 # Read a character from the standard input (`stdin
`).
1536 var c = sys.stdin.read_char
1537 if c == null then return '\1'
1541 # Read a line from the standard input (`stdin
`).
1544 return sys.stdin.read_line
1547 # Return the working (current) directory
1548 fun getcwd: String do return native_getcwd.to_s
1550 private fun native_getcwd: NativeString `{ return getcwd(NULL, 0); `}