Fix missing @clicksequence problem with older Texinfo versions.
[pspp-builds.git] / src / data / file-name.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #ifndef FILE_NAME_H
18 #define FILE_NAME_H 1
19
20 #include <stdio.h>
21 #include <stdbool.h>
22 #include <libpspp/str.h>
23 #include <sys/types.h>
24
25 /* Search path for configuration files. */
26 extern const char *config_path;
27
28 void fn_init (void);
29
30 void fn_interp_vars (struct substring src,
31                      const char *(*getenv) (const char *),
32                      struct string *dst);
33 char *fn_search_path (const char *base_name, const char *path);
34 char *fn_dir_name (const char *fn);
35 char *fn_extension (const char *fn);
36
37 bool fn_is_absolute (const char *fn);
38 bool fn_is_special (const char *fn);
39 bool fn_exists (const char *fn);
40
41 const char *fn_getenv (const char *variable);
42 const char *fn_getenv_default (const char *variable, const char *def);
43
44 FILE *fn_open (const char *fn, const char *mode);
45 int fn_close (const char *fn, FILE *file);
46
47 FILE *create_stream (const char *fn, const char *mode, mode_t permissions);
48
49 struct file_identity *fn_get_identity (const char *file_name);
50 void fn_free_identity (struct file_identity *);
51 int fn_compare_file_identities (const struct file_identity *,
52                                 const struct file_identity *);
53 unsigned int fn_hash_identity (const struct file_identity *);
54
55 const char * default_output_path (void);
56
57 #endif /* file-name.h */