README

   1 ________               .__   .__
   2 \_____  \ __________ __|  |  |__| ______
   3  /   |   \\___   /  |  \  |  |  |/  ___/
   4 /    |    \/    /|  |  /  |__|  |\___ \
   5 \_______  /_____ \____/|____/|__/____  >
   6         \/      \/                   \/
   7
   8 Description:
   9 ============
  10
  11 This project is mainly an experimental compiler for experimental languages.
  12 It provides a common AST and works with modules not #include like in C or C++.
  13 More description will come later.
  14
  15 Dependancies:
  16 =============
  17
  18  - C++0x compiler
  19  - cmake
  20  - boost (>= 1.40 so trunk at the moment)
  21   - using signal, filesystem, iostreams, system, program_options
  22   - svn co http://svn.boost.org/svn/boost/trunk boost-trunk
  23  - bison
  24  - flex
  25  - bohem gc (C/C++ garbage collector)
  26  - rapidxml
  27   - http://rapidxml.sourceforge.net/
  28  - jaula
  29   - http://morongo.homelinux.net/jaula/
  30
  31 You also need to apply a patch on /usr/share/bison/glr.c, the patch can be
  32 found in patches/
  33
  34 Folders:
  35 ========
  36
  37 cmake/                                          cmake macros
  38 doc/                                            the documentation folder
  39 doc/html                                        the generated doxygen html files
  40 patches/                                        patches for upstream sources
  41 po/                                             contains translations
  42 src/                                            the source folder
  43 src/moulette                                    the moulette folder
  44 src/moulette/bison                              the moulette's test parser
  45 src/moulette/listeners                          listeners for the moulette
  46 src/moulette/tests                              tests engines for the moulette
  47 src/ozulis                                      the root of ozulis sources
  48 src/ozulis/ast                                  ast related tools
  49 src/ozulis/core                                 generic stuff
  50 src/ozulis/generators                           some stuff to generate code
  51 src/ozulis/visitors                             type checker, simplifer, llvm generator, ...
  52 src/plugins                                     ozulis' plugins
  53 src/plugins/lang                                language plugins
  54 src/plugins/lang/mugiwara                       the mugiwara parser
  55 src/plugins/lang/mugiwara/bison                 bison stuff for mugiwara
  56
  57
  58 I configure boost with this:
  59
  60 ./bjam --without-mpi --without-date_time --without-graph --without-graph_parallel --without-math --without-python --without-regex --without-serialization --without-test --without-thread --without-wave --prefix=$HOME/local/boost -j3 link=static runtime-link=shared variant=release threading=single toolset=gcc  install
  61
  62 I configure ozulis with this:
  63
  64 CPPFLAGS="-I$HOME/local/boost/include/boost-1_40" LDFLAGS="-L$HOME/local/boost/lib" ./configure --doxygen=$HOME/local/doxygen/bin/doxygen --boost-lib-suffix=-gcc44-1_40 --prefix=$HOME/local/ozulis