Regex Garden

Overall structure

Tree Module

The tree module consists of an internal representation of the regex, using a tree structure with associated name, functionality, and example(s) for each node. This structure contains various methods for manipulating itself, and is capable of recursively generating examples and garden code, as well as reading in garden code to reformat and populate the tree generated by the regex module.

Regex Module

The regex module handles particular implementations of regular expressions. It generates regex code from the format stored by the tree module, creates tree module representations from regex code, indicates what features are available in the current implementation, and if the implementation is available (e.g. python's) runs each node's portion of the regex on its examples. If no implementation is available, a second regex module is created, using an implementation which is available to run tests.

UI Module

The user interface (UI) module handles all interaction with the user. As such, it contains the main control loop (in whatever form it appears) and calls the other two modules as need arises.