src/filename.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., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #if !filename_h
  21 #define filename_h 1
  22
  23 #include <stdio.h>
  24
  25 /* Search path for configuration files. */
  26 extern const char *config_path;
  27
  28 void fn_init (void);
  29
  30 char *fn_interp_vars (const char *input, const char *(*getenv) (const char *));
  31 char *fn_tilde_expand (const char *fn);
  32 char *fn_search_path (const char *basename, const char *path,
  33                       const char *prepend);
  34 char *fn_prepend_dir (const char *filename, const char *directory);
  35 char *fn_normalize (const char *fn);
  36 char *fn_dirname (const char *fn);
  37 char *fn_basename (const char *fn);
  38
  39 char *fn_get_cwd (void);
  40
  41 int fn_absolute_p (const char *fn);
  42 int fn_special_p (const char *fn);
  43 int fn_exists_p (const char *fn);
  44 char *fn_readlink (const char *fn);
  45
  46 const char *fn_getenv (const char *variable);
  47 const char *fn_getenv_default (const char *variable, const char *def);
  48
  49 FILE *fn_open (const char *fn, const char *mode);
  50 int fn_close (const char *fn, FILE *file);
  51 \f
  52 /* Extended file routines. */
  53 struct file_ext;
  54
  55 typedef int (*file_callback) (struct file_ext *);
  56
  57 /* File callbacks may not return zero to indicate failure unless they
  58    set errno to a sensible value. */
  59 struct file_ext
  60   {
  61     char *filename;             /* Filename. */
  62     const char *mode;           /* Open mode, i.e, "wb". */
  63     FILE *file;                 /* File. */
  64     int *sequence_no;           /* Page number, etc. */
  65     void *param;                /* User data. */
  66     file_callback postopen;     /* Called after FILE opened. */
  67     file_callback preclose;     /* Called before FILE closed. */
  68   };
  69
  70 int fn_open_ext (struct file_ext *file);
  71 int fn_close_ext (struct file_ext *file);
  72
  73 #endif /* filename_h */