lib/savedirinfo.h

   1 /* Save the list of files in a directory, with additional information.
   2
   3    Copyright 1997, 1999, 2001, 2003, 2005 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU 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, see <http://www.gnu.org/licenses/>.
  17 */
  18 /* Written by James Youngman <jay@gnu.org>.
  19  * Based on savedir.h by David MacKenzie <djm@gnu.org>.
  20  */
  21
  22 #if !defined SAVEDIRINFO_H_
  23 # define SAVEDIRINFO_H_
  24
  25
  26 typedef enum tagSaveDirControlFlags
  27   {
  28     SavedirSort = 1
  29   }
  30 SaveDirControlFlags;
  31
  32
  33 typedef enum tagSaveDirDataFlags
  34   {
  35     SavedirHaveFileType = 1
  36   }
  37 SaveDirDataFlags;
  38
  39
  40 /* We keep the name and the type in a structure together
  41  * to allow us to sort them together.
  42  */
  43 struct savedir_direntry
  44 {
  45   int      flags;               /* from SaveDirDataFlags */
  46   char     *name;               /* the name of the directory entry */
  47   mode_t   type_info;           /* the type (or zero if unknown) */
  48 };
  49
  50 struct savedir_dirinfo
  51 {
  52   char *buffer;                 /* The names are stored here. */
  53   size_t size;                  /* The total number of results. */
  54   struct savedir_direntry *entries;     /* The results themselves */
  55 };
  56
  57
  58 struct savedir_extrainfo
  59 {
  60   mode_t type_info;
  61 };
  62
  63 /* savedirinfo() is the old interface. */
  64 char *savedirinfo (const char *dir, struct savedir_extrainfo **extra);
  65
  66 /* savedir() is the 'new' interface, but the function has the same name
  67  * as the function from findutils 4.1.7 and 4.1.20.
  68  */
  69 struct savedir_dirinfo * xsavedir(const char *dir, int flags);
  70 void free_dirinfo(struct savedir_dirinfo *p);
  71
  72 #endif