flxp
[-Iinclude-dir]
filebasename
flxm
[-Iinclude-dir]
filebasename
flxd
[-Iinclude-dir]
filebasename
flxb
[-Iinclude-dir]
filebasename
flxcc
control-filename
flxg
[-v] [--verbose]
[-Iinclude-dir] [--include=include_dir]
[--elkhound=flx_elkhound]
[--opt] [--optimise]
[--debug]
[--with-comments]
[--mangle_names]
[--no-check-axioms]
[--trace]
[-e]
[--force]
[--inline[=[n|none]]] [--noinline]
[-c] [--compile-only]
[-h] [--help]
[-q] [--quiet]
filebasename
flx_run
libname
flx_arun
libname
flx_doc
--outdir=docidr filename ..
flx
[--version] [--help] [--test] [--force] [--echo] [--time]
[--inline] [--static] [--optimise] [--optimize]
[-c]
[--nofelix]
[ [--pkg=<pkg-config pkg>]
[<file>.cpp]
[<file>.o]
[<file>.a]
[<linkops>]..]
filebasename
flxl lexes the input and prints the token list to standard output
flxp
lexes and parses the input and prints the parse tree to standard output
flxm
lexes, parses, folds constants and performs
macro expansion of the input and prints the
AST tree to standard output
flxd
lexes, parses and
desugars the the input and prints the desugared
AST tree to standard output
flxb
lexes, parses, desugars and binds identifiers and prints
the bindings to standard output
flxcc
reads a preprocessed C header file and writes
Felix wrapper bindings to out. The command
accepts an argument which specifies wrapper
generation configuration parameters.
flx_doc
Felix documentation generator. The --outdir=dirname option
specifies the directory into which to put documentation.
Defaults to out_doc. Each of the subsequently listed
filenames should be a Felix (*.flx) file, which is treated
as a library. The documentation processor produces a set
of HTML files documenting the interface. Comments specified
with either the publish prefix or comment statement are
also emitted into the documentation.
flxg
lexes, parses, desugars, binds, and generates C++ code.
Two files,
filebase.cpp
and
filebase.hpp
are created. Use the
-v
option for verbose output.
flx
is a load and go test harness which compiles its
argument to C++, compiles and links the C++ using gcc,
then executes the resulting library using flx_run.
--test=dir
Forces use of the Felix system in the specified directory.
Intended for use testing an old installed directory,
or using the development directory when it is not the
current directory.
-c --compile-only
Compiles and links executable without running it.
By default, the program is executed.
--nofelix
Inhibits execution of the flxg compiler,
allowing a modified C++ program to be compiled
and executed. Use in conjunction with -c switch
to disable execution as well.
--force
Forces both Felix and C++ recompilation and linking.
Normally, timestamps are checked, and compilation
is skipped if the program is up to date.
--echo
Indicates what the flx script is doing,
prints external commands such as the C++
compilation command line. Use to check
your options are being processed correctly
by the flx script.
--debug
Turns on all manner of debugging.
Tells the flxg compiler to print extensive
details of its compilation process to help
debugging. Also tells the system C++ compiler
to emit debugging information whilst compiling
and to generate debug symbols in generated
object files. Tells the driver to enable
debugging too.
--inline
Anachronism. Enables inlining, in this version,
inlining is on by default. May slow
down Felix compilation significantly. May cause
significant code bloat. May also reduce code
size significantly.
--optimise --optimize
Enables inlining and passes -O3 to the C++ compiler.
--static
Force linking of an executable instead of a shared library.
--version
Prints version and exits.
--time
Times execution of the target program using the time
command. Note -- compilation time is not included.
--help
Runs 'man flx' and exits.
-c
Generates but does not execute the program.
Warning -- this option is part of the felix options.
It must be given before any C++ compiler options,
or it will just be passed directly to the C++ compiler,
resulting in generation of object files without linking,
but the flx script will try to run the linked
output anyhow (possibly resulting in an old version
being executed).
--pkg=<pkg-config pkg>
NO EFFECT.
USED TO DO THIS:
Specifies the particular C library is required.
This option causes the required flags to be added
to compilation and link steps to allow #includes
to find the headers, and to link the library
to the program. This option uses the pkg-config
program to obtain this data. May be specified
any number of times.
*.cpp *.cxx *.o *.a
Files ending in these extensions are normally recognized
by the C/C++ compiler/linker harness are passed to it
during C++ compilation and linkage steps. This allows
linking Felix to arbitrary C, C++ codes available
as source, object files, or in an archive.
<link opts>
-Dmacro -Llibpath -llib
Various options normally recognized by the C/C++ compiler/linker
harness are passed through to it transparently.
filebasename
The name of the Felix program to run. May be given with
or without the .flx extension. This program is compiled
with the flxg driver to produce filebasename.cpp which is
then compiled and linked with other specified files.
Currently only one Felix file may be given.
flx is a script which combines felix compilation, C++ compilation of the output, and execution using the standard program driver, for rapid prototyping in a scripting style.
flxcc is the wrapper generator for C headers.
flx_doc is the documentation generator. It can be used to create HTML pages documenting any Felix code files.
flx_pkgconfig is the resource manager, used by the flx script to find external resources. This includes header files needed for C++ compilation, libraries which a program needs to be linked against, and which driver a program needs to be run by.
flx_arun is the driver which can load the asynchronous I/O system.
Its argument is a shared library which is passed to dlopen (note you need to use ./lib.so on linux to preempt the stanard search path).
The driver creates a single thread from the libraries main entry point _init_ and runs the thread until it terminates, then exits. The message type here is void and the driver exists with an error diagnostic if the thread tries to read any messages.
*.hpp *.cpp *.rtti
Generated C++ output files for header, body,
and run time type information, respectively.
*.resh generated resource header file
*.par
Precompiled header file.