Revamp mkit

Make it

 *  more flexible,
 *  more readable,
 *  faster,
 *  take care of manpages (not fully done yet),
 *  take care of dist list,
 *  little bit more polished in various other things.

Makefile

@@ -14,11 +14,8 @@ options:
 build:
 	@mkit/make build
 
-install_manpages: manpages
-	@mkit/make install_manpages
-
 manpages: build
-	@mkit/make manpages
+	@mkit/make build_manpages
 
 test:
 	@test/runtests

mkit/paths.ini → mkit/config.ini

@@ -1,32 +1,50 @@
-[roots]
-    bin     = /usr/bin
-    doc     = /usr/share/doc
-    man     = /usr/share/man
-    share   = /usr/share
 
-[groups]
+[main]
+
+    projname = ffoo
+
+    group = bin
+    group = doc
+    group = man
+    group = share
+
+    dist = config.mk
+    dist = LICENSE
+    dist = Makefile
+    dist = mkit
+    dist = README
+    dist = src
+    dist = test
+
+[modes]
     bin     = 755
     doc     = 644
     man     = 644
     share   = 644
 
-[bin]
+[roots]
+    bin     = /usr/bin
+    doc     = /usr/share/doc
+    man     = /usr/share/man
+    share   = /usr/share
+
+[files:bin]
     src/bin/ffdoc                       = ffdoc
     src/bin/fff                         = fff
     src/bin/ffoom                       = ffoom
 
-[doc]
+[files:doc]
     LICENSE                             = ffoo/LICENSE
     README                              = ffoo/README
     src/doc/examples/template.sh        = ffoo/examples/template.sh
     src/doc/examples/test_something.sh  = ffoo/examples/test_something.sh
     src/doc/ffoo.3.sh                   = ffoo/examples/ffoo.3.sh
 
-[man]
-    src/doc/fff.1.md                    = man1/fff.1
-    src/doc/ffoo.3.md                   = man1/ffoo.3
+[files:man]
+    src/doc/fff.1                       = man1/fff.1
+    src/doc/ffoo.3                      = man3/ffoo.3
 
-[share]
+[files:share]
     src/ffoo.sh                         = ffoo/ffoo.sh
     src/include/_pretty_color.sh        = ffoo/include/_pretty_color.sh
     src/include/_pretty_html.sh         = ffoo/include/_pretty_html.sh

mkit/include/common.sh → mkit/include/build.sh

@@ -1,8 +1,18 @@
 #!/bin/bash
 
-bailout() {
-    echo "$@" >&2
-    exit 3
+. mkit/include/ini.sh || die "cannot import ini.sh"
+
+
+build() {
+    #
+    # Add meat to all skeletons
+    #
+    local srcpath
+    find src -type f -name '*.skel' \
+     | while read srcpath;
+       do
+           build1 "$srcpath"
+       done
 }
 
 build1() {
@@ -24,16 +34,21 @@ build1() {
     echo $dstpath >> built.list
 }
 
-build() {
-    #
-    # Add meat to all skeletons
-    #
-    local srcpath
-    find -type f -name '*.skel' \
-     | while read srcpath;
-       do
-           build1 "$srcpath"
-       done
+build_manpages() {
+    local manfile mdfile
+    if command -v ronn >/dev/null;
+    then
+        ini lskeys "files:man" \
+          | while read manfile;
+            do
+                mdfile=$manfile.md
+                ronn -r $mdfile
+                echo $manfile >> built.list
+            done
+    else
+        echo "ronn is not installed"
+        return 1
+    fi
 }
 
 clean() {
@@ -46,34 +61,15 @@ clean() {
     } || :
 }
 
-configure() {
-    #
-    # Load variables fdom config.mk
-    #
-    tmp=$(mktemp)
-    sed -e 's/ = /=/' < config.mk > $tmp
-    . $tmp
-    rm -f $tmp
-    PREFIX="$(readlink -f "$PREFIX")"
-}
-
-die() {
-    #
-    # Exit with message and non-zero exit status
-    #
-    echo "$@" >&2
-    exit 4
-}
-
 dist() {
     #
     # Create distributable tarball
     #
     local version=$(get_version)
-    local dirname=ffoo-$version
+    local dirname=$MKIT_PROJNAME-$version
     mkdir -p $dirname
     local item
-    cp -R $(list_of_dist_items) $dirname
+    cp -R $(ini path "main:dist") $dirname
     sed -i -e "s/^VERSION = .*/VERSION = $version/" $dirname/config.mk
     tar -cf $dirname.tar $dirname
     gzip $dirname.tar
@@ -105,40 +101,6 @@ expand_includes() {
     '
 }
 
-expand_groups() {
-    #
-    # Read path groups from paths.ini and expand to install params
-    #
-    local group
-    local mode
-    cat "mkit/paths.ini" \
-      | read_section groups \
-      | while read line;
-        do
-            group=${line%=*}
-            mode=${line#$group=}
-            expand_paths "$group" "$mode"
-        done
-}
-
-expand_paths() {
-    #
-    # For each path of group $1, print all install params
-    #
-    local group=$1
-    local mode=$2
-    local root="$(get_root $group)"
-    local src dst
-    cat mkit/paths.ini \
-      | read_section $group \
-      | while read line;
-        do
-            src=${line%=*}
-            dst=${line#$src=}
-            echo "$src:$mode:$root/$dst"
-        done
-}
-
 expand_variables() {
     #
     # Expand variable values
@@ -150,16 +112,6 @@ expand_variables() {
     "
 }
 
-get_root() {
-    #
-    # Find out target rooot for group $1
-    #
-    local group="$1"
-    local varname="${group^^*}_DIR"
-    test -n "${!varname}" || die "missing in config.mk: $varname"
-    echo "${!varname}"
-}
-
 get_version() {
     #
     # Build semver version string with build metadata
@@ -234,66 +186,3 @@ get_version() {
     fi
     echo $version
 }
-
-install() {
-    #
-    # Install product
-    #
-    expand_groups \
-      | while read line;
-        do
-            src="$(cut -d: -f1 <<<"$line")"
-            mode="$(cut -d: -f2 <<<"$line")"
-            dst="$(cut -d: -f3- <<<"$line")"
-            command -p install -DTvm $mode $src "$dst"
-        done
-    test -f .autoclean && clean || :
-}
-
-read_section() {
-    #
-    # Read one INI section
-    #
-    local wnt=$1
-    local ok=false
-    grep '.' \
-      | grep -v '\s*#' \
-      | while read line;
-        do
-            case "$line" in
-                \[$wnt\]) ok=true;  continue ;;
-                \[*\])    ok=false; continue ;;
-            esac
-            $ok || continue
-            printf -- "%s\n" "$line"
-        done \
-      | sed -e 's/ *= */=/; s/ +$//; s/^//;'
-}
-
-route() {
-    #
-    # Call correct function based on $1
-    #
-    case $1 in
-        build|clean|dist|install|install_manpages|manpages|uninstall)
-            $1
-            ;;
-        *)
-            echo "usage: $(basename $0) build|clean|dist|install|uninstall" >&2
-    esac
-}
-
-uninstall() {
-    #
-    # Uninstall product
-    #
-    expand_groups \
-      | while read line;
-        do
-            src="$(cut -d: -f1 <<<"$line")"
-            mode="$(cut -d: -f2 <<<"$line")"
-            dst="$(cut -d: -f3- <<<"$line")"
-            rm -vf "$dst"
-        done
-
-}

mkit/include/deploy.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+
+get_dst() {
+    #
+    # Find out target path for src file $2 of group $1
+    #
+    local grp=$1
+    local src=$2
+    echo "$(get_root $grp)/$(ini path "files:$group:$src")"
+}
+
+get_root() {
+    #
+    # Find out target rooot for group $1
+    #
+    local group="$1"
+    local varname="${group^^*}_DIR"
+    test -n "${!varname}" || die "missing in config.mk: $varname"
+    echo "${!varname}"
+}
+
+install() {
+    #
+    # Install product
+    #
+    local dst group mode src
+    ini path "main:group" \
+      | while read group;
+        do
+            mode=$(ini path "modes:$group")
+            ini lskeys "files:$group" \
+              | while read src;
+                do
+                    dst=$(get_dst "$group" "$src")
+                    command -p install -DTvm $mode $src "$dst"
+                done
+        done
+    test -f .autoclean && clean || :
+}
+
+uninstall() {
+    #
+    # Uninstall product
+    #
+    local dst group src
+    ini path "main:group" \
+      | while read group;
+        do
+            ini lskeys "files:$group" \
+              | while read src;
+                do
+                    dst=$(get_dst "$group" "$src")
+                    rm -vf "$dst"
+                done
+        done
+
+}

mkit/include/ini.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+
+_ini_cat() {
+    #
+    # Load ini file to our cache (RAM disk) and cat it
+    #
+    # User should set MKIT_INI_CACHE to a ram-based file
+    # if mktemp cannot be relied upon.
+    #
+    if test -z "$_MKIT_INI_CACHED";
+    then
+        MKIT_INI_CACHE=${MKIT_INI_CACHE:-$(mktemp)}
+        _MKIT_INI_CACHED=$MKIT_INI_CACHE
+        test -r $MKIT_INI || die "cannot read MKIT_INI: $MKIT_INI"
+        cp $MKIT_INI $_MKIT_INI_CACHED
+    fi
+    cat $_MKIT_INI_CACHED
+}
+
+ini() {
+    #
+    # do ini operation
+    #
+    local op=$1
+    local arg=$2
+    local fn
+    case $op in
+        lskeys) fn=_ini_lskeys   ;;
+        sec)    fn=_ini_grepsec  ;;
+        key)    fn=_ini_grepkey  ;;
+        path)   fn=_ini_greppath ;;
+        *)      die "incorrect use of \`ini()\`"
+    esac
+    _ini_cat | $fn $arg
+}
+
+_ini_grepkey() {
+    #
+    # Read key from a section
+    #
+    local wnt=$1
+    grep '.' \
+      | grep -v '\s*#' \
+      | sed -e 's/ *= */=/; s/ +$//; s/^//;' \
+      | grep -e "^$wnt=" \
+      | cut -d= -f2-
+}
+
+_ini_greppath() {
+    #
+    # Read key from the right section
+    #
+    # E.g. `files:share:my/lib.sh` should read
+    #
+    #     [files:share]
+    #         my/lib.sh   = proj/my/lib.sh
+    #
+    local wnt=$1
+    local wntkey=${wnt##*:}
+    local wntsec=${wnt%:$wntkey}
+    _ini_grepsec $wntsec | _ini_grepkey $wntkey
+}
+
+_ini_grepsec() {
+    #
+    # Read one INI section
+    #
+    local wnt=$1
+    local ok=false
+    grep '.' \
+      | grep -v '\s*#' \
+      | while read line;
+        do
+            case "$line" in
+                \[$wnt\]) ok=true;  continue ;;
+                \[*\])    ok=false; continue ;;
+            esac
+            $ok || continue
+            printf -- "%s\n" "$line"
+        done \
+      | sed -e 's/ *= */=/; s/ +$//; s/^//;'
+}
+
+_ini_lskeys() {
+    #
+    # List keys from a section
+    #
+    local sct=$1
+    _ini_grepsec $sct | cut -d= -f1 | sort | uniq
+}

mkit/include/mkit.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+. mkit/include/build.sh  || die "cannot import ini.sh"
+. mkit/include/deploy.sh || die "cannot import ini.sh"
+. mkit/include/ini.sh    || die "cannot import ini.sh"
+
+MKIT_INI=${MKIT_INI:-mkit/config.ini}
+MKIT_PROJNAME=$(ini path main:projname)
+
+configure() {
+    #
+    # Load variables fdom config.mk
+    #
+    tmp=$(mktemp)
+    sed -e 's/ = /=/' < config.mk > $tmp
+    . $tmp
+    rm -f $tmp
+    PREFIX="$(readlink -f "$PREFIX")"
+}
+
+die() {
+    #
+    # Exit with message and non-zero exit status
+    #
+    echo "$@" >&2
+    exit 4
+}
+
+route() {
+    #
+    # Call correct function based on $1
+    #
+    case $1 in
+        build|build_manpages|clean|dist|install|uninstall)
+            $1
+            ;;
+        *)
+            echo "usage: $(basename $0) build|clean|dist|install|uninstall" >&2
+    esac
+}

mkit/make

@@ -6,7 +6,7 @@ die() {
     echo "$@" && exit 9
 }
 
-. mkit/include/common.sh || die "this must be run from project root"
+. mkit/include/mkit.sh || die "this must be run from project root"
 
 configure
 
@@ -14,26 +14,6 @@ BIN_DIR=${DESTDIR}${PREFIX}/bin
 MAN_DIR=${DESTDIR}${MANPREFIX}
 DOC_DIR=${DESTDIR}${PREFIX}/share/doc
 SHARE_DIR=${DESTDIR}${PREFIX}/share
-
-list_of_dist_items() {
-    echo config.mk
-    echo LICENSE
-    echo Makefile
-    echo mkit
-    echo README
-    echo src
-    echo test
-}
-
-manpages() {
-    ronn -r src/doc/*.[1-9].md
-    ls src/doc/*.[1-9] >> built.list
-}
-
-install_manpages() {
-    cp -vr src/doc/*.1 $MAN_DIR/man1
-    cp -vr src/doc/*.3 $MAN_DIR/man3
-    test -f .autoclean && clean || :
-}
+LIBEXEC_DIR=${DESTDIR}${PREFIX}/libexec
 
 route "$@"