README
¶
Katydid
Katydid is a toolkit for trees.
Currently there are three tools in the katydid toolkit:
- Relapse: a regular expression type language for trees that matches up to 1000000s of records per second,
- A collection of parsers (protobuf, json, xml, reflected go structures) which are easily extendable, and
- A collection of encoders (protobuf, json, xml, reflected go structures) which are useful for dynamic transcoding.
Directories
¶
| Path | Synopsis |
|---|---|
|
encode
|
|
|
json
Package json encodes a parser.Interface into json.
|
Package json encodes a parser.Interface into json. |
|
proto
Package proto encodes a parser.Interface into marshaled protocol buffer.
|
Package proto encodes a parser.Interface into marshaled protocol buffer. |
|
reflect
Package reflect encodes a parser.Interface into a reflected go structure.
|
Package reflect encodes a parser.Interface into a reflected go structure. |
|
xml
Package xml encodes a parser.Interface into xml.
|
Package xml encodes a parser.Interface into xml. |
|
Package gen contains some internal utilities for code generation
|
Package gen contains some internal utilities for code generation |
|
Code generated by parser-gen.
|
Code generated by parser-gen. |
|
debug
The debug package is great for testing and debugging of parser.Interface implementations.
|
The debug package is great for testing and debugging of parser.Interface implementations. |
|
debug/debug-gen
Command debug-gen generates some of the code in the debug package.
|
Command debug-gen generates some of the code in the debug package. |
|
json
Package json contains the implementation of a JSON parser.
|
Package json contains the implementation of a JSON parser. |
|
parser-gen
Command parser-gen generates some of the code in the parser package.
|
Command parser-gen generates some of the code in the parser package. |
|
proto
Package proto contains an implementation of a protocol buffer parser.
|
Package proto contains an implementation of a protocol buffer parser. |
|
proto/prototests
Package prototests contains some structures and values that are useful for testing the protocol buffer parser.
|
Package prototests contains some structures and values that are useful for testing the protocol buffer parser. |
|
reflect
Package reflect contains an implementation of a parser for a reflected go structure.
|
Package reflect contains an implementation of a parser for a reflected go structure. |
|
xml
Package xml contains a parser for XML.
|
Package xml contains a parser for XML. |
|
Package relapse contains the relapse validation language and the functions necessary for running it.
|
Package relapse contains the relapse validation language and the functions necessary for running it. |
|
ast
Package ast contains the abstract syntax tree for relapse.
|
Package ast contains the abstract syntax tree for relapse. |
|
auto
Package auto compiles a parsed relapse grammar into a visual pushdown automaton and executes it.
|
Package auto compiles a parsed relapse grammar into a visual pushdown automaton and executes it. |
|
bnf
Package bnf contains the bnf (Backus–Naur Form) files for generating the parser, lexer, token and errors package.
|
Package bnf contains the bnf (Backus–Naur Form) files for generating the parser, lexer, token and errors package. |
|
combinator
Package combinator provides a user friendly way of constructing a relapse abstract syntax tree.
|
Package combinator provides a user friendly way of constructing a relapse abstract syntax tree. |
|
compose
Code generated by compose-gen.
|
Code generated by compose-gen. |
|
compose/compose-gen
Command compose-gen generates some of the code in the compose package.
|
Command compose-gen generates some of the code in the compose package. |
|
errors
Package errors is generated from the bnf using gocc.
|
Package errors is generated from the bnf using gocc. |
|
funcs
Code generated by funcs-gen.
|
Code generated by funcs-gen. |
|
funcs/funcs-gen
Command funcs-gen generates some of the code in the funcs package.
|
Command funcs-gen generates some of the code in the funcs package. |
|
interp
Package interp contains functions to interpret the grammar.
|
Package interp contains functions to interpret the grammar. |
|
lexer
Package lexer is generated from the bnf using gocc.
|
Package lexer is generated from the bnf using gocc. |
|
mem
Package mem contains functions to interpret and memoize the execution of the grammar.
|
Package mem contains functions to interpret and memoize the execution of the grammar. |
|
name
Package name has functions for a parsed name expression which include compilation and evaluation.
|
Package name has functions for a parsed name expression which include compilation and evaluation. |
|
parser
Package parser is mostly generated from the bnf using gocc.
|
Package parser is mostly generated from the bnf using gocc. |
|
protonum
Package protonum is used to rewrite field names to field numbers in relapse grammars.
|
Package protonum is used to rewrite field names to field numbers in relapse grammars. |
|
token
Package token is generated from the bnf using gocc.
|
Package token is generated from the bnf using gocc. |
|
types
Package types contains representations of the relapse types.
|
Package types contains representations of the relapse types. |
Click to show internal directories.
Click to hide internal directories.