Assignement.

Fetch this project:

$ git clone https://github.com/Harenome/noclock.git
$ cd noclock

The following tools are required to build this program:

• C99 development tools and the GNU libc.
• lex/flex >= 2.5.37
• yacc/byacc >= 1.9 20130925 or GNU Bison >= 3.0.2
• libgmp >= 5.0.2
• libisl >= 0.14

The following tools are optionnal:

• doxygen
• graphviz/dot

Install the required tools:

$ apt-get install build-essential
$ apt-get install bison byacc flex

On Ubuntu 12.04:

~~~{.bash}
$ apt-get install libgmp10 libgmp-dev-lts

On Ubuntu 14.04:

$ apt-get install libgmp10 libgmp-dev

Install the optionnal tools:

$ apt-get install doxygen graphviz

Install ISL 0.14:

$ wget http://isl.gforge.inria.fr/isl-0.14.tar.gz
$ tar -xf isl-0.14.tar.gz
$ cd isl-0.14.tar.gz
$ ./configure PREFIX=/usr/local
$ make
$ sudo make install
$ sudo ldconfig

If you do not wish to install ISL into a "standard" location, or do not have sufficient privileges, do not forget to set LDLIBS when compiling noclock and to set LD_LIBRARY_PATH when running noclock.

For instance:

$ make LDLIBS=-L$HOME/lib
$ LD_LIBRARY_PATH=$HOME/lib build/bin/noclock

Install the required tools:

$ yum groupinstall "Development Tools"
$ yum install byacc bison bison-devel flex flex-devel
$ yum install isl isl-devel

Install the optionnal tools:

$ yum install doxygen graphviz

Building has been tested on the following setups:

$ make

The binary will be located in build/bin.

One can explicitly compile the project in debug or in release mode:

$ make debug
$ make release

By default, the Makefile uses gcc, lex and yacc. This can be overriden using the default GNU make variables. For instance:

$ make CC=clang
$ make CC=clang YACC=bison LEX=flex

Once building is successful, the following command will install the project, if root privileges are available (or at least if the current user is allowed to write to /usr/local):

$ make install

To specify another location:

$ make install PREFIX=$HOME/local

A manpage is provided. If the program has been installed via make install, the manpage should most likely available via:

$ man noclock

Otherwise, it can be found in the man/man1:

$ man man/man1/noclock.1

Help can also be printed via the program using the --help or -h options.

Developper documentation is available via the use of Doxygen. The following commands can be used to generate the documentation:

$ make doc
$ doxygen

The generated documentation shall be located in build/doc.

Note that there are two Doxyfiles, Doxyfile and Doxyfile_full. As the file names suggest, the Doxyfile_full enables much more options that its light counterpart Doxyfile. To specify which version to use:

$ doxygen Doxyfile
$ doxygen Doxyfile_full

The generated documentation for the latest release shall also be found at: https://harenome.github.io/noclock.

Some example programs are located in examples/, but please note that examples/E10.x10p2 does not work.

If the program has been install via make install, it should be available in $PATH:

$ noclock <input_file> [output_file]

Otherwise, the binary is located in build/bin:

$ build/bin/noclock <input_file> [output_file]

To remove clocks from an X10 program (for instance examples/E1.x10p2):

$ build/bin/noclock examples/E1.x10p2
$ build/bin/noclock --verbose examples/E1.x10p2

To store the result in another file:

$ build/bin/noclock examples/E1.x10p2 output

Input and output files can also be specified using -i and -o (or --input and --output):

$ build/bin/noclock -o output -i examples/E1.x10p2

If life is sad, colours can be disabled:

$ build/bin/noclock --no-colours examples/E1.x10p2

Copyright (c) 2015 Harenome RAZANAJATO RANAIVOARIVONY

This work is licensed under the MIT License. See the COPYING file for further information.