Mercurial > hg > octave-nkf

annotate scripts/io/textread.m @ 12679:f38cf6224452 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix textscan/textread headerlines arg always skipping 2 lines (bug #33028) * textread.m, textscan.m: Fix wrong headerline argument being fed to fskipl. Check & avoid processing zero headerline values.
author Philip Nienhuis <prnienhuis@users.sf.net>
date Sun, 15 May 2011 19:15:50 -0700
parents c792872f8942
children abd4093753e0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11469
diff changeset
1 ## Copyright (C) 2009-2011 Eric Chassande-Mottin, CNRS (France)
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
3 ## This file is part of Octave.
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
4 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
6 ## under the terms of the GNU General Public License as published by
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
8 ## your option) any later version.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
9 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
13 ## General Public License for more details.
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
14 ##
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
18
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10627
diff changeset
20 ## @deftypefn {Function File} {[@var{a}, @dots{}] =} textread (@var{filename})
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10627
diff changeset
21 ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format})
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
22 ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format}, @var{prop1}, @var{value1}, @dots{})
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
23 ## Read data from a text file.
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
24 ##
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9746
diff changeset
25 ## The file @var{filename} is read and parsed according to @var{format}. The
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10627
diff changeset
26 ## function behaves like @code{strread} except it works by parsing a file
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10627
diff changeset
27 ## instead
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9746
diff changeset
28 ## of a string. See the documentation of @code{strread} for details.
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
29 ## In addition to the options supported by @code{strread}, this function
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
30 ## supports one more:
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
31 ## @itemize
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
32 ## @item "headerlines":
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
33 ## @end itemize
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
34 ## The first @var{value} number of lines of @var{str} are skipped.
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
35 ## @seealso{strread, load, dlmread, fscanf}
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
36 ## @end deftypefn
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
37
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11104
diff changeset
38 function varargout = textread (filename, format = "%f", varargin)
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
39 ## Check input
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
40 if (nargin < 1)
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
41 print_usage ();
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
42 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
43
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11104
diff changeset
44 if (!ischar (filename) || !ischar (format))
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
45 error ("textread: first and second input arguments must be strings");
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
46 endif
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
47
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
48 ## Read file
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
49 fid = fopen (filename, "r");
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
50 if (fid == -1)
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
51 error ("textread: could not open '%s' for reading", filename);
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
52 endif
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
53
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
54 ## Maybe skip header lines
9828
b96e9239178e fix textread bug
Jaroslav Hajek <highegg@gmail.com>
parents: 9758
diff changeset
55 headerlines = find (strcmpi (varargin, "headerlines"), 1);
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
56 if (! isempty (headerlines))
12679
f38cf6224452 Fix textscan/textread headerlines arg always skipping 2 lines (bug #33028)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 11587
diff changeset
57 hdr_lines = floor (varargin{headerlines + 1});
f38cf6224452 Fix textscan/textread headerlines arg always skipping 2 lines (bug #33028)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 11587
diff changeset
58 ## Beware of zero valued headerline, fskipl will count lines to EOF then
f38cf6224452 Fix textscan/textread headerlines arg always skipping 2 lines (bug #33028)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 11587
diff changeset
59 if (hdr_lines > 0)
f38cf6224452 Fix textscan/textread headerlines arg always skipping 2 lines (bug #33028)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 11587
diff changeset
60 fskipl (fid, hdr_lines);
f38cf6224452 Fix textscan/textread headerlines arg always skipping 2 lines (bug #33028)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 11587
diff changeset
61 endif
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
62 varargin(headerlines:headerlines+1) = [];
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
63 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
64
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
65 str = fread (fid, "char=>char").';
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
66 fclose (fid);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
67
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
68 ## Call strread to make it do the real work
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11104
diff changeset
69 [varargout{1:max (nargout, 1)}] = strread (str, format, varargin {:});
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11104
diff changeset
70
9746
31a22d48f41f scripts/io/strread.m scripts/io/textread.m: new functions
Soren Hauberg <hauberg@gmail.com>
parents:
diff changeset
71 endfunction