util: Add simple function to convert dependencies into strings

[pakfire.git] / src / libpakfire / include / pakfire / util.h

/*#############################################################################
#                                                                             #
# Pakfire - The IPFire package management system                              #
# Copyright (C) 2013 Pakfire development team                                 #
#                                                                             #
# 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 PAKFIRE_UTIL_H
#define PAKFIRE_UTIL_H

#ifdef PAKFIRE_PRIVATE

#include <stdio.h>
#include <time.h>

#include <archive.h>


#include <pakfire/package.h>

const char* pakfire_dep2str(struct pakfire* pakfire, Id id);
Id pakfire_parse_dep(struct pakfire* pakfire, const char* s);
void pakfire_parse_deps(struct pakfire* pakfire, struct pakfire_package* pkg,
	void (*func)(struct pakfire_package* pkg, const char* dep), const char* deps);

#define pakfire_string_format(s, fmt, ...) snprintf(s, sizeof(s) - 1, fmt, __VA_ARGS__)
#define pakfire_string_set(s, value) pakfire_string_format(s, "%s", value)

int pakfire_string_startswith(const char* s, const char* prefix);
int pakfire_string_endswith(const char* s, const char* suffix);
int pakfire_string_matches(const char* s, const char* pattern);
char* pakfire_unquote_in_place(char* s);
int pakfire_string_partition(const char* s, const char* delim, char** s1, char** s2);
char* pakfire_string_replace(const char* s, const char* pattern, const char* repl);
char** pakfire_split_string(const char* s, char delim);
char* pakfire_string_join(char** list, const char* delim);

int pakfire_format_size(char* dst, size_t length, double value);
int pakfire_format_speed(char* dst, size_t length, double value);
char* pakfire_format_date(time_t t);

#define pakfire_strftime_now(dest, format) \
	__pakfire_strftime_now(dest, sizeof(dest) - 1, format)
int __pakfire_strftime_now(char* dest, size_t length, const char* format)
	__attribute__((format(strftime, 3, 0)));;

int pakfire_path_exists(const char* path);
time_t pakfire_path_age(const char* path);

char* pakfire_basename(const char* path);
char* pakfire_dirname(const char* path);

char* pakfire_remove_trailing_newline(char* str);

int pakfire_read_file_into_buffer(FILE* f, char** buffer, size_t* len);

#define pakfire_hexlify(digest) __pakfire_hexlify(digest, sizeof(digest))
char* __pakfire_hexlify(const unsigned char* digest, const size_t length);
#define pakfire_unhexlify(dst, src) __pakfire_unhexlify(dst, sizeof(dst), src)
int __pakfire_unhexlify(unsigned char* dst, const size_t l, const char* src);

#define pakfire_path_join(dest, first, second) \
	__pakfire_path_join(dest, sizeof(dest) - 1, first, second)

int __pakfire_path_join(char* dest, size_t length,
	const char* first, const char* second);
const char* pakfire_path_relpath(const char* root, const char* path);

int pakfire_mkparentdir(const char* path, mode_t mode);
int pakfire_mkdir(const char* path, mode_t mode);
FILE* pakfire_mktemp(char* path);
char* pakfire_mkdtemp(char* path);
int pakfire_rmtree(const char* path, int flags);

char* pakfire_generate_uuid();

int pakfire_tty_is_noninteractive(void);

// Digests

size_t pakfire_digest_length(enum pakfire_digests digest);

// Archive Stuff

int pakfire_archive_copy_data(struct archive* src, struct archive* dst,
	struct archive_entry* entry);
int pakfire_archive_copy_data_to_buffer(struct pakfire* pakfire, struct archive* a,
	struct archive_entry* entry, char** data, size_t* data_size);

// JSON Stuff

struct json_object* pakfire_json_parse_from_file(struct pakfire* pakfire, const char* path);

// Time Stuff

struct timespec timespec_add(const struct timespec* t1, const struct timespec* t2);

struct timespec timespec_from_ms(int milliseconds);

int timespec_lt(struct timespec* t1, struct timespec* t2);

// Resource Limits

#define PAKFIRE_RLIMIT_NOFILE_MAX (512 * 1024)

int pakfire_rlimit_set(struct pakfire* pakfire, int limit);
int pakfire_rlimit_reset_nofile(struct pakfire* pakfire);

#endif

#endif /* PAKFIRE_UTIL_H */