enablevtmode.py

Go to the documentation of this file.

 
 
 
STD_OUTPUT_HANDLE = -11
 
ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004
 
 
originalConsoleMode = None
 
# Try to import ctypes and get the kernel32 DLL.  If neither is possible, the
# rest of the code in this module does nothing.
try:
    import ctypes
    kernel32 = ctypes.windll.kernel32
except:
    # ctypes does not exist, assume not on Windows
    kernel32 = None
 
 
def _SetVTMode() -> None:
    if kernel32:
        global originalConsoleMode
        stdOutput = kernel32.GetStdHandle(STD_OUTPUT_HANDLE)
        oldMode = ctypes.c_uint32(0)
        if kernel32.GetConsoleMode(stdOutput, ctypes.byref(oldMode)):
            originalConsoleMode = oldMode.value
            newMode = originalConsoleMode | ENABLE_VIRTUAL_TERMINAL_PROCESSING
            kernel32.SetConsoleMode(stdOutput, newMode)
 
 
 
def _RestoreVTMode() -> None:
    if kernel32 and originalConsoleMode is not None:
        stdOutput = kernel32.GetStdHandle(STD_OUTPUT_HANDLE)
        kernel32.SetConsoleMode(stdOutput, originalConsoleMode)
 
 
 
def EnableVTMode(function : callable):
    _SetVTMode()
    try:
        return function()
    finally:
        _RestoreVTMode()