functions

#!/bin/sh
#
# Jeremy Brubaker <jbru362@gmail.com>

# Color Escape Functions {1

###################################################
# Functions to set colors and attributes
#
#  $(FX bold) sets bold attribute
#  $(FG 1) sets foreground color to ANSI color 1
#  $(BG 1) sets background color to ANSI color 1
#  $(FX bold; FG 1) sets foreground color to ANSI
#      color 1 and bold in one command
#
# These functions automatically interpret escape
# sequences so you don't need to pass '-e' to echo
#
# Based on P. C. SHyamshankar's spectrum script
# for zsh <github.com/sykora>.
# Changed to use functions instead of hashes for speed
# Changed to use tput(1) as much as possible
###################################################
FX() {
    case "$1" in
        reset)       printf ""   ;;
        bold)        printf ""   ;;
        nobold)      printf ""  ;;
        dim)         printf ""   ;;
        nodim)       printf "0m"    ;; # Unsupported
        italic)      printf ""   ;;
        noitalic)    printf ""  ;;
        underline)   printf ""   ;;
        nounderline) printf ""  ;;
        blink)       printf ""   ;;
        fastblink)   printf ""   ;;
        noblink)     printf ""  ;;
        reverse)     printf ""   ;;
        noreverse)   printf ""  ;;
        hidden)      printf ""   ;;
        nohidden)    printf ""  ;;
        standout)    printf ""   ;;
        nostandout)  printf ""  ;;
        strikeout)   printf ""   ;;
        nostrikeout) printf ""  ;;

        fancyul)     printf "[4:1m" ;;
        dblfancyul)  printf "[4:2m" ;;
        undercurl)   printf "[4:3m" ;;
        dotfancyul)  printf "[4:4m" ;;
        dashfancyul) printf "[4:5m" ;;
        nofancyul)   printf "[4:0m" ;;

        *)           echo "";
    esac
}
# FG(), FGt(), BG() and BGt() {
if test "$( tput colors )" -ge 0; then
    # Expects: color number 0-255
    FG()  { printf "[38;5;$1m"; }
    BG()  { printf "[48;5;$1m"; }
    # Expects: 3 values (r g b) of 0-255
    FGt() { printf "[38;2;$1;$2;$3m"; }
    BGt() { printf "[48;2;$1;$2;$3m"; }
else
    FG()  { :; }
    BG()  { :; }
    FGt() { :; }
    BGt() { :; }
fi
# }
# Play rpg-cli {1
if command -v rpg-cli >/dev/null; then
cd () { # rpg-cli
    command cd "$@"
    rpg-cli cd -f .
    rpg-cli battle
}
delve () {
    current=$(basename $PWD)
    case $current in
        # starting the delve
        *[!0123456789]* ) next=dungeon/1 ;;
        # now we're delving
        [!0]*)            next=$((current + 1)) ;;
    esac
    command mkdir -p "$next" &&
        cd "$next" &&
        rpg-cli ls
}
fi # rpg-cli }
# Miscellaneous {1
rmh() { # Remove a host from ~/.ssh/known_hosts
    # Although ssh-keygen -R can be used to remove host entries, that requires
    # both adding the port (which I don't feel like remembering) and enclosing
    # the host in '[]' (which is too much typing)
    #
    printf 'g/^\[\\?%s/d\nw\nq\n' "$1" | ed ~/.ssh/known_hosts
}
http_code () { # Get meaning of HTTP error code
	code=$1

	case $code in
		'100')	echo '100 (continue)';;
		'101')	echo '101 (switching protocols)';;
		'200')	echo 'done';;
		'201')	echo '201 (created)';;
		'202')	echo '202 (accepted)';;
		'203')	echo '203 (non-authoritative information)';;
		'204')	echo '204 (no content)';;
		'205')	echo '205 (reset content)';;
		'206')	echo '206 (partial content)';;
		'300')	echo '300 (multiple choices)';;
		'301')	echo '301 (moved permanently)';;
		'302')	echo '302 (found)';;
		'303')	echo '303 (see other)';;
		'304')	echo '304 (not modified)';;
		'305')	echo '305 (use proxy)';;
		'306')	echo '306 (switch proxy)';;
		'307')	echo '307 (temporary redirect)';;
		'400')	echo '400 (bad request)';;
		'401')	echo '401 (unauthorized)';;
		'402')	echo '402 (payment required)';;
		'403')	echo '403 (forbidden)';;
		'404')	echo '404 (not found)';;
		'405')	echo '405 (method not allowed)';;
		'406')	echo '406 (not acceptable)';;
		'407')	echo '407 (proxy authentication required)';;
		'408')	echo '408 (request timeout)';;
		'409')	echo '409 (conflict)';;
		'410')	echo '410 (gone)';;
		'411')	echo '411 (length required)';;
		'412')	echo '412 (precondition failed)';;
		'413')	echo '413 (request entity too large)';;
		'414')	echo '414 (request URI too long)';;
		'415')	echo '415 (unsupported media type)';;
		'416')	echo '416 (requested range)';;
		'417')	echo '417 (expectation failed)';;
		'418')	echo "418 (I'm a teapot)";;
		'419')	echo '419 (authentication timeout)';;
		'420')	echo '420 (enhance your calm)';;
		'426')	echo '426 (upgrade required)';;
		'428')	echo '428 (precondition required)';;
		'429')	echo '429 (too many requests)';;
		'431')	echo '431 (request header fields too large)';;
		'451')	echo '451 (unavailable for legal reasons)';;
		'500')	echo '500 (internal server error)';;
		'501')	echo '501 (not implemented)';;
		'502')	echo '502 (bad gateway)';;
		'503')	echo '503 (service unavailable)';;
		'504')	echo '504 (gateway timeout)';;
		'505')	echo '505 (HTTP version not supported)';;
		'506')	echo '506 (variant also negotiates)';;
		'510')	echo '510 (not extended)';;
		'511')	echo '511 (network authentication required)';;
		*)	    echo "$code (unknown)"
	esac
}
lsp () { # Print numerical permissions at the start of ls -l output
#
# https://github.com/blaenk/dots/blob/master/zsh/zsh/functions.zsh
#
# Globals:
#   LS_OPTS
#
    # If ls is supposed to be colored, we have to force it because
    # piping the output with --color=auto strips color codes
    _opts=$(echo "$LS_OPTS" | sed 's/--color\s*=*\s*auto/--color=always/')

    command -v exa >/dev/null && _ls=exa
    command -v eza >/dev/null && _ls=eza
    if [ -n "$_ls" ]; then
        command "$_ls" $_opts -l "$@" |
            awk '{
                mode = gensub("\x1b[^m]*m", "", "g", $1)
                k = 0;
                for (i = 0; i <= 8; i++)
                    k += ((substr(mode, i+2, 1) ~ /[rwx]/) * 2^(8-i));
                if(k)
                    printf("%0o %s\n", k, $0);
                }'
    else
        command ls $_opts -lh "$@" |
            awk '{
                k = 0;
                for (i = 0; i <= 8; i++)
                    k += ((substr($1, i+2, 1) ~ /[rwx]/) * 2^(8-i));
                if(k)
                    printf("%0o ", k);
                print;
        }'
    fi
    unset _opts
}
unalias ip 2>/dev/null
ip () { # Add 'get' command to ip(8)
#
# https://jip.dev/posts/dots/
#
# 'ip get' prints current ip address and copies to clipboard
# All other commands are passed to the real 'ip' command
#
    # Use grc if it is available
    if command -v grc >/dev/null; then
        ip="grc ip"
    else
        ip="command ip"
    fi

    case "$1" in
        g | ge | get)
            res=$(curl -s ipinfo.io/ip)
            case $2 in
                c | co | cop | copy)
                    if command -v xclip >/dev/null; then
                        printf "%s" "$res" | xclip -in -selection clipboard
                        printf "copied %s to clipboard\n" "$res"
                    else
                        printf "%s\n" "not copied: xclip is not installed" >&2
                    fi
                    ;;
                h | he | hel | help)
                    cat <<EOF
Usage: ip get [copy]

Print public IP address to stdout or to the X11 clipboard if [copy]
is present
EOF
                ;;
            esac
            printf "%s\n" "$res"
            ;;
        *) $ip "$@" ;;
    esac
}
google () { # Google something
    # Create search string if arguments were passed
    if [ $# != 0 ]; then
        # Google search strings replace spaces with '+'
        IFS='+'
        search_string="$*"
        unset IFS

        url="search?hl=en&lr=&ie=UTF-8&oe=UTF-8&q="
        url="$url$search_string&btnG=Google+Search"
    fi

    # Open URL in browser. If no arguments were passed
    # it merely opens google.com
    openurl "www.google.com/$url"
}
define() { # Define words and phrases with google
    y="$@"
    curl -sA"Opera" "http://www.google.com/search?q=define:${y// /+}" |
        grep -Eo '<li>[^<]+' |
        sed 's/^<li>//g' |
        nl |
        /usr/bin/perl -MHTML::Entities -pe 'decode_entities($_)'
}
rtfm() { # Check various forms of documentation
    man "$@" ||
        [ -f "/usr/share/info/$@.info*" ] && info "$@" ||
        printf "No info entry for \n" "$@" >&2 &&
            openurl "http://duckduckgo.com/?q=%21documentation+for+$@" ;
}
#### hb/hr/hbl {
# Bold, Reverse-Video and Blinking highlighted search
#
# Arguments:
#   $1: search string
#   $2: optional foreground color number
#
# Examples:
#   who | hb "$USER" 1 
#   ps | hr ".*$PPID.*" | hbl ".*$$.*"
####
hb() {
    fx=""
    _hb_hr_hbl "$1" "$fx" "$2"
}
hr() {
    fx=""
    _hb_hr_hbl "$1" "$fx" "$2"
}
hbl() {
    fx=""
    _hb_hr_hbl "$1" "$fx" "$2"
}
_hb_hr_hbl() {
    test $2 && color="[38;5;$3m"
    reset=""
    sed "s/\($1\)/$2$color\1$reset/gI"
}
#}
lh() { # List last "n" commands in history
#
# Arguments:
#   $1: number of commands to show
#
    history | tail -"$1"
}
manf() { # Open manpage for $1 at the first occurence of flag $2
#
# https://jip.dev/posts/dots/
#
# Arguments:
#   $1: manpage to open
#   $2: flag to jump to (omit the first '-')
#
    case $MANPAGER in
        vimpager) _pager="vimpager -c 'silent! /^  *-$2/'" ;;
        *)        _pager="less --pattern '^  *-$2'" ;;
    esac
    man -P "$_pager" $1
}
wiki() { # Interact with wiki
#
# Inspired by: https://vimwiki.github.io/vimwikiwiki/Tips%20and%20Snips.html
#
# Globals:
#   BROWSER
#   WIKI_DIR
#
# Arguments:
#   $1: edit|git|make|view|help
#   $2: arguments needed by $1
#
    if test -z "$WIKI_DIR"; then
        printf "%s\n" '$WIKI_DIR is not defined'
        return 1
    fi

    case "$1" in
        git)
            git -C "$WIKI_DIR" "${@:2}"
            ;;
        make)
            (cd "$WIKI_DIR" && make ${@:2})
            ;;
        view)
            test -n "$2" && BROWSER="$2"
            openurl "$WIKI_DIR/site/index.html"
            ;;
        help)
            cat <<'END'
Usage: wiki <command> [args ...]

Commands:
    edit             Edit $WIKI_DIR/content/index.md in $EDITOR
    git [args]       Pass [args] to git(1) and execute in $WIKI_DIR
    make [args]      Run make(1) [args] in $WIKI_DIR
    view [browser]   Use openurl to view the wiki at $WIKI_DIR/site.
                       Use [browser] to view. Default is $BROWSER
    help             View this help

    Edit is the default command

Note: $WIKI_DIR must be defined
END
            ;;
        edit | *)
            if test -z "$EDITOR"; then
                EDITOR=vim
            fi
            $EDITOR "$WIKI_DIR/content/index.md"
            ;;
        esac
}
sdfmap() { # Print ASCII map location of SDF user
#
# Arguments:
#   $1: user to print
#
    curl http://plewylli.sdf-eu.org/asciimap.cgi?$1
}
elinks() { # Reuse existing elinks instance
#
# Based on elinks contrib/TIPS-AND-TRICKS
#
# Arguments:
#   $1: URL to open
#
    if command elinks -remote "ping()" 2>/dev/null; then
        if [ -n "$1" ]; then
            command elinks -remote "openURL($1,new-tab)"
        else
            command elinks -remote "reload()"
        fi
    else
        command elinks $1
    fi
}
unalias ping 2>/dev/null
ping() { # Wrap ping(1) to allow pinging by SSH Host entry
#
# Use grc if it is available
#
    if command -v grc >/dev/null; then
        ping="grc ping"
    else
        ping="command ping"
    fi

    $ping $(__gethost "$@")
}
# navi {1
_navi_call() {
    result="$(navi --path ~/share/navi "$@" </dev/tty)"
    if [ -z "${result}" ]; then
        result="$(navi --path ~/share/navi --print </dev/tty)"
    fi
    printf "%s" "$result"
}
_navi_widget() {
    input="${READLINE_LINE}"
    last_command="$(echo "${input}" | navi fn widget::last_command)"

    if [ -z "${last_command}" ]; then 
        output="$(_navi_call --print --fzf-overrides '--no-select-1')"
    else
        find="$last_command"
        replacement="$(_navi_call --print --query "${last_command}")"
        output="${input//$find/$replacement}"
    fi

    READLINE_LINE="$output"
    READLINE_POINT=${#READLINE_LINE}
}
# Helper Functions {1
# (prefix names with '__')
__gethost() { # Call gethost with the last argument passed
#
# This allows wrapping commands to use your SSH config to
# resolve hostname while still being able to pass options
# to them
#
# Example: ping -c10 <host> will call gethost <host> but
# still see the -c10 option
#
    options=
    host=
    i=0
    for arg; do
        i=$((i+1))
        # Passthru all but the last arg
        if [ "$i" -lt "$#" ]; then
            options="$options $arg"
        else
            host=$(gethost "$arg")
        fi
    done
    printf '%s %s\n' "$options" "$host"
}

# vim: foldlevel=0 foldmarker={,}