emileclarkb/hammer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
600 commits 2 branches 0 tags 3.4 MiB
Find a file
TQ Hirsch 274cbe38a9 Merge pull request #41 from thequux/install-target 
Added install target
2013-10-31 11:42:12 -07:00
docs Finshed up the regex backend 2013-04-26 20:36:54 -07:00
examples Added new build system 2013-07-10 21:32:05 +02:00
jni Switched sequence and choice in JNI to varargs 2013-05-16 11:32:37 +02:00
lib Fixed a bug in hush 2012-05-26 13:13:56 +02:00
src Merge pull request #41 from thequux/install-target 2013-10-31 11:42:12 -07:00
.gitignore Added coverage support 2013-09-13 01:21:05 -07:00
.travis.yml Removing coveralls, as it's not working for clang. 2013-10-16 18:08:09 -07:00
common.mk Added new build system 2013-07-10 21:32:05 +02:00
config.mk Refactored tests; make just builds library, make test builds/runs tests 2012-11-13 22:29:25 -05:00
Doxyfile Tweaked docs 2012-11-13 22:42:25 -05:00
HACKING Refactored all of the desugaring code to no longer depend on memory being initialized to 0. Everything is about 12% faster now. 2013-05-25 03:35:42 +02:00
LICENSE Licensing under GPL v2. 2012-04-23 00:02:42 +01:00
Makefile Added new build system 2013-07-10 21:32:05 +02:00
NOTES Added benchmark skeleton, and at least stubs for all of the necessary functions 2012-11-02 17:16:53 -04:00
README.md update usage instructions to assume system-wide install; this will change later, but is accurate now. 2013-10-29 17:48:29 -04:00
SConstruct Merge pull request #41 from thequux/install-target 2013-10-31 11:42:12 -07:00
TODO Added benchmark skeleton, and at least stubs for all of the necessary functions 2012-11-02 17:16:53 -04:00

README.md

Hammer is a parsing library. Like many modern parsing libraries, it provides a parser combinator interface for writing grammars as inline domain-specific languages, but Hammer also provides a variety of parsing backends. It's also bit-oriented rather than character-oriented, making it ideal for parsing binary data such as images, network packets, audio, and executables.

Hammer is written in C, but will provide bindings for other languages. If you don't see a language you're interested in on the list, just ask.

Hammer currently builds under Linux and OS X. (Windows is coming.)

Build Status Features

  • Bit-oriented -- grammars can include single-bit flags or multi-bit constructs that span character boundaries, with no hassle
  • Thread-safe, reentrant
  • Benchmarking for parsing backends -- determine empirically which backend will be most time-efficient for your grammar
  • Parsing backends:
    • Packrat parsing
    • LL(k)
    • GLR
    • LALR
    • Regular expressions
  • Language bindings:
    • C++ (not yet implemented)
    • Java
    • Python (not yet implemented)
    • Ruby (not yet implemented)
    • Perl (not yet implemented)
    • Go (not yet implemented)
    • PHP (not yet implemented)
    • .NET (not yet implemented)

Installing

Prerequisites

  • SCons
  • a JDK

Optional Dependencies

  • pkg-config (for make test)
  • glib-2.0 (>= 2.29) (for make test)
  • glib-2.0-dev (for make test)

To build, type scons. To run the built-in test suite, type scons test. For a debug build, add --variant=debug

If jni.h and jni_md.h aren't already somewhere on your include path, prepend C_INCLUDE_PATH=/path/to/jdk/include to that.

To make Hammer available system-wide, use scons install. This places include files in /usr/local/include/hammer and library files in /usr/local/lib by default; to install elsewhere, add a prefix=<destination> argument, e.g. scons install prefix=$HOME.

Usage

Just #include <hammer/hammer.h> and link with -lhammer.

Examples

The examples/ directory contains some simple examples, currently including:

  • base64
  • DNS

Community

Please join us at #hammer on irc.upstandinghackers.com if you have any questions or just want to talk about parsing.

Contact

You can also email us at hammer@upstandinghackers.com.