Constness and global namespace patrol.
[pspp-builds.git] / src / data / file-name.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 #ifndef FILE_NAME_H
21 #define FILE_NAME_H 1
22
23 #include <stdio.h>
24 #include <stdbool.h>
25
26 /* Search path for configuration files. */
27 extern const char *config_path;
28
29 void fn_init (void);
30
31 struct string;
32 struct substring;
33 void fn_interp_vars (struct substring src, 
34                      const char *(*getenv) (const char *),
35                      struct string *dst);
36 char *fn_tilde_expand (const char *fn);
37 char *fn_search_path (const char *base_name, const char *path,
38                       const char *prefix);
39 char *fn_normalize (const char *fn);
40 char *fn_dir_name (const char *fn);
41 char *fn_extension (const char *fn);
42
43 char *fn_get_cwd (void);
44
45 bool fn_is_absolute (const char *fn);
46 bool fn_is_special (const char *fn);
47 bool fn_exists (const char *fn);
48 char *fn_readlink (const char *fn);
49
50 const char *fn_getenv (const char *variable);
51 const char *fn_getenv_default (const char *variable, const char *def);
52
53 FILE *fn_open (const char *fn, const char *mode);
54 int fn_close (const char *fn, FILE *file);
55
56 struct file_identity *fn_get_identity (const char *file_name);
57 void fn_free_identity (struct file_identity *);
58 int fn_compare_file_identities (const struct file_identity *,
59                                 const struct file_identity *);
60
61 #endif /* file-name.h */