up function

up.sh

# Convenience function for moving up levels in the path to the current working directory.
# Synopsis:
#     `up [n]` moves n levels up in the directory hierarchy; default is 1.
#     `up dirname` changes to the closest ancestral directory by that name, regardless of case.
#     `up absolutepath` changes to the specified absolute path; primarily used with command completion (see below).
# Additionally, if command completion via _complete_up() is in effect (<tab> represents pressing the tab key):
#      `up [n]<tab>` replaces n with the absolute path of the directory n levels up (default is 1).
#      `up dirnameprefix<tab>` replaces dirnameprefix with the absolute path of the closest ancestral directory whose name starts with the specified name prefix, terminated with '/'.
#         Whether dirnameprefix is matched case-insensitively or not depends on whether case-insensitive command completion is turned on globally via ~/.inputrc or /etc/inputrc.
#       In both cases the completed absolute path ends in '/', allowing you to optionally continue completion based on that path's subdirectories.
# Notes:
#   - Directory names with characters that need escaping when unquoted (such as spaces) are handled correctly.
#   - For command completion, to specify names that need escaping when unquoted, specify them escaped rather than quoted;
#     e.g., `up my \di<tab>' to match 'my dir' in the ancestral path.
function up {

	local dir='../'   # By default, go up 1 level.

	[[ "$1" == '-h' || "$1" == '--help' ]] && { echo -e "usage:\n\t$FUNCNAME [n]\n\t$FUNCNAME dirname\n  Moves up N levels in the path to the current working directory, 1 by default.\n  If DIRNAME is given, it must be the full name of an ancestral directory (case does not matter).\n  If there are multiple matches, the one *lowest* in the hierarchy is changed to." && return 0; }

	if [[ -n "$1" ]]; then
		if [[ $1 =~ ^[0-9]+$ ]]; then   # A number, specifying the number of levels to go up.
			local strpath=$( printf "%${1}s" ) # This creates a string with as many spaces as levels were specified.
			dir=${strpath// /$dir}  # Create the go-up-multiple-levels cd expression by replacing each space with '../'
		elif [[ $1 =~ ^/ ]]; then  # Already an absolute path? Use as is. (Typically, this happens as a result of command-line completion invoked via _complete_up().)
			dir=$1
		else # Assumed to be the full name of an ancestral directory (regardless of level), though the case needn't match.
			# Note: On case-insensitive HFS+ volumes on a Mac (the default), you can actually use case-insensitive names with 'cd' and the resulting working directory will be reported in that case(!).
			#       This behavior is NOT related to whether case-insensitivity is turned on for command completion or not.
			# !! Strangely, the 'nocasematch' shopt setting has no effect on variable substitution, so we need to roll our own case-insensitive substitution logic here.
			local wdLower=$(echo -n "$PWD" | tr '[:upper:]' '[:lower:]')
			local tokenLower=$(echo -n "$1" | tr '[:upper:]' '[:lower:]')
			local newParentDirLower=${wdLower%/$tokenLower/*}   # If the specified token is a full ancestral directory name (irrespective of case), this substitution will give us its parent path.
			[[ "$newParentDirLower" == "$wdLower"  ]] && { echo "$FUNCNAME: No ancestral directory named '$1' found." 1>&2; return 1; }
			local targetDirPathLength=$(( ${#newParentDirLower} + 1 + ${#tokenLower} ))
			# Get the target directory's name in the exact case it's defined.
			dir=${PWD:0:$targetDirPathLength}
		fi
	fi

	# Change to target directory; use of 'pushd' allows use of 'popd' to return to previous working directory.
	pushd "$dir" 1>/dev/null
}

# Companion function to up(), used for command completion.
# To install it, run (typically in your bash profile):
# `complete -o filenames -F _complete_up up`
# Note: The '-o filenames' option ensures that:
#   (a) paths of directories returned via $COMPREPLY leave the cursor at the terminating "/" for potential further completion
#   (b) paths with embeddes spaces and other characters requiring \-escaping are properly escaped.
function _complete_up {
	COMPREPLY=() # Initialize the array variable through which completions must be passed out.

	# Retrieve the current command-line token, i.e., the one on which completion is being invoked.
	local curToken=${COMP_WORDS[COMP_CWORD]}
	# Remove \ chars., presumed to be escape characters in the current token, which is presumed to be *unquoted*. This allows invoking completion on a token with embedded space, e.g., '$FUNCNAME some\ directory'
	# !! Strictly speaking, we'd have to investigate whether the token was specified with quotes on the command line and, if quoted,  NOT unescape. Given that the purpose of this function is expedience, we
	# !! assume that the token is NOT quoted and that all backslashes are therefore escape characters to be removed.
	curToken=${curToken//'\'}

	if [[ $curToken =~ ^/ ]]; then # Token is an absolute path (typically as a result of a previous completion) -> complete with directory names, similar to 'cd' (although the latter, curiously, also completes *file* names).

		local IFS=$'\n' # Make sure that the output of compgen below is only split along lines, not also along spaces (which the default $IFS would do).
		COMPREPLY=($(compgen -o dirnames -- "$curToken"))

	elif [[ $curToken =~ ^[0-9]+/? ]]; then # Token is a number (optionally followed by a slash) -> replace the token to be completed with the absolute path of the directory N levels above, where N is the number specified.

		# Create a go-up-multiple-levels cd expression that corresponds to the number of levels specified.
		local strpath=$( printf "%${curToken%%/*}s" ) # This creates a string with as many spaces as levels were specified.
		local upDirSpec=${strpath// /../}  # Create the go-up-multiple-levels cd expression by replacing each space with '../'

		local trailingpath="${curToken#*/}"

		if [[ $trailingpath =~ ^[0-9]+$ ]]; then
			trailingpath=""
		fi

		# Expand to absolute path (ending in '/' to facilitate optional further completion) and return.
		local dir=$(cd "$upDirSpec"; echo -n "$PWD/")

		if [[ "$dir" == '//' ]]; then dir='/'; fi # In case the target dir turns out to be the root dir, we've accidentally created '//' in the previous statement; fix it.
		# !! Note that the path will appear *unquoted* on the command line and must therefore be properly \-escaped (e.g., a ' '  as '\ ').
		# !! Escaping is performed automatially by virtue of defining the compspec with '-o filenames' (passed to 'complete').

		# If we had started with something like up 2/mydir then let's add back the /mydir
		if [[ -n $trailingpath ]]; then
			# And check if we have a slash at the beginning
			if [[ "${trailingpath:0:1}" != "/" && "${dir: -1}" != "/" ]]; then
				trailingpath="/$trailingpath"
			fi

			dir="${dir}${trailingpath}"

			# dir="$(compgen -o dirnames -- "$dir")"
		fi

		COMPREPLY=("$dir")

	else # Token is a name -> look for a prefix match among all the ancestral path components; use the first match found (i.e., the next match up in the hierarchy).

		# Determine if we should do case-insensitive matching or not, depending on whether cases-insensitive completion was turned on globally via ~/.inputrc or /etc/inputrc.
		# We do this to be consistent with the default command completion behavior.
		local caseInsensitive=0
		bind -v | egrep -i '\bcompletion-ignore-case[[:space:]]+on\b' &>/dev/null && caseInsensitive=1

		# If we need to do case-INsensitive matching in this function, we need to make sure the 'nocasematch' shell option is (temporarily) turned on.
		local nocasematchWasOff=0
		if (( caseInsensitive )); then
			nocasematchWasOff=1
			shopt nocasematch >/dev/null && nocasematchWasOff=0
			(( nocasematchWasOff )) && shopt -s nocasematch >/dev/null
		fi

		local pathSoFar=''
		local matchingPath=''
		# Note: By letting the loop iterate over ALL components starting at the root, we end up with the *last* match, i.e. the one *lowest* in the hierarchy (closed to the current working folder).
		# !! We COULD try to return multiple matches, if applicable, but in practice we assume that there'll rarely be paths whose components have identical names or prefixes.
		# !! Thus, should there be multiple matches, the user can reinvoke the same command to change to the next-higher match (though the command must be typed again), and so forth.
		local parentPath=${PWD%/*}
		local IFS='/' # This will break our parent path into components in the 'for' loop below.
		local name
		for name in ${parentPath:1}; do
			pathSoFar+=/$name
			if [[ "$name" == *"$curToken"* ]]; then
				matchingPath="$pathSoFar/"
			fi
		done

		# Restore the state of 'nocasematch', if necessary.
		(( caseInsensitive && nocasematchWasOff )) && shopt -u nocasematch >/dev/null

		# If match was found, return its absolute path (ending in / to facilitate optional further completion).
		# !! Note that the path will appear *unquoted* on the command line and must therefore be properly \-escaped (e.g., a ' '  as '\ ').
		# !! Escaping is performed automatially by virtue of defining the compspec with '-o filenames' (passed to 'complete').
		[[ -n "$matchingPath" ]] && COMPREPLY=("$matchingPath")

	fi

	return 0
}

#Assign the auto-completion function _get for our command get.
complete -o plusdirs -o nospace -o filenames -F _complete_up up