Mercurial > octave

annotate scripts/plot/util/ishold.m @ 32048:61db3c9377fb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ishold.m: Suppress BIST hold echo after 72d005398818 (bug @63923). * scripts/plot/util/ishold.m: Change BIST to call 'hold on' instead of 'hold' to avoid hold status echo appearing during self tests.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Fri, 21 Apr 2023 14:49:23 -0400
parents 597f3ee61a48
children 2e484f9f1f18
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
31706
597f3ee61a48 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 30565
diff changeset
3 ## Copyright (C) 2005-2023 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
7 ##
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
8 ## This file is part of Octave.
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24423
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
11 ## 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: 24423
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 ## (at your option) any later version.
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
14 ##
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 ## GNU General Public License for more details.
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
19 ##
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
21 ## 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: 24423
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
25
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
26 ## -*- texinfo -*-
30558
83aeaba707d8 doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
Rik <rik@octave.org>
parents: 29359
diff changeset
27 ## @deftypefn {} {@var{tf} =} ishold
83aeaba707d8 doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
Rik <rik@octave.org>
parents: 29359
diff changeset
28 ## @deftypefnx {} {@var{tf} =} ishold (@var{hax})
83aeaba707d8 doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
Rik <rik@octave.org>
parents: 29359
diff changeset
29 ## @deftypefnx {} {@var{tf} =} ishold (@var{hfig})
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
30 ## Return true if the next plot will be added to the current plot, or
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
31 ## false if the plot device will be cleared before drawing the next plot.
12546
39ca02387a32 Improve docstrings for a number of functions.
Rik <octave@nomad.inbox5.com>
parents: 11563
diff changeset
32 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
33 ## If the first argument is an axes handle @var{hax} or figure handle
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
34 ## @var{hfig} then operate on this plot rather than the current one.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14363
diff changeset
35 ## @seealso{hold, newplot}
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
36 ## @end deftypefn
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
37
30558
83aeaba707d8 doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
Rik <rik@octave.org>
parents: 29359
diff changeset
38 function tf = ishold (h)
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
39
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
40 if (nargin == 0)
9618
e381f80a5f7a correctly toggle hold state
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
41 fig = gcf ();
13319
eb0ce6ffefb0 ishold: don't create axes if none exists
John W. Eaton <jwe@octave.org>
parents: 13204
diff changeset
42 ax = get (fig, "currentaxes");
17130
327862500f1c ishold.m: Recode to follow modern Octave coding conventions.
Rik <rik@octave.org>
parents: 17122
diff changeset
43 else
24423
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 23220
diff changeset
44 if (! ishghandle (h))
22069
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
45 error ("ishold: H must be an axes or figure graphics handle");
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
46 endif
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
47
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
48 switch (get (h, "type"))
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
49 case "figure"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9618
diff changeset
50 fig = h;
17130
327862500f1c ishold.m: Recode to follow modern Octave coding conventions.
Rik <rik@octave.org>
parents: 17122
diff changeset
51 ax = get (fig, "currentaxes");
22069
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
52
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
53 case "axes"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9618
diff changeset
54 ax = h;
19880
f25fe5369022 Don't assume axes parent is a figure (bug #44394)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19697
diff changeset
55 fig = ancestor (ax, "figure");
22069
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
56
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
57 otherwise
17130
327862500f1c ishold.m: Recode to follow modern Octave coding conventions.
Rik <rik@octave.org>
parents: 17122
diff changeset
58 error ("ishold: H must be an axes or figure graphics handle");
22069
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
59
9121d6584f6a Overhaul graphics implementation of hold() (bug #43559).
Rik <rik@octave.org>
parents: 20852
diff changeset
60 endswitch
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
61 endif
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
62
30558
83aeaba707d8 doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
Rik <rik@octave.org>
parents: 29359
diff changeset
63 tf = (strcmp (get (fig, "nextplot"), "add")
17130
327862500f1c ishold.m: Recode to follow modern Octave coding conventions.
Rik <rik@octave.org>
parents: 17122
diff changeset
64 && ! isempty (ax) && strcmp (get (ax, "nextplot"), "add"));
9618
e381f80a5f7a correctly toggle hold state
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
65
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents:
diff changeset
66 endfunction
13204
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
67
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
68
13204
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
69 %!test
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
70 %! hf = figure ("visible", "off");
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
71 %! unwind_protect
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
72 %! assert (! ishold);
13319
eb0ce6ffefb0 ishold: don't create axes if none exists
John W. Eaton <jwe@octave.org>
parents: 13204
diff changeset
73 %! assert (isempty (get (hf, "currentaxes")));
eb0ce6ffefb0 ishold: don't create axes if none exists
John W. Eaton <jwe@octave.org>
parents: 13204
diff changeset
74 %! assert (get (hf, "NextPlot"), "add");
13204
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
75 %! l = plot ([0 1]);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
76 %! assert (! ishold);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
77 %! assert (! ishold (gca));
13204
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
78 %! assert (get (gca, "NextPlot"), "replace");
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
79 %! assert (get (hf, "NextPlot"), "add");
32048
61db3c9377fb ishold.m: Suppress BIST hold echo after 72d005398818 (bug @63923).
Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
parents: 31706
diff changeset
80 %! hold on;
13204
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
81 %! assert (ishold);
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
82 %! assert (ishold (gca));
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
83 %! assert (get (gca, "NextPlot"), "add");
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
84 %! assert (get (hf, "NextPlot"), "add");
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
85 %! p = fill ([0 1 1], [0 0 1],"black");
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
86 %! assert (length (get (hf, "children")), 1);
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
87 %! assert (length (get (gca, "children")), 2);
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
88 %! unwind_protect_cleanup
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
89 %! close (hf);
be7bfd59300a Add tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 12546
diff changeset
90 %! end_unwind_protect