Mercurial > octave

annotate scripts/miscellaneous/fileparts.m @ 23219:3ac9f9ecfae5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright dates.
author John W. Eaton <jwe@octave.org>
date Wed, 22 Feb 2017 12:39:29 -0500
parents e9a0469dedd9
children 092078913d54
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23219
3ac9f9ecfae5 maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents: 23083
diff changeset
1 ## Copyright (C) 2003-2017 John W. Eaton
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
2 ##
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
4 ##
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
9 ##
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
14 ##
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
18
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19833
diff changeset
20 ## @deftypefn {} {[@var{dir}, @var{name}, @var{ext}] =} fileparts (@var{filename})
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
21 ## Return the directory, name, and extension components of @var{filename}.
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
22 ##
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
23 ## The input @var{filename} is a string which is parsed. There is no attempt
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
24 ## to check whether the filename or directory specified actually exists.
19214
8cc4a9bb253b fullfile.m: Match documentation name to function variable name.
Rik <rik@octave.org>
parents: 19205
diff changeset
25 ## @seealso{fullfile, filesep}
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
26 ## @end deftypefn
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
27
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
28 function [dir, name, ext] = fileparts (filename)
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
29
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
30 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5835
diff changeset
31 print_usage ();
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
32 endif
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
33
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
34 if (! ischar (filename) || rows (filename) > 1)
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
35 error ("fileparts: FILENAME must be a single string");
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
36 endif
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
37
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
38 ds = strchr (filename, filesep ("all"), 1, "last");
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
39 if (isempty (ds))
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
40 ds = 0;
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
41 endif
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
42 es = rindex (filename, ".");
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
43 ## These can be the same if they are both 0 (no dir or ext).
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
44 if (es <= ds)
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
45 es = length (filename)+1;
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
46 endif
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
47
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
48 if (ds == 0)
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
49 dir = "";
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
50 elseif (ds == 1)
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
51 dir = filename(1);
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
52 else
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
53 dir = filename(1:ds-1);
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
54 endif
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
55
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
56 name = filename(ds+1:es-1);
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
57 if (isempty (name))
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
58 name = "";
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
59 endif
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
60
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
61 if (es > 0 && es <= length (filename))
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
62 ext = filename(es:end);
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
63 else
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
64 ext = "";
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
65 endif
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
66
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents:
diff changeset
67 endfunction
8201
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
68
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
69
8201
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
70 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
71 %! [d, n, e] = fileparts ("file");
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
72 %! assert (strcmp (d, "") && strcmp (n, "file") && strcmp (e, ""));
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
73
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
74 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
75 %! [d, n, e] = fileparts ("file.ext");
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
76 %! assert (strcmp (d, "") && strcmp (n, "file") && strcmp (e, ".ext"));
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
77
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
78 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
79 %! [d, n, e] = fileparts ("/file.ext");
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
80 %! assert (strcmp (d, "/") && strcmp (n, "file") && strcmp (e, ".ext"));
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
81
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
82 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
83 %! [d, n, e] = fileparts ("dir/file.ext");
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
84 %! assert (strcmp (d, "dir") && strcmp (n, "file") && strcmp (e, ".ext"));
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
85
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
86 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
87 %! [d, n, e] = fileparts ("./file.ext");
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
88 %! assert (strcmp (d, ".") && strcmp (n, "file") && strcmp (e, ".ext"));
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
89
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
90 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
91 %! [d, n, e] = fileparts ("d1/d2/file.ext");
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
92 %! assert (strcmp (d, "d1/d2") && strcmp (n, "file") && strcmp (e, ".ext"));
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
93
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
94 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
95 %! [d, n, e] = fileparts ("/d1/d2/file.ext");
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
96 %! assert (strcmp (d, "/d1/d2") && strcmp (n, "file") && strcmp (e, ".ext"));
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
97
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
98 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
99 %! [d, n, e] = fileparts ("/.ext");
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
100 %! assert (strcmp (d, "/") && strcmp (n, "") && strcmp (e, ".ext"));
8201
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
101
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
102 %!test
0ab4eed59455 fileparts.m: handle "/file" correctly; improve compatibilty
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
103 %! [d, n, e] = fileparts (".ext");
19205
e172186599ca fileparts.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
104 %! assert (strcmp (d, "") && strcmp (n, "") && strcmp (e, ".ext"));
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
105
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
106 ## Test input validation
17438
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
107 %!error fileparts ()
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
108 %!error fileparts (1,2)
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
109 %!error <FILENAME must be a single string> fileparts (1)
791c117eb2cf fileparts.m: Check for multi-line char inputs (bug #40062)
Rik <rik@octave.org>
parents: 14868
diff changeset
110 %!error <FILENAME must be a single string> fileparts (["a"; "b"])