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.

SConstruct

@@ -1,5 +1,6 @@
 # -*- mode:python -*-
 
+# Copyright (c) 2011 Advanced Micro Devices, Inc.
 # Copyright (c) 2009 The Hewlett-Packard Development Company
 # Copyright (c) 2004-2005 The Regents of The University of Michigan
 # All rights reserved.
@@ -120,6 +121,18 @@ sys.path[1:1] = extra_python_paths
 
 from m5.util import compareVersions, readCommand
 
+AddOption('--colors', dest='use_colors', action='store_true')
+AddOption('--no-colors', dest='use_colors', action='store_false')
+use_colors = GetOption('use_colors')
+
+if use_colors:
+    from m5.util.terminal import termcap
+elif use_colors is None:
+    # option unspecified; default behavior is to use colors iff isatty
+    from m5.util.terminal import tty_termcap as termcap
+else:
+    from m5.util.terminal import no_termcap as termcap
+
 ########################################################################
 #
 # Set up the main build environment.
@@ -357,7 +370,7 @@ Export('extras_dir_list')
 # the ext directory should be on the #includes path
 main.Append(CPPPATH=[Dir('ext')])
 
-def _STRIP(path, env):
+def strip_build_path(path, env):
     path = str(path)
     variant_base = env['BUILDROOT'] + os.path.sep
     if path.startswith(variant_base):
@@ -366,29 +379,94 @@ def _STRIP(path, env):
         path = path[6:]
     return path
 
-def _STRIP_SOURCE(target, source, env, for_signature):
+# Generate a string of the form:
-    return _STRIP(source[0], env)
+#   common/path/prefix/src1, src2 -> tgt1, tgt2
-main['STRIP_SOURCE'] = _STRIP_SOURCE
+# to print while building.
+class Transform(object):
+    # all specific color settings should be here and nowhere else
+    tool_color = termcap.Normal
+    pfx_color = termcap.Yellow
+    srcs_color = termcap.Yellow + termcap.Bold
+    arrow_color = termcap.Blue + termcap.Bold
+    tgts_color = termcap.Yellow + termcap.Bold
+
+    def __init__(self, tool, max_sources=99):
+        self.format = self.tool_color + (" [%8s] " % tool) \
+                      + self.pfx_color + "%s" \
+                      + self.srcs_color + "%s" \
+                      + self.arrow_color + " -> " \
+                      + self.tgts_color + "%s" \
+                      + termcap.Normal
+        self.max_sources = max_sources
+
+    def __call__(self, target, source, env, for_signature=None):
+        # truncate source list according to max_sources param
+        source = source[0:self.max_sources]
+        def strip(f):
+            return strip_build_path(str(f), env)
+        if len(source) > 0:
+            srcs = map(strip, source)
+        else:
+            srcs = ['']
+        tgts = map(strip, target)
+        # surprisingly, os.path.commonprefix is a dumb char-by-char string
+        # operation that has nothing to do with paths.
+        com_pfx = os.path.commonprefix(srcs + tgts)
+        com_pfx_len = len(com_pfx)
+        if com_pfx:
+            # do some cleanup and sanity checking on common prefix
+            if com_pfx[-1] == ".":
+                # prefix matches all but file extension: ok
+                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
+                com_pfx = com_pfx[0:-1]
+            elif com_pfx[-1] == "/":
+                # common prefix is directory path: OK
+                pass
+            else:
+                src0_len = len(srcs[0])
+                tgt0_len = len(tgts[0])
+                if src0_len == com_pfx_len:
+                    # source is a substring of target, OK
+                    pass
+                elif tgt0_len == com_pfx_len:
+                    # target is a substring of source, need to back up to
+                    # avoid empty string on RHS of arrow
+                    sep_idx = com_pfx.rfind(".")
+                    if sep_idx != -1:
+                        com_pfx = com_pfx[0:sep_idx]
+                    else:
+                        com_pfx = ''
+                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
+                    # still splitting at file extension: ok
+                    pass
+                else:
+                    # probably a fluke; ignore it
+                    com_pfx = ''
+        # recalculate length in case com_pfx was modified
+        com_pfx_len = len(com_pfx)
+        def fmt(files):
+            f = map(lambda s: s[com_pfx_len:], files)
+            return ', '.join(f)
+        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
+
+Export('Transform')
 
-def _STRIP_TARGET(target, source, env, for_signature):
-    return _STRIP(target[0], env)
-main['STRIP_TARGET'] = _STRIP_TARGET
 
 if main['VERBOSE']:
     def MakeAction(action, string, *args, **kwargs):
         return Action(action, *args, **kwargs)
 else:
     MakeAction = Action
-    main['CCCOMSTR']        = ' [      CC] $STRIP_SOURCE'
+    main['CCCOMSTR']        = Transform("CC")
-    main['CXXCOMSTR']       = ' [     CXX] $STRIP_SOURCE'
+    main['CXXCOMSTR']       = Transform("CXX")
-    main['ASCOMSTR']        = ' [      AS] $STRIP_SOURCE'
+    main['ASCOMSTR']        = Transform("AS")
-    main['SWIGCOMSTR']      = ' [    SWIG] $STRIP_SOURCE'
+    main['SWIGCOMSTR']      = Transform("SWIG")
-    main['ARCOMSTR']        = ' [      AR] $STRIP_TARGET'
+    main['ARCOMSTR']        = Transform("AR", 0)
-    main['LINKCOMSTR']      = ' [    LINK] $STRIP_TARGET'
+    main['LINKCOMSTR']      = Transform("LINK", 0)
-    main['RANLIBCOMSTR']    = ' [  RANLIB] $STRIP_TARGET'
+    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
-    main['M4COMSTR']        = ' [      M4] $STRIP_TARGET'
+    main['M4COMSTR']        = Transform("M4")
-    main['SHCCCOMSTR']      = ' [    SHCC] $STRIP_TARGET'
+    main['SHCCCOMSTR']      = Transform("SHCC")
-    main['SHCXXCOMSTR']     = ' [   SHCXX] $STRIP_TARGET'
+    main['SHCXXCOMSTR']     = Transform("SHCXX")
 Export('MakeAction')
 
 CXX_version = readCommand([main['CXX'],'--version'], exception=False)
@@ -828,7 +906,7 @@ def make_switching_dir(dname, switch_headers, env):
     # action depends on; when env['ALL_ISA_LIST'] changes these actions
     # should get re-executed.
     switch_hdr_action = MakeAction(gen_switch_hdr,
-                     " [GENERATE] $STRIP_TARGET", varlist=['ALL_ISA_LIST'])
+                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
 
     # Instantiate actions for each header
     for hdr in switch_headers:

src/SConscript

@@ -290,7 +290,7 @@ def makeTheISA(source, target, env):
     code.write(str(target[0]))
 
 env.Command('config/the_isa.hh', map(Value, all_isa_list),
-            MakeAction(makeTheISA, " [ CFG ISA] $STRIP_TARGET"))
+            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
 
 ########################################################################
 #
@@ -433,7 +433,7 @@ del _globals
 defines_info = [ Value(build_env), Value(env['HG_INFO']) ]
 # Generate a file with all of the compile options in it
 env.Command('python/m5/defines.py', defines_info,
-            MakeAction(makeDefinesPyFile, " [ DEFINES] $STRIP_TARGET"))
+            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
 PySource('m5', 'python/m5/defines.py')
 
 # Generate python file containing info about the M5 source code
@@ -447,7 +447,7 @@ def makeInfoPyFile(target, source, env):
 # Generate a file that wraps the basic top level files
 env.Command('python/m5/info.py',
             [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
-            MakeAction(makeInfoPyFile, " [    INFO] $STRIP_TARGET"))
+            MakeAction(makeInfoPyFile, Transform("INFO")))
 PySource('m5', 'python/m5/info.py')
 
 ########################################################################
@@ -523,7 +523,7 @@ for name,simobj in sorted(sim_objects.iteritems()):
     hh_file = File('params/%s.hh' % name)
     params_hh_files.append(hh_file)
     env.Command(hh_file, Value(name),
-                MakeAction(createSimObjectParam, " [SO PARAM] $STRIP_TARGET"))
+                MakeAction(createSimObjectParam, Transform("SO PARAM")))
     env.Depends(hh_file, depends + extra_deps)
 
 # Generate any parameter header files needed
@@ -532,7 +532,7 @@ for name,param in all_params.iteritems():
     i_file = File('python/m5/internal/%s_%s.i' % (param.file_ext, name))
     params_i_files.append(i_file)
     env.Command(i_file, Value(name),
-                MakeAction(createSwigParam, " [SW PARAM] $STRIP_TARGET"))
+                MakeAction(createSwigParam, Transform("SW PARAM")))
     env.Depends(i_file, depends)
     SwigSource('m5.internal', i_file)
 
@@ -543,18 +543,18 @@ for name,enum in sorted(all_enums.iteritems()):
 
     cc_file = File('enums/%s.cc' % name)
     env.Command(cc_file, Value(name),
-                MakeAction(createEnumStrings, " [ENUM STR] $STRIP_TARGET"))
+                MakeAction(createEnumStrings, Transform("ENUM STR")))
     env.Depends(cc_file, depends + extra_deps)
     Source(cc_file)
 
     hh_file = File('enums/%s.hh' % name)
     env.Command(hh_file, Value(name),
-                MakeAction(createEnumParam, " [EN PARAM] $STRIP_TARGET"))
+                MakeAction(createEnumParam, Transform("EN PARAM")))
     env.Depends(hh_file, depends + extra_deps)
 
     i_file = File('python/m5/internal/enum_%s.i' % name)
     env.Command(i_file, Value(name),
-                MakeAction(createEnumSwig, " [ENUMSWIG] $STRIP_TARGET"))
+                MakeAction(createEnumSwig, Transform("ENUMSWIG")))
     env.Depends(i_file, depends + extra_deps)
     SwigSource('m5.internal', i_file)
 
@@ -594,7 +594,7 @@ def buildParam(target, source, env):
 for name in sim_objects.iterkeys():
     params_file = File('python/m5/internal/param_%s.i' % name)
     env.Command(params_file, Value(name),
-                MakeAction(buildParam, " [BLDPARAM] $STRIP_TARGET"))
+                MakeAction(buildParam, Transform("BLDPARAM")))
     env.Depends(params_file, depends)
     SwigSource('m5.internal', params_file)
 
@@ -617,10 +617,10 @@ EmbeddedSwig embed_swig_${module}(init_${module});
 for swig in SwigSource.all:
     env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
                 MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
-                '-o ${TARGETS[0]} $SOURCES', " [    SWIG] $STRIP_TARGET"))
+                '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
     init_file = 'python/swig/init_%s.cc' % swig.module
     env.Command(init_file, Value(swig.module),
-                MakeAction(makeEmbeddedSwigInit, " [EMBED SW] $STRIP_TARGET"))
+                MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
     Source(init_file)
 
 def getFlags(source_flags):
@@ -844,13 +844,13 @@ extern const Flags *compoundFlags[];
 
 flags = map(Value, trace_flags.values())
 env.Command('base/traceflags.py', flags, 
-            MakeAction(traceFlagsPy, " [ TRACING] $STRIP_TARGET"))
+            MakeAction(traceFlagsPy, Transform("TRACING", 0)))
 PySource('m5', 'base/traceflags.py')
 
 env.Command('base/traceflags.hh', flags,
-            MakeAction(traceFlagsHH, " [ TRACING] $STRIP_TARGET"))
+            MakeAction(traceFlagsHH, Transform("TRACING", 0)))
 env.Command('base/traceflags.cc', flags, 
-            MakeAction(traceFlagsCC, " [ TRACING] $STRIP_TARGET"))
+            MakeAction(traceFlagsCC, Transform("TRACING", 0)))
 Source('base/traceflags.cc')
 
 # Embed python files.  All .py files that have been indicated by a
@@ -908,7 +908,7 @@ EmbeddedPython embedded_${sym}(
 
 for source in PySource.all:
     env.Command(source.cpp, source.tnode, 
-                MakeAction(embedPyFile, " [EMBED PY] $STRIP_TARGET"))
+                MakeAction(embedPyFile, Transform("EMBED PY")))
     Source(source.cpp)
 
 ########################################################################
@@ -1000,7 +1000,7 @@ def makeEnv(label, objsfx, strip = False, **kwargs):
         else:
             cmd = 'strip $SOURCE -o $TARGET'
         targets = new_env.Command(exename, progname,
-                    MakeAction(cmd, " [   STRIP] $STRIP_TARGET"))
+                    MakeAction(cmd, Transform("STRIP")))
             
     new_env.M5Binary = targets[0]
     envList.append(new_env)

src/arch/SConscript

@@ -118,7 +118,7 @@ def isa_desc_action_func(target, source, env):
     cpu_models = [CpuModel.dict[cpu] for cpu in models]
     parser = isa_parser.ISAParser(target[0].dir.abspath, cpu_models)
     parser.parse_isa_desc(source[0].abspath)
-isa_desc_action = MakeAction(isa_desc_action_func, " [ISA DESC] $STRIP_SOURCE")
+isa_desc_action = MakeAction(isa_desc_action_func, Transform("ISA DESC", 1))
 
 # Also include the CheckerCPU as one of the models if it is being
 # enabled via command line.

src/arch/isa_parser.py

@@ -1980,13 +1980,11 @@ StaticInstPtr
             old_contents = f.read()
             f.close()
             if contents != old_contents:
-                print 'Updating', file
                 os.remove(file) # in case it's write-protected
                 update = True
             else:
                 print 'File', file, 'is unchanged'
         else:
-            print ' [GENERATE]', file
             update = True
         if update:
             f = open(file, 'w')

src/python/SConscript

@@ -60,6 +60,7 @@ PySource('m5.util', 'm5/util/multidict.py')
 PySource('m5.util', 'm5/util/orderdict.py')
 PySource('m5.util', 'm5/util/smartdict.py')
 PySource('m5.util', 'm5/util/sorteddict.py')
+PySource('m5.util', 'm5/util/terminal.py')
 
 SwigSource('m5.internal', 'swig/core.i')
 SwigSource('m5.internal', 'swig/debug.i')

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)