1 # Setup functions and settings used in subdirectories.
3 # Their setup.sh script sources this file.
5 # Copyright (C) 2009-2014 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
44 printf '%s\n' "$directory/$1"
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 rename 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.
79 # Usage: perl_line_filter <cmd> ...
81 # Run the perl command cmd on each line before printing it.
86 # Can't use -pe because it uses <> which treats the arguments as files.
87 perl -e "use strict; use warnings; while (<STDIN>) { $cmd; print; }" "$@"
90 # Usage: simple_cpp <FIRST> <SECOND> .. -- <replacement-for-first> ...
92 # Replaces each FIRST (on word boundaries) with <replacement-for-first> like a
93 # simple cpp replacement.
100 if test x"$x" = x--; then
104 cmd="$cmd s/\b$x\b/\$ARGV[\$i]/g; \$i++;"
107 perl_line_filter "$cmd" -- "$@"
110 # Print the current OS. The following OS are supported at the moment:
114 # - Mac OS X (darwin)
115 # - Solaris/OpenSolaris (sun)
116 # - FreeBSD (freebsd)
118 # If an unsupported OS is used an error is printed.
120 if test -f /etc/debian_version; then
122 elif test -f /etc/gentoo-release; then
124 elif test x`uname` = xDarwin; then
126 elif test x`uname` = xSunOS; then
128 elif test x`uname` = xFreeBSD; then
131 echo 'unsupported OS!' >&2
136 # Creates a symbolic link for file $1 in dirname of $2 with name of basename
139 # `./link.sh example ~/.examplerc` creates a symbolic link to example
140 # (wherever it is located) in ~/ named .examplerc.
142 local pwd base source target >/dev/null 2>&1 || true
144 # Get all necessary paths.
146 base=`printf '%s' "$2" | sed "s|\~|$HOME|"` # expand ~, some sh don't do it
147 base=`dirname "$base"`
148 source=`printf '%s' "$pwd/$1" | sed "s|$base/||"`
149 target=`basename "$2"`
151 # Go to the directory where the link is going to be created.
152 cd "$base" || return 1
154 # Abort if the target file exists and is no symbolic link. Prevents
155 # overwriting real files.
156 if test -e "$target" && test ! -h "$target"; then
157 printf "link(): target '%s' exists already and is no symbolic link!\n" \
162 # Make sure the source exists.
163 if test ! -e "$source"; then
164 printf "link(): source '%s' doesn't exist!\n" "$source" >&2
168 # Create the new symbolic link; remove the old one if necessary.
169 printf "link(): linking '%s' to '%s'\n" "$source" "$target"
171 ln -s "$source" "$target"
173 # Go back to the directory where we were before.
177 # Generate a file from a source file using a given command. A warning not to
178 # edit it is automatically added to the created file.
180 # Usage: generate <file> <extension> <cmd..>
182 # If an empty extension is provided, the file is modified in-place (through a
185 local file >/dev/null 2>&1 || true
186 local file_tmp >/dev/null 2>&1 || true
187 local extension >/dev/null 2>&1 || true
189 # Get command and target file.
195 if test -z "$extension"; then
198 # We only need this message if we generate a new file.
199 printf "%s: generating from '%s' (%s)\n" \
200 "$file" "$file$extension" "$1"
202 echo '###################################' >"$file"
203 echo '# WARNING! DO NOT EDIT THIS FILE! #' >>"$file"
204 echo '###################################' >>"$file"
206 printf "# It was generated from '%s' on %s.\n" \
207 "$file$extension" "`date`" >>"$file"
213 # Generate $file from $file$extension using the given command.
214 "$@" <"$file$extension" >>"$file_tmp"
216 if test -z "$extension"; then
217 mv "$file_tmp" "$file"