Mercurial > octave-antonio
view scripts/miscellaneous/what.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) 2007-2015 David Bateman ## ## 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 {Command} {} what ## @deftypefnx {Command} {} what @var{dir} ## @deftypefnx {Function File} {w =} what (@var{dir}) ## List the Octave specific files in directory @var{dir}. ## ## If @var{dir} is not specified then the current directory is used. ## ## If a return argument is requested, the files found are returned in the ## structure @var{w}. The structure contains the following fields: ## ## @table @asis ## @item path ## Full path to directory @var{dir} ## ## @item m ## Cell array of m-files ## ## @item mat ## Cell array of mat files ## ## @item mex ## Cell array of mex files ## ## @item oct ## Cell array of oct files ## ## @item mdl ## Cell array of mdl files ## ## @item slx ## Cell array of slx files ## ## @item p ## Cell array of p-files ## ## @item classes ## Cell array of class directories (@file{@@@var{classname}/}) ## ## @item packages ## Cell array of package directories (@file{+@var{pkgname}/}) ## @end table ## ## Compatibility Note: Octave does not support mdl, slx, and p files; nor does ## it support package directories. @code{what} will always return an empty ## list for these categories. ## @seealso{which, ls, exist} ## @end deftypefn function retval = what (dir) if (nargin > 1) print_usage (); endif if (nargin == 0) dir = pwd (); else dtmp = canonicalize_file_name (dir); if (isempty (dtmp)) ## Search for directory name in path if (dir(end) == '/' || dir(end) == '\') dir(end) = []; endif dtmp = dir_in_loadpath (dir); if (isempty (dtmp)) error ("what: could not find the directory %s", dir); endif endif dir = dtmp; endif files = readdir (dir); w.path = dir; w.m = cell (0, 1); w.mat = cell (0, 1); w.mex = cell (0, 1); w.oct = cell (0, 1); w.mdl = cell (0, 1); w.slx = cell (0, 1); w.p = cell (0, 1); w.classes = cell (0, 1); w.packages = cell (0, 1); for i = 1 : length (files) n = files{i}; ## Ignore . and .. if (strcmp (n, ".") || strcmp (n, "..")) continue; else ## Ignore mdl, slx, p, and packages since they are not [~, f, e] = fileparts (n); if (strcmp (e, ".m")) w.m{end+1} = n; elseif (strcmp (e, ".mat")) w.mat{end+1} = n; elseif (strcmp (e, ".oct")) w.oct{end+1} = n; elseif (strcmp (e, mexext ())) w.mex{end+1} = n; elseif (n(1) == "@" && isdir (n)) w.classes{end+1} = n; endif endif endfor if (nargout == 0) __display_filenames__ ("M-files in directory", w.path, w.m); __display_filenames__ ("\nMAT-files in directory", w.path, w.mat); __display_filenames__ ("\nMEX-files in directory", w.path, w.mex); __display_filenames__ ("\nOCT-files in directory", w.path, w.oct); __display_filenames__ ("\nClasses in directory", w.path, w.classes); else retval = w; endif endfunction function __display_filenames__ (msg, p, f) if (length (f) > 0) printf ("%s %s:\n\n", msg, p); maxlen = max (cellfun ("length", f)); ncols = max (1, floor (terminal_size ()(2) / (maxlen + 3))); fmt = sprintf (" %%-%ds", maxlen); fmt = repmat (fmt, [1, ncols]); fmt = [fmt "\n"]; nrows = ceil (length (f) / ncols); for i = 1 : nrows args = f(i:nrows:end); if (length (args) < ncols) args(end+1 : ncols) = {""}; endif printf (fmt, args{:}); endfor endif endfunction %!test %! w = what (); %! assert (w.path, pwd); %! assert (fieldnames (w), {"path"; "m"; "mat"; "mex"; "oct"; "mdl"; "slx"; %! "p"; "classes"; "packages"}); %!error what (1, 2)