Mercurial > octave
annotate libinterp/corefcn/file-io.cc @ 21724:aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
* configure.ac, Doxyfile.in, make_int.cc, Backend.cc, BaseControl.cc,
ButtonControl.cc, Canvas.cc, CheckBoxControl.cc, Container.cc,
ContextMenu.cc, EditControl.cc, Figure.cc, FigureWindow.cc,
GLCanvas.cc, KeyMap.cc, ListBoxControl.cc, Logger.cc, Menu.cc,
MouseModeActionGroup.cc, Object.cc, ObjectFactory.cc,
ObjectProxy.cc, Panel.cc, PopupMenuControl.cc, PushButtonControl.cc,
PushTool.cc, QtHandlesUtils.cc, RadioButtonControl.cc,
SliderControl.cc, TextControl.cc, TextEdit.cc,
ToggleButtonControl.cc, ToggleTool.cc, ToolBar.cc, __init_qt__.cc,
annotation-dialog.cc, gl-select.cc, module.mk, color-picker.cc,
dialog.cc, documentation-dock-widget.cc, files-dock-widget.cc,
find-files-dialog.cc, find-files-model.cc, history-dock-widget.cc,
liboctgui-build-info.in.cc, file-editor-tab.cc, file-editor.cc,
find-dialog.cc, marker.cc, marker.h, octave-qscintilla.cc,
octave-txt-lexer.cc, main-window.cc, octave-cmd.cc,
octave-dock-widget.cc, octave-gui.cc, octave-interpreter.cc,
octave-qt-link.cc, parser.cc, webinfo.cc, resource-manager.cc,
settings-dialog.cc, shortcut-manager.cc, terminal-dock-widget.cc,
thread-manager.cc, welcome-wizard.cc, workspace-model.cc,
workspace-view.cc, build-env.in.cc, Cell.cc, __contourc__.cc,
__dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __ilu__.cc,
__lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h,
cdisplay.c, cdisplay.h, cellfun.cc, coct-hdf5-types.c, colloc.cc,
comment-list.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc,
debug.cc, defaults.cc, defaults.in.h, defun.cc, det.cc, dirfns.cc,
display.cc, dlmread.cc, dot.cc, dynamic-ld.cc, eig.cc, ellipj.cc,
error.cc, errwarn.cc, event-queue.cc, fft.cc, fft2.cc, fftn.cc,
file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, gammainc.cc,
gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc,
gl-render.cc, gl2ps-print.cc, graphics.cc, gripes.cc, hash.cc,
help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, jit-ir.cc, jit-ir.h,
jit-typeinfo.cc, jit-typeinfo.h, jit-util.cc, jit-util.h, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-ascii-helper.cc,
ls-hdf5.cc, ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc,
ls-oct-binary.cc, ls-oct-text.cc, ls-oct-text.h, ls-utils.cc,
lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex.cc, mex.h,
mexproto.h, mgorth.cc, nproc.cc, oct-errno.in.cc, oct-fstrm.cc,
oct-hdf5-types.cc, oct-hdf5-types.h, oct-hist.cc, oct-iostrm.cc,
oct-lvalue.cc, oct-map.cc, oct-prcstrm.cc, oct-procbuf.cc,
oct-stdstrm.h, oct-stream.cc, oct-strstrm.cc, oct-tex-lexer.in.ll,
oct-tex-parser.in.yy, octave-link.cc, ordschur.cc, pager.cc,
pinv.cc, pr-output.cc, procstream.cc, profiler.cc, psi.cc,
pt-jit.cc, pt-jit.h, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc,
regexp.cc, schur.cc, sighandlers.cc, sighandlers.h, siglist.c,
siglist.h, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc, spparms.cc,
sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc,
sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc, text-renderer.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, txt-eng.cc, typecast.cc,
urlwrite.cc, utils.cc, variables.cc, xdiv.cc, xgl2ps.c, xnorm.cc,
xpow.cc, zfstream.cc, zfstream.h, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
liboctinterp-build-info.in.cc, mkbuiltins, mkops, ov-base.cc,
ov-bool-mat.cc, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.cc,
ov-cell.cc, ov-ch-mat.cc, ov-class.cc, ov-classdef.cc, ov-colon.cc,
ov-complex.cc, ov-cs-list.cc, ov-cx-diag.cc, ov-cx-mat.cc,
ov-cx-sparse.cc, ov-dld-fcn.cc, ov-fcn-handle.cc, ov-fcn-inline.cc,
ov-fcn.cc, ov-float.cc, ov-flt-complex.cc, ov-flt-cx-diag.cc,
ov-flt-cx-mat.cc, ov-flt-re-diag.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-lazy-idx.cc,
ov-mex-fcn.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-perm.cc,
ov-range.cc, ov-re-diag.cc, ov-re-mat.cc, ov-re-sparse.cc,
ov-scalar.cc, ov-str-mat.cc, ov-struct.cc, ov-typeinfo.cc,
ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ovl.cc, octave.cc, octave.h,
op-b-b.cc, op-b-bm.cc, op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc,
op-bm-sbm.cc, op-cdm-cdm.cc, op-cdm-cm.cc, op-cdm-dm.cc,
op-cdm-m.cc, op-cell.cc, op-chm.cc, op-class.cc, op-cm-cdm.cc,
op-cm-cm.cc, op-cm-cs.cc, op-cm-dm.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc,
op-cs-s.cc, op-cs-scm.cc, op-cs-sm.cc, op-dm-cdm.cc, op-dm-cm.cc,
op-dm-dm.cc, op-dm-m.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dm-template.cc, op-dms-template.cc, op-double-conv.cc,
op-fcdm-fcdm.cc, op-fcdm-fcm.cc, op-fcdm-fdm.cc, op-fcdm-fm.cc,
op-fcm-fcdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fdm.cc,
op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc,
op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fcdm.cc, op-fdm-fcm.cc,
op-fdm-fdm.cc, op-fdm-fm.cc, op-float-conv.cc, op-fm-fcdm.cc,
op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fdm.cc, op-fm-fm.cc, op-fm-fs.cc,
op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc,
op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc,
op-int-conv.cc, op-m-cdm.cc, op-m-cm.cc, op-m-cs.cc, op-m-dm.cc,
op-m-m.cc, op-m-s.cc, op-m-scm.cc, op-m-sm.cc, op-pm-pm.cc,
op-pm-scm.cc, op-pm-sm.cc, op-pm-template.cc, op-range.cc,
op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc,
op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc,
op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc,
op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc,
op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc,
op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc,
lex.ll, oct-parse.in.yy, pt-arg-list.cc, pt-array-list.cc,
pt-assign.cc, pt-binop.cc, pt-bp.cc, pt-cbinop.cc, pt-cell.cc,
pt-check.cc, pt-classdef.cc, pt-cmd.cc, pt-colon.cc, pt-const.cc,
pt-decl.cc, pt-eval.cc, pt-except.cc, pt-exp.cc, pt-fcn-handle.cc,
pt-funcall.cc, pt-id.cc, pt-idx.cc, pt-jump.cc, pt-loop.cc,
pt-loop.h, pt-mat.cc, pt-misc.cc, pt-pr-code.cc, pt-select.cc,
pt-stmt.cc, pt-unop.cc, pt.cc, token.cc, Array-jit.cc, Array-tc.cc,
version.cc, Array-C.cc, Array-b.cc, Array-ch.cc, Array-d.cc,
Array-f.cc, Array-fC.cc, Array-i.cc, Array-idx-vec.cc, Array-s.cc,
Array-str.cc, Array-util.cc, Array-voidp.cc, Array.cc,
CColVector.cc, CDiagMatrix.cc, CMatrix.cc, CNDArray.cc,
CRowVector.cc, CSparse.cc, MArray-C.cc, MArray-d.cc, MArray-f.cc,
MArray-fC.cc, MArray-i.cc, MArray-s.cc, MSparse-C.cc, MSparse-d.cc,
MatrixType.cc, PermMatrix.cc, Range.cc, Sparse-C.cc, Sparse-b.cc,
Sparse-d.cc, boolMatrix.cc, boolNDArray.cc, boolSparse.cc,
chMatrix.cc, chNDArray.cc, dColVector.cc, dDiagMatrix.cc,
dMatrix.cc, dNDArray.cc, dRowVector.cc, dSparse.cc, dim-vector.cc,
dim-vector.h, fCColVector.cc, fCDiagMatrix.cc, fCMatrix.cc,
fCNDArray.cc, fCRowVector.cc, fColVector.cc, fDiagMatrix.cc,
fMatrix.cc, fNDArray.cc, fRowVector.cc, idx-vector.cc,
int16NDArray.cc, int32NDArray.cc, int64NDArray.cc, int8NDArray.cc,
uint16NDArray.cc, uint32NDArray.cc, uint64NDArray.cc,
uint8NDArray.cc, Faddeeva.cc, blaswrap.c, cquit.c, f77-extern.cc,
f77-fcn.c, f77-fcn.h, lo-error.c, lo-error.h, quit.cc, quit.h,
liboctave-build-info.in.cc, CollocWt.cc, DASPK.cc, DASRT.cc,
DASSL.cc, EIG.cc, LSODE.cc, ODES.cc, Quad.cc, aepbalance.cc,
chol.cc, eigs-base.cc, fEIG.cc, gepbalance.cc, hess.cc,
lo-mappers.cc, lo-specfun.cc, lu.cc, oct-convn.cc, oct-fftw.cc,
oct-norm.cc, oct-rand.cc, oct-spparms.cc, qr.cc, qrp.cc,
randmtzig.cc, randpoisson.cc, schur.cc, sparse-chol.cc,
sparse-dmsolve.cc, sparse-lu.cc, sparse-qr.cc, svd.cc, mk-ops.awk,
mx-defs.h, dir-ops.cc, file-ops.cc, file-stat.cc, lo-sysdep.cc,
mach-info.cc, oct-env.cc, oct-group.cc, oct-passwd.cc,
oct-syscalls.cc, oct-time.cc, oct-uname.cc, pathlen.h, syswait.h,
cmd-edit.cc, cmd-hist.cc, data-conv.cc, f2c-main.c, glob-match.cc,
kpse.cc, lo-array-errwarn.cc, lo-array-gripes.cc, lo-cutils.c,
lo-cutils.h, lo-ieee.cc, lo-ieee.h, lo-regexp.cc, lo-utils.cc,
oct-base64.cc, oct-glob.cc, oct-inttypes.cc, oct-inttypes.h,
oct-locbuf.cc, oct-mutex.cc, oct-rl-edit.c, oct-rl-edit.h,
oct-rl-hist.c, oct-rl-hist.h, oct-shlib.cc, oct-sort.cc,
pathsearch.cc, singleton-cleanup.cc, sparse-sort.cc, sparse-util.cc,
statdefs.h, str-vec.cc, unwind-prot.cc, url-transfer.cc,
acinclude.m4, display-available.c, display-available.h, main-cli.cc,
main-gui.cc, main.in.cc, mkoctfile.in.cc, octave-build-info.in.cc,
octave-config.in.cc, shared-fcns.h:
Use "#if ..." consistently instead of "#ifdef" and "#ifndef".
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 17 May 2016 12:09:30 -0400 |
parents | 96518f623c91 |
children | cb0fdd941d84 |
rev | line source |
---|---|
1 | 1 /* |
2 | |
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19597
diff
changeset
|
3 Copyright (C) 1993-2015 John W. Eaton |
1 | 4 |
5 This file is part of Octave. | |
6 | |
7 Octave is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
1 | 11 |
12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
1 | 20 |
21 */ | |
22 | |
2095 | 23 // Originally written by John C. Campbell <jcc@bevo.che.wisc.edu> |
1230 | 24 // |
2095 | 25 // Thomas Baier <baier@ci.tuwien.ac.at> added the original versions of |
26 // the following functions: | |
1230 | 27 // |
2095 | 28 // popen |
29 // pclose | |
30 // execute (now popen2.m) | |
31 // sync_system (now merged with system) | |
32 // async_system (now merged with system) | |
1230 | 33 |
9322 | 34 // Extensively revised by John W. Eaton <jwe@octave.org>, |
2095 | 35 // April 1996. |
1 | 36 |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21634
diff
changeset
|
37 #if defined (HAVE_CONFIG_H) |
21301
40de9f8f23a6
Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
38 # include "config.h" |
1 | 39 #endif |
40 | |
4797 | 41 #include <cerrno> |
42 #include <cstdio> | |
1343 | 43 |
3503 | 44 #include <iostream> |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
45 #include <limits> |
7336 | 46 #include <stack> |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
47 #include <string> |
4726 | 48 #include <vector> |
1350 | 49 |
13958
cb15c5185b6a
mkstemp: open file in binary mode (bug #33669)
John W. Eaton <jwe@octave.org>
parents:
13929
diff
changeset
|
50 #include <fcntl.h> |
1230 | 51 #include <sys/types.h> |
1 | 52 #include <unistd.h> |
1350 | 53 |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21634
diff
changeset
|
54 #if defined (HAVE_ZLIB_H) |
21200
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
21127
diff
changeset
|
55 # include <zlib.h> |
5325 | 56 #endif |
57 | |
5102 | 58 #include "error.h" |
2926 | 59 #include "file-ops.h" |
6159 | 60 #include "file-stat.h" |
5102 | 61 #include "lo-ieee.h" |
6159 | 62 #include "oct-env.h" |
8377
25bc2d31e1bf
improve OCTAVE_LOCAL_BUFFER
Jaroslav Hajek <highegg@gmail.com>
parents:
8021
diff
changeset
|
63 #include "oct-locbuf.h" |
2926 | 64 |
1352 | 65 #include "defun.h" |
21126
ba0a4b4f021d
include errwarn.h in files that use err_disabled_feature conditionally
John W. Eaton <jwe@octave.org>
parents:
21109
diff
changeset
|
66 #include "errwarn.h" |
6108 | 67 #include "file-io.h" |
6159 | 68 #include "load-path.h" |
2095 | 69 #include "oct-fstrm.h" |
70 #include "oct-iostrm.h" | |
1377 | 71 #include "oct-map.h" |
2095 | 72 #include "oct-prcstrm.h" |
73 #include "oct-stream.h" | |
74 #include "oct-strstrm.h" | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
75 #include "ov.h" |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
76 #include "ovl.h" |
1 | 77 #include "pager.h" |
444 | 78 #include "sysdep.h" |
1352 | 79 #include "utils.h" |
2370 | 80 #include "variables.h" |
1583 | 81 |
2902 | 82 static octave_value stdin_file; |
83 static octave_value stdout_file; | |
84 static octave_value stderr_file; | |
85 | |
4468 | 86 static octave_stream stdin_stream; |
87 static octave_stream stdout_stream; | |
88 static octave_stream stderr_stream; | |
89 | |
1 | 90 void |
164 | 91 initialize_file_io (void) |
1 | 92 { |
4468 | 93 stdin_stream = octave_istream::create (&std::cin, "stdin"); |
2116 | 94 |
3531 | 95 // This uses octave_stdout (see pager.h), not std::cout so that Octave's |
2116 | 96 // standard output stream will pass through the pager. |
97 | |
4468 | 98 stdout_stream = octave_ostream::create (&octave_stdout, "stdout"); |
2116 | 99 |
4468 | 100 stderr_stream = octave_ostream::create (&std::cerr, "stderr"); |
1 | 101 |
2902 | 102 stdin_file = octave_stream_list::insert (stdin_stream); |
103 stdout_file = octave_stream_list::insert (stdout_stream); | |
104 stderr_file = octave_stream_list::insert (stderr_stream); | |
1 | 105 } |
106 | |
2095 | 107 void |
108 close_files (void) | |
1 | 109 { |
2095 | 110 octave_stream_list::clear (); |
111 } | |
636 | 112 |
5102 | 113 // List of files to delete when we exit or crash. |
114 // | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
115 // FIXME: this should really be static, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
116 // but that causes problems on some systems. |
5102 | 117 std::stack <std::string> tmp_files; |
118 | |
119 void | |
120 mark_for_deletion (const std::string& file) | |
121 { | |
122 tmp_files.push (file); | |
123 } | |
124 | |
125 void | |
126 cleanup_tmp_files (void) | |
127 { | |
128 while (! tmp_files.empty ()) | |
129 { | |
130 std::string filename = tmp_files.top (); | |
131 tmp_files.pop (); | |
10411 | 132 gnulib::unlink (filename.c_str ()); |
5102 | 133 } |
134 } | |
135 | |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
136 static void |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
137 normalize_fopen_mode (std::string& mode, bool& use_zlib) |
1 | 138 { |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
139 use_zlib = false; |
896 | 140 |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
141 if (! mode.empty ()) |
368 | 142 { |
2095 | 143 // Could probably be faster, but does it really matter? |
1766 | 144 |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
145 // Accept 'W', 'R', and 'A' as 'w', 'r', and 'a' but we warn about |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
146 // them because Matlab says they don't perform "automatic |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
147 // flushing" but we don't know precisely what action that implies. |
7078 | 148 |
149 size_t pos = mode.find ('W'); | |
150 | |
8021 | 151 if (pos != std::string::npos) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
152 { |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
153 warning_with_id ("Octave:fopen-mode", |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
154 "fopen: treating mode \"W\" as equivalent to \"w\""); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
155 mode[pos] = 'w'; |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
156 } |
7078 | 157 |
158 pos = mode.find ('R'); | |
159 | |
8021 | 160 if (pos != std::string::npos) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
161 { |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
162 warning_with_id ("Octave:fopen-mode", |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
163 "fopen: treating mode \"R\" as equivalent to \"r\""); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
164 mode[pos] = 'r'; |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
165 } |
7078 | 166 |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
167 pos = mode.find ('A'); |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
168 |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
169 if (pos != std::string::npos) |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
170 { |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
171 warning_with_id ("Octave:fopen-mode", |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
172 "fopen: treating mode \"A\" as equivalent to \"a\""); |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
173 mode[pos] = 'a'; |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
174 } |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
175 |
7078 | 176 pos = mode.find ('z'); |
5325 | 177 |
8021 | 178 if (pos != std::string::npos) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
179 { |
5325 | 180 #if defined (HAVE_ZLIB) |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
181 use_zlib = true; |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
182 mode.erase (pos, 1); |
5325 | 183 #else |
21109
bd1752782e56
Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents:
21078
diff
changeset
|
184 err_disabled_feature ("", "gzipped files (zlib)"); |
5325 | 185 #endif |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
186 } |
5325 | 187 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
188 // Use binary mode if 't' is not specified, but don't add |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
189 // 'b' if it is already present. |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
190 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
191 size_t bpos = mode.find ('b'); |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
192 size_t tpos = mode.find ('t'); |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
193 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
194 if (bpos == std::string::npos && tpos == std::string::npos) |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
195 mode += 'b'; |
1 | 196 } |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
197 } |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
198 |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
199 static std::ios::openmode |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
200 fopen_mode_to_ios_mode (const std::string& mode) |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
201 { |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
202 std::ios::openmode retval = std::ios::in; |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
203 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
204 if (mode == "rt") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
205 retval = std::ios::in; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
206 else if (mode == "wt") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
207 retval = std::ios::out | std::ios::trunc; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
208 else if (mode == "at") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
209 retval = std::ios::out | std::ios::app; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
210 else if (mode == "r+t" || mode == "rt+") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
211 retval = std::ios::in | std::ios::out; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
212 else if (mode == "w+t" || mode == "wt+") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
213 retval = std::ios::in | std::ios::out | std::ios::trunc; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
214 else if (mode == "a+t" || mode == "at+") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
215 retval = std::ios::in | std::ios::out | std::ios::app; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
216 else if (mode == "rb" || mode == "r") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
217 retval = std::ios::in | std::ios::binary; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
218 else if (mode == "wb" || mode == "w") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
219 retval = std::ios::out | std::ios::trunc | std::ios::binary; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
220 else if (mode == "ab" || mode == "a") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
221 retval = std::ios::out | std::ios::app | std::ios::binary; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
222 else if (mode == "r+b" || mode == "rb+" || mode == "r+") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
223 retval = std::ios::in | std::ios::out | std::ios::binary; |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
224 else if (mode == "w+b" || mode == "wb+" || mode == "w+") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
225 retval = (std::ios::in | std::ios::out | std::ios::trunc |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
226 | std::ios::binary); |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
227 else if (mode == "a+b" || mode == "ab+" || mode == "a+") |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
228 retval = (std::ios::in | std::ios::out | std::ios::app |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
229 | std::ios::binary); |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
230 else |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
231 error ("invalid mode specified"); |
1 | 232 |
233 return retval; | |
234 } | |
235 | |
1957 | 236 DEFUN (fclose, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
237 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
238 @deftypefn {} {} fclose (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
239 @deftypefnx {} {} fclose (\"all\")\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
240 @deftypefnx {} {@var{status} =} fclose (\"all\")\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
241 Close the file specified by the file descriptor @var{fid}.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
242 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
243 If successful, @code{fclose} returns 0, otherwise, it returns -1. The\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
244 second form of the @code{fclose} call closes all open files except\n\ |
20764
0ad449bc8848
Stop 'fclose ("all")' from closing down gnuplot pipes (bug #39504).
Rik <rik@octave.org>
parents:
20756
diff
changeset
|
245 @code{stdin}, @code{stdout}, @code{stderr}, and any FIDs associated\n\ |
0ad449bc8848
Stop 'fclose ("all")' from closing down gnuplot pipes (bug #39504).
Rik <rik@octave.org>
parents:
20756
diff
changeset
|
246 with gnuplot.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
247 @seealso{fopen, fflush, freport}\n\ |
5642 | 248 @end deftypefn") |
529 | 249 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
250 if (args.length () != 1) |
5823 | 251 print_usage (); |
1 | 252 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
253 return ovl (octave_stream_list::remove (args(0), "fclose")); |
1 | 254 } |
255 | |
5144 | 256 DEFUN (fclear, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
257 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
258 @deftypefn {} {} fclear (@var{fid})\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
259 Clear the stream state for the file specified by the file descriptor\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
260 @var{fid}.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
261 @seealso{ferror, fopen}\n\ |
5144 | 262 @end deftypefn") |
263 { | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
264 if (args.length () != 1) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
265 print_usage (); |
5144 | 266 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
267 int fid = octave_stream_list::get_file_number (args(0)); |
5144 | 268 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
269 octave_stream os = octave_stream_list::lookup (fid, "fclear"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
270 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
271 os.clearerr (); |
5144 | 272 |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
273 return ovl (); |
5144 | 274 } |
275 | |
1957 | 276 DEFUN (fflush, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
277 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
278 @deftypefn {} {} fflush (@var{fid})\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
279 Flush output to file descriptor @var{fid}.\n\ |
5095 | 280 \n\ |
281 @code{fflush} returns 0 on success and an OS dependent error value\n\ | |
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
10411
diff
changeset
|
282 (@minus{}1 on Unix) on error.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
283 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
284 Programming Note: Flushing is useful for ensuring that all pending output\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
285 makes it to the screen before some other event occurs. For example, it is\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
286 always a good idea to flush the standard output stream before calling\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
287 @code{input}.\n\ |
5642 | 288 @seealso{fopen, fclose}\n\ |
289 @end deftypefn") | |
1181 | 290 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
291 if (args.length () != 1) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
292 print_usage (); |
1181 | 293 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
294 octave_value retval = -1; |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
295 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
296 // FIXME: any way to avoid special case for stdout? |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
297 int fid = octave_stream_list::get_file_number (args(0)); |
2095 | 298 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
299 if (fid == 1) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
300 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
301 flush_octave_stdout (); |
2609 | 302 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
303 retval = 0; |
2095 | 304 } |
305 else | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
306 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
307 octave_stream os = octave_stream_list::lookup (fid, "fflush"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
308 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
309 retval = os.flush (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
310 } |
1181 | 311 |
312 return retval; | |
313 } | |
314 | |
2095 | 315 DEFUN (fgetl, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
316 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
317 @deftypefn {} {@var{str} =} fgetl (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
318 @deftypefnx {} {@var{str} =} fgetl (@var{fid}, @var{len})\n\ |
3372 | 319 Read characters from a file, stopping after a newline, or EOF,\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
320 or @var{len} characters have been read.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
321 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
322 The characters read, excluding the possible trailing newline, are returned\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
323 as a string.\n\ |
1339 | 324 \n\ |
21547
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
325 If @var{len} is omitted, @code{fgetl} reads until the next newline\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
326 character.\n\ |
3372 | 327 \n\ |
328 If there are no more characters to read, @code{fgetl} returns @minus{}1.\n\ | |
14435
f312918f16d2
doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14429
diff
changeset
|
329 \n\ |
f312918f16d2
doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14429
diff
changeset
|
330 To read a line and return the terminating newline see @code{fgets}.\n\ |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
331 @seealso{fgets, fscanf, fread, fopen}\n\ |
5642 | 332 @end deftypefn") |
1339 | 333 { |
4468 | 334 static std::string who = "fgetl"; |
335 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
336 int nargin = args.length (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
337 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
338 if (nargin < 1 || nargin > 2) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
339 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
340 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
341 octave_stream os = octave_stream_list::lookup (args(0), who); |
1339 | 342 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
343 octave_value len_arg = (nargin == 2) ? args(1) : octave_value (); |
2095 | 344 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
345 bool err = false; |
2095 | 346 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
347 std::string tmp = os.getl (len_arg, err, who); |
2095 | 348 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
349 if (! err) |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
350 return ovl (tmp, tmp.length ()); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
351 else |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
352 return ovl (-1, 0); |
1339 | 353 } |
354 | |
2095 | 355 DEFUN (fgets, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
356 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
357 @deftypefn {} {@var{str} =} fgets (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
358 @deftypefnx {} {@var{str} =} fgets (@var{fid}, @var{len})\n\ |
3372 | 359 Read characters from a file, stopping after a newline, or EOF,\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
360 or @var{len} characters have been read.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
361 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
362 The characters read, including the possible trailing newline, are returned\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
363 as a string.\n\ |
529 | 364 \n\ |
21547
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
365 If @var{len} is omitted, @code{fgets} reads until the next newline\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
366 character.\n\ |
3372 | 367 \n\ |
368 If there are no more characters to read, @code{fgets} returns @minus{}1.\n\ | |
14435
f312918f16d2
doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14429
diff
changeset
|
369 \n\ |
f312918f16d2
doc: Add cross-references between fgets and fgetl in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14429
diff
changeset
|
370 To read a line and discard the terminating newline see @code{fgetl}.\n\ |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
371 @seealso{fputs, fgetl, fscanf, fread, fopen}\n\ |
5642 | 372 @end deftypefn") |
529 | 373 { |
4468 | 374 static std::string who = "fgets"; |
375 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
376 int nargin = args.length (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
377 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
378 if (nargin < 1 || nargin > 2) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
379 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
380 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
381 octave_stream os = octave_stream_list::lookup (args(0), who); |
529 | 382 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
383 octave_value len_arg = (nargin == 2) ? args(1) : octave_value (); |
2095 | 384 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
385 bool err = false; |
2095 | 386 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
387 std::string tmp = os.gets (len_arg, err, who); |
2095 | 388 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
389 if (! err) |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
390 return ovl (tmp, tmp.length ()); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
391 else |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
392 return ovl (-1.0, 0.0); |
529 | 393 } |
394 | |
9701 | 395 DEFUN (fskipl, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
396 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
397 @deftypefn {} {@var{nlines} =} fskipl (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
398 @deftypefnx {} {@var{nlines} =} fskipl (@var{fid}, @var{count})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
399 @deftypefnx {} {@var{nlines} =} fskipl (@var{fid}, Inf)\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
400 Read and skip @var{count} lines from the file specified by the file\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
401 descriptor @var{fid}.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
402 \n\ |
21547
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
403 @code{fskipl} discards characters until an end-of-line is encountered\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
404 exactly @var{count}-times, or until the end-of-file marker is found.\n\ |
14436
12097d20a23e
doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents:
14435
diff
changeset
|
405 \n\ |
12097d20a23e
doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents:
14435
diff
changeset
|
406 If @var{count} is omitted, it defaults to 1. @var{count} may also be\n\ |
12097d20a23e
doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents:
14435
diff
changeset
|
407 @code{Inf}, in which case lines are skipped until the end of the file.\n\ |
12097d20a23e
doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents:
14435
diff
changeset
|
408 This form is suitable for counting the number of lines in a file.\n\ |
12097d20a23e
doc: Improve docstring for fskipl.
Rik <octave@nomad.inbox5.com>
parents:
14435
diff
changeset
|
409 \n\ |
9701 | 410 Returns the number of lines skipped (end-of-line sequences encountered).\n\ |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
411 @seealso{fgetl, fgets, fscanf, fopen}\n\ |
9701 | 412 @end deftypefn") |
413 { | |
414 static std::string who = "fskipl"; | |
415 | |
416 int nargin = args.length (); | |
417 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
418 if (nargin < 1 || nargin > 2) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
419 print_usage (); |
9701 | 420 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
421 octave_stream os = octave_stream_list::lookup (args(0), who); |
9701 | 422 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
423 octave_value count_arg = (nargin == 2) ? args(1) : octave_value (); |
9701 | 424 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
425 bool err = false; |
9701 | 426 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
427 off_t tmp = os.skipl (count_arg, err, who); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
428 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
429 if (! err) |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
430 return ovl (tmp); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
431 else |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
432 return ovl (); |
9701 | 433 } |
434 | |
435 | |
3340 | 436 static octave_stream |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
437 do_stream_open (const std::string& name, const std::string& mode_arg, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
438 const std::string& arch, int& fid) |
1 | 439 { |
3340 | 440 octave_stream retval; |
1 | 441 |
2095 | 442 fid = -1; |
1 | 443 |
16590
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
444 std::string mode = mode_arg; |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
445 bool use_zlib = false; |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
446 normalize_fopen_mode (mode, use_zlib); |
2d968b7830d6
handle A, R, and W fopen modes correctly (bug #38851)
John W. Eaton <jwe@octave.org>
parents:
16308
diff
changeset
|
447 |
4036 | 448 std::ios::openmode md = fopen_mode_to_ios_mode (mode); |
1 | 449 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
450 oct_mach_info::float_format flt_fmt = |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
451 oct_mach_info::string_to_float_format (arch); |
1 | 452 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
453 std::string fname = file_ops::tilde_expand (name); |
6159 | 454 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
455 file_stat fs (fname); |
7730
b68e44c90afe
file-io.cc (do_stream_open): return -1 for directories
John W. Eaton <jwe@octave.org>
parents:
7708
diff
changeset
|
456 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
457 if (! (md & std::ios::out)) |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
458 fname = find_data_file_in_load_path ("fopen", fname); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11572
diff
changeset
|
459 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
460 if (! fs.is_dir ()) |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
461 { |
6905 | 462 #if defined (HAVE_ZLIB) |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
463 if (use_zlib) |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
464 { |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
465 FILE *fptr = gnulib::fopen (fname.c_str (), mode.c_str ()); |
11004
594adb99a25e
cache file id in octave_tstdiostream class
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
466 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
467 int fd = fileno (fptr); |
11004
594adb99a25e
cache file id in octave_tstdiostream class
John W. Eaton <jwe@octave.org>
parents:
10840
diff
changeset
|
468 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
469 gzFile gzf = ::gzdopen (fd, mode.c_str ()); |
5325 | 470 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
471 if (fptr) |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
472 retval = octave_zstdiostream::create (fname, gzf, fd, |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
473 md, flt_fmt); |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
474 else |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
475 retval.error (gnulib::strerror (errno)); |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
476 } |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
477 else |
5325 | 478 #endif |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
479 { |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
480 FILE *fptr = gnulib::fopen (fname.c_str (), mode.c_str ()); |
5370 | 481 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
482 retval = octave_stdiostream::create (fname, fptr, md, |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
483 flt_fmt); |
7730
b68e44c90afe
file-io.cc (do_stream_open): return -1 for directories
John W. Eaton <jwe@octave.org>
parents:
7708
diff
changeset
|
484 |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
485 if (! fptr) |
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
486 retval.error (gnulib::strerror (errno)); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
487 } |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
488 |
1 | 489 } |
490 | |
2095 | 491 return retval; |
492 } | |
1 | 493 |
3340 | 494 static octave_stream |
2095 | 495 do_stream_open (const octave_value& tc_name, const octave_value& tc_mode, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
496 const octave_value& tc_arch, const char *fcn, int& fid) |
2095 | 497 { |
3340 | 498 octave_stream retval; |
2095 | 499 |
500 fid = -1; | |
501 | |
20713
2469d78a1d8b
Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
502 std::string name = tc_name.xstring_value ("%s: filename must be a string", fcn); |
20700
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20687
diff
changeset
|
503 std::string mode = tc_mode.xstring_value ("%s: file mode must be a string", fcn); |
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20687
diff
changeset
|
504 std::string arch = tc_arch.xstring_value ("%s: architecture type must be a string", fcn); |
1 | 505 |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
506 retval = do_stream_open (name, mode, arch, fid); |
1 | 507 |
508 return retval; | |
509 } | |
510 | |
11146
69b2f237060e
file-io.cc (Ffopen): argument parsing tweak
John W. Eaton <jwe@octave.org>
parents:
11081
diff
changeset
|
511 DEFUN (fopen, args, nargout, |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
512 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
513 @deftypefn {} {@var{fid} =} fopen (@var{name})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
514 @deftypefnx {} {@var{fid} =} fopen (@var{name}, @var{mode})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
515 @deftypefnx {} {@var{fid} =} fopen (@var{name}, @var{mode}, @var{arch})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
516 @deftypefnx {} {[@var{fid}, @var{msg}] =} fopen (@dots{})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
517 @deftypefnx {} {@var{fid_list} =} fopen (\"all\")\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
518 @deftypefnx {} {[@var{file}, @var{mode}, @var{arch}] =} fopen (@var{fid})\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
519 Open a file for low-level I/O or query open files and file descriptors.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
520 \n\ |
3372 | 521 The first form of the @code{fopen} function opens the named file with\n\ |
522 the specified mode (read-write, read-only, etc.) and architecture\n\ | |
523 interpretation (IEEE big endian, IEEE little endian, etc.), and returns\n\ | |
524 an integer value that may be used to refer to the file later. If an\n\ | |
525 error occurs, @var{fid} is set to @minus{}1 and @var{msg} contains the\n\ | |
526 corresponding system error message. The @var{mode} is a one or two\n\ | |
527 character string that specifies whether the file is to be opened for\n\ | |
528 reading, writing, or both.\n\ | |
1181 | 529 \n\ |
3372 | 530 The second form of the @code{fopen} function returns a vector of file ids\n\ |
531 corresponding to all the currently open files, excluding the\n\ | |
532 @code{stdin}, @code{stdout}, and @code{stderr} streams.\n\ | |
2318 | 533 \n\ |
5353 | 534 The third form of the @code{fopen} function returns information about the\n\ |
535 open file given its file id.\n\ | |
1181 | 536 \n\ |
3372 | 537 For example,\n\ |
538 \n\ | |
539 @example\n\ | |
540 myfile = fopen (\"splat.dat\", \"r\", \"ieee-le\");\n\ | |
541 @end example\n\ | |
2095 | 542 \n\ |
3372 | 543 @noindent\n\ |
544 opens the file @file{splat.dat} for reading. If necessary, binary\n\ | |
545 numeric values will be read assuming they are stored in IEEE format with\n\ | |
546 the least significant bit first, and then converted to the native\n\ | |
547 representation.\n\ | |
2318 | 548 \n\ |
3372 | 549 Opening a file that is already open simply opens it again and returns a\n\ |
550 separate file id. It is not an error to open a file several times,\n\ | |
551 though writing to the same file through several different file ids may\n\ | |
552 produce unexpected results.\n\ | |
553 \n\ | |
554 The possible values @samp{mode} may have are\n\ | |
555 \n\ | |
556 @table @asis\n\ | |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
557 @item @samp{r} (default)\n\ |
3372 | 558 Open a file for reading.\n\ |
3263 | 559 \n\ |
3372 | 560 @item @samp{w}\n\ |
7001 | 561 Open a file for writing. The previous contents are discarded.\n\ |
3372 | 562 \n\ |
563 @item @samp{a}\n\ | |
564 Open or create a file for writing at the end of the file.\n\ | |
565 \n\ | |
566 @item @samp{r+}\n\ | |
567 Open an existing file for reading and writing.\n\ | |
568 \n\ | |
569 @item @samp{w+}\n\ | |
570 Open a file for reading or writing. The previous contents are\n\ | |
571 discarded.\n\ | |
572 \n\ | |
573 @item @samp{a+}\n\ | |
574 Open or create a file for reading or writing at the end of the\n\ | |
575 file.\n\ | |
576 @end table\n\ | |
577 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
578 Append a @qcode{\"t\"} to the mode string to open the file in text mode or a\n\ |
21547
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
579 @qcode{\"b\"} to open in binary mode. On Windows and Macintosh systems,\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
580 text mode reading and writing automatically converts linefeeds to the\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
581 appropriate line end character for the system (carriage-return linefeed on\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
582 Windows, carriage-return on Macintosh). The default when no mode is\n\ |
4865 | 583 specified is binary mode.\n\ |
584 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
585 Additionally, you may append a @qcode{\"z\"} to the mode string to open a\n\ |
5325 | 586 gzipped file for reading or writing. For this to be successful, you\n\ |
587 must also open the file in binary mode.\n\ | |
588 \n\ | |
3372 | 589 The parameter @var{arch} is a string specifying the default data format\n\ |
590 for the file. Valid values for @var{arch} are:\n\ | |
2318 | 591 \n\ |
20431
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
592 @table @asis\n\ |
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
593 @item @qcode{\"native\"} or @qcode{\"n\"} (default)\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
594 The format of the current machine.\n\ |
3372 | 595 \n\ |
20431
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
596 @item @qcode{\"ieee-be\"} or @qcode{\"b\"}\n\ |
3372 | 597 IEEE big endian format.\n\ |
598 \n\ | |
20431
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
599 @item @qcode{\"ieee-le\"} or @qcode{\"l\"}\n\ |
3372 | 600 IEEE little endian format.\n\ |
601 @end table\n\ | |
602 \n\ | |
603 @noindent\n\ | |
20431
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
604 However, conversions are currently only supported for @samp{native},\n\ |
3372 | 605 @samp{ieee-be}, and @samp{ieee-le} formats.\n\ |
20198
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
606 \n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
607 When opening a new file that does not yet exist, permissions will be set to\n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
608 @code{0666 - @var{umask}}.\n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
609 @seealso{fclose, fgets, fgetl, fscanf, fread, fputs, fdisp, fprintf, fwrite, fskipl, fseek, frewind, ftell, feof, ferror, fclear, fflush, freport, umask}\n\ |
5642 | 610 @end deftypefn") |
529 | 611 { |
612 int nargin = args.length (); | |
613 | |
20861
6774cc464ea0
* file-io.cc (Ffopen): Fix nargin range check, fixes cset f2cd811f0f9e
Mike Miller <mtmiller@octave.org>
parents:
20853
diff
changeset
|
614 if (nargin < 1 || nargin > 3) |
20846
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
615 print_usage (); |
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
616 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
617 octave_value_list retval = ovl (-1.0); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
618 |
2095 | 619 if (nargin == 1) |
620 { | |
12896
a19b50f6697f
Correctly allow single string input form of fopen() (Bug #33535).
Rik <octave@nomad.inbox5.com>
parents:
12775
diff
changeset
|
621 if (args(0).is_string ()) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
622 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
623 // If there is only one argument and it is a string but it |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
624 // is not the string "all", we assume it is a file to open |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
625 // with MODE = "r". To open a file called "all", you have |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
626 // to supply more than one argument. |
12896
a19b50f6697f
Correctly allow single string input form of fopen() (Bug #33535).
Rik <octave@nomad.inbox5.com>
parents:
12775
diff
changeset
|
627 if (nargout < 2 && args(0).string_value () == "all") |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
628 return octave_stream_list::open_file_numbers (); |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
629 } |
2095 | 630 else |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
631 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
632 string_vector tmp = octave_stream_list::get_info (args(0)); |
529 | 633 |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
634 retval = ovl (tmp(0), tmp(1), tmp(2)); |
3263 | 635 |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
636 return retval; |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
637 } |
1 | 638 } |
639 | |
20846
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
640 octave_value mode = (nargin == 2 || nargin == 3) |
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
641 ? args(1) : octave_value ("r"); |
2095 | 642 |
20846
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
643 octave_value arch = (nargin == 3) |
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
644 ? args(2) : octave_value ("native"); |
2095 | 645 |
20846
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
646 int fid = -1; |
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
647 |
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
648 octave_stream os = do_stream_open (args(0), mode, arch, "fopen", fid); |
5370 | 649 |
20846
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
650 if (os) |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
651 retval = ovl (octave_stream_list::insert (os), ""); |
2095 | 652 else |
20846
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
653 { |
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
654 int error_number = 0; |
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
655 |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
656 retval = ovl (-1.0, os.error (false, error_number)); |
20846
f2cd811f0f9e
maint: Refactor C++ calls to print_usage to resemble m-files (2015 code sprint)
Mike Miller <mtmiller@octave.org>
parents:
20819
diff
changeset
|
657 } |
1 | 658 |
659 return retval; | |
660 } | |
661 | |
1957 | 662 DEFUN (freport, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
663 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
664 @deftypefn {} {} freport ()\n\ |
3372 | 665 Print a list of which files have been opened, and whether they are open\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
666 for reading, writing, or both.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
667 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
668 For example:\n\ |
3372 | 669 \n\ |
670 @example\n\ | |
671 @group\n\ | |
672 freport ()\n\ | |
673 \n\ | |
19123 | 674 @print{} number mode arch name\n\ |
675 @print{} ------ ---- ---- ----\n\ | |
676 @print{} 0 r ieee-le stdin\n\ | |
677 @print{} 1 w ieee-le stdout\n\ | |
678 @print{} 2 w ieee-le stderr\n\ | |
679 @print{} 3 r ieee-le myfile\n\ | |
3372 | 680 @end group\n\ |
681 @end example\n\ | |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
682 @seealso{fopen, fclose, is_valid_file_id}\n\ |
3372 | 683 @end deftypefn") |
1181 | 684 { |
20819
f428cbe7576f
eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents:
20812
diff
changeset
|
685 if (args.length () > 0) |
1181 | 686 warning ("freport: ignoring extra arguments"); |
687 | |
2095 | 688 octave_stdout << octave_stream_list::list_open_files (); |
1181 | 689 |
21078
49852ff04747
maint: Remove unnecessary declarations of retval.
Rik <rik@octave.org>
parents:
21055
diff
changeset
|
690 return ovl (); |
1181 | 691 } |
692 | |
4715 | 693 DEFUN (frewind, args, nargout, |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
694 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
695 @deftypefn {} {} frewind (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
696 @deftypefnx {} {@var{status} =} frewind (@var{fid})\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
697 Move the file pointer to the beginning of the file specified by file\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
698 descriptor @var{fid}.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
699 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
700 @code{frewind} returns 0 for success, and -1 if an error is encountered. It\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
701 is equivalent to @code{fseek (@var{fid}, 0, SEEK_SET)}.\n\ |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
702 @seealso{fseek, ftell, fopen}\n\ |
3372 | 703 @end deftypefn") |
529 | 704 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
705 if (args.length () != 1) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
706 print_usage (); |
506 | 707 |
20812
d9ca869ca124
maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents:
20805
diff
changeset
|
708 int result = -1; |
d9ca869ca124
maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents:
20805
diff
changeset
|
709 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
710 octave_stream os = octave_stream_list::lookup (args(0), "frewind"); |
636 | 711 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
712 result = os.rewind (); |
1 | 713 |
4715 | 714 if (nargout > 0) |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
715 return ovl (result); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
716 else |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
717 return ovl (); |
1 | 718 } |
719 | |
1957 | 720 DEFUN (fseek, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
721 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
722 @deftypefn {} {} fseek (@var{fid}, @var{offset})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
723 @deftypefnx {} {} fseek (@var{fid}, @var{offset}, @var{origin})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
724 @deftypefnx {} {@var{status} =} fseek (@dots{})\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
725 Set the file pointer to the location @var{offset} within the file @var{fid}.\n\ |
5095 | 726 \n\ |
727 The pointer is positioned @var{offset} characters from the @var{origin},\n\ | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
728 which may be one of the predefined variables @w{@code{SEEK_CUR}} (current\n\ |
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
729 position), @w{@code{SEEK_SET}} (beginning), or @w{@code{SEEK_END}} (end of\n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
730 file) or strings @qcode{\"cof\"}, @qcode{\"bof\"} or @qcode{\"eof\"}. If\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
731 @var{origin} is omitted, @w{@code{SEEK_SET}} is assumed. @var{offset} may\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
732 be positive, negative, or zero but not all combinations of @var{origin} and\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
733 @var{offset} can be realized.\n\ |
5095 | 734 \n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
735 @code{fseek} returns 0 on success and -1 on error.\n\ |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
736 @seealso{fskipl, frewind, ftell, fopen}\n\ |
5642 | 737 @end deftypefn") |
529 | 738 { |
739 int nargin = args.length (); | |
740 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
741 if (nargin < 2 || nargin > 3) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
742 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
743 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
744 octave_stream os = octave_stream_list::lookup (args(0), "fseek"); |
1181 | 745 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
746 octave_value origin_arg = (nargin == 3) ? args(2) : octave_value (-1.0); |
1 | 747 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
748 return ovl (os.seek (args(1), origin_arg)); |
1 | 749 } |
750 | |
1957 | 751 DEFUN (ftell, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
752 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
753 @deftypefn {} {@var{pos} =} ftell (@var{fid})\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
754 Return the position of the file pointer as the number of characters from the\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
755 beginning of the file specified by file descriptor @var{fid}.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
756 @seealso{fseek, frewind, feof, fopen}\n\ |
5642 | 757 @end deftypefn") |
1181 | 758 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
759 if (args.length () != 1) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
760 print_usage (); |
506 | 761 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
762 octave_stream os = octave_stream_list::lookup (args(0), "ftell"); |
1 | 763 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
764 return ovl (os.tell ()); |
1 | 765 } |
766 | |
3737 | 767 DEFUN (fprintf, args, nargout, |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
768 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
769 @deftypefn {} {} fprintf (@var{fid}, @var{template}, @dots{})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
770 @deftypefnx {} {} fprintf (@var{template}, @dots{})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
771 @deftypefnx {} {@var{numbytes} =} fprintf (@dots{})\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
772 This function is equivalent to @code{printf}, except that the output is\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
773 written to the file descriptor @var{fid} instead of @code{stdout}.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
774 \n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
775 If @var{fid} is omitted, the output is written to @code{stdout} making the\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
776 function exactly equivalent to @code{printf}.\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
777 \n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
778 The optional output returns the number of bytes written to the file.\n\ |
20041
dbf2418a46dd
Document expansion of escape sequences in single quotes (bug #44745).
Rik <rik@octave.org>
parents:
19861
diff
changeset
|
779 \n\ |
20097
1f9ed81bd173
maint: Fix spelling and grammar mistakes in docs and comments (bug #44878)
Rafael Laboissiere <rafael@laboissiere.net>
parents:
20041
diff
changeset
|
780 Implementation Note: For compatibility with @sc{matlab}, escape sequences in\n\ |
20101
e51473fdb622
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
20097
diff
changeset
|
781 the template string (e.g., @qcode{\"@xbackslashchar{}n\"} => newline) are\n\ |
e51473fdb622
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
20097
diff
changeset
|
782 expanded even when the template string is defined with single quotes.\n\ |
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
783 @seealso{fputs, fdisp, fwrite, fscanf, printf, sprintf, fopen}\n\ |
5642 | 784 @end deftypefn") |
1181 | 785 { |
4468 | 786 static std::string who = "fprintf"; |
787 | |
1181 | 788 int nargin = args.length (); |
789 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
790 if (! (nargin > 1 || (nargin > 0 && args(0).is_string ()))) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
791 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
792 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
793 int result; |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
794 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
795 octave_stream os; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
796 int fmt_n = 0; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
797 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
798 if (args(0).is_string ()) |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
799 os = octave_stream_list::lookup (1, who); |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
800 else |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
801 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
802 fmt_n = 1; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
803 os = octave_stream_list::lookup (args(0), who); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
804 } |
2873 | 805 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
806 if (! args(fmt_n).is_string ()) |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
807 error ("%s: format TEMPLATE must be a string", who.c_str ()); |
1181 | 808 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
809 octave_value_list tmp_args; |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
810 |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
811 if (nargin > 1 + fmt_n) |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
812 { |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
813 tmp_args.resize (nargin-fmt_n-1, octave_value ()); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
814 |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
815 for (int i = fmt_n + 1; i < nargin; i++) |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
816 tmp_args(i-fmt_n-1) = args(i); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
817 } |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
818 |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
819 result = os.printf (args(fmt_n), tmp_args, who); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
820 |
4715 | 821 if (nargout > 0) |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
822 return ovl (result); |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
823 else |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
824 return ovl (); |
1181 | 825 } |
826 | |
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
827 DEFUN (printf, args, nargout, |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
828 "-*- texinfo -*-\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
829 @deftypefn {} {} printf (@var{template}, @dots{})\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
830 Print optional arguments under the control of the template string\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
831 @var{template} to the stream @code{stdout} and return the number of\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
832 characters printed.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
833 @ifclear OCTAVE_MANUAL\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
834 \n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
835 See the Formatted Output section of the GNU Octave manual for a\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
836 complete description of the syntax of the template string.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
837 @end ifclear\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
838 \n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
839 Implementation Note: For compatibility with @sc{matlab}, escape sequences in\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
840 the template string (e.g., @qcode{\"@xbackslashchar{}n\"} => newline) are\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
841 expanded even when the template string is defined with single quotes.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
842 @seealso{fprintf, sprintf, scanf}\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
843 @end deftypefn") |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
844 { |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
845 static std::string who = "printf"; |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
846 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
847 int nargin = args.length (); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
848 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
849 if (nargin == 0) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
850 print_usage (); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
851 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
852 int result; |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
853 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
854 if (! args(0).is_string ()) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
855 error ("%s: format TEMPLATE must be a string", who.c_str ()); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
856 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
857 octave_value_list tmp_args; |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
858 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
859 if (nargin > 1) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
860 { |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
861 tmp_args.resize (nargin-1, octave_value ()); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
862 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
863 for (int i = 1; i < nargin; i++) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
864 tmp_args(i-1) = args(i); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
865 } |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
866 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
867 result = stdout_stream.printf (args(0), tmp_args, who); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
868 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
869 if (nargout > 0) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
870 return ovl (result); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
871 else |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
872 return ovl (); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
873 } |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
874 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
875 DEFUN (fputs, args, , |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
876 "-*- texinfo -*-\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
877 @deftypefn {} {} fputs (@var{fid}, @var{string})\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
878 @deftypefnx {} {@var{status} =} fputs (@var{fid}, @var{string})\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
879 Write the string @var{string} to the file with file descriptor @var{fid}.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
880 \n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
881 The string is written to the file with no additional formatting. Use\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
882 @code{fdisp} instead to automatically append a newline character appropriate\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
883 for the local machine.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
884 \n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
885 Return a non-negative number on success or EOF on error.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
886 @seealso{fdisp, fprintf, fwrite, fopen}\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
887 @end deftypefn") |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
888 { |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
889 static std::string who = "fputs"; |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
890 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
891 if (args.length () != 2) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
892 print_usage (); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
893 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
894 octave_stream os = octave_stream_list::lookup (args(0), who); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
895 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
896 return ovl (os.puts (args(1), who)); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
897 } |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
898 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
899 DEFUN (puts, args, , |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
900 "-*- texinfo -*-\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
901 @deftypefn {} {} puts (@var{string})\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
902 @deftypefnx {} {@var{status} =} puts (@var{string})\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
903 Write a string to the standard output with no formatting.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
904 \n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
905 The string is written verbatim to the standard output. Use @code{disp} to\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
906 automatically append a newline character appropriate for the local machine.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
907 \n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
908 Return a non-negative number on success and EOF on error.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
909 @seealso{fputs, disp}\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
910 @end deftypefn") |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
911 { |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
912 static std::string who = "puts"; |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
913 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
914 if (args.length () != 1) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
915 print_usage (); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
916 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
917 return ovl (stdout_stream.puts (args(0), who)); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
918 } |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
919 |
2095 | 920 DEFUN (sprintf, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
921 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
922 @deftypefn {} {} sprintf (@var{template}, @dots{})\n\ |
3372 | 923 This is like @code{printf}, except that the output is returned as a\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
924 string.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
925 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
926 Unlike the C library function, which requires you to provide a suitably\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
927 sized string as an argument, Octave's @code{sprintf} function returns the\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
928 string, automatically sized to hold all of the items converted.\n\ |
20041
dbf2418a46dd
Document expansion of escape sequences in single quotes (bug #44745).
Rik <rik@octave.org>
parents:
19861
diff
changeset
|
929 \n\ |
20097
1f9ed81bd173
maint: Fix spelling and grammar mistakes in docs and comments (bug #44878)
Rafael Laboissiere <rafael@laboissiere.net>
parents:
20041
diff
changeset
|
930 Implementation Note: For compatibility with @sc{matlab}, escape sequences in\n\ |
20101
e51473fdb622
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
20097
diff
changeset
|
931 the template string (e.g., @qcode{\"@xbackslashchar{}n\"} => newline) are\n\ |
e51473fdb622
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
20097
diff
changeset
|
932 expanded even when the template string is defined with single quotes.\n\ |
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
933 @seealso{printf, fprintf, sscanf}\n\ |
5642 | 934 @end deftypefn") |
1 | 935 { |
4468 | 936 static std::string who = "sprintf"; |
937 | |
2095 | 938 int nargin = args.length (); |
1 | 939 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
940 if (nargin == 0) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
941 print_usage (); |
2116 | 942 |
21506
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
943 // We don't use octave_ostrstream::create here because need direct |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
944 // access to the OSTR object so that we can extract a string object |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
945 // from it to return. |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
946 octave_ostrstream *ostr = new octave_ostrstream (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
947 |
21506
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
948 // The octave_stream destructor will delete OSTR for us. |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
949 octave_stream os (ostr); |
628 | 950 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
951 if (! os.is_valid ()) |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
952 error ("%s: unable to create output buffer", who.c_str ()); |
1 | 953 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
954 octave_value fmt_arg = args(0); |
1 | 955 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
956 if (! fmt_arg.is_string ()) |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
957 error ("%s: format TEMPLATE must be a string", who.c_str ()); |
628 | 958 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
959 octave_value_list retval (3); |
19727
3c3b9fce7d2b
improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
960 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
961 octave_value_list tmp_args; |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
962 if (nargin > 1) |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
963 { |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
964 tmp_args.resize (nargin-1, octave_value ()); |
19727
3c3b9fce7d2b
improve compatibility of sprintf function.
John W. Eaton <jwe@octave.org>
parents:
19697
diff
changeset
|
965 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
966 for (int i = 1; i < nargin; i++) |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
967 tmp_args(i-1) = args(i); |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
968 } |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
969 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
970 // NOTE: Call to os.error must precede next call to ostr which might reset it. |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
971 retval(2) = os.printf (fmt_arg, tmp_args, who); |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
972 retval(1) = os.error (); |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
973 |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
974 std::string result = ostr->str (); |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
975 char type = fmt_arg.is_sq_string () ? '\'' : '"'; |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
976 |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
977 retval(0) = (result.empty () ? octave_value (charMatrix (1, 0), type) |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20884
diff
changeset
|
978 : octave_value (result, type)); |
1 | 979 |
980 return retval; | |
981 } | |
982 | |
2095 | 983 DEFUN (fscanf, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
984 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
985 @deftypefn {} {[@var{val}, @var{count}, @var{errmsg}] =} fscanf (@var{fid}, @var{template}, @var{size})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
986 @deftypefnx {} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}] =} fscanf (@var{fid}, @var{template}, \"C\")\n\ |
3372 | 987 In the first form, read from @var{fid} according to @var{template},\n\ |
988 returning the result in the matrix @var{val}.\n\ | |
2122 | 989 \n\ |
3372 | 990 The optional argument @var{size} specifies the amount of data to read\n\ |
991 and may be one of\n\ | |
992 \n\ | |
993 @table @code\n\ | |
994 @item Inf\n\ | |
995 Read as much as possible, returning a column vector.\n\ | |
996 \n\ | |
997 @item @var{nr}\n\ | |
998 Read up to @var{nr} elements, returning a column vector.\n\ | |
2122 | 999 \n\ |
3372 | 1000 @item [@var{nr}, Inf]\n\ |
1001 Read as much as possible, returning a matrix with @var{nr} rows. If the\n\ | |
1002 number of elements read is not an exact multiple of @var{nr}, the last\n\ | |
1003 column is padded with zeros.\n\ | |
1004 \n\ | |
1005 @item [@var{nr}, @var{nc}]\n\ | |
1006 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with\n\ | |
1007 @var{nr} rows. If the number of elements read is not an exact multiple\n\ | |
1008 of @var{nr}, the last column is padded with zeros.\n\ | |
1009 @end table\n\ | |
2122 | 1010 \n\ |
3372 | 1011 @noindent\n\ |
1012 If @var{size} is omitted, a value of @code{Inf} is assumed.\n\ | |
2122 | 1013 \n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
1014 A string is returned if @var{template} specifies only character conversions.\n\ |
2215 | 1015 \n\ |
3372 | 1016 The number of items successfully read is returned in @var{count}.\n\ |
2215 | 1017 \n\ |
13271
fba2cc36b762
return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents:
13194
diff
changeset
|
1018 If an error occurs, @var{errmsg} contains a system-dependent error message.\n\ |
fba2cc36b762
return stream error message in scanf functions and document behavior
John W. Eaton <jwe@octave.org>
parents:
13194
diff
changeset
|
1019 \n\ |
3372 | 1020 In the second form, read from @var{fid} according to @var{template},\n\ |
1021 with each conversion specifier in @var{template} corresponding to a\n\ | |
16766
7268845c0a1e
avoid backquote in error messages, some uses in doc strings
John W. Eaton <jwe@octave.org>
parents:
16590
diff
changeset
|
1022 single scalar return value. This form is more ``C-like'', and also\n\ |
3491 | 1023 compatible with previous versions of Octave. The number of successful\n\ |
16099
4b6c44096862
Backout changeset 238e499c5fea (locale support in scanf)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
1024 conversions is returned in @var{count}\n\ |
5653 | 1025 @ifclear OCTAVE_MANUAL\n\ |
1026 \n\ | |
1027 See the Formatted Input section of the GNU Octave manual for a\n\ | |
1028 complete description of the syntax of the template string.\n\ | |
1029 @end ifclear\n\ | |
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1030 @seealso{fgets, fgetl, fread, scanf, sscanf, fopen}\n\ |
5642 | 1031 @end deftypefn") |
1181 | 1032 { |
4468 | 1033 static std::string who = "fscanf"; |
1034 | |
1181 | 1035 int nargin = args.length (); |
1036 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
1037 if (nargin < 2 || nargin > 3) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
1038 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
1039 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1040 octave_value_list retval; |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1041 |
21506
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1042 octave_stream os = octave_stream_list::lookup (args(0), who); |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1043 |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1044 if (! args(1).is_string ()) |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1045 error ("%s: format TEMPLATE must be a string", who.c_str ()); |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1046 |
2215 | 1047 if (nargin == 3 && args(2).is_string ()) |
2095 | 1048 { |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1049 retval = ovl (os.oscanf (args(1), who)); |
2095 | 1050 } |
1181 | 1051 else |
2215 | 1052 { |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1053 octave_idx_type count = 0; |
2215 | 1054 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1055 Array<double> size = (nargin == 3) |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1056 ? args(2).vector_value () |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1057 : Array<double> (dim_vector (1, 1), |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1058 lo_ieee_inf_value ()); |
2215 | 1059 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1060 octave_value tmp = os.scanf (args(1), size, count, who); |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
1061 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1062 retval = ovl (tmp, count, os.error ()); |
2215 | 1063 } |
1181 | 1064 |
1065 return retval; | |
1066 } | |
1067 | |
13194
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1068 static std::string |
21507
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1069 get_scan_string_data (const octave_value& val, const std::string& who) |
13194
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1070 { |
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1071 std::string retval; |
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1072 |
20962
3aa293be0e8d
maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents:
20956
diff
changeset
|
1073 if (! val.is_string ()) |
21507
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1074 error ("%s: argument STRING must be a string", who.c_str ()); |
13194
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1075 |
20962
3aa293be0e8d
maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents:
20956
diff
changeset
|
1076 octave_value tmp = val.reshape (dim_vector (1, val.numel ())); |
3aa293be0e8d
maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents:
20956
diff
changeset
|
1077 |
3aa293be0e8d
maint: Invert simple conditionals in if/else/error paradigm.
Rik <rik@octave.org>
parents:
20956
diff
changeset
|
1078 retval = tmp.string_value (); |
13194
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1079 |
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1080 return retval; |
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1081 } |
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
12998
diff
changeset
|
1082 |
2095 | 1083 DEFUN (sscanf, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
1084 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
1085 @deftypefn {} {[@var{val}, @var{count}, @var{errmsg}, @var{pos}] =} sscanf (@var{string}, @var{template}, @var{size})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
1086 @deftypefnx {} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}] =} sscanf (@var{string}, @var{template}, \"C\")\n\ |
3372 | 1087 This is like @code{fscanf}, except that the characters are taken from the\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
1088 string @var{string} instead of from a stream.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
1089 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
1090 Reaching the end of the string is treated as an end-of-file condition. In\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
1091 addition to the values returned by @code{fscanf}, the index of the next\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
1092 character to be read is returned in @var{pos}.\n\ |
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1093 @seealso{fscanf, scanf, sprintf}\n\ |
5642 | 1094 @end deftypefn") |
444 | 1095 { |
4468 | 1096 static std::string who = "sscanf"; |
1097 | |
506 | 1098 int nargin = args.length (); |
1099 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
1100 if (nargin < 2 || nargin > 3) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
1101 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
1102 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1103 octave_value_list retval; |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1104 |
21507
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1105 std::string data = get_scan_string_data (args(0), who); |
21506
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1106 |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1107 octave_stream os = octave_istrstream::create (data); |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1108 |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1109 if (! os.is_valid ()) |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1110 error ("%s: unable to create temporary input buffer", who.c_str ()); |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1111 |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1112 if (! args(1).is_string ()) |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1113 error ("%s: format TEMPLATE must be a string", who.c_str ()); |
128703a29388
avoid some duplicate code in file-io functions
John W. Eaton <jwe@octave.org>
parents:
21504
diff
changeset
|
1114 |
2215 | 1115 if (nargin == 3 && args(2).is_string ()) |
2095 | 1116 { |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1117 retval = ovl (os.oscanf (args(1), who)); |
444 | 1118 } |
1119 else | |
2215 | 1120 { |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1121 octave_idx_type count = 0; |
2215 | 1122 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1123 Array<double> size = (nargin == 3) ? args(2).vector_value () |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1124 : Array<double> (dim_vector (1, 1), |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1125 lo_ieee_inf_value ()); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1126 |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1127 octave_value tmp = os.scanf (args(1), size, count, who); |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
1128 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1129 // FIXME: is this the right thing to do? |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1130 // Extract error message first, because getting |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1131 // position will clear it. |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1132 std::string errmsg = os.error (); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1133 |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1134 retval = ovl (tmp, count, errmsg, |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
1135 (os.eof () ? data.length () : os.tell ()) + 1); |
2215 | 1136 } |
444 | 1137 |
1138 return retval; | |
1139 } | |
1140 | |
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1141 DEFUN (scanf, args, nargout, |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1142 "-*- texinfo -*-\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1143 @deftypefn {} {[@var{val}, @var{count}, @var{errmsg}] =} scanf (@var{template}, @var{size})\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1144 @deftypefnx {} {[@var{v1}, @var{v2}, @dots{}, @var{count}, @var{errmsg}]] =} scanf (@var{template}, \"C\")\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1145 This is equivalent to calling @code{fscanf} with @var{fid} = @code{stdin}.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1146 \n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1147 It is currently not useful to call @code{scanf} in interactive programs.\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1148 @seealso{fscanf, sscanf, printf}\n\ |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1149 @end deftypefn") |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1150 { |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1151 int nargin = args.length (); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1152 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1153 octave_value_list tmp_args (nargin+1, octave_value ()); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1154 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1155 tmp_args (0) = 0.0; |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1156 for (int i = 0; i < nargin; i++) |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1157 tmp_args(i+1) = args(i); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1158 |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1159 return Ffscanf (tmp_args, nargout); |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1160 } |
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
1161 |
21504 | 1162 static octave_value_list |
1163 textscan_internal (const std::string& who, const octave_value_list& args) | |
1164 { | |
1165 if (args.length () < 1) | |
1166 print_usage (who); | |
1167 | |
21507
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1168 octave_stream os; |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1169 |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1170 if (args(0).is_string ()) |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1171 { |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1172 std::string data = get_scan_string_data (args(0), who); |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1173 |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1174 os = octave_istrstream::create (data); |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1175 |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1176 if (! os.is_valid ()) |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1177 error ("%s: unable to create temporary input buffer", who.c_str ()); |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1178 } |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1179 else |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
1180 os =octave_stream_list::lookup (args(0), who); |
21504 | 1181 |
1182 int nskip = 1; | |
1183 | |
1184 std::string fmt; | |
1185 | |
1186 if (args.length () == 1) | |
1187 { | |
1188 // ommited format = %f. explicit "" = width from file | |
1189 fmt = "%f"; | |
1190 } | |
1191 else if (args(1).is_string ()) | |
1192 { | |
1193 fmt = args(1).string_value (); | |
1194 | |
1195 if (args(1).is_sq_string ()) | |
1196 fmt = do_string_escapes (fmt); | |
1197 | |
1198 nskip++; | |
1199 } | |
1200 else | |
1201 error ("%s: FORMAT must be a string", who.c_str ()); | |
1202 | |
1203 octave_idx_type ntimes = -1; | |
1204 | |
1205 if (args.length () > 2) | |
1206 { | |
1207 if (args(2).is_numeric_type ()) | |
1208 { | |
1209 ntimes = args(2).idx_type_value (); | |
1210 | |
1211 if (ntimes < args(2).double_value ()) | |
1212 error ("%s: REPEAT = %g is too large", | |
1213 who.c_str (), args(2).double_value ()); | |
1214 | |
1215 nskip++; | |
1216 } | |
1217 } | |
1218 | |
1219 octave_value_list options = args.splice (0, nskip); | |
1220 | |
1221 octave_idx_type count = 0; | |
1222 | |
1223 octave_value result = os.textscan (fmt, ntimes, options, who, count); | |
1224 | |
1225 std::string errmsg = os.error (); | |
1226 | |
1227 return ovl (result, count, errmsg); | |
1228 } | |
1229 | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1230 DEFUN (textscan, args, , |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1231 "-*- texinfo -*-\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1232 @deftypefn {} {@var{C} =} textscan (@var{fid}, @var{format})\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1233 @deftypefnx {} {@var{C} =} textscan (@var{fid}, @var{format}, @var{repeat})\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1234 @deftypefnx {} {@var{C} =} textscan (@var{fid}, @var{format}, @var{param}, @var{value}, @dots{})\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1235 @deftypefnx {} {@var{C} =} textscan (@var{fid}, @var{format}, @var{repeat}, @var{param}, @var{value}, @dots{})\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1236 @deftypefnx {} {@var{C} =} textscan (@var{str}, @dots{})\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1237 @deftypefnx {} {[@var{C}, @var{position}, @var{errmsg}] =} textscan (@dots{})\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1238 Read data from a text file or string.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1239 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1240 The string @var{str} or file associated with @var{fid} is read from and\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1241 parsed according to @var{format}. The function is an extension of\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1242 @code{strread} and @code{textread}. Differences include: the ability to\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1243 read from either a file or a string, additional options, and additional\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1244 format specifiers.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1245 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1246 The input is interpreted as a sequence of words, delimiters (such as\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1247 whitespace), and literals. The characters that form delimiters and\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1248 whitespace are determined by the options. The format consists of format\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1249 specifiers interspersed between literals. In the format, whitespace forms\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1250 a delimiter between consecutive literals, but is otherwise ignored.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1251 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1252 The output @var{C} is a cell array where the number of columns is determined\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1253 by the number of format specifiers.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1254 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1255 The first word of the input is matched to the first specifier of the format\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1256 and placed in the first column of the output; the second is matched to the\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1257 second specifier and placed in the second column and so forth. If there\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1258 are more words than specifiers then the process is repeated until all words\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1259 have been processed or the limit imposed by @var{repeat} has been met (see\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1260 below).\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1261 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1262 The string @var{format} describes how the words in @var{str} should be\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1263 parsed. As in @var{fscanf}, any (non-whitespace) text in the format that is\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1264 not one of these specifiers is considered a literal. If there is a literal\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1265 between two format specifiers then that same literal must appear in the\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1266 input stream between the matching words.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1267 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1268 The following specifiers are valid:\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1269 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1270 @table @code\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1271 @item %f\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1272 @itemx %f64\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1273 @itemx %n\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1274 The word is parsed as a number and converted to double.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1275 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1276 @item %f32\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1277 The word is parsed as a number and converted to single (float).\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1278 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1279 @item %d\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1280 @itemx %d8\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1281 @itemx %d16\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1282 @itemx %d32\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1283 @itemx %d64\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1284 The word is parsed as a number and converted to int8, int16, int32, or\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1285 int64. If no size is specified then int32 is used.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1286 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1287 @item %u\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1288 @itemx %u8\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1289 @itemx %u16\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1290 @itemx %u32\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1291 @itemx %u64\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1292 The word is parsed as a number and converted to uint8, uint16, uint32, or\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1293 uint64. If no size is specified then uint32 is used.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1294 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1295 @item %s\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1296 The word is parsed as a string ending at the last character before\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1297 whitespace, an end-of-line, or a delimiter specified in the options.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1298 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1299 @item %q\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1300 The word is parsed as a \"quoted string\".\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1301 If the first character of the string is a double quote (\") then the string\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1302 includes everything until a matching double quote---including whitespace,\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1303 delimiters, and end-of-line characters. If a pair of consecutive double\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1304 quotes appears in the input, it is replaced in the output by a single\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1305 double quote. For examples, the input \"He said \"\"Hello\"\"\" would\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1306 return the value 'He said \"Hello\"'.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1307 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1308 @item %c\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1309 The next character of the input is read.\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1310 This includes delimiters, whitespace, and end-of-line characters.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1311 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1312 @item %[@dots{}]\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1313 @itemx %[^@dots{}]\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1314 In the first form, the word consists of the longest run consisting of only\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1315 characters between the brackets. Ranges of characters can be specified by\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1316 a hyphen; for example, %[0-9a-zA-Z] matches all alphanumeric characters (if\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1317 the underlying character set is ASCII). Since @sc{matlab} treats hyphens\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1318 literally, this expansion only applies to alphanumeric characters. To\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1319 include '-' in the set, it should appear first or last in the brackets; to\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1320 include ']', it should be the first character. If the first character is\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1321 '^' then the word consists of characters @strong{not} listed.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1322 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1323 @item %N@dots{}\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1324 For %s, %c %d, %f, %n, %u, an optional width can be specified as %Ns, etc.\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1325 where N is an integer > 1. For %c, this causes exactly N characters to be\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1326 read instead of a single character. For the other specifiers, it is an\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1327 upper bound on the number of characters read; normal delimiters can cause\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1328 fewer characters to be read. For complex numbers, this limit applies to\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1329 the real and imaginary components individually. For %f and %n, format\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1330 specifiers like %N.Mf are allowed, where M is an upper bound on number of\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1331 characters after the decimal point to be considered; subsequent digits are\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1332 skipped. For example, the specifier %8.2f would read 12.345e6 as 1.234e7.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1333 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1334 @item %*@dots{}\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1335 The word specified by the remainder of the conversion specifier is skipped.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1336 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1337 @item literals\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1338 In addition the format may contain literal character strings; these will be\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1339 skipped during reading. If the input string does not match this literal,\n\ |
21622
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1340 the processing terminates.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1341 @end table\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1342 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1343 Parsed words corresponding to the first specifier are returned in the first\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1344 output argument and likewise for the rest of the specifiers.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1345 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1346 By default, if there is only one input argument, @var{format} is @t{\"%f\"}.\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1347 This means that numbers are read from the input into a single column vector.\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1348 If @var{format} is explicitly empty (@qcode{\"\"}) then textscan will\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1349 return data in a number of columns matching the number of fields on the\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1350 first data line of the input. Either of these is suitable only when the\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1351 input is exclusively numeric.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1352 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1353 For example, the string\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1354 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1355 @smallexample\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1356 @group\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1357 @var{str} = \"\\\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1358 Bunny Bugs 5.5\\n\\\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1359 Duck Daffy -7.5e-5\\n\\\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1360 Penguin Tux 6\"\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1361 @end group\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1362 @end smallexample\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1363 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1364 @noindent\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1365 can be read using\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1366 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1367 @example\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1368 @var{a} = textscan (@var{str}, \"%s %s %f\");\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1369 @end example\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1370 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1371 The optional numeric argument @var{repeat} can be used for limiting the\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1372 number of items read:\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1373 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1374 @table @asis\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1375 @item -1\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1376 Read all of the string or file until the end (default).\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1377 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1378 @item N\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1379 Read until the first of two conditions occurs: 1) the format has been\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1380 processed N times, or 2) N lines of the input have been processed. Zero\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1381 (0) is an acceptable value for @var{repeat}. Currently, end-of-line\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1382 characters inside %q, %c, and %[@dots{}]$ conversions do not contribute to\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1383 the line count. This is incompatible with @sc{matlab} and may change in\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1384 future.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1385 @end table\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1386 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1387 The behavior of @code{textscan} can be changed via property/value pairs.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1388 The following properties are recognized:\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1389 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1390 @table @asis\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1391 @item @qcode{\"BufSize\"}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1392 This specifies the number of bytes to use for the internal buffer.\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1393 A modest speed improvement may be obtained by setting this to a large value\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1394 when reading a large file, especially if the input contains long strings.\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1395 The default is 4096, or a value dependent on @var{n} if that is specified.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1396 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1397 @item @qcode{\"CollectOutput\"}\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1398 A value of 1 or true instructs @code{textscan} to concatenate consecutive\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1399 columns of the same class in the output cell array. A value of 0 or false\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1400 (default) leaves output in distinct columns.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1401 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1402 @item @qcode{\"CommentStyle\"}\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1403 Specify parts of the input which are considered comments and will be\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1404 skipped. @var{value} is the comment style and can be either (1) A string\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1405 or 1x1 cell string, to skip everything to the right of it; (2) A cell array\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1406 of two strings, to skip everything between the first and second strings. \n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1407 Comments are only parsed where whitespace is accepted and do not act as\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1408 delimiters.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1409 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1410 @item @qcode{\"Delimiter\"}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1411 If @var{value} is a string, any character in @var{value} will be used to\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1412 split the input into words. If @var{value} is a cell array of strings,\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1413 any string in the array will be used to split the input into words.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1414 (default value = any whitespace.)\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1415 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1416 @item @qcode{\"EmptyValue\"}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1417 Value to return for empty numeric values in non-whitespace delimited data.\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1418 The default is NaN@. When the data type does not support NaN (int32 for\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1419 example), then the default is zero.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1420 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1421 @item @qcode{\"EndOfLine\"}\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1422 @var{value} can be either an emtpy or one character specifying the\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1423 end-of-line character, or the pair\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1424 @qcode{\"@xbackslashchar{}r@xbackslashchar{}n\"} (CRLF).\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1425 In the latter case, any of\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1426 @qcode{\"@xbackslashchar{}r\"}, @qcode{\"@xbackslashchar{}n\"} or\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1427 @qcode{\"@xbackslashchar{}r@xbackslashchar{}n\"} is counted as a (single)\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1428 newline. If no value is given,\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1429 @qcode{\"@xbackslashchar{}r@xbackslashchar{}n\"} is used.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1430 @c If set to \"\" (empty string) EOLs are ignored as delimiters and added\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1431 @c to whitespace.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1432 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1433 @c When reading from a character string, optional input argument @var{n}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1434 @c specifies the number of times @var{format} should be used (i.e., to limit\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1435 @c the amount of data read).\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1436 @c When reading from file, @var{n} specifies the number of data lines to read;\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1437 @c in this sense it differs slightly from the format repeat count in strread.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1438 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1439 @item @qcode{\"HeaderLines\"}\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1440 The first @var{value} number of lines of @var{fid} are skipped. Note that\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1441 this does not refer to the first non-comment lines, but the first lines of\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1442 any type.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1443 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1444 @item @qcode{\"MultipleDelimsAsOne\"}\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1445 If @var{value} is nonzero, treat a series of consecutive delimiters,\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1446 without whitespace in between, as a single delimiter. Consecutive\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1447 delimiter series need not be vertically aligned. Without this option, a\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1448 single delimiter before the end of the line does not cause the line to be\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1449 considered to end with an empty value, but a single delimiter at the start\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1450 of a line causes the line to be considered to start with an empty value.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1451 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1452 @item @qcode{\"TreatAsEmpty\"}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1453 Treat single occurrences (surrounded by delimiters or whitespace) of the\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1454 string(s) in @var{value} as missing values.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1455 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1456 @item @qcode{\"ReturnOnError\"}\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1457 If set to numerical 1 or true, return normally as soon as an error is\n\ |
21622
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1458 encountered, such as trying to read a string using @qcode{%f}.\n\ |
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1459 If set to 0 or false, return an error and no data.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1460 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1461 @item @qcode{\"Whitespace\"}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1462 Any character in @var{value} will be interpreted as whitespace and trimmed;\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1463 The default value for whitespace is\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1464 @c Note: the next line specifically has a newline which generates a space\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1465 @c in the output of qcode, but keeps the next line < 80 characters.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1466 @qcode{\"\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1467 @xbackslashchar{}b@xbackslashchar{}r@xbackslashchar{}n@xbackslashchar{}t\"}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1468 (note the space). Unless whitespace is set to @qcode{\"\"} (empty) AND at\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1469 least one @qcode{\"%s\"} format conversion specifier is supplied, a space is\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1470 always part of whitespace.\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1471 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1472 @end table\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1473 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1474 When the number of words in @var{str} or @var{fid} doesn't match an exact\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1475 multiple of the number of format conversion specifiers, @code{textscan}'s\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1476 behavior depends on whether the last character of the string or file is an\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1477 end-of-line as specified by the @code{EndOfLine} option:\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1478 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1479 @table @asis\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1480 @item last character = end-of-line\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1481 Data columns are padded with empty fields, NaN or 0 (for integer fields) so\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1482 that all columns have equal length\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1483 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1484 @item last character is not end-of-line\n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1485 Data columns are not padded; @code{textscan} returns columns of unequal\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1486 length\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1487 @end table\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1488 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1489 \n\ |
21548
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1490 The second output @var{position} provides the location, in characters\n\ |
f044dc45b8b1
doc: grammarcheck and spellcheck new textscan docstring.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
1491 from the beginning of the file or string, where processing stopped.\n\ |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1492 \n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1493 @seealso{dlmread, fscanf, load, strread, textread}\n\ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1494 @end deftypefn") |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1495 { |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1496 static std::string who = "textscan"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1497 |
21504 | 1498 return textscan_internal (who, args); |
1499 } | |
1500 | |
1501 DEFUN (__textscan__, args, , | |
1502 "-*- texinfo -*-\n\ | |
1503 @deftypefn {} {@var{C} =} __textscan__ (@var{who}, @dots{})\n\ | |
1504 Like @code{textscan} but accept additional argument @var{who} to use\n\ | |
1505 as the name of the function when reporting errors.\n\ | |
1506 @end deftypefn") | |
1507 { | |
1508 if (args.length () == 0) | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1509 print_usage (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1510 |
21504 | 1511 return textscan_internal (args(0).string_value (), args.splice (0, 1)); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1512 } |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1513 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1514 /* |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1515 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1516 %! str = "1, 2, 3, 4\n 5, , , 8\n 9, 10, 11, 12"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1517 %! fmtstr = "%f %d %f %s"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1518 %! c = textscan (str, fmtstr, 2, "delimiter", ",", "emptyvalue", -Inf); |
21625 | 1519 %! assert (c{1}, [1;5]); |
1520 %! assert (c{3}, [3; -Inf]); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1521 %! assert (iscellstr (c{4})); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1522 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1523 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1524 %! b = [10:10:100]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1525 %! b = [b; 8*b/5]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1526 %! str = sprintf ("%g miles/hr = %g kilometers/hr\n", b); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1527 %! fmt = "%f miles/hr = %f kilometers/hr"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1528 %! c = textscan (str, fmt); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1529 %! assert (c{1}, b(1,:)', 1e-5); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1530 %! assert (c{2}, b(2,:)', 1e-5); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1531 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1532 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1533 %! str = "13, -, NA, str1, -25\r\n// Middle line\r\n36, na, 05, str3, 6"; |
21625 | 1534 %! c = textscan (str, "%d %n %f %s %n", "delimiter", ",", |
1535 %! "treatAsEmpty", {"NA", "na", "-"}, "commentStyle", "//"); | |
1536 %! assert (c{1}, int32 ([13; 36])); | |
1537 %! assert (c{2}, [NaN; NaN]); | |
1538 %! assert (c{3}, [NaN; 5]); | |
1539 %! assert (c{4}, {"str1"; "str3"}); | |
1540 %! assert (c{5}, [-25; 6]); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1541 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1542 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1543 %! str = "Km:10 = hhhBjjj miles16hour\r\n"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1544 %! str = [str "Km:15 = hhhJjjj miles241hour\r\n"]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1545 %! str = [str "Km:2 = hhhRjjj miles3hour\r\n"]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1546 %! str = [str "Km:25 = hhhZ\r\n"]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1547 %! fmt = "Km:%d = hhh%1sjjj miles%dhour"; |
21625 | 1548 %! c = textscan (str, fmt, "delimiter", " "); |
1549 %! assert (c{1}', int32 ([10, 15, 2, 25])); | |
1550 %! assert (c{2}', {'B' 'J' 'R' 'Z'}); | |
1551 %! assert (c{3}', int32 ([16, 241, 3, 0])); | |
1552 | |
1553 ## Test with default EndOfLine parameter | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1554 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1555 %! c = textscan ("L1\nL2", "%s"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1556 %! assert (c{:}, {"L1"; "L2"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1557 |
21625 | 1558 ## Test with EndofLine parameter set to "" (empty) - newline should be in word |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1559 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1560 %! c = textscan ("L1\nL2", "%s", "endofline", ""); |
21625 | 1561 %! assert (int8 ([c{:}{:}]), int8 ([76, 49, 10, 76, 50])); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1562 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1563 ### Matlab fails this test. A literal after a conversion is not a delimiter |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1564 #%!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1565 #%! ## No delimiters at all besides EOL. Skip fields, even empty fields |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1566 #%! str = "Text1Text2Text\nTextText4Text\nText57Text"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1567 #%! c = textscan (str, "Text%*dText%dText"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1568 #%! assert (c{1}, int32 ([2; 4; 0])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1569 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1570 ## CollectOutput test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1571 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1572 %! b = [10:10:100]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1573 %! b = [b; 8*b/5; 8*b*1000/5]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1574 %! str = sprintf ("%g miles/hr = %g (%g) kilometers (meters)/hr\n", b); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1575 %! fmt = "%f miles%s %s %f (%f) kilometers %*s"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1576 %! c = textscan (str, fmt, "collectoutput", 1); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1577 %! assert (size (c{3}), [10, 2]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1578 %! assert (size (c{2}), [10, 2]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1579 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1580 ## CollectOutput test with uneven column length files |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1581 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1582 %! b = [10:10:100]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1583 %! b = [b; 8*b/5; 8*b*1000/5]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1584 %! str = sprintf ("%g miles/hr = %g (%g) kilometers (meters)/hr\n", b); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1585 %! str = [str "110 miles/hr"]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1586 %! fmt = "%f miles%s %s %f (%f) kilometers %*s"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1587 %! c = textscan (str, fmt, "collectoutput", 1); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1588 %! assert (size (c{1}), [11, 1]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1589 %! assert (size (c{3}), [11, 2]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1590 %! assert (size (c{2}), [11, 2]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1591 %! assert (c{3}(end), NaN); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1592 %! assert (c{2}{11, 1}, "/hr"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1593 %! assert (isempty (c{2}{11, 2}), true); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1594 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1595 ## Double quoted string |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1596 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1597 %! str = 'First "the second called ""the middle""" third'; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1598 %! fmt = "%q"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1599 %! c = textscan (str, fmt); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1600 %! assert (c{1}, {"First"; 'the second called "the middle"'; "third"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1601 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1602 ## Arbitrary character |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1603 %!test |
21625 | 1604 %! c = textscan ("a first, \n second, third", "%s %c %11c", "delimiter", " ,"); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1605 %! assert (c{1}, {"a"; "ond"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1606 %! assert (c{2}, {"f"; "t"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1607 %! assert (c{3}, {"irst, \n sec"; "hird"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1608 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1609 ## Field width and non-standard delimiters |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1610 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1611 %! str = "12;34;123456789;7"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1612 %! c = textscan (str, "%4d %4d", "delimiter", ";", "collectOutput", 1); |
21625 | 1613 %! assert (c, {[12, 34; 1234, 5678; 9, 7]}); |
1614 | |
1615 ## Field width and non-standard delimiters (2) | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1616 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1617 %! str = "12;34;123456789;7"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1618 %! c = textscan (str, "%4f %f", "delimiter", ";", "collectOutput", 1); |
21625 | 1619 %! assert (c, {[12, 34; 1234, 56789; 7, NaN]}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1620 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1621 ## Ignore trailing delimiter, but use leading one |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1622 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1623 %! str = "12.234e+2,34, \n12345.789-9876j,78\n,10|3"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1624 %! c = textscan (str, "%10.2f %f", "delimiter", ",", "collectOutput", 1, |
21625 | 1625 %! "expChars", "e|"); |
1626 %! assert (c, {[1223, 34; 12345.79-9876j, 78; NaN, 10000]}, 1e-6); | |
1627 | |
1628 ## Multi-character delimiter | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1629 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1630 %! str = "99end2 space88gap 4564"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1631 %! c = textscan (str, "%d %s", "delimiter", {"end", "gap", "space"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1632 %! assert (c{1}, int32 ([99; 88])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1633 %! assert (c{2}, {"2 "; "4564"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1634 |
21625 | 1635 ## FIXME: Following two tests still fail (4/13/2016)? |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1636 ### Delimiters as part of literals, and following literals |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1637 #%!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1638 #%! str = "12 R&D & 7"; |
21625 | 1639 #%! c = textscan (str, "%f R&D %f", "delimiter", "&", "collectOutput", 1, |
1640 #%! "EmptyValue", -99); | |
1641 #%! assert (c, {[12, -99; 7, -99]}); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1642 # |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1643 ### Delimiters as part of literals, and before literals |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1644 #%!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1645 #%! str = "12 & R&D 7"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1646 #%! c = textscan (str, "%f R&D %f", "delimiter", "&", "collectOutput", 1); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1647 #%! assert (c, {[12 7]}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1648 |
21625 | 1649 ## Check number of lines read, not number of passes through format string |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1650 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1651 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1652 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1653 %! fprintf (fid, "1\n2\n3\n4\n5\n6"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1654 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1655 %! c = textscan (fid, "%f %f", 2); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1656 %! E = feof (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1657 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1658 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1659 %! assert (c, {1, 2}); |
21625 | 1660 %! assert (! E); |
1661 | |
1662 ## Check number of lines read, not number of passes through format string | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1663 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1664 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1665 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1666 %! fprintf (fid, "1\r\n2\r3\n4\r\n5\n6"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1667 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1668 %! c = textscan (fid, "%f %f", 4); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1669 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1670 %! unlink (f); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
1671 %! assert (c, {[1;3], [2;4]}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1672 |
21625 | 1673 ## Check number of lines read, with multiple delimiters |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1674 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1675 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1676 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1677 %! fprintf (fid, "1-\r\n-2\r3-\n-4\r\n5\n6"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1678 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1679 %! c = textscan (fid, "%f %f", 4, "delimiter", "-", "multipleDelimsAsOne", 1); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1680 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1681 %! unlink (f); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
1682 %! assert (c, {[1;3], [2;4]}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1683 |
21625 | 1684 ## Check ReturnOnError |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1685 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1686 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1687 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1688 %! str = "1 2 3\n4 s 6"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1689 %! fprintf (fid, str); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1690 %! fseek (fid, 0, "bof"); |
21622
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1691 %! c = textscan (fid, "%f %f %f", "ReturnOnError", 1); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1692 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1693 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1694 %! unlink (f); |
21622
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1695 %! u = textscan (str, "%f %f %f", "ReturnOnError", 1); |
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1696 %! assert (c, {[1;4], [2], [3]}); |
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1697 %! assert (u, {[1;4], [2], [3]}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1698 |
21625 | 1699 %! ## Check ReturnOnError (2) |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1700 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1701 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1702 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1703 %! str = "1 2 3\n4 s 6\n"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1704 %! fprintf (fid, str); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1705 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1706 %! c = textscan (fid, "%f %f %f", "ReturnOnError", 1); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1707 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1708 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1709 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1710 %! u = textscan (str, "%f %f %f", "ReturnOnError", 1); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
1711 %! assert (c, {[1;4], 2, 3}); |
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
1712 %! assert (u, {[1;4], 2, 3}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1713 |
21625 | 1714 %!error <Read error in field 2 of row 2> |
1715 %! textscan ("1 2 3\n4 s 6", "%f %f %f", "ReturnOnError", 0); | |
1716 | |
1717 ## Check ReturnOnError (3) | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1718 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1719 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1720 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1721 %! fprintf (fid, "1 s 3\n4 5 6"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1722 %! fseek (fid, 0, "bof"); |
21622
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1723 %! c = textscan (fid, "", "ReturnOnError", 1); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1724 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1725 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1726 %! unlink (f); |
21622
fed1111e1899
textscan: eliminate ReturnOnError="continue" mode (bug #47538)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21621
diff
changeset
|
1727 %! assert (c, {1}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1728 |
21625 | 1729 ## Check ReturnOnError with empty fields |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1730 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1731 %! c = textscan ("1,,3\n4,5,6", "", "Delimiter", ",", "ReturnOnError", 1); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
1732 %! assert (c, {[1;4], [NaN;5], [3;6]}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1733 |
21625 | 1734 ## Check ReturnOnError with empty fields (2) |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1735 %!test |
21625 | 1736 %! c = textscan ("1,,3\n4,5,6", "%f %f %f", "Delimiter", ",", |
1737 %! "ReturnOnError", 1); | |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
1738 %! assert (c, {[1;4], [NaN;5], [3;6]}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1739 |
21625 | 1740 ## Check ReturnOnError in first column |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1741 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1742 %! c = textscan ("1 2 3\ns 5 6", "", "ReturnOnError", 1); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
1743 %! assert (c, {1, 2, 3}); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1744 |
21625 | 1745 ## FIXME: This test fails (4/14/16) |
1746 ### Test incomplete first data line | |
1747 #%!test | |
1748 #%! R = textscan (['Empty1' char(10)], 'Empty%d %f'); | |
1749 #%! assert (R{1}, int32 (1)); | |
1750 #%! assert (isempty (R{2}), true); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1751 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1752 ## bug #37023 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1753 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1754 %! data = textscan (" 1. 1 \n 2 3\n", '%f %f'); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1755 %! assert (data{1}, [1; 2], 1e-15); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1756 %! assert (data{2}, [1; 3], 1e-15); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1757 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1758 ## Whitespace test (bug #37333) using delimiter ";" |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1759 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1760 %! tc{1, 1} = "C:/code;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1761 %! tc{1, end+1} = "C:/code/meas;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1762 %! tc{1, end+1} = " C:/code/sim;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1763 %! tc{1, end+1} = "C:/code/utils;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1764 %! string = [tc{:}]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1765 %! c = textscan (string, "%s", "delimiter", ";"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1766 %! for k = 1:max (numel (c{1}), numel (tc)) |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1767 %! lh = c{1}{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1768 %! rh = tc{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1769 %! rh(rh == ";") = ""; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1770 %! rh = strtrim (rh); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1771 %! assert (strcmp (lh, rh)); |
21625 | 1772 %! endfor |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1773 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1774 ## Whitespace test (bug #37333), adding multipleDelimsAsOne true arg |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1775 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1776 %! tc{1, 1} = "C:/code;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1777 %! tc{1, end+1} = " C:/code/meas;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1778 %! tc{1, end+1} = "C:/code/sim;;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1779 %! tc{1, end+1} = "C:/code/utils;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1780 %! string = [tc{:}]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1781 %! c = textscan (string, "%s", "delimiter", ";", "multipleDelimsAsOne", 1); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1782 %! for k = 1:max (numel (c{1}), numel (tc)) |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1783 %! lh = c{1}{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1784 %! rh = tc{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1785 %! rh(rh == ";") = ""; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1786 %! rh = strtrim (rh); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1787 %! assert (strcmp (lh, rh)); |
21625 | 1788 %! endfor |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1789 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1790 ## Whitespace test (bug #37333), adding multipleDelimsAsOne false arg |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1791 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1792 %! tc{1, 1} = "C:/code;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1793 %! tc{1, end+1} = " C:/code/meas;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1794 %! tc{1, end+1} = "C:/code/sim;;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1795 %! tc{1, end+1} = ""; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1796 %! tc{1, end+1} = "C:/code/utils;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1797 %! string = [tc{:}]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1798 %! c = textscan (string, "%s", "delimiter", ";", "multipleDelimsAsOne", 0); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1799 %! for k = 1:max (numel (c{1}), numel (tc)) |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1800 %! lh = c{1}{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1801 %! rh = tc{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1802 %! rh(rh == ";") = ""; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1803 %! rh = strtrim (rh); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1804 %! assert (strcmp (lh, rh)); |
21625 | 1805 %! endfor |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1806 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1807 ## Whitespace test (bug #37333) whitespace "" arg |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1808 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1809 %! tc{1, 1} = "C:/code;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1810 %! tc{1, end+1} = " C:/code/meas;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1811 %! tc{1, end+1} = "C:/code/sim;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1812 %! tc{1, end+1} = "C:/code/utils;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1813 %! string = [tc{:}]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1814 %! c = textscan (string, "%s", "delimiter", ";", "whitespace", ""); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1815 %! for k = 1:max (numel (c{1}), numel (tc)) |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1816 %! lh = c{1}{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1817 %! rh = tc{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1818 %! rh(rh == ";") = ""; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1819 %! assert (strcmp (lh, rh)); |
21625 | 1820 %! endfor |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1821 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1822 ## Whitespace test (bug #37333), whitespace " " arg |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1823 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1824 %! tc{1, 1} = "C:/code;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1825 %! tc{1, end+1} = " C:/code/meas;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1826 %! tc{1, end+1} = "C:/code/sim;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1827 %! tc{1, end+1} = "C:/code/utils;"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1828 %! string = [tc{:}]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1829 %! c = textscan (string, "%s", "delimiter", ";", "whitespace", " "); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1830 %! for k = 1:max (numel (c{1}), numel (tc)) |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1831 %! lh = c{1}{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1832 %! rh = tc{k}; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1833 %! rh(rh == ";") = ""; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1834 %! rh = strtrim (rh); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1835 %! assert (strcmp (lh, rh)); |
21625 | 1836 %! endfor |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1837 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1838 ## Tests reading with empty format, should return proper nr of columns |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1839 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1840 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1841 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1842 %! fprintf (fid, " 1 2 3 4\n5 6 7 8"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1843 %! fseek (fid, 0, "bof"); |
21625 | 1844 %! C = textscan (fid, ""); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1845 %! E = feof (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1846 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1847 %! unlink (f); |
21625 | 1848 %! assert (C{1}, [1 ; 5], 1e-6); |
1849 %! assert (C{2}, [2 ; 6], 1e-6); | |
1850 %! assert (C{3}, [3 ; 7], 1e-6); | |
1851 %! assert (C{4}, [4 ; 8], 1e-6); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1852 %! assert (E); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1853 |
21621
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1854 ## Test leaving the file at the correct position on exit |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1855 %!test |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1856 %! f = tempname (); |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1857 %! fid = fopen (f, "w+"); |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1858 %! fprintf (fid, "1,2\n3,4\n"); |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1859 %! fseek (fid, 0, "bof"); |
21625 | 1860 %! C = textscan (fid, "%s %f", 2, "Delimiter", ","); |
21621
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1861 %! E = ftell (fid); |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1862 %! fclose (fid); |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1863 %! unlink (f); |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1864 %! assert (E, 8); |
fe0a6de805e4
textscan: Leave file read position correct at exit (bug #47671)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21581
diff
changeset
|
1865 |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1866 ## Tests reading with empty format; empty fields & incomplete lower row |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1867 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1868 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1869 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1870 %! fprintf (fid, " ,2,,4\n5,6"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1871 %! fseek (fid, 0, "bof"); |
21625 | 1872 %! C = textscan (fid, "", "delimiter", ",", "EmptyValue", 999, |
1873 %! "CollectOutput" , 1); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1874 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1875 %! unlink (f); |
21625 | 1876 %! assert (C{1}, [999, 2, 999, 4; 5, 6, 999, 999], 1e-6); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1877 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1878 ## Error message tests |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1879 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1880 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1881 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1882 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1883 %! msg1 = "textscan: 1 parameters given, but only 0 values"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1884 %! try |
21625 | 1885 %! C = textscan (fid, "", "headerlines"); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1886 %! end_try_catch; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1887 %! assert (!feof (fid)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1888 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1889 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1890 %! assert (msg1, lasterr); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1891 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1892 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1893 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1894 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1895 %! msg1 = "textscan: HeaderLines must be numeric"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1896 %! try |
21625 | 1897 %! C = textscan (fid, "", "headerlines", "hh"); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1898 %! end_try_catch; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1899 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1900 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1901 %! assert (msg1, lasterr); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1902 |
21625 | 1903 ## Skip headerlines |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1904 %!test |
21625 | 1905 %! C = textscan ("field 1 field2\n 1 2\n3 4", "", "headerlines", 1, |
1906 %! "collectOutput", 1); | |
1907 %! assert (C, {[1 2; 3 4]}); | |
1908 | |
1909 ## Skip headerlines with non-default EOL | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1910 %!test |
21625 | 1911 %! C = textscan ("field 1 field2\r 1 2\r3 4", "", "headerlines", 2, |
1912 %! "collectOutput", 1, "EndOfLine", '\r'); | |
1913 %! assert (C, {[3 4]}); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1914 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1915 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1916 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1917 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1918 %! fprintf (fid,"some_string"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1919 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1920 %! msg1 = "textscan: EndOfLine must be at most one character or '\\r\\n'"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1921 %! try |
21625 | 1922 %! C = textscan (fid, "%f", "EndOfLine", "\n\r"); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1923 %! end_try_catch; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1924 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1925 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1926 %! assert (msg1, lasterr); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1927 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1928 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1929 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1930 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1931 %! fprintf (fid,"some_string"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1932 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1933 %! msg1 = "textscan: EndOfLine must be at most one character or '\\r\\n'"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1934 %! try |
21625 | 1935 %! C = textscan (fid, "%f", "EndOfLine", 33); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1936 %! end_try_catch; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1937 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1938 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1939 %! assert (msg1, lasterr); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1940 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1941 ## Bug #41824 |
21625 | 1942 %!assert (textscan ("123", "", "whitespace", " "){:}, 123); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1943 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1944 ## Bug #42343-1, just test supplied emptyvalue |
21625 | 1945 %!assert (textscan (",NaN", "", "delimiter", "," ,"emptyValue" ,Inf), |
1946 %! {Inf, NaN}) | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1947 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1948 ## Bug #42343-2, test padding with supplied emptyvalue |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1949 %!test |
21625 | 1950 %! c = textscan (",1,,4\nInf, ,NaN\n", "", "delimiter", ",", |
1951 %! "emptyvalue", -10); | |
1952 %! assert (cell2mat (c), [-10, 1, -10, 4; Inf, -10, NaN, -10]); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1953 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1954 ## Bug #42528 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1955 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1956 %! assert (textscan ("1i", ""){1}, 0+1i); |
21625 | 1957 %! C = textscan ("3, 2-4i, NaN\n -i, 1, 23.4+2.2i\n 1+1 1+1j", "", |
1958 %! "delimiter", ","); | |
1959 %! assert (cell2mat (C), [3+0i, 2-4i, NaN+0i; 0-i, 1+0i, 23.4+2.2i; 1 1 1+1i]); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1960 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1961 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1962 %! ## TreatAsEmpty |
21625 | 1963 %! C = textscan ("1,2,3,NN,5,6\n", "%d%d%d%f", "delimiter", ",", |
1964 %! "TreatAsEmpty", "NN"); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1965 %! assert (C{3}(1), int32 (3)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1966 %! assert (C{4}(1), NaN); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1967 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1968 ## MultipleDelimsAsOne |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1969 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1970 %! str = "11, 12, 13,, 15\n21,, 23, 24, 25\n,, 33, 34, 35\n"; |
21625 | 1971 %! C = textscan (str, "%f %f %f %f", "delimiter", ",", |
1972 %! "multipledelimsasone", 1, "endofline", "\n"); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1973 %! assert (C{1}', [11, 21, 33]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1974 %! assert (C{2}', [12, 23, 34]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1975 %! assert (C{3}', [13, 24, 35]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1976 %! assert (C{4}', [15, 25, NaN]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1977 |
21551
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1978 ## Single-quoted escape sequences |
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1979 %!test |
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1980 %! str = "11\t12\t13\r21\t22\t23"; |
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1981 %! c = textscan (str, "", "delimiter", '\t', "EndOfLine", '\r'); |
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1982 %! assert (c{1}', [11, 21]); |
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1983 %! assert (c{2}', [12, 22]); |
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1984 %! assert (c{3}', [13, 23]); |
990c6c31a684
Accept escape sequences in single quoted strings for "delimiter" (bug #47539)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21548
diff
changeset
|
1985 |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1986 ## Bug #44750 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1987 %!test |
21625 | 1988 %! c = textscan ("/home/foo/", "%s", "delimiter", "/", |
1989 %! "MultipleDelimsAsOne", 1); | |
1990 %! assert (c{1}, {"home"; "foo"}); | |
1991 | |
1992 ## FIXME: Test still fails (4/13/2016)? | |
1993 ## Allow cuddling %sliteral, but warn it is ambiguous | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1994 #%!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1995 #%! C = textscan ("abcxyz51\nxyz83\n##xyz101", "%s xyz %d"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1996 #%! assert (C{1}([1 3]), {"abc"; "##"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1997 #%! assert (isempty (C{1}{2}), true); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1998 #%! assert (C{2}, int32 ([51; 83; 101])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
1999 ### Literals are not delimiters. |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2000 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2001 ## Test for false positives in check for non-supported format specifiers |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2002 %!test |
21625 | 2003 %! c = textscan ("Total: 32.5 % (of cm values)", |
2004 %! "Total: %f %% (of cm values)"); | |
2005 %! assert (c{1}, 32.5, 1e-5); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2006 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2007 ## Test various forms of string format specifiers (bug #45712) |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2008 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2009 %! str = "14 :1 z:2 z:3 z:5 z:11"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2010 %! C = textscan (str, "%f %s %*s %3s %*3s %f", "delimiter", ":"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2011 %! assert (C, {14, {"1 z"}, {"3 z"}, 11}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2012 |
21625 | 2013 ## Bit width, fixed width conversion specifiers |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2014 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2015 %! str2 = "123456789012345 "; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2016 %! str2 = [str2 str2 str2 str2 str2 str2 str2 str2]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2017 %! str2 = [str2 "123456789.01234 1234567890.1234 12345.678901234 12345.678901234"]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2018 %! pttrn = "%3u8%*s %5u16%*s %10u32%*s %15u64 %3d8%*s %5d16%*s %10d32%*s %15d64 %9f32%*s %14f64%*s %10.2f32%*s %12.2f64%*s"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2019 %! C = textscan (str2, pttrn, "delimiter", " "); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2020 %! assert (C{1}, uint8 (123)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2021 %! assert (C{2}, uint16 (12345)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2022 %! assert (C{3}, uint32 (1234567890)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2023 %! assert (C{4}, uint64 (123456789012345)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2024 %! assert (C{5}, int8 (123)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2025 %! assert (C{6}, int16 (12345)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2026 %! assert (C{7}, int32 (1234567890)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2027 %! assert (C{8}, int64 (123456789012345)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2028 %! assert (C{9}, single (123456789), 1e-12); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2029 %! assert (C{10}, double (1234567890.123), 1e-15); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2030 %! assert (C{11}, single (12345.68), 1e-5); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2031 %! assert (C{12}, double (12345.68), 1e-11); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2032 |
21625 | 2033 ## Bit width, fixed width conv. specifiers -- check the right amount is left |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2034 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2035 %! str2 = "123456789012345 "; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2036 %! str2 = [str2 str2 "123456789.01234"]; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2037 %! pttrn = "%3u8 %5u16 %10u32 %3d8 %5d16 %10d32 %9f32 %9f"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2038 %! C = textscan (str2, pttrn, "delimiter", " "); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2039 %! assert (C{1}, uint8 (123)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2040 %! assert (C{2}, uint16 (45678)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2041 %! assert (C{3}, uint32 (9012345)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2042 %! assert (C{4}, int8 (123)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2043 %! assert (C{5}, int16 (45678)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2044 %! assert (C{6}, int32 (9012345)); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2045 %! assert (C{7}, single (123456789), 1e-12); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2046 %! assert (C{8}, double (0.01234), 1e-12); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2047 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2048 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2049 %! C = textscan ("123.123", "%2f %3f %3f"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2050 %! assert (C{1}, 12); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2051 %! assert (C{2}, 3.1, 1e-11); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2052 %! assert (C{3}, 23); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2053 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2054 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2055 %! C = textscan ("123.123", "%3f %3f %3f"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2056 %! assert (C{1}, 123); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2057 %! assert (C{2}, 0.12, 1e-11); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2058 %! assert (C{3}, 3); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2059 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2060 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2061 %! C = textscan ("123.123", "%4f %3f"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2062 %! assert (C{1}, 123); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2063 %! assert (C{2}, 123); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2064 |
21625 | 2065 ## field width interrupts exponent. (Matlab incorrectly gives [12, 2e12]) |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2066 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2067 %! assert (textscan ("12e12", "%4f"), {[120; 2]}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2068 %! assert (textscan ("12e+12", "%5f"), {[120; 2]}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2069 %! assert (textscan ("125e-12","%6f"), {[12.5; 2]}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2070 |
21625 | 2071 ## %[] tests |
2072 ## Plain [..] and *[..] | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2073 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2074 %! ar = "abcdefguvwxAny\nacegxyzTrailing\nJunk"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2075 %! C = textscan (ar, "%[abcdefg] %*[uvwxyz] %s"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2076 %! assert (C{1}, {"abcdefg"; "aceg"; ""}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2077 %! assert (C{2}, {"Any"; "Trailing"; "Junk"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2078 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2079 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2080 %! assert (textscan ("A2 B2 C3", "%*[ABC]%d", 3), {int32([2; 2; 3])}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2081 |
21625 | 2082 ## [^..] and *[^..] |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2083 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2084 %! br = "abcdefguvwx1Any\nacegxyz2Trailing\n3Junk"; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2085 %! C = textscan (br, "%[abcdefg] %*[^0123456789] %s"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2086 %! assert (C{1}, {"abcdefg"; "aceg"; ""}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2087 %! assert (C{2}, {"1Any"; "2Trailing"; "3Junk"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2088 |
21625 | 2089 ## [..] and [^..] containing delimiters |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2090 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2091 %! cr = "ab cd efguv wx1Any\na ce gx yz2Trailing\n 3Junk"; |
21625 | 2092 %! C = textscan (cr, "%[ abcdefg] %*[^0123456789] %s", "delimiter", " \n", |
2093 %! "whitespace", ""); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2094 %! assert (C{1}, {"ab cd efg"; "a ce g"; " "}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2095 %! assert (C{2}, {"1Any"; "2Trailing"; "3Junk"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2096 |
21625 | 2097 ## Bug #36464 |
2098 %!assert (textscan ("1 2 3 4 5 6", "%*n%n%*[^\n]"){1}, 2); | |
2099 | |
2100 ## test %[]] and %[^]] | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2101 %!test |
21625 | 2102 %! assert (textscan ("345]", "%*[123456]%[]]"){1}{1}, "]"); |
2103 %! assert (textscan ("345]", "%*[^]]%s"){1}{1}, "]"); | |
2104 | |
2105 ## Test that "-i" checks the next two characters | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2106 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2107 %! C = textscan ("-i -in -inf -infinity", "%f %f%s %f %f %s"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2108 %! assert (C, {-i, -i, {"n"}, -Inf, -Inf, {"inity"}}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2109 |
21625 | 2110 ## Again for "+i", this time with custom parser |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2111 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2112 %! C = textscan ("+i +in +inf +infinity", "%f %f%s %f %f %s", "ExpChars", "eE"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2113 %! assert (C, {i, i, {"n"}, Inf, Inf, {"inity"}}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2114 |
21625 | 2115 ## Check single quoted format interprets control sequences |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2116 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2117 %! C = textscan ("1 2\t3 4", '%f %[^\t] %f %f'); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2118 %! assert (C, {1, {"2"}, 3, 4}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2119 |
21532
936ab0fca2f7
Textscan returns emptyVal for rows with literal but no conversion (bug #47458)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21507
diff
changeset
|
2120 %% Check a non-empty line with no valid conversion registers empytValue |
936ab0fca2f7
Textscan returns emptyVal for rows with literal but no conversion (bug #47458)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21507
diff
changeset
|
2121 %!test |
936ab0fca2f7
Textscan returns emptyVal for rows with literal but no conversion (bug #47458)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21507
diff
changeset
|
2122 %! C = textscan ("Empty\n", "Empty%f %f"); |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21566
diff
changeset
|
2123 %! assert (C, { NaN, NaN }); |
21532
936ab0fca2f7
Textscan returns emptyVal for rows with literal but no conversion (bug #47458)
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21507
diff
changeset
|
2124 |
21625 | 2125 ## Check overflow and underflow of integer types |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2126 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2127 %! a = "-1e90 "; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2128 %! b = "1e90 "; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2129 %! fmt = "%d8 %d16 %d32 %d64 %u8 %u16 %u32 %u64 "; |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2130 %! C = textscan ([a a a a a a a a b b b b b b b b], fmt); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2131 %! assert (C{1}, int8 ([-128; 127])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2132 %! assert (C{2}, int16 ([-32768; 32767])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2133 %! assert (C{3}, int32 ([-2147483648; 2147483647])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2134 %! assert (C{4}, int64 ([-9223372036854775808; 9223372036854775807])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2135 %! assert (C{5}, uint8 ([0; 255])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2136 %! assert (C{6}, uint16 ([0; 65535])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2137 %! assert (C{7}, uint32 ([0; 4294967295])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2138 %! assert (C{8}, uint64 ([0; 18446744073709551615])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2139 |
21625 | 2140 ## Tests from Matlab (does The MathWorks have any copyright over the input?) |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2141 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2142 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2143 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2144 %! fprintf (fid,"09/12/2005 Level1 12.34 45 1.23e10 inf Nan Yes 5.1+3i\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2145 %! fprintf (fid,"10/12/2005 Level2 23.54 60 9e19 -inf 0.001 No 2.2-.5i\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2146 %! fprintf (fid,"11/12/2005 Level3 34.90 12 2e5 10 100 No 3.1+.1i\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2147 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2148 %! C = textscan (fid,"%s %s %f32 %d8 %u %f %f %s %f"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2149 %! %assert (C{1}, {"09/12/2005";"10/12/2005";"11/12/2005"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2150 %! assert (C{2}, {"Level1";"Level2";"Level3"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2151 %! assert (C{3}, [single(12.34);single(23.54);single(34.90)]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2152 %! assert (C{4}, [int8(45);int8(60);int8(12)]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2153 %! assert (C{5}, [uint32(4294967295);uint32(4294967295);uint32(200000)]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2154 %! assert (C{6}, [inf;-inf;10]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2155 %! assert (C{7}, [NaN;0.001;100], eps); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2156 %! assert (C{8}, {"Yes";"No";"No"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2157 %! assert (C{9}, [5.1+3i;2.2-0.5i;3.1+0.1i]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2158 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2159 %! C = textscan (fid,"%s Level%d %f32 %d8 %u %f %f %s %f"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2160 %! assert (C{2}, [int32(1);int32(2);int32(3)]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2161 %! assert (C{3}, [single(12.34);single(23.54);single(34.90)]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2162 %! fseek (fid, 0, "bof"); |
21625 | 2163 %! C = textscan (fid, '%s %*[^\n]'); |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2164 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2165 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2166 %! assert (C, {{"09/12/2005";"10/12/2005";"11/12/2005"}}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2167 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2168 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2169 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2170 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2171 %! fprintf (fid,"1, 2, 3, 4, , 6\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2172 %! fprintf (fid,"7, 8, 9, , 11, 12\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2173 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2174 %! C = textscan (fid,"%f %f %f %f %u8 %f", "Delimiter",",","EmptyValue",-Inf); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2175 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2176 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2177 %! assert (C{4}, [4; -Inf]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2178 %! assert (C{5}, uint8 ([0; 11])); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2179 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2180 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2181 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2182 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2183 %! fprintf (fid,"abc, 2, NA, 3, 4\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2184 %! fprintf (fid,"// Comment Here\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2185 %! fprintf (fid,"def, na, 5, 6, 7\n"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2186 %! fseek (fid, 0, "bof"); |
21625 | 2187 %! C = textscan (fid, "%s %n %n %n %n", "Delimiter", ",", |
2188 %! "TreatAsEmpty", {"NA","na"}, "CommentStyle", "//"); | |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2189 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2190 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2191 %! assert (C{1}, {"abc";"def"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2192 %! assert (C{2}, [2; NaN]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2193 %! assert (C{3}, [NaN; 5]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2194 %! assert (C{4}, [3; 6]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2195 %! assert (C{5}, [4; 7]); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2196 |
21625 | 2197 ## FIXME: Almost passes. Second return value is {"/"}. Tested 4/14/16. |
2198 ### Test start of comment as string | |
2199 #%!test | |
2200 #%! c = textscan ("1 / 2 // 3", "%n %s %u8", "CommentStyle", {"//"}); | |
2201 #%! assert (c(1), {1, "/", 2}); | |
21507
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
2202 |
2cdbae31c022
improve compatibility of textscan for character arrays
John W. Eaton <jwe@octave.org>
parents:
21506
diff
changeset
|
2203 %!assert (textscan (["1 2 3 4"; "5 6 7 8"], "%f"), {[15; 26; 37; 48]}) |
21566
02826fb0f261
textscan: Fix bug in exponent parsing
Mike Miller <mtmiller@octave.org>
parents:
21551
diff
changeset
|
2204 |
21625 | 2205 ## Check for delimiter after exponent |
21566
02826fb0f261
textscan: Fix bug in exponent parsing
Mike Miller <mtmiller@octave.org>
parents:
21551
diff
changeset
|
2206 %!assert (textscan ("1e-3|42", "%f", "delimiter", "|"), {[1e-3; 42]}) |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2207 */ |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2208 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2209 // These tests have end-comment sequences, so can't just be in a comment |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2210 #if 0 |
21625 | 2211 ## Test unfinished comment |
21502
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2212 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2213 %! c = textscan ("1 2 /* half comment", "%n %u8", "CommentStyle", {"/*", "*/"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2214 %! assert (c, {1, 2}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2215 |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2216 ## Test reading from a real file |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2217 %!test |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2218 %! f = tempname (); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2219 %! fid = fopen (f, "w+"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2220 %! d = rand (1, 4); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2221 %! fprintf (fid, " %f %f /* comment */ %f %f ", d); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2222 %! fseek (fid, 0, "bof"); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2223 %! A = textscan (fid, "%f %f", "CommentStyle", {"/*", "*/"}); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2224 %! E = feof (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2225 %! fclose (fid); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2226 %! unlink (f); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2227 %! assert (A{1}, [d(1); d(3)], 1e-6); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2228 %! assert (A{2}, [d(2); d(4)], 1e-6); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2229 %! assert (E); |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2230 #endif |
7a19c5678f91
move textscan class to oct-stream.cc and textscan function to file-io.cc
John W. Eaton <jwe@octave.org>
parents:
21457
diff
changeset
|
2231 |
21625 | 2232 /* |
2233 ## Test input validation | |
2234 %!error textscan () | |
2235 %!error textscan (single (40)) | |
2236 %!error textscan ({40}) | |
2237 %!error <must be a string> textscan ("Hello World", 2) | |
2238 %!error <at most one character or> | |
2239 %! textscan ("Hello World", "%s", "EndOfLine", 3); | |
2240 %!error <'%z' is not a valid format specifier> textscan ("1.0", "%z") | |
2241 %!error <no valid format conversion specifiers> textscan ("1.0", "foo") | |
2242 */ | |
2243 | |
2116 | 2244 static octave_value |
2245 do_fread (octave_stream& os, const octave_value& size_arg, | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
2246 const octave_value& prec_arg, const octave_value& skip_arg, |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
2247 const octave_value& arch_arg, octave_idx_type& count) |
2116 | 2248 { |
2249 count = -1; | |
2250 | |
20703
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2251 Array<double> size = size_arg.xvector_value ("fread: invalid SIZE specified"); |
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2252 |
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2253 std::string prec = prec_arg.xstring_value ("fread: PRECISION must be a string"); |
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2254 |
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2255 int block_size = 1; |
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2256 oct_data_conv::data_type input_type; |
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2257 oct_data_conv::data_type output_type; |
85e5efae848a
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
2258 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2259 try |
2116 | 2260 { |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2261 oct_data_conv::string_to_data_type (prec, block_size, |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2262 input_type, output_type); |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2263 } |
20785
b6f2909e7f94
always throw exception after debugging with debug_on_error
John W. Eaton <jwe@octave.org>
parents:
20764
diff
changeset
|
2264 catch (octave_execution_exception& e) |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2265 { |
20756
200ae1d650b7
propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents:
20747
diff
changeset
|
2266 error (e, "fread: invalid PRECISION specified"); |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2267 } |
4944 | 2268 |
20747
ee2743bd07a8
eliminate various compiler warnings
John W. Eaton <jwe@octave.org>
parents:
20741
diff
changeset
|
2269 int skip = 0; |
3202 | 2270 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2271 try |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2272 { |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2273 skip = skip_arg.int_value (true); |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2274 } |
20785
b6f2909e7f94
always throw exception after debugging with debug_on_error
John W. Eaton <jwe@octave.org>
parents:
20764
diff
changeset
|
2275 catch (octave_execution_exception& e) |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2276 { |
20756
200ae1d650b7
propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents:
20747
diff
changeset
|
2277 error (e, "fread: SKIP must be an integer"); |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2278 } |
2116 | 2279 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2280 std::string arch = arch_arg.xstring_value ("fread: ARCH architecture type must be a string"); |
2116 | 2281 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2282 oct_mach_info::float_format flt_fmt |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2283 = oct_mach_info::string_to_float_format (arch); |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2284 |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2285 return os.read (size, block_size, input_type, output_type, skip, |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2286 flt_fmt, count); |
2116 | 2287 } |
2288 | |
2289 DEFUN (fread, args, , | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2290 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2291 @deftypefn {} {@var{val} =} fread (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2292 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2293 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2294 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2295 @deftypefnx {} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip}, @var{arch})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2296 @deftypefnx {} {[@var{val}, @var{count}] =} fread (@dots{})\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2297 Read binary data from the file specified by the file descriptor @var{fid}.\n\ |
3372 | 2298 \n\ |
2299 The optional argument @var{size} specifies the amount of data to read\n\ | |
2300 and may be one of\n\ | |
2301 \n\ | |
2302 @table @code\n\ | |
2303 @item Inf\n\ | |
2304 Read as much as possible, returning a column vector.\n\ | |
529 | 2305 \n\ |
3372 | 2306 @item @var{nr}\n\ |
2307 Read up to @var{nr} elements, returning a column vector.\n\ | |
2308 \n\ | |
2309 @item [@var{nr}, Inf]\n\ | |
2310 Read as much as possible, returning a matrix with @var{nr} rows. If the\n\ | |
2311 number of elements read is not an exact multiple of @var{nr}, the last\n\ | |
2312 column is padded with zeros.\n\ | |
2313 \n\ | |
2314 @item [@var{nr}, @var{nc}]\n\ | |
2315 Read up to @code{@var{nr} * @var{nc}} elements, returning a matrix with\n\ | |
2316 @var{nr} rows. If the number of elements read is not an exact multiple\n\ | |
2317 of @var{nr}, the last column is padded with zeros.\n\ | |
2318 @end table\n\ | |
2319 \n\ | |
2320 @noindent\n\ | |
2321 If @var{size} is omitted, a value of @code{Inf} is assumed.\n\ | |
2318 | 2322 \n\ |
3372 | 2323 The optional argument @var{precision} is a string specifying the type of\n\ |
2324 data to read and may be one of\n\ | |
2325 \n\ | |
11595
5ec6aa05638d
Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents:
11586
diff
changeset
|
2326 @table @asis\n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2327 @item @qcode{\"schar\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2328 @itemx @qcode{\"signed char\"}\n\ |
3372 | 2329 Signed character.\n\ |
529 | 2330 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2331 @item @qcode{\"uchar\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2332 @itemx @qcode{\"unsigned char\"}\n\ |
3372 | 2333 Unsigned character.\n\ |
2334 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2335 @item @qcode{\"int8\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2336 @itemx @qcode{\"integer*1\"}\n\ |
4944 | 2337 \n\ |
2338 8-bit signed integer.\n\ | |
2318 | 2339 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2340 @item @qcode{\"int16\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2341 @itemx @qcode{\"integer*2\"}\n\ |
4944 | 2342 16-bit signed integer.\n\ |
3372 | 2343 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2344 @item @qcode{\"int32\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2345 @itemx @qcode{\"integer*4\"}\n\ |
4944 | 2346 32-bit signed integer.\n\ |
3372 | 2347 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2348 @item @qcode{\"int64\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2349 @itemx @qcode{\"integer*8\"}\n\ |
4944 | 2350 64-bit signed integer.\n\ |
2351 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2352 @item @qcode{\"uint8\"}\n\ |
4944 | 2353 8-bit unsigned integer.\n\ |
529 | 2354 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2355 @item @qcode{\"uint16\"}\n\ |
4944 | 2356 16-bit unsigned integer.\n\ |
3372 | 2357 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2358 @item @qcode{\"uint32\"}\n\ |
4944 | 2359 32-bit unsigned integer.\n\ |
3372 | 2360 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2361 @item @qcode{\"uint64\"}\n\ |
4944 | 2362 64-bit unsigned integer.\n\ |
2363 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2364 @item @qcode{\"single\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2365 @itemx @qcode{\"float32\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2366 @itemx @qcode{\"real*4\"}\n\ |
4944 | 2367 32-bit floating point number.\n\ |
3372 | 2368 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2369 @item @qcode{\"double\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2370 @itemx @qcode{\"float64\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2371 @itemx @qcode{\"real*8\"}\n\ |
4944 | 2372 64-bit floating point number.\n\ |
2373 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2374 @item @qcode{\"char\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2375 @itemx @qcode{\"char*1\"}\n\ |
4944 | 2376 Single character.\n\ |
3372 | 2377 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2378 @item @qcode{\"short\"}\n\ |
4944 | 2379 Short integer (size is platform dependent).\n\ |
2380 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2381 @item @qcode{\"int\"}\n\ |
4944 | 2382 Integer (size is platform dependent).\n\ |
2383 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2384 @item @qcode{\"long\"}\n\ |
4944 | 2385 Long integer (size is platform dependent).\n\ |
3372 | 2386 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2387 @item @qcode{\"ushort\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2388 @itemx @qcode{\"unsigned short\"}\n\ |
4944 | 2389 Unsigned short integer (size is platform dependent).\n\ |
4610 | 2390 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2391 @item @qcode{\"uint\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2392 @itemx @qcode{\"unsigned int\"}\n\ |
4944 | 2393 Unsigned integer (size is platform dependent).\n\ |
4610 | 2394 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2395 @item @qcode{\"ulong\"}\n\ |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2396 @itemx @qcode{\"unsigned long\"}\n\ |
4944 | 2397 Unsigned long integer (size is platform dependent).\n\ |
2398 \n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2399 @item @qcode{\"float\"}\n\ |
4944 | 2400 Single precision floating point number (size is platform dependent).\n\ |
3372 | 2401 @end table\n\ |
2402 \n\ | |
2403 @noindent\n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2404 The default precision is @qcode{\"uchar\"}.\n\ |
2318 | 2405 \n\ |
4944 | 2406 The @var{precision} argument may also specify an optional repeat\n\ |
2407 count. For example, @samp{32*single} causes @code{fread} to read\n\ | |
2408 a block of 32 single precision floating point numbers. Reading in\n\ | |
2409 blocks is useful in combination with the @var{skip} argument.\n\ | |
2410 \n\ | |
2411 The @var{precision} argument may also specify a type conversion.\n\ | |
2412 For example, @samp{int16=>int32} causes @code{fread} to read 16-bit\n\ | |
2413 integer values and return an array of 32-bit integer values. By\n\ | |
2414 default, @code{fread} returns a double precision array. The special\n\ | |
2415 form @samp{*TYPE} is shorthand for @samp{TYPE=>TYPE}.\n\ | |
2416 \n\ | |
7096 | 2417 The conversion and repeat counts may be combined. For example, the\n\ |
2418 specification @samp{32*single=>single} causes @code{fread} to read\n\ | |
2419 blocks of single precision floating point values and return an array\n\ | |
2420 of single precision values instead of the default array of double\n\ | |
2421 precision values.\n\ | |
4944 | 2422 \n\ |
3372 | 2423 The optional argument @var{skip} specifies the number of bytes to skip\n\ |
4944 | 2424 after each element (or block of elements) is read. If it is not\n\ |
2425 specified, a value of 0 is assumed. If the final block read is not\n\ | |
2426 complete, the final skip is omitted. For example,\n\ | |
2427 \n\ | |
2428 @example\n\ | |
2429 fread (f, 10, \"3*single=>single\", 8)\n\ | |
2430 @end example\n\ | |
2431 \n\ | |
2432 @noindent\n\ | |
2433 will omit the final 8-byte skip because the last read will not be\n\ | |
2434 a complete block of 3 values.\n\ | |
3372 | 2435 \n\ |
2436 The optional argument @var{arch} is a string specifying the data format\n\ | |
2437 for the file. Valid values are\n\ | |
529 | 2438 \n\ |
18078
b06a9768b643
doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents:
18040
diff
changeset
|
2439 @table @asis\n\ |
20431
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
2440 @item @qcode{\"native\"} or @qcode{\"n\"}\n\ |
3372 | 2441 The format of the current machine.\n\ |
2442 \n\ | |
20431
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
2443 @item @qcode{\"ieee-be\"} or @qcode{\"b\"}\n\ |
3372 | 2444 IEEE big endian.\n\ |
2445 \n\ | |
20431
f02c22f71cdb
doc: Add info about single letter codes for fread, fopen IEEE format.
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
2446 @item @qcode{\"ieee-le\"} or @qcode{\"l\"}\n\ |
3372 | 2447 IEEE little endian.\n\ |
2448 @end table\n\ | |
2318 | 2449 \n\ |
20439
97edbce9b975
doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents:
20431
diff
changeset
|
2450 If no @var{arch} is given the value used in the call to @code{fopen} which\n\ |
97edbce9b975
doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents:
20431
diff
changeset
|
2451 created the file descriptor is used. Otherwise, the value specified with\n\ |
97edbce9b975
doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents:
20431
diff
changeset
|
2452 @code{fread} overrides that of @code{fopen} and determines the data format.\n\ |
97edbce9b975
doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents:
20431
diff
changeset
|
2453 \n\ |
18208
bea06b5d4423
doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents:
18112
diff
changeset
|
2454 The output argument @var{val} contains the data read from the file.\n\ |
20439
97edbce9b975
doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
Rik <rik@octave.org>
parents:
20431
diff
changeset
|
2455 \n\ |
18208
bea06b5d4423
doc: Improve documentation for fread function.
Rik <rik@octave.org>
parents:
18112
diff
changeset
|
2456 The optional return value @var{count} contains the number of elements read.\n\ |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
2457 @seealso{fwrite, fgets, fgetl, fscanf, fopen}\n\ |
5642 | 2458 @end deftypefn") |
529 | 2459 { |
2116 | 2460 int nargin = args.length (); |
2461 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2462 if (nargin < 1 || nargin > 5) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2463 print_usage (); |
2116 | 2464 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2465 octave_stream os = octave_stream_list::lookup (args(0), "fread"); |
2116 | 2466 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2467 octave_value size = lo_ieee_inf_value (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2468 octave_value prec = "uchar"; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2469 octave_value skip = 0; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2470 octave_value arch = "unknown"; |
2116 | 2471 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2472 int idx = 1; |
2116 | 2473 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2474 if (nargin > idx && ! args(idx).is_string ()) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2475 size = args(idx++); |
2116 | 2476 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2477 if (nargin > idx) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2478 prec = args(idx++); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2479 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2480 if (nargin > idx) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2481 skip = args(idx++); |
4257 | 2482 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2483 if (nargin > idx) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2484 arch = args(idx++); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2485 else if (skip.is_string ()) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2486 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2487 arch = skip; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2488 skip = 0; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2489 } |
2116 | 2490 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2491 octave_idx_type count = -1; |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
2492 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2493 octave_value tmp = do_fread (os, size, prec, skip, arch, count); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2494 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2495 return ovl (tmp, count); |
529 | 2496 } |
2497 | |
2116 | 2498 static int |
2499 do_fwrite (octave_stream& os, const octave_value& data, | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
2500 const octave_value& prec_arg, const octave_value& skip_arg, |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
2501 const octave_value& arch_arg) |
2116 | 2502 { |
20700
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20687
diff
changeset
|
2503 std::string prec = prec_arg.xstring_value ("fwrite: PRECISION must be a string"); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
2504 |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
2505 int block_size = 1; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
2506 oct_data_conv::data_type output_type; |
2116 | 2507 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2508 try |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
2509 { |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2510 oct_data_conv::string_to_data_type (prec, block_size, output_type); |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2511 } |
20785
b6f2909e7f94
always throw exception after debugging with debug_on_error
John W. Eaton <jwe@octave.org>
parents:
20764
diff
changeset
|
2512 catch (octave_execution_exception& e) |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2513 { |
20756
200ae1d650b7
propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents:
20747
diff
changeset
|
2514 error (e, "fwrite: invalid PRECISION specified"); |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2515 } |
2116 | 2516 |
20747
ee2743bd07a8
eliminate various compiler warnings
John W. Eaton <jwe@octave.org>
parents:
20741
diff
changeset
|
2517 int skip = 0; |
3202 | 2518 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2519 try |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2520 { |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2521 skip = skip_arg.int_value (true); |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2522 } |
20785
b6f2909e7f94
always throw exception after debugging with debug_on_error
John W. Eaton <jwe@octave.org>
parents:
20764
diff
changeset
|
2523 catch (octave_execution_exception& e) |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2524 { |
20756
200ae1d650b7
propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents:
20747
diff
changeset
|
2525 error (e, "fwrite: SKIP must be an integer"); |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2526 } |
2116 | 2527 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2528 std::string arch = arch_arg.xstring_value ("fwrite: ARCH architecture type must be a string"); |
2116 | 2529 |
20741
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2530 oct_mach_info::float_format flt_fmt |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2531 = oct_mach_info::string_to_float_format (arch); |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2532 |
a5ab31b52ae8
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20713
diff
changeset
|
2533 return os.write (data, block_size, output_type, skip, flt_fmt); |
2116 | 2534 } |
2535 | |
2536 DEFUN (fwrite, args, , | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2537 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2538 @deftypefn {} {} fwrite (@var{fid}, @var{data})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2539 @deftypefnx {} {} fwrite (@var{fid}, @var{data}, @var{precision})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2540 @deftypefnx {} {} fwrite (@var{fid}, @var{data}, @var{precision}, @var{skip})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2541 @deftypefnx {} {} fwrite (@var{fid}, @var{data}, @var{precision}, @var{skip}, @var{arch})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2542 @deftypefnx {} {@var{count} =} fwrite (@dots{})\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2543 Write data in binary form to the file specified by the file descriptor\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2544 @var{fid}, returning the number of values @var{count} successfully written\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2545 to the file.\n\ |
1181 | 2546 \n\ |
3372 | 2547 The argument @var{data} is a matrix of values that are to be written to\n\ |
2548 the file. The values are extracted in column-major order.\n\ | |
1181 | 2549 \n\ |
3372 | 2550 The remaining arguments @var{precision}, @var{skip}, and @var{arch} are\n\ |
2551 optional, and are interpreted as described for @code{fread}.\n\ | |
1181 | 2552 \n\ |
3372 | 2553 The behavior of @code{fwrite} is undefined if the values in @var{data}\n\ |
2554 are too large to fit in the specified precision.\n\ | |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
2555 @seealso{fread, fputs, fprintf, fopen}\n\ |
5642 | 2556 @end deftypefn") |
1181 | 2557 { |
2116 | 2558 int nargin = args.length (); |
2559 | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2560 if (nargin < 2 || nargin > 5) |
5823 | 2561 print_usage (); |
2116 | 2562 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2563 octave_stream os = octave_stream_list::lookup (args(0), "fwrite"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2564 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2565 octave_value prec = "uchar"; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2566 octave_value skip = 0; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2567 octave_value arch = "unknown"; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2568 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2569 int idx = 1; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2570 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2571 octave_value data = args(idx++); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2572 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2573 if (nargin > idx) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2574 prec = args(idx++); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2575 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2576 if (nargin > idx) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2577 skip = args(idx++); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2578 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2579 if (nargin > idx) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2580 arch = args(idx++); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2581 else if (skip.is_string ()) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2582 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2583 arch = skip; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2584 skip = 0; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2585 } |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2586 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
2587 return ovl (do_fwrite (os, data, prec, skip, arch)); |
1181 | 2588 } |
2589 | |
5906 | 2590 DEFUNX ("feof", Ffeof, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2591 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2592 @deftypefn {} {@var{status} =} feof (@var{fid})\n\ |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2593 Return 1 if an end-of-file condition has been encountered for the file\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2594 specified by file descriptor @var{fid} and 0 otherwise.\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2595 \n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2596 Note that @code{feof} will only return 1 if the end of the file has already\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2597 been encountered, not if the next read operation will result in an\n\ |
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2598 end-of-file condition.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2599 @seealso{fread, frewind, fseek, fclear, fopen}\n\ |
5642 | 2600 @end deftypefn") |
529 | 2601 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2602 if (args.length () != 1) |
5823 | 2603 print_usage (); |
444 | 2604 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2605 octave_stream os = octave_stream_list::lookup (args(0), "feof"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2606 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
2607 return ovl (os.eof () ? 1.0 : 0.0); |
444 | 2608 } |
2609 | |
5906 | 2610 DEFUNX ("ferror", Fferror, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2611 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2612 @deftypefn {} {@var{msg} =} ferror (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2613 @deftypefnx {} {[@var{msg}, @var{err}] =} ferror (@var{fid})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2614 @deftypefnx {} {[@var{dots}] =} ferror (@var{fid}, \"clear\")\n\ |
19150 | 2615 Query the error status of the stream specified by file descriptor @var{fid}\n\ |
2616 \n\ | |
2617 If an error condition exists then return a string @var{msg} describing the\n\ | |
2618 error. Otherwise, return an empty string @qcode{\"\"}.\n\ | |
9797
f569f46a1c34
update ferror doc string, take 2
John W. Eaton <jwe@octave.org>
parents:
9796
diff
changeset
|
2619 \n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2620 The second input @qcode{\"clear\"} is optional. If supplied, the error\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2621 state on the stream will be cleared.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2622 \n\ |
19150 | 2623 The optional second output is a numeric indication of the error status.\n\ |
2624 @var{err} is 1 if an error condition has been encountered and 0 otherwise.\n\ | |
19127
df5e4024ec18
doc: Rephrase docstrings for low level C I/O functions.
Rik <rik@octave.org>
parents:
19123
diff
changeset
|
2625 \n\ |
19150 | 2626 Note that @code{ferror} indicates if an error has already occurred, not\n\ |
2627 whether the next operation will result in an error condition.\n\ | |
14438
6a8c3cd326fd
doc: Improve seealso links between low-level file I/O functions.
Rik <octave@nomad.inbox5.com>
parents:
14436
diff
changeset
|
2628 @seealso{fclear, fopen}\n\ |
3372 | 2629 @end deftypefn") |
1230 | 2630 { |
2095 | 2631 int nargin = args.length (); |
1230 | 2632 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2633 if (nargin < 1 || nargin > 2) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2634 print_usage (); |
1230 | 2635 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2636 octave_stream os = octave_stream_list::lookup (args(0), "ferror"); |
1230 | 2637 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2638 bool clear = false; |
2095 | 2639 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2640 if (nargin == 2) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2641 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2642 std::string opt = args(1).string_value (); |
20561
c41595061186
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20457
diff
changeset
|
2643 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2644 clear = (opt == "clear"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2645 } |
1755 | 2646 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2647 int error_number = 0; |
1230 | 2648 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2649 std::string error_message = os.error (clear, error_number); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2650 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2651 return ovl (error_message, error_number); |
1230 | 2652 } |
2653 | |
18477
aa7ca90ce746
avoid problems if popen is a macro
John W. Eaton <jwe@octave.org>
parents:
18040
diff
changeset
|
2654 DEFUNX ("popen", Fpopen, args, , |
19861
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19727
diff
changeset
|
2655 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2656 @deftypefn {} {@var{fid} =} popen (@var{command}, @var{mode})\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2657 Start a process and create a pipe.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2658 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2659 The name of the command to run is given by @var{command}. The argument\n\ |
3301 | 2660 @var{mode} may be\n\ |
2661 \n\ | |
2662 @table @code\n\ | |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2663 @item @qcode{\"r\"}\n\ |
3301 | 2664 The pipe will be connected to the standard output of the process, and\n\ |
2665 open for reading.\n\ | |
1230 | 2666 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2667 @item @qcode{\"w\"}\n\ |
3301 | 2668 The pipe will be connected to the standard input of the process, and\n\ |
2669 open for writing.\n\ | |
2670 @end table\n\ | |
2671 \n\ | |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2672 The file identifier corresponding to the input or output stream of the\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2673 process is returned in @var{fid}.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2674 \n\ |
10840 | 2675 For example:\n\ |
1230 | 2676 \n\ |
3301 | 2677 @example\n\ |
2678 @group\n\ | |
2679 fid = popen (\"ls -ltr / | tail -3\", \"r\");\n\ | |
7768
a2d9f325b65a
Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents:
7730
diff
changeset
|
2680 while (ischar (s = fgets (fid)))\n\ |
3301 | 2681 fputs (stdout, s);\n\ |
2682 endwhile\n\ | |
14360
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14210
diff
changeset
|
2683 \n\ |
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14210
diff
changeset
|
2684 @print{} drwxr-xr-x 33 root root 3072 Feb 15 13:28 etc\n\ |
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14210
diff
changeset
|
2685 @print{} drwxr-xr-x 3 root root 1024 Feb 15 13:28 lib\n\ |
97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents:
14210
diff
changeset
|
2686 @print{} drwxrwxrwt 15 root root 2048 Feb 17 14:53 tmp\n\ |
3301 | 2687 @end group\n\ |
2688 @end example\n\ | |
18950
ed3cb9f81145
file-io.cc (popen): Add seealso popen2
Andreas Weber <andy.weber.aw@gmail.com>
parents:
18487
diff
changeset
|
2689 @seealso{popen2}\n\ |
3301 | 2690 @end deftypefn") |
1230 | 2691 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2692 if (args.length () != 2) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2693 print_usage (); |
1230 | 2694 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2695 std::string name = args(0).xstring_value ("popen: COMMAND must be a string"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2696 std::string mode = args(1).xstring_value ("popen: MODE must be a string"); |
1230 | 2697 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2698 octave_value retval; |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2699 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2700 if (mode == "r") |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2701 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2702 octave_stream ips = octave_iprocstream::create (name); |
1230 | 2703 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2704 retval = octave_stream_list::insert (ips); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2705 } |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2706 else if (mode == "w") |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2707 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2708 octave_stream ops = octave_oprocstream::create (name); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2709 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2710 retval = octave_stream_list::insert (ops); |
2095 | 2711 } |
1230 | 2712 else |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2713 error ("popen: invalid MODE specified"); |
1230 | 2714 |
2715 return retval; | |
2716 } | |
2717 | |
16308
122c1a7a3004
avoid trouble if pclose is a macro
John W. Eaton <jwe@octave.org>
parents:
16099
diff
changeset
|
2718 DEFUNX ("pclose", Fpclose, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2719 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2720 @deftypefn {} {} pclose (@var{fid})\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2721 Close a file identifier that was opened by @code{popen}.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2722 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2723 The function @code{fclose} may also be used for the same purpose.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2724 @seealso{fclose, popen}\n\ |
3301 | 2725 @end deftypefn") |
1230 | 2726 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2727 if (args.length () != 1) |
5823 | 2728 print_usage (); |
1379 | 2729 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
2730 return ovl (octave_stream_list::remove (args(0), "pclose")); |
1379 | 2731 } |
2732 | |
19278
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
2733 DEFUN (tempname, args, , |
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
2734 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2735 @deftypefn {} {@var{fname} =} tempname ()\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2736 @deftypefnx {} {@var{fname} =} tempname (@var{dir})\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2737 @deftypefnx {} {@var{fname} =} tempname (@var{dir}, @var{prefix})\n\ |
20713
2469d78a1d8b
Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
2738 Return a unique temporary filename as a string.\n\ |
3372 | 2739 \n\ |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2740 If @var{prefix} is omitted, a value of @qcode{\"oct-\"} is used.\n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2741 \n\ |
4267 | 2742 If @var{dir} is also omitted, the default directory for temporary files\n\ |
19385
3b4d6780d6b8
doc: Add missing closing parenthesis in tempname docstring.
Rik <rik@octave.org>
parents:
19278
diff
changeset
|
2743 (@code{P_tmpdir}) is used. If @var{dir} is provided, it must exist,\n\ |
19210
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2744 otherwise the default directory for temporary files is used.\n\ |
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2745 \n\ |
19278
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
2746 Programming Note: Because the named file is not opened by @code{tempname},\n\ |
19210
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2747 it is possible, though relatively unlikely, that it will not be available\n\ |
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2748 by the time your program attempts to open it. If this is a concern,\n\ |
19278
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
2749 see @code{tmpfile}.\n\ |
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
2750 @seealso{mkstemp, tempdir, P_tmpdir, tmpfile}\n\ |
5642 | 2751 @end deftypefn") |
1802 | 2752 { |
20812
d9ca869ca124
maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents:
20805
diff
changeset
|
2753 int nargin = args.length (); |
2936 | 2754 |
20812
d9ca869ca124
maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents:
20805
diff
changeset
|
2755 if (nargin > 2) |
5823 | 2756 print_usage (); |
1802 | 2757 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2758 std::string dir; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2759 |
20812
d9ca869ca124
maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents:
20805
diff
changeset
|
2760 if (nargin > 0) |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2761 dir = args(0).xstring_value ("tempname: DIR must be a string"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2762 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2763 std::string pfx ("oct-"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2764 |
20812
d9ca869ca124
maint: Clean-up more instances of print_usage().
Rik <rik@octave.org>
parents:
20805
diff
changeset
|
2765 if (nargin > 1) |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2766 pfx = args(1).xstring_value ("tempname: PREFIX must be a string"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2767 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
2768 return ovl (octave_tempnam (dir, pfx)); |
1802 | 2769 } |
2770 | |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2771 /* |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2772 %!test |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2773 %! if (ispc ()) |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2774 %! envname = "TMP"; |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2775 %! else |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2776 %! envname = "TMPDIR"; |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2777 %! endif |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2778 %! envdir = getenv (envname); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2779 %! unsetenv (envname); |
21457
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2780 %! ## Strip trailing file separators from P_tmpdir |
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2781 %! def_tmpdir = P_tmpdir; |
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2782 %! while (length (def_tmpdir) > 2 && strfind (filesep ("all"), def_tmpdir(end))) |
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2783 %! def_tmpdir(end) = []; |
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2784 %! endwhile |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2785 %! unwind_protect |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2786 %! ## Test 0-argument form |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2787 %! fname = tempname (); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19420
diff
changeset
|
2788 %! [tmpdir, tmpfname] = fileparts (fname); |
21457
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2789 %! assert (tmpdir, def_tmpdir); |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2790 %! assert (tmpfname (1:4), "oct-"); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19420
diff
changeset
|
2791 %! ## Test 1-argument form |
21457
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2792 %! tmp_tmpdir = [def_tmpdir filesep() substr(tmpfname, -5)]; |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2793 %! mkdir (tmp_tmpdir) || error ("Unable to create tmp dir"); |
21457
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2794 %! setenv (envname, def_tmpdir); |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2795 %! fname = tempname (tmp_tmpdir); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19420
diff
changeset
|
2796 %! [tmpdir, tmpfname] = fileparts (fname); |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2797 %! assert (tmpdir, tmp_tmpdir); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2798 %! assert (tmpfname (1:4), "oct-"); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2799 %! ## Test 1-argument form w/null tmpdir |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2800 %! fname = tempname (""); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19420
diff
changeset
|
2801 %! [tmpdir, tmpfname] = fileparts (fname); |
21457
05ffef4ebf62
tempname: Fix failing BIST test when P_tmpdir has trailing slash
Mike Miller <mtmiller@octave.org>
parents:
21301
diff
changeset
|
2802 %! assert (tmpdir, def_tmpdir); |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2803 %! assert (tmpfname (1:4), "oct-"); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19420
diff
changeset
|
2804 %! ## Test 2-argument form |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2805 %! fname = tempname (tmp_tmpdir, "pfx-"); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19420
diff
changeset
|
2806 %! [tmpdir, tmpfname] = fileparts (fname); |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2807 %! assert (tmpdir, tmp_tmpdir); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2808 %! assert (tmpfname (1:4), "pfx-"); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2809 %! ## Test 2-argument form w/null prefix |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2810 %! fname = tempname (tmp_tmpdir, ""); |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19420
diff
changeset
|
2811 %! [tmpdir, tmpfname] = fileparts (fname); |
19420
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2812 %! assert (tmpdir, tmp_tmpdir); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2813 %! assert (tmpfname (1:4), "file"); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2814 %! unwind_protect_cleanup |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2815 %! rmdir (tmp_tmpdir); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2816 %! if (isempty (envdir)) |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2817 %! unsetenv (envname); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2818 %! else |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2819 %! setenv (envname, envdir); |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2820 %! endif |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2821 %! end_unwind_protect |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2822 */ |
82f2a3437e02
Fix tempname so it prioritizes user input dir rather than TMPDIR (bug #43844).
Rik <rik@octave.org>
parents:
19403
diff
changeset
|
2823 |
4326 | 2824 DEFUN (tmpfile, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2825 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2826 @deftypefn {} {[@var{fid}, @var{msg}] =} tmpfile ()\n\ |
4326 | 2827 Return the file ID corresponding to a new temporary file with a unique\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2828 name.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2829 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2830 The file is opened in binary read/write (@qcode{\"w+b\"}) mode and will be\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2831 deleted automatically when it is closed or when Octave exits.\n\ |
4326 | 2832 \n\ |
2833 If successful, @var{fid} is a valid file ID and @var{msg} is an empty\n\ | |
2834 string. Otherwise, @var{fid} is -1 and @var{msg} contains a\n\ | |
2835 system-dependent error message.\n\ | |
19278
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
2836 @seealso{tempname, mkstemp, tempdir, P_tmpdir}\n\ |
5642 | 2837 @end deftypefn") |
4326 | 2838 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2839 if (args.length () != 0) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2840 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2841 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2842 octave_value_list retval; |
4326 | 2843 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2844 FILE *fid = gnulib::tmpfile (); |
4326 | 2845 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2846 if (fid) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2847 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2848 std::string nm; |
4326 | 2849 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2850 std::ios::openmode md = fopen_mode_to_ios_mode ("w+b"); |
4326 | 2851 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2852 octave_stream s = octave_stdiostream::create (nm, fid, md); |
4326 | 2853 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2854 if (! s) |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2855 error ("tmpfile: failed to create octave_stdiostream object"); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2856 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2857 retval = ovl (octave_stream_list::insert (s), ""); |
4326 | 2858 } |
2859 else | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2860 { |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2861 retval = ovl (-1, gnulib::strerror (errno)); |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2862 } |
4326 | 2863 |
2864 return retval; | |
2865 } | |
2866 | |
2867 DEFUN (mkstemp, args, , | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2868 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2869 @deftypefn {} {[@var{fid}, @var{name}, @var{msg}] =} mkstemp (\"@var{template}\")\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2870 @deftypefnx {} {[@var{fid}, @var{name}, @var{msg}] =} mkstemp (\"@var{template}\", @var{delete})\n\ |
19210
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2871 Return the file descriptor @var{fid} corresponding to a new temporary file\n\ |
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2872 with a unique name created from @var{template}.\n\ |
4326 | 2873 \n\ |
19210
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2874 The last six characters of @var{template} must be @qcode{\"XXXXXX\"} and\n\ |
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2875 these are replaced with a string that makes the filename unique. The file\n\ |
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
2876 is then created with mode read/write and permissions that are system\n\ |
21547
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
2877 dependent (on GNU/Linux systems, the permissions will be 0600 for versions\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
2878 of glibc 2.0.7 and later). The file is opened in binary mode and with the\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2879 @w{@code{O_EXCL}} flag.\n\ |
4326 | 2880 \n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2881 If the optional argument @var{delete} is supplied and is true, the file will\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2882 be deleted automatically when Octave exits.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2883 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2884 If successful, @var{fid} is a valid file ID, @var{name} is the name of the\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2885 file, and @var{msg} is an empty string. Otherwise, @var{fid} is -1,\n\ |
21547
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
2886 @var{name} is empty, and @var{msg} contains a system-dependent error\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21532
diff
changeset
|
2887 message.\n\ |
19278
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
2888 @seealso{tempname, tempdir, P_tmpdir, tmpfile, fopen}\n\ |
5642 | 2889 @end deftypefn") |
4326 | 2890 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2891 int nargin = args.length (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2892 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2893 if (nargin < 1 || nargin > 2) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2894 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2895 |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2896 std::string tmpl8 = args(0).xstring_value ("mkstemp: TEMPLATE argument must be a string"); |
4326 | 2897 |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2898 octave_value_list retval = ovl (-1, "", ""); |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2899 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2900 OCTAVE_LOCAL_BUFFER (char, tmp, tmpl8.size () + 1); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2901 strcpy (tmp, tmpl8.c_str ()); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2902 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2903 int fd = gnulib::mkostemp (tmp, O_BINARY); |
4326 | 2904 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2905 if (fd < 0) |
4326 | 2906 { |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2907 retval(0) = fd; |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2908 retval(2) = gnulib::strerror (errno); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2909 } |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2910 else |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2911 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2912 const char *fopen_mode = "w+b"; |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2913 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2914 FILE *fid = fdopen (fd, fopen_mode); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
2915 |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2916 if (! fid) |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2917 { |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2918 retval(0) = -1; |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2919 retval(2) = gnulib::strerror (errno); |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2920 } |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2921 else |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2922 { |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2923 std::string nm = tmp; |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
2924 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2925 std::ios::openmode md = fopen_mode_to_ios_mode (fopen_mode); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2926 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2927 octave_stream s = octave_stdiostream::create (nm, fid, md); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20561
diff
changeset
|
2928 |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2929 if (! s) |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2930 error ("mkstemp: failed to create octave_stdiostream object"); |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2931 |
20884
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2932 retval(0) = octave_stream_list::insert (s); |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2933 retval(1) = nm; |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2934 |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2935 if (nargin == 2 && args(1).is_true ()) |
f1b2a2dbc0e1
2015 Code Sprint: use ovl () in C++ files.
José Luis García Pallero <jgpallero@gmail.com>
parents:
20861
diff
changeset
|
2936 mark_for_deletion (nm); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
2937 } |
4326 | 2938 } |
2939 | |
2940 return retval; | |
2941 } | |
2942 | |
20200
d9f35ceff9e1
Change mkfifo to use an octal argument for MODE (bug #45054).
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
2943 // FIXME: This routine also exists verbatim in syscalls.cc. |
d9f35ceff9e1
Change mkfifo to use an octal argument for MODE (bug #45054).
Rik <rik@octave.org>
parents:
20198
diff
changeset
|
2944 // Maybe change to be a general utility routine. |
1400 | 2945 static int |
2946 convert (int x, int ibase, int obase) | |
2947 { | |
2948 int retval = 0; | |
2949 | |
2950 int tmp = x % obase; | |
2951 | |
2952 if (tmp > ibase - 1) | |
20428
7ac907da9fba
Use error() rather than ::error() unless explicitly required.
Rik <rik@octave.org>
parents:
20200
diff
changeset
|
2953 error ("umask: invalid digit"); |
21055
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2954 |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2955 retval = tmp; |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2956 int mult = ibase; |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2957 while ((x = (x - tmp) / obase)) |
1400 | 2958 { |
21055
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2959 tmp = x % obase; |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2960 |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2961 if (tmp > ibase - 1) |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2962 error ("umask: invalid digit"); |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2963 |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2964 retval += mult * tmp; |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20962
diff
changeset
|
2965 mult *= ibase; |
1400 | 2966 } |
2967 | |
2968 return retval; | |
2969 } | |
2970 | |
10197
4d433bd2d4dc
attempt to avoid trouble with gnulib #defines in a consistent way
John W. Eaton <jwe@octave.org>
parents:
10182
diff
changeset
|
2971 DEFUNX ("umask", Fumask, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
2972 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
2973 @deftypefn {} {} umask (@var{mask})\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2974 Set the permission mask for file creation.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
2975 \n\ |
20172
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2976 The parameter @var{mask} is an integer, interpreted as an octal number.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2977 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20101
diff
changeset
|
2978 If successful, returns the previous value of the mask (as an integer to be\n\ |
4715 | 2979 interpreted as an octal number); otherwise an error message is printed.\n\ |
20198
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
2980 \n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
2981 The permission mask is a UNIX concept used when creating new objects on a\n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
2982 file system such as files, directories, or named FIFOs. The object to be\n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
2983 created has base permissions in an octal number @var{mode} which are\n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
2984 modified according to the octal value of @var{mask}. The final permissions\n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
2985 for the new object are @code{@var{mode} - @var{mask}}.\n\ |
b597bd161a5f
doc: Document that mkfifo's mode argument is in decimal (bug #45054).
Rik <rik@octave.org>
parents:
20172
diff
changeset
|
2986 @seealso{fopen, mkdir, mkfifo}\n\ |
3301 | 2987 @end deftypefn") |
1400 | 2988 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2989 if (args.length () != 1) |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2990 print_usage (); |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2991 |
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2992 int mask = args(0).xint_value ("umask: MASK must be an integer"); |
1400 | 2993 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2994 if (mask < 0) |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2995 error ("umask: MASK must be a positive integer value"); |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
2996 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2997 int oct_mask = convert (mask, 8, 10); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2998 |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
2999 int status = convert (octave_umask (oct_mask), 10, 8); |
1400 | 3000 |
3001 if (status >= 0) | |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
3002 return ovl (status); |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20898
diff
changeset
|
3003 else |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
3004 return ovl (); |
1400 | 3005 } |
3006 | |
5749 | 3007 static octave_value |
6483 | 3008 const_value (const char *, const octave_value_list& args, int val) |
2189 | 3009 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
3010 if (args.length () != 0) |
5823 | 3011 print_usage (); |
5749 | 3012 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
3013 return octave_value (val); |
5749 | 3014 } |
3015 | |
3016 DEFUNX ("P_tmpdir", FP_tmpdir, args, , | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
3017 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3018 @deftypefn {} {} P_tmpdir ()\n\ |
19210
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
3019 Return the name of the host system's @strong{default} directory for\n\ |
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
3020 temporary files.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3021 \n\ |
19210
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
3022 Programming Note: The value returned by @code{P_tmpdir} is always the\n\ |
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
3023 default location. This value may not agree with that returned from\n\ |
20097
1f9ed81bd173
maint: Fix spelling and grammar mistakes in docs and comments (bug #44878)
Rafael Laboissiere <rafael@laboissiere.net>
parents:
20041
diff
changeset
|
3024 @code{tempdir} if the user has overridden the default with the @env{TMPDIR}\n\ |
19210
841d8f606bcd
doc: Improve docstrings for tempname, tempdir family of functions.
Rik <rik@octave.org>
parents:
19150
diff
changeset
|
3025 environment variable.\n\ |
19278
6ca096827123
Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents:
19268
diff
changeset
|
3026 @seealso{tempdir, tempname, mkstemp, tmpfile}\n\ |
5749 | 3027 @end deftypefn") |
3028 { | |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
3029 if (args.length () != 0) |
5823 | 3030 print_usage (); |
5749 | 3031 |
21127
df7891224709
maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents:
21126
diff
changeset
|
3032 return ovl (get_P_tmpdir ()); |
5749 | 3033 } |
2341 | 3034 |
5749 | 3035 // NOTE: the values of SEEK_SET, SEEK_CUR, and SEEK_END have to be |
3036 // this way for Matlab compatibility. | |
3037 | |
3038 DEFUNX ("SEEK_SET", FSEEK_SET, args, , | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
3039 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3040 @deftypefn {} {} SEEK_SET ()\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3041 @deftypefnx {} {} SEEK_CUR ()\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3042 @deftypefnx {} {} SEEK_END ()\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3043 Return the numerical value to pass to @code{fseek} to perform one of the\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3044 following actions:\n\ |
14366
b76f0740940e
doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14365
diff
changeset
|
3045 \n\ |
3372 | 3046 @table @code\n\ |
3047 @item SEEK_SET\n\ | |
3048 Position file relative to the beginning.\n\ | |
3049 \n\ | |
3050 @item SEEK_CUR\n\ | |
3051 Position file relative to the current position.\n\ | |
3052 \n\ | |
3053 @item SEEK_END\n\ | |
5749 | 3054 Position file relative to the end.\n\ |
3372 | 3055 @end table\n\ |
14171
2ced2f59f523
doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
3056 @seealso{fseek}\n\ |
5749 | 3057 @end deftypefn") |
3058 { | |
3059 return const_value ("SEEK_SET", args, -1); | |
3060 } | |
2189 | 3061 |
5749 | 3062 DEFUNX ("SEEK_CUR", FSEEK_CUR, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
3063 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3064 @deftypefn {} {} SEEK_CUR ()\n\ |
14171
2ced2f59f523
doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
3065 Return the numerical value to pass to @code{fseek} to\n\ |
2ced2f59f523
doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
3066 position the file pointer relative to the current position.\n\ |
18040
62f94ef938b4
don't use period after end of @seealso{...}
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
3067 @seealso{SEEK_SET, SEEK_END}\n\ |
5749 | 3068 @end deftypefn") |
3069 { | |
3070 return const_value ("SEEK_CUR", args, 0); | |
3071 } | |
2189 | 3072 |
5749 | 3073 DEFUNX ("SEEK_END", FSEEK_END, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
3074 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3075 @deftypefn {} {} SEEK_END ()\n\ |
14171
2ced2f59f523
doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
3076 Return the numerical value to pass to @code{fseek} to\n\ |
2ced2f59f523
doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
3077 position the file pointer relative to the end of the file.\n\ |
18040
62f94ef938b4
don't use period after end of @seealso{...}
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
3078 @seealso{SEEK_SET, SEEK_CUR}\n\ |
5749 | 3079 @end deftypefn") |
3080 { | |
3081 return const_value ("SEEK_END", args, 1); | |
3082 } | |
3083 | |
3084 static octave_value | |
6483 | 3085 const_value (const char *, const octave_value_list& args, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10259
diff
changeset
|
3086 const octave_value& val) |
5749 | 3087 { |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
3088 if (args.length () != 0) |
5823 | 3089 print_usage (); |
5749 | 3090 |
20805
2d6ddb2b157c
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20785
diff
changeset
|
3091 return octave_value (val); |
5749 | 3092 } |
3093 | |
3094 DEFUNX ("stdin", Fstdin, args, , | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
3095 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3096 @deftypefn {} {} stdin ()\n\ |
5749 | 3097 Return the numeric value corresponding to the standard input stream.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3098 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3099 When Octave is used interactively, stdin is filtered through the command\n\ |
5749 | 3100 line editing functions.\n\ |
5333 | 3101 @seealso{stdout, stderr}\n\ |
5749 | 3102 @end deftypefn") |
3103 { | |
3104 return const_value ("stdin", args, stdin_file); | |
3105 } | |
2189 | 3106 |
5749 | 3107 DEFUNX ("stdout", Fstdout, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
3108 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3109 @deftypefn {} {} stdout ()\n\ |
5749 | 3110 Return the numeric value corresponding to the standard output stream.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3111 \n\ |
5749 | 3112 Data written to the standard output is normally filtered through the pager.\n\ |
5333 | 3113 @seealso{stdin, stderr}\n\ |
5749 | 3114 @end deftypefn") |
3115 { | |
3116 return const_value ("stdout", args, stdout_file); | |
3117 } | |
2189 | 3118 |
5749 | 3119 DEFUNX ("stderr", Fstderr, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
3120 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20846
diff
changeset
|
3121 @deftypefn {} {} stderr ()\n\ |
5749 | 3122 Return the numeric value corresponding to the standard error stream.\n\ |
19109
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3123 \n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3124 Even if paging is turned on, the standard error is not sent to the pager.\n\ |
e90bfaadb489
doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents:
19030
diff
changeset
|
3125 It is useful for error messages and prompts.\n\ |
5333 | 3126 @seealso{stdin, stdout}\n\ |
5749 | 3127 @end deftypefn") |
3128 { | |
3129 return const_value ("stderr", args, stderr_file); | |
2189 | 3130 } |