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 # 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.
  33 #
  34 # [1]: http://unix.stackexchange.com/questions/4988/how-do-i-test-to-see-if-an-application-exists-in-path/4991
  35 installed_path() {
  36     test -z "$1" && return 1
  37
  38     # Keep IFS change local.
  39     (
  40         IFS=:
  41         # Walk PATH.
  42         for directory in $PATH; do
  43             if test -x "$directory/$1"; then
  44                 echo "$directory/$1"
  45                 return 0
  46             fi
  47         done
  48
  49         return 1
  50     )
  51 }
  52
  53 # Print the current OS. The following OS are supported at the moment:
  54 # - Debian (debian)
  55 # - Gentoo (gentoo)
  56 # - Mac OS X (darwin)
  57 # - Solaris/OpenSolaris (sun)
  58 # - FreeBSD (freebsd)
  59 # If an unsupported OS is used an error is printed.
  60 os() {
  61     if test -f /etc/debian_version; then
  62         echo debian
  63     elif test -f /etc/gentoo-release; then
  64         echo gentoo
  65     elif test x`uname` = xDarwin; then
  66         echo darwin
  67     elif test x`uname` = xSunOS; then
  68         echo sun
  69     elif test x`uname` = xFreeBSD; then
  70         echo freebsd
  71     else
  72         echo unsupported OS! >&2
  73         return 1
  74     fi
  75 }
  76
  77 # Creates a symbolic link for file $1 in dirname of $2 with name of basename
  78 # $2.
  79 #
  80 # `./link.sh example ~/.examplerc` creates a symbolic link to example
  81 # (wherever it is located) in ~/ named .examplerc.
  82 link() {
  83     local pwd base source target >/dev/null 2>&1 || true
  84
  85     # Get all necessary paths.
  86     pwd=`pwd`
  87     base=`echo "$2" | sed "s|\~|$HOME|"` # expand ~, some sh don't do it
  88     base=`dirname "$base"`
  89     source=`echo "$pwd/$1" | sed "s|$base/||"`
  90     target=`basename "$2"`
  91
  92     # Go to the directory where the link is going to be created.
  93     cd "$base"
  94
  95     # Abort if the target file exists and is no symbolic link. Prevents
  96     # overwriting real files.
  97     if ( test -f "$target" && test ! -h "$target" ) || \
  98             ( test -s "$target" && test ! -h "$target" ); then
  99         echo "link(): target '$target' exists already and is no symbolic link!" >&2
 100         exit 1
 101     fi
 102
 103     # Make sure the source exists (is file, directory or link).
 104     if test ! -f "$source" && test ! -d "$source" && test ! -h "$source"; then
 105         echo "link(): source '$source' doesn't exist!" >&2
 106         exit 1
 107     fi
 108
 109     # Create the new symbolic link; remove the old one if necessary.
 110     echo "link(): linking '$source' to '$target'"
 111     rm -f "$target"
 112     ln -s "$source" "$target"
 113
 114     # Go back to the directory where we were before.
 115     cd "$pwd"
 116 }
 117
 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.
 121 warning() {
 122     echo "###################################" > $1
 123     echo "# WARNING! DO NOT EDIT THIS FILE! #" >> $1
 124     echo "###################################" >> $1
 125     echo >> $1
 126     echo "# It was generated from $2 on `date`." >> $1
 127     echo >> $1
 128
 129     # Display given options if there were any (Zsh has a problem with $options
 130     # as variable name).
 131     option=
 132     if test -n "$4"; then
 133         option=" with options '$4'"
 134     fi
 135     # Write message to stdout.
 136     echo "$3: generating '$1' from '$2'$option"
 137
 138     unset option
 139 }
 140
 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
 143 # through warning().
 144 #
 145 # The following commands are possible; the file extension for the source file
 146 # in brackets.
 147 #
 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
 152 generate() {
 153     # Get command and target file.
 154     command="$1"
 155     file="$2"
 156     # Remove arguments from list.
 157     shift
 158     shift
 159
 160     # Set extension for the used commands. When cat is used $3 is used as
 161     # extension.
 162     if test x"$command" = xm4; then
 163         extension=.m4
 164     elif test x"$command" = xawk -o x"$command" = xperl; then
 165         extension=.in
 166     elif test x"$command" = xcat; then
 167         extension="$1" # is $3 in reality, $1 because of shifting
 168         shift
 169     # Print a warning and exit if an unsupported command is used.
 170     else
 171         echo "generate(): command '$command' not supported!" >&2
 172         exit 1
 173     fi
 174
 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"
 179
 180     unset command file
 181 }