annotate scripts/java/usejava.m @ 17530:0f45d9dd8107

test: Fix 4 failing plot demos. * scripts/plot/legend.m: Demo #11, use 'h' for returned handle. * scripts/plot/plot.m: Fix typo "lenths" -> "lengths". * scripts/plot/ribbon.m: Remove unnecessary call to meshgrid now that sombrero returns meshgridded data. * scripts/plot/trimesh.m: Set colormap so plot is always reproducible.
author Rik <rik@octave.org>
date Tue, 01 Oct 2013 15:39:20 -0700
parents bc924baa2c4e
children d63878346099
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14093
diff changeset
1 ## Copyright (C) 2012 Rik Wehbring
16768
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 15805
diff changeset
2 ## Parts Copyright (C) 2012 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 ##
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
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
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
9 ## your option) any later version.
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
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
14 ## General Public License for more details.
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
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
18 ## <http://www.gnu.org/licenses/>.
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 -*-
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
21 ## @deftypefn {Function File} {} 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
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16768
diff changeset
27 ## @item @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.
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
46 ## @end deftypefn
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
47
16768
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 15805
diff changeset
48 ## Author: Rik Wehbring
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 15805
diff changeset
49 ## Author: Philip Nienhuis <prnienhuis@users.sf.net>
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 15805
diff changeset
50
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
51 function retval = usejava (feature)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
52
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
53 if (nargin != 1 || ! ischar (feature))
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
54 print_usage ();
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
55 endif
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
56
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
57 retval = false;
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
58
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
59 switch feature
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
60 ## 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
61 case "awt"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
62 try
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
63 dum = methods ("java.awt.Frame");
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
64 retval = true;
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
65 end_try_catch
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
66 case "desktop"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
67 ## 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
68 case "jvm"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
69 try
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
70 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
71 retval = true;
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
72 end_try_catch
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
73 case "swing"
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
74 try
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
75 dum = methods ("javax.swing.Popup");
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
76 retval = true;
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
77 end_try_catch
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
78 otherwise
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
79 error ("usejava: unrecognized feature '%s'", feature);
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
80 endswitch
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
81
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
82 endfunction
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
83
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
84
14353
937035390ec0 usejava.m: Update to use try/catch architecture
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 14138
diff changeset
85 %!assert (usejava ("desktop"), false)
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
86
15805
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
87 %!testif HAVE_JAVA
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
88 %! assert (usejava ("jvm"), true);
420b5603cbbf build: Move usejava.m from scripts/miscellaneous to scripts/java directory.
Rik <rik@octave.org>
parents: 14353
diff changeset
89
13826
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
90 %% Test input validation
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
91 %!error usejava ()
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
92 %!error usejava (1, 2)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
93 %!error usejava (1)
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
94 %!error <unrecognized feature> usejava ("abc")
847812137666 Implement new usejava function for Matlab compatability.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
95