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>
43 # `Stream` used to interact with a File or FileDescriptor
44 abstract class FileStream
46 # The path of the file.
47 var path
: nullable String = null
50 private var file
: nullable NativeFile = null
52 # The status of a file. see POSIX stat(2).
54 # var f = new FileReader.open("/etc/issue")
55 # assert f.file_stat.is_file
57 # Return null in case of error
58 fun file_stat
: nullable FileStat
60 var stat
= _file
.as(not null).file_stat
61 if stat
.address_is_null
then return null
62 return new FileStat(stat
)
65 # File descriptor of this file
66 fun fd
: Int do return _file
.as(not null).fileno
71 if file
== null then return
72 if file
.address_is_null
then
73 if last_error
!= null then return
74 last_error
= new IOError("Cannot close unopened file")
79 last_error
= new IOError("Close failed due to error {sys.errno.strerror}")
84 # Sets the buffering mode for the current FileStream
86 # If the buf_size is <= 0, its value will be 512 by default
88 # The mode is any of the buffer_mode enumeration in `Sys`:
90 # * `buffer_mode_full`
91 # * `buffer_mode_line`
92 # * `buffer_mode_none`
93 fun set_buffering_mode
(buf_size
, mode
: Int) do
94 if buf_size
<= 0 then buf_size
= 512
95 if _file
.as(not null).set_buffering_type
(buf_size
, mode
) != 0 then
96 last_error
= new IOError("Error while changing buffering type for FileStream, returned error {sys.errno.strerror}")
101 # `Stream` that can read from a File
107 # Open the same file again.
108 # The original path is reused, therefore the reopened file can be a different file.
110 # var f = new FileReader.open("/etc/issue")
111 # var l = f.read_line
113 # assert l == f.read_line
117 if fl
!= null and not fl
.address_is_null
then close
119 _file
= new NativeFile.io_open_read
(path
.as(not null).to_cstring
)
120 if _file
.as(not null).address_is_null
then
121 last_error
= new IOError("Cannot open `{path.as(not null)}`: {sys.errno.strerror}")
126 redef fun raw_read_byte
128 var nb
= _file
.as(not null).io_read
(write_buffer
, 1)
129 if last_error
== null and _file
.as(not null).ferror
then
130 last_error
= new IOError("Cannot read `{path.as(not null)}`: {sys.errno.strerror}")
132 if nb
== 0 then return -1
133 return write_buffer
[0].to_i
136 redef fun raw_read_bytes
(cstr
, max
)
138 var nb
= _file
.as(not null).io_read
(cstr
, max
)
139 if last_error
== null and _file
.as(not null).ferror
then
140 last_error
= new IOError("Cannot read `{path.as(not null)}`: {sys.errno.strerror}")
147 if fl
== null then return true
148 if fl
.address_is_null
then return true
149 if last_error
!= null then return true
151 if last_error
!= null then return true
157 # Open the file at `path` for reading.
159 # var f = new FileReader.open("/etc/issue")
163 # In case of error, `last_error` is set
165 # f = new FileReader.open("/fail/does not/exist")
167 # assert f.last_error != null
168 init open
(path
: String)
171 _file
= new NativeFile.io_open_read
(path
.to_cstring
)
172 if _file
.as(not null).address_is_null
then
173 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
177 # Creates a new File stream from a file descriptor
179 # This is a low-level method.
180 init from_fd
(fd
: Int) do
182 _file
= fd
.fd_to_stream
(read_only
)
183 if _file
.as(not null).address_is_null
then
184 last_error
= new IOError("Error: Converting fd {fd} to stream failed with '{sys.errno.strerror}'")
190 var res
= native_poll_in
(fd
)
192 last_error
= new IOError(errno
.to_s
)
197 private fun native_poll_in
(fd
: Int): Int `{
199 struct pollfd fds = {(int)fd, POLLIN, 0};
200 return poll(&fds, 1, 0);
207 # `Stream` that can write to a File
212 redef fun write_bytes_from_cstring
(cs
, len
) do
213 if last_error
!= null then return
214 if not _is_writable
then
215 last_error
= new IOError("cannot write to non-writable stream")
218 write_native
(cs
, 0, len
)
223 if last_error
!= null then return
224 if not _is_writable
then
225 last_error
= new IOError("cannot write to non-writable stream")
228 s
.write_native_to
(self)
231 redef fun write_byte
(value
)
233 if last_error
!= null then return
234 if not _is_writable
then
235 last_error
= new IOError("Cannot write to non-writable stream")
238 if _file
.as(not null).address_is_null
then
239 last_error
= new IOError("Writing on a null stream")
244 var err
= _file
.as(not null).write_byte
(value
)
247 last_error
= new IOError("Problem writing a byte: {err}")
256 redef var is_writable
= false
258 # Write `len` bytes from `native`.
259 private fun write_native
(native
: CString, from
, len
: Int)
261 if last_error
!= null then return
262 if not _is_writable
then
263 last_error
= new IOError("Cannot write to non-writable stream")
266 if _file
.as(not null).address_is_null
then
267 last_error
= new IOError("Writing on a null stream")
271 var err
= _file
.as(not null).io_write
(native
, from
, len
)
274 last_error
= new IOError("Problem in writing : {err} {len} \n")
278 # Open the file at `path` for writing.
279 init open
(path
: String)
281 _file
= new NativeFile.io_open_write
(path
.to_cstring
)
284 if _file
.as(not null).address_is_null
then
285 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
290 # Creates a new File stream from a file descriptor
291 init from_fd
(fd
: Int) do
293 _file
= fd
.fd_to_stream
(wipe_write
)
295 if _file
.as(not null).address_is_null
then
296 last_error
= new IOError("Error: Opening stream from file descriptor {fd} failed with '{sys.errno.strerror}'")
303 # Creates a file stream from a file descriptor `fd` using the file access `mode`.
305 # NOTE: The `mode` specified must be compatible with the one used in the file descriptor.
306 private fun fd_to_stream
(mode
: CString): NativeFile `{
307 return fdopen((int)self, mode);
311 # Constant for read-only file streams
312 private fun read_only
: CString do return once
"r".to_cstring
314 # Constant for write-only file streams
316 # If a stream is opened on a file with this method,
317 # it will wipe the previous file if any.
318 # Else, it will create the file.
319 private fun wipe_write
: CString do return once
"w".to_cstring
321 ###############################################################################
323 # Standard input stream.
325 # The class of the default value of `sys.stdin`.
330 _file
= new NativeFile.native_stdin
335 # Standard output stream.
337 # The class of the default value of `sys.stdout`.
341 _file
= new NativeFile.native_stdout
344 set_buffering_mode
(256, sys
.buffer_mode_line
)
348 # Standard error stream.
350 # The class of the default value of `sys.stderr`.
354 _file
= new NativeFile.native_stderr
360 ###############################################################################
363 # Like `write_to` but take care of creating the file
364 fun write_to_file
(filepath
: String)
366 var stream
= new FileWriter.open
(filepath
)
372 # Utility class to access file system services.
374 # Usually created with `Text::to_path`.
376 # `Path` objects does not necessarily represent existing files in a file system.
377 # They are sate-less objects that efficiently represent path information.
378 # They also provide an easy to use API on file-system services and are used to store their error status (see `last_error`)
381 private var path
: String
384 redef fun to_s
do return path
386 # Short name of the file at `to_s`
389 # var path = "/tmp/somefile".to_path
390 # assert path.filename == "somefile"
393 # The result does not depend of the file system, thus is cached for efficiency.
394 var filename
: String = path
.basename
is lazy
396 # The path simplified by removing useless `.`, removing `//`, and resolving `..`
399 # var path = "somedir/./tmp/../somefile".to_path
400 # assert path.simplified.to_s == "somedir/somefile"
403 # See `String:simplify_path` for details.
405 # The result does not depend of the file system, thus is cached for efficiency.
406 var simplified
: Path is lazy
do
407 var res
= path
.simplify_path
.to_path
412 # Return the directory part of the path.
415 # var path = "/foo/bar/baz".to_path
416 # assert path.dir.to_s == "/foo/bar"
417 # assert path.dir.dir.to_s == "/foo"
418 # assert path.dir.dir.dir.to_s == "/"
421 # See `String:dirname` for details.
423 # The result does not depend of the file system, thus is cached for efficiency.
424 var dir
: Path is lazy
do
425 return path
.dirname
.to_path
428 # Last error produced by I/O operations.
431 # var path = "/does/not/exists".to_path
432 # assert path.last_error == null
434 # assert path.last_error != null
437 # Since `Path` objects are stateless, `last_error` is reset on most operations and reflect its status.
438 var last_error
: nullable IOError = null is writable
440 # Does the file at `path` exists?
442 # If the file does not exists, `last_error` is set to the information.
443 fun exists
: Bool do return stat
!= null
445 # Information on the file at `self` following symbolic links
447 # Returns `null` if there is no file at `self`.
448 # `last_error` is updated to contains the error information on error, and null on success.
450 # assert "/etc/".to_path.stat.is_dir
451 # assert "/etc/issue".to_path.stat.is_file
452 # assert "/fail/does not/exist".to_path.stat == null
455 # var p = "/tmp/".to_path
457 # if stat != null then # Does `p` exist?
458 # print "It's size is {stat.size}"
459 # if stat.is_dir then print "It's a directory"
461 # print p.last_error.to_s
464 fun stat
: nullable FileStat
466 var stat
= path
.to_cstring
.file_stat
467 if stat
.address_is_null
then
468 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
472 return new FileStat(stat
)
475 # Information on the file or link at `self`
477 # Do not follow symbolic links.
478 fun link_stat
: nullable FileStat
480 var stat
= path
.to_cstring
.file_lstat
481 if stat
.address_is_null
then
482 last_error
= new IOError("Cannot open `{path}`: {sys.errno.strerror}")
486 return new FileStat(stat
)
489 # Delete a file from the file system.
491 # `last_error` is updated to contains the error information on error, and null on success.
494 var res
= path
.to_cstring
.file_delete
496 last_error
= new IOError("Cannot delete `{path}`: {sys.errno.strerror}")
502 # Copy content of file at `path` to `dest`.
504 # `last_error` is updated to contains the error information on error, and null on success.
509 var output
= dest
.open_wo
511 var buffer
= new CString(4096)
512 while not input
.eof
do
513 var read
= input
.read_bytes_to_cstring
(buffer
, 4096)
514 output
.write_bytes_from_cstring
(buffer
, read
)
519 last_error
= input
.last_error
or else output
.last_error
522 # Open this file for reading.
525 # var file = "/etc/issue".to_path.open_ro
526 # print file.read_line
530 # Note that it is the user's responsibility to close the stream.
531 # Therefore, for simple use case, look at `read_all` or `each_line`.
533 # ENSURE `last_error == result.last_error`
534 fun open_ro
: FileReader
536 var res
= new FileReader.open
(path
)
537 last_error
= res
.last_error
541 # Open this file for writing
544 # var file = "bla.log".to_path.open_wo
545 # file.write "Blabla\n"
549 # Note that it is the user's responsibility to close the stream.
550 # Therefore, for simple use case, look at `Writable::write_to_file`.
552 # ENSURE `last_error == result.last_error`
553 fun open_wo
: FileWriter
555 var res
= new FileWriter.open
(path
)
556 last_error
= res
.last_error
560 # Read all the content of the file as a string.
563 # var content = "/etc/issue".to_path.read_all
567 # `last_error` is updated to contains the error information on error, and null on success.
568 # In case of error, the result might be empty or truncated.
570 # See `Reader::read_all` for details.
571 fun read_all
: String do return read_all_bytes
.to_s
573 # Read all the content on the file as a raw sequence of bytes.
576 # var content = "/etc/issue".to_path.read_all_bytes
580 # `last_error` is updated to contains the error information on error, and null on success.
581 # In case of error, the result might be empty or truncated.
582 fun read_all_bytes
: Bytes
585 var res
= s
.read_all_bytes
587 last_error
= s
.last_error
591 # Read all the lines of the file
594 # var lines = "/etc/passwd".to_path.read_lines
596 # print "{lines.length} users"
599 # var fields = l.split(":")
600 # print "name={fields[0]} uid={fields[2]}"
604 # `last_error` is updated to contains the error information on error, and null on success.
605 # In case of error, the result might be empty or truncated.
607 # See `Reader::read_lines` for details.
608 fun read_lines
: Array[String]
611 var res
= s
.read_lines
613 last_error
= s
.last_error
617 # Return an iterator on each line of the file
620 # for l in "/etc/passwd".to_path.each_line do
621 # var fields = l.split(":")
622 # print "name={fields[0]} uid={fields[2]}"
626 # Note: the stream is automatically closed at the end of the file (see `LineIterator::close_on_finish`)
628 # `last_error` is updated to contains the error information on error, and null on success.
630 # See `Reader::each_line` for details.
631 fun each_line
: LineIterator
634 var res
= s
.each_line
635 res
.close_on_finish
= true
636 last_error
= s
.last_error
640 # Correctly join `self` with `subpath` using the directory separator.
642 # Using a standard "{self}/{path}" does not work in the following cases:
645 # * `path` starts with `'/'`.
647 # This method ensures that the join is valid.
649 # var hello = "hello".to_path
650 # assert (hello/"world").to_s == "hello/world"
651 # assert ("hel/lo".to_path / "wor/ld").to_s == "hel/lo/wor/ld"
652 # assert ("".to_path / "world").to_s == "world"
653 # assert (hello / "/world").to_s == "/world"
654 # assert ("hello/".to_path / "world").to_s == "hello/world"
655 fun /(subpath
: String): Path do return new Path(path
/ subpath
)
657 # Lists the files contained within the directory at `path`.
659 # var files = "/etc".to_path.files
660 # assert files.has("/etc/issue".to_path)
662 # `last_error` is updated to contains the error information on error, and null on success.
663 # In case of error, the result might be empty or truncated.
665 # var path = "/etc/issue".to_path
667 # assert files.is_empty
668 # assert path.last_error != null
669 fun files
: Array[Path]
672 var res
= new Array[Path]
673 var d
= new NativeDir.opendir
(path
.to_cstring
)
674 if d
.address_is_null
then
675 last_error
= new IOError("Cannot list directory `{path}`: {sys.errno.strerror}")
681 if de
.address_is_null
then
682 # readdir cannot fail, so null means end of list
686 if name
== "." or name
== ".." then continue
694 # Is `self` the path to an existing directory ?
697 # assert ".".to_path.is_dir
698 # assert not "/etc/issue".to_path.is_dir
699 # assert not "/should/not/exist".to_path.is_dir
703 if st
== null then return false
707 # Recursively delete a directory and all of its content
709 # Does not go through symbolic links and may get stuck in a cycle if there
710 # is a cycle in the file system.
712 # `last_error` is updated with the first encountered error, or null on success.
713 # The method does not stop on the first error and tries to remove the most files and directories.
716 # var path = "/does/not/exists/".to_path
718 # assert path.last_error != null
720 # path = "/tmp/path/to/create".to_path
724 # assert path.last_error == null
728 var first_error
= null
729 for file
in self.files
do
730 var stat
= file
.link_stat
732 if first_error
== null then first_error
= file
.last_error
741 if first_error
== null then first_error
= file
.last_error
744 # Delete the directory itself if things are fine
745 if first_error
== null then
746 if not path
.to_cstring
.rmdir
then
747 first_error
= new IOError("Cannot remove `{self}`: {sys.errno.strerror}")
750 self.last_error
= first_error
753 redef fun ==(other
) do return other
isa Path and simplified
.path
== other
.simplified
.path
754 redef fun hash
do return simplified
.path
.hash
757 # Information on a file
759 # Created by `Path::stat` and `Path::link_stat`.
761 # The information within this class is gathered when the instance is initialized
762 # it will not be updated if the targeted file is modified.
768 # The low-level status of a file
771 private var stat
: NativeFileStat
773 private var finalized
= false
777 if not finalized
then
783 # Returns the last access time in seconds since Epoch
784 fun last_access_time
: Int
790 # Returns the last access time
792 # alias for `last_access_time`
793 fun atime
: Int do return last_access_time
795 # Returns the last modification time in seconds since Epoch
796 fun last_modification_time
: Int
802 # Returns the last modification time
804 # alias for `last_modification_time`
805 fun mtime
: Int do return last_modification_time
808 # Size of the file at `path`
815 # Is self a regular file and not a device file, pipe, socket, etc.?
822 # Alias for `is_file`
823 fun is_reg
: Bool do return is_file
825 # Is this a directory?
832 # Is this a symbolic link?
839 # FIXME Make the following POSIX only? or implement in some other way on Windows
841 # Returns the last status change time in seconds since Epoch
842 fun last_status_change_time
: Int
848 # Returns the last status change time
850 # alias for `last_status_change_time`
851 fun ctime
: Int do return last_status_change_time
853 # Returns the permission bits of file
860 # Is this a character device?
867 # Is this a block device?
874 # Is this a FIFO pipe?
881 # Is this a UNIX socket
890 # Access file system related services on the path at `self`
891 fun to_path
: Path do return new Path(to_s
)
893 private fun write_native_to
(s
: FileWriter)
895 for i
in substrings
do s
.write_native
(i
.to_cstring
, 0, i
.byte_length
)
898 # return true if a file with this names exists
899 fun file_exists
: Bool do return to_cstring
.file_exists
901 # The status of a file. see POSIX stat(2).
902 fun file_stat
: nullable FileStat
904 var stat
= to_cstring
.file_stat
905 if stat
.address_is_null
then return null
906 return new FileStat(stat
)
909 # The status of a file or of a symlink. see POSIX lstat(2).
910 fun file_lstat
: nullable FileStat
912 var stat
= to_cstring
.file_lstat
913 if stat
.address_is_null
then return null
914 return new FileStat(stat
)
917 # Remove a file, return true if success
918 fun file_delete
: Bool do return to_cstring
.file_delete
920 # Copy content of file at `self` to `dest`
921 fun file_copy_to
(dest
: String) do to_path
.copy
(dest
.to_path
)
923 # Remove the trailing `extension`.
925 # `extension` usually starts with a dot but could be anything.
927 # assert "file.txt".strip_extension(".txt") == "file"
928 # assert "file.txt".strip_extension("le.txt") == "fi"
929 # assert "file.txt".strip_extension("xt") == "file.t"
931 # If `extension == null`, the rightmost extension is stripped, including the last dot.
933 # assert "file.txt".strip_extension == "file"
935 # If `extension` is not present, `self` is returned unmodified.
937 # assert "file.txt".strip_extension(".tar.gz") == "file.txt"
938 fun strip_extension
(extension
: nullable String): String
940 if extension
== null then
941 extension
= file_extension
942 if extension
== null then
944 else extension
= ".{extension}"
947 if has_suffix
(extension
) then
948 return substring
(0, length
- extension
.length
).to_s
953 # Extract the basename of a path and strip the `extension`
955 # The extension is stripped only if `extension != null`.
957 # assert "/path/to/a_file.ext".basename(".ext") == "a_file"
958 # assert "path/to/a_file.ext".basename(".ext") == "a_file"
959 # assert "path/to/a_file.ext".basename == "a_file.ext"
960 # assert "path/to".basename(".ext") == "to"
961 # assert "path/to/".basename(".ext") == "to"
962 # assert "path/to".basename == "to"
963 # assert "path".basename == "path"
964 # assert "/path".basename == "path"
965 # assert "/".basename == "/"
966 # assert "".basename == ""
968 # On Windows, '\' are replaced by '/':
971 # assert "C:\\path\\to\\a_file.ext".basename(".ext") == "a_file"
972 # assert "C:\\".basename == "C:"
974 fun basename
(extension
: nullable String): String
977 if is_windows
then n
= n
.replace
("\\", "/")
979 var l
= length
- 1 # Index of the last char
980 while l
> 0 and self.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
981 if l
== 0 then return "/"
982 var pos
= chars
.last_index_of_from
('/', l
)
984 n
= substring
(pos
+1, l-pos
)
987 if extension
!= null then
988 return n
.strip_extension
(extension
)
992 # Extract the dirname of a path
994 # assert "/path/to/a_file.ext".dirname == "/path/to"
995 # assert "path/to/a_file.ext".dirname == "path/to"
996 # assert "path/to".dirname == "path"
997 # assert "path/to/".dirname == "path"
998 # assert "path".dirname == "."
999 # assert "/path".dirname == "/"
1000 # assert "/".dirname == "/"
1001 # assert "".dirname == "."
1003 # On Windows, '\' are replaced by '/':
1006 # assert "C:\\path\\to\\a_file.ext".dirname == "C:/path/to"
1007 # assert "C:\\file".dirname == "C:"
1012 if is_windows
then s
= s
.replace
("\\", "/")
1014 var l
= length
- 1 # Index of the last char
1015 while l
> 0 and s
.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
1016 var pos
= s
.chars
.last_index_of_from
('/', l
)
1018 return s
.substring
(0, pos
).to_s
1019 else if pos
== 0 then
1026 # Return the canonicalized absolute pathname (see POSIX function `realpath`)
1028 # Require: `file_exists`
1029 fun realpath
: String do
1030 var cs
= to_cstring
.file_realpath
1037 # Simplify a file path by remove useless `.`, removing `//`, and resolving `..`
1039 # * `..` are not resolved if they start the path
1040 # * starting `.` is simplified unless the path is empty
1041 # * starting `/` is not removed
1042 # * trailing `/` is removed
1044 # Note that the method only work on the string:
1046 # * no I/O access is performed
1047 # * the validity of the path is not checked
1050 # assert "some/./complex/../../path/from/../to/a////file//".simplify_path == "path/to/a/file"
1051 # assert "../dir/file".simplify_path == "../dir/file"
1052 # assert "dir/../../".simplify_path == ".."
1053 # assert "dir/..".simplify_path == "."
1054 # assert "//absolute//path/".simplify_path == "/absolute/path"
1055 # assert "//absolute//../".simplify_path == "/"
1056 # assert "/".simplify_path == "/"
1057 # assert "../".simplify_path == ".."
1058 # assert "./".simplify_path == "."
1059 # assert "././././././".simplify_path == "."
1060 # assert "./../dir".simplify_path == "../dir"
1061 # assert "./dir".simplify_path == "dir"
1064 # On Windows, '\' are replaced by '/':
1067 # assert "C:\\some\\.\\complex\\../../path/to/a_file.ext".simplify_path == "C:/path/to/a_file.ext"
1068 # assert "C:\\".simplify_path == "C:"
1070 fun simplify_path
: String
1073 if is_windows
then s
= s
.replace
("\\", "/")
1074 var a
= s
.split_with
("/")
1075 var a2
= new Array[String]
1077 if x
== "." and not a2
.is_empty
then continue # skip `././`
1078 if x
== "" and not a2
.is_empty
then continue # skip `//`
1079 if x
== ".." and not a2
.is_empty
and a2
.last
!= ".." then
1080 if a2
.last
== "." then # do not skip `./../`
1081 a2
.pop
# reduce `./../` in `../`
1082 else # reduce `dir/../` in `/`
1086 else if not a2
.is_empty
and a2
.last
== "." then
1087 a2
.pop
# reduce `./dir` in `dir`
1091 if a2
.is_empty
then return "."
1092 if a2
.length
== 1 and a2
.first
== "" then return "/"
1096 # Correctly join two path using the directory separator.
1098 # Using a standard "{self}/{path}" does not work in the following cases:
1100 # * `self` is empty.
1101 # * `path` starts with `'/'`.
1103 # This method ensures that the join is valid.
1105 # assert "hello".join_path("world") == "hello/world"
1106 # assert "hel/lo".join_path("wor/ld") == "hel/lo/wor/ld"
1107 # assert "".join_path("world") == "world"
1108 # assert "hello".join_path("/world") == "/world"
1109 # assert "hello/".join_path("world") == "hello/world"
1110 # assert "hello/".join_path("/world") == "/world"
1112 # Note: You may want to use `simplify_path` on the result.
1114 # Note: This method works only with POSIX paths.
1115 fun join_path
(path
: Text): String
1117 if path
.is_empty
then return self.to_s
1118 if self.is_empty
then return path
.to_s
1119 if path
.chars
[0] == '/' then return path
.to_s
1120 if self.last
== '/' then return "{self}{path}"
1121 return "{self}/{path}"
1124 # Convert the path (`self`) to a program name.
1126 # Ensure the path (`self`) will be treated as-is by POSIX shells when it is
1127 # used as a program name. In order to do that, prepend `./` if needed.
1129 # assert "foo".to_program_name == "./foo"
1130 # assert "/foo".to_program_name == "/foo"
1131 # assert "".to_program_name == "./" # At least, your shell will detect the error.
1132 fun to_program_name
: String do
1133 if self.has_prefix
("/") then
1140 # Alias for `join_path`
1142 # assert "hello" / "world" == "hello/world"
1143 # assert "hel/lo" / "wor/ld" == "hel/lo/wor/ld"
1144 # assert "" / "world" == "world"
1145 # assert "/hello" / "/world" == "/world"
1147 # This operator is quite useful for chaining changes of path.
1148 # The next one being relative to the previous one.
1152 # var c = "baz/foobar"
1153 # assert a/b/c == "/bar/baz/foobar"
1154 fun /(path
: Text): String do return join_path
(path
)
1156 # Returns the relative path needed to go from `self` to `dest`.
1158 # assert "/foo/bar".relpath("/foo/baz") == "../baz"
1159 # assert "/foo/bar".relpath("/baz/bar") == "../../baz/bar"
1161 # If `self` or `dest` is relative, they are considered relatively to `getcwd`.
1163 # In some cases, the result is still independent of the current directory:
1165 # assert "foo/bar".relpath("..") == "../../.."
1167 # In other cases, parts of the current directory may be exhibited:
1169 # var p = "../foo/bar".relpath("baz")
1170 # var c = getcwd.basename
1171 # assert p == "../../{c}/baz"
1173 # For path resolution independent of the current directory (eg. for paths in URL),
1174 # or to use an other starting directory than the current directory,
1175 # just force absolute paths:
1177 # var start = "/a/b/c/d"
1178 # var p2 = (start/"../foo/bar").relpath(start/"baz")
1179 # assert p2 == "../../d/baz"
1182 # Neither `self` or `dest` has to be real paths or to exist in directories since
1183 # the resolution is only done with string manipulations and without any access to
1184 # the underlying file system.
1186 # If `self` and `dest` are the same directory, the empty string is returned:
1188 # assert "foo".relpath("foo") == ""
1189 # assert "foo/../bar".relpath("bar") == ""
1191 # The empty string and "." designate both the current directory:
1193 # assert "".relpath("foo/bar") == "foo/bar"
1194 # assert ".".relpath("foo/bar") == "foo/bar"
1195 # assert "foo/bar".relpath("") == "../.."
1196 # assert "/" + "/".relpath(".") == getcwd
1197 fun relpath
(dest
: String): String
1199 # TODO windows support
1201 var from
= (cwd
/self).simplify_path
.split
("/")
1202 if from
.last
.is_empty
then from
.pop
# case for the root directory
1203 var to
= (cwd
/dest
).simplify_path
.split
("/")
1204 if to
.last
.is_empty
then to
.pop
# case for the root directory
1206 # Remove common prefixes
1207 while not from
.is_empty
and not to
.is_empty
and from
.first
== to
.first
do
1212 # Result is going up in `from` with ".." then going down following `to`
1213 var from_len
= from
.length
1214 if from_len
== 0 then return to
.join
("/")
1215 var up
= "../"*(from_len-1
) + ".."
1216 if to
.is_empty
then return up
1217 var res
= up
+ "/" + to
.join
("/")
1221 # Create a directory (and all intermediate directories if needed)
1223 # The optional `mode` parameter specifies the permissions of the directory,
1224 # the default value is `0o777`.
1226 # Return an error object in case of error.
1228 # assert "/etc/".mkdir != null
1229 fun mkdir
(mode
: nullable Int): nullable Error
1231 mode
= mode
or else 0o777
1233 if is_windows
then s
= s
.replace
("\\", "/")
1235 var dirs
= s
.split_with
("/")
1236 var path
= new FlatBuffer
1237 if dirs
.is_empty
then return null
1238 if dirs
[0].is_empty
then
1239 # it was a starting /
1242 var error
: nullable Error = null
1243 for i
in [0 .. dirs
.length
- 1[ do
1245 if d
.is_empty
then continue
1248 if path
.file_exists
then continue
1249 var res
= path
.to_cstring
.file_mkdir
(mode
)
1250 if not res
and error
== null then
1251 error
= new IOError("Cannot create directory `{path}`: {sys.errno.strerror}")
1254 var res
= s
.to_cstring
.file_mkdir
(mode
)
1255 if not res
and error
== null then
1256 error
= new IOError("Cannot create directory `{path}`: {sys.errno.strerror}")
1261 # Delete a directory and all of its content, return `true` on success
1263 # Does not go through symbolic links and may get stuck in a cycle if there
1264 # is a cycle in the filesystem.
1266 # Return an error object in case of error.
1268 # assert "/fail/does not/exist".rmdir != null
1269 fun rmdir
: nullable Error
1276 # Change the current working directory
1279 # assert getcwd == "/etc"
1281 # assert getcwd == "/"
1283 # Return an error object in case of error.
1285 # assert "/etc".chdir == null
1286 # assert "/fail/does no/exist".chdir != null
1287 # assert getcwd == "/etc" # unchanger
1288 fun chdir
: nullable Error
1290 var res
= to_cstring
.file_chdir
1291 if res
then return null
1292 var error
= new IOError("Cannot change directory to `{self}`: {sys.errno.strerror}")
1296 # Return right-most extension (without the dot)
1298 # Only the last extension is returned.
1299 # There is no special case for combined extensions.
1301 # assert "file.txt".file_extension == "txt"
1302 # assert "file.tar.gz".file_extension == "gz"
1304 # For file without extension, `null` is returned.
1305 # Hoever, for trailing dot, `""` is returned.
1307 # assert "file".file_extension == null
1308 # assert "file.".file_extension == ""
1310 # The starting dot of hidden files is never considered.
1312 # assert ".file.txt".file_extension == "txt"
1313 # assert ".file".file_extension == null
1314 fun file_extension
: nullable String
1316 var last_slash
= chars
.last_index_of
('.')
1317 if last_slash
> 0 then
1318 return substring
( last_slash
+1, length
).to_s
1324 # Returns entries contained within the directory represented by self.
1326 # var files = "/etc".files
1327 # assert files.has("issue")
1329 # Returns an empty array in case of error
1331 # files = "/etc/issue".files
1332 # assert files.is_empty
1334 # TODO find a better way to handle errors and to give them back to the user.
1335 fun files
: Array[String]
1337 var res
= new Array[String]
1338 var d
= new NativeDir.opendir
(to_cstring
)
1339 if d
.address_is_null
then return res
1343 if de
.address_is_null
then break
1345 if name
== "." or name
== ".." then continue
1354 redef class FlatString
1355 redef fun write_native_to
(s
)
1357 s
.write_native
(items
, first_byte
, byte_length
)
1360 redef fun file_extension
do
1364 var st
= _first_byte
1365 while p
>= st
and c
!= u
'.' do
1369 if p
<= st
then return null
1371 return new FlatString.with_infos
(its
, ls
- p
, p
+ 1)
1374 redef fun basename
(extension
) do
1376 if is_windows
then s
= s
.replace
("\\", "/").as(FlatString)
1381 var min
= s
._first_byte
1383 while l
> min
and its
[l
] == sl
do l
-= 1
1384 if l
== min
then return "/"
1386 while ns
>= min
and its
[ns
] != sl
do ns
-= 1
1387 bname
= new FlatString.with_infos
(its
, l
- ns
, ns
+ 1)
1389 return if extension
!= null then bname
.strip_extension
(extension
) else bname
1394 private fun file_exists
: Bool `{
1396 DWORD attribs = GetFileAttributesA(self);
1397 return attribs != INVALID_FILE_ATTRIBUTES;
1399 FILE *hdl = fopen(self,"r");
1407 private fun file_stat
: NativeFileStat `{
1409 if(stat(self, &buff) != -1) {
1410 struct stat* stat_element;
1411 stat_element = malloc(sizeof(struct stat));
1412 return memcpy(stat_element, &buff, sizeof(struct stat));
1417 private fun file_lstat
: NativeFileStat `{
1419 // FIXME use a higher level abstraction to support WIN32
1422 struct stat* stat_element;
1424 stat_element = malloc(sizeof(struct stat));
1425 res = lstat(self, stat_element);
1426 if (res == -1) return NULL;
1427 return stat_element;
1431 private fun file_mkdir
(mode
: Int): Bool `{
1433 return !mkdir(self);
1435 return !mkdir(self, mode);
1439 private fun rmdir
: Bool `{ return !rmdir(self); `}
1441 private fun file_delete: Bool `{
1442 return remove
(self) == 0;
1445 private fun file_chdir: Bool `{ return !chdir(self); `}
1447 private fun file_realpath
: CString `{
1449 DWORD len = GetFullPathName(self, 0, NULL, NULL);
1450 char *buf = malloc(len+1); // FIXME don't leak memory
1451 len = GetFullPathName(self, len+1, buf, NULL);
1454 return realpath(self, NULL);
1459 # This class is system dependent ... must reify the vfs
1460 private extern class NativeFileStat `{ struct stat * `}
1462 # Returns the permission bits of file
1463 fun mode: Int `{ return self->st_mode; `}
1465 # Returns the last access time
1466 fun atime
: Int `{ return self->st_atime; `}
1468 # Returns the last status change time
1469 fun ctime: Int `{ return self->st_ctime; `}
1471 # Returns the last modification time
1472 fun mtime
: Int `{ return self->st_mtime; `}
1475 fun size: Int `{ return self->st_size; `}
1477 # Returns true if it is a regular file (not a device file, pipe, sockect, ...)
1478 fun is_reg
: Bool `{ return S_ISREG(self->st_mode); `}
1480 # Returns true if it is a directory
1481 fun is_dir: Bool `{ return S_ISDIR(self->st_mode); `}
1483 # Returns true if it is a character device
1484 fun is_chr
: Bool `{ return S_ISCHR(self->st_mode); `}
1486 # Returns true if it is a block device
1487 fun is_blk: Bool `{ return S_ISBLK(self->st_mode); `}
1489 # Returns true if the type is fifo
1490 fun is_fifo
: Bool `{ return S_ISFIFO(self->st_mode); `}
1492 # Returns true if the type is a link
1497 return S_ISLNK(self-
>st_mode
);
1501 # Returns true if the type is a socket
1502 fun is_sock: Bool `{
1506 return S_ISSOCK(self-
>st_mode
);
1511 # Instance of this class are standard FILE * pointers
1512 private extern class NativeFile `{ FILE* `}
1513 fun io_read
(buf
: CString, len
: Int): Int `{
1514 return fread(buf, 1, len, self);
1517 fun io_write
(buf
: CString, from
, len
: Int): Int `{
1518 size_t res = fwrite(buf+from, 1, len, self);
1520 // Force flushing buffer because end of line does not trigger a flush
1526 fun write_byte
(value
: Int): Int `{
1527 unsigned char b = (unsigned char)value;
1528 return fwrite(&b, 1, 1, self);
1531 fun io_close
: Int `{ return fclose(self); `}
1533 fun file_stat: NativeFileStat `{
1535 if(fstat
(fileno
(self), &buff
) != -1) {
1536 struct stat
* stat_element
;
1537 stat_element
= malloc
(sizeof
(struct stat
));
1538 return memcpy
(stat_element
, &buff
, sizeof
(struct stat
));
1543 fun ferror: Bool `{ return ferror(self); `}
1545 fun feof
: Bool `{ return feof(self); `}
1547 fun fileno: Int `{ return fileno(self); `}
1549 # Flushes the buffer, forcing the write operation
1550 fun flush
: Int `{ return fflush(self); `}
1552 # Used to specify how the buffering will be handled for the current stream.
1553 fun set_buffering_type(buf_length, mode: Int): Int `{
1554 return setvbuf
(self, NULL, (int
)mode
, buf_length
);
1557 new io_open_read(path: CString) `{ return fopen(path, "r"); `}
1559 new io_open_write
(path
: CString) `{ return fopen(path, "w"); `}
1561 new native_stdin `{ return stdin; `}
1563 new native_stdout
`{ return stdout; `}
1565 new native_stderr `{ return stderr; `}
1568 # Standard `DIR*` pointer
1569 private extern class NativeDir `{ DIR* `}
1572 new opendir(path: CString) `{ return opendir(path); `}
1575 fun closedir
`{ closedir(self); `}
1577 # Read the next directory entry
1578 fun readdir: CString `{
1581 if (!de
) return NULL;
1589 var stdin: PollableReader = new Stdin is protected writable, lazy
1592 var stdout: Writer = new Stdout is protected writable, lazy
1594 # Standard output for errors
1595 var stderr: Writer = new Stderr is protected writable, lazy
1597 # Enumeration for buffer mode full (flushes when buffer is full)
1598 fun buffer_mode_full: Int `{ return _IOFBF; `}
1600 # Enumeration for buffer mode line (flushes when a `\n` is encountered)
1601 fun buffer_mode_line
: Int `{ return _IONBF; `}
1603 # Enumeration for buffer mode none (flushes ASAP when something is written)
1604 fun buffer_mode_none: Int `{ return _IOLBF; `}
1606 # returns first available stream to read or write to
1607 # return null on interruption (possibly a signal)
1608 protected fun poll
( streams
: Sequence[FileStream] ) : nullable FileStream
1610 var in_fds
= new Array[Int]
1611 var out_fds
= new Array[Int]
1612 var fd_to_stream
= new HashMap[Int,FileStream]
1615 if s
isa FileReader then in_fds
.add
( fd
)
1616 if s
isa FileWriter then out_fds
.add
( fd
)
1618 fd_to_stream
[fd
] = s
1621 var polled_fd
= intern_poll
( in_fds
, out_fds
)
1623 if polled_fd
== null then
1626 return fd_to_stream
[polled_fd
]
1630 private fun intern_poll
(in_fds
: Array[Int], out_fds
: Array[Int]): nullable Int
1631 import Array[Int].length
, Array[Int].[], Int.as(nullable Int) `{
1633 // FIXME use a higher level abstraction to support WIN32
1635 int in_len, out_len, total_len;
1636 struct pollfd *c_fds;
1638 int first_polled_fd = -1;
1641 in_len = (int)Array_of_Int_length( in_fds );
1642 out_len = (int)Array_of_Int_length( out_fds );
1643 total_len = in_len + out_len;
1644 c_fds = malloc( sizeof(struct pollfd) * total_len );
1647 for ( i=0; i<in_len; i ++ ) {
1648 int fd = (int)Array_of_Int__index( in_fds, i );
1651 c_fds[i].events = POLLIN;
1654 /* output streams */
1655 for ( i=0; i<out_len; i ++ ) {
1656 int fd = (int)Array_of_Int__index( out_fds, i );
1659 c_fds[i].events = POLLOUT;
1662 /* poll all fds, unlimited timeout */
1663 result = poll( c_fds, total_len, -1 );
1666 /* analyse results */
1667 for ( i=0; i<total_len; i++ )
1668 if ( c_fds[i].revents & c_fds[i].events || /* awaited event */
1669 c_fds[i].revents & POLLHUP ) /* closed */
1671 first_polled_fd = c_fds[i].fd;
1675 return Int_as_nullable( first_polled_fd );
1677 else if ( result < 0 )
1678 fprintf( stderr, "Error in Stream:poll: %s\n", strerror( errno ) );
1686 # Print `objects` on the standard output (`stdout`).
1687 fun printn
(objects
: Object...)
1689 sys
.stdout
.write
(objects
.plain_to_s
)
1692 # Print an `object` on the standard output (`stdout`) and add a newline.
1693 fun print
(object
: Object)
1695 sys
.stdout
.write
(object
.to_s
)
1696 sys
.stdout
.write
("\n")
1699 # Print `object` on the error output (`stderr` or a log system)
1700 fun print_error
(object
: Object)
1702 sys
.stderr
.write object
.to_s
1703 sys
.stderr
.write
"\n"
1706 # Read a character from the standard input (`stdin`).
1709 var c
= sys
.stdin
.read_char
1710 if c
== null then return '\1'
1714 # Read a line from the standard input (`stdin`).
1717 return sys
.stdin
.read_line
1720 # Return the working (current) directory
1721 fun getcwd
: String do return native_getcwd
.to_s
1723 private fun native_getcwd
: CString `{ return getcwd(NULL, 0); `}