b5c233b106a73e04a63540434e52fd54a6dab9b9
[WebKit-https.git] / Tools / Scripts / webkitpy / layout_tests / views / metered_stream.py
1 #!/usr/bin/env python
2 # Copyright (C) 2010 Google Inc. 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:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 """
31 Package that implements a stream wrapper that has 'meters' as well as
32 regular output. A 'meter' is a single line of text that can be erased
33 and rewritten repeatedly, without producing multiple lines of output. It
34 can be used to produce effects like progress bars.
35
36 This package should only be called by the printing module in the layout_tests
37 package.
38 """
39
40
41 class MeteredStream:
42     """This class is a wrapper around a stream that allows you to implement
43     meters (progress bars, etc.).
44
45     It can be used directly as a stream, by calling write(), but also provides
46     a method called update() that will overwite prior updates().
47    """
48
49     def __init__(self, stream):
50         """
51         Args:
52           stream: output stream to write to
53         """
54         self._stream = stream
55         self._dirty = False
56         self._last_update = ""
57
58     def write(self, txt):
59         """Write to the stream, overwriting and resetting the meter."""
60
61         # This routine is called by the logging infrastructure, and
62         # must not call back into logging. It is not a public function.
63         self._overwrite(txt)
64         self._reset()
65
66     def update(self, txt):
67         """Write a message that will be overwritten by subsequent update() or write() calls."""
68         self._overwrite(txt)
69
70     def _overwrite(self, txt):
71         # Print the necessary number of backspaces to erase the previous
72         # message.
73         if len(self._last_update):
74             self._stream.write("\b" * len(self._last_update) +
75                                " " * len(self._last_update) +
76                                "\b" * len(self._last_update))
77         self._stream.write(txt)
78         last_newline = txt.rfind("\n")
79         self._last_update = txt[(last_newline + 1):]
80         self._dirty = True
81
82     def _reset(self):
83         self._dirty = False
84         self._last_update = ''