logger.dart 5.92 KB
Newer Older
1 2 3 4
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'dart:async';
6 7
import 'dart:io';

Ian Hickson's avatar
Ian Hickson committed
8
final _AnsiTerminal _terminal = new _AnsiTerminal();
Devon Carew's avatar
Devon Carew committed
9

10
abstract class Logger {
Devon Carew's avatar
Devon Carew committed
11
  bool get isVerbose => false;
12

13 14 15 16
  set supportsColor(bool value) {
    _terminal.supportsColor = value;
  }

17 18 19 20 21 22
  /// Display an error level message to the user. Commands should use this if they
  /// fail in some way.
  void printError(String message, [StackTrace stackTrace]);

  /// Display normal output of the command. This should be used for things like
  /// progress messages, success messages, or just normal command output.
23
  void printStatus(String message, { bool emphasis: false });
24 25 26 27

  /// Use this for verbose tracing output. Users can turn this output on in order
  /// to help diagnose issues with the toolchain or with their setup.
  void printTrace(String message);
Devon Carew's avatar
Devon Carew committed
28

29 30 31
  /// Start an indeterminate progress display.
  Status startProgress(String message);

Devon Carew's avatar
Devon Carew committed
32 33
  /// Flush any buffered output.
  void flush() { }
34 35
}

36 37 38 39 40
class Status {
  void stop({ bool showElapsedTime: false }) { }
  void cancel() { }
}

41
class StdoutLogger extends Logger {
42 43
  Status _status;

44
  @override
Devon Carew's avatar
Devon Carew committed
45
  bool get isVerbose => false;
46

47
  @override
48
  void printError(String message, [StackTrace stackTrace]) {
49 50 51
    _status?.cancel();
    _status = null;

Devon Carew's avatar
Devon Carew committed
52
    stderr.writeln(message);
53 54 55 56
    if (stackTrace != null)
      stderr.writeln(stackTrace);
  }

57
  @override
58
  void printStatus(String message, { bool emphasis: false }) {
59 60 61
    _status?.cancel();
    _status = null;

62
    print(emphasis ? _terminal.writeBold(message) : message);
63
  }
64

65
  @override
Devon Carew's avatar
Devon Carew committed
66
  void printTrace(String message) { }
67

68 69 70 71 72 73 74 75 76 77 78 79 80 81
  @override
  Status startProgress(String message) {
    _status?.cancel();
    _status = null;

    if (_terminal.supportsColor) {
      _status = new _AnsiStatus(message);
      return _status;
    } else {
      printStatus(message);
      return new Status();
    }
  }

82
  @override
Devon Carew's avatar
Devon Carew committed
83
  void flush() { }
84 85
}

86
class BufferLogger extends Logger {
87
  @override
Devon Carew's avatar
Devon Carew committed
88 89
  bool get isVerbose => false;

90 91 92 93 94 95 96 97
  StringBuffer _error = new StringBuffer();
  StringBuffer _status = new StringBuffer();
  StringBuffer _trace = new StringBuffer();

  String get errorText => _error.toString();
  String get statusText => _status.toString();
  String get traceText => _trace.toString();

98
  @override
99
  void printError(String message, [StackTrace stackTrace]) => _error.writeln(message);
100 101

  @override
102
  void printStatus(String message, { bool emphasis: false }) => _status.writeln(message);
103 104

  @override
105
  void printTrace(String message) => _trace.writeln(message);
Devon Carew's avatar
Devon Carew committed
106

107 108 109 110 111 112
  @override
  Status startProgress(String message) {
    printStatus(message);
    return new Status();
  }

113
  @override
Devon Carew's avatar
Devon Carew committed
114 115 116
  void flush() { }
}

117
class VerboseLogger extends Logger {
Devon Carew's avatar
Devon Carew committed
118 119
  _LogMessage lastMessage;

120
  @override
Devon Carew's avatar
Devon Carew committed
121 122
  bool get isVerbose => true;

123
  @override
Devon Carew's avatar
Devon Carew committed
124 125 126 127 128
  void printError(String message, [StackTrace stackTrace]) {
    _emit();
    lastMessage = new _LogMessage(_LogType.error, message, stackTrace);
  }

129
  @override
130
  void printStatus(String message, { bool emphasis: false }) {
Devon Carew's avatar
Devon Carew committed
131 132 133 134
    _emit();
    lastMessage = new _LogMessage(_LogType.status, message);
  }

135
  @override
Devon Carew's avatar
Devon Carew committed
136 137 138 139 140
  void printTrace(String message) {
    _emit();
    lastMessage = new _LogMessage(_LogType.trace, message);
  }

141 142 143 144 145 146
  @override
  Status startProgress(String message) {
    printStatus(message);
    return new Status();
  }

147
  @override
Devon Carew's avatar
Devon Carew committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
  void flush() => _emit();

  void _emit() {
    lastMessage?.emit();
    lastMessage = null;
  }
}

enum _LogType {
  error,
  status,
  trace
}

class _LogMessage {
  _LogMessage(this.type, this.message, [this.stackTrace]) {
    stopwatch.start();
  }

  final _LogType type;
  final String message;
  final StackTrace stackTrace;

  Stopwatch stopwatch = new Stopwatch();

  void emit() {
    stopwatch.stop();

    int millis = stopwatch.elapsedMilliseconds;
177
    String prefix = '${millis.toString().padLeft(4)} ms • ';
Devon Carew's avatar
Devon Carew committed
178 179
    String indent = ''.padLeft(prefix.length);
    if (millis >= 100)
180
      prefix = _terminal.writeBold(prefix.substring(0, prefix.length - 3)) + ' • ';
Devon Carew's avatar
Devon Carew committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
    String indentMessage = message.replaceAll('\n', '\n$indent');

    if (type == _LogType.error) {
      stderr.writeln(prefix + _terminal.writeBold(indentMessage));
      if (stackTrace != null)
        stderr.writeln(indent + stackTrace.toString().replaceAll('\n', '\n$indent'));
    } else if (type == _LogType.status) {
      print(prefix + _terminal.writeBold(indentMessage));
    } else {
      print(prefix + indentMessage);
    }
  }
}

class _AnsiTerminal {
  _AnsiTerminal() {
197
    // TODO(devoncarew): This detection does not work for Windows.
Devon Carew's avatar
Devon Carew committed
198
    String term = Platform.environment['TERM'];
199
    supportsColor = term != null && term != 'dumb';
Devon Carew's avatar
Devon Carew committed
200 201 202 203 204
  }

  static const String _bold = '\u001B[1m';
  static const String _reset = '\u001B[0m';

205
  bool supportsColor;
Devon Carew's avatar
Devon Carew committed
206 207

  String writeBold(String str) => supportsColor ? '$_bold$str$_reset' : str;
208
}
209 210 211 212 213

class _AnsiStatus extends Status {
  _AnsiStatus(this.message) {
    stopwatch = new Stopwatch()..start();

214
    stdout.write('${message.padRight(51)}     ');
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
    stdout.write('${_progress[0]}');

    timer = new Timer.periodic(new Duration(milliseconds: 100), _callback);
  }

  static final List<String> _progress = <String>['-', r'\', '|', r'/', '-', r'\', '|', '/'];

  final String message;
  Stopwatch stopwatch;
  Timer timer;
  int index = 1;
  bool live = true;

  void _callback(Timer timer) {
    stdout.write('\b${_progress[index]}');
    index = ++index % _progress.length;
  }

  @override
  void stop({ bool showElapsedTime: false }) {
    if (!live)
      return;
    live = false;

    if (showElapsedTime) {
      double seconds = stopwatch.elapsedMilliseconds / 1000.0;
      print('\b\b\b\b${seconds.toStringAsFixed(1)}s');
    } else {
243
      print('\b ');
244 245 246 247 248 249 250 251 252 253 254
    }

    timer.cancel();
  }

  @override
  void cancel() {
    if (!live)
      return;
    live = false;

255
    print('\b ');
256 257 258
    timer.cancel();
  }
}