/usr/share/octave/packages/3.2/io-1.0.14/xls2oct.m is in octave-io 1.0.14-2.
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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 | ## Copyright (C) 2009,2010 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 2 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 Octave; see the file COPYING. 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 range @var{range} from worksheet @var{wsh}
## in an Excel spreadsheet file pointed to in struct @var{xls}.
##
## @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 Excel/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. Currently the only option field is
## "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. This only works for the Java
## based interfaces (POI and JXL).
##
## If only the first argument 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.
## Optional return argument @var{xls} contains the pointer struct,
## @var{rstatus} will be set to 1 if the requested data have been read
## successfully, 0 otherwise.
## Use parsecell() to separate numeric and text values from @var{rawarr}.
##
## @var{xls} is supposed to have been created earlier by xlsopen in the
## same octave session. It is only referred to, not changed.
##
## If one of the Java interfaces is used, field @var{xls}.limits contains
## the outermost column and row numbers of the actually read cell range.
##
## 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}.
## When using COM or POI 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
##
## Latest subfunc update: 2010-11-14 (poi)
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);
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 (range) expected for arg # 3"); 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");
endif
# Select the proper interfaces
if (strcmp (xls.xtype, 'COM'))
# Call Excel tru COM server. Excel/COM has no way of returning formulas
# as strings, so arg spsh_opts has no use (yet)
[rawarr, xls, rstatus] = xls2com2oct (xls, wsh, datrange);
elseif (strcmp (xls.xtype, 'POI'))
# Read xls file tru Java POI
[rawarr, xls, rstatus] = xls2jpoi2oct (xls, wsh, datrange, spsh_opts);
elseif (strcmp (xls.xtype, 'JXL'))
# Read xls file tru JExcelAPI
[rawarr, xls, rstatus] = xls2jxla2oct (xls, wsh, datrange, spsh_opts);
# 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
#====================================================================================
## Copyright (C) 2009,2010 P.R. Nienhuis, <pr.nienhuis at hccnet.nl>
##
## based on mat2xls by Michael Goffioul (2007) <michael.goffioul@swing.be>
##
## 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 2 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{obj}, @var{rstatus}, @var{xls} ] = xls2com2oct (@var{xls})
## @deftypefnx {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2com2oct (@var{xls}, @var{wsh})
## @deftypefnx {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2com2oct (@var{xls}, @var{wsh}, @var{range})
## Get cell contents in @var{range} in worksheet @var{wsh} in an Excel
## file pointed to in struct @var{xls} into the cell array @var{obj}.
##
## xls2com2oct should not be invoked directly but rather through xls2oct.
##
## Examples:
##
## @example
## [Arr, status, xls] = xls2com2oct (xls, 'Second_sheet', 'B3:AY41');
## Arr = xls2com2oct (xls, 'Second_sheet');
## @end example
##
## @seealso xls2oct, oct2xls, xlsopen, xlsclose, xlsread, xlswrite
##
## @end deftypefn
## Author: Philip Nienhuis
## Created: 2009-09-23
## Last updates:
## 2009-12-11 <forgot what it was>
## 2010-10-07 Implemented limits (only reliable for empty input ranges)
## 2010-10-08 Resulting data array now cropped (also in case of specified range)
## 2010-10-10 More code cleanup (shuffled xls tests & wsh ptr code before range checks)
## 2010-10-20 Slight change to Excel range setup
## 2010-10-24 Added check for "live" ActiveX server
## 2010-11-12 Moved ptr struct check into main func
## 2010-11-13 Catch empty sheets when no range was specified
function [rawarr, xls, rstatus ] = xls2com2oct (xls, wsh, crange)
rstatus = 0; rawarr = {};
# Basic checks
if (nargin < 2) error ("xls2com2oct needs a minimum of 2 arguments."); endif
if (size (wsh, 2) > 31)
warning ("Worksheet name too long - truncated")
wsh = wsh(1:31);
endif
app = xls.app;
wb = xls.workbook;
# Check to see if ActiveX is still alive
try
wb_cnt = wb.Worksheets.count;
catch
error ("ActiveX invocation in file ptr struct seems non-functional");
end_try_catch
# Check & get handle to requested worksheet
wb_cnt = wb.Worksheets.count;
old_sh = 0;
if (isnumeric (wsh))
if (wsh < 1 || wsh > wb_cnt)
errstr = sprintf ("Worksheet number: %d out of range 1-%d", wsh, wb_cnt);
error (errstr)
rstatus = 1;
return
else
old_sh = wsh;
endif
else
# Find worksheet number corresponding to name in wsh
wb_cnt = wb.Worksheets.count;
for ii =1:wb_cnt
sh_name = wb.Worksheets(ii).name;
if (strcmp (sh_name, wsh)) old_sh = ii; endif
endfor
if (~old_sh)
errstr = sprintf ("Worksheet name \"%s\" not present", wsh);
error (errstr)
else
wsh = old_sh;
endif
endif
sh = wb.Worksheets (wsh);
nrows = 0;
if ((nargin == 2) || (isempty (crange)))
allcells = sh.UsedRange;
# Get actually used range indices
[trow, brow, lcol, rcol] = getusedrange (xls, old_sh);
if (trow == 0 && brow == 0)
# Empty sheet
rawarr = {};
printf ("Worksheet '%s' contains no data\n", sh.Name);
return;
else
nrows = brow - trow + 1; ncols = rcol - lcol + 1;
topleft = calccelladdress (trow, lcol);
lowerright = calccelladdress (brow, rcol);
crange = [topleft ':' lowerright];
endif
else
# Extract top_left_cell from range
[topleft, nrows, ncols, trow, lcol] = parse_sp_range (crange);
brow = trow + nrows - 1;
rcol = lcol + ncols - 1;
endif;
if (nrows >= 1)
# Get object from Excel sheet, starting at cell top_left_cell
rr = sh.Range (crange);
rawarr = rr.Value;
delete (rr);
# Take care of actual singe cell range
if (isnumeric (rawarr) || ischar (rawarr))
rawarr = {rawarr};
endif
# If we get here, all seems to have gone OK
rstatus = 1;
# Keep track of data rectangle limits
xls.limits = [lcol, rcol; trow, brow];
else
error ("No data read from Excel file");
rstatus = 0;
endif
endfunction
#==================================================================================
## Copyright (C) 2009,2010 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 2 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 Octave; see the file COPYING. If not, see
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2jpoi2oct (@var{xls})
## @deftypefnx {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2jpoi2oct (@var{xls}, @var{wsh})
## @deftypefnx {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2jpoi2oct (@var{xls}, @var{wsh}, @var{range})
## Get cell contents in @var{range} in worksheet @var{wsh} in an Excel
## file pointed to in struct @var{xls} into the cell array @var{obj}.
## @var{range} can be a range or just the top left cell of the range.
##
## xls2jpoi2oct should not be invoked directly but rather through xls2oct.
##
## Examples:
##
## @example
## [Arr, status, xls] = xls2jpoi2oct (xls, 'Second_sheet', 'B3:AY41');
## B = xls2jpoi2oct (xls, 'Second_sheet', 'B3');
## @end example
##
## @seealso xls2oct, oct2xls, xlsopen, xlsclose, xlsread, xlswrite, oct2jpoi2xls
##
## @end deftypefn
## Author: Philip Nienhuis
## Created: 2009-11-23
## Updates:
## 2010-01-11 Fall back to cached values when formula evaluator fails
## 2010-03-14 Fixed max column nr for OOXML for empty given range
## 2010-07-28 Added option to read formulas as text strings rather than evaluated value
## 2010-08-01 Some bug fixes for formula reading (cvalue rather than scell)
## 2010-10-10 Code cleanup: -getusedrange called; - fixed typo in formula evaluation msg;
## " moved cropping output array to calling function.
## 2010-11-12 Moved ptr struct check into main func
## 2010-11-13 Catch empty sheets when no range was specified
## 2010-11-14 Fixed sheet # index (was offset by -1) in call to getusedrange() in case
#3 of text sheet name arg
function [ rawarr, xls, status ] = xls2jpoi2oct (xls, wsh, cellrange=[], spsh_opts)
persistent ctype;
if (isempty (ctype))
# Get enumerated cell types. Beware as they start at 0 not 1
ctype(1) = java_get ('org.apache.poi.ss.usermodel.Cell', 'CELL_TYPE_NUMERIC');
ctype(2) = java_get ('org.apache.poi.ss.usermodel.Cell', 'CELL_TYPE_STRING');
ctype(3) = java_get ('org.apache.poi.ss.usermodel.Cell', 'CELL_TYPE_FORMULA');
ctype(4) = java_get ('org.apache.poi.ss.usermodel.Cell', 'CELL_TYPE_BLANK');
ctype(5) = java_get ('org.apache.poi.ss.usermodel.Cell', 'CELL_TYPE_BOOLEAN');
ctype(6) = java_get ('org.apache.poi.ss.usermodel.Cell', 'CELL_TYPE_ERROR');
endif
status = 0; jerror = 0;
wb = xls.workbook;
# Check if requested worksheet exists in the file & if so, get pointer
nr_of_sheets = wb.getNumberOfSheets ();
if (isnumeric (wsh))
if (wsh > nr_of_sheets), error (sprintf ("Worksheet # %d bigger than nr. of sheets (%d) in file %s", wsh, nr_of_sheets, xls.filename)); endif
sh = wb.getSheetAt (wsh - 1); # POI sheet count 0-based
printf ("(Reading from worksheet %s)\n", sh.getSheetName ());
else
sh = wb.getSheet (wsh);
if (isempty (sh)), error (sprintf ("Worksheet %s not found in file %s", wsh, xls.filename)); endif
end
# Check ranges
firstrow = sh.getFirstRowNum (); # 0-based
lastrow = sh.getLastRowNum (); # 0-based
if (isempty (cellrange))
if (ischar (wsh))
# get numeric sheet index
ii = wb.getSheetIndex (sh) + 1;
else
ii = wsh;
endif
[ firstrow, lastrow, lcol, rcol ] = getusedrange (xls, ii);
if (firstrow == 0 && lastrow == 0)
# Empty sheet
rawarr = {};
printf ("Worksheet '%s' contains no data\n", sh.getSheetName ());
rstatus = 1;
return;
else
nrows = lastrow - firstrow + 1;
ncols = rcol - lcol + 1;
endif
else
# Translate range to HSSF POI row & column numbers
[topleft, nrows, ncols, firstrow, lcol] = parse_sp_range (cellrange);
lastrow = firstrow + nrows - 1;
rcol = lcol + ncols - 1;
endif
# Create formula evaluator (needed to infer proper cell type into rawarr)
frm_eval = wb.getCreationHelper().createFormulaEvaluator ();
# Read contents into rawarr
rawarr = cell (nrows, ncols); # create placeholder
for ii = firstrow:lastrow
irow = sh.getRow (ii-1);
if ~isempty (irow)
scol = (irow.getFirstCellNum).intValue ();
ecol = (irow.getLastCellNum).intValue () - 1;
for jj = lcol:rcol
scell = irow.getCell (jj-1);
if ~isempty (scell)
# Explore cell contents
type_of_cell = scell.getCellType ();
if (type_of_cell == ctype(3)) # Formula
if ~(spsh_opts.formulas_as_text)
try # Because not al Excel formulas have been implemented
cvalue = frm_eval.evaluate (scell);
type_of_cell = cvalue.getCellType();
# Separate switch because form.eval. yields different type
switch type_of_cell
case ctype (1) # Numeric
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getNumberValue ();
case ctype(2) # String
rawarr {ii+1-firstrow, jj+1-lcol} = char (scell.getStringValue ());
case ctype (5) # Boolean
rawarr {ii+1-firstrow, jj+1-lcol} = scell.BooleanValue ();
otherwise
# Nothing to do here
endswitch
# Set cell type to blank to skip switch below
type_of_cell = ctype(4);
catch
# In case of formula errors we take the cached results
type_of_cell = scell.getCachedFormulaResultType ();
++jerror; # We only need one warning even for multiple errors
end_try_catch
endif
endif
# Preparations done, get data values into data array
switch type_of_cell
case ctype(1) # 0 Numeric
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getNumericCellValue ();
case ctype(2) # 1 String
rawarr {ii+1-firstrow, jj+1-lcol} = char (scell.getRichStringCellValue ());
case ctype(3)
if (spsh_opts.formulas_as_text)
tmp = char (scell.getCellFormula ());
rawarr {ii+1-firstrow, jj+1-lcol} = ['=' tmp];
endif
case ctype(4) # 3 Blank
# Blank; ignore until further notice
case ctype(5) # 4 Boolean
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getBooleanCellValue ();
otherwise # 5 Error
# Ignore
endswitch
endif
endfor
endif
endfor
if (jerror > 0) warning (sprintf ("xls2oct: %d cached values instead of formula evaluations.\n", jerror)); endif
status = 1;
xls.limits = [lcol, rcol; firstrow, lastrow];
endfunction
#==================================================================================
## Copyright (C) 2009 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 2 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 Octave; see the file COPYING. If not, see
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2jxla2oct (@var{xls})
## @deftypefnx {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2jxla2oct (@var{xls}, @var{wsh})
## @deftypefnx {Function File} [@var{obj}, @var{rstatus}, @var{xls} ] = xls2jxla2oct (@var{xls}, @var{wsh}, @var{range})
## Get cell contents in @var{range} in worksheet @var{wsh} in an Excel
## file pointed to in struct @var{xls} into the cell array @var{obj}.
## @var{range} can be a range or just the top left cell of the range.
##
## xls2jxla2oct should not be invoked directly but rather through xls2oct.
##
## Examples:
##
## @example
## [Arr, status, xls] = xls2jxla2oct (xls, 'Second_sheet', 'B3:AY41');
## B = xls2jxla2oct (xls, 'Second_sheet');
## @end example
##
## @seealso xls2oct, oct2xls, xlsopen, xlsclose, xlsread, xlswrite, oct2jxla2xls
##
## @end deftypefn
## Author: Philip Nienhuis
## Created: 2009-12-04
## Updates:
## 2009-12-11 ??? some bug fix
## 2010-07-28 Added option to read formulas as text strings rather than evaluated value
## Added check for proper xls structure
## 2010-07-29 Added check for too latge requested data rectangle
## 2010-10-10 Code cleanup: -getusedrange(); moved cropping result array to
## " calling function
## 2010-11-12 Moved ptr struct check into main func
## 2010-11-13 Catch empty sheets when no range was specified
function [ rawarr, xls, status ] = xls2jxla2oct (xls, wsh, cellrange=[], spsh_opts)
persistent ctype;
if (isempty (ctype))
ctype = cell (11, 1);
# Get enumerated cell types. Beware as they start at 0 not 1
ctype( 1) = (java_get ('jxl.CellType', 'BOOLEAN')).toString ();
ctype( 2) = (java_get ('jxl.CellType', 'BOOLEAN_FORMULA')).toString ();
ctype( 3) = (java_get ('jxl.CellType', 'DATE')).toString ();
ctype( 4) = (java_get ('jxl.CellType', 'DATE_FORMULA')).toString ();
ctype( 5) = (java_get ('jxl.CellType', 'EMPTY')).toString ();
ctype( 6) = (java_get ('jxl.CellType', 'ERROR')).toString ();
ctype( 7) = (java_get ('jxl.CellType', 'FORMULA_ERROR')).toString ();
ctype( 8) = (java_get ('jxl.CellType', 'NUMBER')).toString ();
ctype( 9) = (java_get ('jxl.CellType', 'LABEL')).toString ();
ctype(10) = (java_get ('jxl.CellType', 'NUMBER_FORMULA')).toString ();
ctype(11) = (java_get ('jxl.CellType', 'STRING_FORMULA')).toString ();
endif
status = 0;
wb = xls.workbook;
# Check if requested worksheet exists in the file & if so, get pointer
nr_of_sheets = wb.getNumberOfSheets ();
shnames = char (wb.getSheetNames ());
if (isnumeric (wsh))
if (wsh > nr_of_sheets), error (sprintf ("Worksheet # %d bigger than nr. of sheets (%d) in file %s", wsh, nr_of_sheets, xls.filename)); endif
sh = wb.getSheet (wsh - 1); # POI sheet count 0-based
printf ("(Reading from worksheet %s)\n", shnames {wsh});
else
sh = wb.getSheet (wsh);
if (isempty (sh)), error (sprintf ("Worksheet %s not found in file %s", wsh, xls.filename)); endif
end
if (isempty (cellrange))
# Get numeric sheet pointer (1-based)
ii = 1;
while (ii <= nr_of_sheets)
if (strcmp (wsh, shnames{ii}) == 1)
wsh = ii;
ii = nr_of_sheets + 1;
else
++ii;
endif
endwhile
# Get data rectangle row & column numbers (1-based)
[firstrow, lastrow, lcol, rcol] = getusedrange (xls, wsh);
if (firstrow == 0 && lastrow == 0)
# Empty sheet
rawarr = {};
printf ("Worksheet '%s' contains no data\n", shnames {wsh});
rstatus = 1;
return;
else
nrows = lastrow - firstrow + 1;
ncols = rcol - lcol + 1;
endif
else
# Translate range to row & column numbers (1-based)
[dummy, nrows, ncols, firstrow, lcol] = parse_sp_range (cellrange);
# Check for too large requested range against actually present range
lastrow = min (firstrow + nrows - 1, sh.getRows ());
nrows = min (nrows, sh.getRows () - firstrow + 1);
ncols = min (ncols, sh.getColumns () - lcol + 1);
rcol = lcol + ncols - 1;
endif
# Read contents into rawarr
rawarr = cell (nrows, ncols); # create placeholder
for jj = lcol : rcol
for ii = firstrow:lastrow
scell = sh.getCell (jj-1, ii-1);
switch char (scell.getType ())
case ctype {1} # Boolean
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getValue ();
case ctype {2} # Boolean formula
if (spsh_opts.formulas_as_text)
tmp = scell.getFormula ();
rawarr {ii+1-firstrow, jj+1-lcol} = ["=" tmp];
else
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getValue ();
endif
case ctype {3} # Date
try
% Older JXL.JAR, returns float
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getValue ();
catch
% Newer JXL.JAR, returns date string w. epoch = 1-1-1900 :-(
tmp = strsplit (' ', char (scell.getDate ()));
yy = str2num (tmp{6});
mo = find (ismember (months, upper (tmp{2})) == 1);
dd = str2num (tmp{3});
hh = str2num (tmp{4}(1:2));
mi = str2num (tmp{4}(4:5));
ss = str2num (tmp{4}(7:8));
if (~scell.isTime ())
yy = mo = dd = 0;
endif
rawarr {ii+1-firstrow, jj+1-lcol} = datenum (yy, mo, dd, hh, mi, ss);
end_try_catch
case ctype {4} # Date formula
if (spsh_opts.formulas_as_text)
tmp = scell.getFormula ();
rawarr {ii+1-firstrow, jj+1-lcol} = ["=" tmp];
else
unwind_protect
% Older JXL.JAR, returns float
tmp = scell.getValue ();
% if we get here, we got a float (old JXL).
% Check if it is time
if (~scell.isTime ())
% Reset rawarr <> so it can be processed below as date string
rawarr {ii+1-firstrow, jj+1-lcol} = [];
else
rawarr {ii+1-firstrow, jj+1-lcol} = tmp;
end
unwind_protect_cleanup
if (isempty (rawarr {ii+1-firstrow, jj+1-lcol}))
% Newer JXL.JAR, returns date string w. epoch = 1-1-1900 :-(
tmp = strsplit (' ', char (scell.getDate ()));
yy = str2num (tmp{6});
mo = find (ismember (months, upper (tmp{2})) == 1);
dd = str2num (tmp{3});
hh = str2num (tmp{4}(1:2));
mi = str2num (tmp{4}(4:5));
ss = str2num (tmp{4}(7:8));
if (scell.isTime ())
yy = 0; mo = 0; dd = 0;
end
rawarr {ii+1-firstrow, jj+1-lcol} = datenum (yy, mo, dd, hh, mi, ss);
endif
end_unwind_protect
endif
case { ctype {5}, ctype {6}, ctype {7} }
# Empty, Error or Formula error. Nothing to do here
case ctype {8} # Number
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getValue ();
case ctype {9} # String
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getString ();
case ctype {10} # Numerical formula
if (spsh_opts.formulas_as_text)
tmp = scell.getFormula ();
rawarr {ii+1-firstrow, jj+1-lcol} = ["=" tmp];
else
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getValue ();
endif
case ctype {11} # String formula
if (spsh_opts.formulas_as_text)
tmp = scell.getFormula ();
rawarr {ii+1-firstrow, jj+1-lcol} = ["=" tmp];
else
rawarr {ii+1-firstrow, jj+1-lcol} = scell.getString ();
endif
otherwise
# Do nothing
endswitch
endfor
endfor
status = 1;
xls.limits = [lcol, rcol; firstrow, lastrow];
endfunction
|