Skip to content

Commit

Permalink
Copied version 2.5 of GNU Nana into the git archive.
Browse files Browse the repository at this point in the history
  • Loading branch information
pjmaker committed Dec 24, 2014
1 parent 92dec49 commit b06bbde
Show file tree
Hide file tree
Showing 160 changed files with 32,285 additions and 0 deletions.
96 changes: 96 additions & 0 deletions ANNOUNCE
@@ -0,0 +1,96 @@
GNU Nana -- improved support for assertions and logging.

GNU Nana is a freely available library providing improved support for
assertions and logging GNU C/C++. In particular:

* Space/time efficient assertion checking.
* Space/time efficent program logging.
* Code to HTML converter giving only details
of your interface and pre/postconditions
(similar to Eiffel short form).
* Statement and function level tracing under GDB.

It was written by the author because he has written too many of these
systems in the past for individual projects and has finally gotten
tired of it. In particular it provides:

0. Assertion and logging code can be implemented as inline C code (as
in <assert.h>) or by extracting a set of commands for the GNU gdb
debugger which then does the actual checking. The use of gdb avoids
the need to create two executables (one with assertions in, and one
which does not contain assertions and is the production system) since
the cost for assertion checking only occurs if you run the application
under the debugger.

1. Configurable:

a) Compile and run-time selection of assertions and logging.
b) The action on assertion failure can be redefined.
c) Modify the destination for logging messages. For example:

i) To a file.
ii) To a circular buffer in core.
iii) To a UNIX process (for program visualisation)

2. Space and time efficient (particularly compared to <assert.h>).
For example:

a) Simply replacing assert(i >= 0) with nana's I(i >= 0)
reduces the code space from 53 bytes to 32 bytes.
If your willing to accept a illegal instruction as the
signal for assertion failure you can reduce this to only
10 bytes from the original 53.

b) By using nana's debugger based assertions and log messages
you can reduce the code space to 0 or 1 bytes and so leave
support for these things in your production code.


3. Some support for formal methods in particular Quantifiers and
before and after state (as in Z, VDM etc). For example:

if(A(int i = 0, i < MAX, i++,
A(int j = 0, j < MAX, j++,
a[i][j] == 0))) { /* a[..][..] is all 0's */
... ;
}

DS($x = x);
..; /* code that modifies x */
DI(x * x == $x); /* check the previous state of x */

If you have an instruction level simulator you can also add in
timing constraints into your system as well as various simple
forms of instrumentation.

4. Ability to produce a short form of your program in HTML which
describes the interfaces and assumptions of your code.

5. Portability.

Ideally you should be using GNU CC/C++ and/or GDB.

The library should also be useful to people using other compilers.
Unfortunately parts of the library use two GNU CC extensions
which makes them non-portable. These are:

1. Variable number of arguments to macros which is used in the
message logging components (L.h,DL.h).
2. Statement Expressions which are used to implement
the support for Forall, Exists, etc (Q.h)

The rest of the library is written in at least partially portable ANSI C.

6. For further information see:

<ftp://ftp.cs.ntu.edu.au/pub/nana/>

or

<http://www.cs.ntu.edu.au/homepages/pjm/nana-home>


Phil Maker <pjm@gnu.org>
Quoll Systems <http://www.quoll.com.au/>


5 changes: 5 additions & 0 deletions AUTHORS
@@ -0,0 +1,5 @@
Phil Maker <pjm@gnu.org>,
Quoll Systems Pty Ltd <http://www.quoll.com.au/>.

8 Brown St, Fannie Bay,
Darwin, NT, 0820, Australia.
27 changes: 27 additions & 0 deletions COPYING
@@ -0,0 +1,27 @@

* Copyright (c) 1995,1996,1997,1998 Phil Maker
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.


11 changes: 11 additions & 0 deletions ChangeLog
@@ -0,0 +1,11 @@
1999-09-12 Phil Maker <pjm@pjm.quoll.com.au>

* Releasing 2.5 which is a maintainence release.

* Reinstalled perf targets from an older version.






40 changes: 40 additions & 0 deletions INSTALL
@@ -0,0 +1,40 @@
* Installing GNU Nana.

GNU Nana uses autoconf style automatic configuration and thus follows the
standard [./configure; make; make install] model of system
administration. For example try something like:

% gzcat nana-2.3.tar.gz | tar xvf - # extract archive
% cd nana-2.3

% ./configure # possibly with --prefix=$HOME/play
or
% I_DEFAULT=fast ./configure # just use single instructions
# when an assert fail is detected
# rather than printing a message
% make
% make install # and finally install it
% make check # run self-testing code

% make check-mail # send check output off to nana-bug
# *** Please do this step!
or
% make MAILER=elm check-mail # if your mailer doesn't handle -s

% make subscribe # subscribe to the nana mailinglist
# for new version information, etc

More details can be found in INSTALL.con and in the info documentation
supplied with the distribution. You might also wish to look at the
patch file for gdb which stops all those annoying breakpoint inserted
messages (see gdb/quiet.diff).

Good Luck

Phil Maker <pjm@gnu.org>






181 changes: 181 additions & 0 deletions INSTALL.con
@@ -0,0 +1,181 @@
Basic Installation
==================

These are generic installation instructions.

The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

The file `configure.in' is used to create `configure' by a program
called `autoconf'. You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The simplest way to compile this package is:

1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.

Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.

2. Type `make' to compile the package.

3. Optionally, type `make check' to run any self-tests that come with
the package.

4. Type `make install' to install the programs and any data files and
documentation.

5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.

Compilers and Options
=====================

Some systems require unusual options for compilation or linking that
the `configure' script does not know about. You can give `configure'
initial values for variables by setting them in the environment. Using
a Bourne-compatible shell, you can do that on the command line like
this:
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures
====================================

You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory. After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.

Installation Names
==================

By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.

In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.

If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features
=================

Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.

For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.

Specifying the System Type
==========================

There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on. Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults
================

If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls
==================

`configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
Use and save the results of the tests in FILE instead of
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
debugging `configure'.

`--help'
Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made.

`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.

`--version'
Print the version of Autoconf used to generate the `configure'
script, and exit.

`configure' also accepts some other, not widely useful, options.

0 comments on commit b06bbde

Please sign in to comment.