Standardize on using dune to build CodeHawk

Remove the Shake-based build (even though it's a great example!).

Author: brk

.gitignore

@@ -11,6 +11,9 @@
 # ocamlbuild working directory
 _build/
 
+# local opam switch
+_opam/
+
 # ocamlbuild targets
 *.byte
 *.native

CodeHawk/README.md

@@ -8,166 +8,46 @@ Building codehawk requires the following applications and libraries:
 - The Findlib / ocamlfind library manager
 - The Zlib C library, version 1.1.3 or up
 - The Zarith library
+- goblint-cil, version 2.0.6
 
 The CodeHawk Tool Suite contains three analyzers that can all be built
 individually. All three analyzers have an optional gui that can be built
 separately (and that requires additional dependencies to be installed).
+The gui is current out-of-date and will require additional work to revive.
 
 
-### Install dependencies: Ubuntu 16.04 or later (without gui)
+### Install Dependencies:
 
-```
-sudo apt update -y
-sudo apt install software-properties-common pkg-config m4 zlib1g-dev libgmp-dev -y
-sudo add-apt-repository ppa:avsm/ppa -y
-sudo apt update -y
-sudo apt install opam
-git clone https://github.com/static-analysis-engineering/codehawk.git
-opam init --bare --no-setup --disable-sandboxing
-opam switch create codehawk-4.12.1 4.12.1 --no-switch
-eval $(opam env --switch=codehawk-4.12.1 --set-switch)
-opam install ocamlfind zarith camlzip extlib goblint-cil
-cd codehawk/CodeHawk
-```
-
-Depending on which analyzer you want to build:
-- **Binary:** `./make_binary_analyzer.sh`
-  - analyzer binary: CHB/bchcmdline/chx86_analyze
-- **C:** `./make_c_analyzer.sh`
-  - parser binary: CHC/cchcil/parseFile
-  - analyzer binary: CHC/cchcmdline/canalyzer
-- **Java:** `./make_java_analyzer.sh`
-  - analyzer binary: CHJ/jchstac/chj_initialize
-- **all:** `./full_make_no_gui.sh`
-  - analyzer/parser binaries: all of the above
-
-
-### Install dependencies and build: Ubuntu 16.04 or later (including gui)
+These commands should work for Ubuntu 22.04+:
 
 ```
 sudo apt update -y
-sudo apt install software-properties-common pkg-config m4 zlib1g-dev libgmp-dev liblablgtk2-ocaml-dev liblablgtksourceview2-ocaml-dev -y
-sudo add-apt-repository ppa:avsm/ppa -y
-sudo apt update -y
-sudo apt install opam
-git clone https://github.com/static-analysis-engineering/codehawk.git
-opam init --bare --no-setup --disable-sandboxing
-opam switch create codehawk-4.12.1 4.12.1 --no-switch
-eval $(opam env --switch=codehawk-4.12.1 --set-switch)
-opam install ocamlfind zarith camlzip extlib lablgtk lablgtk-extras goblint-cil
-cd codehawk/CodeHawk
-./full_make.sh
-```
-
-# Building with shake
-
-### High-level process:
-
-1. Install dependencies
-2. Install the shake build system
-3. Install ocaml
-4. Build CodeHawk
-
-The top-level dependencies needed to build CodeHawk are zlib for compression, the shake build
-system, and the ocaml package manager (opam). In addition to the commands below, use the `opam`
-setup above to get the dependencies.
-
-### Generic Unix
-
-Other dependencies: `pkg-config`, `m4`
-
-```
-sudo apt update -y
-sudo apt install curl -y
-curl -sSL https://get.haskellstack.org/ | sh
-sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)
-stack install shake
-git clone https://github.com/static-analysis-engineering/codehawk.git
-cd codehawk/CodeHawk
-stack runghc Shakefile.hs
-```
-
-### Arch Linux
-
-```
-sudo pacman -Syu opam haskell-shake lablgtk2
-git clone https://github.com/static-analysis-engineering/codehawk.git
-cd codehawk/CodeHawk
-shake
-```
-
-### Fedora
-
-```
-sudo yum install opam shake ghc-compiler ghc-shake-devel diffutils zlib-devel ocaml-lablgtk-devel -y
-git clone https://github.com/static-analysis-engineering/codehawk.git
-cd codehawk/CodeHawk
-shake
-```
-
-### Homebrew
+sudo apt install --no-install-recommends software-properties-common \
+                     build-essential unzip \
+                     pkg-config m4 zlib1g-dev libgmp-dev bubblewrap -y
 
-```
-brew install opam
-brew install cabal-install
-brew install lablgtk
-cabal update
-cabal install --lib shake
-cabal install --lib unordered-containers
-git clone https://github.com/static-analysis-engineering/codehawk.git
-cd codehawk/CodeHawk
-~/.cabal/bin/shake
-```
+# Run with sudo if you wish to install globally
+bash -c "sh <(curl -fsSL https://opam.ocaml.org/install.sh)"
+opam init --bare
 
-### MacPorts
-
-```
-sudo port install opam
-sudo port install hs-cabal-install
-sudo port install lablgtk2
-cabal update
-cabal install --lib shake
-cabal install --lib unordered-containers
 git clone https://github.com/static-analysis-engineering/codehawk.git
 cd codehawk/CodeHawk
-~/.cabal/bin/shake
+opam switch create . 5.2.0 && eval $(opam env)
+opam install dune ocamlfind zarith camlzip extlib goblint-cil.2.0.6
 ```
 
-### Ubuntu 19.04 or later, Debian Buster or later
-
-```
-sudo apt update -y
-sudo apt install cabal-install pkg-config m4 zlib1g-dev opam liblablgtk2-ocaml-dev liblablgtksourceview2-ocaml-dev -y
-cabal update
-cabal install shake
-git clone https://github.com/static-analysis-engineering/codehawk.git
-cd codehawk/CodeHawk
-~/.cabal/bin/shake
-```
-
-### Ubuntu 16.04 or later
-
-```
-sudo apt update -y
-sudo apt install software-properties-common cabal-install pkg-config m4 zlib1g-dev liblablgtk2-ocaml-dev liblablgtksourceview2-ocaml-dev -y
-sudo add-apt-repository ppa:avsm/ppa -y
-sudo apt update -y
-sudo apt install opam
-cabal update
-cabal install shake
-git clone https://github.com/static-analysis-engineering/codehawk.git
-cd codehawk/CodeHawk
-~/.cabal/bin/shake
-```
+Depending on which analyzer you want to build:
+- **Binary:** `dune build CHB`
+- **C:** `dune build CHC`
+- **Java:** `dune build CHJ`
+- **all:** `dune build`
 
-### Manually configured opam
+These targets can be combined, e.g. `dune build CHB CHC`.
 
-Before the final "shake" command in one of the above instructions:
+The Makefiles in the repository are to help CodeHawk's developers
+debug circular module dependencies, they are not intended for users.
 
-```
-opam init --bare --no-setup --disable-sandboxing
-opam switch create codehawk-4.12.1 4.09.0 --no-switch
-eval $(opam env --switch=codehawk-4.12.1 --set-switch)
-opam install ocamlfind zarith camlzip extlib lablgtk lablgtk-extras
-/path/to/shake
-```
+Dependencies for other OS flavors:
+- Arch Linux: `sudo pacman -Syu opam`
+- Fedora: `sudo yum install opam diffutils zlib-devel ocaml-lablgtk-devel -y`
+- macOS: `brew install opam`