The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

Name

SPVM::Sys - System Calls for File IO, User, Process, Signal, Socket

Description

SPVM::Sys is the Sys class in SPVM language. It provides system calls such as file IO, user manipulation, process, socket, time,

This class provides methods compatible with functions related to system calls provided by Perl.

This distribution contains many modules for system calls such as Sys::IO, Sys::Socket, Sys::Process. See "Modules".

Methods compatible with file IO, sockets, file paths, current directory, select, and poll are implemented as other modules such as IO::File, IO::Socket, Cwd. See "See Also".

Usage

  use Sys;
  
  Sys->mkdir("foo");
  
  Sys->rmdir("foo");
  
  my $path = Sys->env("PATH");
  
  my $process_id = Sys->getpid;

Class Methods

env

  static method env : string ($name : string);

Gets an environment variable. The same as getting of the Perl $ENV{$name}.

osname

  static method osname : string ()

Gets OS name. The same as Perl $^O.

Currently the following OS names are supported.

  • linux

  • darwin

  • MSWin32

  • freebsd

  • openbsd

  • solaris

A

  static method A : double ($file : string);

Script start time minus file access time, in days. The same as Perl -A.

C

  static method C : double ($file : string);

Script start time minus file inode change time, in days. The same as Perl -C.

M

  static method M : double ($file : string);

Script start time minus file modification time, in days. The same as Perl -M.

O

  static method O : int ($file : string);

File is owned by real uid. The same as Perl -O.

R

  static method R : int ($file : string);

File is readable by real uid/gid. The same as Perl -R.

S

  static method S : int ($file : string);

File is a socket. The same as Perl -S.

W

  static method W : int ($file : string);

File is writable by real uid/gid. The same as Perl -W.

X

  static method X : int ($file : string);

File is executable by real uid/gid. The same as Perl -X.

b

  static method b : int ($file : string);

File is a block special file. The same as Perl -b.

c

  static method c : int ($file : string);

File is a character special file. The same as Perl -c.

d

  static method d : int ($file : string);

File is a directory. The same as Perl -d.

e

  static method e : int ($file : string);

File exists. The same as Perl -e.

f

  static method f : int ($file : string);

File is a plain file. The same as Perl -f.

g

  static method g : int ($file : string);

File has setgid bit set. The same as Perl -g.

k

  static method k : int ($file : string);

File has sticky bit set. The same as Perl -k.

l

  static method l : int ($file : string);

File is a symbolic link (false if symlinks aren't supported by the file system). The same as Perl -l.

o

  static method o : int ($file : string);

File is owned by effective uid. The same as Perl -l.

p

  static method p : int ($file : string);

File is a named pipe (FIFO), or Filehandle is a pipe. The same as Perl -p.

r

  static method r : int ($file : string);

File is readable by effective uid/gid. The same as Perl -r.

s

  static method s : long ($file : string);

File has nonzero size (returns size in bytes). The same as Perl -s.

u

  static method u : int ($file : string);

File has setuid bit set. The same as Perl -u.

w

  static method w : int ($file : string);

File is writable by effective uid/gid. The same as Perl -u.

x

  static method x : int ($file : string);

File is executable by effective uid/gid. The same as Perl -x.

z

  static method z : int ($file : string);

File has zero size (is empty). The same as Perl -z.

time

  static method time : long ();

Returns the number of non-leap seconds since whatever time the system considers to be the epoch, suitable for feeding to gmtime and localtime. The same as the Perl time.

localtime

  static method localtime : Sys::Time::Tm ($time : long);

Converts a time as returned by the time function to a Sys::Time::Tm object with the time analyzed for the local time zone. The same as the Perl localtime.

gmtime

  static method gmtime : Sys::Time::Tm ($time : long);

Works just like localtime, but the returned values are localized for the standard Greenwich time zone. The same as the Perl gmtime.

process_id

  static method process_id : int ();

Gets the process number of the running this program. The same as the Perl $$.

stat

  static method stat : Sys::IO::Stat ($path : string);

Returns a Sys::IO::Stat object giving the status info for a file. The same as the Perl stat function.

chdir

  static method chdir : int ($path : string);

Changes the working directory to $path. The same as the Perl chdir function.

chmod

  static method chmod : int ($mode :int, $path : string);

Changes the permissions of a file. The same as the Perl chmod function.

mkdir

  static method mkdir : int ($path : string, $mode : int);

Creates the directory specified by $path and $mode. The same as the Perl mkdir function.

umask

  static method umask : int ($mode : int);

Sets the umask for the process to $mode and returns the previous value. The same as the Perl umask function.

rmdir

  static method rmdir : int ($path : string);

Deletes the directory specified by $path. The same as the Perl rmdir function.

  static method unlink : int ($pathname : string);

Deletes a file. The same as the Perl unlink function.

rename

  static method rename : int ($oldpath : string, $newpath : string);

Changes the name of a file. The same as the Perl rename function.

  static method readlink : int ($file : string);

Returns the value of a symbolic link. The same as the Perl readlink function.

  static method symlink : int ($oldpath : string, $newpath : string);

Creates a $newpath symbolically linked to the $oldpath. The same as the Perl symlink function.

sleep

  static method sleep : int ($seconds : int);

Causes the program to sleep for $seconds seconds. The same as the Perl sleep.

Modules

All modules included in this distribution. These classes have methods that directly correspond to Linux/Unix/Mac or Windows system call functions written in C. In addition, several helper methods are implemented.

Sys::Env

Sys::Env

Sys::IO

Sys::IO

Sys::IO::Constant

Sys::IO::Dirent

Sys::IO::DirStream

Sys::IO::FileStream

Sys::IO::Flock

Sys::IO::Stat

Sys::IO::Utimbuf

Sys::Ioctl

Sys::Ioctl

Sys::Ioctl::Constant

Sys::OS

Sys::OS

Sys::Poll

Sys::Poll

Sys::Poll::Constant

Sys::Poll::PollfdArray

Sys::Process

Sys::Process

Sys::Process::Constant

Sys::Select

Sys::Select

Sys::Select::Constant

Sys::Select::Fd_set

Sys::Signal

Sys::Signal

Sys::Signal::Constant

Sys::Signal::Handler

Sys::Signal::Handler::Default

Sys::Signal::Handler::Ignore

Sys::Signal::Handler::Monitor

Sys::Signal::Handler::Unknown

Sys::Socket

Sys::Socket

Sys::Socket::Addrinfo

Sys::Socket::AddrinfoLinkedList

Sys::Socket::Constant

Sys::Socket::Error

Sys::Socket::Error::InetInvalidNetworkAddress

Sys::Socket::In6_addr

Sys::Socket::In_addr

Sys::Socket::Ip_mreq

Sys::Socket::Ip_mreq_source

Sys::Socket::Ipv6_mreq

Sys::Socket::Sockaddr

Sys::Socket::Sockaddr::In

Sys::Socket::Sockaddr::In6

Sys::Socket::Sockaddr::Interface

Sys::Socket::Sockaddr::Storage

Sys::Socket::Sockaddr::Un

Sys::Time

Sys::Time

Sys::Time::Constant

Sys::Time::Itimerval

Sys::Time::Timespec

Sys::Time::Timeval

Sys::Time::Timezone

Sys::Time::Tms

Sys::Time::Tms

Sys::User

Sys::User

Sys::User::Group

Sys::User::Passwd

Sys::FileTest

Sys::FileTest (Deparecated)

See Also

IO::File

IO::Socket

IO::Select

IO::Poll

File::Spec

Cwd

Author

Yuki Kimoto(https://github.com/yuki-kimoto)

Contributors

Gabor Szabo(https://github.com/szabgab)

Repository

SPVM::Sys - Github

Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License