Makefile: Fix typo in localstatedir

[people/ms/network.git] / src / functions / functions.list

#!/bin/bash
###############################################################################
#                                                                             #
# IPFire.org - A linux based firewall                                         #
# Copyright (C) 2012  IPFire Network Development Team                         #
#                                                                             #
# 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 <http://www.gnu.org/licenses/>.       #
#                                                                             #
###############################################################################
#
# Functions for nice handling of lists.
#

list_append() {
	local list=${1}
	assert isset list
	assert [ ${list} != "list" ]
	shift

	local arg
	for arg in "$@"; do
		list_append_one "${list}" "${arg}"
	done
}

list_append_one() {
	assert [ $# -eq 2 ]

	local list="${1}"
	shift

	assert isset list
	assert [ ${list} != "list" ]

	if [ -n "${!list}" ]; then
		assign "${list}" "${!list} $@"
	else
		assign "${list}" "$@"
	fi
}

# Appends one or more elements to the list only if they are not on the list, yet
list_append_unique() {
	local list=${1}
	shift

	assert isset list

	local ret=${EXIT_ERROR}

	local arg
	for arg in "$@"; do
		if ! list_match ${arg} ${!list}; then
			list_append_one ${list} "${arg}"
			ret=${EXIT_OK}
		fi
	done

	return ${ret}
}

# Removes all matching items from the list
# Returns OK if at least one match was found and ERROR when not
list_remove() {
	local list=${1}
	shift

	assert isset list
	assert [ ${list} != "list" ]

	local ret=${EXIT_ERROR}

	local _list k
	for k in ${!list}; do
		if list_match ${k} "$@"; then
			ret=${EXIT_OK}
			 continue
		fi

		_list="${_list} ${k}"
	done

	assign "${list}" "${_list}"

	return ${ret}
}

list_sort() {
	local i
	for i in "$@"; do
		print "${i}"
	done | sort | tr '\n' ' '
	print
}

list_unique() {
	local items item
	for item in "$@"; do
		# Check if the item has already been processed.
		list_match "${item}" ${items} && continue

		list_append items "${item}"
		print "${item}"
	done
}

list_match() {
	local match=${1}
	shift

	local i
	for i in "$@"; do
		[ "${match}" = "${i}" ] && return ${EXIT_OK}
	done

	return ${EXIT_ERROR}
}

list_is_empty() {
	local list="${1}"

	[ ! -n "${!list}" ]
}

list_length() {
	local length=0

	local i
	for i in "$@"; do
		length=$(( ${length} + 1 ))
	done

	print "${length}"
}

# Count how often $1 occurs in the list.
list_count() {
	local what=${1}
	shift

	local counter=0

	local arg
	for arg in "$@"; do
		if [ "${arg}" = "${what}" ]; then
			counter=$(( ${counter} + 1 ))
		fi
	done

	print "${counter}"
}

list_join() {
	local list=${1}
	local delim=${2}

	assert isset list
	assert isset delim
	assert [ ${list} != "list" ]

	local ret
	printf -v ret "${delim}%s" ${!list}

	print "${ret:${#delim}}"
}

list_reverse() {
	local reversed arg
	for arg in "$@"; do
		reversed="${arg} ${reversed}"
	done

	print "${reversed}"
	return ${EXIT_OK}
}

list_head() {
	local arg
	for arg in "$@"; do
		print "${arg}"
		return ${EXIT_OK}
	done

	return ${EXIT_ERROR}
}

list_directory() {
	local dir="${1}"

	# Only works for directories
	if [ ! -d "${dir}" ]; then
		return ${EXIT_ERROR}
	fi

	local path
	for path in ${dir}/*; do
		if [ -e "${path}" ]; then
			basename "${path}"
		fi
	done

	return ${EXIT_OK}
}