1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
########################################################################
##
## Copyright (C) 2018-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This filename is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the filename COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} openfig
## @deftypefnx {} {} openfig (@var{filename})
## @deftypefnx {} {} openfig (@dots{}, @var{copies})
## @deftypefnx {} {} openfig (@dots{}, @var{visibility})
## @deftypefnx {} {@var{h} =} openfig (@dots{})
## Read saved figure window(s) from @var{filename} and return graphics
## handle(s) @var{h}.
##
## By default, @var{filename} is @qcode{"Untitled.fig"}. If a full path is not
## specified, the file opened will be the first one encountered in the load
## path. If @var{filename} is not found and does not have an extension, a
## search will take place for the first file in the load path with extension
## @qcode{".fig"} or @qcode{".ofig"}, in that order.
##
## @var{copies} is an optional input indicating whether a new figure should
## be created (@qcode{"new"}) or whether an existing figure may be reused
## (@qcode{"reuse"}). An existing figure may be reused if the
## @qcode{"FileName"} property matches the specified input @var{filename}.
## When a figure is reused it becomes the active figure and is shown on top
## of other figures. If the figure was offscreen, it is re-positioned to be
## onscreen. The default value for @var{copies} is @qcode{"new"}.
##
## @var{visibility} is an optional input indicating whether to show the figure
## (@qcode{"visible"}) or not (@qcode{"invisible"}). When @var{visibility} is
## specified as an input to @code{openfig} it overrides the visibility setting
## stored in @var{filename}.
##
## @seealso{open, hgload, savefig, struct2hdl}
## @end deftypefn
function h = openfig (filename = "Untitled.fig", varargin)
if (nargin > 3)
print_usage ();
endif
## Check input filename
if (isempty (file_in_loadpath (filename)))
[d,n,ext] = fileparts (filename);
if (isempty (ext))
filename = fullfile (d, [n ".fig"]);
if (isempty (file_in_loadpath (filename)))
filename = fullfile (d, [n ".ofig"]);
if (isempty (file_in_loadpath (filename)))
error ("openfig: cannot find file '%s'", filename);
endif
endif
else
error ("openfig: cannot find file '%s'", filename);
endif
endif
filename = file_in_loadpath (filename);
## Process optional arguments
copies = true;
visibility = {};
for i = 1:numel (varargin)
if (! ischar (varargin{i}))
error ("openfig: input argument %d must be a string", i+1);
endif
switch (lower (varargin{i}))
case "reuse"
copies = false;
case "new"
copies = true;
case "visible"
visibility = {"visible", "on"};
case "invisible"
visibility = {"visible", "off"};
otherwise
error ("openfig: unknown option '%s'", varargin{i});
endswitch
endfor
## Reuse an existing figure?
if (! copies)
htmp = findobj (allchild (0), "type", "figure", "FileName", filename);
if (! isempty (htmp))
htmp = htmp(end);
if (! isempty (visibility))
set (htmp, visibility{:});
endif
movegui (htmp, "onscreen");
if (nargout > 0)
h = htmp;
endif
return;
endif
endif
## Load graphics objects from file
prop_struct = cell2struct (visibility(2:2:end), visibility(1:2:end), 2);
htmp = hgload (filename, prop_struct);
set (htmp, "FileName", filename);
if (nargout > 0)
h = htmp;
endif
endfunction
%!test
%! unwind_protect
%! h1 = figure ("visible", "off");
%! ftmp = [tempname() ".ofig"];
%! hgsave (h1, ftmp);
%! close (h1);
%! h2 = openfig (ftmp, "new", "invisible");
%! h3 = openfig (ftmp, "reuse");
%! assert (h2 == h3);
%! close (h2);
%! unwind_protect_cleanup
%! unlink (ftmp);
%! try, close (h1); end_try_catch
%! try, close (h2); end_try_catch
%! try, close (h3); end_try_catch
%! end_unwind_protect
%!error openfig (1, 2, 3, 4)
%!error <cannot find file> openfig ("%%_A_REALLY_UNLIKELY_FILENAME_%%")
%!error <cannot find file> openfig ("%%_A_REALLY_UNLIKELY_FILENAME_%%.fig")
%!error <input argument 3 must be a string>
%! unwind_protect
%! h = figure ("visible", "off");
%! ftmp = [tempname() ".ofig"];
%! hgsave (h, ftmp);
%! openfig (ftmp, "new", [1, 2, 3]);
%! unwind_protect_cleanup
%! unlink (ftmp);
%! close (h);
%! end_unwind_protect
%!error <unknown option 'foobar'>
%! unwind_protect
%! h = figure ("visible", "off");
%! ftmp = [tempname() ".ofig"];
%! hgsave (h, ftmp);
%! openfig (ftmp, "foobar");
%! unwind_protect_cleanup
%! unlink (ftmp);
%! close (h);
%! end_unwind_protect
|
