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.)
26 #include <sys/types.h>
34 # Print `objects` on the standard output (`stdout`).
35 protected fun printn
(objects
: Object...)
37 stdout
.write
(objects
.to_s
)
40 # Print an `object` on the standard output (`stdout`) and add a newline.
41 protected fun print
(object
: Object)
43 stdout
.write
(object
.to_s
)
47 # Read a character from the standard input (`stdin`).
48 protected fun getc
: Char
50 return stdin
.read_char
.ascii
53 # Read a line from the standard input (`stdin`).
54 protected fun gets
: String
56 return stdin
.read_line
59 # Return the working (current) directory
60 protected fun getcwd
: String do return file_getcwd
.to_s
61 private fun file_getcwd
: NativeString is extern "string_NativeString_NativeString_file_getcwd_0"
64 # File Abstract Stream
65 abstract class FStream
67 # The path of the file.
68 readable var _path
: nullable String = null
71 var _file
: nullable NativeFile = null
73 fun file_stat
: FileStat
74 do return _file
.file_stat
end
83 # Open the same file again.
84 # The original path is reused, therefore the reopened file can be a different file.
88 _file
= new NativeFile.io_open_read
(_path
.to_cstring
)
96 var i
= _file
.io_close
100 redef fun fill_buffer
102 var nb
= _file
.io_read
(_buffer
._items
, _buffer
._capacity
)
112 redef readable var _end_reached
: Bool = false
114 # Open the file at `path` for reading.
115 init open
(path
: String)
119 _file
= new NativeFile.io_open_read
(_path
.to_cstring
)
120 assert cant_open_file
: _file
!= null
124 private init without_file
do end
135 write_native
(s
.to_cstring
, s
.length
)
138 redef fun is_writable
do return _writable
142 var i
= _file
.io_close
146 # Is the file open in write mode
149 # Write `len` bytes from `native`.
150 private fun write_native
(native
: NativeString, len
: Int)
153 var err
= _file
.io_write
(native
, len
)
156 printn
("Problem in writing : ", err
, " ", len
, "\n")
160 # Open the file at `path` for writing.
161 init open
(path
: String)
163 _file
= new NativeFile.io_open_write
(path
.to_cstring
)
164 assert cant_open_file
: _file
!= null
170 private init without_file
do end
173 ###############################################################################
178 _file
= new NativeFile.native_stdin
183 # Is these something to read? (non blocking)
184 # FIXME: should be generalized
185 fun poll_in
: Bool is extern "file_stdin_poll_in"
191 _file
= new NativeFile.native_stdout
192 _path
= "/dev/stdout"
200 _file
= new NativeFile.native_stderr
201 _path
= "/dev/stderr"
206 ###############################################################################
208 redef class Streamable
209 # Like `write_to` but take care of creating the file
210 fun write_to_file
(filepath
: String)
212 var stream
= new OFStream.open
(filepath
)
219 # return true if a file with this names exists
220 fun file_exists
: Bool do return to_cstring
.file_exists
222 fun file_stat
: FileStat do return to_cstring
.file_stat
223 fun file_lstat
: FileStat do return to_cstring
.file_lstat
225 # Remove a file, return true if success
226 fun file_delete
: Bool do return to_cstring
.file_delete
228 # Copy content of file at `self` to `dest`
229 fun file_copy_to
(dest
: String)
231 var input
= new IFStream.open
(self)
232 var output
= new OFStream.open
(dest
)
234 while not input
.eof
do
235 var buffer
= input
.read
(1024)
243 # remove the trailing extension "ext"
244 fun strip_extension
(ext
: String): String
246 if has_suffix
(ext
) then
247 return substring
(0, length
- ext
.length
)
252 # Extract the basename of a path and remove the extension
253 fun basename
(ext
: String): String
255 var pos
= last_index_of_from
('/', _length
- 1)
258 n
= substring_from
(pos
+1)
260 return n
.strip_extension
(ext
)
263 # Extract the dirname of a path
265 # assert "/path/to/a_file.ext".dirname == "/path/to"
266 # assert "path/to/a_file.ext".dirname == "path/to"
267 # assert "path/to".dirname == "path"
268 # assert "path/to/".dirname == "path"
269 # assert "path".dirname == "."
270 # assert "/path".dirname == "/"
271 # assert "/".dirname == "/"
272 # assert "".dirname == "."
275 var l
= _length
- 1 # Index of the last char
276 if l
> 0 and self.chars
[l
] == '/' then l
-= 1 # remove trailing `/`
277 var pos
= last_index_of_from
('/', l
)
279 return substring
(0, pos
)
280 else if pos
== 0 then
287 # Return the canonicalized absolute pathname (see POSIX function `realpath`)
288 fun realpath
: String do
289 var cs
= to_cstring
.file_realpath
290 var res
= cs
.to_s_with_copy
291 # cs.free_malloc # FIXME memory leak
295 # Simplify a file path by remove useless ".", removing "//", and resolving ".."
296 # ".." are not resolved if they start the path
297 # starting "/" is not removed
298 # trainling "/" is removed
300 # Note that the method only wonrk on the string:
301 # * no I/O access is performed
302 # * the validity of the path is not checked
304 # assert "some/./complex/../../path/from/../to/a////file//".simplify_path == "path/to/a/file"
305 # assert "../dir/file".simplify_path == "../dir/file"
306 # assert "dir/../../".simplify_path == ".."
307 # assert "dir/..".simplify_path == "."
308 # assert "//absolute//path/".simplify_path == "/absolute/path"
309 fun simplify_path
: String
311 var a
= self.split_with
("/")
312 var a2
= new Array[String]
314 if x
== "." then continue
315 if x
== "" and not a2
.is_empty
then continue
316 if x
== ".." and not a2
.is_empty
and a2
.last
!= ".." then
322 if a2
.is_empty
then return "."
326 # Correctly join two path using the directory separator.
328 # Using a standard "{self}/{path}" does not work when `self` is the empty string.
329 # This method ensure that the join is valid.
331 # assert "hello".join_path("world") == "hello/world"
332 # assert "hel/lo".join_path("wor/ld") == "hel/lo/wor/ld"
333 # assert "".join_path("world") == "world"
334 # assert "/hello".join_path("/world") == "/world"
336 # Note: you may want to use `simplify_path` on the result
338 # Note: I you want to join a great number of path, you can write
340 # [p1, p2, p3, p4].join("/")
341 fun join_path
(path
: String): String
343 if path
.is_empty
then return self
344 if self.is_empty
then return path
345 if path
.chars
[0] == '/' then return path
346 return "{self}/{path}"
349 # Create a directory (and all intermediate directories if needed)
352 var dirs
= self.split_with
("/")
353 var path
= new Buffer
354 if dirs
.is_empty
then return
355 if dirs
[0].is_empty
then
356 # it was a starting /
360 if d
.is_empty
then continue
363 path
.to_s
.to_cstring
.file_mkdir
367 # Change the current working directory
370 # assert getcwd == "/etc"
372 # assert getcwd == "/"
375 fun chdir
do to_cstring
.file_chdir
377 # Return right-most extension (without the dot)
378 fun file_extension
: nullable String
380 var last_slash
= last_index_of
('.')
381 if last_slash
>= 0 then
382 return substring
( last_slash
+1, length
)
388 # returns files contained within the directory represented by self
389 fun files
: Set[ String ] is extern import HashSet[String], HashSet[String].add
, NativeString.to_s
, String.to_cstring
, HashSet[String].as(Set[String]) `{
393 dir_path = String_to_cstring( recv );
394 if ((dir = opendir(dir_path)) == NULL)
401 HashSet_of_String results;
405 results = new_HashSet_of_String();
407 while ( ( de = readdir( dir ) ) != NULL )
408 if ( strcmp( de->d_name, ".." ) != 0 &&
409 strcmp( de->d_name, "." ) != 0 )
411 file_name = NativeString_to_s( strdup( de->d_name ) );
412 HashSet_of_String_add( results, file_name );
416 return HashSet_of_String_as_Set_of_String( results );
421 redef class NativeString
422 private fun file_exists
: Bool is extern "string_NativeString_NativeString_file_exists_0"
423 private fun file_stat
: FileStat is extern "string_NativeString_NativeString_file_stat_0"
424 private fun file_lstat
: FileStat `{
425 struct stat* stat_element;
427 stat_element = malloc(sizeof(struct stat));
428 res = lstat(recv, stat_element);
429 if (res == -1) return NULL;
432 private fun file_mkdir
: Bool is extern "string_NativeString_NativeString_file_mkdir_0"
433 private fun file_delete
: Bool is extern "string_NativeString_NativeString_file_delete_0"
434 private fun file_chdir
is extern "string_NativeString_NativeString_file_chdir_0"
435 private fun file_realpath
: NativeString is extern "file_NativeString_realpath"
438 extern FileStat `{ struct stat * `}
439 # This class is system dependent ... must reify the vfs
440 fun mode: Int is extern "file_FileStat_FileStat_mode_0"
441 fun atime: Int is extern "file_FileStat_FileStat_atime_0"
442 fun ctime: Int is extern "file_FileStat_FileStat_ctime_0"
443 fun mtime: Int is extern "file_FileStat_FileStat_mtime_0"
444 fun size: Int is extern "file_FileStat_FileStat_size_0"
446 fun is_reg: Bool `{ return S_ISREG(recv->st_mode); `}
447 fun is_dir
: Bool `{ return S_ISDIR(recv->st_mode); `}
448 fun is_chr: Bool `{ return S_ISCHR(recv->st_mode); `}
449 fun is_blk
: Bool `{ return S_ISBLK(recv->st_mode); `}
450 fun is_fifo: Bool `{ return S_ISFIFO(recv->st_mode); `}
451 fun is_lnk
: Bool `{ return S_ISLNK(recv->st_mode); `}
452 fun is_sock: Bool `{ return S_ISSOCK(recv->st_mode); `}
455 # Instance of this class are standard FILE * pointers
456 private extern NativeFile `{ FILE* `}
457 fun io_read(buf: NativeString, len: Int): Int is extern "file_NativeFile_NativeFile_io_read_2"
458 fun io_write(buf: NativeString, len: Int): Int is extern "file_NativeFile_NativeFile_io_write_2"
459 fun io_close: Int is extern "file_NativeFile_NativeFile_io_close_0"
460 fun file_stat: FileStat is extern "file_NativeFile_NativeFile_file_stat_0"
462 new io_open_read(path: NativeString) is extern "file_NativeFileCapable_NativeFileCapable_io_open_read_1"
463 new io_open_write(path: NativeString) is extern "file_NativeFileCapable_NativeFileCapable_io_open_write_1"
464 new native_stdin is extern "file_NativeFileCapable_NativeFileCapable_native_stdin_0"
465 new native_stdout is extern "file_NativeFileCapable_NativeFileCapable_native_stdout_0"
466 new native_stderr is extern "file_NativeFileCapable_NativeFileCapable_native_stderr_0"
470 fun stdin: Stdin do return once new Stdin
473 fun stdout: OFStream do return once new Stdout
475 # Standard output for error.
476 fun stderr: OFStream do return once new Stderr