X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Ftpath.h;h=ae7f7c27ce21a01fbae4e8fd36b0543e2ca2271f;hb=3f282496986cbae7fd4bd7f95d44bf47a2cc6874;hp=f93ba637da9a88b0ac6cb07e5f83e9fb29f172be;hpb=d9ee01635f03f9095a66f71b73580560d48798e8;p=yaz-moved-to-github.git diff --git a/include/yaz/tpath.h b/include/yaz/tpath.h index f93ba63..ae7f7c2 100644 --- a/include/yaz/tpath.h +++ b/include/yaz/tpath.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-1997, Index Data. + * Copyright (C) 1995-2006, Index Data ApS * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,31 +23,82 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Log: tpath.h,v $ - * Revision 1.1 1999-11-30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.4 1997/10/31 12:20:08 adam - * Improved memory debugging for xmalloc/nmem.c. References to NMEM - * instead of ODR in n ESPEC-1 handling in source d1_espec.c. - * Bug fix: missing fclose in data1_read_espec1. + * $Id: tpath.h,v 1.11 2006-05-02 12:11:08 adam Exp $ * */ +/** + * \file tpath.h + * \brief File Path utilities + */ #ifndef TPATH_H #define TPATH_H #include +#include -#ifdef __cplusplus -extern "C" { -#endif +YAZ_BEGIN_CDECL -YAZ_EXPORT FILE *yaz_path_fopen(const char *path, - const char *name, const char *mode); +/** \brief checks whether path is absolute + \param path path to checked -#ifdef __cplusplus -} -#endif + Returns 1 if path is absolute, 0 if relative +*/ +YAZ_EXPORT int yaz_is_abspath (const char *path); + +/** \brief resolve file on path + \param fname "short" filename (without path) + \param path the path (dir1:dir2,..) - ala Unix + \param base can be added to relative paths (NULL for no append) + \param fullpath the full path to filename (if succesful) + + Returns 0/NULL if no fname could be found in path; + pointer to fullpath if fname could be found. + We assume fullpath is 1024 bytes in length! +*/ +YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path, + const char *base, char *fullpath); + + +/** \brief opens first file in path in path + \param fname "short" filename (without path) + \param mode mode as in fopen(3) + \param path the path (dir1:dir2,..) - ala Unix + \param base can be added to relative paths (NULL for no append) + + Returns 0/NULL if no fname could be found in path; + FILE pointer if fname could be found. +*/ +YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *fname, + const char *mode, const char *base); + +/** \brief opens first file in path in path + \param fname "short" filename (without path) + \param mode mode as in fopen(3) + \param path the path (dir1:dir2,..) - ala Unix + + Returns 0/NULL if no fname could be found in path; + FILE pointer if fname could be found. +*/ +YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *fname, + const char *mode); + +/** \brief closes file + \param f FILE handle + + Returns -1 on failure; 0 on success +*/ +YAZ_EXPORT int yaz_fclose(FILE *f); + + +YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +