cosmos::Terminal Class Reference

Access to Terminal information and ioctls. More...

#include <Terminal.hxx>

Public Member Functions
	Terminal (FileDescriptor fd)
	Terminal (const FileBase &f)
void	setFD (const FileBase &f)
void	setFD (FileDescriptor fd)
bool	isTTY () const
	Returns whether the associated file descriptor is a TTY.
TermDimension	getSize () const
	Returns the terminal dimension in character width x height.
void	setSize (const TermDimension dim)
	Sets the terminal dimension according to the given values.
void	sendBreak (const std::chrono::milliseconds ms)
	Sends a stream of zero bits for a certain duration.
void	makeControllingTerminal (bool force=false)
	Attempt to make the terminal the controlling terminal of the current process.

Protected Member Functions
int	rawFD () const

Protected Attributes
FileDescriptor	m_fd

Detailed Description

Access to Terminal information and ioctls.

This simply wraps a FileDescriptor for performing terminal related ioctls on it. It will not take ownership of the file descriptor i.e. it will never be closed by this class.

Definition at line 43 of file Terminal.hxx.

Constructor & Destructor Documentation

Terminal() [1/3]

cosmos::Terminal::Terminal ( )

inline

Definition at line 45 of file Terminal.hxx.

{}

Terminal() [2/3]

cosmos::Terminal::Terminal ( FileDescriptor fd )

inlineexplicit

Definition at line 46 of file Terminal.hxx.

: m_fd(fd) {}

Terminal() [3/3]

cosmos::Terminal::Terminal ( const FileBase & f )

inlineexplicit

Definition at line 47 of file Terminal.hxx.

: m_fd(f.fd()) {}

Member Function Documentation

getSize()

TermDimension cosmos::Terminal::getSize

(

)

const

Returns the terminal dimension in character width x height.

Definition at line 33 of file Terminal.cxx.

                                      {
        TermDimension ws;
        int rc = ::ioctl(rawFD(), TIOCGWINSZ, &ws);
        if (rc != 0) {
                cosmos_throw (ApiError("ioctl(GWINSZ)"));
        }
 
        return ws;
}

isTTY()

bool cosmos::Terminal::isTTY

(

)

const

Returns whether the associated file descriptor is a TTY.

Definition at line 20 of file Terminal.cxx.

                           {
        if (::isatty(rawFD()) == 1) {
                return true;
        }
 
        switch (get_errno()) {
                case Errno::NOT_A_TTY: break;
                default: cosmos_throw (ApiError("isatty:"));
        }
 
        return false;
}

makeControllingTerminal()

void cosmos::Terminal::makeControllingTerminal

(

bool

force = false

)

Attempt to make the terminal the controlling terminal of the current process.

This only works if the current process is a session leader and does not yet have a controlling terminal.

If the caller has CAP_SYS_ADMIN capability and force is true then the terminal is "stolen" and all processes that had this terminal as controlling terminal before, lose it.

On error an exception is thrown by this call.

Definition at line 56 of file Terminal.cxx.

                                                 {
        int rc = ::ioctl(rawFD(), TIOCSCTTY, force ? 1 : 0);
        if (rc != 0) {
                cosmos_throw (ApiError("ioctl(TIOCSCTTY)"));
        }
}

rawFD()

int cosmos::Terminal::rawFD ( ) const

protected

Definition at line 16 of file Terminal.cxx.

                          {
        return to_integral(m_fd.raw());
}

sendBreak()

void cosmos::Terminal::sendBreak

(

const std::chrono::milliseconds

ms

)

Sends a stream of zero bits for a certain duration.

If ms is zero then the stream will last between 0.25 and 0.50 seconds. If it is non-zero then the stream will last for an implementation defined time (on Linux the given duration in milliseconds).

Definition at line 50 of file Terminal.cxx.

                                                       {
        if (::tcsendbreak(rawFD(), static_cast<int>(ms.count())) != 0) {
                cosmos_throw (ApiError("tcsendbreak"));
        }
}

setFD() [1/2]

void cosmos::Terminal::setFD ( const FileBase & f )

inline

Definition at line 49 of file Terminal.hxx.

                                      {
                m_fd = f.fd();
        }

setFD() [2/2]

void cosmos::Terminal::setFD ( FileDescriptor fd )

inline

Definition at line 53 of file Terminal.hxx.

                                      {
                m_fd = fd;
        }

setSize()

void cosmos::Terminal::setSize

(

const TermDimension

dim

)

Sets the terminal dimension according to the given values.

Definition at line 43 of file Terminal.cxx.

                                              {
        int rc = ::ioctl(rawFD(), TIOCSWINSZ, &dim);
        if (rc != 0) {
                cosmos_throw (ApiError("ioctl(SWINSZ)"));
        }
}

Member Data Documentation

m_fd

FileDescriptor cosmos::Terminal::m_fd

protected

Definition at line 93 of file Terminal.hxx.

---

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

• include/io/Terminal.hxx
• src/io/Terminal.cxx