refs/tags/1.1.0 - string_scanner

commit	0e53bf9059e8e22a3b346aac7ec755a0f8314eb6	[log] [tgz]
author	Nate Bosch <nbosch@google.com>	Tue Feb 02 15:49:51 2021 -0800
committer	GitHub <noreply@github.com>	Tue Feb 02 15:49:51 2021 -0800
tree	4fb4ec766c24fb08f12f9ecaf603de212e7bd2e5
parent	1719b933f1e46b302f0170df205144831f35958d [diff]

tree: 4fb4ec766c24fb08f12f9ecaf603de212e7bd2e5

README.md

This package exposes a StringScanner type that makes it easy to parse a string using a series of Patterns. For example:

import 'dart:math' as math;

import 'package:string_scanner/string_scanner.dart';

num parseNumber(String source) {
  // Scan a number ("1", "1.5", "-3").
  final scanner = StringScanner(source);

  // [Scanner.scan] tries to consume a [Pattern] and returns whether or not it
  // succeeded. It will move the scan pointer past the end of the pattern.
  final negative = scanner.scan('-');

  // [Scanner.expect] consumes a [Pattern] and throws a [FormatError] if it
  // fails. Like [Scanner.scan], it will move the scan pointer forward.
  scanner.expect(RegExp(r'\d+'));

  // [Scanner.lastMatch] holds the [MatchData] for the most recent call to
  // [Scanner.scan], [Scanner.expect], or [Scanner.matches].
  var number = num.parse(scanner.lastMatch[0]);

  if (scanner.scan('.')) {
    scanner.expect(RegExp(r'\d+'));
    final decimal = scanner.lastMatch[0];
    number += int.parse(decimal) / math.pow(10, decimal.length);
  }

  // [Scanner.expectDone] will throw a [FormatError] if there's any input that
  // hasn't yet been consumed.
  scanner.expectDone();

  return (negative ? -1 : 1) * number;
}