dejagnu

   1 #!/bin/sh
   2 #
   3 # Copyright (C) 2018, 2021 Free Software Foundation, Inc.
   4 #
   5 # This file is part of DejaGnu.
   6 #
   7 # DejaGnu is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # DejaGnu is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with DejaGnu; if not, write to the Free Software Foundation,
  19 # Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  20
  21 # Portions from runtest Copyright (C) 1992-2016 Free Software Foundation, Inc.
  22
  23 # This script was written by Jacob Bachmeyer.  Portions of this script are
  24 # adapted from the existing runtest script originally written by Rob Savoye.
  25
  26 # This script finds an implementation for the command given, finds the
  27 # proper interpreter, and then dispatches the command.  This script can
  28 # either be run with a command name as the first (few) argument(s), via a
  29 # link from the command name, or some combination of those.
  30
  31 # shellcheck disable=SC2003
  32 # The shellcheck tool complains about use of expr and recommends using
  33 # newer shell features instead.  Solaris 10 /bin/sh does not support the
  34 # newer features, so we must use expr in this script.
  35
  36 # shellcheck disable=SC2006
  37 # The shellcheck tool complains about the old style backtick command
  38 # substitution.  Solaris 10 /bin/sh does not support the new style $()
  39 # command substitution and the usage of command substitution in this script
  40 # is simple enough to work.  Most notably, nesting backtick command
  41 # substitution is tricky, but we do not do that.
  42
  43 # shellcheck disable=SC2209
  44 # The shellcheck tool complains about assigning certain constant strings to
  45 # variables.  In this script, the intended meaning is obvious in context.
  46
  47 # ##help
  48 # #Usage: dejagnu COMMAND [ --help | OPTIONS... ]
  49 # #Usage: dejagnu --help
  50 # #Usage: dejagnu --version
  51 # #     --help                  Print help text
  52 # #     --version               Print DejaGnu version
  53 # ##end
  54
  55 # list of extensions supported for commands in priority order
  56 Variants='gawk awk tcl exp bash sh'
  57 readonly Variants
  58
  59 ## Recognize options
  60
  61 # For testing and development
  62 override_ext=
  63 if test x"$1" = x--DGTimpl ; then
  64     override_ext=$2
  65     shift 2
  66 fi
  67
  68 want_help=false
  69 want_version=false
  70 verbose=0
  71 for a in "$@"; do
  72     case $a in
  73         --help)                         want_help=true                  ;;
  74         -v|--v|-verbose|--verbose)      verbose=`expr $verbose + 1`     ;;
  75         -V|--V|-version|--version)      want_version=true               ;;
  76     esac
  77 done
  78
  79 if expr "$verbose" \> 0 > /dev/null ; then
  80     echo Verbose level is "$verbose"
  81 fi
  82
  83 ## Get the file name of this script and deduce @bindir@.
  84
  85 bindir=`echo "$0" | sed -e 's@/[^/]*$@@'`
  86 if expr "$verbose" \> 0 > /dev/null ; then
  87     echo Running launcher from "$bindir"
  88 fi
  89
  90 ## Find the commands.
  91
  92 # If running from source tree, they are in ./commands/ relative to this script.
  93 # If installed, they are in @datadir@/dejagnu/commands/ on the system.
  94
  95 # This makes the same assumption as in runtest that one of these holds:
  96 #
  97 #   @datadir@ == @bindir@/../share
  98 #   @datadir@ == @bindir@/../../share
  99 #   @datadir@ == /usr/share
 100 #   @datadir@ == /usr/local/share
 101
 102 if test -n "$DEJAGNULIBS" ; then
 103     commdir="${DEJAGNULIBS}/commands"
 104     datadir="${DEJAGNULIBS}"
 105 elif test -d "${bindir}/commands" && test -f "${bindir}/runtest.exp" ; then
 106     if expr "$verbose" \> 1 > /dev/null ; then
 107         echo Running from source directory
 108     fi
 109     commdir="${bindir}/commands"
 110     datadir="${bindir}"
 111 else
 112     commdir=
 113     bindir1up_check=`echo "$bindir" | sed -e 's@/[^/]*$@/share/dejagnu@'`
 114     bindir2up_check=`echo "$bindir" | sed -e 's@/[^/]*/[^/]*$@/share/dejagnu@'`
 115     for i in \
 116         "${bindir1up_check}" "${bindir2up_check}" \
 117         /usr/share/dejagnu /usr/local/share/dejagnu
 118     do
 119         if expr "$verbose" \> 1 > /dev/null ; then
 120             echo Probing directory "$i"/commands
 121         fi
 122         if test -d "$i"/commands ; then
 123             commdir="$i"/commands
 124             datadir="$i"
 125             break
 126         fi
 127     done
 128 fi
 129
 130 if test -z "${commdir}" ; then
 131     echo ERROR: could not find command directory.
 132     exit 2
 133 fi
 134
 135 if expr "$verbose" \> 0 > /dev/null ; then
 136     echo Looking for commands in "$commdir"
 137 fi
 138
 139 ## Get the name of the requested command.
 140
 141 # Are we just looking for version information?
 142 if $want_version ; then
 143     frame_version=`grep '^set frame_version' "${datadir}/runtest.exp" \
 144         | sed 's/^[^0-9]*//'`
 145     echo 'dejagnu auxiliary launcher (DejaGnu)' "$frame_version"
 146     exit 0
 147 fi
 148
 149 # Remove any leading autoconf platform prefix and the "dejagnu" prefix.
 150 # command=`basename "$0" | sed -e 's/^.*-\?dejagnu-\?//'`
 151
 152 # The above simple solution is not portable, so we use Awk and two steps:
 153 command=`echo "$0" | awk 'BEGIN { FS = "/" } { print $NF }'`
 154 # First, we use a simple Awk program to perform the role of basename.
 155 command=`echo "$command" | awk 'BEGIN { OFS = FS = "-" }
 156            { for (i = 1; i <= NF; i++) if ($i ~ /dejagnu/) break;
 157              i++; for (out = ""; i <= NF; i++) out = out OFS $i;
 158              print substr(out,2) }'`
 159 # Second, we split on "-" and search for a field matching /dejagnu/ to
 160 # identify the other prefixes, then skip that field and the second loop
 161 # collects any following fields.  The spurious leading "-" is then removed
 162 # using substr() and the result is returned to the shell.
 163
 164 # This roundabout approach maintains compatibility with Solaris 10, where
 165 # awk allows only limited manipulation of the record structure.
 166
 167 while expr $# \> 0 > /dev/null
 168 do
 169     if test -z "${command}" ; then
 170         case $1 in -*) break;; esac
 171         command="$1"
 172         shift
 173     fi
 174     if expr "$verbose" \> 2 > /dev/null ; then
 175         echo Looking for "${commdir}/${command}.*"
 176     fi
 177     for ext in ${Variants}
 178     do
 179         if test -f "${commdir}/${command}.$ext" ; then
 180             break 2
 181         fi
 182     done
 183     case $1 in -*) break;; esac
 184     if test -n "$1" ; then
 185         command="${command}-$1"
 186         shift
 187     else
 188         break
 189     fi
 190 done
 191
 192 commext=
 193 for ext in ${Variants}
 194 do
 195     if test -f "${commdir}/${command}.$ext" ; then
 196         commext="$commext $ext"
 197     fi
 198 done
 199
 200 if test -z "$commext" && test -n "$command" ; then
 201     echo ERROR: could not resolve command "$command"
 202     exit 2
 203 fi
 204
 205 if expr "$verbose" \> 0 > /dev/null ; then
 206     if test -n "$command"; then
 207         if expr "$verbose" \> 1 > /dev/null ; then
 208             echo Found subcommand "$command" with variants: "$commext"
 209         else
 210             echo Found subcommand "$command"
 211         fi
 212     else
 213         echo Running nothing.
 214     fi
 215 fi
 216
 217 ## Find interpreters.
 218
 219 # Awk and GNU awk
 220 if test -n "$AWK" ; then
 221     awkbin="$AWK"
 222 elif test -x "${bindir}/awk" ; then
 223     awkbin="${bindir}/awk"
 224 else
 225     # find what might be a usable awk
 226     # on Solaris 10, POSIX awk is in /usr/xpg4/bin
 227     for awktest in mawk /usr/xpg4/bin/awk nawk awk ; do
 228         if command -v "$awktest" > /dev/null 2>&1 ; then
 229             awkbin=$awktest
 230             break;
 231         fi
 232     done
 233 fi
 234 if test -n "$GAWK" ; then
 235     gawkbin="$GAWK"
 236 elif test -x "${bindir}/gawk" ; then
 237     gawkbin="${bindir}/gawk"
 238 else
 239     gawkbin=gawk
 240 fi
 241 # The non-POSIX awk in /usr/bin on Solaris 10 fails this test
 242 if echo | "$awkbin" '1 && 1 {exit 0}' > /dev/null 2>&1 ; then
 243     have_awk=true
 244 else
 245     have_awk=false
 246 fi
 247 if command -v "$gawkbin" > /dev/null 2>&1 ; then
 248     have_gawk=true
 249 else
 250     have_gawk=false
 251 fi
 252 # substitute GNU awk for awk if needed
 253 if $have_gawk ; then
 254     if $have_awk ; then : ; else
 255         have_awk=$have_gawk
 256         awkbin=$gawkbin
 257     fi
 258 fi
 259 # is "awk" actually GNU Awk?
 260 if $have_awk ; then
 261     case `"$awkbin" --version </dev/null 2>&1 | sed 1q` in
 262         *'GNU Awk'*)    have_gawk_as_awk=true   ;;
 263         *)              have_gawk_as_awk=false  ;;
 264     esac
 265 fi
 266 if expr "$verbose" \> 2 > /dev/null ; then
 267     if $have_awk ; then
 268         echo Awk interpreter is "$awkbin"
 269     else
 270         echo Awk interpreter was not found
 271     fi
 272     if $have_gawk ; then
 273         echo GNU Awk interpreter is "$gawkbin"
 274     else
 275         echo GNU Awk interpreter was not found
 276     fi
 277 fi
 278 # export chosen Awk and GNU Awk
 279 if $have_awk ; then
 280     AWK=$awkbin
 281     export AWK
 282 fi
 283 if $have_gawk ; then
 284     GAWK=$gawkbin
 285     export GAWK
 286 fi
 287
 288
 289 # Bash
 290 if test -n "$BASH" ; then
 291     bashbin="$BASH"
 292 elif test -x "${bindir}/bash" ; then
 293     bashbin="${bindir}/bash"
 294 elif test -x /bin/bash ; then
 295     bashbin=/bin/bash
 296 else
 297     bashbin=bash
 298 fi
 299 if command -v "$bashbin" > /dev/null 2>&1 ; then
 300     have_bash=true
 301 else
 302     have_bash=false
 303 fi
 304 if expr "$verbose" \> 2 > /dev/null ; then
 305     if $have_bash ; then
 306         echo Bash interpreter is "$bashbin"
 307     else
 308         echo Bash interpreter was not found
 309     fi
 310 fi
 311
 312 # Bourne shell
 313 #  This script is running, therefore we have a Bourne shell.
 314 have_sh=true
 315
 316 # Expect
 317 #  DejaGnu configure bails out if Expect is not available, but this script
 318 #  can be run from the source directory without first running configure.
 319 if test -n "$EXPECT" ; then
 320     expectbin="$EXPECT"
 321 elif test -x "${bindir}/expect" ; then
 322     expectbin="${bindir}/expect"
 323 else
 324     expectbin=expect
 325 fi
 326 if command -v "$expectbin" > /dev/null 2>&1 ; then
 327     have_expect=true
 328 else
 329     have_expect=false
 330 fi
 331 if expr "$verbose" \> 2 > /dev/null ; then
 332     if $have_expect ; then
 333         echo Expect interpreter is "$expectbin"
 334     else
 335         echo Expect interpreter was not found
 336     fi
 337 fi
 338
 339 # Tcl
 340 if test -n "$TCLSH" ; then
 341     tclbin="$TCLSH"
 342 elif test -x "${bindir}/tclsh" ; then
 343     tclbin="${bindir}/tclsh"
 344 else
 345     tclbin=tclsh
 346 fi
 347 # substitute expect if needed
 348 if command -v "$tclbin" > /dev/null 2>&1 ; then :
 349 elif command -v "$expectbin" > /dev/null 2>&1 ; then tclbin="$expectbin"
 350 fi
 351 if command -v "$tclbin" > /dev/null 2>&1 ; then
 352     have_tcl=true
 353 else
 354     have_tcl=false
 355 fi
 356 if expr "$verbose" \> 2 > /dev/null ; then
 357     if $have_tcl ; then
 358         echo Tcl interpreter is "$tclbin"
 359     else
 360         echo Tcl interpreter was not found
 361     fi
 362 fi
 363
 364 ## Select a variant.
 365
 366 if test -n "$override_ext" ; then
 367     selected_ext="$override_ext"
 368 else
 369     selected_ext=
 370     for v in $commext
 371     do
 372         case $v in
 373             awk)
 374                 if $have_awk ; then
 375                     selected_ext=awk
 376                     break
 377                 fi
 378                 ;;
 379             bash)
 380                 if $have_bash ; then
 381                     selected_ext=bash
 382                     break
 383                 fi
 384                 ;;
 385             exp)
 386                 if $have_expect ; then
 387                     selected_ext=exp
 388                     break
 389                 fi
 390                 ;;
 391             gawk)
 392                 if $have_gawk ; then
 393                     selected_ext=gawk
 394                     break
 395                 fi
 396                 ;;
 397             tcl)
 398                 if $have_tcl ; then
 399                     selected_ext=tcl
 400                     break
 401                 fi
 402                 ;;
 403             sh)
 404                 selected_ext=sh
 405                 break
 406                 ;;
 407             *)
 408                 echo ERROR: '(select-variant)' unrecognized variant "$v"
 409                 ;;
 410         esac
 411     done
 412     if test -z "$selected_ext" && test -n "$command" ; then
 413         echo ERROR: no variant of "$command" was selected
 414         exit 2
 415     fi
 416 fi
 417
 418 if test -n "$command" && expr "$verbose" \> 0 > /dev/null ; then
 419     if test -n "$override_ext" ; then
 420         echo Selected variant "$selected_ext" by override
 421     else
 422         echo Selected variant "$selected_ext"
 423     fi
 424 fi
 425
 426 ## Dispatch to the selected command.
 427
 428 # Are we just looking for a usage message?
 429 if $want_help ; then
 430     if $have_awk; then : ; else
 431         echo ERROR: extracting help message requires POSIX Awk
 432         exit 2
 433     fi
 434     if test -z "$command" ; then
 435         # want help on the launcher itself
 436         help_file=$0
 437     else
 438         help_file="${commdir}/${command}.${selected_ext}"
 439     fi
 440     if test ! -r "$help_file" ; then
 441         echo ERROR: file "'$help_file'" is not readable
 442         exit 2
 443     fi
 444     if "$AWK" '/#help$/ { pfxlen = length($0) - 4 }
 445             pfxlen && substr($0, pfxlen) == "#end" { exit 1 }
 446            ' "$help_file" ; then
 447         echo ERROR: file "'$help_file'" does not contain a help message
 448         exit 2
 449     fi
 450     exec "$AWK" '/#help$/ { pfxlen = length($0) - 4 }
 451               pfxlen && substr($0, pfxlen) == "#end" { exit 0 }
 452               pfxlen { print substr($0, pfxlen) }' "$help_file"
 453 fi
 454
 455 if test -z "$command" ; then
 456     if test -n "$override_ext" ; then
 457         case $selected_ext in
 458             awk)    if $have_awk;       then exit 0; else exit 1; fi ;;
 459             bash)   if $have_bash;      then exit 0; else exit 1; fi ;;
 460             exp)    if $have_expect;    then exit 0; else exit 1; fi ;;
 461             gawk)   if $have_gawk;      then exit 0; else exit 1; fi ;;
 462             tcl)    if $have_tcl;       then exit 0; else exit 1; fi ;;
 463             sh)     if $have_sh;        then exit 0; else exit 1; fi ;;
 464             *)      exit 2 ;;
 465         esac
 466     else
 467         echo ERROR: no command given
 468         exit 2
 469     fi
 470 fi
 471
 472 case $selected_ext in
 473     awk)
 474         if $have_gawk_as_awk ; then
 475             exec "$awkbin" --posix -f "${commdir}/${command}.awk" -- ${1+"$@"}
 476         else
 477             exec "$awkbin" -f "${commdir}/${command}.awk" -- ${1+"$@"}
 478         fi
 479         ;;
 480     bash)   exec "$bashbin" -- "${commdir}/${command}.bash" ${1+"$@"} ;;
 481     exp)    exec "$expectbin" -- "${commdir}/${command}.exp" ${1+"$@"} ;;
 482     gawk)   exec "$gawkbin" -f "${commdir}/${command}.gawk" -- ${1+"$@"} ;;
 483     tcl)    exec "$tclbin" "${commdir}/${command}.tcl" ${1+"$@"} ;;
 484     sh)     exec /bin/sh "${commdir}/${command}.sh" ${1+"$@"} ;;
 485     echo)
 486         echo command: "${command}"
 487         echo args: ${1+"$@"}
 488         exit 0
 489         ;;
 490     *)
 491         echo ERROR: '(run-variant)' unrecognized variant "$selected_ext"
 492         exit 2
 493         ;;
 494 esac
 495
 496 #EOF