summaryrefslogtreecommitdiff
path: root/src/python/m5/util/terminal.py
diff options
context:
space:
mode:
authorSteve Reinhardt <steve.reinhardt@amd.com>2011-01-07 21:50:13 -0800
committerSteve Reinhardt <steve.reinhardt@amd.com>2011-01-07 21:50:13 -0800
commitd650f4138eaa68c856d0879e39a78f66d205b017 (patch)
tree257321d1adfe8559eca2f36c6f8c0a1319e2e7af /src/python/m5/util/terminal.py
parentd36cc62c117c2ec37dd99b1e55f3663f4af65b8d (diff)
downloadgem5-d650f4138eaa68c856d0879e39a78f66d205b017.tar.xz
scons: show sources and targets when building, and colorize output.
I like the brevity of Ali's recent change, but the ambiguity of sometimes showing the source and sometimes the target is a little confusing. This patch makes scons typically list all sources and all targets for each action, with the common path prefix factored out for brevity. It's a little more verbose now but also more informative. Somehow Ali talked me into adding colors too, which is a whole 'nother story.
Diffstat (limited to 'src/python/m5/util/terminal.py')
-rw-r--r--src/python/m5/util/terminal.py113
1 files changed, 113 insertions, 0 deletions
diff --git a/src/python/m5/util/terminal.py b/src/python/m5/util/terminal.py
new file mode 100644
index 000000000..9038c1f54
--- /dev/null
+++ b/src/python/m5/util/terminal.py
@@ -0,0 +1,113 @@
+# Copyright (c) 2011 Advanced Micro Devices, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Author: Steve Reinhardt
+
+import sys
+
+# Intended usage example:
+#
+# if force_colors:
+# from m5.util.terminal import termcap
+# elif no_colors:
+# from m5.util.terminal import no_termcap as termcap
+# else:
+# from m5.util.terminal import tty_termcap as termcap
+# print termcap.Blue + "This could be blue!" + termcap.Normal
+
+# ANSI color names in index order
+color_names = "Black Red Green Yellow Blue Magenta Cyan".split()
+
+# Character attribute capabilities. Note that not all terminals
+# support all of these capabilities, or support them
+# differently/meaningfully. For example:
+#
+# - In PuTTY (with the default settings), Dim has no effect, Standout
+# is the same as Reverse, and Blink does not blink but switches to a
+# gray background.
+#
+# Please feel free to add information about other terminals here.
+#
+capability_map = {
+ 'Bold': 'bold',
+ 'Dim': 'dim',
+ 'Blink': 'blink',
+ 'Underline': 'smul',
+ 'Reverse': 'rev',
+ 'Standout': 'smso',
+ 'Normal': 'sgr0'
+}
+
+capability_names = capability_map.keys()
+
+def null_cap_string(s, *args):
+ return ''
+
+try:
+ import curses
+ curses.setupterm()
+ def cap_string(s, *args):
+ cap = curses.tigetstr(s)
+ if cap:
+ return curses.tparm(cap, *args)
+ else:
+ return ''
+except:
+ cap_string = null_cap_string
+
+class ColorStrings(object):
+ def __init__(self, cap_string):
+ for i, c in enumerate(color_names):
+ setattr(self, c, cap_string('setaf', i))
+ for name, cap in capability_map.iteritems():
+ setattr(self, name, cap_string(cap))
+
+termcap = ColorStrings(cap_string)
+no_termcap = ColorStrings(null_cap_string)
+
+if sys.stdout.isatty():
+ tty_termcap = termcap
+else:
+ tty_termcap = no_termcap
+
+def test_termcap(obj):
+ for c_name in color_names:
+ c_str = getattr(obj, c_name)
+ print c_str + c_name + obj.Normal
+ for attr_name in capability_names:
+ if attr_name == 'Normal':
+ continue
+ attr_str = getattr(obj, attr_name)
+ print attr_str + c_str + attr_name + " " + c_name + obj.Normal
+ print obj.Bold + obj.Underline + \
+ c_name + "Bold Underline " + c + obj.Normal
+
+if __name__ == '__main__':
+ print "=== termcap enabled ==="
+ test_termcap(termcap)
+ print termcap.Normal
+ print "=== termcap disabled ==="
+ test_termcap(no_termcap)