include/yaz/tpath.h

   1 /*
   2  * Copyright (c) 1995-2006, Index Data
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 /* $Id: tpath.h,v 1.12 2006-10-09 21:02:41 adam Exp $ */
  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 mode mode as in fopen(3)
  66     \param path the path (dir1:dir2,..) - ala Unix
  67     \param base can be added to relative paths (NULL for no append)
  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 *fname,
  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 mode mode as in fopen(3)
  78     \param path the path (dir1:dir2,..) - ala Unix
  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 *fname,
  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