A Value-Range Analyzer Built On Top of Code Listener

                  Daniela Ďuričeková <xduric00@stud.fit.vutbr.cz>, 2013


Description:
------------
  A value-range analyzer that is built on top of the Code Listener infrastructure.

System requirements:
--------------------
  OS GNU/Linux, x86/x86_64, kernel >= 3.0

Software requirements:
----------------------
  GNU make             >= 3.8       Compilation and linking
  g++                  >= 4.7       C++ source files compiler and linker
  GMP                  >= 5.1       The GNU multiple precision arithmetic library
  Git                  >= 1.8       Revision control system (to get CL source code)
  Doxygen              >= 1.7       Generating program documentation (optional)

Installation:
-------------
  (1) Get the latest version of Code Listener:

        git clone https://github.com/kdudka/predator

  (2) Extract the contents of the archive `vra-YYYY-MM-DD.zip` to `predator`:

        tar -C predator -xvzf vra-YYYY-MM-DD.tar.gz

  (3) Build Code Listener:

        cd predator
        make build_gcc
        make

  (4) Build the analyzer:

        cd predator/vra
        make

Usage:
------
  Assuming that you are in `predator`, run the following command, where
  `test.c` is the input C source program:

        ./gcc-install/bin/gcc -fplugin=vra_build/libvra.so \
            -fplugin-arg-libvra-dump-pp test.c

Unit tests:
-----------
  Assuming that you are in `predator/vra/tests-unit`, run

        make

  to build the unit tests, and then run either

        ./run-all-unit-tests.sh

  to run all the unit tests or

        ./TestName

  to run a specific test fixture (for example, `./NumberTest`).

Overall tests:
--------------
  Assuming that you are in `predator/vra/tests-overall`, run

         ./tests-run.sh

  to run all the overall tests.

Documentation:
--------------
  Assuming that you are in `predator/vra`, run the following command to
  generate the Doxygen API documentation for the value-range analyzer:

        make doc

  Then, open `predator/vra/doc/html/index.html` in your favorite web browser.

Feedback:
---------
  Send an email to xduric00@stud.fit.vutbr.cz.