Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
C C++ Ruby Python C# PHP Other

This branch is 1 commit ahead of UpstandingHackers:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
contrib
docs
examples
jni
lib
src
tools
.gitignore
.travis.yml
Doxyfile
HACKING
LICENSE
Makefile
NOTES
README.md
SConstruct
TODO
common.mk
config.mk
libhammer.pc.in

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++
    • Java (not currently building; give us a few days)
    • Python
    • Ruby
    • Perl
    • Go
    • PHP
    • .NET

Installing

Prerequisites

  • SCons

Optional Dependencies

  • pkg-config (for scons test)
  • glib-2.0 (>= 2.29) (for scons test)
  • glib-2.0-dev (for scons test)
  • swig (for Python/Perl/PHP bindings; Perl requires >= 2.0.8)
  • python2.7-dev (for Python bindings)
  • a JDK (for Java bindings)
  • a working phpenv configuration (for PHP bindings)
  • Ruby >= 1.9.3 and bundler, for the Ruby bindings
  • mono-devel and mono-mcs (>= 3.0.6) (for .NET bindings)
  • nunit (for testing .NET bindings)

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

To build bindings, pass a "bindings" argument to scons, e.g. scons bindings=python. scons bindings=python test will build Python bindings and run tests for both C and Python. --variant=debug is valid here too. You can build more than one set of bindings at a time; just separate them with commas, e.g. scons bindings=python,perl.

For Java, 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.

For the Go bindings, install the C library using "scons install", and then just run go get gopkg.upstandinghackers.com/hammer

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. A suitable bindings= argument will install bindings in whatever place your system thinks is appropriate.

Usage

Just #include <hammer/hammer.h> (also #include <hammer/glue.h> if you plan to use any of the convenience macros) and link with -lhammer.

If you've installed Hammer system-wide, you can use pkg-config in the usual way.

For documentation, see the user guide.

Examples

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

  • base64
  • DNS

Known Issues

The Python bindings only work with Python 2.7. SCons doesn't work with Python 3, and PyCapsule isn't available in 2.6 and below, so 2.7 is all you get. Sorry about that.

The requirement for SWIG >= 2.0.8 for Perl bindings is due to a known bug in SWIG. ppa:dns/irc has backports of SWIG 2.0.8 for Ubuntu versions 10.04-12.10; you can also build SWIG from source.

The .NET bindings are for Mono 3.0.6 and greater. If you're on a Debian-based distro that only provides Mono 2 (e.g., Ubuntu 12.04), there are backports for 3.0.x, and a 3.2.x PPA maintained by the Mono team.

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.

Something went wrong with that request. Please try again.