Qore Programming Language Reference Manual  1.8.0
QC_TermIOS.dox.h
1 
3 namespace Qore {
5 
45 class TermIOS {
46 
47 public:
49 
61 
62 public:
64 
72  copy();
73 
74 public:
76 
93 int getCC(softint cc);
94 
95 public:
97 
107 int getCFlag();
108 
109 public:
111 
121 int getIFlag();
122 
123 public:
125 
135 int getLFlag();
136 
137 public:
139 
149 int getOFlag();
150 
151 public:
153 
167 bool isEqual(Termios termios);
168 
169 public:
171 
188 nothing setCC(softint offset, softint value);
189 
190 public:
192 
205 nothing setCFlag(softint flag);
206 
207 public:
209 
222 nothing setIFlag(softint flag);
223 
224 public:
226 
243 nothing setLFlag(softint flag);
244 
245 public:
247 
260 nothing setOFlag(softint flag);
261 
262 public:
264 
283 };
287 
292  const ECHO = ECHO;
294  const ECHOCTL = ECHOCTL;
296  const ECHOE = ECHOE;
298  const ECHOKE = ECHOKE;
300  const ECHONL = ECHONL;
302  const ECHOPRT = ECHOPRT;
304  const EXTPROC = EXTPROC;
306  const FLUSHO = FLUSHO;
308  const ICANON = ICANON;
310  const IEXTEN = IEXTEN;
312  const ISIG = ISIG;
314  const NOFLSH = NOFLSH;
318  const PENDIN = PENDIN;
320  const TOSTOP = TOSTOP;
325 
334  const CLOCAL = CLOCAL;
336  const CREAD = CREAD;
338  const CRTSCTS = CRTSCTS;
342  const CS5 = CS5;
344  const CS6 = CS6;
346  const CS7 = CS7;
348  const CS8 = CS8;
350  const CSIZE = CSIZE;
352  const CSTOPB = CSTOPB;
354  const HUPCL = HUPCL;
356  const MDMBUF = MDMBUF;
358  const PARENB = PARENB;
360  const PARODD = PARODD;
365 
368  const OCRNL = OCRNL;
370  const OLCUC = OLCUC;
372  const ONLCR = ONLCR;
374  const ONLRET = ONLRET;
376  const ONOCR = ONOCR;
378  const ONOEOT = ONOEOT;
380  const OPOST = OPOST;
382  const OXTABS = OXTABS;
387 
390  const BRKINT = BRKINT;
392  const ICRNL = ICRNL;
394  const IGNBRK = IGNBRK;
396  const IGNCR = IGNCR;
398  const IGNPAR = IGNPAR;
400  const IMAXBEL = IMAXBEL;
402  const INLCR = INLCR;
404  const INPCK = INPCK;
406  const ISTRIP = ISTRIP;
408  const IUCLC = IUCLC;
410  const IXANY = IXANY;
412  const IXOFF = IXOFF;
414  const IXON = IXON;
416  const PARMRK = PARMRK;
421 
426  const VDSUSP = VDSUSP;
428  const VEOF = VEOF;
430  const VEOL = VEOL;
432  const VEOL2 = VEOL2;
434  const VERASE = VERASE;
436  const VINTR = VINTR;
438  const VKILL = VKILL;
440  const VLNEXT = VLNEXT;
442  const VMIN = VMIN;
444  const VQUIT = VQUIT;
448  const VSTART = VSTART;
450  const VSTATUS = VSTATUS;
452  const VSTOP = VSTOP;
454  const VSUSP = VSUSP;
456  const VTIME = VTIME;
458  const VWERASE = VWERASE;
465 
472  const TCSANOW = TCSANOW;
476 }
This class allows Qore scripts to get or set terminal settings on UNIX platforms.
Definition: QC_TermIOS.dox.h:45
int getLFlag()
Returns the local mode flag for the object.
int getCC(softint cc)
Returns the integer value for the given control character from the given control character code.
nothing setLFlag(softint flag)
Sets the local mode flag for the object from a mask of Terminal Attribute Local Mode Constants.
static hash getWindowSize()
Returns a hash giving the current terminal window size in hash keys "rows" and "columns".
int getIFlag()
Returns the input mode flag for the object.
nothing setIFlag(softint flag)
Sets the input mode flag for the object from a mask of Terminal Attributes Input Mode Constants.
bool isEqual(Termios termios)
Returns True if the TermIOS object passed as an argument is equal to the current object; False if not...
nothing setOFlag(softint flag)
Sets the output mode flag for the object from a mask of Terminal Attributes Output Mode Constants.
nothing setCFlag(softint flag)
Sets the control mode flag for the object from a mask of Terminal Attribute Control Mode Constants.
constructor()
Creates the TermIOS object with random contents.
int getCFlag()
Returns the control mode flag for the object.
int getOFlag()
Returns the output mode flag for the object.
nothing setCC(softint offset, softint value)
Sets the value of the given control character.
copy()
Returns a copy of the object.
const VWERASE
subscript for the VWERASE character
Definition: QC_TermIOS.dox.h:458
const VERASE
subscript for the VERASE character
Definition: QC_TermIOS.dox.h:434
const VEOL2
subscript for the EOL2 character
Definition: QC_TermIOS.dox.h:432
const VLNEXT
subscript for the VLNEXT character
Definition: QC_TermIOS.dox.h:440
const VREPRINT
subscript for the VREPRINT character
Definition: QC_TermIOS.dox.h:446
const VSTATUS
subscript for the character
Definition: QC_TermIOS.dox.h:450
const VSUSP
subscript for the VSUSP character
Definition: QC_TermIOS.dox.h:454
const VSTART
subscript for the VSTART character
Definition: QC_TermIOS.dox.h:448
const VEOL
subscript for the EOL character
Definition: QC_TermIOS.dox.h:430
const VTIME
subscript for the VTIME value
Definition: QC_TermIOS.dox.h:456
const VDISCARD
subscript for the VDISCARD character
Definition: QC_TermIOS.dox.h:424
const VKILL
subscript for the VKILL character
Definition: QC_TermIOS.dox.h:438
const VQUIT
subscript for the VQUIT character
Definition: QC_TermIOS.dox.h:444
const VSTOP
subscript for the VSTOP character
Definition: QC_TermIOS.dox.h:452
const VEOF
subscript for the EOF character
Definition: QC_TermIOS.dox.h:428
const _POSIX_VDISABLE
if the value of any key is this value, it means that the key is disabled
Definition: QC_TermIOS.dox.h:460
const VDSUSP
subscript for the VDSUSP character
Definition: QC_TermIOS.dox.h:426
const VINTR
subscript for the VINTR character
Definition: QC_TermIOS.dox.h:436
const VMIN
subscript for the VMIN value
Definition: QC_TermIOS.dox.h:442
const MDMBUF
old name for CCAR_OFLOW
Definition: QC_TermIOS.dox.h:356
const CLOCAL
ignore modem status lines
Definition: QC_TermIOS.dox.h:334
const CSIZE
character size mask
Definition: QC_TermIOS.dox.h:350
const CS8
character size mask: 8 bits
Definition: QC_TermIOS.dox.h:348
const CSTOPB
send 2 stop bits
Definition: QC_TermIOS.dox.h:352
const CCAR_OFLOW
DCD flow control of output.
Definition: QC_TermIOS.dox.h:328
const CS7
character size mask: 7 bits
Definition: QC_TermIOS.dox.h:346
const CCTS_OFLOW
CTS flow control of output.
Definition: QC_TermIOS.dox.h:330
const PARENB
parity enable
Definition: QC_TermIOS.dox.h:358
const HUPCL
hang up on last close
Definition: QC_TermIOS.dox.h:354
const CDSR_OFLOW
DSR flow control of output.
Definition: QC_TermIOS.dox.h:332
const CRTSCTS
CTS flow control of output and RTS flow control of input.
Definition: QC_TermIOS.dox.h:338
const CS6
character size mask: 6 bits
Definition: QC_TermIOS.dox.h:344
const CREAD
enable receiver
Definition: QC_TermIOS.dox.h:336
const PARODD
odd parity, else even
Definition: QC_TermIOS.dox.h:360
const CS5
character size mask: 5 bits
Definition: QC_TermIOS.dox.h:342
const CRTS_IFLOW
RTS flow control of input.
Definition: QC_TermIOS.dox.h:340
const IXON
enable output flow control
Definition: QC_TermIOS.dox.h:414
const INLCR
map NL into CR
Definition: QC_TermIOS.dox.h:402
const INPCK
enable checking of parity errors
Definition: QC_TermIOS.dox.h:404
const IXANY
any char will restart after stop
Definition: QC_TermIOS.dox.h:410
const IGNCR
ignore CR
Definition: QC_TermIOS.dox.h:396
const IMAXBEL
ring bell on input queue full
Definition: QC_TermIOS.dox.h:400
const IXOFF
enable input flow control
Definition: QC_TermIOS.dox.h:412
const ISTRIP
strip 8th bit off chars
Definition: QC_TermIOS.dox.h:406
const IGNBRK
ignore BREAK condition
Definition: QC_TermIOS.dox.h:394
const ICRNL
map CR to NL (ala CRMOD)
Definition: QC_TermIOS.dox.h:392
const BRKINT
map BREAK to SIGINTR
Definition: QC_TermIOS.dox.h:390
const IGNPAR
ignore (discard) parity errors
Definition: QC_TermIOS.dox.h:398
const PARMRK
mark parity and framing errors
Definition: QC_TermIOS.dox.h:416
const ECHO
enable echoing
Definition: QC_TermIOS.dox.h:292
const ALTWERASE
use alternate WERASE algorithm
Definition: QC_TermIOS.dox.h:290
const ECHONL
echo NL even if ECHO is off
Definition: QC_TermIOS.dox.h:300
const FLUSHO
output being flushed (state)
Definition: QC_TermIOS.dox.h:306
const ECHOKE
visual erase for line kill
Definition: QC_TermIOS.dox.h:298
const NOFLSH
don't flush after interrupt
Definition: QC_TermIOS.dox.h:314
const ECHOE
visually erase chars
Definition: QC_TermIOS.dox.h:296
const ECHOCTL
echo control chars as ^(Char)
Definition: QC_TermIOS.dox.h:294
const TOSTOP
stop background jobs from output
Definition: QC_TermIOS.dox.h:320
const IEXTEN
enable DISCARD and LNEXT
Definition: QC_TermIOS.dox.h:310
const ECHOPRT
visual erase mode for hardcopy
Definition: QC_TermIOS.dox.h:302
const ISIG
enable signals INTR, QUIT, [D]SUSP
Definition: QC_TermIOS.dox.h:312
const PENDIN
retype pending input (state)
Definition: QC_TermIOS.dox.h:318
const EXTPROC
external processing
Definition: QC_TermIOS.dox.h:304
const NOKERNINFO
no kernel output from VSTATUS
Definition: QC_TermIOS.dox.h:316
const ICANON
canonicalize input lines
Definition: QC_TermIOS.dox.h:308
const ONOCR
no CR output at column 0
Definition: QC_TermIOS.dox.h:376
const OPOST
enable following output processing
Definition: QC_TermIOS.dox.h:380
const ONOEOT
discard EOT's (^D) on output
Definition: QC_TermIOS.dox.h:378
const OXTABS
expand tabs to spaces
Definition: QC_TermIOS.dox.h:382
const ONLRET
NL performs CR function.
Definition: QC_TermIOS.dox.h:374
const OCRNL
map CR to NL on output
Definition: QC_TermIOS.dox.h:368
const ONLCR
map NL to CR-NL (ala CRMOD)
Definition: QC_TermIOS.dox.h:372
const TCSANOW
make change immediate
Definition: QC_TermIOS.dox.h:472
const TCSASOFT
flag - don't alter hardware state
Definition: QC_TermIOS.dox.h:474
const TCSADRAIN
drain output, then change
Definition: QC_TermIOS.dox.h:468
const TCSAFLUSH
drain output, flush input
Definition: QC_TermIOS.dox.h:470
hash< auto > hash(object obj)
Returns a hash of an object's members.
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3