/usr/share/octave/packages/io-2.0.2/xls2oct.m is in octave-io 2.0.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | ## Copyright (C) 2009,2010,2011,2012,2013 Philip Nienhuis <prnienhuis at users.sf.net>
##
## 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{rawarr}, @var{xls}, @var{rstatus} ] = xls2oct (@var{xls})
## @deftypefnx {Function File} [ @var{rawarr}, @var{xls}, @var{rstatus} ] = xls2oct (@var{xls}, @var{wsh})
## @deftypefnx {Function File} [ @var{rawarr}, @var{xls}, @var{rstatus} ] = xls2oct (@var{xls}, @var{wsh}, @var{range})
## @deftypefnx {Function File} [ @var{rawarr}, @var{xls}, @var{rstatus} ] = xls2oct (@var{xls}, @var{wsh}, @var{range}, @var{options})
##
## Read data contained within cell range @var{range} from worksheet @var{wsh}
## in an Excel spreadsheet file pointed to in struct @var{xls}. Gnumeric
## files can be read as well.
##
## @var{xls} is supposed to have been created earlier by xlsopen in the
## same octave session.
##
## @var{wsh} is either numerical or text, in the latter case it is
## case-sensitive and it may be max. 31 characters long.
## Note that in case of a numerical @var{wsh} this number refers to the
## position in the worksheet stack, counted from the left in an Excel
## window. The default is numerical 1, i.e. the leftmost worksheet
## in the Excel file.
##
## @var{range} is expected to be a regular spreadsheet range format,
## or "" (empty string, indicating all data in a worksheet).
## If no range is specified the occupied cell range will have to be
## determined behind the scenes first; this can take some time for the
## Java-based interfaces. Be aware that in COM/ActiveX interface the
## used range can be outdated. The Java-based interfaces are more
## reliable in this respect albeit much slower.
##
## Optional argument @var{options}, a structure, can be used to
## specify various read modes by setting option fields in the struct
## to true (1) or false (0). Currently recognized option fields are:
##
## @table @asis
## @item "formulas_as_text"
## If set to TRUE or 1, spreadsheet formulas (if at all present)
## are read as formula strings rather than the evaluated formula
## result values. The default value is 0 (FALSE).
##
## @item 'strip_array'
## Set the value of this field set to TRUE or 1 to strip the returned
## output array @var{rawarr} from empty outer columns and rows. The
## spreadsheet cell rectangle limits from where the data actually
## came will be updated. The default value is FALSE or 0 (no cropping).
## When using the COM interface, the output array is always cropped.
## @end table
##
## If only the first argument @var{xls} is specified, xls2oct will try
## to read all contents from the first = leftmost (or the only)
## worksheet (as if a range of @'' (empty string) was specified).
##
## If only two arguments are specified, xls2oct assumes the second
## argument to be @var{wsh}. In that case xls2oct will try to read
## all data contained in that worksheet.
##
## Return argument @var{rawarr} contains the raw spreadsheet cell data.
## Use parsecell() to separate numeric and text values from @var{rawarr}.
##
## Optional return argument @var{xls} contains the pointer struct,
## If any data have been read, field @var{xls}.limits contains the
## outermost column and row numbers of the actually returned cell range.
##
## Optional return argument @var{rstatus} will be set to 1 if the
## requested data have been read successfully, 0 otherwise.
##
## Erroneous data and empty cells turn up empty in @var{rawarr}.
## Date/time values in Excel are returned as numerical values.
## Note that Excel and Octave have different date base values (1/1/1900 &
## 1/1/0000, resp.)
## Be aware that Excel trims @var{rawarr} from empty outer rows & columns,
## so any returned cell array may turn out to be smaller than requested
## in @var{range}, independent of field 'formulas_as_text' in @var{options}.
## When using COM, POI, or UNO interface, formulas in cells are evaluated; if
## that fails cached values are retrieved. These may be outdated depending
## on Excel's "Automatic calculation" settings when the spreadsheet was saved.
##
## When reading from merged cells, all array elements NOT corresponding
## to the leftmost or upper Excel cell will be treated as if the
## "corresponding" Excel cells are empty.
##
## Beware: when the COM interface is used, hidden Excel invocations may be
## kept running silently in case of COM errors.
##
## Examples:
##
## @example
## A = xls2oct (xls1, '2nd_sheet', 'C3:AB40');
## (which returns the numeric contents in range C3:AB40 in worksheet
## '2nd_sheet' from a spreadsheet file pointed to in pointer struct xls1,
## into numeric array A)
## @end example
##
## @example
## [An, xls2, status] = xls2oct (xls2, 'Third_sheet');
## @end example
##
## @seealso {oct2xls, xlsopen, xlsclose, parsecell, xlsread, xlsfinfo, xlswrite }
##
## @end deftypefn
## Author: Philip Nienhuis
## Created: 2010-10-16
## Updates:
## 2009-01-03 (added OOXML support & cleaned up code. Excel
## ADDRESS function still not implemented in Apache POI)
## 2010-03-14 Updated help text
## 2010-05-31 Updated help text (delay i.c.o. empty range due to getusedrange call)
## 2010-07-28 Added option to read formulas as text strings rather than evaluated value
## 2010-08-25 Small typo in help text
## 2010-10-20 Added option fornot stripping output arrays
## 2010-11-07 More rigorous input checks.
## 2010-11-12 Moved pointer check into main func
## 2010-11-13 Catch empty sheets when no range was specified
## 2011-03-26 OpenXLS support added
## 2011-03-29 Test for proper input xls struct extended
## 2011-05-18 Experimental UNO support added
## 2011-09-08 Minor code layout
## 2012-01-26 Fixed "seealso" help string
## 2012-02-25 Fixed missing quotes in struct check L.149-153
## 2012-02-26 Updated texinfo header help text
## 2012-06-06 Implemented "formulas_as_text" option for COM
## 2012-06-07 Replaced all tabs by double space
## 2012-10-12 Moved all interface-specific subfubcs into ./private
## 2012-10-24 Style fixes
## 2013-09-30 Native Octave (OCT) added
## 2013-10-01 Some adaptations for gnumeric
## 2013-10-02 Delete ODS section
## 2013-11-02 Added rstatus return arg for __OCT_xlsx2oct__.m
## 2013-11-08 Added spsh_opts arg for __OCT_xls2oct__.m
##
## Latest subfunc update: 2012-10-12
function [ rawarr, xls, rstatus ] = xls2oct (xls, wsh=1, datrange="", spsh_opts=[])
## Check if xls struct pointer seems valid
if (~isstruct (xls))
error ("File ptr struct expected for arg @ 1");
endif
test1 = ~isfield (xls, "xtype");
test1 = test1 || ~isfield (xls, "workbook");
test1 = test1 || isempty (xls.workbook);
test1 = test1 || isempty (xls.app);
test1 = test1 || ~ischar (xls.xtype);
if test1
error ("Invalid xls file pointer struct");
endif
## Check worksheet ptr
if (~(ischar (wsh) || isnumeric (wsh)))
error ("Integer (index) or text (wsh name) expected for arg # 2");
endif
## Check range
if (~(isempty (datrange) || ischar (datrange)))
error ("Character string expected for arg # 3 (range)");
endif
## Check & setup options struct
if (nargin < 4 || isempty (spsh_opts))
spsh_opts.formulas_as_text = 0;
spsh_opts.strip_array = 1;
## Future options:
elseif (isstruct (spsh_opts))
if (~isfield (spsh_opts, "formulas_as_text"))
spsh_opts.formulas_as_text = 0;
endif
if (~isfield (spsh_opts, "strip_array"))
spsh_opts.strip_array = 1;
endif
## Future options:
else
error ("Structure expected for arg # 4 (options)");
endif
## Select the proper interfaces
if (strcmp (xls.xtype, "COM"))
## Call Excel tru COM / ActiveX server
[rawarr, xls, rstatus] = __COM_spsh2oct__ (xls, wsh, datrange, spsh_opts);
elseif (strcmp (xls.xtype, "POI"))
## Read xls file tru Java POI
[rawarr, xls, rstatus] = __POI_spsh2oct__ (xls, wsh, datrange, spsh_opts);
elseif (strcmp (xls.xtype, "JXL"))
## Read xls file tru JExcelAPI
[rawarr, xls, rstatus] = __JXL_spsh2oct__ (xls, wsh, datrange, spsh_opts);
elseif (strcmp (xls.xtype, "OXS"))
## Read xls file tru OpenXLS
[rawarr, xls, rstatus] = __OXS_spsh2oct__ (xls, wsh, datrange, spsh_opts);
elseif (strcmp (xls.xtype, "UNO"))
## Read xls file tru OpenOffice.org UNO (Java) bridge
[rawarr, xls, rstatus] = __UNO_spsh2oct__ (xls, wsh, datrange, spsh_opts);
elseif (strcmp (xls.xtype, "OCT"))
## Read xls file tru native Octave
if (strcmpi (xls.app, 'xlsx'))
[rawarr, xls, rstatus] = __OCT_xlsx2oct__ (xls, wsh, datrange, spsh_opts);
elseif (strcmpi (xls.app, 'gnumeric'))
[rawarr, xls, rstatus] = __OCT_gnm2oct__ (xls, wsh, datrange);
endif
##elseif ---- <Other interfaces here>
## Call to next interface
else
error (sprintf ("xls2oct: unknown Excel .xls interface - %s.", xls.xtype));
endif
## Optionally strip empty outer rows and columns & keep track of original data location
if (spsh_opts.strip_array)
emptr = cellfun ('isempty', rawarr);
if (all (all (emptr)))
rawarr = {};
xls.limits = [];
else
nrows = size (rawarr, 1); ncols = size (rawarr, 2);
irowt = 1;
while (all (emptr(irowt, :))), irowt++; endwhile
irowb = nrows;
while (all (emptr(irowb, :))), irowb--; endwhile
icoll = 1;
while (all (emptr(:, icoll))), icoll++; endwhile
icolr = ncols;
while (all (emptr(:, icolr))), icolr--; endwhile
## Crop output cell array and update limits
rawarr = rawarr(irowt:irowb, icoll:icolr);
xls.limits = xls.limits + [icoll-1, icolr-ncols; irowt-1, irowb-nrows];
endif
endif
endfunction
|