lib.sh

   1 # Setup functions and settings used in subdirectories.
   2 #
   3 # Their setup.sh script sources this file.
   4
   5 # Copyright (C) 2009-2013  Simon Ruderich
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19
  20
  21 # csh gives the error "Unknown colorls variable `su'." when used with newer
  22 # options supported by Zsh or GNU ls.
  23 unset LS_COLORS
  24
  25
  26 # Check if the given program is installed. `type` is portable, `which` is not.
  27 installed() {
  28     type "$1" >/dev/null 2>&1
  29 }
  30
  31 # Print the current OS. The following OS are supported at the moment:
  32 # - Debian (debian)
  33 # - Gentoo (gentoo)
  34 # - Mac OS X (darwin)
  35 # - Solaris/OpenSolaris (sun)
  36 # - FreeBSD (freebsd)
  37 # If an unsupported OS is used an error is printed.
  38 os() {
  39     if [ -f /etc/debian_version ]; then
  40         echo debian
  41     elif [ -f /etc/gentoo-release ]; then
  42         echo gentoo
  43     elif [ x`uname` = xDarwin ]; then
  44         echo darwin
  45     elif [ x`uname` = xSunOS ]; then
  46         echo sun
  47     elif [ x`uname` = xFreeBSD ]; then
  48         echo freebsd
  49     else
  50         echo unsupported OS! >&2
  51         return 1
  52     fi
  53 }
  54
  55 # Creates a symbolic link for file $1 in dirname of $2 with name of basename
  56 # $2.
  57 #
  58 # `./link.sh example ~/.examplerc` creates a symbolic link to example
  59 # (wherever it is located) in ~/ named .examplerc.
  60 link() {
  61     # Get all necessary paths.
  62     pwd=`pwd`
  63     base=`echo "$2" | sed "s|\~|$HOME|"` # expand ~, some sh don't do it
  64     base=`dirname "$base"`
  65     source=`echo "$pwd/$1" | sed "s|$base/||"`
  66     target=`basename "$2"`
  67
  68     # Go to the directory where the link is going to be created.
  69     cd "$base"
  70
  71     # Abort if the target file exists and is no symbolic link. Prevents
  72     # overwriting real files.
  73     if [ \( -f "$target" -a ! -h "$target" \) -o \
  74          \( -s "$target" -a ! -h "$target" \) ]; then
  75         echo "link(): target '$target' exists already and is no symbolic link!" >&2
  76         exit 1
  77     fi
  78
  79     # Make sure the source exists (is file, directory or link).
  80     if [ ! -f "$source" -a ! -d "$source" -a ! -h "$source" ]; then
  81         echo "link(): source '$source' doesn't exist!" >&2
  82         exit 1
  83     fi
  84
  85     # Create the new symbolic link; remove the old one if necessary.
  86     echo "link(): linking '$source' to '$target'"
  87     rm -f "$target"
  88     ln -s "$source" "$target"
  89
  90     # Go back to the directory where we were before.
  91     cd "$pwd"
  92
  93     unset pwd base source target
  94 }
  95
  96 # Write a warning to $1 to make clear it should not be modified. $2 is the
  97 # source for the generated file. Also print a message to stdout that the file
  98 # $1 was generated from $2 using the command $3 with options $4.
  99 warning() {
 100     echo "###################################" > $1
 101     echo "# WARNING! DO NOT EDIT THIS FILE! #" >> $1
 102     echo "###################################" >> $1
 103     echo >> $1
 104     echo "# It was generated from $2 on `date`." >> $1
 105     echo >> $1
 106
 107     # Display given options if there were any (Zsh has a problem with $options
 108     # as variable name).
 109     option=
 110     if [ -n "$4" ]; then
 111         option=" with options '$4'"
 112     fi
 113     # Write message to stdout.
 114     echo "$3: generating '$1' from '$2'$option"
 115
 116     unset option
 117 }
 118
 119 # Generate a file using several methods. A warning not to edit it is
 120 # automatically added to the created file and a message printed to stdout
 121 # through warning().
 122 #
 123 # The following commands are possible; the file extension for the source file
 124 # in brackets.
 125 #
 126 # - m4   (.m4): pipe $2.m4 through m4 then write it to $2
 127 # - awk  (.in): pipe $2.in through awk then write it to $2
 128 # - perl (.in): pipe $2.in through perl then write it to $2
 129 # - cat  ($3):  copy $2$3 to $2
 130 generate() {
 131     # Get command and target file.
 132     command="$1"
 133     file="$2"
 134     # Remove arguments from list.
 135     shift
 136     shift
 137
 138     # Set extension for the used commands. When cat is used $3 is used as
 139     # extension.
 140     if [ x"$command" = xm4 ]; then
 141         extension=.m4
 142     elif [ x"$command" = xawk -o x"$command" = xperl ]; then
 143         extension=.in
 144     elif [ x"$command" = xcat ]; then
 145         extension="$1" # is $3 in reality, $1 because of shifting
 146         shift
 147     # Print a warning and exit if an unsupported command is used.
 148     else
 149         echo "generate(): command '$command' not supported!" >&2
 150         exit 1
 151     fi
 152
 153     # Add warning to file and write a message to stdout.
 154     warning "$file" "$file$extension" $command "$*"
 155     # Generate $file from $file$extension using the given command.
 156     cat "$file$extension" | $command "$@" >> "$file"
 157
 158     unset command file
 159 }