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 # Usage: cmd_i <cmd> ... <file>
  54 #
  55 # Run <cmd> with all arguments (including the last file) and write the result
  56 # to the temporary file <file>.tmp and then renamed that file to <file>. This
  57 # can't be done in-place (e.g. cmd <file >file) because it truncates the file.
  58 cmd_i() {
  59     # Get last argument.
  60     last=
  61     for x; do
  62         last="$x"
  63     done
  64
  65     "$@" >"$last".tmp
  66     mv "$last".tmp "$last"
  67 }
  68
  69 # Usage: sed_i ... <file>
  70 #
  71 # sed -i is not compatible due to different implementations. See cmd_i.
  72 sed_i() {
  73     cmd_i sed "$@"
  74 }
  75
  76 # Print the current OS. The following OS are supported at the moment:
  77 # - Debian (debian)
  78 # - Gentoo (gentoo)
  79 # - Mac OS X (darwin)
  80 # - Solaris/OpenSolaris (sun)
  81 # - FreeBSD (freebsd)
  82 # If an unsupported OS is used an error is printed.
  83 os() {
  84     if test -f /etc/debian_version; then
  85         echo debian
  86     elif test -f /etc/gentoo-release; then
  87         echo gentoo
  88     elif test x`uname` = xDarwin; then
  89         echo darwin
  90     elif test x`uname` = xSunOS; then
  91         echo sun
  92     elif test x`uname` = xFreeBSD; then
  93         echo freebsd
  94     else
  95         echo unsupported OS! >&2
  96         return 1
  97     fi
  98 }
  99
 100 # Creates a symbolic link for file $1 in dirname of $2 with name of basename
 101 # $2.
 102 #
 103 # `./link.sh example ~/.examplerc` creates a symbolic link to example
 104 # (wherever it is located) in ~/ named .examplerc.
 105 link() {
 106     local pwd base source target >/dev/null 2>&1 || true
 107
 108     # Get all necessary paths.
 109     pwd=`pwd`
 110     base=`echo "$2" | sed "s|\~|$HOME|"` # expand ~, some sh don't do it
 111     base=`dirname "$base"`
 112     source=`echo "$pwd/$1" | sed "s|$base/||"`
 113     target=`basename "$2"`
 114
 115     # Go to the directory where the link is going to be created.
 116     cd "$base"
 117
 118     # Abort if the target file exists and is no symbolic link. Prevents
 119     # overwriting real files.
 120     if ( test -f "$target" && test ! -h "$target" ) || \
 121             ( test -s "$target" && test ! -h "$target" ); then
 122         echo "link(): target '$target' exists already and is no symbolic link!" >&2
 123         exit 1
 124     fi
 125
 126     # Make sure the source exists (is file, directory or link).
 127     if test ! -f "$source" && test ! -d "$source" && test ! -h "$source"; then
 128         echo "link(): source '$source' doesn't exist!" >&2
 129         exit 1
 130     fi
 131
 132     # Create the new symbolic link; remove the old one if necessary.
 133     echo "link(): linking '$source' to '$target'"
 134     rm -f "$target"
 135     ln -s "$source" "$target"
 136
 137     # Go back to the directory where we were before.
 138     cd "$pwd"
 139 }
 140
 141 # Write a warning to $1 to make clear it should not be modified. $2 is the
 142 # source for the generated file. Also print a message to stdout that the file
 143 # $1 was generated from $2 using the command $3 with options $4.
 144 warning() {
 145     echo "###################################" > $1
 146     echo "# WARNING! DO NOT EDIT THIS FILE! #" >> $1
 147     echo "###################################" >> $1
 148     echo >> $1
 149     echo "# It was generated from $2 on `date`." >> $1
 150     echo >> $1
 151
 152     # Display given options if there were any (Zsh has a problem with $options
 153     # as variable name).
 154     option=
 155     if test -n "$4"; then
 156         option=" with options '$4'"
 157     fi
 158     # Write message to stdout.
 159     echo "$3: generating '$1' from '$2'$option"
 160
 161     unset option
 162 }
 163
 164 # Generate a file using several methods. A warning not to edit it is
 165 # automatically added to the created file and a message printed to stdout
 166 # through warning().
 167 #
 168 # The following commands are possible; the file extension for the source file
 169 # in brackets.
 170 #
 171 # - m4   (.m4): pipe $2.m4 through m4 then write it to $2
 172 # - awk  (.in): pipe $2.in through awk then write it to $2
 173 # - perl (.in): pipe $2.in through perl then write it to $2
 174 # - cat  ($3):  copy $2$3 to $2
 175 generate() {
 176     # Get command and target file.
 177     command="$1"
 178     file="$2"
 179     # Remove arguments from list.
 180     shift
 181     shift
 182
 183     # Set extension for the used commands. When cat is used $3 is used as
 184     # extension.
 185     if test x"$command" = xm4; then
 186         extension=.m4
 187     elif test x"$command" = xawk -o x"$command" = xperl; then
 188         extension=.in
 189     elif test x"$command" = xcat; then
 190         extension="$1" # is $3 in reality, $1 because of shifting
 191         shift
 192     # Print a warning and exit if an unsupported command is used.
 193     else
 194         echo "generate(): command '$command' not supported!" >&2
 195         exit 1
 196     fi
 197
 198     # Add warning to file and write a message to stdout.
 199     warning "$file" "$file$extension" $command "$*"
 200     # Generate $file from $file$extension using the given command.
 201     cat "$file$extension" | $command "$@" >> "$file"
 202
 203     unset command file
 204 }