Mercurial > octave-antonio
view scripts/miscellaneous/fullfile.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 | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2014-2015 Carnë Draug ## ## 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} {@var{filename} =} fullfile (@var{dir1}, @var{dir2}, @dots{}, @var{file}) ## @deftypefnx {Function File} {@var{filenames} =} fullfile (@dots{}, @var{files}) ## Build complete filename from separate parts. ## ## Joins any number of path components intelligently. The return value is ## the concatenation of each component with exactly one file separator ## between each non empty part and at most one leading and/or trailing file ## separator. ## ## If the last component part is a cell array, returns a cell array of ## filepaths, one for each element in the last component, e.g.: ## ## @example ## @group ## fullfile ("/home/username", "data", @{"f1.csv", "f2.csv", "f3.csv"@}) ## @result{} /home/username/data/f1.csv ## /home/username/data/f2.csv ## /home/username/data/f3.csv ## @end group ## @end example ## ## On Windows systems, while forward slash file separators do work, they are ## replaced by backslashes; in addition drive letters are stripped of leading ## file separators to obtain a valid file path. ## ## @seealso{fileparts, filesep} ## @end deftypefn ## Author: Carnë Draug <carandraug@octave.org> function filename = fullfile (varargin) if (nargin && iscell (varargin{end})) filename = cellfun (@(x) fullfile (varargin{1:end-1}, x), varargin{end}, "UniformOutput", false); else non_empty = cellfun ("isempty", varargin); if (ispc && ! isempty (varargin)) varargin = strrep (varargin, "/", filesep); varargin(1) = regexprep (varargin{1}, '[\\/]*([a-zA-Z]:[\\/]*)', "$1"); endif filename = strjoin (varargin(! non_empty), filesep); filename(strfind (filename, [filesep filesep])) = ""; endif endfunction %!shared fs, fsx, xfs, fsxfs, xfsy, xfsyfs %! fs = filesep (); %! fsx = [fs "x"]; %! xfs = ["x" fs]; %! fsxfs = [fs "x" fs]; %! xfsy = ["x" fs "y"]; %! xfsyfs = ["x" fs "y" fs]; %!assert (fullfile (""), "") %!assert (fullfile (fs), fs) %!assert (fullfile ("", fs), fs) %!assert (fullfile (fs, ""), fs) %!assert (fullfile ("", fs), fs) %!assert (fullfile ("x"), "x") %!assert (fullfile ("", "x"), "x") %!assert (fullfile ("x", ""), "x") %!assert (fullfile ("", "x", ""), "x") %!assert (fullfile ("x", "y"), xfsy) %!assert (fullfile ("x", "", "y"), xfsy) %!assert (fullfile ("x", "", "y", ""), xfsy) %!assert (fullfile ("", "x", "", "y", ""), xfsy) %!assert (fullfile (fs), fs) %!assert (fullfile (fs, fs), fs) %!assert (fullfile (fs, "x"), fsx) %!assert (fullfile (fs, xfs), fsxfs) %!assert (fullfile (fsx, fs), fsxfs) %!assert (fullfile (fs, "x", fs), fsxfs) %!assert (fullfile ("x/", "/", "/", "y", "/", "/"), xfsyfs) %!assert (fullfile ("/", "x/", "/", "/", "y", "/", "/"), [fs xfsyfs]) %!assert (fullfile ("/x/", "/", "/", "y", "/", "/"), [fs xfsyfs]) ## different on purpose so that "fullfile (c{:})" works for empty c %!assert (fullfile (), "") %!assert (fullfile ("x", "y", {"c", "d"}), {[xfsyfs "c"], [xfsyfs "d"]}) ## Windows specific - drive letters and file sep type %!test %! if (ispc) %! assert (fullfile ('\/\/\//A:/\/\', "x/", "/", "/", "y", "/", "/"), ... %! ['A:\' xfsyfs]); %! endif ## Windows specific - drive letters and file sep type, cell array %!test %! if (ispc) %! tmp = fullfile ({"\\\/B:\//", "A://c", "\\\C:/g/h/i/j\/"}); %! assert (tmp{1}, 'B:\'); %! assert (tmp{2}, 'A:\c'); %! assert (tmp{3}, 'C:\g\h\i\j\'); %! endif