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
|
########################################################################
##
## Copyright (C) 2014-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.
##
## 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 file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} hgsave (@var{filename})
## @deftypefnx {} {} hgsave (@var{h}, @var{filename})
## @deftypefnx {} {} hgsave (@var{h}, @var{filename}, @var{fmt})
## Save the graphics handle(s) @var{h} to the file @var{filename} in the format
## @var{fmt}.
##
## If unspecified, @var{h} is the current figure as returned by @code{gcf}.
##
## When @var{filename} does not have an extension the default filename
## extension @file{.ofig} will be appended.
##
## If present, @var{fmt} must be one of the following:
##
## @itemize @bullet
## @item @option{-binary}, @option{-float-binary}
##
## @item @option{-hdf5}, @option{-float-hdf5}
##
## @item @option{-V7}, @option{-v7}, @option{-7}, @option{-mat7-binary}
##
## @item @option{-V6}, @option{-v6}, @option{-6}, @option{-mat6-binary}
##
## @item @option{-text}
##
## @item @option{-zip}, @option{-z}
## @end itemize
##
## The default format is @option{-binary} to minimize storage.
##
## Programming Note: When producing graphics for final publication use
## @code{print} or @code{saveas}. When it is important to be able to continue
## to edit a figure as an Octave object, use @code{hgsave}/@code{hgload}.
## @seealso{hgload, hdl2struct, savefig, saveas, print}
## @end deftypefn
function hgsave (h, filename, fmt = "-binary")
if (nargin < 1)
print_usage ();
endif
## Check input arguments
if (nargin == 1 && ischar (h))
filename = h;
h = get (0, "currentfigure");
if (isempty (h))
error ("hgsave: no current figure to save");
endif
elseif (! (all (ishghandle (h)) && ischar (filename)))
print_usage ();
endif
## Check file extension
[~, ~, ext] = fileparts (filename);
if (isempty (ext))
filename = [filename ".ofig"];
endif
for i = 1:numel (h)
s_oct40(i) = hdl2struct (h(i));
endfor
save (fmt, filename, "s_oct40");
endfunction
%!testif HAVE_MAGICK; (have_window_system () && any (strcmp ("qt", available_graphics_toolkits ())));
%! toolkit = graphics_toolkit ();
%! graphics_toolkit ("qt");
%! h1 = figure ("visible", "off", "paperposition", [0.25, 2.5, 8.0, 6.0]);
%! unwind_protect
%! x = 0:0.1:2*pi;
%! y1 = sin (x);
%! y2 = exp (x - 1);
%! ax = plotyy (x,y1, x-1,y2, @plot, @semilogy);
%! xlabel ("X");
%! ylabel (ax(1), "Axis 1");
%! ylabel (ax(2), "Axis 2");
%! axes (ax(1));
%! text (0.5, 0.5, "Left Axis", ...
%! "color", [0 0 1], "horizontalalignment", "center");
%! axes (ax(2));
%! text (4.5, 80, "Right Axis", ...
%! "color", [0 0.5 0], "horizontalalignment", "center");
%! ftmp = [tempname() ".ofig"];
%! png1 = [tempname() ".png"];
%! png2 = [tempname() ".png"];
%! unwind_protect
%! hgsave (h1, ftmp);
%! print (h1, png1);
%! [img1, map1, alpha1] = imread (png1);
%! h2 = hgload (ftmp);
%! print (h2, png2);
%! [img2, map2, alpha2] = imread (png2);
%! unwind_protect_cleanup
%! unlink (ftmp);
%! unlink (png1);
%! unlink (png2);
%! end_unwind_protect
%! assert (img1, img2);
%! assert (map1, map2);
%! assert (alpha1, alpha2);
%! unwind_protect_cleanup
%! close (h1);
%! close (h2);
%! graphics_toolkit (toolkit);
%! end_unwind_protect
## Test input validation
%!error <Invalid call> hgsave ()
%!error <no current figure to save>
%! unwind_protect
%! old_fig = get (0, "currentfigure");
%! set (0, "currentfigure", []);
%! hgsave ("foobar");
%! unwind_protect_cleanup
%! set (0, "currentfigure", old_fig);
%! end_unwind_protect
%!error hgsave ([0, -1], "foobar")
%!error hgsave (0, { "foobar" })
|
