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