Oink-Stack

Welcome! This is the homepage for Oink-Stack. Oink-stack is the minimum collection of software necessary to build and run Oink. Oink-stack contains the repositories:

smbase: Scott McPeak's replacement for the C++ container and string libraries.
ast: Scott McPeak's tool for generating AST classes from a specification language.
elkhound: Scott McPeak's tool for generating a parser for a GLR grammar.
elsa: Scott McPeak's C and C++ front-end.
libregion: David Gay's C region-based memory management library.
libqual: Rob Johnson's serializable polymorphic type qualifier inference engine based on Jeff Foster's original monomorphic type qualifier inference engine, cqual.
platform-model: Karl Chen's static model of libc and libstdc++.
oink: Daniel S. Wilkerson's join-point for front-end and back-end coordination. Client applications are built in this directory. In particular, contains Cqual++.

This repository is what we call a "software stack": it is a collection of repositories that together form one large project of composable parts. The name is reminiscent of the TCP/IP networking stack, which we think of as being organized this way.

If you want to use Oink you should create your own stack that uses the same components that Oink-stack uses: smbase ast elkhound oink, plus your own.

Getting the code

To check out oink-stack, install Subversion, then type:

svn checkout https://svn.cubewano.org/repos/oink-stack/trunk oink-stack

This single command will get oink-stack and its 8 component repositories.

Licensing

See oink/License.txt for the license for the entirety of oink-stack.

Building

To build everything, in oink-stack/ type:

./configure && make clean all check

Upon successful build, you should see

================================================================ DONE in all directories: check ================================================================

The oink-stack repository has a meta-configure file that will allow you to specify a configuration "mode" for the whole project. When it is run all of the sub-repository configure scripts are then called with arguments such that the whole project is built in one way consistent with that mode.

The default mode is fastdebug, which is what you want for debugging: the resulting code is reasonably fast and can still be run in gdb.
To build for performance, use the perform mode.

There are other modes; for an exhaustive and a usage message, in oink-stack run ./configure -h