Flutter组合逻辑插件belatuk_combinator的使用

Flutter组合逻辑插件belatuk_combinator的使用

简介

belatuk_combinator 是一个用于构建解析器的库，支持静态类型、泛型、文件跨度、记忆化等功能。它是 package:combinator 的替代品，并引入了对非空安全（NNBD）的支持。

基本用法

以下是一个简单的示例，展示了如何使用 belatuk_combinator 来解析字符串：

void main() {
  // 解析模式（通常是字符串或正则表达式）
  var foo = match('foo');
  var number = match(RegExp(r'[0-9]+'), errorMessage: 'Expected a number.');

  // 设置值
  var numWithValue = number.map((r) => int.parse(r.span.text));

  // 可选模式
  var optional = numWithValue.opt();

  // 零次或多次
  var star = optional.star();

  // 一次或多次
  var plus = optional.plus();

  // 指定次数
  var threeTimes = optional.times(3);

  // 顺序模式
  var doraTheExplorer = chain([
    match('Dora').space(),
    match('the').space(),
    match('Explorer').space(),
  ]);

  // 选择第一个匹配的模式
  var alt = any([
    match('1'),
    match('11'),
    match('111'),
  ]);

  // 选择最长的匹配
  var alt2 = longest([
    match('1'),
    match('11'),
    match('111'),
  ]);

  // 友好操作符
  var fooOrNumber = foo | number;
  var fooAndNumber = foo & number;
  var notFoo = ~foo;
}

错误消息

为了提高用户体验，belatuk_combinator 提供了详细的错误处理功能：

void main(Parser parser) {
  // 如果模式不匹配，添加自定义错误消息
  var withError = parser.error(errorMessage: 'Hey!!! Wrong!!!');

  // 设置错误的严重性
  var asHint = parser.error(severity: SyntaxErrorSeverity.hint);

  // `any`、`chain` 和 `longest` 也支持错误消息
  var foo = longest([
    parser.error(errorMessage: 'foo'),
    parser.error(errorMessage: 'bar')
  ], errorMessage: 'Expected a "foo" or a "bar"');

  // 使用 `foldErrors` 减少同一位置的多个错误
  var lessNoise = parser.foldErrors();
}

处理空白字符

处理可选的空白字符非常简单：

void main(Parser parser) {
  var optionalSpace = parser.space();
}

编程语言解析

belatuk_combinator 旨在简化复杂语法（如编程语言）的解析，提供了许多内置函数来处理常见的结构：

void main(Parser parser) {
  // 解析数组
  var array = parser
                .separatedByComma()
                .surroundedBySquareBrackets(defaultValue: []);

  // 解析大括号内的内容
  var braces = parser.surroundedByCurlyBraces();

  // 使用自定义分隔符
  var sep = parser.separatedBy(match('!').space());
}

完整示例

以下是一个完整的示例，展示了如何使用 belatuk_combinator 来解析用户输入的数字：

import 'dart:io';
import 'package:belatuk_combinator/belatuk_combinator.dart';
import 'package:string_scanner/string_scanner.dart';

// 匹配负号
final Parser minus = match('-');

// 匹配单个数字
final Parser<int> digit =
    match(RegExp(r'[0-9]'), errorMessage: 'Expected a number');

// 匹配多个数字
final Parser digits = digit.plus();

// 匹配小数点
final Parser dot = match('.');

// 匹配小数（整数部分，可选的小数部分）
final Parser decimal = (digits & (dot & digits).opt());

// 匹配带符号的数字
final Parser number = (minus.opt() & decimal).map<num>((r) => num.parse(r.span!.text));

void main() {
  while (true) {
    stdout.write('Enter a number: ');
    var line = stdin.readLineSync()!;
    var scanner = SpanScanner(line, sourceUrl: 'stdin');
    var result = number.parse(scanner);

    if (!result.successful) {
      for (var error in result.errors) {
        stderr.writeln(error.toolString);
        stderr.writeln(error.span!.highlight(color: true));
      }
    } else {
      print(result.value);
    }
  }
}