terminal.py revision 12882:dd87d7f2f3e5 
1# Copyright (c) 2011 Advanced Micro Devices, Inc.
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
15# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
16# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
17# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
19# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24#
25# Author: Steve Reinhardt
26
27import sys
28import fcntl
29import termios
30import struct
31
32# Intended usage example:
33#
34# if force_colors:
35#    from m5.util.terminal import termcap
36# elif no_colors:
37#    from m5.util.terminal import no_termcap as termcap
38# else:
39#    from m5.util.terminal import tty_termcap as termcap
40# print termcap.Blue + "This could be blue!" + termcap.Normal
41
42# ANSI color names in index order
43color_names = "Black Red Green Yellow Blue Magenta Cyan White".split()
44default_separator = '='
45
46# Character attribute capabilities.  Note that not all terminals
47# support all of these capabilities, or support them
48# differently/meaningfully.  For example:
49#
50# - In PuTTY (with the default settings), Dim has no effect, Standout
51#   is the same as Reverse, and Blink does not blink but switches to a
52#   gray background.
53#
54# Please feel free to add information about other terminals here.
55#
56capability_map = {
57         'Bold': 'bold',
58          'Dim': 'dim',
59        'Blink': 'blink',
60    'Underline': 'smul',
61      'Reverse': 'rev',
62     'Standout': 'smso',
63       'Normal': 'sgr0'
64}
65
66capability_names = capability_map.keys()
67
68def null_cap_string(s, *args):
69    return ''
70
71try:
72    import curses
73    curses.setupterm()
74    def cap_string(s, *args):
75        cap = curses.tigetstr(s)
76        if cap:
77            return curses.tparm(cap, *args)
78        else:
79            return ''
80except:
81    cap_string = null_cap_string
82
83class ColorStrings(object):
84    def __init__(self, cap_string):
85        for i, c in enumerate(color_names):
86            setattr(self, c, cap_string('setaf', i))
87        for name, cap in capability_map.iteritems():
88            setattr(self, name, cap_string(cap))
89
90termcap = ColorStrings(cap_string)
91no_termcap = ColorStrings(null_cap_string)
92
93if sys.stdout.isatty():
94    tty_termcap = termcap
95else:
96    tty_termcap = no_termcap
97
98def get_termcap(use_colors = None):
99    if use_colors:
100        return termcap
101    elif use_colors is None:
102        # option unspecified; default behavior is to use colors iff isatty
103        return tty_termcap
104    else:
105        return no_termcap
106
107def terminal_size():
108    '''Return the (width, heigth) of the terminal screen.'''
109    h, w, hp, wp = struct.unpack('HHHH',
110        fcntl.ioctl(0, termios.TIOCGWINSZ,
111        struct.pack('HHHH', 0, 0, 0, 0)))
112    return w, h
113
114def separator(char=default_separator, color=None):
115    '''
116    Return a separator of the given character that is the length of the full
117    width of the terminal screen.
118    '''
119    (w, h) = terminal_size()
120    if color:
121        return color + char*w + termcap.Normal
122    else:
123        return char*w
124
125def insert_separator(inside, char=default_separator,
126                     min_barrier=3, color=None):
127    '''
128    Place the given string inside of the separator. If it does not fit inside,
129    expand the separator to fit it with at least min_barrier.
130
131    .. seealso:: :func:`separator`
132    '''
133    # Use a bytearray so it's efficient to manipulate
134    string = bytearray(separator(char, color=color))
135
136    # Check if we can fit inside with at least min_barrier.
137    gap = (len(string) - len(inside)) - min_barrier * 2
138    if gap > 0:
139        # We'll need to expand the string to fit us.
140        string.extend([ char for _ in range(-gap)])
141    # Emplace inside
142    middle = ((len(string)-1)/2)
143    start_idx = middle - len(inside)/2
144    string[start_idx:len(inside)+start_idx] = inside
145    return str(string)
146
147
148if __name__ == '__main__':
149    def test_termcap(obj):
150        for c_name in color_names:
151            c_str = getattr(obj, c_name)
152            print c_str + c_name + obj.Normal
153            for attr_name in capability_names:
154                if attr_name == 'Normal':
155                    continue
156                attr_str = getattr(obj, attr_name)
157                print attr_str + c_str + attr_name + " " + c_name + obj.Normal
158            print obj.Bold + obj.Underline + \
159                  c_name + "Bold Underline " + c_str + obj.Normal
160
161    print "=== termcap enabled ==="
162    test_termcap(termcap)
163    print termcap.Normal
164    print "=== termcap disabled ==="
165    test_termcap(no_termcap)
166