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 # Print the current OS. The following OS are supported at the moment:
57 # - Solaris/OpenSolaris (sun)
59 # If an unsupported OS is used an error is printed.
61 if [ -f /etc/debian_version ]; then
63 elif [ -f /etc/gentoo-release ]; then
65 elif [ x`uname` = xDarwin ]; then
67 elif [ x`uname` = xSunOS ]; then
69 elif [ x`uname` = xFreeBSD ]; then
72 echo unsupported OS! >&2
77 # Creates a symbolic link for file $1 in dirname of $2 with name of basename
80 # `./link.sh example ~/.examplerc` creates a symbolic link to example
81 # (wherever it is located) in ~/ named .examplerc.
83 # Get all necessary paths.
85 base=`echo "$2" | sed "s|\~|$HOME|"` # expand ~, some sh don't do it
86 base=`dirname "$base"`
87 source=`echo "$pwd/$1" | sed "s|$base/||"`
88 target=`basename "$2"`
90 # Go to the directory where the link is going to be created.
93 # Abort if the target file exists and is no symbolic link. Prevents
94 # overwriting real files.
95 if [ \( -f "$target" -a ! -h "$target" \) -o \
96 \( -s "$target" -a ! -h "$target" \) ]; then
97 echo "link(): target '$target' exists already and is no symbolic link!" >&2
101 # Make sure the source exists (is file, directory or link).
102 if [ ! -f "$source" -a ! -d "$source" -a ! -h "$source" ]; then
103 echo "link(): source '$source' doesn't exist!" >&2
107 # Create the new symbolic link; remove the old one if necessary.
108 echo "link(): linking '$source' to '$target'"
110 ln -s "$source" "$target"
112 # Go back to the directory where we were before.
115 unset pwd base source target
118 # Write a warning to $1 to make clear it should not be modified. $2 is the
119 # source for the generated file. Also print a message to stdout that the file
120 # $1 was generated from $2 using the command $3 with options $4.
122 echo "###################################" > $1
123 echo "# WARNING! DO NOT EDIT THIS FILE! #" >> $1
124 echo "###################################" >> $1
126 echo "# It was generated from $2 on `date`." >> $1
129 # Display given options if there were any (Zsh has a problem with $options
133 option=" with options '$4'"
135 # Write message to stdout.
136 echo "$3: generating '$1' from '$2'$option"
141 # Generate a file using several methods. A warning not to edit it is
142 # automatically added to the created file and a message printed to stdout
145 # The following commands are possible; the file extension for the source file
148 # - m4 (.m4): pipe $2.m4 through m4 then write it to $2
149 # - awk (.in): pipe $2.in through awk then write it to $2
150 # - perl (.in): pipe $2.in through perl then write it to $2
151 # - cat ($3): copy $2$3 to $2
153 # Get command and target file.
156 # Remove arguments from list.
160 # Set extension for the used commands. When cat is used $3 is used as
162 if [ x"$command" = xm4 ]; then
164 elif [ x"$command" = xawk -o x"$command" = xperl ]; then
166 elif [ x"$command" = xcat ]; then
167 extension="$1" # is $3 in reality, $1 because of shifting
169 # Print a warning and exit if an unsupported command is used.
171 echo "generate(): command '$command' not supported!" >&2
175 # Add warning to file and write a message to stdout.
176 warning "$file" "$file$extension" $command "$*"
177 # Generate $file from $file$extension using the given command.
178 cat "$file$extension" | $command "$@" >> "$file"