Trivial whitespace cleanups.
[paraslash.git] / command_util.sh
index 326bb032abfa827b21ea4d09f524cc7266938680..f0a861d61d887b5e68b9e90e9b9cfa512c23b9b6 100755 (executable)
@@ -1,26 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 
-dump_array_member()
-{
-       echo '{'
-       echo ".name = \"$name_txt\","
-       if test $line_handler -eq 0; then
-               echo ".handler = com_$name_txt,"
-       else
-               echo ".handler = NULL,"
-               echo ".line_handler = com_$name_txt,"
-       fi
-       if test -n "$perms_txt"; then
-               echo ".perms = $perms_txt,"
-       fi
-       echo ".description = \"$desc_txt\","
-       echo ".usage = \"$usage_txt\","
-       echo ".help = "
-       echo "$help_txt" | sed -e 's/^/\"/g' -e 's/$/\\n\"/g'
-       echo '},'
-}
-
 read_header()
 {
        local key value i
@@ -36,10 +16,13 @@ read_header()
                CC:)
                        c_file_comment="$value"
                        ;;
-               FN:)
-                       file_name="$value"
+               OF:)
+                       output_file="$value"
                        array_name=${value%command_list}cmds
                        ;;
+               SF:)
+                       source_files="$value"
+                       ;;
                AT:)
                        array_type="$value"
                        ;;
@@ -49,14 +32,17 @@ read_header()
 #include \"$i.h\""
                        done
                        includes="$includes
-#include \"$file_name.h\""
+#include \"$output_file.h\""
                        ;;
                SN:)
                        section_name="$value"
+                       ;;
+               TM:)
+                       template_members="$value"
                esac
        done
        if test -z "$header_comment" -o -z "$c_file_comment" \
-                       -o -z "$file_name"; then
+                       -o -z "$output_file"; then
                echo "header error" 1&>2
                exit 1
        fi
@@ -72,6 +58,9 @@ read_one_command()
        help_txt=""
        perms_txt=""
        line_handler=0
+       template=0
+       template_name=""
+       template_prototype=""
        mkdir -p man/man1
        while read key value; do
                case "$key" in
@@ -81,6 +70,14 @@ read_one_command()
                N:)
                        name_txt="$value"
                        ;;
+               T:)
+                       template_name="$value"
+                       template=1
+                       ;;
+               O:)
+                       template_prototype="$value"
+                       template=1
+                       ;;
                P:)
                        perms_txt="$value"
                        ;;
@@ -107,10 +104,20 @@ ${line# }"
                        ;;
                esac
        done
-       if test -n "$name_txt" -a -n "$desc_txt" -a -n "$usage_txt" \
-                       -a -n "$help_txt"; then
-               ret=1
-               return
+       if test $template -eq 0; then
+               if test -n "$name_txt" -a -n "$desc_txt" -a -n "$usage_txt" \
+                               -a -n "$help_txt"; then
+                       ret=1
+                       return
+               fi
+       else
+               if test -n "$template_name" -a -n "$template_prototype" \
+                               -a -n "$name_txt " -a -n "$template_members" \
+                               -a -n "$desc_txt" -a -n "$usage_txt" \
+                               -a -n "$help_txt"; then
+                       ret=1
+                       return
+               fi
        fi
        if test -z "$name_txt" -a -z "$desc_txt" -a -z "$usage_txt" \
                        -a -z "$help_txt"; then
@@ -118,23 +125,43 @@ ${line# }"
                return
        fi
        ret=-1
-       return
+       #return
        echo "!ERROR!"
        echo "N: $name_txt"
        echo "D: $desc_txt"
        echo "S: $usage_txt"
        echo "P: $perms_txt"
        echo "H: $help_txt"
+       echo "O: $template_prototype"
 }
 
 dump_man()
 {
-       echo ".SS \"$name_txt\""
-       echo "$desc_txt"
-       echo
-       echo "\\fBusage: \\fP$usage_txt"
+       if test $template -eq 0; then
+               echo ".SS \"$name_txt\""
+               echo "$desc_txt"
+               echo
+               echo "\\fBUsage: \\fP$usage_txt"
+       else
+               for member in $template_members; do
+                       local sed_cmd="sed -e s/@member@/$member/g"
+                       local t_name_txt=$(echo $name_txt | $sed_cmd)
+                       echo ".SS \"$t_name_txt\""
+               done
+               echo "$desc_txt"
+               echo
+               echo "\\fBUsage: \\fP"
+               echo
+               echo ".nf"
+               for member in $template_members; do
+                       local sed_cmd="sed -e s/@member@/$member/g"
+                       local t_usage_txt=$(echo $usage_txt | $sed_cmd)
+                       printf "\t$t_usage_txt\n"
+               done
+               echo ".fi"
+       fi
        echo
-       echo "$help_txt"
+       echo "$help_txt" | sed -e 's/^  //'
        echo
        if test -n "$perms_txt"; then
                echo -n "\\fBpermissions:\\fP "
@@ -164,52 +191,110 @@ com_man()
        done
 }
 
-com_c_file()
-{
-       echo "/** \file $file_name.c $c_file_comment */"
-       echo "$includes"
-       echo "struct $array_type $array_name[] = {"
-       while : ; do
-               read_one_command
-               if test $ret -lt 0; then
-                       exit 1
-               fi
-               if test $ret -eq 0; then
-                       break
-               fi
-               dump_array_member
-       done
-       echo '{.name = NULL}};'
-}
-
 dump_proto()
 {
+       local source_file match=""
+
        echo '/**'
        echo " * $desc_txt"
        echo ' *'
-       echo ' * \param fd the file descriptor to send output to'
+       echo ' * \param fd The file descriptor to send output to.'
        if test $line_handler -eq 0; then
-               echo ' * \param argc the number of arguments'
-               echo ' * \param argv the argument vector'
+               echo ' * \param argc The number of arguments.'
+               echo ' * \param argv The argument vector.'
        else
-               echo ' * \param cmdline the full command line'
+               echo ' * \param cmdline The full command line.'
        fi
        echo ' * '
-       echo " * usage: $usage_txt"
+       echo " * Usage: $usage_txt"
        echo ' * '
        echo "$help_txt" | sed -e 's/^/ * /g'
        echo ' */'
+       if test -n "$prototype"; then
+               echo "$prototype"
+               echo
+               return
+       fi
+       for source_file in $source_files; do
+               match=$(grep "^\(__noreturn \)*int com_$name_txt(" $source_file | head -n 1 | sed -e 's/$/;/1')
+               if test -n "$match"; then
+                       echo "$match"
+                       break
+               fi
+       done
+       echo
+}
+
+dump_array_member()
+{
+       echo '{'
+       echo ".name = \"$name_txt\","
        if test $line_handler -eq 0; then
-               echo "int com_$name_txt(int fd, int argc, char **argv);"
+               echo ".handler = com_$name_txt,"
        else
-               echo "int com_$name_txt(int fd, char *cmdline);"
+               echo ".handler = NULL,"
+               echo ".line_handler = com_$name_txt,"
        fi
-       echo
+       if test -n "$perms_txt"; then
+               echo ".perms = $perms_txt,"
+       fi
+       echo ".description = \"$desc_txt\","
+       echo ".usage = \"$usage_txt\","
+       echo ".help = "
+       printf "%s\n" "$help_txt" | sed -e 's/^/\"/g' -e 's/$/\\n\"/g'
+       echo '},'
+}
+
+
+template_loop()
+{
+       local t_name="$name_txt"
+       local t_perms="$perms_txt"
+       local t_desc="$desc_txt"
+       local t_usage="$usage_txt"
+       local t_help="$help_txt"
+       local t_source_files="$source_files"
+       local member
+       for member in $template_members; do
+               local sed_cmd="sed -e s/@member@/$member/g"
+               #echo "sed_cmd: $sed_cmd"
+               name_txt=$(echo $t_name | $sed_cmd)
+               #name_txt="$tname"
+               perms_txt=$(echo $t_perms | $sed_cmd)
+               desc_txt=$(echo $t_desc | $sed_cmd)
+               usage_txt=$(echo $t_usage | $sed_cmd)
+               help_txt=$(printf "%s" "$t_help" | $sed_cmd)
+               prototype=$(echo "$template_prototype" | $sed_cmd)
+               $1
+       done
+
+}
+
+com_c_file()
+{
+       echo "/** \file $output_file.c $c_file_comment */"
+       echo "$includes"
+       echo "struct $array_type $array_name[] = {"
+       while : ; do
+               read_one_command
+               if test $ret -lt 0; then
+                       exit 1
+               fi
+               if test $ret -eq 0; then
+                       break
+               fi
+               if test $template -eq 0; then
+                       dump_array_member
+                       continue
+               fi
+               template_loop dump_array_member
+       done
+       echo '{.name = NULL}};'
 }
 
 com_header()
 {
-       echo "/** \file $file_name.h $header_comment */"
+       echo "/** \file $output_file.h $header_comment */"
        echo
        echo "extern struct $array_type $array_name[];"
        while : ; do
@@ -220,7 +305,11 @@ com_header()
                if test $ret -eq 0; then
                        break
                fi
-               dump_proto
+               if test $template -eq 0; then
+                       dump_proto
+                       continue
+               fi
+               template_loop dump_proto
        done
 }