# Shell functions useful to all shells.
+# Copyright (C) 2011-2012 Simon Ruderich
+#
+# This file 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 file 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 file. If not, see <http://www.gnu.org/licenses/>.
+
# Helper function to print debug information if $DEBUG is not empty.
#
# available everywhere.
source_debug() {
if [ x$DEBUG != x ]; then
- echo $@
+ echo "$@"
fi
}
-# Sources a configuration file if it exists; loads a fallback .local file if
-# it doesn't. If the .local files doesn't exist nothing is sourced.
-#
-# $1: Path to directory where configuration files are located.
-# $2: Directory name in $1 where the non .local files are stored, can be
-# empty. If empty both configuration files (normal and .local) are stored
-# in $1.
-# $3: Base name of file in $2, for example "rc" or "env".
-# $4: Extension for $3, if this file doesn't exist "$1/$3.local" is sourced.
-# Can be empty, then no extension is used.
-# $5: Additional options, set to nolocal to prevent loading of "$1/$3.local"
-# if "$1/$2/$3.$4" doesn't exist.
-#
-# Example with the following directory/file structure, $os is Darwin and
-# $hostname is marvin.
-#
-# ~/.zsh
-# ~/.zsh/env
-# ~/.zsh/env.local
-# ~/.zsh/rc
-# ~/.zsh/rc.local
-# ~/.zsh/host/rc.marvin
-# ~/.zsh/os/rc.Darwin
-#
-# To load additional rc files from within ~/.zsh/rc use the following:
-#
-# source_config ~/.zsh os rc $os # loads os/rc.Darwin
-# source_config ~/.zsh host rc $hostname # loads host/rc.marvin
-#
-# To load additional env files from within ~/.zsh/env use the following (note
-# nolocal to prevent loading env.local two times if os and host files don't
-# exist):
-#
-# source_config zsh os env $os nolocal # loads os/rc.Darwin
-# source_config zsh host env $hostname # loads env.local
-#
-# By letting $4 empty normal configuration files can be sourced. A .local can
-# still be used.
-#
-# source_config zsh "" file # loads zsh/file if it exists
-#
-# Doesn't fit perfectly in this file, but this is the best place to make it
-# available everywhere.
-#
-# If DEBUG is set to a non empty value additional debug output is printed.
+# Source $1 if it exists. And $1.local if it exists as well.
source_config() {
- # Path to the file to source and its local counterpart.
- if [ x$4 != x ]; then
- source_file=$1/$2/$3.$4
- # If $4 is empty don't append a trailing dot. This allows source_config()
- # to load normal configuration files.
- else
- source_file=$1/$2/$3
- fi
- source_file_local=$1/$3.local
-
- # Additional debug output.
- source_debug "source_config(): checking if $source_file exists"
- source_debug "source_config(): checking if $source_file_local exists"
+ source_debug "source_config(): $1"
- # If the file does exist then source it.
- if [ -f $source_file ]; then
- source_debug "source_config(): -> sourcing $source_file"
- . $source_file
-
- # Otherwise load the .local file if it exists and .local files are
- # allowed.
- elif [ -f $source_file_local -a x$5 != xnolocal ]; then
- source_debug "source_config(): -> sourcing $source_file_local"
- . $source_file_local
- else
- source_debug "source_config(): -> neither exists"
+ if [ -f $1 ]; then
+ source_debug ". $1"
+ . $1
fi
- unset source_file source_file_local
+ if [ -f $1.local ]; then
+ source_debug ". $1.local"
+ . $1.local
+ fi
}
# vim: ft=sh