NAME

src/pmc/os.pmc - Files and Directories PMC

DESCRIPTION

OS is a PMC type which provides access to the filesystem files and directories.

Usage

From PIR code:

    loadlib "os"
    $P0 = new 'OS'

From NQP:

    pir::loadlib__s("os");
    my $os := pir::new__ps("OS");

From Winxed:

    loadlib("os");
    var os = new 'OS';

Methods

static PMC * stat_buf_to_array(PARROT_INTERP, const Parrot_Stat_Buf *buf)

Converts a stat buffer to a Perl-like array.

STRING *cwd()

Returns the current working directory.

void chdir(STRING *path)

Changes the current working directory to the one specified by path.

void unlink(STRING *file)

Removes file file from the file system.

void rmdir(STRING *path)

Removes directory path from the file system, if it is empty.

void rm(STRING *path)

Calls remove to remove the file or empty directory specified by path.

void mkdir(STRING *path, STRING *mode)

Creates a directory specified by path with mode mode.

fixedpmcarray *stat(STRING *path)

Stats a file, and returns a 13 position array as in Perl:

     0 dev      device number of filesystem
     1 ino      inode number
     2 mode     file mode  (type and permissions)
     3 nlink    number of (hard) links to the file
     4 uid      numeric user ID of file's owner
     5 gid      numeric group ID of file's owner
     6 rdev     the device identifier (special files only)
     7 size     total size of file, in bytes
     8 atime    last access time in seconds since the epoch
     9 mtime    last modify time in seconds since the epoch
    10 ctime    inode change time in seconds since the epoch (*)
    11 blksize  preferred block size for file system I/O
    12 blocks   actual number of blocks allocated

11 and 12 are not available under Windows.

fixedpmcarray *lstat(STRING *path)

Lstats a file, and returns a 13 position array as in Perl. See stat.

void symlink(STRING *from, STRING *to)

Creates a symlink

void link(STRING *from, STRING *to)

Creates a hard link

INTVAL umask(INTVAL mask)

umask sets the process's file mode creation mask (and returns the previous one).

INTVAL chroot(STRING *path)

it makes the named directory the new root directory for all further pathnames that begin with a "/" by your process and all its children.NOTE: perl restricts this operation to superusers. It might be a good idea to do the same with parrot.

PMC *readdir(STRING *path)

Reads entries from a directory.

rename(STRING *oldpath, STRING *newpath)

This method is a wrapper for rename(2). On error a SystemError exception is thrown.

chmod(STRING *path, INTVAL mode)

get_user_id()

Returns the ID number of the current user. This is platform-dependent.

can_execute(STRING *filename)

can_read(STRING *filename)

can_write(STRING *filename)

exists(STRING *filename)

Determine if the file exists. Return 1 if it exists. Return 0 otherwise.

SEE ALSO

   chdir(2), getcwd(3), unlink(2), mkdir(2), stat(2), lstat(2),
   symlink(2), link(2), umask(2), chroot(2)