Mercurial > hg > octave-nkf

annotate scripts/plot/util/graphics_toolkit.m @ 18451:abc78c10acb6 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
graphics_toolkit: Check argument against list of available toolkits (bug #41258) * graphics_toolkit.m: Check argument against list of available toolkits, better error reporting in case of typo or missing toolkit.
author Michael Godfrey <michaeldgodfrey@gmail.com>
date Thu, 16 Jan 2014 22:49:52 -0500
parents d63878346099
children 446c46af4b42
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17572
diff changeset
1 ## Copyright (C) 2008-2013 Michael Goffioul
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
16491
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility.
Rik <rik@octave.org>
parents: 16489
diff changeset
20 ## @deftypefn {Function File} {@var{name} =} graphics_toolkit ()
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
21 ## @deftypefnx {Function File} {@var{name} =} graphics_toolkit (@var{hlist})
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
22 ## @deftypefnx {Function File} {} graphics_toolkit (@var{name})
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
23 ## @deftypefnx {Function File} {} graphics_toolkit (@var{hlist}, @var{name})
17496
5789ad69c85a graphics_toolkit.m: Adjust spacing in docstring.
Rik <rik@octave.org>
parents: 17312
diff changeset
24 ## Query or set the default graphics toolkit which is assigned to new figures.
16489
36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392)
Amod Mulay <amodmulay1@gmail.com>
parents: 14853
diff changeset
25 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
26 ## With no inputs, return the current default graphics toolkit. If the input
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
27 ## is a list of figure graphic handles, @var{hlist}, then return the name
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
28 ## of the graphics toolkit in use for each figure.
16489
36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392)
Amod Mulay <amodmulay1@gmail.com>
parents: 14853
diff changeset
29 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
30 ## When called with a single input @var{name} set the default graphics toolkit
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
31 ## to @var{name}. If the toolkit is not already loaded, it is initialized by
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
32 ## calling the function @code{__init_@var{name}__}. If the first input
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
33 ## is a list of figure handles, @var{hlist}, then the graphics toolkit is set
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17107
diff changeset
34 ## to @var{name} for these figures only.
16489
36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392)
Amod Mulay <amodmulay1@gmail.com>
parents: 14853
diff changeset
35 ##
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
36 ## @seealso{available_graphics_toolkits}
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 ## @end deftypefn
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
39 function retval = graphics_toolkit (name, hlist = [])
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
41 if (nargin > 2)
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
42 print_usage ();
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
43 endif
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44
14046
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
45 if (nargout > 0 || nargin == 0)
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
46 retval = get (0, "defaultfigure__graphics_toolkit__");
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
47 endif
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
48
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
49 if (nargin == 0)
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
50 return;
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
51 elseif (nargin == 1)
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
52 if (all (isfigure (name)))
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
53 hlist = name;
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
54 retval = get (hlist, "__graphics_toolkit__");
17312
088d014a7fe2 Use semicolon after "return" statement in core m-files.
Rik <rik@octave.org>
parents: 17122
diff changeset
55 return;
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
56 elseif (! ischar (name))
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
57 error ("graphics_toolkit: invalid graphics toolkit NAME");
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 elseif (nargin == 2)
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
60 ## Swap input arguments
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
61 [hlist, name] = deal (name, hlist);
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
62 if (! all (isfigure (hlist)))
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
63 error ("graphics_toolkit: invalid figure handle list HLIST");
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
64 elseif (! ischar (name))
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
65 error ("graphics_toolkit: invalid graphics toolkit NAME");
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68
18451
abc78c10acb6 graphics_toolkit: Check argument against list of available toolkits (bug #41258)
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17744
diff changeset
69 if (! any (strcmp (available_graphics_toolkits (), name)))
abc78c10acb6 graphics_toolkit: Check argument against list of available toolkits (bug #41258)
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17744
diff changeset
70 error ("graphics_toolkit: %s toolkit is not available", name);
abc78c10acb6 graphics_toolkit: Check argument against list of available toolkits (bug #41258)
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17744
diff changeset
71 endif
abc78c10acb6 graphics_toolkit: Check argument against list of available toolkits (bug #41258)
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17744
diff changeset
72
14021
e3bed294b117 refactor graphics_toolkit class (bug #31583)
John W. Eaton <jwe@octave.org>
parents: 13977
diff changeset
73 if (! any (strcmp (loaded_graphics_toolkits (), name)))
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 feval (["__init_", name, "__"]);
14021
e3bed294b117 refactor graphics_toolkit class (bug #31583)
John W. Eaton <jwe@octave.org>
parents: 13977
diff changeset
75 if (! any (strcmp (loaded_graphics_toolkits (), name)))
e3bed294b117 refactor graphics_toolkit class (bug #31583)
John W. Eaton <jwe@octave.org>
parents: 13977
diff changeset
76 error ("graphics_toolkit: %s toolkit was not correctly loaded", name);
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 endif
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 if (isempty (hlist))
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
81 set (0, "defaultfigure__graphics_toolkit__", name);
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
82 else
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
83 set (hlist, "__graphics_toolkit__", name);
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
84 endif
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
85
8060
09f32aac8fbc Interface for backend switch/initialization
John W. Eaton <jwe@octave.org>
parents:
diff changeset
86 endfunction
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
87
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
88
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
89 %!testif HAVE_FLTK
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
90 %! unwind_protect
17107
dbd64c9a16da Restore graphics toolkit after %!tests that alter it.
Rik <rik@octave.org>
parents: 16933
diff changeset
91 %! hf = figure ("visible", "off");
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
92 %! toolkit = graphics_toolkit ();
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
93 %! assert (get (0, "defaultfigure__graphics_toolkit__"), toolkit);
17107
dbd64c9a16da Restore graphics toolkit after %!tests that alter it.
Rik <rik@octave.org>
parents: 16933
diff changeset
94 %! graphics_toolkit (hf, "fltk");
14724
395d238418a7 Allow graphics_toolkit (h) to return the value for specified figures.
Ben Abbott <bpabbott@mac.com>
parents: 14363
diff changeset
95 %! assert (graphics_toolkit (hf), "fltk");
13976
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
96 %! unwind_protect_cleanup
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
97 %! close (hf);
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
98 %! end_unwind_protect
fb5955171b0b graphics_toolkit.m: Update function to return current toolkit when no arg given.
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
99
14046
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
100 %!testif HAVE_FLTK
14277
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
101 %! old_toolkit = graphics_toolkit ();
16933
e39f00a32dc7 maint: Use parentheses around condition for switch(),while(),if() statements.
Rik <rik@octave.org>
parents: 16491
diff changeset
102 %! switch (old_toolkit)
14277
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
103 %! case {"gnuplot"}
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
104 %! new_toolkit = "fltk";
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
105 %! otherwise
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
106 %! new_toolkit = "gnuplot";
c39345616b7e maint: Use Octave spacing conventions in %!test block for graphics_toolkit.m
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
107 %! endswitch
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14277
diff changeset
108 %! assert (graphics_toolkit (new_toolkit), old_toolkit);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14277
diff changeset
109 %! assert (graphics_toolkit (old_toolkit), new_toolkit);
14046
c3fab3891460 Trivial bug fixes for graphics_toolkit().
Ben Abbott <bpabbott@mac.com>
parents: 14021
diff changeset
110