# -*- coding: utf-8 -*-
# Copyright (C) 2016, Maximilian Köhl <mail@koehlma.de>
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License version 3 as published by
# the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
from __future__ import absolute_import, division, print_function, unicode_literals
from .. import common, error, handle
from ..library import ffi, lib
from . import stream
[docs]class ConsoleSize(tuple):
def __new__(cls, width, height):
return tuple.__new__(cls, (width, height))
@property
def width(self):
"""
Width of the console.
:readonly:
True
:type:
int
"""
return self[0]
@property
def height(self):
"""
Height of the console.
:readonly:
True
:type:
int
"""
return self[1]
def reset_mode():
"""
To be called when the program exits. Resets TTY settings to default
values for the next process to take over.
This function is async signal-safe on Unix platforms but can fail
with error code UV_EBUSY if you call it when execution is inside
`set_mode()`.
:raises uv.UVError:
error while resetting tty mode
"""
code = lib.uv_tty_reset_mode()
if code != error.StatusCodes.SUCCESS:
raise error.UVError(code)
[docs]class TTYMode(common.Enumeration):
"""
Terminal modes enumeration.
"""
NORMAL = lib.UV_TTY_MODE_NORMAL
"""
Initial normal terminal mode.
:type: uv.TTYMode
"""
RAW = lib.UV_TTY_MODE_RAW
"""
Raw input mode (on windows, `ENABLE_WINDOW_INPUT` is also enabled).
:type: uv.TTYMode
"""
IO = lib.UV_TTY_MODE_IO
"""
Binary-safe IO mode for IPC (Unix only).
:type: uv.TTYMode
"""
@handle.HandleTypes.TTY
[docs]class TTY(stream.UVStream):
"""
Stream interface to the local user terminal console. It allows
using ANSI escape codes across platforms.
:raises uv.UVError:
error while initializing the handle
:param fd:
file descriptor of the console
:param readable:
specifies whether the file descriptor is readable or not
:param loop:
event loop the handle should run on
:param on_read:
callback which should be called when data has been read
:type fd:
int
:type readable:
bool
:type loop:
uv.Loop
:type on_read:
((uv.TTY, uv.StatusCodes, bytes) -> None) |
((Any, uv.TTY, uv.StatusCodes, bytes) -> None)
"""
__slots__ = ['uv_tty']
uv_handle_type = 'uv_tty_t*'
uv_handle_init = lib.cross_uv_tty_init
def __init__(self, fd, readable=False, loop=None, on_read=None):
super(TTY, self).__init__(loop, False, (fd, int(readable)), on_read, None)
self.uv_tty = self.base_handle.uv_object
@property
def console_size(self):
"""
Current size of the console.
:raises uv.UVError:
error while getting console size
:rtype:
ConsoleSize
"""
if self.closing:
return ConsoleSize(0, 0)
c_with, c_height = ffi.new('int*'), ffi.new('int*')
code = lib.uv_tty_get_winsize(self.uv_tty, c_with, c_height)
if code != error.StatusCodes.SUCCESS:
raise error.UVError(code)
return ConsoleSize(c_with[0], c_height[0])
[docs] def set_mode(self, mode=TTYMode.NORMAL):
"""
Set the the specified terminal mode.
:raises uv.UVError:
error while setting mode
:raises uv.ClosedHandleError:
handle has already been closed or is closing
:param mode:
mode to set
:type mode:
uv.TTYMode
"""
if self.closing:
raise error.ClosedHandleError()
code = lib.uv_tty_set_mode(self.uv_tty, mode)
if code != error.StatusCodes.SUCCESS:
raise error.UVError(code)
@property
def family(self):
return None