module_os.c

#include <assert.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <signal.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/types.h>
#ifndef _WIN32
#include <sys/utsname.h>
#include <sys/ioctl.h>
#include <termios.h>
#else
#include <windows.h>
#endif
 
#include <kuroko/vm.h>
#include <kuroko/value.h>
#include <kuroko/object.h>
#include <kuroko/util.h>
 
/* Did you know this is actually specified to not exist in a header? */
extern char ** environ;
 
static KrkClass * os_Environ;
static KrkClass * os_stat_result;
 
#define DO_KEY(key) krk_attachNamedObject(AS_DICT(result), #key, (KrkObj*)krk_copyString(buf. key, strlen(buf .key)))
#define S_KEY(key,val) krk_attachNamedObject(AS_DICT(result), #key, (KrkObj*)val);
 
#ifndef _WIN32
KRK_Function(uname) {
    struct utsname buf;
    if (uname(&buf) < 0) return NONE_VAL();
 
    KrkValue result = krk_dict_of(0, NULL, 0);
    krk_push(result);
 
    DO_KEY(sysname);
    DO_KEY(nodename);
    DO_KEY(release);
    DO_KEY(version);
    DO_KEY(machine);
 
    return krk_pop();;
}
#else
KRK_Function(uname) {
    KrkValue result = krk_dict_of(0, NULL, 0);
    krk_push(result);
 
    TCHAR buffer[256] = TEXT("");
    DWORD dwSize = sizeof(buffer);
    GetComputerName(buffer, &dwSize);
 
    OSVERSIONINFOA versionInfo = {0};
    versionInfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
    GetVersionExA(&versionInfo);
 
    if (versionInfo.dwMajorVersion == 10) {
        S_KEY(release,S("10"));
    } else if (versionInfo.dwMajorVersion == 6) {
        if (versionInfo.dwMinorVersion == 3) {
            S_KEY(release,S("8.1"));
        } else if (versionInfo.dwMinorVersion == 2) {
            S_KEY(release,S("8.0"));
        } else if (versionInfo.dwMinorVersion == 1) {
            S_KEY(release,S("7"));
        } else if (versionInfo.dwMinorVersion == 0) {
            S_KEY(release,S("Vista"));
        }
    } else {
        S_KEY(release,S("XP or earlier"));
    }
 
    char tmp[256];
    size_t len = snprintf(tmp, 256, "%ld", versionInfo.dwBuildNumber);
 
    S_KEY(version, krk_copyString(tmp,len));
    if (sizeof(void *) == 8) {
        S_KEY(machine,S("x64"));
    } else {
        S_KEY(machine,S("x86"));
    }
 
    S_KEY(sysname,S("Windows"));
    S_KEY(nodename,krk_copyString(buffer,dwSize));
 
    return krk_pop();
}
#endif
 
#define AS_Environ(o) (AS_INSTANCE(o))
#define IS_Environ(o) (krk_isInstanceOf(o,os_Environ))
#define CURRENT_CTYPE KrkInstance*
 
static int _setVar(KrkString * key, KrkString * val) {
#ifndef _WIN32
    return setenv(key->chars, val->chars, 1);
#else
    size_t len = key->length + val->length + 3;
    char * tmp = malloc(len);
    snprintf(tmp, len, "%s=%s", key->chars, val->chars);
    return putenv(tmp);
#endif
}
 
KRK_Method(Environ,__setitem__) {
    METHOD_TAKES_EXACTLY(2);
    CHECK_ARG(1,str,KrkString*,key);
    CHECK_ARG(2,str,KrkString*,val);
    int r = _setVar(key,val);
    if (r == 0) {
        krk_push(argv[0]);
        krk_push(argv[1]);
        krk_push(argv[2]);
        return krk_callDirect(vm.baseClasses->dictClass->_setter, 3);
    }
 
    return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
}
 
static void _unsetVar(KrkString * str) {
#ifndef _WIN32
    unsetenv(str->chars);
#else
    size_t len = str->length + 2;
    char * tmp = malloc(len);
    snprintf(tmp, len, "%s", str->chars);
    putenv(tmp);
    free(tmp);
#endif
}
 
KRK_Method(Environ,__delitem__) {
    METHOD_TAKES_EXACTLY(1);
    CHECK_ARG(1,str,KrkString*,key);
    _unsetVar(key);
    krk_push(argv[0]);
    krk_push(argv[1]);
    return krk_callDirect(vm.baseClasses->dictClass->_delitem, 2);
}
 
static void _loadEnviron(KrkInstance * module) {
    /* Create a new class to subclass `dict` */
    KrkClass * Environ = krk_makeClass(module, &os_Environ, "_Environ", vm.baseClasses->dictClass);
    krk_attachNamedObject(&module->fields, "_Environ", (KrkObj*)Environ);
 
    /* Add our set method that should also call dict's set method */
    BIND_METHOD(Environ,__setitem__);
    BIND_METHOD(Environ,__delitem__);
    krk_finalizeClass(Environ);
 
    /* Start with an empty dictionary */
    KrkInstance * environObj = AS_INSTANCE(krk_dict_of(0,NULL,0));
    krk_push(OBJECT_VAL(environObj));
 
    /* Transform it into an _Environ */
    environObj->_class = Environ;
 
    /* And attach it to the module */
    krk_attachNamedObject(&module->fields, "environ", (KrkObj*)environObj);
    krk_pop();
 
    /* Now load the environment into it */
    if (!environ) return; /* Empty environment */
 
    char ** env = environ;
    for (; *env; env++) {
        const char * equals = strchr(*env, '=');
        if (!equals) continue;
 
        size_t len = strlen(*env);
        size_t keyLen = equals - *env;
        size_t valLen = len - keyLen - 1;
 
        KrkValue key = OBJECT_VAL(krk_copyString(*env, keyLen));
        krk_push(key);
        KrkValue val = OBJECT_VAL(krk_copyString(equals+1, valLen));
        krk_push(val);
 
        krk_tableSet(AS_DICT(OBJECT_VAL(environObj)), key, val);
        krk_pop(); /* val */
        krk_pop(); /* key */
    }
 
}
 
KRK_Function(system) {
    const char * cmd;
    if (!krk_parseArgs("s",(const char*[]){"command"},&cmd)) return NONE_VAL();
    return INTEGER_VAL(system(cmd));
}
 
KRK_Function(getcwd) {
    FUNCTION_TAKES_NONE();
    char buf[4096]; /* TODO PATH_MAX? */
    if (!getcwd(buf, 4096)) return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    return OBJECT_VAL(krk_copyString(buf, strlen(buf)));
}
 
KRK_Function(chdir) {
    const char * path;
    if (!krk_parseArgs("s",(const char*[]){"path"}, &path)) return NONE_VAL();
    if (chdir(path)) return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    return NONE_VAL();
}
 
KRK_Function(getpid) {
    FUNCTION_TAKES_NONE();
    return INTEGER_VAL(getpid());
}
 
KRK_Function(strerror) {
    int errnum;
    if (!krk_parseArgs("i",(const char*[]){"errnum"},&errnum)) return NONE_VAL();
    char *s = strerror(errnum);
    if (!s) return NONE_VAL();
    return OBJECT_VAL(krk_copyString(s,strlen(s)));
}
 
KRK_Function(access) {
    const char * path;
    int mask;
    if (!krk_parseArgs("si",(const char*[]){"pathname","mode"},&path,&mask)) return NONE_VAL();
    if (access(path, mask) == 0) return BOOLEAN_VAL(1);
    return BOOLEAN_VAL(0);
}
 
KRK_Function(abort) {
    abort();
}
 
KRK_Function(exit) {
    int status;
    if (!krk_parseArgs("i",(const char*[]){"status"},&status)) return NONE_VAL();
    exit(status);
}
 
KRK_Function(remove) {
    const char * path;
    if (!krk_parseArgs("s",(const char*[]){"path"}, &path)) return NONE_VAL();
    if (remove(path) != 0) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return NONE_VAL();
}
 
KRK_Function(truncate) {
    const char * path;
    size_t length;
    if (!krk_parseArgs("sn",(const char*[]){"path","length"}, &path, &length)) return NONE_VAL();
    if (truncate(path, length) != 0) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return NONE_VAL();
}
 
KRK_Function(dup) {
    int fd;
    if (!krk_parseArgs("i",(const char*[]){"fd"}, &fd)) return NONE_VAL();
    int result = dup(fd);
    if (result < 0) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return INTEGER_VAL(result);
}
 
KRK_Function(dup2) {
    int fd, fd2;
    if (!krk_parseArgs("ii",(const char*[]){"fd","fd2"}, &fd, &fd2)) return NONE_VAL();
    int result = dup2(fd,fd2);
    if (result < 0) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return INTEGER_VAL(result);
}
 
KRK_Function(isatty) {
    int fd;
    if (!krk_parseArgs("i",(const char*[]){"fd"}, &fd)) return NONE_VAL();
    return BOOLEAN_VAL(isatty(fd));
}
 
KRK_Function(lseek) {
    int fd, how;
    ssize_t offset;
    if (!krk_parseArgs("ini",(const char*[]){"fd","offset","how"}, &fd, &offset, &how)) return NONE_VAL();
    off_t result = lseek(fd,offset,how);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return INTEGER_VAL(result);
}
 
KRK_Function(open) {
    const char * path;
    int flags;
    int mode = 0777;
    if (!krk_parseArgs("si|i",(const char*[]){"path","flags","mode"}, &path, &flags, &mode)) return NONE_VAL();
    int result = open(path, flags, mode);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return INTEGER_VAL(result);
}
 
KRK_Function(close) {
    int fd;
    if (!krk_parseArgs("i",(const char*[]){"fd"}, &fd)) return NONE_VAL();
    if (close(fd) == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return NONE_VAL();
}
 
#ifdef _WIN32
#define mkdir(p,m) mkdir(p); (void)m
#endif
KRK_Function(mkdir) {
    const char * path;
    int mode = 0777;
    if (!krk_parseArgs("s|i",(const char*[]){"path","mode"}, &path, &mode)) return NONE_VAL();
    int result = mkdir(path, mode);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return NONE_VAL();
}
 
KRK_Function(read) {
    int fd;
    ssize_t count;
    if (!krk_parseArgs("in",(const char*[]){"fd","count"}, &fd, &count)) return NONE_VAL();
 
    uint8_t * tmp = malloc(count);
    ssize_t result = read(fd,tmp,count);
    if (result == -1) {
        free(tmp);
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    } else {
        krk_push(OBJECT_VAL(krk_newBytes(result,tmp)));
        free(tmp);
        return krk_pop();
    }
}
 
#ifndef IS_bytes
#define IS_bytes(o) IS_BYTES(o)
#define AS_bytes(o) AS_BYTES(o)
#endif
 
KRK_Function(write) {
    int fd;
    KrkBytes * buf;
    if (!krk_parseArgs("iO!",(const char*[]){"fd","buf"}, &fd, KRK_BASE_CLASS(bytes), &buf)) return NONE_VAL();
 
    ssize_t result = write(fd,buf->bytes,buf->length);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return INTEGER_VAL(result);
}
 
#ifndef _WIN32
KRK_Function(pipe) {
    FUNCTION_TAKES_NONE();
    int fds[2];
    if (pipe(fds) == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    krk_push(OBJECT_VAL(krk_newTuple(2)));
    AS_TUPLE(krk_peek(0))->values.values[0] = INTEGER_VAL(fds[0]);
    AS_TUPLE(krk_peek(0))->values.values[1] = INTEGER_VAL(fds[1]);
    AS_TUPLE(krk_peek(0))->values.count = 2;
    return krk_pop();
}
 
KRK_Function(kill) {
    FUNCTION_TAKES_EXACTLY(2);
    ssize_t pid;
    int sig;
    if (!krk_parseArgs("ni",(const char*[]){"pid","sig"}, &pid, &sig)) return NONE_VAL();
 
    int result = kill(pid, sig);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return INTEGER_VAL(result);
}
 
KRK_Function(fork) {
    FUNCTION_TAKES_NONE();
    return INTEGER_VAL(fork());
}
 
KRK_Function(symlink) {
    const char * src;
    const char * dst;
    if (!krk_parseArgs("ss",(const char*[]){"target","linkpath"}, &src, &dst)) return NONE_VAL();
 
    if (symlink(src, dst) != 0) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return NONE_VAL();
}
 
KRK_Function(tcgetpgrp) {
    int fd;
    if (!krk_parseArgs("i",(const char*[]){"fd"}, &fd)) return NONE_VAL();
    int result = tcgetpgrp(fd);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return INTEGER_VAL(result);
}
 
KRK_Function(tcsetpgrp) {
    int fd;
    ssize_t pgrp;
    if (!krk_parseArgs("in",(const char*[]){"fd","pgrp"}, &fd, &pgrp)) return NONE_VAL();
    int result = tcsetpgrp(fd,pgrp);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return NONE_VAL();
}
 
KRK_Function(ttyname) {
    int fd;
    if (!krk_parseArgs("i",(const char*[]){"fd"}, &fd)) return NONE_VAL();
    char * result = ttyname(fd);
    if (!result) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return OBJECT_VAL(krk_copyString(result,strlen(result)));
}
 
KRK_Function(get_terminal_size) {
    int fd = 1;
    if (!krk_parseArgs("|i",(const char*[]){"fd"}, &fd)) return NONE_VAL();
 
    struct winsize wsz;
    int res = ioctl(fd, TIOCGWINSZ, &wsz);
 
    if (res < 0) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
 
    krk_push(OBJECT_VAL(krk_newTuple(2)));
    AS_TUPLE(krk_peek(0))->values.values[0] = INTEGER_VAL(wsz.ws_col);
    AS_TUPLE(krk_peek(0))->values.values[1] = INTEGER_VAL(wsz.ws_row);
    AS_TUPLE(krk_peek(0))->values.count = 2;
    return krk_pop();
}
#endif
 
static int makeArgs(int count, const KrkValue * values, char *** argsOut, const char * _method_name) {
    char ** out = malloc(sizeof(char*)*(count+1));
    for (int i = 0; i < count; ++i) {
        if (!IS_STRING(values[i])) {
            free(out);
            TYPE_ERROR(str,values[i]);
            return 1;
        }
        out[i] = AS_CSTRING(values[i]);
    }
    out[count] = NULL;
    *argsOut = out;
    return 0;
}
 
KRK_Function(execl) {
    FUNCTION_TAKES_AT_LEAST(1);
    CHECK_ARG(0,str,KrkString*,path);
    char ** args;
    if (makeArgs(argc-1,&argv[1],&args,_method_name)) return NONE_VAL();
    if (execv(path->chars, args) == -1) {
        free(args);
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return krk_runtimeError(KRK_EXC(OSError), "Expected to not return from exec, but did.");
}
 
KRK_Function(execlp) {
    FUNCTION_TAKES_AT_LEAST(1);
    CHECK_ARG(0,str,KrkString*,filename);
    char ** args;
    if (makeArgs(argc-1,&argv[1],&args,_method_name)) return NONE_VAL();
    if (execvp(filename->chars, args) == -1) {
        free(args);
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return krk_runtimeError(KRK_EXC(OSError), "Expected to not return from exec, but did.");
}
 
KRK_Function(execle) {
    FUNCTION_TAKES_AT_LEAST(1);
    CHECK_ARG(0,str,KrkString*,path);
    CHECK_ARG((argc-1),list,KrkList*,envp);
    char ** args;
    char ** env;
    if (makeArgs(argc-2,&argv[1],&args,_method_name)) return NONE_VAL();
    if (makeArgs(envp->values.count, envp->values.values,&env,_method_name)) {
        free(args);
        return NONE_VAL();
    }
    if (execve(path->chars, args, env) == -1) {
        free(args);
        free(env);
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return krk_runtimeError(KRK_EXC(OSError), "Expected to not return from exec, but did.");
}
 
KRK_Function(execv) {
    FUNCTION_TAKES_EXACTLY(2);
    CHECK_ARG(0,str,KrkString*,filename);
    CHECK_ARG(1,list,KrkList*,args);
    char ** argp;
    if (makeArgs(args->values.count, args->values.values, &argp,_method_name)) return NONE_VAL();
    if (execv(filename->chars, argp) == -1) {
        free(argp);
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return krk_runtimeError(KRK_EXC(OSError), "Expected to not return from exec, but did.");
}
 
KRK_Function(execvp) {
    FUNCTION_TAKES_EXACTLY(2);
    CHECK_ARG(0,str,KrkString*,path);
    CHECK_ARG(1,list,KrkList*,args);
    char ** argp;
    if (makeArgs(args->values.count, args->values.values, &argp,_method_name)) return NONE_VAL();
    if (execvp(path->chars, argp) == -1) {
        free(argp);
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    return krk_runtimeError(KRK_EXC(OSError), "Expected to not return from exec, but did.");
}
 
#define SET(thing) krk_attachNamedValue(&out->fields, #thing, INTEGER_VAL(buf. thing))
#ifdef _WIN32
#define STAT_STRUCT struct __stat64
#define stat _stat64
#else
#define STAT_STRUCT struct stat
#endif
KRK_Function(stat) {
    const char * path;
    if (!krk_parseArgs("s",(const char*[]){"path"}, &path)) return NONE_VAL();
 
    STAT_STRUCT buf;
    int result = stat(path, &buf);
    if (result == -1) {
        return krk_runtimeError(KRK_EXC(OSError), "%s", strerror(errno));
    }
    KrkInstance * out = krk_newInstance(os_stat_result);
    krk_push(OBJECT_VAL(out));
 
    SET(st_dev);
    SET(st_ino);
    SET(st_mode);
    SET(st_nlink);
    SET(st_uid);
    SET(st_gid);
    SET(st_size);
 
    /* TODO times */
    /* TODO block sizes */
 
    return krk_pop();
}
#undef SET
 
#define IS_stat_result(o) (krk_isInstanceOf(o,os_stat_result))
#define AS_stat_result(o) AS_INSTANCE(o)
#define CURRENT_NAME  self
 
#define getProp(name) \
    KrkValue name = NONE_VAL(); \
    krk_tableGet(&self->fields, OBJECT_VAL(S(#name)), &name); \
    if (!IS_INTEGER(name)) return krk_runtimeError(vm.exceptions->valueError, "stat_result is invalid")
 
KRK_Method(stat_result,__repr__) {
    METHOD_TAKES_NONE();
    getProp(st_dev);
    getProp(st_ino);
    getProp(st_mode);
    getProp(st_nlink);
    getProp(st_uid);
    getProp(st_gid);
    getProp(st_size);
 
    char * buf = malloc(1024);
    size_t len = snprintf(buf,1024,
        "os.stat_result("
            "st_dev=%d,"
            "st_ino=%d,"
            "st_mode=%d,"
            "st_nlink=%d,"
            "st_uid=%d,"
            "st_gid=%d,"
            "st_size=%d)",
        (int)AS_INTEGER(st_dev),
        (int)AS_INTEGER(st_ino),
        (int)AS_INTEGER(st_mode),
        (int)AS_INTEGER(st_nlink),
        (int)AS_INTEGER(st_uid),
        (int)AS_INTEGER(st_gid),
        (int)AS_INTEGER(st_size));
 
    if (len > 1023) len = 1023;
    krk_push(OBJECT_VAL(krk_copyString(buf,len)));
    free(buf);
    return krk_pop();
}
 
KRK_Module(os) {
    KRK_DOC(module, "@brief Provides access to low-level system operations.");
 
#ifdef _WIN32
    krk_attachNamedObject(&module->fields, "name", (KrkObj*)S("nt"));
    krk_attachNamedObject(&module->fields, "sep", (KrkObj*)S("\\"));
    krk_attachNamedObject(&module->fields, "altsep", (KrkObj*)S("/"));
    krk_attachNamedObject(&module->fields, "pathsep", (KrkObj*)S(";"));
    krk_attachNamedObject(&module->fields, "linesep", (KrkObj*)S("\r\n"));
    krk_attachNamedObject(&module->fields, "devnull", (KrkObj*)S("nul"));
#else
    krk_attachNamedObject(&module->fields, "name", (KrkObj*)S("posix"));
    krk_attachNamedObject(&module->fields, "sep", (KrkObj*)S("/"));
    krk_attachNamedValue(&module->fields, "altsep", NONE_VAL());
    krk_attachNamedObject(&module->fields, "pathsep", (KrkObj*)S(":"));
    krk_attachNamedObject(&module->fields, "linesep", (KrkObj*)S("\n"));
    krk_attachNamedObject(&module->fields, "devnull", (KrkObj*)S("/dev/null"));
#endif
 
    krk_attachNamedObject(&module->fields, "curdir", (KrkObj*)S("."));
    krk_attachNamedObject(&module->fields, "pardir", (KrkObj*)S(".."));
    krk_attachNamedObject(&module->fields, "extsep", (KrkObj*)S("."));
 
#define DO_INT(name) krk_attachNamedValue(&module->fields, #name, INTEGER_VAL(name))
 
    DO_INT(O_RDONLY);
    DO_INT(O_WRONLY);
    DO_INT(O_RDWR);
    DO_INT(O_APPEND);
    DO_INT(O_CREAT);
    DO_INT(O_EXCL);
    DO_INT(O_TRUNC);
 
#ifdef O_CLOEXEC
    DO_INT(O_CLOEXEC);
#endif
#ifdef O_DIRECTORY
    DO_INT(O_DIRECTORY);
#endif
#ifdef O_PATH
    DO_INT(O_PATH);
#endif
#ifdef O_NOFOLLOW
    DO_INT(O_NOFOLLOW);
#endif
#ifdef O_NONBLOCK
    DO_INT(O_NONBLOCK);
#endif
 
    DO_INT(SEEK_SET);
    DO_INT(SEEK_CUR);
    DO_INT(SEEK_END);
 
#ifdef SEEK_HOLE
    DO_INT(SEEK_HOLE);
#endif
#ifdef SEEK_DATA
    DO_INT(SEEK_DATA);
#endif
 
    KRK_DOC(BIND_FUNC(module,uname),
        "@brief Returns a @ref dict of attributes describing the current platform.\n\n"
        "On POSIX platforms, the result should match the contents and layout of a standard @c uname() call. "
        "On Windows, values are synthesized from available information.");
    KRK_DOC(BIND_FUNC(module,system),
        "@brief Call the system shell.\n"
        "@arguments cmd\n\n"
        "Runs @p cmd using the system shell and returns the platform-dependent return value.");
    KRK_DOC(BIND_FUNC(module,getcwd),
        "@brief Get the name of the current working directory.");
    KRK_DOC(BIND_FUNC(module,chdir),
        "@brief Change the current working directory.\n"
        "@arguments newcwd\n\n"
        "Attempts to change the working directory to @p newcwd. Raises @ref OSError on failure.");
    KRK_DOC(BIND_FUNC(module,getpid),
        "@brief Obtain the system process identifier.");
    KRK_DOC(BIND_FUNC(module,strerror),
        "@brief Convert an integer error code to a string.\n"
        "@arguments errorno\n\n"
        "Provides the string description for the error code specified by @p errorno.");
    KRK_DOC(BIND_FUNC(module,abort),
        "@brief Abort the current process.\n\n"
        "@bsnote{This will exit the interpreter without calling cleanup routines.}");
    KRK_DOC(BIND_FUNC(module,exit),
        "@brief Exit the current process.\n\n"
        "@bsnote{This will exit the interpreter without calling cleanup routines.}");
    KRK_DOC(BIND_FUNC(module,remove),
        "@brief Delete a file.\n"
        "@arguments path\n\n"
        "Attempts to delete the file at @p path.");
    KRK_DOC(BIND_FUNC(module,truncate),
        "@brief Resize a file.\n"
        "@arguments path,length\n\n"
        "Attempts to resize the file at @p path to @p length bytes.");
    KRK_DOC(BIND_FUNC(module,dup),
        "@brief Duplicate a file descriptor.\n"
        "@arguments fd\n\n"
        "Returns a new file descriptor pointing to the same file as @p fd.");
    KRK_DOC(BIND_FUNC(module,dup2),
        "@brief Duplicate a file descriptor.\n"
        "@arguments oldfd,newfd\n\n"
        "Like @ref dup but the new file descriptor is placed at @p newfd.\n");
    KRK_DOC(BIND_FUNC(module,isatty),
        "@brief Determine if a file descriptor is a terminal.\n"
        "@arguments fd\n\n"
        "Returns a @ref bool indicating whether the open file descriptor @p fd refers to a terminal.");
    KRK_DOC(BIND_FUNC(module,lseek),
        "@brief Seek an open file descriptor.\n"
        "@arguments fd,pos,how\n\n"
        "Seeks the open file descriptor @p fd by @p pos bytes as specified in @p how. "
        "Use the values @c SEEK_SET, @c SEEK_CUR, and @c SEEK_END for @p how.");
    KRK_DOC(BIND_FUNC(module,open),
        "@brief Open a file.\n"
        "@arguments path,flags,mode=0o777\n\n"
        "Opens the file at @p path with the specified @p flags and @p mode. Returns a file descriptor.\n\n"
        "@bsnote{Not to be confused with <a class=\"el\" href=\"mod_fileio.html#open\">fileio.open</a>}");
    KRK_DOC(BIND_FUNC(module,close),
        "@brief Close an open file descriptor.\n"
        "@arguments fd");
    KRK_DOC(BIND_FUNC(module,read),
        "@brief Read from an open file descriptor.\n"
        "@arguments fd,n\n\n"
        "Reads at most @p n bytes from the open file descriptor @p fd.");
    KRK_DOC(BIND_FUNC(module,write),
        "@brief Write to an open file descriptor.\n"
        "@arguments fd,data\n\n"
        "Writes the @ref bytes object @p data to the open file descriptor @p fd.");
    KRK_DOC(BIND_FUNC(module,mkdir),
        "@brief Create a directory.\n"
        "@arguments path,mode=0o777\n\n"
        "Creates a directory at @p path.");
 
    KRK_DOC(BIND_FUNC(module,execl),
        "@brief Replace the current process.\n"
        "@arguments path,[args...]\n\n"
        "The @c exec* family of functions replaces the calling process's image with a new one. "
        "@c execl takes a @p path to a binary and an arbitrary number of @ref str arguments to "
        "pass to the new executable.");
    KRK_DOC(BIND_FUNC(module,execle),
        "@brief Replace the current process.\n"
        "@arguments path,[args...],env\n\n"
        "The @c exec* family of functions replaces the calling process's image with a new one. "
        "@c execle takes a @p path to a binary, an arbitrary number of @ref str arguments to "
        "pass to the new executable, and @ref list of @c 'KEY=VALUE' pairs to set as the new "
        "environment.");
    KRK_DOC(BIND_FUNC(module,execlp),
        "@brief Replace the current process.\n"
        "@arguments filename,[args...]\n\n"
        "The @c exec* family of functions replaces the calling process's image with a new one. "
        "@c execlp takes a @p filename of a binary and an arbitrary number of @ref str arguments to "
        "pass to the new executable. @p filename will be searched for in @c $PATH.");
    KRK_DOC(BIND_FUNC(module,execv),
        "@brief Replace the current process.\n"
        "@arguments path,args\n\n"
        "The @c exec* family of functions replaces the calling process's image with a new one. "
        "@c execv takes a @p path to a binary and a @ref list @p args of @ref str arguments to "
        "pass to the new executable.");
    KRK_DOC(BIND_FUNC(module,execvp),
        "@brief Replace the current process.\n"
        "@arguments filename,args\n\n"
        "The @c exec* family of functions replaces the calling process's image with a new one. "
        "@c execvp takes a @p filename of a binary and a @ref list @p args of @ref str arguments to "
        "pass to the new executable. @p filename will be searched for in @c $PATH.");
 
    DO_INT(F_OK);
    DO_INT(R_OK);
    DO_INT(W_OK);
    DO_INT(X_OK);
    KRK_DOC(BIND_FUNC(module,access),
        "@brief Determine if a file can be accessed.\n"
        "@arguments path,mask\n\n"
        "Use the values @c F_OK, @c R_OK, @c W_OK, and @c X_OK to construct @p mask and check if the current "
        "process has sufficient access rights to perform the requested operations on the file "
        "at @p path.");
 
#ifndef _WIN32
    KRK_DOC(BIND_FUNC(module,pipe),
        "@brief Create a pipe.\n\n"
        "Creates a _pipe_, returning a two-tuple of file descriptors for the read and write ends respectively.");
    KRK_DOC(BIND_FUNC(module,kill),
        "@brief Send a signal to a process.\n"
        "@arguments pid,signum\n\n"
        "Send the signal @p signum to the process at @p pid.\n");
    KRK_DOC(BIND_FUNC(module,fork),
        "@brief Fork the current process.\n\n"
        "Returns the PID of the new child process in the original process and @c 0 in the child.");
    KRK_DOC(BIND_FUNC(module,symlink),
        "@brief Create a symbolic link.\n"
        "@arguments src,dst\n\n"
        "Creates a symbolic link at @p src pointing to @p dst.");
 
    KRK_DOC(BIND_FUNC(module,tcgetpgrp),
        "@brief Get the terminal foreground process group.\n"
        "@arguments fd\n\n"
        "Return the PID representing the foreground process group of the terminal specified by the file descriptor @p fd.");
    KRK_DOC(BIND_FUNC(module,tcsetpgrp),
        "@brief %Set the terminal foreground process group.\n"
        "@arguments fd,pgrp\n\n"
        "%Set the PID representing the foreground process group of the terminal specified by the file descriptor @p fd to @p pgrp.");
    KRK_DOC(BIND_FUNC(module,ttyname),
        "@brief Get the path to a terminal device.\n"
        "@arguments fd\n\n"
        "Returns a @ref str representing the path to the terminal device provided by the file descriptor @p fd.");
 
    KRK_DOC(BIND_FUNC(module,get_terminal_size),
        "@brief Obtain the size of the terminal window.\n"
        "@arguments fd=1\n"
        "Obtain the size of the host terminal as a tuple of columns and lines.");
#endif
 
    _loadEnviron(module);
 
    /* Nothing special */
    KrkClass * stat_result = krk_makeClass(module, &os_stat_result, "stat_result", vm.baseClasses->objectClass);
    BIND_METHOD(stat_result,__repr__);
    krk_finalizeClass(stat_result);
 
    KRK_DOC(BIND_FUNC(module,stat),
        "@brief Get the status of a file\n"
        "@arguments path\n\n"
        "Runs the @c stat system call on @p path. Returns a @ref stat_result.\n");
}