Carvable

Allows you to remove and change parts of something, without modifying the original. The carvable object returns a result with the changes applied.

With this, it's possible to hide sections of a string that would be created by objects. For instance, hiding child nodes inside AstNode.

final AstNode node;
final AstNode child = node.childEntities.elementAt(0) as AstNode;

print(node.remove(child).apply());

The position of the child could change at any time, and it would still hide the correct section in the string.

Features

• Carvable generic interface
• Carvable String
• Carvable Analyzer objects, such as AstNode, Element and LibraryElement

Getting Started

dart pub add carvable

And import the package:

import 'package:carvable/carvable.dart';

Usage

Get the carvable object of a String.

final CarvableString carvable = 'abcd'.carvable;

You may add carving zones, such as a carving range:

carvable.remove(1, 3);

The range is inclusive in the first value and exclusive in the second value.

After carving all zones, you can apply to get the result:

print(carvable.apply()); // 'ad'

Carvable

Carvable objects are objects which receive carving zones to be used to delimit how the result will be.

This object may accept any carving zone type, but might not apply all of them, depending on the Carvable implementation.

After adding the carving zones you may apply those zones to get the result.

class CarvableExample extends Carvable<String, CarvingRange> {
  @override
  String apply() {
    for (final zone in carvings) {
      // ...
    }
  }
}

Zones

Zones are basic data structures with the information needed to carve a part of the object.

This data can be anything, from a number to a complex path, or even any already existing object. What matters is that this zone will imprint something into the final result.

class CarvingRange {
  final int start;
  final int end;

  CarvingRange(this.start, this.end);
}

Example

Carvable String (/example/main.dart)

import 'package:carvable/carvable.dart';

void main() {
  final carvable = CarvableString('abcd');
  carvable.remove(1, 2);
  print(carvable.apply()); // 'acd'

  print('abcde'.remove(1, 2).remove(3, 4).apply()); // 'ace'
}

Contributing

Contributions are welcome! Please open an issue or pull request if you find a bug or have a feature request.

Libraries

carvable

carvable_analyzer