refs/tags/1.1.1 - string_scanner

commit	12598070ac8f248132bd877f21f99176cb67f7e6	[log] [tgz]
author	Devon Carew <devoncarew@google.com>	Thu May 12 10:09:18 2022 -0700
committer	GitHub <noreply@github.com>	Thu May 12 10:09:18 2022 -0700
tree	4aef0f9f13301763c2c73ab8dff388587c7fc17e
parent	6579871b528036767b3200b390a3ecef28e4900d [diff]

tree: 4aef0f9f13301763c2c73ab8dff388587c7fc17e

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;
}