Distribution Contents
The software is available in two distribution sets: UNIX,
and Win32. The former's structure is applicable for all
flavors of UNIX, while the latter is applicable for Windows NT and 95. There are only
minor differences between the two, reflecting platform-specific characteristics (e.g.,
makefiles).
- README.html
- The starting page for the Flavor documentation.
-
- COPYRIGHT
- The copyright statement covering use and (re)distribution of this package.
-
- configure
- This is a shell script that will automatically configure the Flavor software for your
system. It is generated using GNU's
autoconf, and it
works by first examining your system's capabilities, and then generating appropriate
makefiles. It is quite powerful, and you should run it before attempting to build any of
the samples. Note that the template makefiles used by configure have a suffix
.in; regular makefiles suitable for use by make will be
generated only after you run configure.
-
- INSTALL.UNIX
- This is a text file with instructions on how to run the
configure
script. Unless you want a specific customization, you should just enter ./configure in the command line without any options.
-
- bin\flavorc
- The Flavor translator to C++. It takes as an input a
.fl
file and generates an equivalent .h file.
-
- include\flavor.h, bitstream.h, port.h
- lib\libflavor.a
- These are the files of the Flavor run-time library for C++. This library provides
support for bitstream I/O operations. Its API is very simple, and developers can use their
own libraries as long as they expose the interface that flavorc expects. Note that the library is compiled using GNU C++; if you
use a different compiler you will need to rebuild the library as C++ name mangling is
compiler-dependent. More information about the run-time library is provided in the User's Manual.
-
- samples\sample1\sample1.fl, main.cpp, Makefile.in
- This is a trivial example of a bitstream syntax that shows how to integrate your code
with the one generated by
flavorc.
-
- samples\sample2\sample2.fl, main.cpp, main.cpp, GIF87a.txt, Makefile.in
- This is a more sophisticated sample that implements the entire GIF87a syntax. The sample
program prints the information from all headers of a GIF87a file. The GIF87a specification
is also included in that directory in case you are not familiar with it.
-
- samples\sample3\sample3.fl, main.cpp, Makefile.in
- This is a more sophisticated example that demonstrates how polymorphic parsable classes
work within Flavor and within your own code.
-
- src\Makefile.in
- This is a makefile suitable for building the entire source tree. In regular
distributions this just include the run-time library (see below).
-
- src\lib\flavor.h, bitstream.h, port.h, bitstream.cpp, flerror.cpp, trace.cpp,
Makefile.in
- This directory contains the source code for the run-time library. You will need to
recompile the library if you are using a C++ compiler other than GNU's, as C++ name
mangling is compiler-specific.
-
- src\flavorc
- This directory contains the source code for flavorc.
This directory is only included in source code distributions of Flavor. If you are
interested in obtaining a source code release please contact Sara Brock of the ADVENT Project at Columbia University. Note
that the source code for
flavorc is covered by a different copyright
statement that the rest of the package.
- README.html
- The starting page for the Flavor documentation.
-
- COPYRIGHT
- The copyright statement covering use and (re)distribution of this package.
-
- flavor.dsw
- This is a Microsoft Visual C++ 5.0 Workspace file. It contains as projects the run-time
library source code as well as all the samples. In addition to providing quick access to
this package's source code, it is also a good example on how to configure the IDE to
compile Flavor files (using custom build commands).
-
- bin\flavorc.exe
- The Flavor translator to C++. It takes as an input a
.fl
file and generates an equivalent .h file.
-
- include\flavor.h, bitstream.h, port.h
- lib\flavor.lib
- These are the files of the Flavor run-time library for C++. This library provides
support for bitstream I/O operations. Its API is very simple, and developers can use their
own libraries as long as they expose the interface that flavorc expects. Note that the library is compiled using Microsoft Visual
C++ 5.0; if you use a different compiler you will need to rebuild the library as C++ name
mangling is compiler-dependent. More information about the run-time library is provided in
the User's Manual.
-
- samples\sample1\sample1.fl, main.cpp, sample1.mak, sample1.dsp
- This is a trivial example of a bitstream syntax that shows how to integrate your code
with the one generated by
flavorc. sample1.mak
is a makefile suitable for Microsoft's nmake (or compatible), while sample1.dsp
is a project file suitable for loading into Microsoft Visual C++ 5.0.
-
- samples\sample2\sample2.fl, main.cpp, main.cpp, GIF87a.txt, sample2.mak,
sample2.dsp
- This is a more sophisticated sample that implements the entire GIF87a syntax. The sample
program prints the information from all headers of a GIF87a file. The GIF87a specification
is also included in that directory in case you are not familiar with it.
-
- samples\sample3\sample3.fl, main.cpp, sample3.mak, sample3.dsp
- This is a more sophisticated example that demonstrates how polymorphic parsable classes
work within Flavor and within your own code.
-
- src\lib\flavor.h, bitstream.h, port.h, bitstream.cpp, flerror.cpp, trace.cpp,
lib.mak, lib.dsp
- This directory contains the source code for the run-time library. You only need to
compile the library if you make changes to it, as this distribution includes a precompiled
version.
-
- src\flavorc
- This directory contains the source code for flavorc.
This directory is only included in source code distributions of Flavor. If you are
interested in obtaining a source code release please contact Sara Brock of the ADVENT Project at Columbia University. Note
that the source code for
flavorc is covered by a different copyright
statement that the rest of the package.