Merge branch 'streamable'
[nit.git] / lib / standard / file.nit
index a6b1aef..dbabb41 100644 (file)
 # another product.
 
 # File manipulations (create, read, write, etc.)
-package file
+module file
 
 intrude import stream
 intrude import string
 import string_search
 import time
 
+in "C Header" `{
+       #include <dirent.h>
+       #include <string.h>
+       #include <sys/types.h>
+       #include <sys/stat.h>
+       #include <unistd.h>
+`}
+
 redef class Object
 # Simple I/O
 
@@ -47,6 +55,10 @@ redef class Object
        do
                return stdin.read_line
        end
+
+       # Return the working (current) directory
+       protected fun getcwd: String do return file_getcwd.to_s
+       private fun file_getcwd: NativeString is extern "string_NativeString_NativeString_file_getcwd_0"
 end
 
 # File Abstract Stream
@@ -193,6 +205,16 @@ end
 
 ###############################################################################
 
+redef class Streamable
+       # Like `write_to` but take care of creating the file
+       fun write_to_file(filepath: String)
+       do
+               var stream = new OFStream.open(filepath)
+               write_to(stream)
+               stream.close
+       end
+end
+
 redef class String
        # return true if a file with this names exists
        fun file_exists: Bool do return to_cstring.file_exists
@@ -203,6 +225,21 @@ redef class String
        # Remove a file, return true if success
        fun file_delete: Bool do return to_cstring.file_delete
 
+       # Copy content of file at `self` to `dest`
+       fun file_copy_to(dest: String)
+       do
+               var input = new IFStream.open(self)
+               var output = new OFStream.open(dest)
+
+               while not input.eof do
+                       var buffer = input.read(1024)
+                       output.write buffer
+               end
+
+               input.close
+               output.close
+       end
+
        # remove the trailing extension "ext"
        fun strip_extension(ext: String): String
        do
@@ -213,12 +250,24 @@ redef class String
        end
 
        # Extract the basename of a path and remove the extension
+       #
+       #     assert "/path/to/a_file.ext".basename(".ext")         == "a_file"
+       #     assert "path/to/a_file.ext".basename(".ext")          == "a_file"
+       #     assert "path/to".basename(".ext")                     == "to"
+       #     assert "path/to/".basename(".ext")                    == "to"
+       #     assert "path".basename("")                        == "path"
+       #     assert "/path".basename("")                       == "path"
+       #     assert "/".basename("")                           == "/"
+       #     assert "".basename("")                            == ""
        fun basename(ext: String): String
        do
-               var pos = last_index_of_from('/', _length - 1)
+               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 = last_index_of_from('/', l)
                var n = self
                if pos >= 0 then
-                       n = substring_from(pos+1)
+                       n = substring(pos+1, l-pos)
                end
                return n.strip_extension(ext)
        end
@@ -236,7 +285,7 @@ redef class String
        fun dirname: String
        do
                var l = _length - 1 # Index of the last char
-               if l > 0 and self[l] == '/' then l -= 1 # remove trailing `/`
+               while l > 0 and self.chars[l] == '/' do l -= 1 # remove all trailing `/`
                var pos = last_index_of_from('/', l)
                if pos > 0 then
                        return substring(0, pos)
@@ -247,6 +296,14 @@ redef class String
                end
        end
 
+       # Return the canonicalized absolute pathname (see POSIX function `realpath`)
+       fun realpath: String do
+               var cs = to_cstring.file_realpath
+               var res = cs.to_s_with_copy
+               # cs.free_malloc # FIXME memory leak
+               return res
+       end
+
        # Simplify a file path by remove useless ".", removing "//", and resolving ".."
        # ".." are not resolved if they start the path
        # starting "/" is not removed
@@ -257,9 +314,10 @@ redef class String
        #  * the validity of the path is not checked
        #
        #     assert "some/./complex/../../path/from/../to/a////file//".simplify_path        ==  "path/to/a/file"
-       #     assert "../dir/file".simplify_path      ==  "../dir/file"
-       #     assert "dir/../../".simplify_path      ==  ".."
-       #     assert "//absolute//path/".simplify_path      ==  "/absolute/path"
+       #     assert "../dir/file".simplify_path       ==  "../dir/file"
+       #     assert "dir/../../".simplify_path        ==  ".."
+       #     assert "dir/..".simplify_path            ==  "."
+       #     assert "//absolute//path/".simplify_path ==  "/absolute/path"
        fun simplify_path: String
        do
                var a = self.split_with("/")
@@ -273,6 +331,7 @@ redef class String
                        end
                        a2.push(x)
                end
+               if a2.is_empty then return "."
                return a2.join("/")
        end
 
@@ -295,7 +354,7 @@ redef class String
        do
                if path.is_empty then return self
                if self.is_empty then return path
-               if path[0] == '/' then return path
+               if path.chars[0] == '/' then return path
                return "{self}/{path}"
        end
 
@@ -317,6 +376,16 @@ redef class String
                end
        end
 
+       # Change the current working directory
+       #
+       #     "/etc".chdir
+       #     assert getcwd == "/etc"
+       #     "..".chdir
+       #     assert getcwd == "/"
+       #
+       # TODO: errno
+       fun chdir do to_cstring.file_chdir
+
        # Return right-most extension (without the dot)
        fun file_extension : nullable String
        do
@@ -329,7 +398,36 @@ redef class String
        end
 
        # returns files contained within the directory represented by self
-       fun files : Set[ String ] is extern import HashSet, HashSet::add, NativeString::to_s, String::to_cstring, HashSet[String] as( Set[String] ), String as( Object )
+       fun files : Set[ String ] is extern import HashSet[String], HashSet[String].add, NativeString.to_s, String.to_cstring, HashSet[String].as(Set[String]) `{
+               char *dir_path;
+               DIR *dir;
+
+               dir_path = String_to_cstring( recv );
+               if ((dir = opendir(dir_path)) == NULL)
+               {
+                       perror( dir_path );
+                       exit( 1 );
+               }
+               else
+               {
+                       HashSet_of_String results;
+                       String file_name;
+                       struct dirent *de;
+
+                       results = new_HashSet_of_String();
+
+                       while ( ( de = readdir( dir ) ) != NULL )
+                               if ( strcmp( de->d_name, ".." ) != 0 &&
+                                       strcmp( de->d_name, "." ) != 0 )
+                               {
+                                       file_name = NativeString_to_s( strdup( de->d_name ) );
+                                       HashSet_of_String_add( results, file_name );
+                               }
+
+                       closedir( dir );
+                       return HashSet_of_String_as_Set_of_String( results );
+               }
+       `}
 end
 
 redef class NativeString
@@ -345,6 +443,8 @@ redef class NativeString
        `}
        private fun file_mkdir: Bool is extern "string_NativeString_NativeString_file_mkdir_0"
        private fun file_delete: Bool is extern "string_NativeString_NativeString_file_delete_0"
+       private fun file_chdir is extern "string_NativeString_NativeString_file_chdir_0"
+       private fun file_realpath: NativeString is extern "file_NativeString_realpath"
 end
 
 extern FileStat `{ struct stat * `}
@@ -365,7 +465,7 @@ extern FileStat `{ struct stat * `}
 end
 
 # Instance of this class are standard FILE * pointers
-private extern NativeFile
+private extern NativeFile `{ FILE* `}
        fun io_read(buf: NativeString, len: Int): Int is extern "file_NativeFile_NativeFile_io_read_2"
        fun io_write(buf: NativeString, len: Int): Int is extern "file_NativeFile_NativeFile_io_write_2"
        fun io_close: Int is extern "file_NativeFile_NativeFile_io_close_0"