Mercurial > octave-antonio
view scripts/miscellaneous/dir.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2004-2015 John W. Eaton ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} dir ## @deftypefnx {Function File} {} dir (@var{directory}) ## @deftypefnx {Function File} {[@var{list}] =} dir (@var{directory}) ## Display file listing for directory @var{directory}. ## ## If @var{directory} is not specified then list the present working directory. ## ## If a return value is requested, return a structure array with the fields ## ## @table @asis ## @item name ## File or directory name. ## ## @item date ## Timestamp of file modification (string value). ## ## @item bytes ## File size in bytes. ## ## @item isdir ## True if name is a directory. ## ## @item datenum ## Timestamp of file modification as serial date number (double). ## ## @item statinfo ## Information structure returned from @code{stat}. ## @end table ## ## If @var{directory} is a filename, rather than a directory, then return ## information about the named file. @var{directory} may also be a list rather ## than a single directory or file. ## ## @var{directory} is subject to shell expansion if it contains any wildcard ## characters @samp{*}, @samp{?}, @samp{[]}. To find a literal example of a ## wildcard character the wildcard must be escaped using the backslash operator ## @samp{\}. ## ## Note that for symbolic links, @code{dir} returns information about the ## file that the symbolic link points to rather than the link itself. ## However, if the link points to a nonexistent file, @code{dir} returns ## information about the link. ## @seealso{ls, readdir, glob, what, stat, lstat} ## @end deftypefn ## Author: jwe ## FIXME: This is quite slow for large directories. ## Perhaps it should be converted to C++? function retval = dir (directory) if (nargin == 0) directory = "."; elseif (nargin > 1) print_usage (); endif if (! ischar (directory)) error ("dir: DIRECTORY argument must be a string"); endif ## Prep the retval. info = struct (zeros (0, 1), {"name", "date", "bytes", "isdir", "datenum", "statinfo"}); if (strcmp (directory, "*")) directory = "."; endif if (strcmp (directory, ".")) flst = {"."}; nf = 1; else flst = glob (directory); nf = numel (flst); endif ## Determine the file list for the case where a single directory is specified. if (nf == 1) fn = flst{1}; [st, err, msg] = stat (fn); if (err < 0) warning ("dir: 'stat (%s)' failed: %s", fn, msg); nf = 0; elseif (S_ISDIR (st.mode)) flst = readdir (flst{1}); nf = numel (flst); for i = 1:nf flst{i} = fullfile (fn, flst{i}); endfor endif endif if (numel (flst) > 0) ## Collect results. for i = nf:-1:1 fn = flst{i}; [st, err, msg] = lstat (fn); if (err < 0) warning ("dir: 'lstat (%s)' failed: %s", fn, msg); else ## If we are looking at a link that points to something, ## return info about the target of the link, otherwise, return ## info about the link itself. if (S_ISLNK (st.mode)) [xst, err, msg] = stat (fn); if (! err) st = xst; endif endif [dummy, fn, ext] = fileparts (fn); fn = [fn ext]; info(i,1).name = fn; lt = localtime (st.mtime); info(i,1).date = strftime ("%d-%b-%Y %T", lt); info(i,1).bytes = st.size; info(i,1).isdir = S_ISDIR (st.mode); info(i,1).datenum = datenum (lt.year + 1900, lt.mon + 1, lt.mday, lt.hour, lt.min, lt.sec); info(i,1).statinfo = st; endif endfor endif ## Return the output arguments. if (nargout > 0) ## Return the requested structure. retval = info; elseif (numel (info) > 0) ## Print the structure to the screen. printf ("%s", list_in_columns ({info.name})); else warning ("dir: nonexistent directory '%s'", directory); endif endfunction %!test %! list = dir (); %! assert (isstruct (list) && ! isempty (list)); %! assert (fieldnames (list), %! {"name"; "date"; "bytes"; "isdir"; "datenum"; "statinfo"}); %! %! if (isunix ()) %! assert ({list(1:2).name}, {".", ".."}); %! assert ([list(1:2).isdir], [true true]); %! endif %! %! ## test that specifying a filename works the same as using a directory. %! found = find (! [list.isdir], 1); %! if (! isempty (found)) %! list2 = dir (list(found).name); %! assert (list(found), list2); %! endif ## Test input validation %!error <DIRECTORY argument must be a string> dir (1) %!warning <nonexistent directory> dir ("_%UNLIKELY_DIR_NAME%_");