/usr/include/rpm/rpmfi.h is in librpm-dev 4.14.1+dfsg1-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 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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 | #ifndef H_RPMFI
#define H_RPMFI
/** \ingroup rpmfi
* \file lib/rpmfi.h
* File info set iterator API.
*/
#include <rpm/rpmtypes.h>
#include <rpm/rpmfiles.h>
#include <rpm/rpmarchive.h>
#ifdef __cplusplus
extern "C" {
#endif
/** \ingroup rpmfi
* Reference a file info set iterator instance.
* @param fi file info set iterator
* @return new file info set iterator reference
*/
rpmfi rpmfiLink (rpmfi fi);
/** \ingroup rpmfi
* Return file count from file info set iterator.
* @param fi file info set iterator
* @return current file count
*/
rpm_count_t rpmfiFC(rpmfi fi);
/** \ingroup rpmfi
* Return current file index from file info set iterator.
* @param fi file info set iterator
* @return current file index
*/
int rpmfiFX(rpmfi fi);
/** \ingroup rpmfi
* Set current file index in file info set iterator.
* @param fi file info set iterator
* @param fx new file index
* @return current file index
*/
int rpmfiSetFX(rpmfi fi, int fx);
/** \ingroup rpmfi
* Return directory count from file info set iterator.
* @param fi file info set iterator
* @return current directory count
*/
rpm_count_t rpmfiDC(rpmfi fi);
/** \ingroup rpmfi
* Return current directory index from file info set iterator.
* @param fi file info set iterator
* @return current directory index
*/
int rpmfiDX(rpmfi fi);
/** \ingroup rpmfi
* Set current directory index in file info set iterator.
* @param fi file info set iterator
* @param dx new directory index
* @return current directory index
*/
int rpmfiSetDX(rpmfi fi, int dx);
/** \ingroup rpmfi
* Return current base name from file info set iterator.
* @param fi file info set iterator
* @return current base name, NULL on invalid
*/
const char * rpmfiBN(rpmfi fi);
/** \ingroup rpmfi
* Return current directory name from file info set iterator.
* @param fi file info set iterator
* @return current directory, NULL on invalid
*/
const char * rpmfiDN(rpmfi fi);
/** \ingroup rpmfi
* Return current file name from file info set iterator.
* @param fi file info set iterator
* @return current file name
*/
const char * rpmfiFN(rpmfi fi);
/** \ingroup rpmfi
* Return file index of the given file name or -1 if file is not in the rpmfi.
* The file name may have "." prefixed but is then interpreted as a global
* path without the prefixing "."
* @param fi file info set iterator
* @param fn file name
* @return file index or -1
*/
int rpmfiFindFN(rpmfi fi, const char * fn);
/** \ingroup rpmfi
* Return current original base name from file info set iterator.
* @param fi file info set iterator
* @return current base name, NULL on invalid
*/
const char * rpmfiOBN(rpmfi fi);
/** \ingroup rpmfi
* Return current original directory name from file info set iterator.
* @param fi file info set iterator
* @return current directory, NULL on invalid
*/
const char * rpmfiODN(rpmfi fi);
/** \ingroup rpmfi
* Return current original file name from file info set iterator.
* @param fi file info set iterator
* @return current file name
*/
const char * rpmfiOFN(rpmfi fi);
/** \ingroup rpmfi
* Return file index of the given original file name or -1 if file is not
* in the rpmfi. The file name may have "." prefixed but is then interpreted
* as a global path without the prefixing "."
* @param fi file info set iterator
* @param fn file name
* @return file index or -1
*/
int rpmfiFindOFN(rpmfi fi, const char * fn);
/** \ingroup rpmfi
* Return current file flags from file info set iterator.
* @param fi file info set iterator
* @return current file flags, 0 on invalid
*/
rpmfileAttrs rpmfiFFlags(rpmfi fi);
/** \ingroup rpmfi
* Return current file verify flags from file info set iterator.
* @param fi file info set iterator
* @return current file verify flags, 0 on invalid
*/
rpmVerifyAttrs rpmfiVFlags(rpmfi fi);
/** \ingroup rpmfi
* Return current file mode from file info set iterator.
* @param fi file info set iterator
* @return current file mode, 0 on invalid
*/
rpm_mode_t rpmfiFMode(rpmfi fi);
/** \ingroup rpmfi
* Return current file state from file info set iterator.
* @param fi file info set iterator
* @return current file state, 0 on invalid
*/
rpmfileState rpmfiFState(rpmfi fi);
/** \ingroup rpmfi
* Return digest algorithm of a file info set iterator.
* @param fi file info set iterator
* @return digest algorithm of file info set iterator, 0 on invalid
*/
int rpmfiDigestAlgo(rpmfi fi);
/** \ingroup rpmfi
* Return current file (binary) digest of file info set iterator.
* @param fi file info set iterator
* @retval algo digest hash algorithm used (pass NULL to ignore)
* @retval diglen digest hash length (pass NULL to ignore)
* @return current file digest, NULL on invalid
*/
const unsigned char * rpmfiFDigest(rpmfi fi, int *algo, size_t *diglen);
/** \ingroup rpmfi
* Return current file (hex) digest of file info set iterator.
* The file info set iterator stores file digests in binary format to conserve
* memory, this converts the binary data back to hex presentation used in
* headers.
* @param fi file info set iterator
* @retval algo digest hash algorithm used (pass NULL to ignore)
* @return current file digest (malloc'ed), NULL on invalid
*/
char * rpmfiFDigestHex(rpmfi fi, int *algo);
/** \ingroup rpmfi
* Return current file (binary) signature of file info set iterator.
* @param fi file info set iterator
* @retval siglen signature length (pass NULL to ignore)
* @return current file signature, NULL on invalid
*/
const unsigned char * rpmfiFSignature(rpmfi fi, size_t *siglen);
/** \ingroup rpmfi
* Return current file linkto (i.e. symlink(2) target) from file info set iterator.
* @param fi file info set iterator
* @return current file linkto, NULL on invalid
*/
const char * rpmfiFLink(rpmfi fi);
/** \ingroup rpmfi
* Return current file size from file info set iterator.
* @param fi file info set iterator
* @return current file size, 0 on invalid
*/
rpm_loff_t rpmfiFSize(rpmfi fi);
/** \ingroup rpmfi
* Return current file rdev from file info set iterator.
* @param fi file info set iterator
* @return current file rdev, 0 on invalid
*/
rpm_rdev_t rpmfiFRdev(rpmfi fi);
/** \ingroup rpmfi
* Return current file inode from file info set iterator.
* @param fi file info set iterator
* @return current file inode, 0 on invalid
*/
rpm_ino_t rpmfiFInode(rpmfi fi);
/** \ingroup rpmfi
* Return union of all file color bits from file info set iterator.
* @param fi file info set iterator
* @return current color
*/
rpm_color_t rpmfiColor(rpmfi fi);
/** \ingroup rpmfi
* Return current file color bits from file info set iterator.
* @param fi file info set iterator
* @return current file color
*/
rpm_color_t rpmfiFColor(rpmfi fi);
/** \ingroup rpmfi
* Return current file class from file info set iterator.
* @param fi file info set iterator
* @return current file class, 0 on invalid
*/
const char * rpmfiFClass(rpmfi fi);
/** \ingroup rpmfi
* Return current file depends dictionary from file info set iterator.
* @param fi file info set iterator
* @retval *fddictp file depends dictionary array (or NULL)
* @return no. of file depends entries, 0 on invalid
*/
uint32_t rpmfiFDepends(rpmfi fi,
const uint32_t ** fddictp);
/** \ingroup rpmfi
* Return (calculated) current file nlink count from file info set iterator.
* @param fi file info set iterator
* @return current file nlink count, 0 on invalid
*/
uint32_t rpmfiFNlink(rpmfi fi);
/** \ingroup rpmfi
* Return (calculated) current file nlink count from file info set iterator.
* @param fi file info set iterator
* @param files returns array of file ids hardlinked including ix,
NULL for nlink count == 1
* @return current file nlink count, 0 on invalid
*/
uint32_t rpmfiFLinks(rpmfi fi, const int ** files);
/** \ingroup rpmfi
* Return current file modify time from file info set iterator.
* @param fi file info set iterator
* @return current file modify time, 0 on invalid
*/
rpm_time_t rpmfiFMtime(rpmfi fi);
/** \ingroup rpmfi
* Return current file owner from file info set iterator.
* @param fi file info set iterator
* @return current file owner, NULL on invalid
*/
const char * rpmfiFUser(rpmfi fi);
/** \ingroup rpmfi
* Return current file group from file info set iterator.
* @param fi file info set iterator
* @return current file group, NULL on invalid
*/
const char * rpmfiFGroup(rpmfi fi);
/** \ingroup rpmfi
* Return textual representation of current file capabilities
* from file info set iterator. See cap_from_text(3) for details.
* @param fi file info set iterator
* @return file capability description, "" for no capabilities
* and NULL on invalid
*/
const char * rpmfiFCaps(rpmfi fi);
/** \ingroup rpmfi
* Return current file language(s) from file info set iterator.
* @param fi file info set iterator
* @return current file language(s), NULL on invalid
*/
const char * rpmfiFLangs(rpmfi fi);
/** \ingroup rpmfi
* Map file stat(2) info.
* @param fi file info iterator
* @param flags flags
* @retval sb mapped stat(2) data
*/
int rpmfiStat(rpmfi fi, int flags, struct stat *sb);
/** \ingroup rpmfi
* Return next file iterator index.
* @param fi file info set iterator
* @return file iterator index, -1 on termination
*/
int rpmfiNext(rpmfi fi);
/** \ingroup rpmfi
* Initialize file iterator index.
* @param fi file info set iterator
* @param fx file iterator index
* @return file info set iterator
*/
rpmfi rpmfiInit(rpmfi fi, int fx);
/** \ingroup rpmfi
* Return next directory iterator index.
* @param fi file info set iterator
* @return directory iterator index, -1 on termination
*/
int rpmfiNextD(rpmfi fi);
/** \ingroup rpmfi
* Initialize directory iterator index.
* @param fi file info set iterator
* @param dx directory iterator index
* @return file info set iterator, NULL if dx is out of range
*/
rpmfi rpmfiInitD(rpmfi fi, int dx);
/** \ingroup rpmfi
* Destroy a file info set iterator.
* @param fi file info set iterator
* @return NULL always
*/
rpmfi rpmfiFree(rpmfi fi);
/** \ingroup rpmfi
* Create and load a file info set iterator.
* @param pool shared string pool (or NULL for private pool)
* @param h header
* @param tagN unused
* @param flags Flags to control what information is loaded.
* @return new file info set iterator
*/
rpmfi rpmfiNewPool(rpmstrPool pool, Header h, rpmTagVal tagN, rpmfiFlags flags);
/** \ingroup rpmfi
* Create and load a file info set iterator.
* @param ts unused
* @param h header
* @param tagN unused
* @param flags Flags to control what information is loaded.
* @return new file info set iterator
*/
rpmfi rpmfiNew(const rpmts ts, Header h, rpmTagVal tagN, rpmfiFlags flags);
/** \ingroup rpmfi
* Return file type from mode_t.
* @param mode file mode bits (from header)
* @return file type
*/
rpmFileTypes rpmfiWhatis(rpm_mode_t mode);
/** \ingroup rpmfi
* Return file info comparison.
* @param afi 1st file info
* @param bfi 2nd file info
* @return 0 if identical
*/
int rpmfiCompare(const rpmfi afi, const rpmfi bfi);
/** \ingroup rpmfi
* Verify file attributes (including digest).
* @param fi file info iterator
* @param omitMask bit(s) to disable verify checks
* @return bit(s) to indicate failure (ie 0 for passed verify)
*/
rpmVerifyAttrs rpmfiVerify(rpmfi fi, rpmVerifyAttrs omitMask);
#ifdef __cplusplus
}
#endif
#endif /* H_RPMDS */
|