[people/ms/u-boot.git] / tools / patman / terminal.py

# Copyright (c) 2011 The Chromium OS Authors.
#
# See file CREDITS for list of people who contributed to this
# project.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA
#

"""Terminal utilities

This module handles terminal interaction including ANSI color codes.
"""

import os
import sys

# Selection of when we want our output to be colored
COLOR_IF_TERMINAL, COLOR_ALWAYS, COLOR_NEVER = range(3)

class Color(object):
  """Conditionally wraps text in ANSI color escape sequences."""
  BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)
  BOLD = -1
  COLOR_START = '\033[1;%dm'
  BOLD_START = '\033[1m'
  RESET = '\033[0m'

  def __init__(self, colored=COLOR_IF_TERMINAL):
    """Create a new Color object, optionally disabling color output.

    Args:
      enabled: True if color output should be enabled. If False then this
        class will not add color codes at all.
    """
    self._enabled = (colored == COLOR_ALWAYS or
        (colored == COLOR_IF_TERMINAL and os.isatty(sys.stdout.fileno())))

  def Start(self, color):
    """Returns a start color code.

    Args:
      color: Color to use, .e.g BLACK, RED, etc.

    Returns:
      If color is enabled, returns an ANSI sequence to start the given color,
      otherwise returns empty string
    """
    if self._enabled:
      return self.COLOR_START % (color + 30)
    return ''

  def Stop(self):
    """Retruns a stop color code.

    Returns:
      If color is enabled, returns an ANSI color reset sequence, otherwise
      returns empty string
    """
    if self._enabled:
      return self.RESET
    return ''

  def Color(self, color, text):
    """Returns text with conditionally added color escape sequences.

    Keyword arguments:
      color: Text color -- one of the color constants defined in this class.
      text: The text to color.

    Returns:
      If self._enabled is False, returns the original text. If it's True,
      returns text with color escape sequences based on the value of color.
    """
    if not self._enabled:
      return text
    if color == self.BOLD:
      start = self.BOLD_START
    else:
      start = self.COLOR_START % (color + 30)
    return start + text + self.RESET
Commit	Line	Data
0d24de9d SG	1	# Copyright (c) 2011 The Chromium OS Authors.
	2	#
	3	# See file CREDITS for list of people who contributed to this
	4	# project.
	5	#
	6	# This program is free software; you can redistribute it and/or
	7	# modify it under the terms of the GNU General Public License as
	8	# published by the Free Software Foundation; either version 2 of
	9	# the License, or (at your option) any later version.
	10	#
	11	# This program is distributed in the hope that it will be useful,
	12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	# GNU General Public License for more details.
	15	#
	16	# You should have received a copy of the GNU General Public License
	17	# along with this program; if not, write to the Free Software
	18	# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	19	# MA 02111-1307 USA
	20	#
	21
	22	"""Terminal utilities
	23
	24	This module handles terminal interaction including ANSI color codes.
	25	"""
	26
bbd01435 SG	27	import os
	28	import sys
	29
	30	# Selection of when we want our output to be colored
	31	COLOR_IF_TERMINAL, COLOR_ALWAYS, COLOR_NEVER = range(3)
	32
0d24de9d SG	33	class Color(object):
	34	"""Conditionally wraps text in ANSI color escape sequences."""
	35	BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)
	36	BOLD = -1
	37	COLOR_START = '\033[1;%dm'
	38	BOLD_START = '\033[1m'
	39	RESET = '\033[0m'
	40
bbd01435	41	def __init__(self, colored=COLOR_IF_TERMINAL):
0d24de9d SG	42	"""Create a new Color object, optionally disabling color output.
	43
	44	Args:
	45	enabled: True if color output should be enabled. If False then this
	46	class will not add color codes at all.
	47	"""
bbd01435 SG	48	self._enabled = (colored == COLOR_ALWAYS or
bbd01435 SG	49	(colored == COLOR_IF_TERMINAL and os.isatty(sys.stdout.fileno())))
0d24de9d SG	50
	51	def Start(self, color):
	52	"""Returns a start color code.
	53
	54	Args:
	55	color: Color to use, .e.g BLACK, RED, etc.
	56
	57	Returns:
	58	If color is enabled, returns an ANSI sequence to start the given color,
	59	otherwise returns empty string
	60	"""
	61	if self._enabled:
	62	return self.COLOR_START % (color + 30)
	63	return ''
	64
	65	def Stop(self):
	66	"""Retruns a stop color code.
	67
	68	Returns:
	69	If color is enabled, returns an ANSI color reset sequence, otherwise
	70	returns empty string
	71	"""
	72	if self._enabled:
	73	return self.RESET
	74	return ''
	75
	76	def Color(self, color, text):
	77	"""Returns text with conditionally added color escape sequences.
	78
	79	Keyword arguments:
	80	color: Text color -- one of the color constants defined in this class.
	81	text: The text to color.
	82
	83	Returns:
	84	If self._enabled is False, returns the original text. If it's True,
	85	returns text with color escape sequences based on the value of color.
	86	"""
	87	if not self._enabled:
	88	return text
	89	if color == self.BOLD:
	90	start = self.BOLD_START
	91	else:
	92	start = self.COLOR_START % (color + 30)
	93	return start + text + self.RESET