Add option --clean for the install script.

Author: pavoljuhas

Diff for: diffpy-cmi/install

@@ -8,13 +8,21 @@ usage: ./install [options]
 Options:
 
   -n, --dry-run   list what would be done without making any changes.
-                  Display a list of steps when run with --build or --update.
+                  Display a list of steps when run with --update, --build
+                  or --clean.
+
   --update[=steps]  perform all or selected software updates from online
                   source repositories.  Update steps are comma separated
                   integers or ranges such as '1,3,5-6'.  Use option -n to
                   display the steps.
+
   --build[=steps]   rebuild all or specified packages from sources in the
                   src folder.  Use option -n to display the build steps.
+
+  --clean[=steps]   remove generated files from the source folders of the
+                  specified packages.  This ensures that --build is run
+                  from a pristine state.
+
   -h, --help      display this message and exit
 "
 
@@ -66,7 +74,8 @@ SRCDIR=${BASEDIR}/src
 PTHFILE=${BASEDIR}/diffpy_cmi.pth
 VERSION=$(cd $BASEDIR && test -s VERSION.txt && <VERSION.txt)
 
-typeset -aU build_selection update_selection
+typeset -aU clean_selection build_selection update_selection
+clean_selection=( )
 build_selection=( )
 update_selection=( )
 HASHLINE=${(l:78::#:):-}
@@ -92,13 +101,14 @@ export LIBRARY_PATH=${BASEDIRSHORT}/lib:\$LIBRARY_PATH
 # Extract command-line options -----------------------------------------------
 
 zmodload zsh/zutil
-zparseopts -K -E -D \
+zparseopts -D -E \
     n=opt_dryrun -dry-run=opt_dryrun \
-    h=opt_help -help=opt_help -update::=opt_update -build::=opt_build ||
+    h=opt_help -help=opt_help \
+    -clean::=opt_clean -update::=opt_update -build::=opt_build ||
     exit $?
 
 if [[ -n $* ]]; then
-    print -u2 "Invalid arguments or options: $*"
+    print -u2 "Invalid option: $*"
     exit 2
 fi
 
@@ -223,6 +233,7 @@ adjust_macosx_environment() {
 }
 
 
+integer CIDX=0
 integer UIDX=0
 integer BIDX=0
 
@@ -231,6 +242,10 @@ ListSkipOrDo() {
     local idx
     typeset -gA didheader
     case $1 in
+        (clean)
+            idx=$(( ++CIDX ))
+            selection=( $clean_selection )
+            ;;
         (build)
             idx=$(( ++BIDX ))
             selection=( $build_selection )
@@ -264,6 +279,57 @@ ListSkipOrDo() {
 }
 
 
+do_clean() {
+    local PS4=">> "
+    local msg_noupdate
+    MSG_NOCLEAN="No cleanup needed for this package.  Skipped."
+    ListSkipOrDo clean "src/pycifrw (N/A)" || {
+        print $MSG_NOCLEAN
+    } || return $?
+    ListSkipOrDo clean "src/diffpy.Structure" || (
+        setopt xtrace
+        cd $SRCDIR/diffpy.Structure &&
+            rm -rf build temp diffpy.Structure.egg-info
+    ) || return $?
+    ListSkipOrDo clean "src/diffpy.utils" || (
+        setopt xtrace
+        cd $SRCDIR/diffpy.utils &&
+            rm -rf build temp diffpy.utils.egg-info
+    ) || return $?
+    ListSkipOrDo clean "src/periodictable (N/A)" || {
+        print $MSG_NOCLEAN
+    } || return $?
+    ListSkipOrDo clean "src/libobjcryst" || (
+        setopt xtrace
+        cd $SRCDIR/libobjcryst && $SCONS --clean
+    ) || return $?
+    ListSkipOrDo clean "src/pyobjcryst" || (
+        setopt xtrace
+        cd $SRCDIR/pyobjcryst &&
+            rm -rf build temp pyobjcryst.egg-info
+    ) || return $?
+    ListSkipOrDo clean "src/libdiffpy" || (
+        setopt xtrace
+        cd $SRCDIR/libdiffpy && $SCONS --clean
+    ) || return $?
+    ListSkipOrDo clean "src/diffpy.srreal" || (
+        setopt xtrace
+        cd $SRCDIR/diffpy.srreal &&
+            rm -rf build temp diffpy.srreal.egg-info
+    ) || return $?
+    ListSkipOrDo clean "src/diffpy.srfit" || (
+        setopt xtrace
+        cd $SRCDIR/diffpy.srfit &&
+            rm -rf build temp diffpy.srreal.egg-info
+    ) || return $?
+    ListSkipOrDo clean "src/srfit-sasview" || {
+        setopt xtrace
+        cd $SRCDIR/srfit-sasview &&
+            rm -rf build temp srfit_sasview.egg-info
+    } || return $?
+}
+
+
 do_update() {
     local PS4=">> "
     local msg_noupdate
@@ -483,6 +549,11 @@ do_install() {
 
 # Main section here ----------------------------------------------------------
 
+if [[ -n ${opt_clean} ]]; then
+    expand_ranges clean_selection ${${opt_clean##--clean=#}:-all}
+    do_clean || exit $?
+fi
+
 if [[ -n ${opt_update} ]]; then
     expand_ranges update_selection ${${opt_update##--update=#}:-all}
     do_update || exit $?
@@ -493,6 +564,6 @@ if [[ -n ${opt_build} ]]; then
     do_build || exit $?
 fi
 
-if [[ -z "${opt_update}${opt_build}" ]]; then
+if [[ -z "${opt_clean}${opt_update}${opt_build}" ]]; then
     do_install
 fi