include/yaz/tpath.h

   1 /*
   2  * Copyright (C) 1995-2006, Index Data ApS
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The names of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Id: tpath.h,v 1.10 2006-04-26 10:01:31 adam Exp $
  27  *
  28  */
  29 /**
  30  * \file tpath.h
  31  * \brief File Path utilities
  32  */
  33
  34 #ifndef TPATH_H
  35 #define TPATH_H
  36
  37 #include <yaz/yconfig.h>
  38 #include <stdio.h>
  39
  40 YAZ_BEGIN_CDECL
  41
  42 /** \brief checks whether path is absolute
  43     \param path path to checked
  44
  45     Returns 1 if path is absolute, 0 if relative
  46 */
  47 YAZ_EXPORT int yaz_is_abspath (const char *path);
  48
  49 /** \brief resolve file on path
  50     \param fname "short" filename (without path)
  51     \param path the path (dir1:dir2,..) - ala Unix
  52     \param base can be added to relative paths (NULL for no append)
  53     \param fullpath the full path to filename (if succesful)
  54
  55     Returns 0/NULL if no fname could be found in path;
  56     pointer to fullpath if fname could be found.
  57     We assume fullpath is 1024 bytes in length!
  58 */
  59 YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path,
  60                                       const char *base, char *fullpath);
  61
  62
  63 /** \brief opens first file in path in path
  64     \param fname "short" filename (without path)
  65     \param path the path (dir1:dir2,..) - ala Unix
  66     \param base can be added to relative paths (NULL for no append)
  67     \param fullpath the full path to filename (if succesful)
  68
  69     Returns 0/NULL if no fname could be found in path;
  70     FILE * pointer if fname could be found.
  71 */
  72 YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *name,
  73                            const char *mode, const char *base);
  74
  75 /** \brief opens first file in path in path
  76     \param fname "short" filename (without path)
  77     \param path the path (dir1:dir2,..) - ala Unix
  78     \param fullpath the full path to filename (if succesful)
  79
  80     Returns 0/NULL if no fname could be found in path;
  81     FILE * pointer if fname could be found.
  82 */
  83 YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *name,
  84                            const char *mode);
  85
  86 /** \brief closes file
  87     \param f FILE handle
  88
  89     Returns -1 on failure; 0 on success
  90 */
  91 YAZ_EXPORT int yaz_fclose(FILE *f);
  92
  93
  94 YAZ_END_CDECL
  95
  96 #endif
  97 /*
  98  * Local variables:
  99  * c-basic-offset: 4
 100  * indent-tabs-mode: nil
 101  * End:
 102  * vim: shiftwidth=4 tabstop=8 expandtab
 103  */
 104