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
|
########################################################################
##
## 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 file 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 {} {} savefig ()
## @deftypefnx {} {} savefig (@var{h})
## @deftypefnx {} {} savefig (@var{filename})
## @deftypefnx {} {} savefig (@var{h}, @var{filename})
## @deftypefnx {} {} savefig (@var{h}, @var{filename}, @qcode{"compact"})
## Save figure windows specified by graphics handle(s) @var{h} to file
## @var{filename}.
##
## If unspecified, @var{h} is the current figure returned by @code{gcf}.
##
## If unspecified, @var{filename} is set to @file{"Untitled.fig"}. If
## @var{filename} does not have an extension then the default extension
## @file{".fig"} will be added.
##
## If the optional third input @qcode{"compact"} is present then the data
## will be compressed to save more space.
##
## @seealso{hgsave, hdl2struct, openfig}
## @end deftypefn
function savefig (varargin)
if (nargin > 3)
print_usage ();
endif
## Default values for input arguments
h = [];
filename = "Untitled.fig";
fmt = "-binary";
## Check input arguments
if (nargin == 1)
if (all (isfigure (varargin{1})))
h = varargin{1};
elseif (ischar (varargin{1}))
filename = varargin{1};
else
error ("savefig: first argument must be a figure handle or filename");
endif
else
if (! all (isfigure (varargin{1})))
error ("savefig: H must be a valid figure handle");
endif
h = varargin{1};
if (! ischar (varargin{2}))
error ("savefig: FILENAME must be a string");
endif
filename = varargin{2};
if (nargin == 3)
if (strcmpi (varargin{3}, "compact"))
fmt = "-zip";
else
warning ("savefig: unrecognized option '%s'", varargin{3});
endif
endif
endif
## Check figure handle input
if (isempty (h))
h = gcf ();
endif
## Check filename extension
[~, ~, ext] = fileparts (filename);
if (isempty (ext))
filename = [filename ".fig"];
endif
## Save handles to file
hgsave (h, filename, fmt);
endfunction
%!test
%! unwind_protect
%! h = figure ("visible", "off");
%! ftmp = [tempname() ".fig"];
%! savefig (h, ftmp);
%! savefig (ftmp);
%! unwind_protect_cleanup
%! close (h);
%! unlink (ftmp);
%! end_unwind_protect
%!testif HAVE_ZLIB
%! unwind_protect
%! h = figure ("visible", "off");
%! ftmp = [tempname() ".fig"];
%! savefig (h, ftmp, "compact");
%! unwind_protect_cleanup
%! close (h);
%! unlink (ftmp);
%! end_unwind_protect
## Test input validation
%!error savefig (1,2,3,4)
%!error <must be a figure handle or filename> savefig (struct ())
%!error <H must be a valid figure handle> savefig ([0, -1], "foobar")
%!error <FILENAME must be a string>
%! unwind_protect
%! h = figure ("visible", "off");
%! savefig (h, -1);
%! unwind_protect_cleanup
%! close (h);
%! end_unwind_protect
%!warning <unrecognized option 'foobar'>
%! unwind_protect
%! h = figure ("visible", "off");
%! ftmp = [tempname() ".fig"];
%! savefig (h, ftmp, "foobar");
%! unwind_protect_cleanup
%! close (h);
%! unlink (ftmp);
%! end_unwind_protect
|
