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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
########################################################################
##
## Copyright (C) 2012-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 {} {} methods (@var{obj})
## @deftypefnx {} {} methods ("@var{classname}")
## @deftypefnx {} {} methods (@dots{}, "-full")
## @deftypefnx {} {@var{mtds} =} methods (@dots{})
## List the names of the public methods for the object @var{obj} or the
## named class @var{classname}.
##
## @var{obj} may be an Octave class object or a Java object.
## @var{classname} may be the name of an Octave class or a Java class.
##
## If the optional argument @qcode{"-full"} is given then Octave returns
## full method signatures which include output type, name of method,
## and the number and type of inputs.
##
## When called with no output arguments, @code{methods} prints the list of
## method names to the screen. Otherwise, the output argument @var{mtds}
## contains the list in a cell array of strings.
## @seealso{ismethod, properties, fieldnames}
## @end deftypefn
function mtds = methods (obj, fullopt)
if (nargin < 1)
print_usage ();
endif
havesigs = false;
showsigs = false;
if (nargin == 2)
if (! strcmp (fullopt, "-full"))
error ("methods: invalid option");
endif
showsigs = true;
endif
if (isobject (obj))
## Call internal C++ function for Octave objects.
mtds_list = __methods__ (obj);
elseif (ischar (obj))
## CLASSNAME could be an Octave class or Java class.
## Try Octave class first.
[mtds_list, valid] = __methods__ (obj);
if (! valid)
## Try Java class second.
try
mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", obj);
catch
error ("methods: class '%s' not found", obj);
end_try_catch
mtds_list = ostrsplit (mtds_str, ';');
mtds_list = mtds_list(:); # return a column vector for compatibility
havesigs = true;
endif
elseif (isjava (obj))
## If obj is a String or a subclass of String, then get the methods of its
## class name, not the methods of the class that may be named by the
## content of the string.
if (isa (obj, "java.lang.String"))
klass = class (obj);
mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", klass);
else
mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", obj);
endif
mtds_list = strsplit (mtds_str, ';');
mtds_list = mtds_list(:); # return a column vector for compatibility
havesigs = true;
else
error ("methods: invalid input argument");
endif
if (havesigs && ! showsigs)
## Extract only the method name for ordinary class methods, delete the
## return type and the argument list.
mtds_list = regexprep (mtds_list, '^(?:[^(]+) (\w+) ?\(.*$', '$1');
## Extract only the class name for class constructors, delete the optional
## "org.example." package prefix and the argument list.
mtds_list = regexprep (mtds_list, '^(?:[\.\w]+\.)?(\w+) ?\(.*$', '$1');
mtds_list = unique (mtds_list);
else
## Delete the "org.example." package prefix if present.
mtds_list = regexprep (mtds_list, '^(?:[\.\w]+\.)(\w+ ?\(.*)$', '$1');
endif
if (nargout == 0)
classname = ifelse (ischar (obj), obj, class (obj));
printf ("Methods for class %s:\n", classname);
disp (list_in_columns (mtds_list));
else
mtds = mtds_list;
endif
endfunction
## test classdef object
%!test
%! ip = inputParser ();
%! assert (methods (ip),
%! {"addOptional"; "addParamValue"; "addParameter"; "addRequired";
%! "addSwitch"; "delete"; "disp"; "parse"; });
## test classdef classname
%!assert (methods ("inputParser"),
%! {"addOptional"; "addParamValue"; "addParameter"; "addRequired";
%! "addSwitch"; "delete"; "disp"; "parse"; });
## test old-style @classname
%!test
%! mtds = methods ("ftp");
%! assert (mtds{1}, "ascii");
%! assert (numel (mtds), 15);
## test Java classname
%!testif HAVE_JAVA; usejava ("jvm")
%! mtds = methods ("java.lang.Double");
%! search = strfind (mtds, "valueOf");
%! assert (! isempty ([search{:}]));
## test Java classname with -full prototypes
%!testif HAVE_JAVA; usejava ("jvm")
%! mtds = methods ("java.lang.Double", "-full");
%! search = strfind (mtds, "java.lang.Double valueOf");
%! assert (! isempty ([search{:}]));
## test Java object
%!testif HAVE_JAVA; usejava ("jvm")
%! jobject = javaObject ("java.lang.Double", pi);
%! assert (methods (jobject), methods ("java.lang.Double"));
## test exceptional case of Java String object
%!testif HAVE_JAVA; usejava ("jvm") <*48758>
%! jobject = javaObject ("java.lang.String", "java.lang.Integer");
%! assert (methods (jobject), methods ("java.lang.String"));
## Test input validation
%!error <Invalid call> methods ()
%!error <invalid option> methods ("ftp", "option1")
%!error <class 'foobar' not found> methods ('foobar')
%!error <invalid input argument> methods (1)
|
