xref: /openbsd/bin/ksh/shf.h (revision 5ef49dcf)
1 /*	$OpenBSD: shf.h,v 1.8 2015/12/14 06:09:43 mmcc Exp $	*/
2 
3 #ifndef SHF_H
4 # define SHF_H
5 
6 /*
7  * Shell file I/O routines
8  */
9 
10 #define SHF_BSIZE	512
11 
12 #define shf_getc(shf) ((shf)->rnleft > 0 ? (shf)->rnleft--, *(shf)->rp++ : \
13 			shf_getchar(shf))
14 #define shf_putc(c, shf)	((shf)->wnleft == 0 ? shf_putchar((c), (shf)) : \
15 				    ((shf)->wnleft--, *(shf)->wp++ = (c)))
16 #define shf_eof(shf)		((shf)->flags & SHF_EOF)
17 #define shf_error(shf)		((shf)->flags & SHF_ERROR)
18 #define shf_clearerr(shf)	((shf)->flags &= ~(SHF_EOF | SHF_ERROR))
19 
20 /* Flags passed to shf_*open() */
21 #define SHF_RD		0x0001
22 #define SHF_WR		0x0002
23 #define SHF_RDWR	  (SHF_RD|SHF_WR)
24 #define SHF_ACCMODE	  0x0003	/* mask */
25 #define SHF_GETFL	0x0004		/* use fcntl() to figure RD/WR flags */
26 #define SHF_UNBUF	0x0008		/* unbuffered I/O */
27 #define SHF_CLEXEC	0x0010		/* set close on exec flag */
28 #define SHF_MAPHI	0x0020		/* make fd > FDBASE (and close orig)
29 					 * (shf_open() only) */
30 #define SHF_DYNAMIC	0x0040		/* string: increase buffer as needed */
31 #define SHF_INTERRUPT	0x0080		/* EINTR in read/write causes error */
32 /* Flags used internally */
33 #define SHF_STRING	0x0100		/* a string, not a file */
34 #define SHF_ALLOCS	0x0200		/* shf and shf->buf were alloc()ed */
35 #define SHF_ALLOCB	0x0400		/* shf->buf was alloc()ed */
36 #define SHF_ERROR	0x0800		/* read()/write() error */
37 #define SHF_EOF		0x1000		/* read eof (sticky) */
38 #define SHF_READING	0x2000		/* currently reading: rnleft,rp valid */
39 #define SHF_WRITING	0x4000		/* currently writing: wnleft,wp valid */
40 
41 
42 struct shf {
43 	int flags;		/* see SHF_* */
44 	unsigned char *rp;	/* read: current position in buffer */
45 	int rbsize;		/* size of buffer (1 if SHF_UNBUF) */
46 	int rnleft;		/* read: how much data left in buffer */
47 	unsigned char *wp;	/* write: current position in buffer */
48 	int wbsize;		/* size of buffer (0 if SHF_UNBUF) */
49 	int wnleft;		/* write: how much space left in buffer */
50 	unsigned char *buf;	/* buffer */
51 	int fd;			/* file descriptor */
52 	int errno_;		/* saved value of errno after error */
53 	int bsize;		/* actual size of buf */
54 	Area *areap;		/* area shf/buf were allocated in */
55 };
56 
57 extern struct shf shf_iob[];
58 
59 struct shf *shf_open(const char *, int, int, int);
60 struct shf *shf_fdopen(int, int, struct shf *);
61 struct shf *shf_reopen(int, int, struct shf *);
62 struct shf *shf_sopen(char *, int, int, struct shf *);
63 int	    shf_close(struct shf *);
64 int	    shf_fdclose(struct shf *);
65 char	   *shf_sclose(struct shf *);
66 int	    shf_flush(struct shf *);
67 int	    shf_read(char *, int, struct shf *);
68 char	   *shf_getse(char *, int, struct shf *);
69 int	    shf_getchar(struct shf *s);
70 int	    shf_ungetc(int, struct shf *);
71 int	    shf_putchar(int, struct shf *);
72 int	    shf_puts(const char *, struct shf *);
73 int	    shf_write(const char *, int, struct shf *);
74 int	    shf_fprintf(struct shf *, const char *, ...);
75 int	    shf_snprintf(char *, int, const char *, ...);
76 char	    *shf_smprintf(const char *, ...);
77 int	    shf_vfprintf(struct shf *, const char *, va_list);
78 
79 #endif /* SHF_H */
80