octave_packages/m/miscellaneous/unix.m

   1 ## Copyright (C) 2004-2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} unix ("@var{command}")
  21 ## @deftypefnx {Function File} {@var{status} =} unix ("@var{command}")
  22 ## @deftypefnx {Function File} {[@var{status}, @var{text}] =} unix ("@var{command}")
  23 ## @deftypefnx {Function File} {[@dots{}] =} unix ("@var{command}", "-echo")
  24 ## Execute a system command if running under a Unix-like operating
  25 ## system, otherwise do nothing.  Return the exit status of the program
  26 ## in @var{status} and any output from the command in @var{text}.
  27 ## When called with no output argument, or the "-echo" argument is
  28 ## given, then @var{text} is also sent to standard output.
  29 ## @seealso{dos, system, isunix, ispc}
  30 ## @end deftypefn
  31
  32 ## Author: octave-forge ???
  33 ## Adapted by: jwe
  34
  35 function [status, text] = unix (command, echo_arg)
  36
  37   if (nargin < 1 || nargin > 2)
  38     print_usage ();
  39   elseif (isunix ())
  40     [status, text] = system (command);
  41     if (nargin > 1 || nargout == 0)
  42       printf ("%s\n", text);
  43     endif
  44   endif
  45
  46 endfunction
  47
  48
  49 %!test
  50 %! cmd = ls_command ();
  51 %! old_wstate = warning ("query");
  52 %! warning ("off", "Octave:undefined-return-values");
  53 %! unwind_protect
  54 %!   [status, output] = unix (cmd);
  55 %! unwind_protect_cleanup
  56 %!   warning (old_wstate);
  57 %! end_unwind_protect
  58 %!
  59 %! if (isunix ())
  60 %!   assert (status, 0);
  61 %!   assert (ischar (output));
  62 %!   assert (! isempty (output));
  63 %! else
  64 %!   assert (status, []);
  65 %!   assert (output, []);
  66 %! endif
  67
  68 %!error unix ()
  69 %!error unix (1, 2, 3)
  70