Ribs

Appearance

ribs_parse›Classes›Expectation

Expectation sealed ​

sealedclassExpectation

Annotations: @immutable

Represents what was expected at a given offset when a parse failed.

The sealed hierarchy covers every way a parser can express failure: character ranges, literal strings, positional anchors, explicit failures, and named contexts.

Implementers

Constructors ​

Expectation.endOfString() factory ​

factoryExpectation.endOfString(intoffset,intlength)

The input was expected to end at offset; length is the total input length.

Implementation
dart
factory Expectation.endOfString(int offset, int length) => EndOfString(offset, length);

Expectation.expectedFailureAt() factory ​

factoryExpectation.expectedFailureAt(intoffset,Stringmatched)

A not/peek-style parser failed because matched was present at offset.

Implementation
dart
factory Expectation.expectedFailureAt(int offset, String matched) =>
    ExpectedFailureAt(offset, matched);

Expectation.fail() factory ​

factoryExpectation.fail(intoffset)

An unconditional failure was expected at offset.

Implementation
dart
factory Expectation.fail(int offset) => ExpectationFail(offset);

Expectation.failWith() factory ​

factoryExpectation.failWith(intoffset,Stringmessage)

An unconditional failure with message was expected at offset.

Implementation
dart
factory Expectation.failWith(int offset, String message) => ExpectationFailWith(offset, message);

Expectation.inRange() factory ​

factoryExpectation.inRange(intoffset,Charlower,Charupper)

A character in the range [lower, upper] was expected at offset.

Implementation
dart
factory Expectation.inRange(int offset, Char lower, Char upper) => InRange(offset, lower, upper);

Expectation.length() factory ​

factoryExpectation.length(intoffset,intexpected,intactual)

A fixed-length parser needed expected characters but only actual were available.

Implementation
dart
factory Expectation.length(int offset, int expected, int actual) =>
    Length(offset, expected, actual);

Expectation.oneOfStr() factory ​

factoryExpectation.oneOfStr(intoffset,IList<String>strs)

One of the literal strings in strs was expected at offset.

Implementation
dart
factory Expectation.oneOfStr(int offset, IList<String> strs) => OneOfStr(offset, strs);

Expectation.startOfString() factory ​

factoryExpectation.startOfString(intoffset)

The input was expected to start (offset 0) at offset.

Implementation
dart
factory Expectation.startOfString(int offset) => StartOfString(offset);

Expectation.withContext() factory ​

factoryExpectation.withContext(Stringcontext,Expectationinner)

Wraps inner with a user-supplied context label for richer diagnostics.

Implementation
dart
factory Expectation.withContext(String context, Expectation inner) =>
    WithContext(inner.offset, context, inner);

Properties ​

hashCode no setter override ​

intgethashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Implementation
dart
@override
int get hashCode;

offset final ​

finalintoffset

The character offset at which this expectation was not met.

Implementation
dart
final int offset;

runtimeType no setter inherited ​

TypegetruntimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

Methods ​

noSuchMethod() inherited ​

dynamicnoSuchMethod(Invocationinvocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
dart
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited ​

StringtoString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation
dart
external String toString();

Operators ​

operator ==() override ​

booloperator ==(Objectother)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Implementation
dart
@override
bool operator ==(Object other);

Static Methods ​

unify() ​

NonEmptyIList<Expectation>unify(NonEmptyIList<Expectation>errors)
Implementation
dart
static NonEmptyIList<Expectation> unify(NonEmptyIList<Expectation> errors) {
  List<String> contextOf(Expectation e) {
    final ctx = <String>[];
    var current = e;

    while (current is WithContext) {
      ctx.add(current.context);
      current = current.inner;
    }

    return ctx;
  }

  Expectation stripContext(Expectation e) {
    var current = e;

    while (current is WithContext) {
      current = current.inner;
    }

    return current;
  }

  Expectation addContext(List<String> revCtx, Expectation e) {
    var result = e;

    for (final ctx in revCtx) {
      result = WithContext(result.offset, ctx, result);
    }

    return result;
  }

  &#47;&#47; Group by (offset, context chain). Use a string key since List lacks value equality.
  final groups = <String, ({int offset, List<String> ctx, List<Expectation> items})>{};

  for (final e in errors.toList()) {
    final ctx = contextOf(e);
    final key = '${e.offset}:\x00${ctx.join('\x00')}';
    final existing = groups[key];

    if (existing != null) {
      existing.items.add(e);
    } else {
      groups[key] = (offset: e.offset, ctx: ctx, items: [e]);
    }
  }

  final result = <Expectation>[];

  for (final group in groups.values) {
    final ranges = <InRange>[];
    final oneOfStrs = <OneOfStr>[];
    final fails = <Expectation>[];
    final others = <Expectation>[];

    for (final e in group.items) {
      switch (stripContext(e)) {
        case final InRange ir:
          ranges.add(ir);
        case final OneOfStr oos:
          oneOfStrs.add(oos);
        case ExpectationFail() || ExpectationFailWith():
          fails.add(stripContext(e));
        case final other:
          others.add(other);
      }
    }

    final mergedRanges = _mergeInRange(ranges);
    final mergedOneOfStr = _mergeOneOfStr(group.offset, oneOfStrs);

    final combined = [...others, ...mergedOneOfStr, ...mergedRanges];
    final finals = combined.isEmpty ? fails : combined;

    final ctx = group.ctx;

    if (ctx.isNotEmpty) {
      final revCtx = ctx.reversed.toList();
      result.addAll(finals.map((e) => addContext(revCtx, e)));
    } else {
      result.addAll(finals);
    }
  }

  &#47;&#47; Deduplicate while preserving order.
  final seen = <Expectation>{};
  final distinct = <Expectation>[];

  for (final e in result) {
    if (seen.add(e)) distinct.add(e);
  }

  return NonEmptyIList.fromDartUnsafe(distinct);
}