search

microsoft / tolerant-php-parser

An early-stage PHP parser designed for IDE usage scenarios.
MIT License
882 stars 80 forks source link

Implement RecursiveIterator #130

Open felixfbecker opened 7 years ago

felixfbecker commented 7 years ago

PHP has native interfaces and classes for Iterators (Generator implements Iterator). Iterators can be traversed with foreach and composed easily, for example by filtering through CallbackFilterIterator.

In particular, it has the RecursiveIterator interface, that adds two more methods to implement: hasChildren() and getChildren(). This allows it to be traversed with a RecursiveIteratorIterator, which has countless options for emitting all nodes or just leaves, using level order, etc. ParentIterator can be used to visit just nodes with child nodes, RecursiveLimitIterator to limit the nodes traversed, AppendIterator to concatenate Iterators, RecursiveTreeIterator can be used to draw an ASCII tree of an AST and RecursiveCallbackFilterIterator to filter nodes (including skipping children). Really a lot of awesome stuff in there.

The Parser already uses Generators for traversal, which is great, but it only has limited options for filtering and skipping certain children through a callback: https://sourcegraph.com/github.com/Microsoft/tolerant-php-parser/-/blob/src/Node.php#L158-159 I think providing class-based implementations for Iterators would give greater flexibility.

jens1o commented 7 years ago

Actually, that was my idea creating a pr, after the pr has been merged. But you are stealing my ideas constantly. :D

felixfbecker commented 7 years ago

Well, go ahead. Don't let me keep you :)

jens1o commented 7 years ago

@roblourens Are you fine with this change? I would start getting on this.

felixfbecker commented 7 years ago

@jens1o Already almost finished ;)

jens1o commented 7 years ago

Sorry, so you had implemented that already? Okay. Then I search for other things :D