General cleanup.

Author: renggli

README.md

@@ -109,7 +109,6 @@ print(id.accept('foo'));                // true
 print(id.accept('123'));                // false
 ```
 
-
 ### Different Kinds of Parsers
 
 PetitParser provides a large set of ready-made parser that you can compose to consume and transform arbitrarily complex languages. 
@@ -130,8 +129,11 @@ Terminal parsers are the simplest. We've already seen a few of those:
 - [`whitespace()`](https://pub.dev/documentation/petitparser/latest/petitparser/whitespace.html) parses a whitespace character, i.e. *␣* or *↦*.
 - [`word()`](https://pub.dev/documentation/petitparser/latest/petitparser/word.html) parses a single letter, digit, or the underscore character.
 
-By default all parsers use an automatically generated descriptive error message, match case-sensitive, and work on 16-bit UTF-16 code units.
+By default all parsers use an automatically generated descriptive error message, match case-sensitive, and work on 16-bit UTF-16 code units. To change this default behavior use the named arguments (where appropriate):
 
+- `message: 'expected a special character'` to use a custom error message,
+- `ignoreCase: true` to accept both lower- and uppercase variations, and
+- `unicode: true` to decode surrogate pairs and read Unicode code-points.
 
 #### Combinator Parsers
 

bin/generate_sequence.dart

@@ -223,32 +223,11 @@ Future<void> generateTest() async {
           'position: $j));');
       out.writeln('});');
     }
-    out.writeln('});');
-
-    out.writeln('group(\'toSequenceParser()\', () {');
-    out.writeln('final parser = ('
+    out.writeln('test(\'toSequenceParser()\', () {');
+    out.writeln('final alternate = ('
         '${chars.map((each) => 'char(\'$each\')').join(', ')}).toSequenceParser();');
-    out.writeln('const record = ('
-        '${chars.map((each) => '\'$each\'').join(', ')});');
-    out.writeln('expectParserInvariants(parser);');
-    out.writeln('test(\'success\', () {');
-    out.writeln('expect(parser, '
-        'isParseSuccess(\'$string\', result: record));');
-    out.writeln('expect(parser, '
-        'isParseSuccess(\'$string*\', result: record, position: $i));');
+    out.writeln('expect(alternate, isParserDeepEqual(parser));');
     out.writeln('});');
-    for (var j = 0; j < i; j++) {
-      out.writeln('test(\'failure at $j\', () {');
-      out.writeln('expect(parser, isParseFailure(\''
-          '${string.substring(0, j)}\', '
-          'message: \'"${chars[j]}" expected\', '
-          'position: $j));');
-      out.writeln('expect(parser, isParseFailure(\''
-          '${string.substring(0, j)}*\', '
-          'message: \'"${chars[j]}" expected\', '
-          'position: $j));');
-      out.writeln('});');
-    }
     out.writeln('});');
 
     out.writeln('group(\'map$i\', () {');

lib/parser.dart

@@ -10,7 +10,7 @@ export 'src/parser/action/map.dart';
 export 'src/parser/action/permute.dart';
 export 'src/parser/action/pick.dart';
 export 'src/parser/action/token.dart';
-export 'src/parser/action/trimming.dart';
+export 'src/parser/action/trim.dart';
 export 'src/parser/action/where.dart';
 export 'src/parser/character/any.dart';
 export 'src/parser/character/any_of.dart';
@@ -34,7 +34,7 @@ export 'src/parser/combinator/optional.dart';
 export 'src/parser/combinator/sequence.dart';
 export 'src/parser/combinator/settable.dart';
 export 'src/parser/combinator/skip.dart';
-export 'src/parser/misc/eof.dart';
+export 'src/parser/misc/end.dart';
 export 'src/parser/misc/epsilon.dart';
 export 'src/parser/misc/failure.dart';
 export 'src/parser/misc/label.dart';

lib/src/definition/grammar.dart

@@ -81,8 +81,8 @@ abstract class GrammarDefinition<R> {
 
   /// Builds a composite parser starting with the specified [parser].
   ///
-  /// As argument either pass a reference to a production of this definition or
-  /// any other parser using productions of this definition.
+  /// As argument either pass a reference to a production in this definition, or
+  /// any other parser using productions in this definition.
   @useResult
   Parser<T> buildFrom<T>(Parser<T> parser) => resolve<T>(parser);
 }

lib/src/parser/action/trimming.dart renamed to lib/src/parser/action/trim.dart

@@ -9,10 +9,8 @@ import 'utils/optimize.dart';
 @useResult
 Parser<String> anyOf(String value,
     {String? message, bool ignoreCase = false, bool unicode = false}) {
-  final predicate = ignoreCase
-      ? optimizedString('${value.toLowerCase()}${value.toUpperCase()}',
-          unicode: unicode)
-      : optimizedString(value, unicode: unicode);
+  final predicate =
+      optimizedString(value, ignoreCase: ignoreCase, unicode: unicode);
   message ??= 'any of "${toReadableString(value, unicode: unicode)}"'
       '${ignoreCase ? ' (case-insensitive)' : ''} expected';
   return CharacterParser(predicate, message, unicode: unicode);

lib/src/parser/character/any_of.dart

@@ -18,15 +18,9 @@ Parser<String> char(String value,
     {String? message, bool ignoreCase = false, bool unicode = false}) {
   final charCode = toCharCode(value, unicode: unicode);
   final predicate = ignoreCase
-      ? optimizedString('${value.toLowerCase()}${value.toUpperCase()}',
-          unicode: unicode)
+      ? optimizedString(value, ignoreCase: ignoreCase, unicode: unicode)
       : SingleCharPredicate(charCode);
   message ??= '"${toReadableString(value, unicode: unicode)}"'
       '${ignoreCase ? ' (case-insensitive)' : ''} expected';
   return CharacterParser(predicate, message, unicode: unicode);
 }
-
-@useResult
-@Deprecated('Use `char(value, message: message, ignoreCase: true)` instead')
-Parser<String> charIgnoringCase(String value, [String? message]) =>
-    char(value, message: message, ignoreCase: true);

lib/src/parser/character/char.dart

@@ -10,10 +10,8 @@ import 'utils/optimize.dart';
 @useResult
 Parser<String> noneOf(String value,
     {String? message, bool ignoreCase = false, bool unicode = false}) {
-  final predicate = NotCharPredicate(ignoreCase
-      ? optimizedString('${value.toLowerCase()}${value.toUpperCase()}',
-          unicode: unicode)
-      : optimizedString(value, unicode: unicode));
+  final predicate = NotCharPredicate(
+      optimizedString(value, ignoreCase: ignoreCase, unicode: unicode));
   message ??= 'none of "${toReadableString(value, unicode: unicode)}"'
       '${ignoreCase ? ' (case-insensitive)' : ''} expected';
   return CharacterParser(predicate, message, unicode: unicode);

lib/src/parser/character/none_of.dart

@@ -4,7 +4,7 @@ import '../../core/parser.dart';
 import '../action/map.dart';
 import '../combinator/choice.dart';
 import '../combinator/sequence.dart';
-import '../misc/eof.dart';
+import '../misc/end.dart';
 import '../predicate/character.dart';
 import '../repeater/possessive.dart';
 import 'any.dart';
@@ -52,11 +52,6 @@ Parser<String> pattern(String pattern,
   return CharacterParser(predicate, message, unicode: unicode);
 }
 
-@useResult
-@Deprecated('Use `pattern(value, message: message, ignoreCase: true)` instead')
-Parser<String> patternIgnoreCase(String value, [String? message]) =>
-    pattern(value, message: message, ignoreCase: true);
-
 Parser<List<RangeCharPredicate>> _createParser({required bool unicode}) {
   // Parser that consumes a single character.
   final character = any(unicode: unicode);

lib/src/parser/character/pattern.dart

@@ -8,7 +8,7 @@ abstract class CharacterPredicate {
   /// Tests if the [charCode] satisfies the predicate.
   bool test(int charCode);
 
-  /// Compares the two predicates for equality.
+  /// Compares the predicate and [other] for equality.
   bool isEqualTo(CharacterPredicate other);
 
   @override

lib/src/parser/character/predicate.dart

@@ -5,11 +5,14 @@ import '../predicate/lookup.dart';
 import '../predicate/range.dart';
 
 /// Creates an optimized character from a string.
-CharacterPredicate optimizedString(String string, {required bool unicode}) =>
-    optimizedRanges(
-        (unicode ? string.runes : string.codeUnits)
-            .map((value) => RangeCharPredicate(value, value)),
-        unicode: unicode);
+CharacterPredicate optimizedString(String string,
+    {required bool unicode, bool ignoreCase = false}) {
+  if (ignoreCase) string = '${string.toLowerCase()}${string.toUpperCase()}';
+  return optimizedRanges(
+      (unicode ? string.runes : string.codeUnits)
+          .map((value) => RangeCharPredicate(value, value)),
+      unicode: unicode);
+}
 
 /// Creates an optimized predicate from a list of range predicates.
 CharacterPredicate optimizedRanges(Iterable<RangeCharPredicate> ranges,

lib/src/parser/character/utils/optimize.dart

@@ -22,8 +22,3 @@ Parser<String> string(String string,
             message ?? '"$string" (case-insensitive) expected')
         : predicate(string.length, (value) => string == value,
             message ?? '"$string" expected');
-
-@useResult
-@Deprecated('Use `string(value, ignoreCase: true)` instead')
-Parser<String> stringIgnoreCase(String value, [String? message]) =>
-    string(value, message: message, ignoreCase: true);