Mercurial > octave

annotate scripts/miscellaneous/methods.m @ 24491:d8fb16ab0992

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: move non-numeric m-files from general/ to miscellaneous/ dir. * scripts/miscellaneous/fieldnames.m, scripts/miscellaneous/grabcode.m, scripts/miscellaneous/inputParser.m, scripts/miscellaneous/isdir.m, scripts/miscellaneous/loadobj.m, scripts/miscellaneous/methods.m, scripts/miscellaneous/nargchk.m, scripts/miscellaneous/narginchk.m, scripts/miscellaneous/nargoutchk.m, scripts/miscellaneous/nthargout.m, scripts/miscellaneous/private/__publish_html_output__.m, scripts/miscellaneous/private/__publish_latex_output__.m, scripts/miscellaneous/publish.m, scripts/miscellaneous/saveobj.m, scripts/miscellaneous/validateattributes.m: Moved from scripts/general dir. * scripts/general/module.mk, scripts/miscellaneous/module.mk: Update build system.
author Rik <rik@octave.org>
date Thu, 28 Dec 2017 16:14:37 -0800
parents scripts/general/methods.m@32ec90068be5
children 194eb4bd202b
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) 2012-2017 Rik Wehbring
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22497
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22497
diff changeset
8 ## (at your option) any later version.
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22497
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22497
diff changeset
13 ## GNU General Public License for more details.
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
18
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
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: 20539
diff changeset
20 ## @deftypefn {} {} methods (@var{obj})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20539
diff changeset
21 ## @deftypefnx {} {} methods ("@var{classname}")
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20539
diff changeset
22 ## @deftypefnx {} {@var{mtds} =} methods (@dots{})
22167
6c94c7bd55e7 doc: Reword methods doc string for clarity
Mike Miller <mtmiller@octave.org>
parents: 21634
diff changeset
23 ## List the names of the public methods for the object @var{obj} or the
6c94c7bd55e7 doc: Reword methods doc string for clarity
Mike Miller <mtmiller@octave.org>
parents: 21634
diff changeset
24 ## named class @var{classname}.
20158
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
25 ##
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
26 ## @var{obj} may be an Octave class object or a Java object.
22167
6c94c7bd55e7 doc: Reword methods doc string for clarity
Mike Miller <mtmiller@octave.org>
parents: 21634
diff changeset
27 ## @var{classname} may be the name of an Octave class or a Java class.
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
28 ##
22167
6c94c7bd55e7 doc: Reword methods doc string for clarity
Mike Miller <mtmiller@octave.org>
parents: 21634
diff changeset
29 ## When called with no output arguments, @code{methods} prints the list of
6c94c7bd55e7 doc: Reword methods doc string for clarity
Mike Miller <mtmiller@octave.org>
parents: 21634
diff changeset
30 ## method names to the screen. Otherwise, the output argument @var{mtds}
6c94c7bd55e7 doc: Reword methods doc string for clarity
Mike Miller <mtmiller@octave.org>
parents: 21634
diff changeset
31 ## contains the list in a cell array of strings.
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
32 ## @seealso{fieldnames}
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
33 ## @end deftypefn
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
34
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
35 function mtds = methods (obj)
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
36
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
37 if (nargin != 1)
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
38 print_usage ();
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
39 endif
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
40
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
41 if (isobject (obj))
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
42 ## Call internal C++ function for Octave objects
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
43 mtds_list = __methods__ (obj);
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
44 elseif (ischar (obj))
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
45 ## Could be a classname for an Octave class or Java class.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
46 ## Try Octave class first.
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
47 mtds_list = __methods__ (obj);
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
48 if (isempty (mtds_list))
15790
921912c92102 Deprecate java_invoke, replace with javaMethod.
Rik <rik@octave.org>
parents: 15785
diff changeset
49 mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", obj);
16724
b7667fcb9fbc Substitute ostrsplit() for strsplit().
Ben Abbott <bpabbott@mac.com>
parents: 16403
diff changeset
50 mtds_list = ostrsplit (mtds_str, ';');
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
51 endif
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
52 elseif (isjava (obj))
20539
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
53 ## FIXME: Function prototype accepts java obj, but doesn't work if obj
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
54 ## is e.g., java.lang.String. Convert obj to classname then.
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
55 try
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
56 mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", obj);
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
57 catch
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
58 obj = class (obj);
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
59 mtds_str = javaMethod ("getMethods", "org.octave.ClassHelper", obj);
5d31cd795c21 methods.m: try Java class names if getMethods fails on Java objects (bug #46010)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 20158
diff changeset
60 end_try_catch
16724
b7667fcb9fbc Substitute ostrsplit() for strsplit().
Ben Abbott <bpabbott@mac.com>
parents: 16403
diff changeset
61 mtds_list = strsplit (mtds_str, ';');
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
62 else
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
63 error ("methods: Invalid input argument");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
64 endif
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
65
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
66 if (nargout == 0)
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
67 classname = ifelse (ischar (obj), obj, class (obj));
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
68 printf ("Methods for class %s:\n", classname);
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
69 disp (list_in_columns (mtds_list));
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
70 else
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
71 mtds = mtds_list;
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
72 endif
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
73
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
74 endfunction
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
75
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
76
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
77 ## test Octave classname
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
78 %!test
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
79 %! mtds = methods ("ftp");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
80 %! assert (mtds{1}, "ascii");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
81
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
82 ## test Java classname
23405
32ec90068be5 use %!testif runtime tests to properly skip java tests
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
83 %!testif HAVE_JAVA; usejava ("jvm")
15785
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
84 %! mtds = methods ("java.lang.Double");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
85 %! search = strfind (mtds, "java.lang.Double valueOf");
42cff4396de4 Add methods.m which extends methods() to work on Java objects.
Rik <rik@octave.org>
parents:
diff changeset
86 %! assert (! isempty ([search{:}]));