Module Hierarchy

lepl: Lepl is a parser library written in Python.
- lepl._test: Tests for the lepl package.
  - lepl._test.base: Support for matcher tests.
  - lepl._test.bug_stalled_parser: Tests for a regexp bug.
  - lepl._test.magus: Tests for a bug reported for 3.2, 3.2.1
- lepl.apps
  - lepl.apps._test: Tests for the lepl.apps package.
    - lepl.apps._test.json
    - lepl.apps._test.rfc3696: Tests for the lepl.apps.rfc3696 module.
  - lepl.apps.json: Punt to the contrib package (this is just to keep copyright clear).
  - lepl.apps.rfc3696: Matchers for validating URIs and related objects, taken from RFC3696.
- lepl.bin: Parse (and construct) binary data.
  - lepl.bin._test: Tests for the lepl.bin package.
    - lepl.bin._test.bits: Tests for the lepl.bin.bits module.
    - lepl.bin._test.encode: Tests for the lepl.bin.encode module.
    - lepl.bin._test.literal: Tests for the lepl.bin.literal module.
    - lepl.bin._test.matchers: Tests for the lepl.bin.matchers module.
  - lepl.bin.bits: Storage of binary values of arbitrary length.
  - lepl.bin.encode: Convert structured Python data to a binary stream.
  - lepl.bin.literal: Specify and construct binary structures.
  - lepl.bin.matchers: Matchers specifically for binary data (most LEPL matchers can be used with binary data, but additional support is needed when the matching involves a literal comparison or generation of a binary result).
- lepl.cairo: This is a possibly temporary addition to lepl - a higher level wrapper to the pycairo library.
  - lepl.cairo._test: Tests for the lepl.cairo package.
    - lepl.cairo._test.colour: Test the Colour class.
  - lepl.cairo.colour: Provide some short-hand colour definitions for cairo.
  - lepl.cairo.context: Provide a with-context syntax for cairo.
- lepl.contrib: Contributed code.
  - lepl.contrib.json: http://www.ietf.org/rfc/rfc4627.txt
  - lepl.contrib.matchers: Contributed matchers.
- lepl.core: Core classes, related to parsing, config etc.
  - lepl.core._test: Tests for the lepl.core package.
    - lepl.core._test.config: Tests for the lepl.core.config module.
    - lepl.core._test.manager: Tests for the lepl.core.manager module.
    - lepl.core._test.parser: Tests for the lepl.core.parser module.
    - lepl.core._test.rewrite_delayed_bug: Tests for bug reprted on the mailing list.
    - lepl.core._test.rewrite_repeat_bug: Tests for bug reprted on the mailing list.
    - lepl.core._test.rewriters
  - lepl.core.config: The main configuration object and various standard configurations.
  - lepl.core.manager: Manage resources.
  - lepl.core.monitor: Support for classes that monitor the execution process (for example, managing resources and tracing program flow).
  - lepl.core.parser: Create and evaluate parsers.
  - lepl.core.rewriters: Rewriters modify the graph of matchers before it is used to generate a parser.
  - lepl.core.trace: Tools for logging and tracing.
- lepl.lexer: A lexer (tokenizer) for Lepl.
  - lepl.lexer._test: Tests for the lepl.lexer package.
    - lepl.lexer._test.matchers: Wide range of tests for lexer.
    - lepl.lexer._test.stream: Check location data within tokens.
  - lepl.lexer.matchers: Generate and match a stream of tokens that are identified by regular expressions.
  - lepl.lexer.rewriters: Rewrite a matcher graph to include lexing.
  - lepl.lexer.stream: The token streams.
  - lepl.lexer.support: Support classes for the lexer.
- lepl.matchers: Matchers form the basis of the library; they are used to define the grammar and do the work of parsing the input.
  - lepl.matchers._test: Tests for the lepl.matchers package.
    - lepl.matchers._test.combine: Tests for the combining matchers.
    - lepl.matchers._test.core: Tests for the lepl.matchers.core module.
    - lepl.matchers._test.derived: Tests for the lepl.matchers.derived module.
    - lepl.matchers._test.error: Tests for the lepl.matchers.error module.
    - lepl.matchers._test.memo: Tests for the lepl.matchers.memo module.
    - lepl.matchers._test.operators: Tests for the lepl.matchers.operators module.
    - lepl.matchers._test.separators: Tests for the lepl.matchers.separators module.
    - lepl.matchers._test.support: Tests for the lepl.matchers.support module
    - lepl.matchers._test.transform: Tests for the lepl.matchers.transform module
    - lepl.matchers._test.variables: Tests for the lepl.matchers.variables module.
  - lepl.matchers._test3: Tests for the lepl.matchers package (Python 3 only - not include in final release)
    - lepl.matchers._test3.support: Tests for the lepl.matchers.support module (duplicate, including Python 3 only syntax)
  - lepl.matchers.combine: Matchers that combine sub-matchers (And, Or etc).
  - lepl.matchers.core: Matchers that embody fundamental, common actions.
  - lepl.matchers.derived: Matchers that are defined in terms of other matchers (ie the majority).
  - lepl.matchers.error: Error handling (generating an error while parsing).
  - lepl.matchers.matcher: Base class for matchers.
  - lepl.matchers.memo: Memoisation (both as described by Norvig 1991, giving Packrat parsers for non-left recursive grammars, and the equivalent described by Frost and Hafiz 2006 which allows left-recursive grammars to be used).
  - lepl.matchers.monitor: Matchers that interact with monitors.
  - lepl.matchers.operators: Support for operator syntactic sugar (and operator redefinition).
  - lepl.matchers.support: Support classes for matchers.
  - lepl.matchers.transform: A transformation is a function that modifies the result of calling a matcher once.
  - lepl.matchers.variables: Display information when matchers that are bound to variables are called.
- lepl.offside: Support for parsing with significant whitespace (the "offside rule" etc).
  - lepl.offside._test: Tests for the lepl.offside package.
    - lepl.offside._test.extension: Tests for the regexp extensions.
    - lepl.offside._test.indentation: Tests for indentation aware parsing.
    - lepl.offside._test.left_bug: See http://groups.google.com/group/lepl/browse_thread/thread/79e39e03a03718cc?hl=en_US
    - lepl.offside._test.matchers: Tests for the lepl.offside.matchers module (currently unused).
    - lepl.offside._test.offside: Tests for offside parsing.
    - lepl.offside._test.pithon: Test a Python-like grammar.
    - lepl.offside._test.regexp: Tests for the lepl.offside.regexp module.
    - lepl.offside._test.stream: Tests for the lepl.offside.stream module.
    - lepl.offside._test.text: An example that avoids using tokens with the line aware parsing.
    - lepl.offside._test.unicode: Further tests for the lepl.offside.regexp module.
    - lepl.offside._test.word_bug: Tests related to a bug when Word() is specified inside Token() with line-aware parsing.
  - lepl.offside.lexer: Tokens for indents.
  - lepl.offside.matchers: Matchers that are indent aware.
  - lepl.offside.monitor: Support the stack-scoped tracking of indent level blocks.
  - lepl.offside.regexp: Extend regular expressions to be aware of additional tokens for line start and end.
  - lepl.offside.stream: A stream that adds tokens at the start and end of lines.
  - lepl.offside.support: Support for offisde and line-aware parsing.
- lepl.regexp: Pure Python regular expression support.
  - lepl.regexp._test: Tests for the lepl.regexp package.
    - lepl.regexp._test.binary: Tests for the lepl.regexp.binary module.
    - lepl.regexp._test.core: Tests for the lepl.regexp.matchers module.
    - lepl.regexp._test.interval: Tests for the lepl.regexp.interval module.
    - lepl.regexp._test.matchers: Tests for the lepl.regexp.matchers module.
    - lepl.regexp._test.random
    - lepl.regexp._test.rewriters: Tests for the lepl.regexp.rewriters module.
    - lepl.regexp._test.unicode: Tests for the lepl.regexp.unicode module.
  - lepl.regexp.binary: A proof-of-concept regexp implementation for binary data strings.
  - lepl.regexp.core: A simple regular expression engine in pure Python.
  - lepl.regexp.interval
  - lepl.regexp.matchers: Matchers that call the regular expression engine.
  - lepl.regexp.rewriters: Rewrite the tree of matchers from the bottom up (as far as possible) using regular expressions.
  - lepl.regexp.str: Some intermediate classes that support parsers for objects that can be converted to strings using str().
  - lepl.regexp.unicode: A regexp implementation for unicode strings.
- lepl.stream: Streams are used to bind location data to text during parsing.
  - lepl.stream._test: Tests for the lepl.stream package.
    - lepl.stream._test.filters: Tests for the lepl.stream.filters module.
    - lepl.stream._test.maxdepth: Tests for the lepl.stream.maxdepth module.
    - lepl.stream._test.stream: Tests for the lepl.stream.stream module.
  - lepl.stream.filters: Filter and transform streams.
  - lepl.stream.maxdepth: Track the maximum depth of a stream.
  - lepl.stream.stream: Stream interfaces for the input, with an implementation using singly linked lists.
- lepl.support: Various support classes.
  - lepl.support._test: Tests for the lepl.matchers package.
    - lepl.support._test.graph: Tests for the lepl.support.graph module.
    - lepl.support._test.lib: Tests for the lepl.support.lib module.
    - lepl.support._test.list: Tests for the lepl.support.list module.
    - lepl.support._test.node: Tests for the lepl.support.node module.
  - lepl.support.context: Allow global per-thread values to be defined within a certain scope in a way that supports multiple values, temporary changes inside with contexts, etc.
  - lepl.support.graph: Graph traversal - supports generic Python classes, but has extensions for classes that record their own constructor arguments (and so allow deep cloning of graphs).
  - lepl.support.lib: Library routines / utilities (some unused).
  - lepl.support.list: Support for S-expression ASTs using subclasses of Python's list class.
  - lepl.support.node: Base classes for AST nodes (and associated functions).
  - lepl.support.state: Encapsulate global (per thread) state.