octave-nkf: scripts/io/textscan.m annotate

annotate scripts/io/textscan.m @ 12866:fe6e2afcd9ee

Revamp strread, textscan, textread functions for Matlab compatability Implemented ML-compatible whitespace and delimiter defaults Implemented ML-compatible options: 'whitespace', treatasempty', format string repeat count, user-specified comment style, uneven-length output arrays, %n and %u conversion specifiers (provisionally) Implemented processing of given-width format specifiers * textscan.m: Add new tests. Implement EndofLine, ReturnOnError, TreatAsEmpty options. Improve whitespace handling. * textread.m: Add new tests Implement EndofLine option. Improve whitespace handling. * strread.m: Major rewrite.

author	Philip Nienhuis <prnienhuis@users.sf.net>
date	Fri, 22 Jul 2011 13:05:26 -0700
parents	f38cf6224452
children	e8c8e118a1e6

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11472 diff changeset	1 ## Copyright (C) 2010-2011 Ben Abbott <bpabbott@mac.com>
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	2 ##
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	3 ## This file is part of Octave.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	4 ##
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	8 ## your option) any later version.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	9 ##
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	13 ## General Public License for more details.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	14 ##
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	18
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	19 ## -- texinfo --
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 11469 diff changeset	20 ## @deftypefn {Function File} {@var{C} =} textscan (@var{fid}, @var{format})
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	21 ## @deftypefnx {Function File} {@var{C} =} textscan (@var{fid}, @var{format}, @var{n})
d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	22 ## @deftypefnx {Function File} {@var{C} =} textscan (@var{fid}, @var{format}, @var{param}, @var{value}, @dots{})
d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	23 ## @deftypefnx {Function File} {@var{C} =} textscan (@var{fid}, @var{format}, @var{n}, @var{param}, @var{value}, @dots{})
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 11469 diff changeset	24 ## @deftypefnx {Function File} {@var{C} =} textscan (@var{str}, @dots{})
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 11469 diff changeset	25 ## @deftypefnx {Function File} {[@var{C}, @var{position}] =} textscan (@dots{})
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	26 ## Read data from a text file.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	27 ##
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	28 ## The file associated with @var{fid} is read and parsed according to
3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	29 ## @var{format}. The function behaves like @code{strread} except it works by
3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	30 ## parsing a file instead of a string. See the documentation of
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	31 ## @code{strread} for details.
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	32 ##
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	33 ## In addition to the options supported by
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	34 ## @code{strread}, this function supports a few more:
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	35 ##
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	36 ## @itemize
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	37 ## @item "headerlines":
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	38 ## The first @var{value} number of lines of @var{str} are skipped.
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	39 ##
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	40 ## @item "endofline":
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	41 ## Specify a single character or "\r\n". If no value is given, it will be
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	42 ## inferred from the file. If set to "" (empty string) EOLs are ignored as
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	43 ## delimiters.
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	44 ##
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	45 ## @item "returnonerror":
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	46 ## If set to numerical 1 or true (default), return normally when read errors
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	47 ## have been encountered. If set to 0 or false, return an error and no data.
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	48 ## @end itemize
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	49 ##
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	50 ## The optional input, @var{n}, specifes the number of lines to be read from
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	51 ## the file, associated with @var{fid}.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	52 ##
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 11469 diff changeset	53 ## The output, @var{C}, is a cell array whose length is given by the number
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	54 ## of format specifiers.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	55 ##
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	56 ## The second output, @var{position}, provides the position, in characters,
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	57 ## from the beginning of the file.
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	58 ##
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	59 ## @seealso{dlmread, fscanf, load, strread, textread}
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	60 ## @end deftypefn
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	61
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	62 function [C, position] = textscan (fid, format = "%f", varargin)
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	63
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	64 ## Check input
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	65 if (nargin < 1)
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	66 print_usage ();
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	67 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	68
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	69 if (isempty (format))
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11191 diff changeset	70 format = "%f";
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	71 endif
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	72
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	73 if (! (isa (fid, "double") && fid > 0) && ! ischar (fid))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	74 error ("textscan: first argument must be a file id or character string");
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	75 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	76
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	77 if (! ischar (format))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	78 error ("textscan: FORMAT must be a valid specification");
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	79 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	80
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	81 if (nargin > 2 && isnumeric (varargin{1}))
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	82 nlines = varargin{1};
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	83 args = varargin(2:end);
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	84 else
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	85 nlines = Inf;
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	86 args = varargin;
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	87 endif
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	88
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	89 if (! any (strcmpi (args, "emptyvalue")))
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	90 ## Matlab returns NaNs for missing values
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	91 args{end+1} = "emptyvalue";
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	92 args{end+1} = NaN;
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	93 endif
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	94
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	95 ## Check default parameter values that differ for strread & textread
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	96
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	97 ipos = find (strcmpi (args, "whitespace"));
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	98 if (isempty (ipos))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	99 ## Matlab default whitespace = " \b\t"
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	100 args{end+1} = "whitespace";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	101 args{end+1} = " \b\t";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	102 whitespace = " \b\t";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	103 else
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	104 ## Check if there's at least one string format specifier
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	105 fmt = strrep (format, "%", " %");
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	106 [~, ~, ~, fmt] = regexp (fmt, '[^ ]+');
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	107 fmt = strtrim (fmt(strmatch ("%", fmt)))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	108 has_str_fmt = all (cellfun ("isempty", strfind (strtrim (fmt(strmatch ("%", fmt))), 's')));
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	109 ## If there is a format, AND whitespace value = empty,
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	110 ## don't add a space (char(32)) to whitespace
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	111 if (! (isempty (args{ipos+1}) && has_str_fmt))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	112 args {ipos+1} = unique ([" " whitespace]);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	113 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	114 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	115
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	116 if (! any (strcmpi (args, "delimiter")))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	117 ## Matlab says default delimiter = whitespace.
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	118 ## strread() will pick this up further
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	119 args{end+1} = "delimiter";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	120 args{end+1} = "";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	121 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	122
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	123 if (any (strcmpi (args, "returnonerror")))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	124 ## Because of the way strread() reads data (columnwise) this parameter
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	125 ## can't be neatly implemented. strread() will pick it up anyway
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	126 warning ('ReturnOnError is not fully implemented');
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	127 else
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	128 ## Set default value (=true)
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	129 args{end+1} = "returnonerror";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	130 args{end+1} = 1;
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	131 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	132
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	133 if (ischar (fid))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	134 ## Read from a text string
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	135 if (nargout == 2)
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	136 error ("textscan: cannot provide position information for character input");
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	137 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	138 str = fid;
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	139 else
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	140 ## Skip header lines if requested
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	141 headerlines = find (strcmpi (args, "headerlines"), 1);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	142 ## Beware of zero valued headerline, fskipl would skip to EOF
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	143 if (! isempty (headerlines) && (args{headerlines + 1} > 0))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	144 fskipl (fid, varargin{headerlines + 1});
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	145 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	146 if (isfinite (nlines))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	147 str = "";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	148 ## FIXME: Can this be done without slow for loop?
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	149 for n = 1:nlines
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	150 str = strcat (str, fgets (fid));
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	151 endfor
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	152 else
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	153 str = fread (fid, "char=>char").';
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	154 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	155 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	156
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	157 ## Check for empty result
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	158 if (isempty (str))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	159 warning ("textscan: no data read");
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	160 C = [];
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	161 else
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	162 ## Check value of 'endofline'. String or file doesn't seem to matter
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	163 endofline = find (strcmpi (args, "endofline"), 1);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	164 if (! isempty (endofline))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	165 if (! ischar (args{endofline + 1}))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	166 error ("textscan: character value required for EndOfLine");
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	167 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	168 else
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	169 ## Determine EOL from file. Search for EOL candidates in first 3000 chars
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	170 BUFLEN = 3000;
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	171 ## First try DOS (CRLF)
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	172 eol_srch_len = min (length (str), 3000);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	173 if (! isempty (findstr ("\r\n", str(1 : eol_srch_len))))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	174 eol_char = "\r\n";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	175 ## Perhaps old Macintosh? (CR)
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	176 elseif (! isempty (findstr ("\r", str(1 : eol_srch_len))))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	177 eol_char = "\r";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	178 ## Otherwise, use plain UNIX (LF)
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	179 else
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	180 eol_char = "\n";
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	181 endif
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	182 ## Set up the default endofline param value
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	183 args{end+1} = "endofline";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	184 args{end+1} = eol_char;
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	185 endif
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	186
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	187 ## Determine the number of data fields
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	188 num_fields = numel (strfind (format, "%")) - ...
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	189 numel (idx_star = strfind (format, "%*"));
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	190
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	191 ## Strip trailing EOL to avoid returning stray missing values (f. strread)
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	192 if (strcmp (str(end-length (eol_char) + 1 : end), eol_char));
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	193 str = str(1 : end-length (eol_char));
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	194 endif
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	195
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	196 ## Call strread to make it do the real work
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	197 C = cell (1, num_fields);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	198 [C{:}] = strread (str, format, args{:});
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	199
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	200 if (ischar (fid) && isfinite (nlines))
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	201 C = cellfun (@(x) x(1:nlines), C, "uniformoutput", false);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	202 endif
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	203
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	204 if (nargout == 2)
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	205 position = ftell (fid);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	206 endif
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	207
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	208 endif
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	209
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	210 endfunction
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	211
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	212
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	213 %!test
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	214 %! str = "1, 2, 3, 4\n 5, , , 8\n 9, 10, 11, 12";
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	215 %! fmtstr = "%f %d %f %s";
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	216 %! c = textscan (str, fmtstr, 2, "delimiter", ",", "emptyvalue", -Inf);
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	217 %! assert (isequal (c{1}, [1;5]));
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	218 %! assert (length (c{1}), 2);
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	219 %! assert (iscellstr (c{4}));
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	220 %! assert (isequal (c{3}, [3; -Inf]));
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	221
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	222 %!test
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	223 %! b = [10:10:100];
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	224 %! b = [b; 8*b/5];
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	225 %! str = sprintf ("%g miles/hr = %g kilometers/hr\n", b);
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	226 %! fmt = "%f miles/hr = %f kilometers/hr";
224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	227 %! c = textscan (str, fmt);
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	228 %! assert (b(1,:)', c{1});
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	229 %! assert (b(2,:)', c{2});
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	230
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	231 #%!test
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	232 #%! str = "13, 72, NA, str1, 25\r\n// Middle line\r\n36, na, 05, str3, 6";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	233 #%! a = textscan(str, '%d %n %f %s %n', 'delimiter', ',','treatAsEmpty', {'NA', 'na'},'commentStyle', '//');
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	234 #%! assert (a{1}, [13; 36]);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	235 #%! assert (a{2}, [72; NaN]);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	236 #%! assert (a{3}, [NaN; 5]);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	237 #%! assert (a{4}, {"str1"; "str3"});
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	238 #%! assert (a{5}, [25; 6]);
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	239
12866 fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	240 %!test
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	241 %! str = "Km:10 = hhhBjjj miles16hour\r\n";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	242 %! str = [str "Km:15 = hhhJjjj miles241hour\r\n"];
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	243 %! str = [str "Km:2 = hhhRjjj miles3hour\r\n"];
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	244 %! str = [str "Km:25 = hhhZ\r\n"];
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	245 %! fmt = "Km:%d = hhh%1sjjj miles%dhour";
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	246 %! a = textscan (str, fmt, 'delimiter', ' ');
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	247 %! assert (a{1}', [10 15 2 25], 1e-5);
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	248 %! assert (a{2}', {'B' 'J' 'R' 'Z'});
fe6e2afcd9ee Revamp strread, textscan, textread functions for Matlab compatability Philip Nienhuis <prnienhuis@users.sf.net> parents: 12679 diff changeset	249 %! assert (a{3}', [16 241 3 NaN], 1e-5);
11141 224c80da37c5 textscan.m: Add new function. Ben Abbott <bpabbott@mac.com> parents: diff changeset	250

Mercurial > hg > octave-nkf

annotate scripts/io/textscan.m @ 12866:fe6e2afcd9ee