utils.h

Go to the documentation of this file.

#ifndef STASIS_UTILS_H
#define STASIS_UTILS_H
#include <stdio.h>
#include <stdlib.h>
#include <dirent.h>
#include <string.h>
#include <unistd.h>
#include <limits.h>
#include <errno.h>
#include "core.h"
#include "log.h"
#include "copy.h"
#include "system.h"
#include "strlist.h"
#include "utils.h"
#include "ini.h"
 
#if defined(STASIS_OS_WINDOWS)
#define PATH_ENV_VAR "path"
#define DIR_SEP "\\"
#define PATH_SEP ";"
#define LINE_SEP "\r\n"
#else
#define PATH_ENV_VAR "PATH"
#define DIR_SEP "/"
#define PATH_SEP ":"
#define LINE_SEP "\n"
#endif
 
#if defined(STASIS_OS_LINUX)
#define STASIS_RANDOM_GENERATOR_FILE "/dev/urandom"
#elif defined(STASIS_OS_DARWIN)
#define STASIS_RANDOM_GENERATOR_FILE "/dev/random"
#else
#define STASIS_RANDOM_GENERATOR_FILE NULL
#define NEED_SRAND 1
#endif
 
#define STASIS_XML_PRETTY_PRINT_PROG "xmllint"
#define STASIS_XML_PRETTY_PRINT_ARGS "--format"

int pushd(const char *path);

int popd(void);

char *expandpath(const char *_path);

int rmtree(char *_path);
 
 
char **file_readlines(const char *filename, size_t start, size_t limit, ReaderFn *readerFn);

char *path_basename(char *path);

char *path_dirname(char *path);

char *find_program(const char *name);

int touch(const char *filename);

int git_clone(struct Process *proc, char *url, char *destdir, char *gitref);

char *git_describe(const char *path);

char *git_rev_parse(const char *path, char *args);

int path_store(char **destptr, size_t maxlen, const char *base, const char *path);
 
#if defined(STASIS_DUMB_TERMINAL)
#define STASIS_COLOR_RED ""
#define STASIS_COLOR_GREEN ""
#define STASIS_COLOR_YELLOW ""
#define STASIS_COLOR_BLUE ""
#define STASIS_COLOR_WHITE ""
#define STASIS_COLOR_RESET ""
#else
#define STASIS_COLOR_RED "\x1b[1;91m"
#define STASIS_COLOR_GREEN "\x1b[1;92m"
#define STASIS_COLOR_YELLOW "\x1b[1;93m"
#define STASIS_COLOR_BLUE "\x1b[1;94m"
#define STASIS_COLOR_WHITE "\x1b[1;97m"
#define STASIS_COLOR_RESET "\x1b[0;37m\x1b[0m"
#endif
 
#define STASIS_MSG_SUCCESS 0
#define STASIS_MSG_NOP 1 << 0
#define STASIS_MSG_ERROR 1 << 1
#define STASIS_MSG_WARN 1 << 2
#define STASIS_MSG_L1 1 << 3
#define STASIS_MSG_L2 1 << 4
#define STASIS_MSG_L3 1 << 5
#define STASIS_MSG_RESTRICT 1 << 6
 
void msg(unsigned type, char *fmt, ...);
 
// Enter an interactive shell that ends the program on-exit
void debug_shell();

char *xmkstemp(FILE **fp, const char *mode);

int isempty_dir(const char *path);

int xml_pretty_print_in_place(const char *filename, const char *pretty_print_prog, const char *pretty_print_args);

int fix_tox_conf(const char *filename, char **result, size_t maxlen);
 
char *collapse_whitespace(char **s);

int redact_sensitive(const char **to_redact, size_t to_redact_size, char *src, char *dest, size_t maxlen);

struct StrList *listdir(const char *path);

long get_cpu_count();

int mkdirs(const char *_path, mode_t mode);

char *find_version_spec(char *package_name);
 
// mode flags for env_manipulate_pathstr
#define PM_APPEND 1 << 0
#define PM_PREPEND 1 << 1
#define PM_ONCE  1 << 2

int env_manipulate_pathstr(const char *key, char *path, int mode);

int gen_file_extension_str(char *filename, size_t maxlen, const char *extension);

char *remove_extras(char *s);
 
void debug_hexdump(char *data, int len);

int grow(size_t size_new, size_t *size_orig, char **data);
 
int in_ascii_range(char c, char lower, char upper);
 
#define GIT_HASH_LEN 40
int is_git_sha(char const *hash);
 
int check_python_package_dependencies(const char *srcdir);
 
void seconds_to_human_readable(int v, char *result, size_t maxlen);
 
#define STR_TO_TIMEOUT_NEGATIVE (-1)
#define STR_TO_TIMEOUT_INVALID_TIME_SCALE (-2)
int str_to_timeout(char *s);
 
const char *get_random_generator_file();
int get_random_bytes(char *result, size_t maxlen);

int non_format_len(const char *s);
 
char *center_text(const char *s, size_t maxwidth);
#endif //STASIS_UTILS_H