~ubuntu-branches/ubuntu/raring/vice/raring

/****************************************************************************

	Directory.h

	This file contains the C definitions and declarations for the

	Directory.c directory iteration code.

	This code is intended to be used as a convenient, machine

	independent interface to iterate through the contents of a

	directory.

 ****************************************************************************/

/*

 * Author:

 * 	Brian Totty

 * 	Department of Computer Science

 * 	University Of Illinois at Urbana-Champaign

 *	1304 West Springfield Avenue

 * 	Urbana, IL 61801

 * 

 * 	totty@cs.uiuc.edu

 * 	

 */ 

#ifndef _FWF_DIRECTORY_H_

#define _FWF_DIRECTORY_H_

#ifdef MINIXVMD

#undef NAME_MAX

#define NAME_MAX 60

#endif

#include <stdio.h>

#include <string.h>

#ifndef VMS

#include <sys/param.h>

#endif

#include <sys/types.h>

#include <sys/stat.h>

#ifndef PATH_MAX

#  ifdef MAX_PATH

#    define PATH_MAX MAX_PATH

#  else

#    define PATH_MAX 1024

#  endif

#endif

#ifndef MAXPATHLEN

#define MAXPATHLEN PATH_MAX

#endif

#if defined(SYSV) || defined(SVR4)

#define getwd(path) getcwd(path, MAXPATHLEN)

#endif

#ifdef VMS

struct __dirdesc {

  unsigned long dd_fd;

  long dd_loc;

  long dd_size;

  long dd_bsize;

  long dd_off;

  char *dd_buf;

  char d_name[256];

};

typedef struct __dirdesc DIR;

struct dirent {

  long d_off;

  unsigned long d_fileno;

  unsigned short d_reclen;

  unsigned short d_namlen;

  char d_name[255+1];

};

extern DIR *opendir(char *dirname);

extern int closedir(DIR *dirp);

extern long telldir(DIR *dirp);

extern void seekdir(DIR *dirp, int loc);

extern struct dirent *readdir(DIR *dirp);

#else

#ifndef	NO_DIRENT

#include <dirent.h>

#else

#include <sys/dir.h>

#define	dirent direct

#endif

#endif

#ifdef __NeXT__

#ifdef HAVE_SYS_DIR_H

#include <sys/dir.h>

#endif

#define dirent direct

#endif

#define NeedFunctionPrototypes 1

#ifndef HAVE_U_SHORT

#define u_short unsigned short

#endif

#ifndef NAME_MAX  /* was _SYS_NAME_MAX, but doesn't compile with `gcc -ansi' */

#ifndef MAXNAMLEN

#define MAX_NAME_LENGTH 1024	/* ettore@comm2000.it 03.14.97 */

#else

#define	MAX_NAME_LENGTH	MAXNAMLEN

#endif

#else

#define	MAX_NAME_LENGTH	NAME_MAX

#endif

#ifndef TRUE

#define TRUE				1

#endif

#ifndef FALSE

#define	FALSE				0

#endif

#define	PERM_READ			4

#define	PERM_WRITE			2	

#define	PERM_EXECUTE			1

#define	F_TYPE_DIR			1

#define	F_TYPE_FILE			2

#define	F_TYPE_CHAR_SPECIAL		3

#define	F_TYPE_BLOCK_SPECIAL		4

#define	F_TYPE_SYM_LINK			5

#define	F_TYPE_SOCKET			6

#define	F_TYPE_FIFO			7

/*--------------------------------------------------------------------------*

            D A T A    T Y P E    A C C E S S    M A C R O S

 *--------------------------------------------------------------------------*/

	/* Directory: Directory Iterator */

#define	DirectoryDir(dp)		((dp)->filep)

#define	DirectoryPath(dp)		((dp)->path)

	/* FileInfo: Information About A File Or Link */

#define	FileInfoProt(fi)		((fi)->protections)

#define FileInfoOrigMode(fi)		((fi)->orig_mode)

#define	FileInfoUserID(fi)		((fi)->user_id)

#define	FileInfoGroupID(fi)		((fi)->group_id)

#define	FileInfoFileSize(fi)		((fi)->size)

#define	FileInfoLastAccess(fi)		((fi)->last_access)

#define	FileInfoLastModify(fi)		((fi)->last_modify)

#define	FileInfoLastStatusChange(fi)	((fi)->last_status_change)

#define	FIProt(fi)			FileInfoProt(fi)

#define FIOrigMode(fi)			FileInfoOrigMode(fi)

#define	FIUserID(fi)			FileInfoUserID(fi)

#define	FIGroupID(fi)			FileInfoGroupID(fi)

#define	FIFileSize(fi)			FileInfoFileSize(fi)

#define	FILastAccess(fi)		FileInfoLastAccess(fi)

#define	FILastModify(fi)		FileInfoLastModify(fi)

#define	FILastStatusChange(fi)		FileInfoLastStatusChange(fi)

	/* FType: File Type Macros */

#define	FTypeIsDir(ft)			((ft) == F_TYPE_DIR)

#define	FTypeIsFile(ft)			((ft) == F_TYPE_FILE)

#define	FTypeIsCharSpecial(ft)		((ft) == F_TYPE_CHAR_SPECIAL)

#define	FTypeIsBlockSpecial(ft)		((ft) == F_TYPE_BLOCK_SPECIAL)

#define	FTypeIsSymLink(ft)		((ft) == F_TYPE_SYM_LINK)

#define	FTypeIsSocket(ft)		((ft) == F_TYPE_SOCKET)

#define	FTypeIsFifo(ft)			((ft) == F_TYPE_FIFO)

	/* DirEntry: Information About A Item In A Directory */

#define	DirEntryFileName(fi)		((fi)->filename)

#define	DirEntryType(fi)		((fi)->file_type)

#define	DirEntrySelfInfo(fi)		(&((fi)->self_info))

#define	DirEntryActualInfo(fi)		(&((fi)->actual_info))

#define	DirEntryIsBrokenLink(fi)	((fi)->broken_link)

#define	DirEntryIsDirectoryLink(fi)	((fi)->directory_link)

#define	DirEntryIsDir(fi)		(FTypeIsDir(DirEntryType(fi)))

#define	DirEntryIsFile(fi)		(FTypeIsFile(DirEntryType(fi)))

#define	DirEntryIsCharSpecial(fi)	(FTypeIsCharSpecial(DirEntryType(fi)))

#define	DirEntryIsBlockSpecial(fi)	(FTypeIsBlockSpecial(DirEntryType(fi)))

#define	DirEntryIsSymLink(fi)		(FTypeIsSymLink(DirEntryType(fi)))

#define	DirEntryIsSocket(fi)		(FTypeIsSocket(DirEntryType(fi)))

#define	DirEntryIsFifo(fi)		(FTypeIsFifo(DirEntryType(fi)))

#define	DirEntryLeadsToDir(fi)		(DirEntryIsDir(fi) ||		\

					 DirEntryIsDirectoryLink(fi))

#define	DirEntryProt(d)			FIProt(DirEntrySelfInfo(d))

#define DirEntryOrigMode(d)		FIOrigMode(DirEntrySelfInfo(d))

#define	DirEntryUserID(d)		FIUserID(DirEntrySelfInfo(d))

#define	DirEntryGroupID(d)		FIGroupID(DirEntrySelfInfo(d))

#define	DirEntryFileSize(d)		FIFileSize(DirEntrySelfInfo(d))

#define	DirEntryLastAccess(d)		FILastAccess(DirEntrySelfInfo(d))

#define	DirEntryLastModify(d)		FILastModify(DirEntrySelfInfo(d))

#define	DirEntryLastStatusChange(d)	FILastStatusChange(DirEntrySelfInfo(d))

/*--------------------------------------------------------------------------*

             D A T A    T Y P E    D E F I N I T I O N S

 *--------------------------------------------------------------------------*/

	/* Directory: Directory Iterator */

typedef struct

{

	DIR *filep;

	char path[MAXPATHLEN + 2];

} DIRECTORY;

typedef DIRECTORY Directory;

	/* FileInfo: Information About A File Or Link */

typedef struct

{

	short protections;

	short orig_mode;

	short user_id;

	short group_id;

	long size;

	time_t last_access;

	time_t last_modify;

	time_t last_status_change;

} FILE_INFO;

typedef	FILE_INFO FileInfo;

	/* DirEntry: Information About A Item In A Directory */

typedef struct

{

	char filename[MAX_NAME_LENGTH + 1];

	short file_type;

	short broken_link;

	short directory_link;

	FileInfo self_info;

	FileInfo actual_info;

} DIR_ENTRY;

typedef DIR_ENTRY DirEntry;

/*--------------------------------------------------------------------------*

        L O W    L E V E L    D I R E C T O R Y    I N T E R F A C E

 *--------------------------------------------------------------------------*/

#if (!NeedFunctionPrototypes)

int	DirectoryOpen();

void	DirectoryRestart();

void	DirectoryClose();

long	DirectoryTellPosition();

void	DirectorySetPosition();

int	DirectoryReadNextEntry();

char *	DirectoryPathExpand();

void	DirEntryDump();

#else

int	DirectoryOpen(char *dir_name, Directory *dp);

void	DirectoryRestart(Directory *dp);

void	DirectoryClose(Directory *dp);

long	DirectoryTellPosition(Directory *dp);

void	DirectorySetPosition(Directory *dp, long int pos);

int	DirectoryReadNextEntry(Directory *dp, DirEntry *de);

char *	DirectoryPathExpand(char *old_path, char *new_path);

void	DirEntryDump(FILE *fp, DirEntry *de);

#endif

#endif