rom/dos/execute.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Execute a CLI command
   6     Lang: English
   7 */
   8
   9 #include <aros/debug.h>
  10 #include <dos/dosextens.h>
  11 #include <utility/tagitem.h>
  12
  13 #include "dos_intern.h"
  14
  15 /*****************************************************************************
  16
  17     NAME */
  18 #include <proto/dos.h>
  19
  20         AROS_LH3(BOOL, Execute,
  21
  22 /*  SYNOPSIS */
  23         AROS_LHA(CONST_STRPTR, string, D1),
  24         AROS_LHA(BPTR  , input , D2),
  25         AROS_LHA(BPTR  , output, D3),
  26
  27 /*  LOCATION */
  28         struct DosLibrary *, DOSBase, 37, Dos)
  29
  30 /*  FUNCTION
  31         Execute a CLI command specified in 'string'. This string may contain
  32         features you may use on the shell commandline like redirection using >,
  33         < or >>. Execute() doesn't return until the command(s) that should be
  34         executed are finished.
  35
  36         If 'input' is not NULL, more commands will be read from this stream
  37         until end of file is reached. 'output' will be used as the output stream
  38         of the commands (if output is not redirected). If 'output' is NULL the
  39         current window is used for output -- note that programs run from the
  40         Workbench doesn't normally have a current window.
  41
  42     INPUTS
  43         string - pointer to a NULL-terminated string with commands
  44                  (may be NULL)
  45         input  - stream to use as input (may be NULL)
  46         output - stream to use as output (may be NULL)
  47
  48     RESULT
  49         Boolean telling whether Execute() could find and start the specified
  50         command(s). (This is NOT the return code of the command(s).)
  51
  52     NOTES
  53
  54     EXAMPLE
  55
  56     BUGS
  57
  58     SEE ALSO
  59
  60     SystemTagList()
  61
  62     INTERNALS
  63         To get the right result, the function ExecCommand() (used by both
  64         Execute() and SystemTagList()) uses NP_Synchronous to wait for the
  65         commands to finish. This is not the way AmigaOS does it as
  66         NP_Synchronous is not implemented (but defined).
  67
  68 *****************************************************************************/
  69 {
  70     AROS_LIBFUNC_INIT
  71
  72     LONG           result;
  73     struct TagItem tags[] =
  74     {
  75         { SYS_Background, TRUE         },
  76         { SYS_Asynch,     FALSE        },
  77         { SYS_Input,      (IPTR)input  },
  78         { SYS_Output,     (IPTR)output },
  79         { SYS_Error,      (IPTR)NULL   },
  80         { TAG_DONE,       0            }
  81     };
  82
  83     D(bug("[Execute] input = %p, output = %p, cmd = \"%s\"\n", input, output, string));
  84
  85     /* Check for the special cases where we want a new
  86      * interactive shell.
  87      */
  88     if ((!string || string[0] == 0) && IsInteractive(input) && output == BNULL)
  89         tags[0].ti_Data = FALSE;
  90
  91     if ((!string || string[0] == 0) && input == BNULL && output == BNULL)
  92         string = "Run NewShell";
  93
  94     result = SystemTagList(string, tags);
  95
  96     if(result == 0)
  97         return DOSTRUE;
  98     else
  99         return DOSFALSE;
 100
 101     AROS_LIBFUNC_EXIT
 102 } /* Execute */
 103