libaegis/os.h

Go to the documentation of this file.

//
//      aegis - project change supervisor
//      Copyright (C) 1991-1997, 1999, 2001-2008 Peter Miller
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; either version 3 of the License, or
//      (at your option) any later version.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program. If not, see
//      <http://www.gnu.org/licenses/>.
//

#ifndef OS_H
#define OS_H

#include <common/ac/time.h>

#include <common/main.h>
#include <common/nstring.h>

class string_list_ty; // forward
class nstring_list; // forward

#define OS_EXEC_FLAG_NO_INPUT 0
#define OS_EXEC_FLAG_INPUT 1
#define OS_EXEC_FLAG_ERROK 2
#define OS_EXEC_FLAG_SILENT 4

int os_exists(string_ty *path, bool eaccess_is_ok = false);

bool os_exists(const nstring &path, bool eaccess_is_ok = false);

void os_mkdir(string_ty *path, int mode);

void os_mkdir(const nstring &path, int mode);

void os_rmdir(string_ty *path);

void os_rmdir(const nstring &path);

void os_rmdir_errok(string_ty *path);

void os_rmdir_errok(const nstring &path);

void os_rmdir_bg(string_ty *path);

void os_rmdir_bg(const nstring &path);

void os_rmdir_tree(string_ty *path);

void os_rmdir_tree(const nstring &path);

void os_mkdir_between(string_ty *root, string_ty *rel, int mode);

void os_mkdir_between(const nstring &root, const nstring &rel, int mode);

void os_rename(string_ty *oldpath, string_ty *newpath);

void os_rename(const nstring &oldpath, const nstring &newpath);

void os_unlink(string_ty *path);

void os_unlink(const nstring &path);

void os_unlink_errok(string_ty *path);

void os_unlink_errok(const nstring &path);

string_ty *os_curdir(void);

string_ty *os_path_join(string_ty *lhs, string_ty *rhs);

nstring os_path_join(const nstring &lhs, const nstring &rhs);

nstring os_path_join(const nstring &lhs, const nstring &rhs);

string_ty *os_path_cat(string_ty *lhs, string_ty *rhs);

nstring os_path_cat(const nstring &lhs, const nstring &rhs);

nstring os_path_cat(const nstring &lhs, const nstring &rhs);

string_ty *os_path_rel2abs(string_ty *root, string_ty *path);

nstring os_path_rel2abs(const nstring &root, const nstring &path);

string_ty *os_pathname(string_ty *path, int resolve);

nstring os_pathname(const nstring &path, bool resolve);

string_ty *os_basename(string_ty *name, string_ty *ext = NULL);

nstring os_basename(const nstring &name, const nstring &ext = "");

string_ty *os_dirname(string_ty *path);

nstring os_dirname(const nstring &path);

string_ty *os_dirname_relative(string_ty *path);

nstring os_dirname_relative(const nstring &path);

string_ty *os_entryname(string_ty *path);

nstring os_entryname(const nstring &path);

string_ty *os_entryname_relative(string_ty *path);

nstring os_entryname_relative(const nstring &path);

string_ty *os_below_dir(string_ty *higher, string_ty *lower);

nstring os_below_dir(const nstring &upper, const nstring &lower);

void os_chdir(string_ty *path);

void os_chdir(const nstring &path);

void os_setuid(int id);

void os_setgid(int id);

void os_execute(string_ty *cmd, int flags, string_ty *dir);

void os_execute(const nstring &cmd, int flags, const nstring &dir);

int os_execute_retcode(string_ty *cmd, int flags, string_ty *dir);

int os_execute_retcode(const nstring &cmd, int flags, const nstring &dir);

string_ty *os_execute_slurp(string_ty *cmd, int flags, string_ty *dir);

void os_xargs(string_ty *the_command, struct string_list_ty *the_list,
    string_ty *dir);

void os_xargs(const nstring &the_command, const nstring_list &the_list,
    const nstring &dir);

long os_file_size(string_ty *);
void os_mtime_range(string_ty *, time_t *, time_t *);
time_t os_mtime_actual(string_ty *);
void os_mtime_set(string_ty *, time_t);
void os_mtime_set_errok(string_ty *, time_t);
void os_chown_check(string_ty *path, int mode, int uid, int gid);

void os_chmod(string_ty *path, int mode);

void os_chmod(const nstring &path, int mode);

void os_chmod_errok(string_ty *path, int mode);

void os_chmod_errok(const nstring &path, int mode);

int os_chmod_query(string_ty *);

void os_link(string_ty *from, string_ty *to);

void os_link(const nstring &from, const nstring &to);

int os_testing_mode(void);
void os_become_init(void);
void os_become_init_mortal(void);
void os_become_reinit_mortal(void);
void os_become(int uid, int gid, int umsk);

void os_become_undo(void);

void os_become_undo(int uid, int gid);

void os_become_undo_atexit(void);

void os_become_orig(void);
void os_become_query(int *uid, int *gid, int *umsk);
void os_become_orig_query(int *uid, int *gid, int *umsk);

int os_become_active(void);
#define os_become_must_be_active() \
        os_become_must_be_active_gizzards(__FILE__, __LINE__)
void os_become_must_be_active_gizzards(const char *, int);
#define os_become_must_not_be_active() \
        os_become_must_not_be_active_gizzards(__FILE__, __LINE__)
void os_become_must_not_be_active_gizzards(const char *, int);


int os_background(void);

int os_readable(string_ty *path);

int os_readable(const nstring &path);

bool os_executable(string_ty *);
int os_waitpid(int child, int *status);
int os_waitpid_status(int child, const char *cmd);

const char *os_shell(void);

enum edit_ty
{
        edit_not_set,
        edit_foreground,
        edit_background
};

void os_edit(string_ty *filename, edit_ty mode);

void os_edit(const nstring &filename, edit_ty mode);

string_ty *os_edit_string(string_ty *, edit_ty);
string_ty *os_edit_new(edit_ty);
string_ty *os_edit_filename(int);
string_ty *os_tmpdir(void);

int os_pathconf_name_max(const nstring &path);

int os_pathconf_name_max(string_ty *path);

int os_pathconf_path_max(const nstring &path);

int os_pathconf_path_max(string_ty *path);

void os_symlink(string_ty *src, string_ty *dst);

void os_symlink(const nstring &src, const nstring &dst);

void os_symlink_or_copy(string_ty *src, string_ty *dst);

string_ty *os_readlink(string_ty *);
int os_symlink_query(string_ty *);

void os_throttle(void);

bool os_unthrottle(void);

void os_owner_query(string_ty *, int *, int *);
string_ty *os_fingerprint(string_ty *);

void os_interrupt_register(void);
void os_interrupt_cope(void);
void os_interrupt_ignore(void);
int os_interrupt_has_occurred(void);

int os_isa_directory(string_ty *path);

bool os_isa_symlink(string_ty *path);

int os_isa_special_file(string_ty *path);

nstring os_magic_file(const nstring &filename);

nstring os_magic_file(string_ty *filename);

string_ty* os_canonify_dirname(string_ty *dirname);

nstring os_canonify_dirname(const nstring &dirname);

void os_check_path_traversable(string_ty *path);

#endif // OS_H

---