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
|
########################################################################
##
## Copyright (C) 2000-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 {} {@var{str} =} strjust (@var{s})
## @deftypefnx {} {@var{str} =} strjust (@var{s}, @var{pos})
## Return the text, @var{s}, justified according to @var{pos}, which may
## be @qcode{"left"}, @qcode{"center"}, or @qcode{"right"}.
##
## If @var{pos} is omitted it defaults to @qcode{"right"}.
##
## Null characters are replaced by spaces. All other character data are
## treated as non-white space.
##
## Example:
##
## @example
## @group
## strjust (["a"; "ab"; "abc"; "abcd"])
## @result{}
## " a"
## " ab"
## " abc"
## "abcd"
## @end group
## @end example
## @seealso{deblank, strrep, strtrim, untabify}
## @end deftypefn
function str = strjust (s, pos = "right")
if (nargin < 1)
print_usage ();
elseif (! ischar (s) || ndims (s) > 2)
error ("strjust: S must be a string or 2-D character matrix");
endif
if (isempty (s))
str = s;
return;
endif
## Apparently, Matlab considers nulls to be blanks as well; however, does
## not preserve the nulls, but rather converts them to blanks. That's a
## bit unexpected, but it allows simpler processing, because we can move
## just the nonblank characters. So we'll do the same here.
[nr, nc] = size (s);
## Find the indices of all nonblanks.
nonbl = s != " " & s != "\0";
[idx, jdx] = find (nonbl);
if (strcmpi (pos, "right"))
## We wish to find the maximum column index for each row. Because jdx is
## sorted, we can take advantage of the fact that assignment is processed
## sequentially and for duplicate indices the last value will remain.
maxs = repmat (nc, [nr, 1]);
maxs(idx) = jdx;
shift = nc - maxs;
elseif (strcmpi (pos, "left"))
## See above for explanation.
mins = ones (nr, 1);
mins(flipud (idx(:))) = flipud (jdx(:));
shift = 1 - mins;
else
## Use both of the above to achieve centering.
mins = ones (nr, 1);
mins(flipud (idx(:))) = flipud (jdx(:));
maxs = repmat (nc, [nr, 1]);
maxs(idx) = jdx;
shift = floor ((nc + 1 - maxs - mins) / 2);
endif
## Adjust the column indices.
jdx += shift(idx);
## Create a blank matrix and position the nonblank characters.
str = repmat (" ", nr, nc);
str(sub2ind ([nr, nc], idx, jdx)) = s(nonbl);
endfunction
%!assert (strjust (char ("a", "ab", "abc", "abcd")),
%! [" a";" ab"; " abc"; "abcd"])
%!assert (strjust (char (" a", " ab", "abc", "abcd"), "left"),
%! ["a "; "ab "; "abc "; "abcd"])
%!assert (strjust (char ("a", "ab", "abc", "abcd"), "CENTER"),
%! [" a "; " ab "; "abc "; "abcd"])
%!assert (strjust (["";""]), "")
## Test input validation
%!error <Invalid call to strjust> strjust ()
%!error <called with too many inputs> strjust (["a";"ab"], "center", 1)
%!error <S must be a string> strjust (ones (3,3))
%!error <S must be a string> strjust (char (ones (3,3,3)))
|