/usr/include/girara/utils.h is in libgirara-dev 0.2.8-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | /* See LICENSE file for license and copyright information */
#ifndef GIRARA_UTILS_H
#define GIRARA_UTILS_H
#include <stdio.h>
#include "types.h"
#include "macros.h"
#include "log.h"
/**
* Enum for directories specified in the XDG specification.
*/
typedef enum {
XDG_CONFIG, /**< XDG_CONFIG_HOME */
XDG_DATA, /**< XDG_DATA_HOME */
XDG_CONFIG_DIRS, /**< XDG_CONFIG_DIRS */
XDG_DATA_DIRS, /**< XDG_DATA_DIRS */
XDG_CACHE, /**< XDG_CACHE_HOME */
} girara_xdg_path_t;
/**
* Returns the home directory for the given user. $HOME is preferred over the
* value from g_get_home_dir.
*
* @param user a username or NULL to get home directory of the current user.
* @return a string containing the path to the user's home directory (needs to
* be freed with g_free) or NULL if the user doesn't exist.
*/
char* girara_get_home_directory(const char* user);
/**
* Returns a specific path specified in the XDG specification. ~ in paths will
* not be expanded.
* @param path which path to get
* @return a string containing the requested patch (needs to be freed with
* g_free) or NULL for invalid values.
*/
char* girara_get_xdg_path(girara_xdg_path_t path);
/**
* Opens a URI with xdg-open.
*
* @param uri the URI to be opened.
* @return true on success, false otherwise
*/
bool girara_xdg_open(const char* uri);
/**
* Splits paths separated by : (as in $PATH) into a list.
*
* @param patharray String like $PATH to split
* @return a list of paths and NULL on failure.
*/
girara_list_t* girara_split_path_array(const char* patharray);
/**
* Returns a "fixed" version of path. Which means, it will be an absolute path
* and fully expanded. ~ and ~user will be replaced by the current user's home
* directory (user's home directory respectively).
* @param path the path to "fix".
* @return the "fixed" path (needs to be freed with g_free).
*/
char* girara_fix_path(const char* path);
/**
* Open a file in a safe way
*
* @param path Path of the file
* @param mode Mode that the file should be opened
* @return NULL if an error occurred
*/
FILE* girara_file_open(const char* path, const char* mode);
/**
* Reads a line from the file. The returned string has to be released with
* g_free.
*
* @param file The file stream
* @return Read line or NULL if an error occurred
*/
char* girara_file_read_line(FILE* file);
/**
* Reads the whole content from a file. Returned string has to be freed.
*
* @param path Path to the file
* @return Read file or NULL if an error occurred
*/
char* girara_file_read(const char* path);
/**
* Reads the whole content from a file. Returned string has to be freed.
*
* @param file file to read
* @return Read file or NULL if an error occurred
*/
char* girara_file_read2(FILE* file);
/**
* Trims and cleans a line from multiple whitespaces
*
* @param line
*/
void girara_clean_line(char* line);
/**
* Changes the size of the memory block by wrapping a realloc function call
* In addition it frees the old memory block if realloc fails.
*
* @param ptr Memory space
* @param size Number of bytes
* @return Pointer to the allocated memory block or NULL
*/
void* girara_safe_realloc(void** ptr, size_t size) GIRARA_ALLOC_SIZE(2);
/**
* Escape \\, \\t, ", ' and spaces in strings.
* @param value The string to be escaped.
* @returns The escaped string. Needs to be freed with g_free.
*/
char* girara_escape_string(const char* value);
/**
* Replaces all occurrences of old in string with new and returns
* a new allocated string
*
* @param string The original string
* @param old String to replace
* @param new Replacement string
*
* @return new allocated string, needs to be freed with g_free
*/
char* girara_replace_substring(const char* string, const char* old, const char* new);
/**
* Execute command from argument list
*
* @param session The used girara session
* @param argument_list The argument list
* @return true if no error occurred
*/
bool girara_exec_with_argument_list(girara_session_t* session, girara_list_t* argument_list);
#endif
|