include/yaz/tpath.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2011 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
  28 /**
  29  * \file tpath.h
  30  * \brief File Path utilities
  31  */
  32
  33 #ifndef TPATH_H
  34 #define TPATH_H
  35
  36 #include <yaz/yconfig.h>
  37 #include <stdio.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 /** \brief checks whether path is absolute
  42     \param path path to checked
  43     \retval 1 path is absolute
  44     \retval 0 path is relative
  45 */
  46 YAZ_EXPORT int yaz_is_abspath(const char *path);
  47
  48 /** \brief get next path component in filepath
  49     \param path_p pointer to path (updated to "next" entry if any)
  50     \param comp upon pointer to component (if component is found)
  51     \retval 0 no component found (and no more componennts)
  52     \retval >0 length of component (length of *comp)
  53
  54     A filepath has components separted by colon. For example
  55     /usr/lib/modules:c:/my:/:lib
  56     which has these components
  57     "/usr/lib/modules", "c:/my", "/", "lib"
  58 */
  59 YAZ_EXPORT size_t yaz_filepath_comp(const char **path_p, const char **comp);
  60
  61
  62 /** \brief resolve file on path
  63     \param fname "short" filename (without path)
  64     \param path the path (dir1:dir2,..) - ala Unix
  65     \param base can be added to relative paths (NULL for no append)
  66     \param fullpath the full path to filename (if successful)
  67     \returns fullpath or NULL if file could not be found
  68
  69     Be sure to allocate at least 1024 bytes for fullpath
  70 */
  71 YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path,
  72                                       const char *base, char *fullpath);
  73
  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     \param base can be added to relative paths (NULL for no append)
  80     \returns FILE pointer if fname could be found; NULL otherwise
  81 */
  82 YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *fname,
  83                            const char *mode, const char *base);
  84
  85 /** \brief opens first file in path in path
  86     \param fname "short" filename (without path)
  87     \param mode mode as in fopen(3)
  88     \param path the path (dir1:dir2,..) - ala Unix
  89     \returns FILE pointer if fname could be found; NULL otherwise
  90 */
  91 YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *fname,
  92                                 const char *mode);
  93
  94 /** \brief closes file
  95     \param f FILE handle
  96
  97     \retval -1 on failure
  98     \retval 0 on success
  99 */
 100 YAZ_EXPORT int yaz_fclose(FILE *f);
 101
 102
 103 YAZ_END_CDECL
 104
 105 #endif
 106 /*
 107  * Local variables:
 108  * c-basic-offset: 4
 109  * c-file-style: "Stroustrup"
 110  * indent-tabs-mode: nil
 111  * End:
 112  * vim: shiftwidth=4 tabstop=8 expandtab
 113  */
 114