Documentation and a few re-factoring

Author: refactormyself

native-library-files/stp_project/build_raw_to_java_api.sh

@@ -1,37 +1,44 @@
 #!/usr/bin/etc/ bash
 
 set -e
+set -u
 
-# get or locate the project
-# build it as a shared library
+# Gets the normal STP library, if not found it is cloned and built.
+# Afterwards, using SWIG we define a new API and generate its JNI bindings
+# The new API is rebuild as a shared library and the JNI Java classes generated
+# The resulting .so library and the binding classes (compile to a .jar) 
+# are copied into appropriate folder in java-smt.
 
-# --- POSSIBLE LIBRARY FILES:
-# ./build/src/bin/CMakeFiles/exec.dir/opensmt.C.o
-# ./build/src/api/libopensmt2.so
 
-# FILE="$(pwd)"/opensmt/build/src/api/libopensmt2.so
+STP_LIB=./stp/build/lib/libstp.so
+
+
+PRJ_DIR="${PWD%/*/*}"
+PRJ_NAME=$(basename "$PRJ_DIR")
+
+
+# confirm expected directory structure 
+# MUST BE like java-smt/../../this_script.sh
+if [[ "$PRJ_NAME"!="java-smt" ]]
+ then
+	echo "this script is not place in the proper directory" >&2
+	echo "this script expects to reside in somewhere like\
+	 .../java-smt/dir_1/dir_2/build_raw_to_java_api.sh" >&2 
+	exit 1
+fi
+
+# set destination directory for final libraries
+JAR_LIB_DIR="${PRJ_DIR}/lib/"
+SO_LIB_DIR="${JAR_LIB_DIR}/native/x86_64-linux/
 
-FILE=./stp/build/lib/libstp.so
 
 # echo $FILE
 echo ---
-if [! -f "$FILE" ]; then
+if [! -f "$STP_LIB" ]; then
 	echo "I can't find the STP library file. I am making a new one ..."
     sh clean_clone_build.sh
 fi
 
-# --- copying is no more needed CMAKE should find the library
-
-# [ ! -f ./stpJ/lib/ ] && mkdir ./stpJ/lib/
-# cp $FILE ./stpJ/lib/
-# echo "STP shared library file now copied to ./stpJ/lib/ for convinience"
-
-# create or locate the SWIG interface to this project
-# cmake build a new API linking :
-	#- SWIG interface
-	#- project .so
-	#- source file referenced in the SWIG interface (if any)
-
 cd ./stpJ
 [ ! -f ./build ] && mkdir ./build || rm -rf ./build/* ||:
 
@@ -50,10 +57,12 @@ ls
 	
 # copy API - jar and - so into javasmt
 echo
-echo "copying library files into JavaSMT (old files are overwritten) ... ...."
+echo "copying library files into JavaSMT (old files are overwritten) ... ..."
 
-cp ./stpJavaAPI.jar /home/lubuntu/SAHEED/gsoc/CODE/java-smt/lib/
-cp ./libstpJapi.so /home/lubuntu/SAHEED/gsoc/CODE/java-smt/lib/native/x86_64-linux/
+# cp ./stpJavaAPI.jar /home/lubuntu/SAHEED/gsoc/CODE/java-smt/lib/
+# cp ./libstpJapi.so /home/lubuntu/SAHEED/gsoc/CODE/java-smt/lib/native/x86_64-linux/
 
-echo "SUCCESS"
+cp ./stpJavaAPI.jar $JAR_LIB_DIR
+cp ./libstpJapi.so $SO_LIB_DIR
 
+echo "SUCCESS"

native-library-files/stp_project/clean_clone_build.sh

@@ -1,8 +1,12 @@
 #/usr/bin/env/ bash
+
+# This removes any existing STP repositories and build files
+# and clones a new repo and build STP
+# 
 set -e
 
 [ -d "./stp" ] && rm -rf ./stp ||:
-# [ -d "./build" ] && rm -rf ./build ||:
+[ -d "./build" ] && rm -rf ./build ||:
 
 echo "Build files removed and STP repo deleted."
 echo "Now cloning stp ..."
@@ -15,18 +19,13 @@ mkdir ./build;cd ./build
 echo
 echo "Now building STP ... "
 
-# cmake .. -DCMAKE_BUILD_TYPE=Debug
-# cmake -DSHAREDCOMPILE=ON ..
-# cmake -DSTATICCOMPILE=ON ..
-
 cmake ..
 make
-sudo make install
-#sudo ldconfig
+# sudo make install
+# sudo ldconfig
 
 echo "... ... STP BUILD SUCCESSFULL"
 ls 
 echo
-echo "https://github.com/stp/stp/tree/master/examples/simple"
 
 # cd ../../

native-library-files/stp_project/clean_up.sh

@@ -1,4 +1,8 @@
 #/usr/bin/env/ bash
+
+# Clean up the build files for StpJavaApi
+# cryptominisat repo is also removed
+
 set -e
 
 # remove STP repo

native-library-files/stp_project/dependencies/install_depends.sh

@@ -1,7 +1,7 @@
 #!/usr/etc/ bash
 
 set -e
-
+# prerequisite for building STP
 #  boost, flex, bison and minisat
 sudo apt-get install cmake bison flex libboost-all-dev python perl minisat
 

native-library-files/stp_project/install_prereq.sh

@@ -1,5 +1,6 @@
 #!/usr/etc/ bash
 
+# installs dependencies for building the STP library
 set -e
 
 cd ./dependencies