diff options
Diffstat (limited to 'rpmio/rpmio.h')
| -rw-r--r-- | rpmio/rpmio.h | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/rpmio/rpmio.h b/rpmio/rpmio.h index 7ec637483..b60e23b2b 100644 --- a/rpmio/rpmio.h +++ b/rpmio/rpmio.h @@ -18,47 +18,121 @@ #define USE_COOKIE_SEEK_POINTER 1 #endif + +/** \ingroup rpmio + */ typedef /*@abstract@*/ /*@refcounted@*/ struct _FD_s * FD_t; + +/** \ingroup rpmio + */ typedef /*@observer@*/ struct FDIO_s * FDIO_t; #ifdef __cplusplus extern "C" { #endif +/** \ingroup rpmio + * \name RPMIO Vectors. + */ +/*@{*/ typedef ssize_t fdio_read_function_t (void *cookie, char *buf, size_t nbytes); + +/** \ingroup rpmio + */ typedef ssize_t fdio_write_function_t (void *cookie, const char *buf, size_t nbytes); + +/** \ingroup rpmio + */ #ifdef USE_COOKIE_SEEK_POINTER typedef int fdio_seek_function_t (void *cookie, _IO_off64_t * offset, int whence); #else typedef int fdio_seek_function_t (void *cookie, off_t offset, int whence); #endif + +/** \ingroup rpmio + */ typedef int fdio_close_function_t (void *cookie); + +/** \ingroup rpmio + */ typedef /*@null@*/ FD_t fdio_ref_function_t ( /*@only@*/ void * cookie, const char * msg, const char * file, unsigned line); + +/** \ingroup rpmio + */ typedef /*@null@*/ FD_t fdio_deref_function_t ( /*@only@*/ FD_t fd, const char * msg, const char * file, unsigned line); + +/** \ingroup rpmio + */ typedef /*@null@*/ FD_t fdio_new_function_t (const char * msg, const char * file, unsigned line); + +/** \ingroup rpmio + */ typedef int fdio_fileno_function_t (void * cookie); + +/** \ingroup rpmio + */ typedef FD_t fdio_open_function_t (const char * path, int flags, mode_t mode); + +/** \ingroup rpmio + */ typedef FD_t fdio_fopen_function_t (const char * path, const char * fmode); + +/** \ingroup rpmio + */ typedef void * fdio_ffileno_function_t (FD_t fd); + +/** \ingroup rpmio + */ typedef int fdio_fflush_function_t (FD_t fd); +/*@}*/ + +/** \ingroup rpmrpc + * \name RPMRPC Vectors. + */ +/*@{*/ typedef int fdio_mkdir_function_t (const char * path, mode_t mode); + +/** \ingroup rpmrpc + */ typedef int fdio_chdir_function_t (const char * path); + +/** \ingroup rpmrpc + */ typedef int fdio_rmdir_function_t (const char * path); + +/** \ingroup rpmrpc + */ typedef int fdio_rename_function_t (const char * oldpath, const char * newpath); + +/** \ingroup rpmrpc + */ typedef int fdio_unlink_function_t (const char * path); + +/** \ingroup rpmrpc + */ typedef int fdio_stat_function_t (const char * path, struct stat * st); + +/** \ingroup rpmrpc + */ typedef int fdio_lstat_function_t (const char * path, struct stat * st); + +/** \ingroup rpmrpc + */ typedef int fdio_access_function_t (const char * path, int amode); +/*@}*/ + +/** \ingroup rpmio + */ struct FDIO_s { fdio_read_function_t * read; fdio_write_function_t * write; @@ -82,57 +156,157 @@ struct FDIO_s { fdio_unlink_function_t * _unlink; }; + +/** \ingroup rpmio + * \name RPMIO Interface. + */ +/*@{*/ + +/** \ingroup rpmio + */ /*@observer@*/ const char * Fstrerror(FD_t fd); +/** \ingroup rpmio + */ size_t Fread (/*@out@*/ void * buf, size_t size, size_t nmemb, FD_t fd); + +/** \ingroup rpmio + */ size_t Fwrite (const void *buf, size_t size, size_t nmemb, FD_t fd); + +/** \ingroup rpmio + */ #ifdef USE_COOKIE_SEEK_POINTER int Fseek (FD_t fd, _IO_off64_t offset, int whence); #else int Fseek (FD_t fd, off_t offset, int whence); #endif + +/** \ingroup rpmio + */ int Fclose ( /*@killref@*/ FD_t fd); + +/** \ingroup rpmio + */ FD_t Fdopen (FD_t fd, const char * fmode); + +/** \ingroup rpmio + */ FD_t Fopen (const char * path, const char * fmode); + +/** \ingroup rpmio + */ int Fflush (FD_t fd); + +/** \ingroup rpmio + */ int Ferror (FD_t fd); + +/** \ingroup rpmio + */ int Fileno (FD_t fd); + +/** \ingroup rpmio + */ int Fcntl (FD_t, int op, void *lip); + +/** \ingroup rpmio + */ #ifdef USE_COOKIE_SEEK_POINTER ssize_t Pread(FD_t fd, void * buf, size_t count, _IO_off64_t offset); #else ssize_t Pread(FD_t fd, void * buf, size_t count, off_t offset); #endif + +/** \ingroup rpmio + */ #ifdef USE_COOKIE_SEEK_POINTER ssize_t Pwrite(FD_t fd, const void * buf, size_t count, _IO_off64_t offset); #else ssize_t Pwrite(FD_t fd, const void * buf, size_t count, off_t offset); #endif +/*@}*/ + +/** \ingroup rpmrpc + * \name RPMRPC Interface. + */ +/*@{*/ int Mkdir (const char * path, mode_t mode); + +/** \ingroup rpmrpc + */ int Chdir (const char * path); + +/** \ingroup rpmrpc + */ int Rmdir (const char * path); + +/** \ingroup rpmrpc + */ int Rename (const char * oldpath, const char * newpath); + +/** \ingroup rpmrpc + */ int Link (const char * oldpath, const char * newpath); + +/** \ingroup rpmrpc + */ int Unlink (const char * path); + +/** \ingroup rpmrpc + */ int Readlink(const char * path, char * buf, size_t bufsiz); + +/** \ingroup rpmrpc + */ int Stat (const char * path, /*@out@*/ struct stat * st); + +/** \ingroup rpmrpc + */ int Lstat (const char * path, /*@out@*/ struct stat * st); + +/** \ingroup rpmrpc + */ int Access (const char * path, int amode); + +/** \ingroup rpmrpc + */ int Glob (const char * pattern, int flags, int errfunc(const char * epath, int eerrno), /*@out@*/ glob_t * pglob); + +/** \ingroup rpmrpc + */ void Globfree( /*@only@*/ glob_t * pglob); + +/** \ingroup rpmrpc + */ DIR * Opendir (const char * name); + +/** \ingroup rpmrpc + */ struct dirent * Readdir (DIR * dir); + +/** \ingroup rpmrpc + */ int Closedir(DIR * dir); +/*@}*/ + +/** \ingroup rpmio + * \name RPMIO Utilities. + */ +/*@{*/ off_t fdSize (FD_t fd); + +/** \ingroup rpmio + */ /*@null@*/ FD_t fdDup(int fdno); #ifdef UNUSED /*@null@*/ FILE *fdFdopen( /*@only@*/ void * cookie, const char * mode); @@ -140,13 +314,28 @@ off_t fdSize (FD_t fd); /* XXX Legacy interfaces needed by gnorpm, rpmfind et al */ + +/** \ingroup rpmio + */ /*@-shadow@*/ int fdFileno(void * cookie); /*@=shadow@*/ + +/** \ingroup rpmio + */ /*@null@*/ FD_t fdOpen(const char *path, int flags, mode_t mode); + +/** \ingroup rpmio + */ ssize_t fdRead(void * cookie, /*@out@*/ char * buf, size_t count); + +/** \ingroup rpmio + */ ssize_t fdWrite(void * cookie, const char * buf, size_t count); + +/** \ingroup rpmio + */ int fdClose( /*@only@*/ void * cookie); /* XXX FD_t reference count debugging wrappers */ @@ -154,7 +343,13 @@ int fdClose( /*@only@*/ void * cookie); #define fdFree(_fd, _msg) fdio->_fdderef(_fd, _msg, __FILE__, __LINE__) #define fdNew(_msg) fdio->_fdnew(_msg, __FILE__, __LINE__) + +/** \ingroup rpmio + */ int fdWritable(FD_t fd, int secs); + +/** \ingroup rpmio + */ int fdReadable(FD_t fd, int secs); /* @@ -173,22 +368,56 @@ int fdReadable(FD_t fd, int secs); #define FTPERR_NIC_ABORT_IN_PROGRESS -11 #define FTPERR_UNKNOWN -100 + +/** \ingroup rpmio + */ /*@dependent@*/ /*@null@*/ void * ufdGetUrlinfo(FD_t fd); + +/** \ingroup rpmio + */ /*@observer@*/ const char * urlStrerror(const char * url); + +/** \ingroup rpmio + */ int ufdCopy(FD_t sfd, FD_t tfd); + +/** \ingroup rpmio + */ int ufdGetFile( /*@killref@*/ FD_t sfd, FD_t tfd); + +/** \ingroup rpmio + */ /*@observer@*/ const char *const ftpStrerror(int errorNumber); int timedRead(FD_t fd, /*@out@*/ void * bufptr, int length); #define timedRead ufdio->read + +/** \ingroup rpmio + */ /*@observer@*/ extern FDIO_t fdio; + +/** \ingroup rpmio + */ /*@observer@*/ extern FDIO_t fpio; + +/** \ingroup rpmio + */ /*@observer@*/ extern FDIO_t ufdio; + +/** \ingroup rpmio + */ /*@observer@*/ extern FDIO_t gzdio; + +/** \ingroup rpmio + */ /*@observer@*/ extern FDIO_t bzdio; + +/** \ingroup rpmio + */ /*@observer@*/ extern FDIO_t fadio; +/*@}*/ #ifdef __cplusplus } |