annotate main/strings/strtok.m @ 0:6b33357c7561 octave-forge

Initial revision
author pkienzle
date Wed, 10 Oct 2001 19:54:49 +0000
parents
children 55daac44d4ad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
1 ## Copyright (C) 2000 Paul Kienzle
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
2 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
6 ## (at your option) any later version.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
7 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
11 ## GNU General Public License for more details.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
12 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
15 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
16
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
17 ## usage: [tok, rem] = strtok(str, delim)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
18 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
19 ## Find all characters up to but not including the first character which
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
20 ## is in the string delim. If rem is requested, it contains the
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
21 ## remainder of the string, starting at the first deliminator. Leading
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
22 ## delimiters are ignored. If delim is not specified, space is assumed.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
23
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
24 ## TODO: check what to do for a null delimiter
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
25 function [tok, rem] = strtok(str, delim)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
26
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
27 if nargin<1 || nargin > 2
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
28 usage("[tok, rem] = strtok(str, delim)");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
29 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
30 if nargin < 2 || isempty(delim), delim = " "; endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
31
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
32 if isempty(str)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
33 tok = rem = "";
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
34 elseif length(delim) > 3
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
35 start = 1;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
36 len = length(str);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
37 while start<=len
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
38 if all(str(start) != delim), break; endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
39 start++;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
40 endwhile
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
41 stop = start;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
42 while stop<=len
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
43 if any(str(stop) == delim), break; endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
44 stop++;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
45 endwhile
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
46 tok = str(start:stop-1);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
47 rem = str(stop:len);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
48 else
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
49 if length(delim)==1
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
50 idx = find(str == delim);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
51 elseif length(delim)==2
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
52 idx = find(str == delim(1) | str==delim(2));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
53 else
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
54 idx = find(str == delim(1) | str==delim(2) | str==delim(3));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
55 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
56 if isempty(idx)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
57 tok = str;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
58 rem = "";
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
59 else
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
60 skip = find(idx != 1:length(idx)); # find first non-leading delimiter
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
61 if isempty(skip)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
62 tok = str(idx(length(idx))+1:length(str));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
63 rem = "";
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
64 else
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
65 tok = str(skip(1):idx(skip(1))-1);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
66 rem = str(idx(skip(1)):length(str));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
67 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
68 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
69 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
70
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
71 endfunction
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
72
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
73 %!demo
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
74 %! strtok("this is the life")
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
75 %! % split at the first space, returning "this"
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
76
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
77 %!demo
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
78 %! s = "14*27+31"
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
79 %! while 1
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
80 %! [t,s] = strtok(s, "+-*/");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
81 %! printf("<%s>", t);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
82 %! if isempty(s), break; endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
83 %! printf("<%s>", s(1));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
84 %! endwhile
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
85 %! printf("\n");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
86 %! % ----------------------------------------------------
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
87 %! % Demonstrates processing of an entire string split on
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
88 %! % a variety of delimiters. Tokens and delimiters are
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
89 %! % printed one after another in angle brackets. The
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
90 %! % string is:
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
91
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
92 %!# test the tokens for all cases
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
93 %!assert(strtok(""), ""); # no string
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
94 %!assert(strtok("this"), "this"); # no delimiter in string
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
95 %!assert(strtok("this "), "this"); # delimiter at end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
96 %!assert(strtok("this is"), "this"); # delimiter in middle
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
97 %!assert(strtok(" this"), "this"); # delimiter at start
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
98 %!assert(strtok(" this "), "this"); # delimiter at start and end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
99 %!assert(strtok(" "), ""); # delimiter only
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
100
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
101 %!# test the remainder for all cases
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
102 %!test [t,r] = strtok(""); assert(r, "");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
103 %!test [t,r] = strtok("this"); assert(r, "");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
104 %!test [t,r] = strtok("this "); assert(r, " ");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
105 %!test [t,r] = strtok("this is"); assert(r, " is");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
106 %!test [t,r] = strtok(" this"); assert(r, "");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
107 %!test [t,r] = strtok(" this "); assert(r, " ");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
108 %!test [t,r] = strtok(" "); assert(r, "");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
109
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
110 %!# simple check with 2 and 3 delimeters
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
111 %!assert(strtok("this is", "i "), "th");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
112 %!assert(strtok("this is", "ij "), "th");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
113
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
114 %!# test all cases for 4 delimiters since a different
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
115 %!# algorithm is used when more than 3 delimiters
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
116 %!assert(strtok("","jkl "), "");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
117 %!assert(strtok("this","jkl "), "this");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
118 %!assert(strtok("this ","jkl "), "this");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
119 %!assert(strtok("this is","jkl "), "this");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
120 %!assert(strtok(" this","jkl "), "this");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
121 %!assert(strtok(" this ","jkl "), "this");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
122 %!assert(strtok(" ","jkl "), "");