builtins/test.def

   1 This file is test.def, from which is created test.c.
   2 It implements the builtin "test" in Bash.
   3
   4 Copyright (C) 1987, 1989, 1991 Free Software Foundation, Inc.
   5
   6 This file is part of GNU Bash, the Bourne Again SHell.
   7
   8 Bash is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 1, or (at your option) any later
  11 version.
  12
  13 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License along
  19 with Bash; see the file COPYING.  If not, write to the Free Software
  20 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22 $PRODUCES test.c
  23
  24 $BUILTIN test
  25 $FUNCTION test_builtin
  26 $SHORT_DOC test [expr]
  27 Exits with a status of 0 (trueness) or 1 (falseness) depending on
  28 the evaluation of EXPR.  Expressions may be unary or binary.  Unary
  29 expressions are often used to examine the status of a file.  There
  30 are string operators as well, and numeric comparison operators.
  31
  32 File operators:
  33
  34     -b FILE        True if file is block special.
  35     -c FILE        True if file is character special.
  36     -d FILE        True if file is a directory.
  37     -e FILE        True if file exists.
  38     -f FILE        True if file exists and is a regular file.
  39     -g FILE        True if file is set-group-id.
  40     -h FILE        True if file is a symbolic link.
  41     -L FILE        True if file is a symbolic link.
  42     -k FILE        True if file has its `sticky' bit set.
  43     -p FILE        True if file is a named pipe.
  44     -r FILE        True if file is readable by you.
  45     -s FILE        True if file exists and is not empty.
  46     -S FILE        True if file is a socket.
  47     -t FD          True if FD is opened on a terminal.
  48     -u FILE        True if the file is set-user-id.
  49     -w FILE        True if the file is writable by you.
  50     -x FILE        True if the file is executable by you.
  51     -O FILE        True if the file is effectively owned by you.
  52     -G FILE        True if the file is effectively owned by your group.
  53     -N FILE        True if the file has been modified since it was last read.
  54
  55   FILE1 -nt FILE2  True if file1 is newer than file2 (according to
  56                    modification date).
  57
  58   FILE1 -ot FILE2  True if file1 is older than file2.
  59
  60   FILE1 -ef FILE2  True if file1 is a hard link to file2.
  61
  62 String operators:
  63
  64     -z STRING      True if string is empty.
  65
  66     -n STRING
  67     STRING         True if string is not empty.
  68
  69     STRING1 = STRING2
  70                    True if the strings are equal.
  71     STRING1 != STRING2
  72                    True if the strings are not equal.
  73     STRING1 < STRING2
  74                    True if STRING1 sorts before STRING2 lexicographically.
  75     STRING1 > STRING2
  76                    True if STRING1 sorts after STRING2 lexicographically.
  77
  78 Other operators:
  79
  80     -o OPTION      True if the shell option OPTION is enabled.
  81     ! EXPR         True if expr is false.
  82     EXPR1 -a EXPR2 True if both expr1 AND expr2 are true.
  83     EXPR1 -o EXPR2 True if either expr1 OR expr2 is true.
  84
  85     arg1 OP arg2   Arithmetic tests.  OP is one of -eq, -ne,
  86                    -lt, -le, -gt, or -ge.
  87
  88 Arithmetic binary operators return true if ARG1 is equal, not-equal,
  89 less-than, less-than-or-equal, greater-than, or greater-than-or-equal
  90 than ARG2.
  91 $END
  92
  93 $BUILTIN [
  94 $DOCNAME test_bracket
  95 $FUNCTION test_builtin
  96 $SHORT_DOC [ arg... ]
  97 This is a synonym for the "test" builtin, but the last
  98 argument must be a literal `]', to match the opening `['.
  99 $END
 100
 101 #include <config.h>
 102
 103 #if defined (HAVE_UNISTD_H)
 104 #  ifdef _MINIX
 105 #    include <sys/types.h>
 106 #  endif
 107 #  include <unistd.h>
 108 #endif
 109
 110 #include "../bashansi.h"
 111
 112 #include "../shell.h"
 113 #include "../test.h"
 114 #include "common.h"
 115
 116 extern char *this_command_name;
 117
 118 /* TEST/[ builtin. */
 119 int
 120 test_builtin (list)
 121      WORD_LIST *list;
 122 {
 123   char **argv;
 124   int argc, result;
 125
 126   /* We let Matthew Bradburn and Kevin Braunsdorf's code do the
 127      actual test command.  So turn the list of args into an array
 128      of strings, since that is what their code wants. */
 129   if (list == 0)
 130     {
 131       if (this_command_name[0] == '[' && !this_command_name[1])
 132         builtin_error ("missing `]'");
 133
 134       return (EXECUTION_FAILURE);
 135     }
 136
 137   argv = make_builtin_argv  (list, &argc);
 138   result = test_command (argc, argv);
 139   free ((char *)argv);
 140
 141   return (result);
 142 }