Mercurial > octave

annotate scripts/java/usejava.m @ 26376:00f796120a6d stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright dates in all source files.
author John W. Eaton <jwe@octave.org>
date Wed, 02 Jan 2019 16:32:43 -0500
parents 6652d3823428
children b442ec6dda5c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26376
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
1 ## Copyright (C) 2012-2019 Rik Wehbring
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
2 ## Parts Copyright (C) 2012-2019 Philip Nienhuis
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
3 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
4 ## This file is part of Octave.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
5 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23405
diff changeset
6 ## Octave is free software: you can redistribute it and/or modify it
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23405
diff changeset
8 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22497
diff changeset
9 ## (at your option) any later version.
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
10 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22497
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22497
diff changeset
14 ## GNU General Public License for more details.
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
15 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23405
diff changeset
18 ## <https://www.gnu.org/licenses/>.
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
19
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
20 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19833
diff changeset
21 ## @deftypefn {} {} usejava (@var{feature})
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
22 ## Return true if the Java element @var{feature} is available.
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
23 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
24 ## Possible features are:
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
25 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
26 ## @table @asis
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24534
diff changeset
27 ## @item @nospell{@qcode{"awt"}}
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
28 ## Abstract Window Toolkit for GUIs.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
29 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
30 ## @item @qcode{"desktop"}
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
31 ## Interactive desktop is running.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
32 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
33 ## @item @qcode{"jvm"}
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
34 ## Java Virtual Machine.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
35 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
36 ## @item @qcode{"swing"}
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
37 ## Swing components for lightweight GUIs.
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
38 ## @end table
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
39 ##
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
40 ## @code{usejava} determines if specific Java features are available in an
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
41 ## Octave session. This function is provided for scripts which may alter
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
42 ## their behavior based on the availability of Java. The feature
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
43 ## @qcode{"desktop"} always returns @code{false} as Octave has no Java-based
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
44 ## desktop. Other features may be available if Octave was compiled with the
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
45 ## Java Interface and Java is installed.
18721
700714c099a2 Add new function javachk for Matlab compatibility.
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 17744
diff changeset
46 ## @seealso{javachk}
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
47 ## @end deftypefn
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
48
16768
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 15805
diff changeset
49 ## Author: Rik Wehbring
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 15805
diff changeset
50 ## Author: Philip Nienhuis <prnienhuis@users.sf.net>
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 15805
diff changeset
51
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
52 function retval = usejava (feature)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
53
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
54 if (nargin != 1 || ! ischar (feature))
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
55 print_usage ();
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
56 endif
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
57
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
58 retval = false;
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
59
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
60 switch (feature)
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
61 ## For each feature, try methods() on a Java class of a feature
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
62 case "awt"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
63 try
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
64 dum = methods ("java.awt.Frame");
21778
895971cb50f0 usejava: Return false if not running in a graphical environment (bug #48005)
Atri Bhattacharya <badshah400@aim.com>
parents: 20852
diff changeset
65 retval = ! javaMethod ("isHeadless", "java.awt.GraphicsEnvironment");
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
66 end_try_catch
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
67 case "desktop"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
68 ## Octave has no Java based GUI/desktop, leave retval = false
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
69 case "jvm"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
70 try
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
71 dum = methods ("java.lang.Runtime");
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
72 retval = true;
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
73 end_try_catch
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
74 case "swing"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
75 try
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
76 dum = methods ("javax.swing.Popup");
21778
895971cb50f0 usejava: Return false if not running in a graphical environment (bug #48005)
Atri Bhattacharya <badshah400@aim.com>
parents: 20852
diff changeset
77 retval = ! javaMethod ("isHeadless", "java.awt.GraphicsEnvironment");
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
78 end_try_catch
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
79 otherwise
22760
c4d80b9d2898 maint: Capitalize variable names appearing in error() messages of m-files.
Rik <rik@octave.org>
parents: 22755
diff changeset
80 error ("usejava: unrecognized FEATURE '%s'", feature);
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
81 endswitch
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
82
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
83 endfunction
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
84
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
85
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
86 %!assert (usejava ("desktop"), false)
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
87
23405
32ec90068be5 use %!testif runtime tests to properly skip java tests
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
88 %!testif HAVE_JAVA; usejava ("jvm")
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
89 %! assert (usejava ("jvm"), true);
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
90
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
91 ## Test input validation
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
92 %!error usejava ()
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
93 %!error usejava (1, 2)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
94 %!error usejava (1)
22765
01aae08a0105 maint: Rename variables to match documentation in m-files.
Rik <rik@octave.org>
parents: 22760
diff changeset
95 %!error <unrecognized FEATURE> usejava ("abc")