Mercurial > octave-nkf
diff scripts/deprecated/strmatch.m @ 19094:edf5d63c82e1
Deprecate strmatch function.
* scripts/deprecated/strmatch.m: Moved from scripts/strings. Add
deprecation warning to code and to docstring.
* strings.txi: Remove from manual
* scripts/deprecated/module.mk: Add to build system in deprecated directory.
* scripts/strings/module.mk: Remove from build system in strings directory.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 29 Aug 2014 20:41:58 -0700 |
parents | scripts/strings/strmatch.m@d63878346099 |
children | ebd27d8c63fd |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scripts/deprecated/strmatch.m Fri Aug 29 20:41:58 2014 -0700 @@ -0,0 +1,130 @@ +## Copyright (C) 2000-2013 Paul Kienzle +## Copyright (C) 2003 Alois Schloegl +## Copyright (C) 2010 VZLU Prague +## +## 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} {} strmatch (@var{s}, @var{A}) +## @deftypefnx {Function File} {} strmatch (@var{s}, @var{A}, "exact") +## +## @code{strmatch} is deprecated and will be removed in Octave version 4.6. +## Use @code{strncmp} (normal case), or @code{strcmp} (@qcode{"exact"} case), +## or @code{regexp} in all new code. +## +## Return indices of entries of @var{A} which begin with the string @var{s}. +## The second argument @var{A} must be a string, character matrix, or a cell +## array of strings. If the third argument @qcode{"exact"} is not given, then +## @var{s} only needs to match @var{A} up to the length of @var{s}. +## Trailing spaces and nulls in @var{s} and @var{A} are ignored when matching. +## +## For example: +## +## @example +## @group +## strmatch ("apple", "apple juice") +## @result{} 1 +## +## strmatch ("apple", ["apple "; "apple juice"; "an apple"]) +## @result{} [1; 2] +## +## strmatch ("apple", ["apple "; "apple juice"; "an apple"], "exact") +## @result{} [1] +## @end group +## @end example +## +## @seealso{strfind, findstr, strcmp, strncmp, strcmpi, strncmpi, find} +## @end deftypefn + +## Author: Paul Kienzle, Alois Schloegl +## Adapted-by: jwe + +## Deprecated in version 4.2 + +function idx = strmatch (s, A, exact) + + persistent warned = false; + if (! warned) + warned = true; + warning ("Octave:deprecated-function", + "strmatch is obsolete and will be removed from a future version of Octave, please use strncmp, strcmp, or regexp instead"); + endif + + if (nargin < 2 || nargin > 3) + print_usage (); + endif + + if (! ischar (s) || (! isempty (s) && ! isvector (s))) + error ("strmatch: S must be a string"); + elseif (! (ischar (A) || iscellstr (A))) + error ("strmatch: A must be a string or cell array of strings"); + endif + + ## Trim blanks and nulls from search string + s = regexprep (s, "[ \\0]+$", ''); + len = length (s); + + exact = nargin == 3 && ischar (exact) && strcmp (exact, "exact"); + + if (ischar (A)) + [nr, nc] = size (A); + if (len > nc) + idx = []; + else + match = all (bsxfun (@eq, A(:,1:len), s), 2); + if (exact) + AA = A(:,len+1:nc); + match &= all (AA == " " | AA == "\0", 2); + endif + idx = find (match); + endif + else + if (len > 0) + idx = find (strncmp (s, A, len)); + else + idx = find (strcmp (s, A)); + endif + if (exact) + ## We can't just use strcmp, because we need to ignore spaces at end. + B = regexprep (A(idx), "[ \\0]+$", ''); + idx = idx(strcmp (s, B)); + endif + endif + +endfunction + + +%!assert (strmatch ("a", {"aaa", "bab", "bbb"}), 1) +%!assert (strmatch ("apple", "apple juice"), 1) +%!assert (strmatch ("apple", ["apple pie"; "apple juice"; "an apple"]), [1; 2]) +%!assert (strmatch ("apple", {"apple pie"; "apple juice"; "tomato"}), [1; 2]) +%!assert (strmatch ("apple pie", "apple"), []) +%!assert (strmatch ("a ", "a"), 1) +%!assert (strmatch ("a", "a \0", "exact"), 1) +%!assert (strmatch ("a b", {"a b", "a c", "c d"}), 1) +%!assert (strmatch ("", {"", "foo", "bar", ""}), [1, 4]) +%!assert (strmatch ('', { '', '% comment', 'var a = 5', ''}, 'exact'), [1,4]) + +%% Test input validation +%!error <Invalid call to strmatch> strmatch () +%!error <Invalid call to strmatch> strmatch ("a") +%!error <Invalid call to strmatch> strmatch ("a", "aaa", "exact", 1) +%!error <S must be a string> strmatch (1, "aaa") +%!error <S must be a string> strmatch (char ("a", "bb"), "aaa") +%!error <A must be a string> strmatch ("a", 1) +%!error <A must be a string> strmatch ("a", {"hello", [1]}) +