Rewrite with sh HEAD main

6 files changed, 179 insertions, 260 deletions

@@ -1,10 +1,12 @@
 NAME = shin
 DESC = Include shell scripts in other shell scripts
 
+INSTALLED = shin shinb
+
 DESTDIR =
 PREFIX = /usr/local
 
-BIN = $(DESTDIR)$(PREFIX)/bin/$(NAME)
+BIN = $(DESTDIR)$(PREFIX)/bin
 
 .PHONY: help
 help:
@@ -19,13 +21,16 @@ help:
         @echo " uninstall       Uninstall $(NAME)-related files."
 
 .PHONY: install
-install: $(NAME)
-        install -D $< $(BIN)
+install: $(INSTALLED)
+        install -Dt $(BIN) $?
 
 .PHONY: link
-link:
-        ln -sf $(PWD)/$(NAME) $(BIN)
+link: $(NAME) shinb $(BIN)
+        ln -sf $(PWD)/$(NAME) $(PWD)/shinb $(BIN)
 
 .PHONY: uninstall
 uninstall:
         rm $(BIN)
+
+$(BIN):
+        mkdir -p $(BIN)
@@ -2,35 +2,24 @@
 ## include shell files
 
 built to scratch a personal itch.  SHIN is an awk(1) script that plops include
-files in to .shin files.  here's the usage text:
+files in to .shin files.
 
-```
-SHIN: include shell files in other shell files
-USAGE: shin FILE...
-
-FILEs named FILE.shin will be built to FILE.sh in the same directory.
-to include files in shin files, use the following comment syntax:
+recently rewritten.  now use it like this:
 
-#< INCLUDE
+```sh
+#!/bin/sh
 
-shin will add INCLUDE below that comment, as well as a comment
-denoting the end of INCLUDE.
-```
+. shin # if shin is in $PATH this should Just Work(TM)
 
-it's really that simple.  and stupid.
+do_stuff_here
 
-## configuration
+shin included_file
 
-SHIN will look for include files in the current directory, unless you set the
-SHINPATH environment variable.  $SHINPATH is a colon-separated list of
-directories like $PATH or $MANPATH.
-
-## extras
+other_stuff
+```
 
-`shin.awk` is the plain awk script.  because awk is dumb about handling
-arguments, `shin` is a shell script that will do `shin.awk`'s work unless you
-pass `shin -h`, in which case it will print a helpful message.
+you can run the above script itself, or you can "compile" it by running `shin -c <script>`, which will insert `included_file` in the correct spot in the file and remove the `. shin` line (only if it's by itself, which really it should be).
 
-## license
+## build a shell file
 
-SHIN is licensed under the FAIR license.  see COPYING for details.
+use the program `shinb` to build a shell file on the command line.  You don't need to include `-c` in the command line when calling `shinb`.
@@ -1,67 +1,164 @@
 #!/bin/sh
-# SHIN v. 0/1
+# SHIN --- include files in shell scripts
 # Copyright (C) Case Duckworth <acdw@acdw.net>
-# Licensed under the Fair License.  See COPYING for details.
 
-_shin() {
-        awk 'BEGIN {
-        if (ENVIRON["SHINPATH"]) split(ENVIRON["SHINPATH"], SHINPATH, ":")
-        else SHINPATH[1] = "."
+_shin_check_SHINPATH() {
+        printf "%s\n" "${SHINPATH:-.}" |
+                tr : '\n' |
+                while read -r path
+                do
+                        if test -f "$path/$1"
+                        then
+                                printf '%s\n' "$path/$1"
+                                return 0
+                        fi
+                done
+        return 1
 }
-FNR == 1 { outfile = FILENAME; sub(/in$/, "", outfile) }
-{ print($0) > outfile }
-/^#</ {
-        inclfile = shin_resolve(substr($0, 3))
-        while ((getline l < inclfile) > 0) print(l) > outfile
-        close(inclfile)
-        sub(/</, ">", $0)
-        print > outfile
+
+_shin_resolve_file() {
+        f=
+        case "$1" in
+                ~/*) f="$HOME/${1#~/}" ;;
+                /*) f="/${1#/}" ;;
+                *) f="$(_shin_check_SHINPATH "$1")" ;;
+        esac
+
+        if test -f "$f"
+        then
+                printf '%s\n' "$f"
+        elif test -f "$f.sh"
+        then
+                printf '%s\n' "$f.sh"
+        else
+                return 1
+        fi
+        return 0
 }
-function shin_test(filename) {
-         if (! system("test -f \"" f "\"")) return filename
-        print("Cannot find \"" filename "\" in " sp) > (STDERR ? STDERR : "/dev/stderr")
-        exit 1
+
+_shin_include() { # _shin_include FILE ...
+        for lib
+        do
+                lib="$(_shin_resolve_file "$lib")"
+                test -f "$lib" && . "$lib"
+        done
 }
-function shin_resolve(filename) {
-        if (match(filename, "^/")) return shin_test(filename)
-        if (match(filename, "^~")) return shin_test(ENVIRON["HOME"] "/" substr(filename, 2))
-        sub(/^[ \t]*/, "", filename)
-        sub(/[ \t]*$/, "", filename)
-        sp = ""
-        for (p in SHINPATH) {
-                sp = sp (sp ? ", " : "") "\"" SHINPATH[p] "\""
-                f = SHINPATH[p] "/" filename
-                gsub("//", "/", f)
-                return shin_test(f)
-        }
-}'
+
+_shin_cleanup() {
+        if "$_shin_rmtemp" && test -f "$_shin_temp"
+        then
+                rm -f "$_shin_temp"
+        fi
 }
 
-if [ "x$1" = -h ]; then
-        cat <<\EOF
-SHIN: include shell files in other shell files
-USAGE: shin [-h] FILE...
+_shin_build() ( # _shin_build FILE ...
+        for file
+        do
+                file="$(_shin_resolve_file "$file")"
+
+                # Determine output file
+                if test -z "$_shin_output"
+                then
+                        case "$file" in
+                                # file.shin -> file.sh
+                                *.shin) _shin_output="${file%in}" ;;
+                                # file.sh -> file
+                                *.sh) _shin_output="${file%.sh}" ;;
+                                # file.ext -> file.ext.sh
+                                *) _shin_output="$file.sh" ;;
+                        esac
+                fi
 
-FLAGS:
- -h     Show this help and exit.
+                while read -r line
+                do
+                        case "$line" in
+                                # skip lines where the user sources the library
+                                .*shin) ;;
+                                .*shin.sh) ;;
+                                # where the user invokes shin, replace with file
+                                shin*) # cursed
+                                        eval \
+                                                for file in ${line#shin}\; \
+                                                do \
+                                                test -f \"\$file\" \&\& \
+                                                sed \"/^#!/d\" \"\$file\"\; \
+                                                done
+                                        ;;
+                                # else, print the line
+                                *) printf '%s\n' "$line" ;;
+                        esac
+                done < "$file" > "$_shin_temp"
 
-PARAMETERS:
- FILE...        Input files. FILEs named FILE.shin will be built to
-                FILE.sh in the same directory.  To include files in
-                shin files, use the following comment syntax:
+                ec=$?
 
-                #< INCLUDE
+                if test "x$_shin_output" = x-
+                then # already output to standard out
+                        cat "$_shin_temp"
+                        continue
+                elif test $ec -ne 0
+                then # uh oh we messed up
+                        echo >&2 "shin: errors building."
+                        echo >&2 "shin: part-built file: $_shin_temp"
+                        _shin_rmtemp=false
+                elif test -f "$_shin_output" && ! "$_shin_force"
+                then # can't overwrite sumthin without -f
+                        echo >&2 "shin: file already exists: $_shin_output"
+                        echo >&2 "shin: part-built file: $_shin_temp"
+                        _shin_rmtemp=false
+                else # move the temp file to the output
+                        if mv "$_shin_temp" "$_shin_output"
+                        then
+                                printf >&2 '%s\n' "$_shin_output"
+                        else
+                                echo >&2 "shin: errors moving $_shin_output"
+                                echo >&2 "shin: part-built file: $_shin_temp"
+                                _shin_rmtemp=false
+                        fi
+                fi
+        done
+)
 
-                If INCLUDE begins with / or ~, it's taken as a literal
-                file name; otherwise SHINPATH will be searched for the
-                file.  SHINPATH is a colon-separated list of paths
-                like $PATH.  If SHINPATH is unset, it defaults to the
-                current directory.
+shin() {
+        _shin_func="${_shin_func:-_shin_include}"
+        _shin_temp=/tmp/shinf
+        _shin_rmtemp=true
+        _shin_force=false
+        _shin_debug=false
 
-                If INCLUDE is not found, shin will error and quit.
-                Otherwise, shin will add INCLUDE below that comment,
-                as well as a comment denoting the end of the INCLUDE.
+        trap _shin_cleanup INT EXIT QUIT
+
+        while getopts dfcio: OPT
+        do
+                case "$OPT" in
+                        c) _shin_func=_shin_build ;;
+                        i) _shin_func=_shin_include ;;
+                        o) # output file implies build.
+                                _shin_func=_shin_build
+                                _shin_output="$OPTARG"
+                                echo "$_shin_output"
+                                ;;
+                        f) _shin_force=true ;;
+                        d) _shin_debug=true ;;
+                        *) exit 1 ;;
+                esac
+        done
+        shift $((OPTIND - 1))
+        OPTIND=0
+
+        if "$_shin_debug"
+        then
+                cat >&2 <<EOF
+SHIN DEBUGGING: ON
+VARIABLES:
+        _shin_func      $_shin_func
+        _shin_output    $_shin_output
+        _shin_temp      $_shin_temp
+
+        _shin_rmtemp    $_shin_rmtemp
+        _shin_force     $_shin_force
 EOF
-else
-        _shin "$@"
-fi
+                set -x
+        fi
+
+        "$_shin_func" "$@"
+}
@@ -1,60 +0,0 @@
-#!/usr/bin/awk -f
-# SHIN: include files in shell scripts
-# by Case Duckworth <acdw@acdw.net>
-# usage: shin -- FILE.shin...
-# each FILE.shin will output to FILE.sh in the same directory
-BEGIN {
-        if (ENVIRON["SHINPATH"]) {
-                split(ENVIRON["SHINPATH"], SHINPATH, ":")
-        } else {
-                SHINPATH[1] = "."
-        }
-}
-
-FNR == 1 {
-        outfile = FILENAME
-        sub(/in$/, "", outfile)
-}
-
-{
-        print($0) > outfile
-}
-
-/^#</ {
-        inclfile = shin_resolve(substr($0, 3))
-        while (getline l < inclfile) {
-                print(l) > outfile
-        }
-        close(inclfile)
-        sub(/</, ">", $0)
-        print > outfile
-}
-
-
-function shin_resolve(filename)
-{
-        if (match(filename, "^/")) {
-                return shin_test(filename)
-        }
-        if (match(filename, "^~")) {
-                return shin_test(ENVIRON["HOME"] "/" substr(filename, 2))
-        }
-        sub(/^[ \t]*/, "", filename)
-        sub(/[ \t]*$/, "", filename)
-        sp = ""
-        for (p in SHINPATH) {
-                sp = sp (sp ? ", " : "") "\"" SHINPATH[p] "\""
-                f = SHINPATH[p] "/" filename
-                gsub("//", "/", f)
-                return shin_test(f)
-        }
-}
-
-function shin_test(filename)
-{
-        if (! system("test -f \"" f "\"")) {
-                return filename
-        }
-        print("Cannot find \"" filename "\" in " sp) > (STDERR ? STDERR : "/dev/stderr")
-        exit 1
-}
@@ -1,119 +0,0 @@
-#!/bin/sh
-# SHIN --- include files in shell scripts
-# Copyright (C) Case Duckworth <acdw@acdw.net>
-
-_shin_check_SHINPATH{) {
-        printf "%s\n" "${SHINPATH:-.}" |
-                tr : '\n' |
-                while read -r path
-                do
-                        if test -f "$path/$1"
-                        then
-                                printf '%s\n' "$path/$1"
-                                return 0
-                        fi
-                done
-        return 1
-}
-
-_shin_resolve_file(} {
-        f=
-        case "$1" in
-                ~/*) f="$HOME/${1#~/}" ;;
-                /*) f="/${1#/}" ;;
-                *) f="$(_shin_check_SHINPATH "$1")" ;;
-        esac
-
-        if test -f "$f"
-        then
-                printf '%s\n' "$f"
-                return 0
-        else
-                return 1
-        fi
-}
-
-_shin_include() { # _shin_include FILE ...
-        for lib
-        do
-                lib="$(_shin_resolve_file "$lib")"
-                test -f "$lib" && . "$lib"
-        done
-}
-
-_shin_build() ( # _shin_build FILE ...
-        temp=/tmp/shinf; trap 'rm "$temp"' INT EXIT QUIT
-        for file
-        do
-                file="$(_shin_resolve_file "$file")"
-
-                # Determine output file
-                if test -z "$outfile"
-                then
-                        case "$file" in
-                                # file.shin -> file.sh
-                                *.shin) outfile="${file%in}" ;;
-                                # file.sh -> file
-                                *.sh) outfile="${file%.sh}" ;;
-                                # file.ext -> file.ext.sh
-                                *) outfile="$file.sh" ;;
-                        esac
-                fi
-
-                while read -r line
-                do
-                        case "$line" in
-                                # skip lines where the user sources the library
-                                .*shin) ;;
-                                .*shin.sh) ;;
-                                # where the user invokes shin, replace with file
-                                shin*) # cursed
-                                        eval \
-                                                for file in ${line#shin}\; \
-                                                do \
-                                                test -f \"\$file\" \&\& \
-                                                cat \"\$file\"\; \
-                                                done
-                                        ;;
-                                # else, print the line
-                                *) printf '%s\n' "$line" ;;
-                        esac
-                done < "$file" > "$temp"
-
-                if test "x$outfile" = x-
-                then # already output to standard out
-                        cat "$temp"
-                        continue
-                elif test $? -ne 0
-                then # uh oh we messed up
-                        echo >&2 "shin: errors building."
-                        echo >&2 "shin: part-built file: $temp"
-                elif test -f "$outfile"
-                then # can't overwrite sumthin
-                        echo >&2 "shin: file already exists: $outfile"
-                        echo >&2 "shin: part-built file: $temp"
-                else # move the temp file to the output
-                        mv "$temp" "$outfile"
-                fi
-        done
-)
-
-shin() {
-        func=_shin_include
-        while getopts fio: OPT
-        do
-                case "$OPT" in
-                        f) func=_shin_build ;;
-                        i) func=_shin_include ;;
-                        o) # output file implies build.
-                                func=_shin_build
-                                outputfile="$OPTARG"
-                                ;;
-                        *) exit 1 ;;
-                esac
-        done
-        shift $((OPTIND - 1))
-        OPTIND=0
-
-        "$func" "$@"
-}
@@ -0,0 +1,7 @@
+#!/bin/sh
+
+. shin
+
+_shin_func=_shin_build
+
+shin "$@"