Documentation update
[clfswm.git] / contrib / clfswm
blob68a5f78bb9ce4a0d5af45e072030d49d06f85891
1 #!/bin/bash -e
3 # (C) 2008 Xavier Maillard <xma@gnu.org>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 # --------------------------------------------------------------------------
21 # Documentation:
23 # Original code and idea: http://stumpwm.antidesktop.net/cgi-bin/wiki/SetUp
25 # Installation:
26 # Put this script wherever you want and just call it from your .xinitrc file
28 # The first time you will launch it, it will build the final
29 # executable and then call it. To force a rebuild of your executable
30 # (say you have updated something in the CLFSWM source tree), just
31 # delete the image and restart your X session.
32 # --------------------------------------------------------------------------
35 no_start=no
37 lisp=clisp # +config+
38 lisp_opt='' # +config+
39 dump_path="$XDG_CACHE_HOME/clfswm/" # +config+
40 clfswm_asd_path="$(pwd)" # +config+
41 asdf_path="$(pwd)/contrib" # +config+
43 tmp_dir=/tmp
46 usage() {
48 echo "$0 [options]
49 -n, --no-start don't start CLFSWM after image dump
50 -f, --force force image dump
51 --rebuild same as -f, --force
52 -l, --with-lisp use <lisp> as the common lisp implementation [$lisp]
53 -o, --lisp-opt use <opt> as lisp option [$lisp_opt]
54 -d, --dump-path path to the dump directory [$dump_path]
55 --with-clfswm path to clfswm.asd file [$clfswm_asd_path]
56 --with-asdf path to the asdf.lisp file [$asdf_path]"
58 exit 0
61 die() {
62 echo >&2 "$@"
63 exit 1
66 build_clisp ()
68 clisp $lisp_opt -m 8MB -E ISO-8859-1 -q -i "$asdf_path"/asdf.lisp -x "(load \"$clfswm_asd_path/clfswm.asd\")
69 (asdf:oos 'asdf:load-op :clfswm) \
70 (EXT:SAVEINITMEM \"$dump_image\" :INIT-FUNCTION (lambda () (clfswm:main) (quit)) :EXECUTABLE t :norc t)"
73 build_sbcl()
75 sbcl $lisp_opt --disable-debugger --eval "(require :asdf)" \
76 --eval "(load \"$clfswm_asd_path/clfswm.asd\")" \
77 --eval "(require :clfswm)" \
78 --eval "(save-lisp-and-die \"$dump_image\" :toplevel 'clfswm:main)"
81 build_cmucl()
83 cmucl $lisp_opt -eval "(load \"$asdf_path/asdf.lisp\")" \
84 -eval "(load \"$clfswm_asd_path/clfswm.asd\")" \
85 -eval "(require :clx)" \
86 -eval "(asdf:oos 'asdf:load-op :clfswm)" \
87 -eval "(save-lisp \"$dump_image\" :init-function (lambda () (clfswm:main) (quit)))"
90 build_ccl()
92 ccl $lisp_opt --eval "(require :asdf)" \
93 --eval "(load \"$clfswm_asd_path/clfswm.asd\")" \
94 --eval "(asdf:oos 'asdf:load-op :clfswm)" \
95 --eval "(save-application \"$dump_image\" :toplevel-function (lambda () (clfswm:main) (quit)))"
98 build_ecl()
100 ecl $lisp_opt -eval "(require :asdf)" \
101 -eval "(load \"$clfswm_asd_path/clfswm.asd\")" \
102 -eval "(asdf:make-build :clfswm :type :program :monolithic t :move-here \".\" :prologue-code '(progn (require :asdf) (require :clx)))" \
103 -eval "(ext:quit 0)"
104 mv ./clfswm-mono "$dump_image"
105 echo "$dump_image"
109 while test $# != 0
111 case "$1" in
112 -n|--no-start)
113 no_start=yes ;;
114 -f|--force|--rebuild)
115 force=yes ;;
116 -d|--dump-path)
117 shift
118 dump_path="$1" ;;
119 --with-clfswm)
120 shift
121 clfswm_asd_path="$1" ;;
122 --with-asdf)
123 shift
124 asdf_path="$1" ;;
125 -l|--with-lisp)
126 shift
127 case "$1" in
129 usage;;
130 clisp|sbcl|cmucl|ccl|ecl)
131 lisp="$1" ;;
132 esac
134 -o|--lisp-opt)
135 shift
136 lisp_opt="$1" ;;
138 shift
139 break ;;
141 usage ;;
142 esac
143 shift
144 done
147 dump_image="$dump_path/clfswm-$(cksum $(type -p $lisp) | cut -d ' ' -f 1).core"
149 if test yes = "$force" && test -e "$dump_image"
150 then
151 echo "Removing old image."
152 rm -f "$dump_image"
155 clfswm_asd="$clfswm_asd_path"/clfswm.asd
156 if test -L "$clfswm_asd_path"; then
157 clfswm_asd=$(readlink "$clfswm_asd")
160 older_image=0
161 for i in "$(dirname $clfswm_asd)"/src/*.lisp; do
162 test "$dump_image" -ot "$i" && older_image=1
163 done
165 if test ! -e "$dump_image" || test $older_image -eq 1
166 then
167 echo "Image is nonexistent or older than sources. Rebuilding clfswm."
168 test -x $(type -p "$lisp") || die "$lisp can't be found."
169 test -e "$clfswm_asd_path"/clfswm.asd || die "can't find clfswm.asd in $clfswm_asd_path"
170 test -e "$asdf_path"/asdf.lisp || die "can't find asdf.lisp in $asdf_path"
172 # Move clfswm sources to $tmp_dir if there is no write permission on $clfswm_asd_path
173 if test ! -w "$clfswm_asd_path" ; then
174 echo "* Note: No write access in sources ($clfswm_asd_path),
175 -> copying in a writable directory ($tmp_dir/clfswm-tmp)"
176 rm -rf "$tmp_dir"/clfswm-tmp
177 mkdir "$tmp_dir"/clfswm-tmp
178 cp -R "$clfswm_asd_path"/* "$tmp_dir"/clfswm-tmp
179 clfswm_asd_path="$tmp_dir"/clfswm-tmp
180 asdf_path="$tmp_dir"/clfswm-tmp/contrib
183 mkdir -p "$dump_path"
184 mkdir -p "$dump_path/contrib"
185 eval build_"$lisp"
186 rm -rf "$dump_path/contrib"
187 cp -R "$clfswm_asd_path/contrib/" "$dump_path/"
188 rm -rf $(find "$dump_path/" -name "*svn")
190 rm -rf "$tmp_dir"/clfswm-tmp
193 # Run the resulting image
194 if test no = "$no_start"
195 then
196 cd "$dump_path"
197 case $lisp in
198 clisp ) "$dump_image" ;;
199 sbcl ) exec sbcl --core "$dump_image" ;;
200 cmucl ) exec cmucl -core "$dump_image" ;;
201 ccl ) exec ccl -I "$dump_image" ;;
202 ecl ) "$dump_image" -eval "(progn (clfswm:main) (ext:quit 0))" ;;
203 *) echo "..." ;;
204 esac
205 else
206 echo "As requested, we have just dumped the image."