core: standardize Windows path handling
[nit.git] / lib / core / file.nit
index 23d3ce3..09b20d9 100644 (file)
@@ -257,7 +257,7 @@ class FileWriter
        redef var is_writable = false
 
        # Write `len` bytes from `native`.
-       private fun write_native(native: NativeString, from, len: Int)
+       private fun write_native(native: CString, from, len: Int)
        do
                if last_error != null then return
                if not _is_writable then
@@ -304,20 +304,20 @@ redef class Int
        # Creates a file stream from a file descriptor `fd` using the file access `mode`.
        #
        # NOTE: The `mode` specified must be compatible with the one used in the file descriptor.
-       private fun fd_to_stream(mode: NativeString): NativeFile `{
+       private fun fd_to_stream(mode: CString): NativeFile `{
                return fdopen((int)self, mode);
        `}
 end
 
 # Constant for read-only file streams
-private fun read_only: NativeString do return once "r".to_cstring
+private fun read_only: CString do return once "r".to_cstring
 
 # Constant for write-only file streams
 #
 # If a stream is opened on a file with this method,
 # it will wipe the previous file if any.
 # Else, it will create the file.
-private fun wipe_write: NativeString do return once "w".to_cstring
+private fun wipe_write: CString do return once "w".to_cstring
 
 ###############################################################################
 
@@ -683,7 +683,7 @@ class Path
                                # readdir cannot fail, so null means end of list
                                break
                        end
-                       var name = de.to_s_with_copy
+                       var name = de.to_s
                        if name == "." or name == ".." then continue
                        res.add self / name
                end
@@ -705,26 +705,32 @@ class Path
                return st.is_dir
        end
 
-       # Delete a directory and all of its content
+       # Recursively delete a directory and all of its content
        #
        # Does not go through symbolic links and may get stuck in a cycle if there
        # is a cycle in the file system.
        #
-       # `last_error` is updated to contains the error information on error, and null on success.
-       # The method does not stop on the first error and try to remove most file and directories.
+       # `last_error` is updated with the first encountered error, or null on success.
+       # The method does not stop on the first error and tries to remove the most files and directories.
        #
        # ~~~
        # var path = "/does/not/exists/".to_path
        # path.rmdir
        # assert path.last_error != null
+       #
+       # path = "/tmp/path/to/create".to_path
+       # path.to_s.mkdir
+       # assert path.exists
+       # path.rmdir
+       # assert path.last_error == null
        # ~~~
        fun rmdir
        do
-               last_error = null
+               var first_error = null
                for file in self.files do
                        var stat = file.link_stat
                        if stat == null then
-                               last_error = file.last_error
+                               if first_error == null then first_error = file.last_error
                                continue
                        end
                        if stat.is_dir then
@@ -733,15 +739,16 @@ class Path
                        else
                                file.delete
                        end
-                       if last_error == null then last_error = file.last_error
+                       if first_error == null then first_error = file.last_error
                end
 
                # Delete the directory itself if things are fine
-               if last_error == null then
-                       if path.to_cstring.rmdir then
-                               last_error = new IOError("Cannot remove `{self}`: {sys.errno.strerror}")
+               if first_error == null then
+                       if not path.to_cstring.rmdir then
+                               first_error = new IOError("Cannot remove `{self}`: {sys.errno.strerror}")
                        end
                end
+               self.last_error = first_error
        end
 
        redef fun ==(other) do return other isa Path and simplified.path == other.simplified.path
@@ -888,12 +895,12 @@ redef class Text
        do
                for i in substrings do s.write_native(i.to_cstring, 0, i.byte_length)
        end
-end
 
-redef class String
        # return true if a file with this names exists
        fun file_exists: Bool do return to_cstring.file_exists
+end
 
+redef class String
        # The status of a file. see POSIX stat(2).
        fun file_stat: nullable FileStat
        do
@@ -956,30 +963,28 @@ redef class String
        #     assert "path/to".basename(".ext")                 == "to"
        #     assert "path/to/".basename(".ext")                == "to"
        #     assert "path/to".basename                         == "to"
-       #     assert "path".basename("")                        == "path"
-       #     assert "/path".basename("")                       == "path"
-       #     assert "/".basename("")                           == "/"
-       #     assert "".basename("")                            == ""
+       #     assert "path".basename                            == "path"
+       #     assert "/path".basename                           == "path"
+       #     assert "/".basename                               == "/"
+       #     assert "".basename                                == ""
+       #
+       # On Windows, '\' are replaced by '/':
+       #
+       # ~~~nitish
+       # assert "C:\\path\\to\\a_file.ext".basename(".ext")    == "a_file"
+       # assert "C:\\".basename                                == "C:"
+       # ~~~
        fun basename(extension: nullable String): String
        do
                var n = self
-               if is_windows then
-                       var l = length - 1 # Index of the last char
-                       while l > 0 and (self.chars[l] == '/' or chars[l] == '\\') do l -= 1 # remove all trailing `/`
-                       if l == 0 then return "/"
-                       var pos = chars.last_index_of_from('/', l)
-                       pos = pos.max(last_index_of_from('\\', l))
-                       if pos >= 0 then
-                               n = substring(pos+1, l-pos)
-                       end
-               else
-                       var l = length - 1 # Index of the last char
-                       while l > 0 and self.chars[l] == '/' do l -= 1 # remove all trailing `/`
-                       if l == 0 then return "/"
-                       var pos = chars.last_index_of_from('/', l)
-                       if pos >= 0 then
-                               n = substring(pos+1, l-pos)
-                       end
+               if is_windows then n = n.replace("\\", "/")
+
+               var l = length - 1 # Index of the last char
+               while l > 0 and self.chars[l] == '/' do l -= 1 # remove all trailing `/`
+               if l == 0 then return "/"
+               var pos = chars.last_index_of_from('/', l)
+               if pos >= 0 then
+                       n = substring(pos+1, l-pos)
                end
 
                if extension != null then
@@ -997,13 +1002,23 @@ redef class String
        #     assert "/path".dirname                       == "/"
        #     assert "/".dirname                           == "/"
        #     assert "".dirname                            == "."
+       #
+       # On Windows, '\' are replaced by '/':
+       #
+       # ~~~nitish
+       # assert "C:\\path\\to\\a_file.ext".dirname        == "C:/path/to"
+       # assert "C:\\file".dirname                        == "C:"
+       # ~~~
        fun dirname: String
        do
+               var s = self
+               if is_windows then s = s.replace("\\", "/")
+
                var l = length - 1 # Index of the last char
-               while l > 0 and self.chars[l] == '/' do l -= 1 # remove all trailing `/`
-               var pos = chars.last_index_of_from('/', l)
+               while l > 0 and s.chars[l] == '/' do l -= 1 # remove all trailing `/`
+               var pos = s.chars.last_index_of_from('/', l)
                if pos > 0 then
-                       return substring(0, pos)
+                       return s.substring(0, pos)
                else if pos == 0 then
                        return "/"
                else
@@ -1017,7 +1032,7 @@ redef class String
        fun realpath: String do
                var cs = to_cstring.file_realpath
                assert file_exists
-               var res = cs.to_s_with_copy
+               var res = cs.to_s
                cs.free
                return res
        end
@@ -1048,9 +1063,18 @@ redef class String
        # assert "./../dir".simplify_path                  == "../dir"
        # assert "./dir".simplify_path                     == "dir"
        # ~~~
+       #
+       # On Windows, '\' are replaced by '/':
+       #
+       # ~~~nitish
+       # assert "C:\\some\\.\\complex\\../../path/to/a_file.ext".simplify_path == "C:/path/to/a_file.ext"
+       # assert "C:\\".simplify_path              == "C:"
+       # ~~~
        fun simplify_path: String
        do
-               var a = self.split_with("/")
+               var s = self
+               if is_windows then s = s.replace("\\", "/")
+               var a = s.split_with("/")
                var a2 = new Array[String]
                for x in a do
                        if x == "." and not a2.is_empty then continue # skip `././`
@@ -1175,6 +1199,7 @@ redef class String
        #     assert "/" + "/".relpath(".") == getcwd
        fun relpath(dest: String): String
        do
+               # TODO windows support
                var cwd = getcwd
                var from = (cwd/self).simplify_path.split("/")
                if from.last.is_empty then from.pop # case for the root directory
@@ -1207,8 +1232,10 @@ redef class String
        fun mkdir(mode: nullable Int): nullable Error
        do
                mode = mode or else 0o777
+               var s = self
+               if is_windows then s = s.replace("\\", "/")
 
-               var dirs = self.split_with("/")
+               var dirs = s.split_with("/")
                var path = new FlatBuffer
                if dirs.is_empty then return null
                if dirs[0].is_empty then
@@ -1216,15 +1243,21 @@ redef class String
                        path.add('/')
                end
                var error: nullable Error = null
-               for d in dirs do
+               for i in [0 .. dirs.length - 1[ do
+                       var d = dirs[i]
                        if d.is_empty then continue
                        path.append(d)
                        path.add('/')
-                       var res = path.to_s.to_cstring.file_mkdir(mode)
+                       if path.file_exists then continue
+                       var res = path.to_cstring.file_mkdir(mode)
                        if not res and error == null then
                                error = new IOError("Cannot create directory `{path}`: {sys.errno.strerror}")
                        end
                end
+               var res = s.to_cstring.file_mkdir(mode)
+               if not res and error == null then
+                       error = new IOError("Cannot create directory `{path}`: {sys.errno.strerror}")
+               end
                return error
        end
 
@@ -1311,7 +1344,7 @@ redef class String
                loop
                        var de = d.readdir
                        if de.address_is_null then break
-                       var name = de.to_s_with_copy
+                       var name = de.to_s
                        if name == "." or name == ".." then continue
                        res.add name
                end
@@ -1342,35 +1375,25 @@ redef class FlatString
        end
 
        redef fun basename(extension) do
+               var s = self
+               if is_windows then s = s.replace("\\", "/").as(FlatString)
+
                var bname
-               if is_windows then
-                       var l = last_byte
-                       var its = _items
-                       var min = _first_byte
-                       var sl = '/'.ascii
-                       var ls = '\\'.ascii
-                       while l > min and (its[l] == sl or its[l] == ls) do l -= 1
-                       if l == min then return "\\"
-                       var ns = l
-                       while ns >= min and its[ns] != sl and its[ns] != ls do ns -= 1
-                       bname = new FlatString.with_infos(its, l - ns, ns + 1)
-               else
-                       var l = last_byte
-                       var its = _items
-                       var min = _first_byte
-                       var sl = '/'.ascii
-                       while l > min and its[l] == sl do l -= 1
-                       if l == min then return "/"
-                       var ns = l
-                       while ns >= min and its[ns] != sl do ns -= 1
-                       bname = new FlatString.with_infos(its, l - ns, ns + 1)
-               end
+               var l = s.last_byte
+               var its = s._items
+               var min = s._first_byte
+               var sl = '/'.ascii
+               while l > min and its[l] == sl do l -= 1
+               if l == min then return "/"
+               var ns = l
+               while ns >= min and its[ns] != sl do ns -= 1
+               bname = new FlatString.with_infos(its, l - ns, ns + 1)
 
                return if extension != null then bname.strip_extension(extension) else bname
        end
 end
 
-redef class NativeString
+redef class CString
        private fun file_exists: Bool `{
 #ifdef _WIN32
                DWORD attribs = GetFileAttributesA(self);
@@ -1424,7 +1447,7 @@ redef class NativeString
 
        private fun file_chdir: Bool `{ return !chdir(self); `}
 
-       private fun file_realpath: NativeString `{
+       private fun file_realpath: CString `{
 #ifdef _WIN32
                DWORD len = GetFullPathName(self, 0, NULL, NULL);
                char *buf = malloc(len+1); // FIXME don't leak memory
@@ -1490,12 +1513,17 @@ end
 
 # Instance of this class are standard FILE * pointers
 private extern class NativeFile `{ FILE* `}
-       fun io_read(buf: NativeString, len: Int): Int `{
+       fun io_read(buf: CString, len: Int): Int `{
                return fread(buf, 1, len, self);
        `}
 
-       fun io_write(buf: NativeString, from, len: Int): Int `{
-               return fwrite(buf+from, 1, len, self);
+       fun io_write(buf: CString, from, len: Int): Int `{
+               size_t res = fwrite(buf+from, 1, len, self);
+#ifdef _WIN32
+               // Force flushing buffer because end of line does not trigger a flush
+               fflush(self);
+#endif
+               return (long)res;
        `}
 
        fun write_byte(value: Byte): Int `{
@@ -1527,9 +1555,9 @@ private extern class NativeFile `{ FILE* `}
                return setvbuf(self, NULL, (int)mode, buf_length);
        `}
 
-       new io_open_read(path: NativeString) `{ return fopen(path, "r"); `}
+       new io_open_read(path: CString) `{ return fopen(path, "r"); `}
 
-       new io_open_write(path: NativeString) `{ return fopen(path, "w"); `}
+       new io_open_write(path: CString) `{ return fopen(path, "w"); `}
 
        new native_stdin `{ return stdin; `}
 
@@ -1542,13 +1570,13 @@ end
 private extern class NativeDir `{ DIR* `}
 
        # Open a directory
-       new opendir(path: NativeString) `{ return opendir(path); `}
+       new opendir(path: CString) `{ return opendir(path); `}
 
        # Close a directory
        fun closedir `{ closedir(self); `}
 
        # Read the next directory entry
-       fun readdir: NativeString `{
+       fun readdir: CString `{
                struct dirent *de;
                de = readdir(self);
                if (!de) return NULL;
@@ -1693,4 +1721,4 @@ end
 # Return the working (current) directory
 fun getcwd: String do return native_getcwd.to_s
 
-private fun native_getcwd: NativeString `{ return getcwd(NULL, 0); `}
+private fun native_getcwd: CString `{ return getcwd(NULL, 0); `}