1 # Setup functions and settings used in subdirectories.
3 # Their setup.sh script sources this file.
5 # Copyright (C) 2009-2013 Simon Ruderich
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 # csh gives the error "Unknown colorls variable `su'." when used with newer
22 # options supported by Zsh or GNU ls.
26 # Check if the given program is installed. `type` is portable, `which` is not.
28 type "$1" >/dev/null 2>&1
30 # Get the path of the given program. Thanks to Gilles on [1] (read on
31 # 2013-03-10) for the PATH-walking idea. `which` is not portable and `type`
32 # has no well-formed output format.
34 # [1]: http://unix.stackexchange.com/questions/4988/how-do-i-test-to-see-if-an-application-exists-in-path/4991
36 test -z "$1" && return 1
38 # Keep IFS change local.
42 for directory in $PATH; do
43 if test -x "$directory/$1"; then
53 # Usage: cmd_i <cmd> ... <file>
55 # Run <cmd> with all arguments (including the last file) and write the result
56 # to the temporary file <file>.tmp and then renamed that file to <file>. This
57 # can't be done in-place (e.g. cmd <file >file) because it truncates the file.
66 mv "$last".tmp "$last"
69 # Usage: sed_i ... <file>
71 # sed -i is not compatible due to different implementations. See cmd_i.
76 # Print the current OS. The following OS are supported at the moment:
80 # - Solaris/OpenSolaris (sun)
82 # If an unsupported OS is used an error is printed.
84 if test -f /etc/debian_version; then
86 elif test -f /etc/gentoo-release; then
88 elif test x`uname` = xDarwin; then
90 elif test x`uname` = xSunOS; then
92 elif test x`uname` = xFreeBSD; then
95 echo unsupported OS! >&2
100 # Creates a symbolic link for file $1 in dirname of $2 with name of basename
103 # `./link.sh example ~/.examplerc` creates a symbolic link to example
104 # (wherever it is located) in ~/ named .examplerc.
106 local pwd base source target >/dev/null 2>&1 || true
108 # Get all necessary paths.
110 base=`echo "$2" | sed "s|\~|$HOME|"` # expand ~, some sh don't do it
111 base=`dirname "$base"`
112 source=`echo "$pwd/$1" | sed "s|$base/||"`
113 target=`basename "$2"`
115 # Go to the directory where the link is going to be created.
118 # Abort if the target file exists and is no symbolic link. Prevents
119 # overwriting real files.
120 if ( test -f "$target" && test ! -h "$target" ) || \
121 ( test -s "$target" && test ! -h "$target" ); then
122 echo "link(): target '$target' exists already and is no symbolic link!" >&2
126 # Make sure the source exists (is file, directory or link).
127 if test ! -f "$source" && test ! -d "$source" && test ! -h "$source"; then
128 echo "link(): source '$source' doesn't exist!" >&2
132 # Create the new symbolic link; remove the old one if necessary.
133 echo "link(): linking '$source' to '$target'"
135 ln -s "$source" "$target"
137 # Go back to the directory where we were before.
141 # Generate a file from a source file using a given command. A warning not to
142 # edit it is automatically added to the created file.
144 # Usage: generated() <file> <extension> <cmd..>
146 # If an empty extension is provided, the file is modified in-place (through a
149 local file >/dev/null 2>&1 || true
150 local file_tmp >/dev/null 2>&1 || true
151 local extension >/dev/null 2>&1 || true
153 # Get command and target file.
159 if test -z "$extension"; then
162 # We only need this message if we generate a new file.
163 printf "%s: generating from '%s' (%s)\n" \
164 "$file" "$file$extension" "$1"
166 echo '###################################' >"$file"
167 echo '# WARNING! DO NOT EDIT THIS FILE! #' >>"$file"
168 echo '###################################' >>"$file"
170 echo "# It was generated from $file$extension on `date`." >>"$file"
176 # Generate $file from $file$extension using the given command.
177 "$@" <"$file$extension" >>"$file_tmp"
179 if test -z "$extension"; then
180 mv "$file_tmp" "$file"