filesys.h revision 42660 
1/* filesys.h -- External declarations of functions and vars in filesys.c.
2   $Id: filesys.h,v 1.3 1997/07/15 18:39:08 karl Exp $
3
4   This file is part of GNU Info, a program for reading online documentation
5   stored in Info format.
6
7   Copyright (C) 1993, 97 Free Software Foundation, Inc.
8
9   This program is free software; you can redistribute it and/or modify
10   it under the terms of the GNU General Public License as published by
11   the Free Software Foundation; either version 2, or (at your option)
12   any later version.
13
14   This program is distributed in the hope that it will be useful,
15   but WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   GNU General Public License for more details.
18
19   You should have received a copy of the GNU General Public License
20   along with this program; if not, write to the Free Software
21   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22
23   Written by Brian Fox (bfox@ai.mit.edu). */
24
25#ifndef INFO_FILESYS_H
26#define INFO_FILESYS_H
27
28/* The path on which we look for info files.  You can initialize this
29   from the environment variable INFOPATH if there is one, or you can
30   call info_add_path () to add paths to the beginning or end of it. */
31extern char *infopath;
32
33/* Make INFOPATH have absolutely nothing in it. */
34extern void zap_infopath ();
35
36/* Add PATH to the list of paths found in INFOPATH.  2nd argument says
37   whether to put PATH at the front or end of INFOPATH. */
38extern void info_add_path ();
39
40/* Defines that are passed along with the pathname to info_add_path (). */
41#define INFOPATH_PREPEND 0
42#define INFOPATH_APPEND  1
43
44/* Expand the filename in PARTIAL to make a real name for this operating
45   system.  This looks in INFO_PATHS in order to find the correct file.
46   If it can't find the file, it returns NULL. */
47extern char *info_find_fullpath ();
48
49/* Read the contents of PATHNAME, returning a buffer with the contents of
50   that file in it, and returning the size of that buffer in FILESIZE.
51   FINFO is a stat struct which has already been filled in by the caller.
52   If the file cannot be read, return a NULL pointer. */
53extern char *filesys_read_info_file ();
54extern char *filesys_read_compressed ();
55
56/* Return the command string that would be used to decompress FILENAME. */
57extern char *filesys_decompressor_for_file ();
58extern int compressed_filename_p ();
59
60/* A function which returns a pointer to a static buffer containing
61   an error message for FILENAME and ERROR_NUM. */
62extern char *filesys_error_string ();
63
64/* The number of the most recent file system error. */
65extern int filesys_error_number;
66
67/* Given a string containing units of information separated by colons,
68   return the next one pointed to by IDX, or NULL if there are no more.
69   Advance IDX to the character after the colon. */
70extern char *extract_colon_unit ();
71
72/* The default value of INFOPATH. */
73#if !defined (DEFAULT_INFOPATH)
74#  define DEFAULT_INFOPATH "/usr/local/info:/usr/info:/usr/local/lib/info:/usr/lib/info:/usr/local/gnu/info:/usr/local/gnu/lib/info:/usr/gnu/info:/usr/gnu/lib/info:/opt/gnu/info:/usr/share/info:/usr/share/lib/info:/usr/local/share/info:/usr/local/share/lib/info:/usr/gnu/lib/emacs/info:/usr/local/gnu/lib/emacs/info:/usr/local/lib/emacs/info:/usr/local/emacs/info:."
75#endif /* !DEFAULT_INFOPATH */
76
77#if !defined (S_ISREG) && defined (S_IFREG)
78#  define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
79#endif /* !S_ISREG && S_IFREG */
80
81#if !defined (S_ISDIR) && defined (S_IFDIR)
82#  define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
83#endif /* !S_ISDIR && S_IFDIR */
84
85#endif /* not INFO_FILESYS_H */
86