2021-02-01 10:40:03 +00:00
|
|
|
# Copyright 2015-2021 Espressif Systems (Shanghai) CO LTD
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
import ctypes
|
|
|
|
import os
|
|
|
|
import re
|
|
|
|
import sys
|
|
|
|
from io import TextIOBase
|
2021-05-14 09:20:38 +00:00
|
|
|
from typing import Any, Optional, TextIO, Union
|
2021-02-01 10:40:03 +00:00
|
|
|
|
|
|
|
from .output_helpers import ANSI_NORMAL
|
|
|
|
|
|
|
|
STD_OUTPUT_HANDLE = -11
|
|
|
|
STD_ERROR_HANDLE = -12
|
|
|
|
|
|
|
|
# wincon.h values
|
|
|
|
FOREGROUND_INTENSITY = 8
|
|
|
|
FOREGROUND_GREY = 7
|
|
|
|
|
|
|
|
# matches the ANSI color change sequences that IDF sends
|
|
|
|
RE_ANSI_COLOR = re.compile(b'\033\\[([01]);3([0-7])m')
|
|
|
|
|
|
|
|
# list mapping the 8 ANSI colors (the indexes) to Windows Console colors
|
|
|
|
ANSI_TO_WINDOWS_COLOR = [0, 4, 2, 6, 1, 5, 3, 7]
|
|
|
|
|
|
|
|
if os.name == 'nt':
|
|
|
|
GetStdHandle = ctypes.windll.kernel32.GetStdHandle # type: ignore
|
|
|
|
SetConsoleTextAttribute = ctypes.windll.kernel32.SetConsoleTextAttribute # type: ignore
|
|
|
|
|
|
|
|
|
2021-04-15 16:51:25 +00:00
|
|
|
def get_converter(orig_output_method=None, decode_output=False):
|
2021-05-14 09:20:38 +00:00
|
|
|
# type: (Any[TextIO, Optional[TextIOBase]], bool) -> Union[ANSIColorConverter, Optional[TextIOBase]]
|
2021-04-15 16:51:25 +00:00
|
|
|
"""
|
|
|
|
Returns an ANSIColorConverter on Windows and the original output method (orig_output_method) on other platforms.
|
|
|
|
The ANSIColorConverter with decode_output=True will decode the bytes before passing them to the output.
|
|
|
|
"""
|
|
|
|
if os.name == 'nt':
|
|
|
|
return ANSIColorConverter(orig_output_method, decode_output)
|
|
|
|
return orig_output_method
|
|
|
|
|
|
|
|
|
2021-02-01 10:40:03 +00:00
|
|
|
class ANSIColorConverter(object):
|
|
|
|
"""Class to wrap a file-like output stream, intercept ANSI color codes,
|
|
|
|
and convert them into calls to Windows SetConsoleTextAttribute.
|
|
|
|
|
|
|
|
Doesn't support all ANSI terminal code escape sequences, only the sequences IDF uses.
|
|
|
|
|
|
|
|
Ironically, in Windows this console output is normally wrapped by winpty which will then detect the console text
|
|
|
|
color changes and convert these back to ANSI color codes for MSYS' terminal to display. However this is the
|
|
|
|
least-bad working solution, as winpty doesn't support any "passthrough" mode for raw output.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, output=None, decode_output=False):
|
|
|
|
# type: (TextIOBase, bool) -> None
|
|
|
|
self.output = output
|
|
|
|
self.decode_output = decode_output
|
|
|
|
self.handle = GetStdHandle(STD_ERROR_HANDLE if self.output == sys.stderr else STD_OUTPUT_HANDLE)
|
|
|
|
self.matched = b''
|
|
|
|
|
|
|
|
def _output_write(self, data): # type: (Union[str, bytes]) -> None
|
|
|
|
try:
|
|
|
|
if self.decode_output:
|
|
|
|
self.output.write(data.decode()) # type: ignore
|
|
|
|
else:
|
|
|
|
self.output.write(data) # type: ignore
|
|
|
|
except (IOError, OSError):
|
|
|
|
# Windows 10 bug since the Fall Creators Update, sometimes writing to console randomly throws
|
|
|
|
# an exception (however, the character is still written to the screen)
|
|
|
|
# Ref https://github.com/espressif/esp-idf/issues/1163
|
|
|
|
#
|
|
|
|
# Also possible for Windows to throw an OSError error if the data is invalid for the console
|
|
|
|
# (garbage bytes, etc)
|
|
|
|
pass
|
|
|
|
except UnicodeDecodeError:
|
|
|
|
# In case of double byte Unicode characters display '?'
|
|
|
|
self.output.write('?') # type: ignore
|
|
|
|
|
|
|
|
def write(self, data): # type: ignore
|
|
|
|
if isinstance(data, bytes):
|
|
|
|
data = bytearray(data)
|
|
|
|
else:
|
|
|
|
data = bytearray(data, 'utf-8')
|
|
|
|
for b in data:
|
|
|
|
b = bytes([b])
|
|
|
|
length = len(self.matched)
|
|
|
|
if b == b'\033': # ESC
|
|
|
|
self.matched = b
|
|
|
|
elif (length == 1 and b == b'[') or (1 < length < 7):
|
|
|
|
self.matched += b
|
|
|
|
if self.matched == ANSI_NORMAL.encode('latin-1'): # reset console
|
|
|
|
# Flush is required only with Python3 - switching color before it is printed would mess up the console
|
|
|
|
self.flush()
|
|
|
|
SetConsoleTextAttribute(self.handle, FOREGROUND_GREY)
|
|
|
|
self.matched = b''
|
|
|
|
elif len(self.matched) == 7: # could be an ANSI sequence
|
|
|
|
m = re.match(RE_ANSI_COLOR, self.matched)
|
|
|
|
if m is not None:
|
|
|
|
color = ANSI_TO_WINDOWS_COLOR[int(m.group(2))]
|
|
|
|
if m.group(1) == b'1':
|
|
|
|
color |= FOREGROUND_INTENSITY
|
|
|
|
# Flush is required only with Python3 - switching color before it is printed would mess up the console
|
|
|
|
self.flush()
|
|
|
|
SetConsoleTextAttribute(self.handle, color)
|
|
|
|
else:
|
|
|
|
self._output_write(self.matched) # not an ANSI color code, display verbatim
|
|
|
|
self.matched = b''
|
|
|
|
else:
|
|
|
|
self._output_write(b)
|
|
|
|
self.matched = b''
|
|
|
|
|
|
|
|
def flush(self): # type: () -> None
|
|
|
|
try:
|
|
|
|
self.output.flush() # type: ignore
|
|
|
|
except OSError:
|
|
|
|
# Account for Windows Console refusing to accept garbage bytes (serial noise, etc)
|
|
|
|
pass
|