| // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
| // for details. All rights reserved. Use of this source code is governed by a |
| // BSD-style license that can be found in the LICENSE file. |
| |
| /// Generic utility functions. Stuff that should possibly be in core. |
| import 'dart:async'; |
| import "dart:convert"; |
| import 'dart:io'; |
| import 'dart:math' as math; |
| |
| import "package:crypto/crypto.dart" as crypto; |
| import 'package:meta/meta.dart'; |
| import 'package:path/path.dart' as path; |
| import "package:stack_trace/stack_trace.dart"; |
| |
| import 'exceptions.dart'; |
| import 'io.dart'; |
| import 'log.dart' as log; |
| |
| export 'asset/dart/utils.dart'; |
| |
| /// Whether Pub is running its own tests under Travis.CI. |
| final isTravis = Platform.environment["TRAVIS_REPO_SLUG"] == "dart-lang/pub"; |
| |
| /// A regular expression matching a Dart identifier. |
| /// |
| /// This also matches a package name, since they must be Dart identifiers. |
| final identifierRegExp = new RegExp(r"[a-zA-Z_]\w*"); |
| |
| /// Like [identifierRegExp], but anchored so that it only matches strings that |
| /// are *just* Dart identifiers. |
| final onlyIdentifierRegExp = new RegExp("^${identifierRegExp.pattern}\$"); |
| |
| /// Dart reserved words, from the Dart spec. |
| const reservedWords = const [ |
| "assert", |
| "break", |
| "case", |
| "catch", |
| "class", |
| "const", |
| "continue", |
| "default", |
| "do", |
| "else", |
| "extends", |
| "false", |
| "final", |
| "finally", |
| "for", |
| "if", |
| "in", |
| "is", |
| "new", |
| "null", |
| "return", |
| "super", |
| "switch", |
| "this", |
| "throw", |
| "true", |
| "try", |
| "var", |
| "void", |
| "while", |
| "with" |
| ]; |
| |
| /// An cryptographically secure instance of [math.Random]. |
| final random = new math.Random.secure(); |
| |
| /// A pair of values. |
| class Pair<E, F> { |
| E first; |
| F last; |
| |
| Pair(this.first, this.last); |
| |
| String toString() => '($first, $last)'; |
| |
| bool operator ==(other) { |
| if (other is! Pair) return false; |
| return other.first == first && other.last == last; |
| } |
| |
| int get hashCode => first.hashCode ^ last.hashCode; |
| } |
| |
| /// Like [new Future], but avoids around issue 11911 by using [new Future.value] |
| /// under the covers. |
| Future newFuture(callback()) => new Future.value().then((_) => callback()); |
| |
| /// Runs [callback] in an error zone and pipes any unhandled error to the |
| /// returned [Future]. |
| /// |
| /// If the returned [Future] produces an error, its stack trace will always be a |
| /// [Chain]. By default, this chain will contain only the local stack trace, but |
| /// if [captureStackChains] is passed, it will contain the full stack chain for |
| /// the error. |
| Future captureErrors(Future callback(), {bool captureStackChains: false}) { |
| var completer = new Completer(); |
| var wrappedCallback = () { |
| new Future.sync(callback) |
| .then(completer.complete) |
| .catchError((e, stackTrace) { |
| // [stackTrace] can be null if we're running without [captureStackChains], |
| // since dart:io will often throw errors without stack traces. |
| if (stackTrace != null) { |
| stackTrace = new Chain.forTrace(stackTrace); |
| } else { |
| stackTrace = new Chain([]); |
| } |
| if (!completer.isCompleted) completer.completeError(e, stackTrace); |
| }); |
| }; |
| |
| if (captureStackChains) { |
| Chain.capture(wrappedCallback, onError: (error, stackTrace) { |
| if (!completer.isCompleted) completer.completeError(error, stackTrace); |
| }); |
| } else { |
| runZoned(wrappedCallback, onError: (e, stackTrace) { |
| if (stackTrace == null) { |
| stackTrace = new Chain.current(); |
| } else { |
| stackTrace = new Chain([new Trace.from(stackTrace)]); |
| } |
| if (!completer.isCompleted) completer.completeError(e, stackTrace); |
| }); |
| } |
| |
| return completer.future; |
| } |
| |
| /// Like [Future.wait], but prints all errors from the futures as they occur and |
| /// only returns once all Futures have completed, successfully or not. |
| /// |
| /// This will wrap the first error thrown in a [SilentException] and rethrow it. |
| Future<List<T>> waitAndPrintErrors<T>(Iterable<Future<T>> futures) { |
| return Future.wait(futures.map((future) { |
| return future.catchError((error, stackTrace) { |
| log.exception(error, stackTrace); |
| throw error; |
| }); |
| })).catchError((error, stackTrace) { |
| throw new SilentException(error, stackTrace); |
| }); |
| } |
| |
| /// Returns a [StreamTransformer] that will call [onDone] when the stream |
| /// completes. |
| /// |
| /// The stream will be passed through unchanged. |
| StreamTransformer<T, T> onDoneTransformer<T>(void onDone()) { |
| return new StreamTransformer<T, T>.fromHandlers(handleDone: (sink) { |
| onDone(); |
| sink.close(); |
| }); |
| } |
| |
| // TODO(rnystrom): Move into String? |
| /// Pads [source] to [length] by adding spaces at the end. |
| String padRight(String source, int length) { |
| final result = new StringBuffer(); |
| result.write(source); |
| |
| while (result.length < length) { |
| result.write(' '); |
| } |
| |
| return result.toString(); |
| } |
| |
| /// Pads [source] to [length] by adding [char]s at the beginning. |
| /// |
| /// If [char] is `null`, it defaults to a space. |
| String padLeft(String source, int length, [String char]) { |
| if (char == null) char = ' '; |
| if (source.length >= length) return source; |
| |
| return char * (length - source.length) + source; |
| } |
| |
| /// Returns a labelled sentence fragment starting with [name] listing the |
| /// elements [iter]. |
| /// |
| /// If [iter] does not have one item, name will be pluralized by adding "s" or |
| /// using [plural], if given. |
| String namedSequence(String name, Iterable iter, [String plural]) { |
| if (iter.length == 1) return "$name ${iter.single}"; |
| |
| if (plural == null) plural = "${name}s"; |
| return "$plural ${toSentence(iter)}"; |
| } |
| |
| /// Returns a sentence fragment listing the elements of [iter]. |
| /// |
| /// This converts each element of [iter] to a string and separates them with |
| /// commas and/or "and" where appropriate. |
| String toSentence(Iterable iter) { |
| if (iter.length == 1) return iter.first.toString(); |
| return iter.take(iter.length - 1).join(", ") + " and ${iter.last}"; |
| } |
| |
| /// Returns [name] if [number] is 1, or the plural of [name] otherwise. |
| /// |
| /// By default, this just adds "s" to the end of [name] to get the plural. If |
| /// [plural] is passed, that's used instead. |
| String pluralize(String name, int number, {String plural}) { |
| if (number == 1) return name; |
| if (plural != null) return plural; |
| return '${name}s'; |
| } |
| |
| /// Escapes any regex metacharacters in [string] so that using as a [RegExp] |
| /// pattern will match the string literally. |
| // TODO(rnystrom): Remove when #4706 is fixed. |
| String quoteRegExp(String string) { |
| // Note: make sure "\" is done first so that we don't escape the other |
| // escaped characters. We could do all of the replaces at once with a regexp |
| // but string literal for regex that matches all regex metacharacters would |
| // be a bit hard to read. |
| for (var metacharacter in r"\^$.*+?()[]{}|".split("")) { |
| string = string.replaceAll(metacharacter, "\\$metacharacter"); |
| } |
| |
| return string; |
| } |
| |
| /// Creates a URL string for [address]:[port]. |
| /// |
| /// Handles properly formatting IPv6 addresses. |
| Uri baseUrlForAddress(InternetAddress address, int port) { |
| if (address.isLoopback) { |
| return new Uri(scheme: "http", host: "localhost", port: port); |
| } |
| |
| // IPv6 addresses in URLs need to be enclosed in square brackets to avoid |
| // URL ambiguity with the ":" in the address. |
| if (address.type == InternetAddressType.IP_V6) { |
| return new Uri(scheme: "http", host: "[${address.address}]", port: port); |
| } |
| |
| return new Uri(scheme: "http", host: address.address, port: port); |
| } |
| |
| /// Returns whether [host] is a host for a localhost or loopback URL. |
| /// |
| /// Unlike [InternetAddress.isLoopback], this hostnames from URLs as well as |
| /// from [InternetAddress]es, including "localhost". |
| bool isLoopback(String host) { |
| if (host == 'localhost') return true; |
| |
| // IPv6 hosts in URLs are surrounded by square brackets. |
| if (host.startsWith("[") && host.endsWith("]")) { |
| host = host.substring(1, host.length - 1); |
| } |
| |
| try { |
| return new InternetAddress(host).isLoopback; |
| } on ArgumentError catch (_) { |
| // The host isn't an IP address and isn't "localhost', so it's almost |
| // certainly not a loopback host. |
| return false; |
| } |
| } |
| |
| /// Randomly chooses a single element in [elements]. |
| T choose<T>(List<T> elements) => elements[random.nextInt(elements.length)]; |
| |
| /// Returns a set containing all elements in [minuend] that are not in |
| /// [subtrahend]. |
| Set setMinus(Iterable minuend, Iterable subtrahend) { |
| var minuendSet = new Set.from(minuend); |
| minuendSet.removeAll(subtrahend); |
| return minuendSet; |
| } |
| |
| /// Returns whether there's any overlap between [set1] and [set2]. |
| bool overlaps(Set set1, Set set2) { |
| // Iterate through the smaller set. |
| var smaller = set1.length > set2.length ? set1 : set2; |
| var larger = smaller == set1 ? set2 : set1; |
| return smaller.any(larger.contains); |
| } |
| |
| /// Returns a list containing the sorted elements of [iter]. |
| List<T> ordered<T extends Comparable<T>>(Iterable<T> iter) { |
| var list = iter.toList(); |
| list.sort(); |
| return list; |
| } |
| |
| /// Given a list of filenames, returns a set of patterns that can be used to |
| /// filter for those filenames. |
| /// |
| /// For a given path, that path ends with some string in the returned set if |
| /// and only if that path's basename is in [files]. |
| Set<String> createFileFilter(Iterable<String> files) { |
| return files.expand<String>((file) { |
| var result = ["/$file"]; |
| if (Platform.operatingSystem == 'windows') result.add("\\$file"); |
| return result; |
| }).toSet(); |
| } |
| |
| /// Given a blacklist of directory names, returns a set of patterns that can |
| /// be used to filter for those directory names. |
| /// |
| /// For a given path, that path contains some string in the returned set if |
| /// and only if one of that path's components is in [dirs]. |
| Set<String> createDirectoryFilter(Iterable<String> dirs) { |
| return dirs.expand<String>((dir) { |
| var result = ["/$dir/"]; |
| if (Platform.operatingSystem == 'windows') { |
| result..add("/$dir\\")..add("\\$dir/")..add("\\$dir\\"); |
| } |
| return result; |
| }).toSet(); |
| } |
| |
| /// Returns the maximum value in [iter] by [compare]. |
| /// |
| /// [compare] defaults to [Comparable.compare]. |
| T maxAll<T extends Comparable>(Iterable<T> iter, |
| [int compare(T element1, T element2)]) { |
| if (compare == null) compare = Comparable.compare; |
| return iter |
| .reduce((max, element) => compare(element, max) > 0 ? element : max); |
| } |
| |
| /// Replace each instance of [matcher] in [source] with the return value of |
| /// [fn]. |
| String replace(String source, Pattern matcher, String fn(Match match)) { |
| var buffer = new StringBuffer(); |
| var start = 0; |
| for (var match in matcher.allMatches(source)) { |
| buffer.write(source.substring(start, match.start)); |
| start = match.end; |
| buffer.write(fn(match)); |
| } |
| buffer.write(source.substring(start)); |
| return buffer.toString(); |
| } |
| |
| /// Returns the hex-encoded sha1 hash of [source]. |
| String sha1(String source) => |
| crypto.sha1.convert(UTF8.encode(source)).toString(); |
| |
| /// Returns the base64-encoded sha1 hash of [stream]. |
| Future<String> sha1Stream(Stream<List<int>> stream) async { |
| crypto.Digest digest; |
| |
| var digestSink = |
| new ChunkedConversionSink<crypto.Digest>.withCallback((digests) { |
| digest = digests.single; |
| }); |
| |
| var byteSink = crypto.sha1.startChunkedConversion(digestSink); |
| |
| await stream.forEach((chunk) { |
| byteSink.add(chunk); |
| }); |
| |
| byteSink.close(); |
| |
| // TODO(rnystrom): this call to `close` should not be needed. Remove when |
| // https://github.com/dart-lang/crypto/issues/33 |
| // is fixed. |
| // Does not cause any problems in the mean time. |
| digestSink.close(); |
| |
| return BASE64.encode(digest.bytes); |
| } |
| |
| /// Configures [future] so that its result (success or exception) is passed on |
| /// to [completer]. |
| void chainToCompleter(Future future, Completer completer) { |
| future.then(completer.complete, onError: completer.completeError); |
| } |
| |
| /// Ensures that [stream] can emit at least one value successfully (or close |
| /// without any values). |
| /// |
| /// For example, reading asynchronously from a non-existent file will return a |
| /// stream that fails on the first chunk. In order to handle that more |
| /// gracefully, you may want to check that the stream looks like it's working |
| /// before you pipe the stream to something else. |
| /// |
| /// This lets you do that. It returns a [Future] that completes to a [Stream] |
| /// emitting the same values and errors as [stream], but only if at least one |
| /// value can be read successfully. If an error occurs before any values are |
| /// emitted, the returned Future completes to that error. |
| Future<Stream<T>> validateStream<T>(Stream<T> stream) { |
| var completer = new Completer<Stream>(); |
| var controller = new StreamController(sync: true); |
| |
| StreamSubscription subscription; |
| subscription = stream.listen((value) { |
| // We got a value, so the stream is valid. |
| if (!completer.isCompleted) completer.complete(controller.stream); |
| controller.add(value); |
| }, onError: (error, [StackTrace stackTrace]) { |
| // If the error came after values, it's OK. |
| if (completer.isCompleted) { |
| controller.addError(error, stackTrace); |
| return; |
| } |
| |
| // Otherwise, the error came first and the stream is invalid. |
| completer.completeError(error, stackTrace); |
| |
| // We won't be returning the stream at all in this case, so unsubscribe |
| // and swallow the error. |
| subscription.cancel(); |
| }, onDone: () { |
| // It closed with no errors, so the stream is valid. |
| if (!completer.isCompleted) completer.complete(controller.stream); |
| controller.close(); |
| }); |
| |
| return completer.future; |
| } |
| |
| // TODO(nweiz): remove this when issue 7964 is fixed. |
| /// Returns a [Future] that will complete to the first element of [stream]. |
| /// |
| /// Unlike [Stream.first], this is safe to use with single-subscription streams. |
| Future<T> streamFirst<T>(Stream<T> stream) { |
| var completer = new Completer(); |
| var subscription; |
| subscription = stream.listen((value) { |
| subscription.cancel(); |
| completer.complete(value); |
| }, onError: (e, [StackTrace stackTrace]) { |
| completer.completeError(e, stackTrace); |
| }, onDone: () { |
| completer.completeError(new StateError("No elements"), new Chain.current()); |
| }, cancelOnError: true); |
| return completer.future; |
| } |
| |
| /// A regular expression matching a trailing CR character. |
| final _trailingCR = new RegExp(r"\r$"); |
| |
| // TODO(nweiz): Use `text.split(new RegExp("\r\n?|\n\r?"))` when issue 9360 is |
| // fixed. |
| /// Splits [text] on its line breaks in a Windows-line-break-friendly way. |
| List<String> splitLines(String text) => |
| text.split("\n").map((line) => line.replaceFirst(_trailingCR, "")).toList(); |
| |
| /// Converts a stream of arbitrarily chunked strings into a line-by-line stream. |
| /// |
| /// The lines don't include line termination characters. A single trailing |
| /// newline is ignored. |
| Stream<String> streamToLines(Stream<String> stream) { |
| var buffer = new StringBuffer(); |
| return stream |
| .transform(new StreamTransformer.fromHandlers(handleData: (chunk, sink) { |
| var lines = splitLines(chunk); |
| var leftover = lines.removeLast(); |
| for (var line in lines) { |
| if (buffer.isNotEmpty) { |
| buffer.write(line); |
| line = buffer.toString(); |
| buffer = new StringBuffer(); |
| } |
| |
| sink.add(line); |
| } |
| buffer.write(leftover); |
| }, handleDone: (sink) { |
| if (buffer.isNotEmpty) sink.add(buffer.toString()); |
| sink.close(); |
| })); |
| } |
| |
| // TODO(nweiz): unify the following functions with the utility functions in |
| // pkg/http. |
| |
| /// Like [String.split], but only splits on the first occurrence of the pattern. |
| /// |
| /// This always returns an array of two elements or fewer. |
| List<String> split1(String toSplit, String pattern) { |
| if (toSplit.isEmpty) return <String>[]; |
| |
| var index = toSplit.indexOf(pattern); |
| if (index == -1) return [toSplit]; |
| return [ |
| toSplit.substring(0, index), |
| toSplit.substring(index + pattern.length) |
| ]; |
| } |
| |
| /// Adds additional query parameters to [url], overwriting the original |
| /// parameters if a name conflict occurs. |
| Uri addQueryParameters(Uri url, Map<String, String> parameters) { |
| var queryMap = queryToMap(url.query); |
| queryMap.addAll(parameters); |
| return url.resolve("?${mapToQuery(queryMap)}"); |
| } |
| |
| /// Convert a URL query string (or `application/x-www-form-urlencoded` body) |
| /// into a [Map] from parameter names to values. |
| Map<String, String> queryToMap(String queryList) { |
| var map = <String, String>{}; |
| for (var pair in queryList.split("&")) { |
| var split = split1(pair, "="); |
| if (split.isEmpty) continue; |
| var key = urlDecode(split[0]); |
| var value = split.length > 1 ? urlDecode(split[1]) : ""; |
| map[key] = value; |
| } |
| return map; |
| } |
| |
| /// Convert a [Map] from parameter names to values to a URL query string. |
| String mapToQuery(Map<String, String> map) { |
| var pairs = <List<String>>[]; |
| map.forEach((key, value) { |
| key = Uri.encodeQueryComponent(key); |
| value = (value == null || value.isEmpty) |
| ? null |
| : Uri.encodeQueryComponent(value); |
| pairs.add([key, value]); |
| }); |
| return pairs.map((pair) { |
| if (pair[1] == null) return pair[0]; |
| return "${pair[0]}=${pair[1]}"; |
| }).join("&"); |
| } |
| |
| /// Returns the union of all elements in each set in [sets]. |
| Set<T> unionAll<T>(Iterable<Set<T>> sets) => |
| sets.fold(new Set(), (union, set) => union.union(set)); |
| |
| /// Returns a human-friendly representation of [inputPath]. |
| /// |
| /// If [inputPath] isn't too distant from the current working directory, this |
| /// will return the relative path to it. Otherwise, it will return the absolute |
| /// path. |
| String nicePath(String inputPath) { |
| var relative = path.relative(inputPath); |
| var split = path.split(relative); |
| if (split.length > 1 && split[0] == '..' && split[1] == '..') { |
| return path.absolute(inputPath); |
| } |
| return relative; |
| } |
| |
| /// Returns a human-friendly representation of [duration]. |
| String niceDuration(Duration duration) { |
| var hasMinutes = duration.inMinutes > 0; |
| var result = hasMinutes ? "${duration.inMinutes}:" : ""; |
| |
| var s = duration.inSeconds % 60; |
| var ms = duration.inMilliseconds % 1000; |
| |
| // If we're using verbose logging, be more verbose but more accurate when |
| // reporting timing information. |
| var msString = log.verbosity.isLevelVisible(log.Level.FINE) |
| ? padLeft(ms.toString(), 3, '0') |
| : (ms ~/ 100).toString(); |
| |
| return "$result${hasMinutes ? padLeft(s.toString(), 2, '0') : s}" |
| ".${msString}s"; |
| } |
| |
| /// Decodes a URL-encoded string. |
| /// |
| /// Unlike [Uri.decodeComponent], this includes replacing `+` with ` `. |
| String urlDecode(String encoded) => |
| Uri.decodeComponent(encoded.replaceAll("+", " ")); |
| |
| /// Takes a simple data structure (composed of [Map]s, [Iterable]s, scalar |
| /// objects, and [Future]s) and recursively resolves all the [Future]s contained |
| /// within. |
| /// |
| /// Completes with the fully resolved structure. |
| Future<T> awaitObject<T>(T object) async { |
| // Unroll nested futures. |
| if (object is Future) return await awaitObject(await object); |
| |
| if (object is Iterable) { |
| return await Future.wait(object.map(awaitObject)) as T; |
| } |
| |
| if (object is Map) { |
| var newMap = {}; |
| await Future.wait(object.keys.map((key) async { |
| newMap[key] = await awaitObject(await object[key]); |
| })); |
| return newMap as T; |
| } |
| |
| return object; |
| } |
| |
| /// Whether "special" strings such as Unicode characters or color escapes are |
| /// safe to use. |
| /// |
| /// On Windows or when not printing to a terminal, only printable ASCII |
| /// characters should be used. |
| bool get canUseSpecialChars => |
| !runningFromTest && |
| !runningAsTest && |
| Platform.operatingSystem != 'windows' && |
| stdioType(stdout) == StdioType.TERMINAL; |
| |
| /// Gets a "special" string (ANSI escape or Unicode). |
| /// |
| /// On Windows or when not printing to a terminal, returns something else since |
| /// those aren't supported. |
| String getSpecial(String special, [String onWindows = '']) => |
| canUseSpecialChars ? special : onWindows; |
| |
| /// Prepends each line in [text] with [prefix]. |
| /// |
| /// If [firstPrefix] is passed, the first line is prefixed with that instead. |
| String prefixLines(String text, {String prefix: '| ', String firstPrefix}) { |
| var lines = text.split('\n'); |
| if (firstPrefix == null) { |
| return lines.map((line) => '$prefix$line').join('\n'); |
| } |
| |
| var firstLine = "$firstPrefix${lines.first}"; |
| lines = lines.skip(1).map((line) => '$prefix$line').toList(); |
| lines.insert(0, firstLine); |
| return lines.join('\n'); |
| } |
| |
| /// Whether today is April Fools' day. |
| bool get isAprilFools { |
| // Tests should never see April Fools' output. |
| if (runningFromTest) return false; |
| |
| var date = new DateTime.now(); |
| return date.month == 4 && date.day == 1; |
| } |
| |
| /// Wraps [fn] to guard against several different kinds of stack overflow |
| /// exceptions: |
| /// |
| /// * A sufficiently long [Future] chain can cause a stack overflow if there are |
| /// no asynchronous operations in it (issue 9583). |
| /// * A recursive function that recurses too deeply without an asynchronous |
| /// operation can cause a stack overflow. |
| /// * Even if the former is guarded against by adding asynchronous operations, |
| /// returning a value through the [Future] chain can still cause a stack |
| /// overflow. |
| Future resetStack(fn()) { |
| // Using a [Completer] breaks the [Future] chain for the return value and |
| // avoids the third case described above. |
| var completer = new Completer(); |
| |
| // Using [new Future] adds an asynchronous operation that works around the |
| // first and second cases described above. |
| newFuture(fn).then((val) { |
| scheduleMicrotask(() => completer.complete(val)); |
| }).catchError((err, stackTrace) { |
| scheduleMicrotask(() => completer.completeError(err, stackTrace)); |
| }); |
| return completer.future; |
| } |
| |
| /// The subset of strings that don't need quoting in YAML. |
| /// |
| /// This pattern does not strictly follow the plain scalar grammar of YAML, |
| /// which means some strings may be unnecessarily quoted, but it's much simpler. |
| final _unquotableYamlString = new RegExp(r"^[a-zA-Z_-][a-zA-Z_0-9-]*$"); |
| |
| /// Converts [data], which is a parsed YAML object, to a pretty-printed string, |
| /// using indentation for maps. |
| String yamlToString(data) { |
| var buffer = new StringBuffer(); |
| |
| _stringify(bool isMapValue, String indent, data) { |
| // TODO(nweiz): Serialize using the YAML library once it supports |
| // serialization. |
| |
| // Use indentation for (non-empty) maps. |
| if (data is Map && data.isNotEmpty) { |
| if (isMapValue) { |
| buffer.writeln(); |
| indent += ' '; |
| } |
| |
| // Sort the keys. This minimizes deltas in diffs. |
| var keys = data.keys.toList(); |
| keys.sort((a, b) => a.toString().compareTo(b.toString())); |
| |
| var first = true; |
| for (var key in keys) { |
| if (!first) buffer.writeln(); |
| first = false; |
| |
| var keyString = key; |
| if (key is! String || !_unquotableYamlString.hasMatch(key)) { |
| keyString = JSON.encode(key); |
| } |
| |
| buffer.write('$indent$keyString:'); |
| _stringify(true, indent, data[key]); |
| } |
| |
| return; |
| } |
| |
| // Everything else we just stringify using JSON to handle escapes in |
| // strings and number formatting. |
| var string = data; |
| |
| // Don't quote plain strings if not needed. |
| if (data is! String || !_unquotableYamlString.hasMatch(data)) { |
| string = JSON.encode(data); |
| } |
| |
| if (isMapValue) { |
| buffer.write(' $string'); |
| } else { |
| buffer.write('$indent$string'); |
| } |
| } |
| |
| _stringify(false, '', data); |
| return buffer.toString(); |
| } |
| |
| /// Throw a [ApplicationException] with [message]. |
| @alwaysThrows |
| void fail(String message, [innerError, StackTrace innerTrace]) { |
| if (innerError != null) { |
| throw new WrappedException(message, innerError, innerTrace); |
| } else { |
| throw new ApplicationException(message); |
| } |
| } |
| |
| /// Throw a [DataException] with [message] to indicate that the command has |
| /// failed because of invalid input data. |
| /// |
| /// This will report the error and cause pub to exit with [exit_codes.DATA]. |
| void dataError(String message) => throw new DataException(message); |
| |
| /// Returns a UUID in v4 format as a `String`. |
| /// |
| /// If [bytes] is provided, it must be length 16 and have values between `0` and |
| /// `255` inclusive. |
| /// |
| /// If [bytes] is not provided, it is generated using `Random.secure`. |
| String createUuid([List<int> bytes]) { |
| var rnd = new math.Random.secure(); |
| |
| // See http://www.cryptosys.net/pki/uuid-rfc4122.html for notes |
| bytes ??= new List<int>.generate(16, (_) => rnd.nextInt(256)); |
| bytes[6] = (bytes[6] & 0x0F) | 0x40; |
| bytes[8] = (bytes[8] & 0x3f) | 0x80; |
| |
| var chars = bytes |
| .map((b) => b.toRadixString(16).padLeft(2, '0')) |
| .join() |
| .toUpperCase(); |
| |
| return '${chars.substring(0, 8)}-${chars.substring(8, 12)}-' |
| '${chars.substring(12, 16)}-${chars.substring(16, 20)}-${chars.substring(20, 32)}'; |
| } |