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 # The status of a file. see POSIX stat(2).
223 fun file_stat
: FileStat do return to_cstring
.file_stat
225 # The status of a file or of a symlink. see POSIX lstat(2).
226 fun file_lstat
: FileStat do return to_cstring
.file_lstat
228 # Remove a file, return true if success
229 fun file_delete
: Bool do return to_cstring
.file_delete
231 # Copy content of file at `self` to `dest`
232 fun file_copy_to
(dest
: String)
234 var input
= new IFStream.open
(self)
235 var output
= new OFStream.open
(dest
)
237 while not input
.eof
do
238 var buffer
= input
.read
(1024)
246 # Remove the trailing extension `ext`.
248 # `ext` usually starts with a dot but could be anything.
250 # assert "file.txt".strip_extension(".txt") == "file"
251 # assert "file.txt".strip_extension("le.txt") == "fi"
252 # assert "file.txt".strip_extension("xt") == "file.t"
254 # if `ext` is not present, `self` is returned unmodified.
256 # assert "file.txt".strip_extension(".tar.gz") == "file.txt"
257 fun strip_extension
(ext
: String): String
259 if has_suffix
(ext
) then
260 return substring
(0, length
- ext
.length
)
265 # Extract the basename of a path and remove the extension
267 # assert "/path/to/a_file.ext".basename(".ext") == "a_file"
268 # assert "path/to/a_file.ext".basename(".ext") == "a_file"
269 # assert "path/to".basename(".ext") == "to"
270 # assert "path/to/".basename(".ext") == "to"
271 # assert "path".basename("") == "path"
272 # assert "/path".basename("") == "path"
273 # assert "/".basename("") == "/"
274 # assert "".basename("") == ""
275 fun basename
(ext
: String): String
277 var l
= length
- 1 # Index of the last char
278 while l
> 0 and self.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
279 if l
== 0 then return "/"
280 var pos
= chars
.last_index_of_from
('/', l
)
283 n
= substring
(pos
+1, l-pos
)
285 return n
.strip_extension
(ext
)
288 # Extract the dirname of a path
290 # assert "/path/to/a_file.ext".dirname == "/path/to"
291 # assert "path/to/a_file.ext".dirname == "path/to"
292 # assert "path/to".dirname == "path"
293 # assert "path/to/".dirname == "path"
294 # assert "path".dirname == "."
295 # assert "/path".dirname == "/"
296 # assert "/".dirname == "/"
297 # assert "".dirname == "."
300 var l
= length
- 1 # Index of the last char
301 while l
> 0 and self.chars
[l
] == '/' do l
-= 1 # remove all trailing `/`
302 var pos
= chars
.last_index_of_from
('/', l
)
304 return substring
(0, pos
)
305 else if pos
== 0 then
312 # Return the canonicalized absolute pathname (see POSIX function `realpath`)
313 fun realpath
: String do
314 var cs
= to_cstring
.file_realpath
315 var res
= cs
.to_s_with_copy
316 # cs.free_malloc # FIXME memory leak
320 # Simplify a file path by remove useless ".", removing "//", and resolving ".."
321 # ".." are not resolved if they start the path
322 # starting "/" is not removed
323 # trainling "/" is removed
325 # Note that the method only wonrk on the string:
326 # * no I/O access is performed
327 # * the validity of the path is not checked
329 # assert "some/./complex/../../path/from/../to/a////file//".simplify_path == "path/to/a/file"
330 # assert "../dir/file".simplify_path == "../dir/file"
331 # assert "dir/../../".simplify_path == ".."
332 # assert "dir/..".simplify_path == "."
333 # assert "//absolute//path/".simplify_path == "/absolute/path"
334 fun simplify_path
: String
336 var a
= self.split_with
("/")
337 var a2
= new Array[String]
339 if x
== "." then continue
340 if x
== "" and not a2
.is_empty
then continue
341 if x
== ".." and not a2
.is_empty
and a2
.last
!= ".." then
347 if a2
.is_empty
then return "."
351 # Correctly join two path using the directory separator.
353 # Using a standard "{self}/{path}" does not work when `self` is the empty string.
354 # This method ensure that the join is valid.
356 # assert "hello".join_path("world") == "hello/world"
357 # assert "hel/lo".join_path("wor/ld") == "hel/lo/wor/ld"
358 # assert "".join_path("world") == "world"
359 # assert "/hello".join_path("/world") == "/world"
361 # Note: you may want to use `simplify_path` on the result
363 # Note: I you want to join a great number of path, you can write
365 # [p1, p2, p3, p4].join("/")
366 fun join_path
(path
: String): String
368 if path
.is_empty
then return self
369 if self.is_empty
then return path
370 if path
.chars
[0] == '/' then return path
371 return "{self}/{path}"
374 # Create a directory (and all intermediate directories if needed)
377 var dirs
= self.split_with
("/")
378 var path
= new FlatBuffer
379 if dirs
.is_empty
then return
380 if dirs
[0].is_empty
then
381 # it was a starting /
385 if d
.is_empty
then continue
388 path
.to_s
.to_cstring
.file_mkdir
392 # Change the current working directory
395 # assert getcwd == "/etc"
397 # assert getcwd == "/"
400 fun chdir
do to_cstring
.file_chdir
402 # Return right-most extension (without the dot)
404 # Only the last extension is returned.
405 # There is no special case for combined extensions.
407 # assert "file.txt".file_extension == "txt"
408 # assert "file.tar.gz".file_extension == "gz"
410 # For file without extension, `null` is returned.
411 # Hoever, for trailing dot, `""` is returned.
413 # assert "file".file_extension == null
414 # assert "file.".file_extension == ""
416 # The starting dot of hidden files is never considered.
418 # assert ".file.txt".file_extension == "txt"
419 # assert ".file".file_extension == null
420 fun file_extension
: nullable String
422 var last_slash
= chars
.last_index_of
('.')
423 if last_slash
> 0 then
424 return substring
( last_slash
+1, length
)
430 # returns files contained within the directory represented by self
431 fun files
: Set[ String ] is extern import HashSet[String], HashSet[String].add
, NativeString.to_s
, String.to_cstring
, HashSet[String].as(Set[String]) `{
435 dir_path = String_to_cstring( recv );
436 if ((dir = opendir(dir_path)) == NULL)
443 HashSet_of_String results;
447 results = new_HashSet_of_String();
449 while ( ( de = readdir( dir ) ) != NULL )
450 if ( strcmp( de->d_name, ".." ) != 0 &&
451 strcmp( de->d_name, "." ) != 0 )
453 file_name = NativeString_to_s( strdup( de->d_name ) );
454 HashSet_of_String_add( results, file_name );
458 return HashSet_of_String_as_Set_of_String( results );
463 redef class NativeString
464 private fun file_exists
: Bool is extern "string_NativeString_NativeString_file_exists_0"
465 private fun file_stat
: FileStat is extern "string_NativeString_NativeString_file_stat_0"
466 private fun file_lstat
: FileStat `{
467 struct stat* stat_element;
469 stat_element = malloc(sizeof(struct stat));
470 res = lstat(recv, stat_element);
471 if (res == -1) return NULL;
474 private fun file_mkdir
: Bool is extern "string_NativeString_NativeString_file_mkdir_0"
475 private fun file_delete
: Bool is extern "string_NativeString_NativeString_file_delete_0"
476 private fun file_chdir
is extern "string_NativeString_NativeString_file_chdir_0"
477 private fun file_realpath
: NativeString is extern "file_NativeString_realpath"
480 # This class is system dependent ... must reify the vfs
481 extern class FileStat `{ struct stat * `}
482 # Returns the permission bits of file
483 fun mode: Int is extern "file_FileStat_FileStat_mode_0"
484 # Returns the last access time
485 fun atime: Int is extern "file_FileStat_FileStat_atime_0"
486 # Returns the last status change time
487 fun ctime: Int is extern "file_FileStat_FileStat_ctime_0"
488 # Returns the last modification time
489 fun mtime: Int is extern "file_FileStat_FileStat_mtime_0"
491 fun size: Int is extern "file_FileStat_FileStat_size_0"
493 # Returns true if it is a regular file (not a device file, pipe, sockect, ...)
494 fun is_reg: Bool `{ return S_ISREG(recv->st_mode); `}
495 # Returns true if it is a directory
496 fun is_dir
: Bool `{ return S_ISDIR(recv->st_mode); `}
497 # Returns true if it is a character device
498 fun is_chr: Bool `{ return S_ISCHR(recv->st_mode); `}
499 # Returns true if it is a block device
500 fun is_blk
: Bool `{ return S_ISBLK(recv->st_mode); `}
501 # Returns true if the type is fifo
502 fun is_fifo: Bool `{ return S_ISFIFO(recv->st_mode); `}
503 # Returns true if the type is a link
504 fun is_lnk
: Bool `{ return S_ISLNK(recv->st_mode); `}
505 # Returns true if the type is a socket
506 fun is_sock: Bool `{ return S_ISSOCK(recv->st_mode); `}
509 # Instance of this class are standard FILE * pointers
510 private extern class NativeFile `{ FILE* `}
511 fun io_read(buf: NativeString, len: Int): Int is extern "file_NativeFile_NativeFile_io_read_2"
512 fun io_write(buf: NativeString, len: Int): Int is extern "file_NativeFile_NativeFile_io_write_2"
513 fun io_close: Int is extern "file_NativeFile_NativeFile_io_close_0"
514 fun file_stat: FileStat is extern "file_NativeFile_NativeFile_file_stat_0"
516 new io_open_read(path: NativeString) is extern "file_NativeFileCapable_NativeFileCapable_io_open_read_1"
517 new io_open_write(path: NativeString) is extern "file_NativeFileCapable_NativeFileCapable_io_open_write_1"
518 new native_stdin is extern "file_NativeFileCapable_NativeFileCapable_native_stdin_0"
519 new native_stdout is extern "file_NativeFileCapable_NativeFileCapable_native_stdout_0"
520 new native_stderr is extern "file_NativeFileCapable_NativeFileCapable_native_stderr_0"
524 fun stdin: Stdin do return once new Stdin
527 fun stdout: OFStream do return once new Stdout
529 # Standard output for error.
530 fun stderr: OFStream do return once new Stderr