# Setup functions and settings used in subdirectories.
#
# Their setup.sh script sources this file.
# Copyright (C) 2009-2013 Simon Ruderich
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
# csh gives the error "Unknown colorls variable `su'." when used with newer
# options supported by Zsh or GNU ls.
unset LS_COLORS
# Check if the given program is installed. `type` is portable, `which` is not.
installed() {
type "$1" >/dev/null 2>&1
}
# Get the path of the given program. Thanks to Gilles on [1] (read on
# 2013-03-10) for the PATH-walking idea. `which` is not portable and `type`
# has no well-formed output format.
#
# [1]: http://unix.stackexchange.com/questions/4988/how-do-i-test-to-see-if-an-application-exists-in-path/4991
installed_path() {
test -z "$1" && return 1
# Keep IFS change local.
(
IFS=:
# Walk PATH.
for directory in $PATH; do
if test -x "$directory/$1"; then
echo "$directory/$1"
return 0
fi
done
return 1
)
}
# Usage: sed_i ...
#
# Uses .tmp as temporary file. sed -i is not compatible due to different
# implementations.
sed_i() {
# Get last argument.
last=
for x; do
last="$x"
done
sed "$@" >"$last".tmp
mv "$last".tmp "$last"
}
# Print the current OS. The following OS are supported at the moment:
# - Debian (debian)
# - Gentoo (gentoo)
# - Mac OS X (darwin)
# - Solaris/OpenSolaris (sun)
# - FreeBSD (freebsd)
# If an unsupported OS is used an error is printed.
os() {
if test -f /etc/debian_version; then
echo debian
elif test -f /etc/gentoo-release; then
echo gentoo
elif test x`uname` = xDarwin; then
echo darwin
elif test x`uname` = xSunOS; then
echo sun
elif test x`uname` = xFreeBSD; then
echo freebsd
else
echo unsupported OS! >&2
return 1
fi
}
# Creates a symbolic link for file $1 in dirname of $2 with name of basename
# $2.
#
# `./link.sh example ~/.examplerc` creates a symbolic link to example
# (wherever it is located) in ~/ named .examplerc.
link() {
local pwd base source target >/dev/null 2>&1 || true
# Get all necessary paths.
pwd=`pwd`
base=`echo "$2" | sed "s|\~|$HOME|"` # expand ~, some sh don't do it
base=`dirname "$base"`
source=`echo "$pwd/$1" | sed "s|$base/||"`
target=`basename "$2"`
# Go to the directory where the link is going to be created.
cd "$base"
# Abort if the target file exists and is no symbolic link. Prevents
# overwriting real files.
if ( test -f "$target" && test ! -h "$target" ) || \
( test -s "$target" && test ! -h "$target" ); then
echo "link(): target '$target' exists already and is no symbolic link!" >&2
exit 1
fi
# Make sure the source exists (is file, directory or link).
if test ! -f "$source" && test ! -d "$source" && test ! -h "$source"; then
echo "link(): source '$source' doesn't exist!" >&2
exit 1
fi
# Create the new symbolic link; remove the old one if necessary.
echo "link(): linking '$source' to '$target'"
rm -f "$target"
ln -s "$source" "$target"
# Go back to the directory where we were before.
cd "$pwd"
}
# Write a warning to $1 to make clear it should not be modified. $2 is the
# source for the generated file. Also print a message to stdout that the file
# $1 was generated from $2 using the command $3 with options $4.
warning() {
echo "###################################" > $1
echo "# WARNING! DO NOT EDIT THIS FILE! #" >> $1
echo "###################################" >> $1
echo >> $1
echo "# It was generated from $2 on `date`." >> $1
echo >> $1
# Display given options if there were any (Zsh has a problem with $options
# as variable name).
option=
if test -n "$4"; then
option=" with options '$4'"
fi
# Write message to stdout.
echo "$3: generating '$1' from '$2'$option"
unset option
}
# Generate a file using several methods. A warning not to edit it is
# automatically added to the created file and a message printed to stdout
# through warning().
#
# The following commands are possible; the file extension for the source file
# in brackets.
#
# - m4 (.m4): pipe $2.m4 through m4 then write it to $2
# - awk (.in): pipe $2.in through awk then write it to $2
# - perl (.in): pipe $2.in through perl then write it to $2
# - cat ($3): copy $2$3 to $2
generate() {
# Get command and target file.
command="$1"
file="$2"
# Remove arguments from list.
shift
shift
# Set extension for the used commands. When cat is used $3 is used as
# extension.
if test x"$command" = xm4; then
extension=.m4
elif test x"$command" = xawk -o x"$command" = xperl; then
extension=.in
elif test x"$command" = xcat; then
extension="$1" # is $3 in reality, $1 because of shifting
shift
# Print a warning and exit if an unsupported command is used.
else
echo "generate(): command '$command' not supported!" >&2
exit 1
fi
# Add warning to file and write a message to stdout.
warning "$file" "$file$extension" $command "$*"
# Generate $file from $file$extension using the given command.
cat "$file$extension" | $command "$@" >> "$file"
unset command file
}