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
|
########################################################################
##
## Copyright (C) 1996-2026 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 {} {@var{s} =} deblank (@var{s})
## Remove trailing whitespace and nulls from @var{s}.
##
## If @var{s} is a matrix, @var{deblank} trims each row to the length of
## the longest string. If @var{s} is a cell array of strings, operate
## recursively on each string element.
##
## Examples:
##
## @example
## @group
## deblank (" abc ")
## @xresult{} " abc"
##
## deblank ([" abc "; " def "])
## @xresult{} [" abc " ; " def"]
## @end group
## @end example
## @seealso{strtrim}
## @end deftypefn
function s = deblank (s)
if (nargin != 1)
print_usage ();
endif
if (isempty (s))
## Return empty objects unchanged (Matlab compatibility)
elseif (ischar (s))
## Find indices of non-whitespace characters. If s is a
## char matrix, the indices are in column major order.
k = find (! isspace (s) & s != "\0");
if (isempty (k))
## Even if s was a char matrix! (Matlab compatibility)
s = "";
else
s = s(:,1:ceil (max (k) / rows (s)));
endif
elseif (iscell (s))
char_idx = cellfun ("isclass", s, "char");
cell_idx = cellfun ("isclass", s, "cell");
empty_idx = cellfun ("isempty", s);
if (! all (char_idx | cell_idx | empty_idx))
error ("deblank: S argument must be a string or cellstring");
endif
## Divide work load. Recursive cellfun deblank call is slow
## and avoided where possible.
s(char_idx) = regexprep (s(char_idx), "[\\s\v\\0]+$", '');
s(cell_idx) = cellfun ("deblank", s(cell_idx), "UniformOutput", false);
else
error ("deblank: S argument must be a string or cellstring");
endif
endfunction
%!assert (deblank (" f o o \0"), " f o o")
%!assert (deblank (" \t f o o \t \0"), " \t f o o")
%!assert (deblank (char (" abc ", " def ")), [" abc " ; " def"])
%!assert (deblank ([" "; " "]), "")
%!assert (deblank (' '), '')
%!assert (deblank (" "), "")
%!assert (deblank (""), "")
%!assert (deblank ([]), [])
%!assert (deblank ({}), {})
%!assert (deblank ({[]}), {[]})
%!assert (deblank ({[], []}), {[], []})
%!assert (deblank ({" abc ", {" def "}}), {" abc", {" def"}})
%!error <Invalid call to deblank> deblank ()
%!error <called with too many inputs> deblank ("foo", "bar")
%!error <argument must be a string> deblank (1)
|