1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*
WARNING: This file was generated by dkct.
Changes you make here will be lost if dkct is run again!
You should modify the original source and run dkct on it.
Original source: dk3echo.ctr
*/
/*
Copyright (C) 2011-2017, Dirk Krause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/** @file dk3echo.h Header file for the dk3echo module.
*/
#ifndef DK3ECHO_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3ECHO_H_INCLUDED 1
#line 10 "dk3echo.ctr"
#include "dk3conf.h"
#if DK3_HAVE_TCGETATTR
/** Terminal IO structure.
*/
typedef struct termios dk3_termios_t;
#else
#if defined(TCGETS)
/** Terminal IO structure.
*/
typedef struct termios dk3_termios_t;
#else
#endif
#endif
/** Keyboard echo configuration.
*/
typedef struct {
#if DK3_ON_WINDOWS
/** Handle for console.
*/
HANDLE consoleHandle;
/** Original console flags.
*/
DWORD ori;
#else
/* DK3_ON_WINDOWS */
#if DK3_HAVE_TCGETATTR
/** Original terminal settings.
*/
dk3_termios_t ori;
#else
/* DK3_HAVE_TCGETATTR */
#if defined(TCGETS)
/** Original terminal settings.
*/
dk3_termios_t ori;
#else
/* defined(TCGETS) */
#endif
/* defined(TCGETS) */
#endif
/* DK3_HAVE_TCGETATTR */
#endif
/* DK3_ON_WINDOWS */
/** Flag: Standard input is a terminal.
*/
int is_tty;
} dk3_echo_t;
#ifdef __cplusplus
extern "C" {
#endif
/** Save current keyboard echo settings.
@param ep Keyboard echo settings structure.
@param app Application structure for diagnostics, may be NULL.
@return 1 on success, 0 on error.
*/
int
dk3echo_save_app(dk3_echo_t *ep, dk3_app_t *app);
/** Restore keyboard echo settings.
@param ep Keyboard echo settings structure.
@param app Application structure for diagnostics, may be NULL.
@return 1 on success, 0 on error.
*/
int
dk3echo_restore_app(dk3_echo_t *ep, dk3_app_t *app);
/** Disable keyboard echo.
@param ep Keyboard echo settings structure.
@param app Application structure for diagnostics, may be NULL.
@return 1 on success, 0 on error.
*/
int
dk3echo_off_app(dk3_echo_t *ep, dk3_app_t *app);
/** Check whether standard input is from terminal for settings structure.
@param ep Keyboard echo settings structure.
@param app Application structure for diagnostics, may be NULL.
@return 1 on success, 0 on error.
*/
int
dk3echo_is_tty_app(dk3_echo_t const *ep, dk3_app_t *app);
/** Check whether standard input is from terminal.
@param ep Keyboard echo settings structure.
@param app Application structure for diagnostics, may be NULL.
@return 1 on success, 0 on error.
*/
int
dk3echo_test_tty_app(dk3_echo_t *ep, dk3_app_t *app);
/** Save current keyboard echo settings.
@param ep Keyboard echo settings structure.
@return 1 on success, 0 on error.
*/
int
dk3echo_save(dk3_echo_t *ep);
/** Restore keyboard echo settings.
@param ep Keyboard echo settings structure.
@return 1 on success, 0 on error.
*/
int
dk3echo_restore(dk3_echo_t *ep);
/** Disable keyboard echo.
@param ep Keyboard echo settings structure.
@return 1 on success, 0 on error.
*/
int
dk3echo_off(dk3_echo_t *ep);
/** Check whether standard input is from terminal for settings structure.
@param ep Keyboard echo settings structure.
@return 1 on success, 0 on error.
*/
int
dk3echo_is_tty(dk3_echo_t *ep);
/** Check whether standard input is from terminal.
@param ep Keyboard echo settings structure.
@return 1 on success, 0 on error.
*/
int
dk3echo_test_tty(dk3_echo_t *ep);
#ifdef __cplusplus
}
#endif
#endif
|
