/usr/include/eina-1/eina/eina_xattr.h is in libeina-dev 1.8.6-2.5.
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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | /* EINA - EFL data type library
* Copyright (C) 2011 Cedric Bail
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library;
* if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EINA_XATTR_H_
#define EINA_XATTR_H_
#include "eina_types.h"
/**
* @addtogroup Eina_Tools_Group Tools
*
* @{
*/
/**
* @typedef Eina_Xattr_Flags
* define extended attribute creation
*
* @since 1.1
*/
typedef enum {
EINA_XATTR_INSERT, /**< This is the default behaviour, it will either create or replace the extended attribute */
EINA_XATTR_REPLACE, /**< This will only succeed if the extended attribute previously existed */
EINA_XATTR_CREATED /**< This will only succeed if the extended attribute wasn't previously set */
} Eina_Xattr_Flags;
typedef struct _Eina_Xattr Eina_Xattr;
struct _Eina_Xattr
{
const char *name; /**< The eXtended attribute name @since 1.2 */
const char *value; /**< The eXtended attribute value @since 1.2 */
size_t length; /**< The length of the eXtended attribute value @since 1.2 */
};
/**
* @brief Get an iterator that list all extended attribute of a file.
*
* @param file The filename to retrieve the extended attribute list from.
* @return an iterator.
*
* The iterator will not allocate any data during the iteration step, so you need to copy them yourself
* if you need.
*
* @since 1.1
*/
EAPI Eina_Iterator *eina_xattr_ls(const char *file) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
* @brief Get an iterator that list all extended attribute value related to a fd.
*
* @param file The filename to retrieve the extended attribute list from.
* @return an iterator.
*
* The iterator will not allocate any data during the iteration step, so you need to copy them yourself
* if you need. The iterator will provide an Eina_Xattr structure.
*
* @since 1.2
*/
EAPI Eina_Iterator *eina_xattr_value_ls(const char *file) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
* @brief Get an iterator that list all extended attribute related to a fd.
*
* @param fd The file descriptor to retrieve the extended attribute list from.
* @return an iterator.
*
* The iterator will not allocate any data during the iteration step, so you need to copy them yourself
* if you need.
*
* @since 1.2
*/
EAPI Eina_Iterator *eina_xattr_fd_ls(int fd) EINA_WARN_UNUSED_RESULT;
/**
* @brief Get an iterator that list all extended attribute value related to a fd.
*
* @param fd The file descriptor to retrieve the extended attribute list from.
* @return an iterator.
*
* The iterator will not allocate any data during the iteration step, so you need to copy them yourself
* if you need. The iterator will provide an Eina_Xattr structure.
*
* @since 1.2
*/
EAPI Eina_Iterator *eina_xattr_value_fd_ls(int fd) EINA_WARN_UNUSED_RESULT;
/**
* @brief Copy the extended attribute from one file to another.
* @param src source file to use as input.
* @param dst destination file to use as output.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
* @see eina_xattr_fd_copy()
* @since 1.8
*/
EAPI Eina_Bool eina_xattr_copy(const char *src, const char *dst) EINA_ARG_NONNULL(1, 2);
/**
* @brief Copy the extended attribute from one file descriptor to another.
* @param src source file descriptor to use as input.
* @param dst destination file descriptor to use as output.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
* @see eina_xattr_copy()
* @since 1.8
*/
EAPI Eina_Bool eina_xattr_fd_copy(int src, int dst);
/**
* @brief Retrieve an extended attribute from a file.
*
* @param file The file to retrieve the extended attribute from.
* @param attribute The extended attribute name to retrieve.
* @param size The size of the retrieved extended attribute.
* @return the allocated data that hold the extended attribute value.
*
* It will return @c NULL and *size will be @c 0 if it fails.
*
* @since 1.1
*/
EAPI void *eina_xattr_get(const char *file, const char *attribute, ssize_t *size) EINA_ARG_NONNULL(1, 2, 3) EINA_WARN_UNUSED_RESULT;
/**
* @brief Retrieve an extended attribute from a file descriptor.
*
* @param fd The file descriptor to retrieve the extended attribute from.
* @param attribute The extended attribute name to retrieve.
* @param size The size of the retrieved extended attribute.
* @return the allocated data that hold the extended attribute value.
*
* It will return @c NULL and *size will be @c 0 if it fails.
*
* @since 1.8
*/
EAPI void *eina_xattr_fd_get(int fd, const char *attribute, ssize_t *size) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT;
/**
* @brief Set an extended attribute on a file.
*
* @param file The file to set the extended attribute to.
* @param attribute The attribute to set.
* @param data The data to set.
* @param length The length of the data to set.
* @param flags Define the set policy.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.1
*/
EAPI Eina_Bool eina_xattr_set(const char *file, const char *attribute, const void *data, ssize_t length, Eina_Xattr_Flags flags) EINA_ARG_NONNULL(1, 2, 3);
/**
* @brief Set an extended attribute on a file descriptor.
*
* @param fd The file descriptor to set the extended attribute to.
* @param attribute The attribute to set.
* @param data The data to set.
* @param length The length of the data to set.
* @param flags Define the set policy.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.8
*/
EAPI Eina_Bool eina_xattr_fd_set(int fd, const char *attribute, const void *data, ssize_t length, Eina_Xattr_Flags flags) EINA_ARG_NONNULL(2, 3);
/**
* @brief Delete (remove) an extended attribute from a file.
*
* @param file The file to del the extended attribute from.
* @param attribute The attribute to del.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.8
*/
EAPI Eina_Bool eina_xattr_del(const char *file, const char *attribute) EINA_ARG_NONNULL(1, 2);
/**
* @brief Delete (remove) an extended attribute from a file descriptor.
*
* @param fd The file descriptor to del the extended attribute from.
* @param attribute The attribute to del.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.8
*/
EAPI Eina_Bool eina_xattr_fd_del(int fd, const char *attribute) EINA_ARG_NONNULL(2);
/**
* @brief Set a string as a extended attribute properties.
*
* @param file The file to set the string to.
* @param attribute The attribute to set.
* @param data The NULL-terminated string to set.
* @param flags Define the set policy.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*
* @since 1.1
*/
EAPI Eina_Bool eina_xattr_string_set(const char *file, const char *attribute, const char *data, Eina_Xattr_Flags flags);
/**
* @brief Get a string from an extended attribute properties.
*
* @param file The file to get the string from.
* @param attribute The attribute to get.
* @return A valid string on success, @c NULL otherwise.
*
* This call check that the string is properly NULL-terminated before returning it.
*
* @since 1.1
*/
EAPI char *eina_xattr_string_get(const char *file, const char *attribute);
/**
* @brief Set a double as a extended attribute properties.
*
* @param file The file to set the double to.
* @param attribute The attribute to set.
* @param value The NULL-terminated double to set.
* @param flags Define the set policy.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.1
*/
EAPI Eina_Bool eina_xattr_double_set(const char *file, const char *attribute, double value, Eina_Xattr_Flags flags);
/**
* @brief Get a double from an extended attribute properties.
*
* @param file The file to get the string from.
* @param attribute The attribute to get.
* @param value Where to put the extracted value
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This call check that the double is correctly set.
*
* @since 1.1
*/
EAPI Eina_Bool eina_xattr_double_get(const char *file, const char *attribute, double *value);
/**
* @brief Set an int as a extended attribute properties.
*
* @param file The file to set the int to.
* @param attribute The attribute to set.
* @param value The NULL-terminated int to set.
* @param flags Define the set policy.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.1
*/
EAPI Eina_Bool eina_xattr_int_set(const char *file, const char *attribute, int value, Eina_Xattr_Flags flags);
/**
* @brief Get a int from an extended attribute properties.
*
* @param file The file to get the string from.
* @param attribute The attribute to get.
* @param value Where to put the extracted value
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This call check that the int is correctly set.
*
* @since 1.1
*/
EAPI Eina_Bool eina_xattr_int_get(const char *file, const char *attribute, int *value);
/**
* @}
*/
#endif
|