lib/rpmlead.h

   1 #ifndef _H_RPMLEAD
   2 #define _H_RPMLEAD
   3
   4 /** \ingroup lead
   5  * \file lib/rpmlead.h
   6  * Routines to read and write an rpm lead structure for a a package.
   7  */
   8 #ifdef __cplusplus
   9 extern "C" {
  10 #endif
  11
  12 #define RPMLEAD_BINARY 0
  13 #define RPMLEAD_SOURCE 1
  14
  15 #define RPMLEAD_MAGIC0 0xed
  16 #define RPMLEAD_MAGIC1 0xab
  17 #define RPMLEAD_MAGIC2 0xee
  18 #define RPMLEAD_MAGIC3 0xdb
  19
  20 #define RPMLEAD_SIZE 96         /*!< Don't rely on sizeof(struct) */
  21
  22 typedef struct rpmlead_s * rpmlead;
  23
  24 /** \ingroup lead
  25  * Initialize a lead structure from header
  26  * param h              Header
  27  * @return              Pointer to populated lead structure (malloced)
  28  */
  29 rpmlead rpmLeadFromHeader(Header h);
  30
  31 /** \ingroup lead
  32  * Free a lead structure
  33  * @param lead          Pointer to lead structure
  34  * @return              NULL always
  35  */
  36 rpmlead rpmLeadFree(rpmlead lead);
  37
  38 /** \ingroup lead
  39  * Write lead to file handle.
  40  * @param fd            file handle
  41  * @param lead          package lead
  42  * @return              RPMRC_OK on success, RPMRC_FAIL on error
  43  */
  44 rpmRC rpmLeadWrite(FD_t fd, rpmlead lead);
  45
  46 /** \ingroup lead
  47  * Read lead from file handle.
  48  * @param fd            file handle
  49  * @retval lead         pointer to package lead (malloced)
  50  * @retval type         RPMLEAD_BINARY or RPMLEAD_SOURCE on success
  51  * @retval emsg         failure message on error (malloced)
  52  * @return              RPMRC_OK on success, RPMRC_FAIL/RPMRC_NOTFOUND on error
  53  */
  54 rpmRC rpmLeadRead(FD_t fd, rpmlead *lead, int *type, char **emsg);
  55
  56 #ifdef __cplusplus
  57 }
  58 #endif
  59
  60 #endif  /* _H_RPMLEAD */