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
|
## Copyright (C) 2009-2025 Philip Nienhuis
##
## This program 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.
##
## This program 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
## this program; if not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} [@var{xls}] = xlsclose (@var{xls})
## @deftypefnx {Function File} [@var{xls}] = xlsclose (@var{xls}, @var{filename})
## @deftypefnx {Function File} [@var{xls}] = xlsclose (@var{xls}, "FORCE")
## Close a spreadsheet file pointed to in struct @var{xls}, and if needed
## write file to disk.
##
## xlsclose will determine if the file should be written to disk based
## on information contained in @var{xls}. If no errors occured during
## writing, the xls file pointer struct will be reset to empty and -if
## the UNO or COM interface was used- LibreOffice (or OpenOffice.org) or
## ActiveX/Excel will be closed. However if errors occurred, the file pointer
## will be untouched so you can clean up before a next try with xlsclose().@*
## Be warned that until xlsopen is called again with the same @var{xls}
## pointer struct, hidden Excel or Java applications with associated
## (possibly large) memory chunks are kept in memory, taking up resources.
## If (string) argument "FORCE" is supplied, the file pointer will be
## reset regardless, whether the possibly modified file has been saved
## successfully or not. Hidden Excel (COM) or LibreOffice.org (UNO)
## invocations may live on, possibly even impeding proper shutdown of
## Octave.
##
## @var{filename} can be used to write changed spreadsheet files to
## a file other than that opened with xlsopen(); unfortunately this doesn't
## work with JXL (JExcelAPI) interface.
##
## For other file formats than OOXML, ODS or gnumeric, you need a Java JRE
## plus Apache POI > 3.5 and/or JExcelAPI, OpenXLS, jOpenDocument, ODF Toolkit
## and/or LibreOffice or clones, and/or the OF windows package + MS-Excel
## installed on your computer + proper javaclasspath set, to make this
## function work at all.
##
## @var{xls} must be a valid pointer struct made by xlsopen() in the same
## octave session.
##
## Examples:
##
## @example
## xls1 = xlsclose (xls1);
## (Close spreadsheet file pointed to in pointer struct xls1; xls1 is reset)
## @end example
##
## @seealso {xlsopen, xlsread, xlswrite, xls2oct, oct2xls, xlsfinfo}
##
## @end deftypefn
## Author: Philip Nienhuis <prnienhuis at users.sf.net>
## Created: 2009-11-29
function [ xls ] = xlsclose (xls, varargin)
if (isempty (xls))
warning ("xlsclose: file pointer struct was already closed\n");
return
endif
if (nargout < 1)
warning ("xlsclose: return argument missing - spreadsheet pointer not reset.\n");
endif
force = 0;
if (nargin > 1)
for ii=1:nargin-1
if (strcmpi (varargin{ii}, "force"))
## Close pointer anyway even if write errors occur
force = 1;
## Interface-specific clauses here:
elseif (! isempty (strfind (tolower (varargin{ii}), ".")))
## Apparently a file name. First some checks....
if (xls.changed == 0 || xls.changed > 2)
warning ("xlsclose: file %s wasn't changed, new filename ignored.\n", ...
xls.filename);
elseif (strcmp (xls.xtype, "JXL"))
error (["xlsclose: JXL doesn't support changing filename, new ", ...
"filename ignored.\n"]);
elseif (isempty (cell2mat (cell2mat (regexp (lower (varargin{ii}), ...
'.*?(\.xls[xm]{0,1}$|\.ods$|\.gnumeric$)', "tokens")))) && ...
(! (strcmp (xls.xtype, "COM") || strcmp (xls.xtype, "UNO"))))
## Excel/ActiveX && OOo (UNO bridge) will write any valid filetype;
## POI/JXL/OXS need .xls[x], JOD/OTK need .ods, OCT nees ods/xlsx/gnumeric
error ("xlsclose: proper suffix lacking in filename %s\n", ...
varargin{ii});
else
## For multi-user environments, uncomment below AND relevant stanza in xlsopen
## In case of COM, be sure to first close the open workbook
##if (strcmp (xls.xtype, 'COM'))
## xls.app.Application.DisplayAlerts = 0;
## xls.workbook.close();
## xls.app.Application.DisplayAlerts = 0;
##endif
## Preprocessing / -checking ready. Assign filename arg to file ptr struct
xls.nfilename = varargin{ii};
endif
endif
endfor
endif
unwind_protect
switch upper (xls.xtype)
case "COM"
## COM / ActiveX
xls = __COM_spsh_close__ (xls);
case "JOD"
## Java & jOpenDocument
xls = __JOD_spsh_close__ (xls);
case "JXL"
## Java and jExcelAPI
xls = __JXL_spsh_close__ (xls);
case "OTK"
## Java & ODF toolkit
xls = __OTK_spsh_close__ (xls, force);
case "OXS"
## Java and OpenXLS
xls = __OXS_spsh_close__ (xls);
case "POI"
## Java and Apache POI
xls = __POI_spsh_close__ (xls);
case "UNO"
## Java and LibreOffice / OOo
xls = __UNO_spsh_close__ (xls, force);
case "OCT"
## Native Octave
xls = __OCT_spsh_close__ (xls, "xlsclose", force);
otherwise
## Cannot happen theoretically
error ("xlsclose: unknown interface - %s", xls.xtype);
endswitch
unwind_protect_cleanup
if (xls.changed && xls.changed < 3)
warning (sprintf (['xlsclose: file %s could not be saved.\n', ...
"No write permission? unsupported file format? in use elsewhere?\n"], ...
xls.filename));
if (force)
xls = [];
else
printf (["(File pointer preserved.\n Try saving again later, or ", ...
"with different file name, or as different file type.)\n"]);
endif
else
xls = [];
endif
end_unwind_protect
endfunction
|
