JSYSTEM::JKeypress Class Reference

Enable unbuffered terminal input. More...

#include <JKeypress.hh>

Public Member Functions
	JKeypress (const bool echo=true)
	Constructor. More...
	~JKeypress ()
	Destructor. More...
char	get ()
	Get single character. More...
bool	timeout (JTimeval timeout)
	Timeout method. More...

Private Member Functions
	JKeypress (const JKeypress &)
	JKeypress (JKeypress &&)
JKeypress &	operator= (const JKeypress &)
JKeypress &	operator= (JKeypress &&)

Private Attributes
termios	termcap
JFileDescriptorMask	mask

Detailed Description

Enable unbuffered terminal input.

Definition at line 32 of file JKeypress.hh.

Constructor & Destructor Documentation

JSYSTEM::JKeypress::JKeypress ( const bool  echo = true )

inline

Constructor.

The settings are modified by the constructor and the original settings are reset by the destructor.

Parameters

echo	enable/disable echo of input character

Definition at line 42 of file JKeypress.hh.

    {
      tcgetattr(STDIN_FILENO, &termcap);

      termios buffer = termcap;

      // Disable canonical mode, and set buffer size to 1 byte.
 
      buffer.c_lflag     &= ~ICANON;
      buffer.c_lflag     &= (echo ? ECHO : ~ECHO);
      buffer.c_cc[VTIME]  = 0;
      buffer.c_cc[VMIN]   = 1;

      tcsetattr(STDIN_FILENO, TCSANOW, &buffer);
    }

JSYSTEM::JKeypress::~JKeypress ( )

inline

Destructor.

Definition at line 62 of file JKeypress.hh.

    {
      tcsetattr(STDIN_FILENO, TCSANOW, &termcap);
    }

JSYSTEM::JKeypress::JKeypress ( const JKeypress &  )

private

JSYSTEM::JKeypress::JKeypress ( JKeypress &&  )

private

Member Function Documentation

char JSYSTEM::JKeypress::get ( )

inline

Get single character.

This method returns as soon as input from terminal is available.

Returns

character

Definition at line 74 of file JKeypress.hh.

    {
      char c;

      ::read(STDIN_FILENO, &c, 1);

      return c;
    }

bool JSYSTEM::JKeypress::timeout ( JTimeval  timeout )

inline

Timeout method.

This method returns immediatly if input from terminal is available, else after the specified timeout period.

Parameters

timeout

timeout

Returns

true if input available; else false

Definition at line 92 of file JKeypress.hh.

    {
      mask.set(STDIN_FILENO);
      
      return mask.in_avail(timeout);
    }

JKeypress& JSYSTEM::JKeypress::operator= ( const JKeypress &  )

private

JKeypress& JSYSTEM::JKeypress::operator= ( JKeypress &&  )

private

Member Data Documentation

termios JSYSTEM::JKeypress::termcap

private

Definition at line 101 of file JKeypress.hh.

JFileDescriptorMask JSYSTEM::JKeypress::mask

private

Definition at line 102 of file JKeypress.hh.

---

The documentation for this class was generated from the following file:

• JKeypress.hh