]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - command_util.sh
command_util: Write array definition in header mode.
[paraslash.git] / command_util.sh
index d6626c253057675cceedb689d82957d607911a20..abae4ec2b74c84e925c0297900c01c3dfb3c553a 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 ".synopsis = \"$syn_txt\","
-       echo ".help = "
-       echo "$help_txt" | sed -e 's/^/\"/g' -e 's/$/\\n\"/g'
-       echo '},'
-}
-
 read_header()
 {
        local key value i
@@ -30,33 +10,41 @@ read_header()
                ---)
                        break
                        ;;
-               HC:)
-                       header_comment="$value"
+               BN:)
+                       base_name="$value"
                        ;;
-               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"
                        ;;
+               SI:)
+                       for i in $value; do
+                               system_includes="$system_includes
+#include <$i.h>"
+                       done
+                       ;;
                IN:)
                        for i in $value; do
                                includes="$includes
 #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
+       if test -z "$output_file"; then
                echo "header error" 1&>2
                exit 1
        fi
@@ -68,10 +56,12 @@ read_one_command()
 
        name_txt=""
        desc_txt=""
-       syn_txt=""
+       usage_txt=""
        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,17 +71,22 @@ read_one_command()
                N:)
                        name_txt="$value"
                        ;;
+               T:)
+                       template_name="$value"
+                       template=1
+                       ;;
+               O:)
+                       template_prototype="$value"
+                       template=1
+                       ;;
                P:)
                        perms_txt="$value"
                        ;;
                D:)
                        desc_txt="$value"
                        ;;
-               L:)
-                       line_handler=1
-                       ;;
-               S:)
-                       syn_txt="$value"
+               U:)
+                       usage_txt="$value"
                        ;;
                H:)
                        help_txt="${value}"
@@ -107,34 +102,64 @@ ${line# }"
                        ;;
                esac
        done
-       if test -n "$name_txt" -a -n "$desc_txt" -a -n "$syn_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 "$syn_txt" \
+       if test -z "$name_txt" -a -z "$desc_txt" -a -z "$usage_txt" \
                        -a -z "$help_txt"; then
                ret=0
                return
        fi
        ret=-1
-       return
+       #return
        echo "!ERROR!"
        echo "N: $name_txt"
        echo "D: $desc_txt"
-       echo "S: $syn_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$syn_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" | sed -e "s/@member@/{$(echo $template_members | sed -e 's/ / | /g')}/g"
+               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 "
@@ -150,7 +175,6 @@ dump_man()
 
 com_man()
 {
-       local n
        echo "[$section_name]"
        echo
        while : ; do
@@ -161,16 +185,89 @@ com_man()
                if test $ret -eq 0; then
                        break
                fi
-               dump_man #> $txtdir/$n.txt
-#              txt2man -t "$n" -r "$r"  < $txtdir/$n.txt \
-#                      | sed -e 1d > $mandir/$n.1
-#              man2html $mandir/$n.1 > $htmldir/$n.html
+               dump_man
+       done
+}
+
+make_proto()
+{
+       local source_file match="" CR='
+'
+       if test -n "$prototype"; then
+               result="$prototype$CR"
+               return
+       fi
+       result=
+       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
+                       result="$result$match$CR"
+                       break
+               fi
        done
 }
 
+make_array_member()
+{
+       local TAB='     ' CR='
+'
+       local tmp
+
+       result="{.name = \"$name_txt\", .handler = com_$name_txt, "
+       if test -n "$perms_txt"; then
+               result="$result .perms = $perms_txt,"
+       fi
+       result="$result.description = \"$desc_txt\", .usage = \"$usage_txt\", \\$CR .help = "
+       tmp="$(printf "%s\n" "$help_txt" | sed -e 's/^/\"/g' -e 's/$/\\n\"/g' \
+               -e "s/$TAB/\\\t/g" -e's/$/\\/g')"
+       result="$result$tmp$CR}, \\$CR"
+}
+
+make_completion()
+{
+       local CR='
+'
+       result="  {.name = \"$name_txt\", .completer = ${name_txt}_completer}, \\$CR"
+}
+
+template_loop()
+{
+       local loop_result=
+
+       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\n" "$t_help" | $sed_cmd)
+               prototype=$(echo "$template_prototype" | $sed_cmd)
+               result=
+               $1
+               loop_result="$loop_result$result"
+       done
+       result="$loop_result"
+       # reset global variables
+       name_txt="$t_name"
+       perms_txt="$t_perms"
+       desc_txt="$t_desc"
+       usage_txt="$t_usage"
+       help_txt="$t_help"
+       source_files="$t_source_files"
+}
+
 com_c_file()
 {
-       echo "/** \file $file_name.c $c_file_comment */"
+       echo "$system_includes"
        echo "$includes"
        echo "struct $array_type $array_name[] = {"
        while : ; do
@@ -181,41 +278,51 @@ com_c_file()
                if test $ret -eq 0; then
                        break
                fi
-               dump_array_member
+               if test $template -eq 0; then
+                       make_array_member
+                       printf "%s" "$result"
+                       continue
+               fi
+               template_loop make_array_member
+               printf "%s" "$result"
        done
        echo '{.name = NULL}};'
 }
 
-dump_proto()
+com_header()
 {
-       echo '/**'
-       echo " * $desc_txt"
-       echo ' *'
-       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'
-       else
-               echo ' * \param cmdline the full command line'
-       fi
-       echo ' * '
-       echo " * synopsis: $syn_txt"
-       echo ' * '
-       echo "$help_txt" | sed -e 's/^/ * /g'
-       echo ' */'
-       if test $line_handler -eq 0; then
-               echo "int com_$name_txt(int fd, int argc, char **argv);"
-       else
-               echo "int com_$name_txt(int fd, char *cmdline);"
-       fi
-       echo
+       local array_members CR='
+'
+
+       echo "extern 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
+                       make_proto
+                       printf "%s" "$result"
+                       make_array_member
+                       array_members="$array_members$result"
+                       continue
+               fi
+               template_loop make_proto
+               printf "%s" "$result"
+               template_loop make_array_member
+               array_members="$array_members$result"
+       done
+       array_members="$array_members{.name = NULL} \\$CR"
+       echo "#define DEFINE_$(tr 'a-z' 'A-Z' <<< "$base_name")_CMD_ARRAY $array_members"
 }
 
-com_header()
+com_completion()
 {
-       echo "/** \file $file_name.h $header_comment */"
-       echo
-       echo "extern struct $array_type $array_name[];"
+
+       echo "#define $1 \\"
        while : ; do
                read_one_command
                if test $ret -lt 0; then
@@ -224,8 +331,15 @@ com_header()
                if test $ret -eq 0; then
                        break
                fi
-               dump_proto
+               if test $template -eq 0; then
+                       make_completion
+                       printf "%s" "$result"
+                       continue
+               fi
+               template_loop make_completion
+               printf "%s" "$result"
        done
+       echo
 }
 
 read_header
@@ -241,4 +355,7 @@ case "$arg" in
        "man")
                com_man $*
                ;;
+       "compl")
+               com_completion $*
+               ;;
 esac