]> git.ipfire.org Git - thirdparty/bash.git/blob - input.h
Imported from ../bash-2.05.tar.gz.
[thirdparty/bash.git] / input.h
1 /* input.h -- Structures and unions used for reading input. */
2 /* Copyright (C) 1993 Free Software Foundation, Inc.
3
4 This file is part of GNU Bash, the Bourne Again SHell.
5
6 Bash is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
9 version.
10
11 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License along
17 with Bash; see the file COPYING. If not, write to the Free Software
18 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
19
20 #if !defined (_INPUT_H_)
21 #define _INPUT_H_
22
23 #include "stdc.h"
24
25 /* Function pointers can be declared as (Function *)foo. */
26 #if !defined (_FUNCTION_DEF)
27 # define _FUNCTION_DEF
28 typedef int Function ();
29 typedef void VFunction ();
30 typedef char *CPFunction ();
31 typedef char **CPPFunction ();
32 #endif /* _FUNCTION_DEF */
33
34 enum stream_type {st_none, st_stdin, st_stream, st_string, st_bstream};
35
36 #if defined (BUFFERED_INPUT)
37
38 /* Possible values for b_flag. */
39 #undef B_EOF
40 #undef B_ERROR /* There are some systems with this define */
41 #undef B_UNBUFF
42
43 #define B_EOF 0x01
44 #define B_ERROR 0x02
45 #define B_UNBUFF 0x04
46 #define B_WASBASHINPUT 0x08
47
48 /* A buffered stream. Like a FILE *, but with our own buffering and
49 synchronization. Look in input.c for the implementation. */
50 typedef struct BSTREAM
51 {
52 int b_fd;
53 char *b_buffer; /* The buffer that holds characters read. */
54 size_t b_size; /* How big the buffer is. */
55 int b_used; /* How much of the buffer we're using, */
56 int b_flag; /* Flag values. */
57 int b_inputp; /* The input pointer, index into b_buffer. */
58 } BUFFERED_STREAM;
59
60 #if 0
61 extern BUFFERED_STREAM **buffers;
62 #endif
63
64 extern int default_buffered_input;
65
66 #endif /* BUFFERED_INPUT */
67
68 typedef union {
69 FILE *file;
70 char *string;
71 #if defined (BUFFERED_INPUT)
72 int buffered_fd;
73 #endif
74 } INPUT_STREAM;
75
76 typedef struct {
77 enum stream_type type;
78 char *name;
79 INPUT_STREAM location;
80 Function *getter;
81 Function *ungetter;
82 } BASH_INPUT;
83
84 extern BASH_INPUT bash_input;
85
86 /* Functions from parse.y. */
87 extern void initialize_bash_input __P((void));
88 extern void init_yy_io __P((Function *, Function *, enum stream_type, char *, INPUT_STREAM));
89 extern void with_input_from_stdin __P((void));
90 extern void with_input_from_string __P((char *, char *));
91 extern void with_input_from_stream __P((FILE *, char *));
92 extern void push_stream __P((int));
93 extern void pop_stream __P((void));
94 extern int stream_on_stack __P((enum stream_type));
95 extern char *read_secondary_line __P((int));
96 extern int find_reserved_word __P((char *));
97 extern char *decode_prompt_string __P((char *));
98 extern void gather_here_documents __P((void));
99 extern void execute_prompt_command __P((char *));
100
101 extern int *save_token_state __P((void));
102 extern void restore_token_state __P((int *));
103
104 /* Functions from input.c */
105 extern int getc_with_restart ();
106 extern int ungetc_with_restart ();
107
108 #if defined (BUFFERED_INPUT)
109 /* Functions from input.c. */
110 extern int fd_is_bash_input __P((int));
111 extern int set_bash_input_fd __P((int));
112 extern int save_bash_input __P((int, int));
113 extern int check_bash_input __P((int));
114 extern int duplicate_buffered_stream __P((int, int));
115 extern BUFFERED_STREAM *fd_to_buffered_stream __P((int));
116 extern BUFFERED_STREAM *set_buffered_stream __P((int, BUFFERED_STREAM *));
117 extern BUFFERED_STREAM *open_buffered_stream __P((char *));
118 extern void free_buffered_stream __P((BUFFERED_STREAM *));
119 extern int close_buffered_stream __P((BUFFERED_STREAM *));
120 extern int close_buffered_fd __P((int));
121 extern int sync_buffered_stream __P((int));
122 extern int buffered_getchar __P((void));
123 extern int buffered_ungetchar __P((int));
124 extern void with_input_from_buffered_stream __P((int, char *));
125 #endif /* BUFFERED_INPUT */
126
127 #endif /* _INPUT_H_ */