1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
########################################################################
##
## Copyright (C) 2006-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} ls
## @deftypefnx {} {} ls @var{filenames}
## @deftypefnx {} {} ls @var{options}
## @deftypefnx {} {} ls @var{options} @var{filenames}
## @deftypefnx {} {@var{list} =} ls (@dots{})
##
## List directory contents.
##
## The @code{ls} function forwards to the @code{ls} command if it is available.
## It falls back to calling the native operating system's directory listing
## command. Available @var{options} may vary from system to system.
##
## Filenames are subject to shell expansion if they contain any wildcard
## characters @samp{*}, @samp{?}, @samp{[]}. If these wildcard characters are
## escaped with a backslash @samp{\} (e.g., @samp{\*}) then they are not
## treated as wildcards, but instead as the corresponding literal character.
##
## If the optional output @var{list} is requested then @code{ls} returns a
## character array with one row for each file/directory name.
##
## Example usage on a UNIX-like system:
##
## @example
## @group
## ls -l
## @print{} total 12
## @print{} -rw-r--r-- 1 jwe users 4488 Aug 19 04:02 foo.m
## @print{} -rw-r--r-- 1 jwe users 1315 Aug 17 23:14 bar.m
## @end group
## @end example
##
## @seealso{dir, readdir, glob, what, stat, filesep, ls_command}
## @end deftypefn
function list = ls (varargin)
if (! iscellstr (varargin))
error ("ls: all arguments must be character strings");
endif
ls_cmd = ls_command ();
if (nargin > 0)
args = tilde_expand (varargin);
if (ispc () && ! isunix ())
if (strncmp (ls_cmd, "ls", 2))
## Replace backslashes with forward slashes (unless they escape a
## wildcard character)
args = regexprep (args, '\\(?![*?\[\]])', '/');
## Enclose paths, potentially having spaces, in double quotes:
args = strcat ('"', args, '"');
## Exclude glob patterns and escaped characters from quoted part of
## FILENAMES string
args = regexprep (args, '(?<!\\)([*?])', '"$1"');
args = regexprep (args, '(?<!\\)\[', '"[');
args = regexprep (args, '(?<!\\)\]', ']"');
args = regexprep (args, '(\\.)', '"$1"');
else
idx = ! strncmp (args, '/', 1);
## Enclose paths, potentially having spaces, in double quotes:
args(idx) = strcat ('"', args(idx), '"');
## shell (cmd.exe) on MinGW uses '^' as escape character
args = regexprep (args, '([^\w.*?])', '^$1');
endif
else
## Escape any special characters in filename
args = regexprep (args, '(?<!\\)([^][\w.*?-\\])', '\\$1');
## Undo escaped spaces following command args
## Only used for command form where single str contains many args.
## Example: list = ls ("-l /usr/bin")
args = regexprep (args, '(-\w+)(?:\\ )+', '$1 ');
endif
args = sprintf ("%s ", args{:});
else
args = "";
endif
if (nargout > 0 && strncmp (ls_cmd, "ls", 2))
args = ["-1 ", args];
endif
cmd = [ls_cmd, " ", args];
if (page_screen_output () || nargout > 0)
[status, output] = system (cmd);
if (status != 0)
error ("ls: command exited abnormally with status %d\n", status);
elseif (nargout == 0)
puts (output);
else
list = strvcat (regexp (output, "[\r\n]+", "split"){:});
endif
else
## Just let the output flow if the pager is off. That way the
## output from things like "ls -R /" will show up immediately and
## we won't have to buffer all the output.
system (cmd);
endif
endfunction
%!test
%! list = ls ();
%! assert (ischar (list));
%! assert (! isempty (list));
%!test
%! if (isunix ())
%! list = ls ("/");
%! list = (list')(:)'; # transform to a single row vector
%! assert (! isempty (strfind (list, "sbin")));
%! list2 = ls ("-l /");
%! list2 = (list2')(:)'; # transform to a single row vector
%! assert (! isempty (strfind (list2, "sbin")));
%! assert (rows (list) == rows (list2));
%! endif
%!error <all arguments must be character strings> ls (1)
## Test below is valid, but produces confusing output on screen
%!#error <command exited abnormally> ls ("-!")
|
