Bump version to 2.1.19. Added function yaz_filepath_resolve.
[yaz-moved-to-github.git] / include / yaz / tpath.h
1 /*
2  * Copyright (C) 1995-2005, 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.9 2006-04-26 09:40:43 adam Exp $
27  *
28  */
29 /**
30  * \file tpath.h
31  * \brief Header for path fopen
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 YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *name,
43                            const char *mode, const char *base);
44 YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *name,
45                            const char *mode);
46
47 YAZ_EXPORT int yaz_fclose(FILE *f);
48
49 YAZ_EXPORT int yaz_is_abspath (const char *p);
50
51 /** \brief resolve file on path 
52     \param fname "short" filename (without path)
53     \param path the path (dir1:dir2,..) - ala Unix
54     \param base can be added to relative paths (NULL for no append)
55     \param fullpath the full path to filename (if succesful)
56
57     Returns 0/NULL if no fname could be found in path; 
58     pointer to fullpath if fname could be found.
59     We assume fullpath is 1024 bytes in length!
60 */
61 YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path,
62                                       const char *base, char *fullpath);
63
64
65 YAZ_END_CDECL
66
67 #endif
68 /*
69  * Local variables:
70  * c-basic-offset: 4
71  * indent-tabs-mode: nil
72  * End:
73  * vim: shiftwidth=4 tabstop=8 expandtab
74  */
75