Mercurial > octave-nkf
annotate src/oct-stream.h @ 14138:72c96de7a403 stable
maint: update copyright notices for 2012
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 02 Jan 2012 14:25:41 -0500 |
| parents | 43cc49c7abd1 |
| children | 238e499c5fea d174210ce1ec |
| rev | line source |
|---|---|
| 2117 | 1 /* |
| 2 | |
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13985
diff
changeset
|
3 Copyright (C) 1996-2012 John W. Eaton |
| 2117 | 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. | |
| 2117 | 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/>. | |
| 2117 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_octave_stream_h) | |
| 24 #define octave_octave_stream_h 1 | |
| 25 | |
| 2877 | 26 class Matrix; |
| 27 class string_vector; | |
| 28 class octave_value; | |
| 29 class octave_value_list; | |
| 2117 | 30 |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
31 #include <iosfwd> |
| 5765 | 32 #include <sstream> |
| 2877 | 33 #include <string> |
| 6757 | 34 #include <map> |
| 2117 | 35 |
| 36 #include "Array.h" | |
| 2317 | 37 #include "data-conv.h" |
| 3640 | 38 #include "lo-utils.h" |
| 2317 | 39 #include "mach-info.h" |
|
13985
43cc49c7abd1
Use thread-safe atomic reference counting (GCC and MSVC).
Michael Goffioul <michael.goffioul@gmail.com>
parents:
13983
diff
changeset
|
40 #include "oct-refcount.h" |
| 2117 | 41 |
| 3640 | 42 class |
| 6109 | 43 OCTINTERP_API |
| 2117 | 44 scanf_format_elt |
| 45 { | |
| 3640 | 46 public: |
| 47 | |
| 3483 | 48 enum special_conversion |
| 49 { | |
| 50 whitespace_conversion = 1, | |
| 51 literal_conversion = 2 | |
| 52 }; | |
| 53 | |
| 2215 | 54 scanf_format_elt (const char *txt = 0, int w = 0, bool d = false, |
| 10313 | 55 char typ = '\0', char mod = '\0', |
| 56 const std::string& ch_class = std::string ()) | |
| 3640 | 57 : text (strsave (txt)), width (w), discard (d), type (typ), |
| 58 modifier (mod), char_class (ch_class) { } | |
| 59 | |
| 60 scanf_format_elt (const scanf_format_elt& e) | |
| 61 : text (strsave (e.text)), width (e.width), discard (e.discard), | |
| 62 type (e.type), modifier (e.modifier), char_class (e.char_class) { } | |
| 2117 | 63 |
| 3640 | 64 scanf_format_elt& operator = (const scanf_format_elt& e) |
| 65 { | |
| 66 if (this != &e) | |
| 10313 | 67 { |
| 68 text = strsave (e.text); | |
| 69 width = e.width; | |
| 70 discard = e.discard; | |
| 71 type = e.type; | |
| 72 modifier = e.modifier; | |
| 73 char_class = e.char_class; | |
| 74 } | |
| 2117 | 75 |
| 3640 | 76 return *this; |
| 77 } | |
| 78 | |
| 79 ~scanf_format_elt (void) { delete [] text; } | |
| 80 | |
| 81 // The C-style format string. | |
| 2117 | 82 const char *text; |
| 3640 | 83 |
| 84 // The maximum field width. | |
| 2215 | 85 int width; |
| 3640 | 86 |
| 87 // TRUE if we are not storing the result of this conversion. | |
| 2117 | 88 bool discard; |
| 3640 | 89 |
| 90 // Type of conversion -- `d', `i', `o', `u', `x', `e', `f', `g', | |
| 91 // `c', `s', `p', `%', or `['. | |
| 2117 | 92 char type; |
| 3640 | 93 |
| 94 // A length modifier -- `h', `l', or `L'. | |
| 2117 | 95 char modifier; |
| 3640 | 96 |
| 97 // The class of characters in a `[' format. | |
| 3523 | 98 std::string char_class; |
| 2117 | 99 }; |
| 100 | |
| 101 class | |
| 6109 | 102 OCTINTERP_API |
| 2117 | 103 scanf_format_list |
| 104 { | |
| 105 public: | |
| 106 | |
| 3523 | 107 scanf_format_list (const std::string& fmt = std::string ()); |
| 2117 | 108 |
| 109 ~scanf_format_list (void); | |
| 110 | |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
111 octave_idx_type num_conversions (void) { return nconv; } |
| 2117 | 112 |
| 2215 | 113 // The length can be different than the number of conversions. |
| 114 // For example, "x %d y %d z" has 2 conversions but the length of | |
| 115 // the list is 3 because of the characters that appear after the | |
| 116 // last conversion. | |
| 117 | |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
118 octave_idx_type length (void) { return list.length (); } |
| 2215 | 119 |
| 2117 | 120 const scanf_format_elt *first (void) |
| 121 { | |
| 122 curr_idx = 0; | |
| 123 return current (); | |
| 124 } | |
| 125 | |
| 126 const scanf_format_elt *current (void) const | |
| 127 { return list.length () > 0 ? list.elem (curr_idx) : 0; } | |
| 128 | |
| 3640 | 129 const scanf_format_elt *next (bool cycle = true) |
| 2117 | 130 { |
| 131 curr_idx++; | |
| 3640 | 132 |
| 2117 | 133 if (curr_idx >= list.length ()) |
| 10313 | 134 { |
| 135 if (cycle) | |
| 136 curr_idx = 0; | |
| 137 else | |
| 138 return 0; | |
| 139 } | |
| 2117 | 140 return current (); |
| 141 } | |
| 142 | |
| 143 void printme (void) const; | |
| 144 | |
| 145 bool ok (void) const { return (nconv >= 0); } | |
| 146 | |
| 3145 | 147 operator bool () const { return ok (); } |
| 2117 | 148 |
| 149 bool all_character_conversions (void); | |
| 150 | |
| 151 bool all_numeric_conversions (void); | |
| 152 | |
| 153 private: | |
| 154 | |
| 3642 | 155 // Number of conversions specified by this format string, or -1 if |
| 2117 | 156 // invalid conversions have been found. |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
157 octave_idx_type nconv; |
| 2117 | 158 |
| 159 // Index to current element; | |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
160 octave_idx_type curr_idx; |
| 2117 | 161 |
|
11570
57632dea2446
attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
162 // FIXME -- maybe LIST should be a std::list object? |
| 2117 | 163 // List of format elements. |
| 164 Array<scanf_format_elt*> list; | |
| 165 | |
| 166 // Temporary buffer. | |
| 5765 | 167 std::ostringstream *buf; |
| 2117 | 168 |
| 2215 | 169 void add_elt_to_list (int width, bool discard, char type, char modifier, |
| 10313 | 170 octave_idx_type& num_elts, |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
171 const std::string& char_class = std::string ()); |
| 2117 | 172 |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
173 void process_conversion (const std::string& s, size_t& i, size_t n, |
|
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
174 int& width, bool& discard, char& type, |
|
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
175 char& modifier, octave_idx_type& num_elts); |
| 2117 | 176 |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
177 int finish_conversion (const std::string& s, size_t& i, size_t n, |
|
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
178 int& width, bool discard, char& type, |
|
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
179 char modifier, octave_idx_type& num_elts); |
| 2117 | 180 // No copying! |
| 181 | |
| 182 scanf_format_list (const scanf_format_list&); | |
| 183 | |
| 184 scanf_format_list& operator = (const scanf_format_list&); | |
| 185 }; | |
| 186 | |
| 3640 | 187 class |
| 2117 | 188 printf_format_elt |
| 189 { | |
| 3640 | 190 public: |
| 191 | |
| 192 printf_format_elt (const char *txt = 0, int n = 0, int w = 0, | |
| 10313 | 193 int p = 0, const std::string& f = std::string (), |
| 194 char typ = '\0', char mod = '\0') | |
| 3640 | 195 : text (strsave (txt)), args (n), fw (w), prec (p), flags (f), |
| 196 type (typ), modifier (mod) { } | |
| 197 | |
| 198 printf_format_elt (const printf_format_elt& e) | |
| 199 : text (strsave (e.text)), args (e.args), fw (e.fw), prec (e.prec), | |
| 200 flags (e.flags), type (e.type), modifier (e.modifier) { } | |
| 201 | |
| 202 printf_format_elt& operator = (const printf_format_elt& e) | |
| 203 { | |
| 204 if (this != &e) | |
| 10313 | 205 { |
| 206 text = strsave (e.text); | |
| 207 args = e.args; | |
| 208 fw = e.fw; | |
| 209 prec = e.prec; | |
| 210 flags = e.flags; | |
| 211 type = e.type; | |
| 212 modifier = e.modifier; | |
| 213 } | |
| 2117 | 214 |
| 3640 | 215 return *this; |
| 216 } | |
| 2117 | 217 |
| 3640 | 218 ~printf_format_elt (void) { delete [] text; } |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
219 |
| 3640 | 220 // The C-style format string. |
| 2117 | 221 const char *text; |
| 3640 | 222 |
| 223 // How many args do we expect to consume? | |
| 2117 | 224 int args; |
| 3640 | 225 |
| 226 // Field width. | |
| 227 int fw; | |
| 228 | |
| 229 // Precision. | |
| 230 int prec; | |
| 231 | |
| 232 // Flags -- `-', `+', ` ', `0', or `#'. | |
| 3642 | 233 std::string flags; |
| 3640 | 234 |
| 235 // Type of conversion -- `d', `i', `o', `x', `X', `u', `c', `s', | |
| 236 // `f', `e', `E', `g', `G', `p', or `%' | |
| 2117 | 237 char type; |
| 3640 | 238 |
| 239 // A length modifier -- `h', `l', or `L'. | |
| 2117 | 240 char modifier; |
| 241 }; | |
| 242 | |
| 243 class | |
| 6109 | 244 OCTINTERP_API |
| 2117 | 245 printf_format_list |
| 246 { | |
| 247 public: | |
| 248 | |
| 3523 | 249 printf_format_list (const std::string& fmt = std::string ()); |
| 2117 | 250 |
| 251 ~printf_format_list (void); | |
| 252 | |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
253 octave_idx_type num_conversions (void) { return nconv; } |
| 2117 | 254 |
| 255 const printf_format_elt *first (void) | |
| 256 { | |
| 257 curr_idx = 0; | |
| 258 return current (); | |
| 259 } | |
| 260 | |
| 261 const printf_format_elt *current (void) const | |
| 262 { return list.length () > 0 ? list.elem (curr_idx) : 0; } | |
| 263 | |
| 3640 | 264 const printf_format_elt *next (bool cycle = true) |
| 2117 | 265 { |
| 266 curr_idx++; | |
| 3640 | 267 |
| 2117 | 268 if (curr_idx >= list.length ()) |
| 10313 | 269 { |
| 270 if (cycle) | |
| 271 curr_idx = 0; | |
| 272 else | |
| 273 return 0; | |
| 274 } | |
| 3640 | 275 |
| 2117 | 276 return current (); |
| 277 } | |
| 278 | |
| 3640 | 279 bool last_elt_p (void) { return (curr_idx + 1 == list.length ()); } |
| 280 | |
| 2117 | 281 void printme (void) const; |
| 282 | |
| 283 bool ok (void) const { return (nconv >= 0); } | |
| 284 | |
| 3145 | 285 operator bool () const { return ok (); } |
| 2117 | 286 |
| 287 private: | |
| 288 | |
| 3642 | 289 // Number of conversions specified by this format string, or -1 if |
| 2117 | 290 // invalid conversions have been found. |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
291 octave_idx_type nconv; |
| 2117 | 292 |
| 293 // Index to current element; | |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
294 octave_idx_type curr_idx; |
| 2117 | 295 |
|
11570
57632dea2446
attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
296 // FIXME -- maybe LIST should be a std::list object? |
| 2117 | 297 // List of format elements. |
| 298 Array<printf_format_elt*> list; | |
| 299 | |
| 300 // Temporary buffer. | |
| 5765 | 301 std::ostringstream *buf; |
| 2117 | 302 |
| 3640 | 303 void add_elt_to_list (int args, const std::string& flags, int fw, |
| 10313 | 304 int prec, char type, char modifier, |
| 305 octave_idx_type& num_elts); | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
306 |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
307 void process_conversion (const std::string& s, size_t& i, size_t n, |
| 10313 | 308 int& args, std::string& flags, int& fw, |
| 309 int& prec, char& modifier, char& type, | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
310 octave_idx_type& num_elts); |
|
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11584
diff
changeset
|
311 |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
312 void finish_conversion (const std::string& s, size_t& i, int args, |
| 10313 | 313 const std::string& flags, int fw, int prec, |
| 314 char modifier, char& type, | |
|
10187
a44d15813a39
don't skip literal text elements in scanf formats
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
315 octave_idx_type& num_elts); |
| 2117 | 316 |
| 317 // No copying! | |
| 318 | |
| 319 printf_format_list (const printf_format_list&); | |
| 320 | |
| 321 printf_format_list& operator = (const printf_format_list&); | |
| 322 }; | |
| 323 | |
| 324 // Provide an interface for Octave streams. | |
| 325 | |
| 326 class | |
| 6109 | 327 OCTINTERP_API |
| 2117 | 328 octave_base_stream |
| 329 { | |
| 330 friend class octave_stream; | |
| 331 | |
| 332 public: | |
| 333 | |
| 3544 | 334 octave_base_stream (std::ios::openmode arg_md = std::ios::in|std::ios::out, |
| 10313 | 335 oct_mach_info::float_format ff |
| 336 = oct_mach_info::native_float_format ()) | |
|
11584
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11570
diff
changeset
|
337 : count (0), md (arg_md), flt_fmt (ff), fail (false), open_state (true), |
|
cda4aa780d58
Another round of initialising members in the constructor initialisation list
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents:
11570
diff
changeset
|
338 errmsg () |
| 3340 | 339 { } |
| 2117 | 340 |
| 341 virtual ~octave_base_stream (void) { } | |
| 342 | |
| 343 // The remaining functions are not specific to input or output only, | |
| 344 // and must be provided by the derived classes. | |
| 345 | |
| 346 // Position a stream at OFFSET relative to ORIGIN. | |
| 347 | |
| 4797 | 348 virtual int seek (long offset, int origin) = 0; |
| 2117 | 349 |
| 350 // Return current stream position. | |
| 351 | |
| 4797 | 352 virtual long tell (void) = 0; |
| 2117 | 353 |
| 3340 | 354 // Return TRUE if EOF has been reached on this stream. |
| 2117 | 355 |
| 356 virtual bool eof (void) const = 0; | |
| 357 | |
| 358 // The name of the file. | |
| 359 | |
| 3523 | 360 virtual std::string name (void) const = 0; |
| 2117 | 361 |
| 362 // If the derived class provides this function and it returns a | |
| 363 // pointer to a valid istream, scanf(), read(), getl(), and gets() | |
| 364 // will automatically work for this stream. | |
| 365 | |
| 3523 | 366 virtual std::istream *input_stream (void) { return 0; } |
| 2117 | 367 |
| 368 // If the derived class provides this function and it returns a | |
| 369 // pointer to a valid ostream, flush(), write(), and printf() will | |
| 370 // automatically work for this stream. | |
| 371 | |
| 3523 | 372 virtual std::ostream *output_stream (void) { return 0; } |
| 2117 | 373 |
| 3340 | 374 // Return TRUE if this stream is open. |
| 375 | |
| 376 bool is_open (void) const { return open_state; } | |
| 377 | |
| 3652 | 378 virtual void do_close (void) { } |
| 379 | |
| 380 void close (void) | |
| 381 { | |
| 382 if (is_open ()) | |
| 10313 | 383 { |
| 384 open_state = false; | |
| 385 do_close (); | |
| 386 } | |
| 3652 | 387 } |
| 3340 | 388 |
|
11007
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
389 virtual int file_number (void) const |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
390 { |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
391 // Kluge alert! |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
392 |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
393 if (name () == "stdin") |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
394 return 0; |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
395 else if (name () == "stdout") |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
396 return 1; |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
397 else if (name () == "stderr") |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
398 return 2; |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
399 else |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
400 return -1; |
|
ffe58182db89
src/oct-stream.h (octave_base_stream::file_number): return 0, 1, and 2 for stdin, stdout, and stderr, -1 otherwise
John W. Eaton <jwe@octave.org>
parents:
11004
diff
changeset
|
401 } |
| 3145 | 402 |
| 2117 | 403 bool ok (void) const { return ! fail; } |
| 404 | |
| 405 // Return current error message for this stream. | |
| 406 | |
| 3523 | 407 std::string error (bool clear, int& err_num); |
| 2117 | 408 |
| 409 protected: | |
| 410 | |
| 3340 | 411 int mode (void) const { return md; } |
| 2117 | 412 |
| 3340 | 413 oct_mach_info::float_format float_format (void) const { return flt_fmt; } |
| 2117 | 414 |
| 415 // Set current error state and set fail to TRUE. | |
| 416 | |
| 3523 | 417 void error (const std::string& msg); |
| 4468 | 418 void error (const std::string& who, const std::string& msg); |
| 2117 | 419 |
| 420 // Clear any error message and set fail to FALSE. | |
| 421 | |
| 422 void clear (void); | |
| 423 | |
| 4889 | 424 // Clear stream state. |
| 425 | |
| 426 void clearerr (void); | |
| 427 | |
| 2117 | 428 private: |
| 429 | |
| 3340 | 430 // A reference count. |
|
13985
43cc49c7abd1
Use thread-safe atomic reference counting (GCC and MSVC).
Michael Goffioul <michael.goffioul@gmail.com>
parents:
13983
diff
changeset
|
431 octave_refcount<octave_idx_type> count; |
| 3340 | 432 |
| 2117 | 433 // The permission bits for the file. Should be some combination of |
| 3544 | 434 // std::ios::open_mode bits. |
| 2117 | 435 int md; |
| 436 | |
| 437 // Data format. | |
| 2317 | 438 oct_mach_info::float_format flt_fmt; |
| 2117 | 439 |
| 440 // TRUE if an error has occurred. | |
| 441 bool fail; | |
| 442 | |
| 3340 | 443 // TRUE if this stream is open. |
| 444 bool open_state; | |
| 445 | |
| 2117 | 446 // Should contain error message if fail is TRUE. |
| 3523 | 447 std::string errmsg; |
| 2117 | 448 |
| 449 // Functions that are defined for all input streams (input streams | |
| 450 // are those that define is). | |
| 451 | |
| 5275 | 452 std::string do_gets (octave_idx_type max_len, bool& err, bool strip_newline, |
| 10313 | 453 const std::string& who /* = "gets" */); |
| 2117 | 454 |
| 5275 | 455 std::string getl (octave_idx_type max_len, bool& err, const std::string& who /* = "getl" */); |
| 456 std::string gets (octave_idx_type max_len, bool& err, const std::string& who /* = "gets" */); | |
| 9701 | 457 long skipl (long count, bool& err, const std::string& who /* = "skipl" */); |
| 2117 | 458 |
| 5275 | 459 octave_value do_scanf (scanf_format_list& fmt_list, octave_idx_type nr, octave_idx_type nc, |
| 10313 | 460 bool one_elt_size_spec, octave_idx_type& count, |
| 461 const std::string& who /* = "scanf" */); | |
| 2117 | 462 |
| 4468 | 463 octave_value scanf (const std::string& fmt, const Array<double>& size, |
| 10313 | 464 octave_idx_type& count, const std::string& who /* = "scanf" */); |
| 2117 | 465 |
| 4468 | 466 bool do_oscanf (const scanf_format_elt *elt, octave_value&, |
| 10313 | 467 const std::string& who /* = "scanf" */); |
| 2117 | 468 |
| 4468 | 469 octave_value_list oscanf (const std::string& fmt, |
| 10313 | 470 const std::string& who /* = "scanf" */); |
| 2215 | 471 |
| 2117 | 472 // Functions that are defined for all output streams (output streams |
| 473 // are those that define os). | |
| 474 | |
| 475 int flush (void); | |
| 476 | |
| 4468 | 477 int do_printf (printf_format_list& fmt_list, const octave_value_list& args, |
| 10313 | 478 const std::string& who /* = "printf" */); |
| 2117 | 479 |
| 4468 | 480 int printf (const std::string& fmt, const octave_value_list& args, |
| 10313 | 481 const std::string& who /* = "printf" */); |
| 2117 | 482 |
| 4468 | 483 int puts (const std::string& s, const std::string& who /* = "puts" */); |
| 2117 | 484 |
| 485 // We can always do this in terms of seek(), so the derived class | |
| 486 // only has to provide that. | |
| 487 | |
| 4468 | 488 void invalid_operation (const std::string& who, const char *rw); |
| 2117 | 489 |
| 490 // No copying! | |
| 491 | |
| 492 octave_base_stream (const octave_base_stream&); | |
| 493 | |
| 494 octave_base_stream& operator = (const octave_base_stream&); | |
| 495 }; | |
| 496 | |
| 497 class | |
| 6109 | 498 OCTINTERP_API |
| 2117 | 499 octave_stream |
| 500 { | |
| 501 public: | |
| 502 | |
| 3340 | 503 octave_stream (octave_base_stream *bs = 0); |
| 504 | |
| 505 ~octave_stream (void); | |
| 2117 | 506 |
| 3340 | 507 octave_stream (const octave_stream&); |
| 508 | |
| 509 octave_stream& operator = (const octave_stream&); | |
| 2117 | 510 |
| 511 int flush (void); | |
| 512 | |
| 5275 | 513 std::string getl (octave_idx_type max_len, bool& err, const std::string& who /* = "getl" */); |
| 4468 | 514 std::string getl (const octave_value& max_len, bool& err, |
| 10313 | 515 const std::string& who /* = "getl" */); |
| 2117 | 516 |
| 5275 | 517 std::string gets (octave_idx_type max_len, bool& err, const std::string& who /* = "gets" */); |
| 4468 | 518 std::string gets (const octave_value& max_len, bool& err, |
| 10313 | 519 const std::string& who /* = "gets" */); |
| 2117 | 520 |
| 9701 | 521 long skipl (long count, bool& err, const std::string& who /* = "skipl" */); |
| 522 long skipl (const octave_value& count, bool& err, const std::string& who /* = "skipl" */); | |
| 523 | |
| 4797 | 524 int seek (long offset, int origin); |
| 2117 | 525 int seek (const octave_value& offset, const octave_value& origin); |
| 526 | |
| 4797 | 527 long tell (void); |
| 2117 | 528 |
| 529 int rewind (void); | |
| 530 | |
| 3340 | 531 bool is_open (void) const; |
| 532 | |
| 533 void close (void); | |
| 534 | |
| 5275 | 535 octave_value read (const Array<double>& size, octave_idx_type block_size, |
| 10313 | 536 oct_data_conv::data_type input_type, |
| 537 oct_data_conv::data_type output_type, | |
| 538 octave_idx_type skip, oct_mach_info::float_format flt_fmt, | |
| 539 octave_idx_type& count); | |
| 2117 | 540 |
| 5275 | 541 octave_idx_type write (const octave_value& data, octave_idx_type block_size, |
| 10313 | 542 oct_data_conv::data_type output_type, |
| 543 octave_idx_type skip, oct_mach_info::float_format flt_fmt); | |
| 4944 | 544 |
| 545 template <class T> | |
| 5275 | 546 octave_idx_type write (const Array<T>&, octave_idx_type block_size, |
| 10313 | 547 oct_data_conv::data_type output_type, |
| 548 octave_idx_type skip, oct_mach_info::float_format flt_fmt); | |
| 2117 | 549 |
| 4468 | 550 octave_value scanf (const std::string& fmt, const Array<double>& size, |
| 10313 | 551 octave_idx_type& count, const std::string& who /* = "scanf" */); |
| 2117 | 552 |
| 5279 | 553 octave_value scanf (const octave_value& fmt, const Array<double>& size, |
| 10313 | 554 octave_idx_type& count, const std::string& who /* = "scanf" */); |
| 5279 | 555 |
| 4468 | 556 octave_value_list oscanf (const std::string& fmt, |
| 10313 | 557 const std::string& who /* = "scanf" */); |
| 2215 | 558 |
| 5279 | 559 octave_value_list oscanf (const octave_value& fmt, |
| 10313 | 560 const std::string& who /* = "scanf" */); |
| 5279 | 561 |
| 4468 | 562 int printf (const std::string& fmt, const octave_value_list& args, |
| 10313 | 563 const std::string& who /* = "printf" */); |
| 2117 | 564 |
| 5279 | 565 int printf (const octave_value& fmt, const octave_value_list& args, |
| 10313 | 566 const std::string& who /* = "printf" */); |
| 5279 | 567 |
| 4468 | 568 int puts (const std::string& s, const std::string& who /* = "puts" */); |
| 569 int puts (const octave_value& s, const std::string& who /* = "puts" */); | |
| 2117 | 570 |
| 571 bool eof (void) const; | |
| 572 | |
| 3523 | 573 std::string error (bool clear, int& err_num); |
| 2117 | 574 |
| 3523 | 575 std::string error (bool clear = false) |
| 2117 | 576 { |
| 2435 | 577 int err_num; |
| 578 return error (clear, err_num); | |
| 2117 | 579 } |
| 580 | |
| 4799 | 581 // Set the error message and state. |
| 582 | |
| 583 void error (const std::string& msg) | |
| 584 { | |
| 585 if (rep) | |
| 10313 | 586 rep->error (msg); |
| 4799 | 587 } |
| 588 | |
| 589 void error (const char *msg) { error (std::string (msg)); } | |
| 590 | |
| 3148 | 591 int file_number (void) { return rep ? rep->file_number () : -1; } |
| 3145 | 592 |
| 3340 | 593 bool is_valid (void) const { return (rep != 0); } |
| 594 | |
| 2117 | 595 bool ok (void) const { return rep && rep->ok (); } |
| 596 | |
| 3145 | 597 operator bool () const { return ok (); } |
| 2117 | 598 |
| 3523 | 599 std::string name (void) const; |
| 2117 | 600 |
| 3340 | 601 int mode (void) const; |
| 2117 | 602 |
| 3340 | 603 oct_mach_info::float_format float_format (void) const; |
| 2117 | 604 |
| 3523 | 605 static std::string mode_as_string (int mode); |
| 2117 | 606 |
| 6757 | 607 std::istream *input_stream (void) |
| 608 { | |
| 609 return rep ? rep->input_stream () : 0; | |
| 610 } | |
| 2902 | 611 |
| 6757 | 612 std::ostream *output_stream (void) |
| 613 { | |
| 614 return rep ? rep->output_stream () : 0; | |
| 615 } | |
| 2902 | 616 |
| 4889 | 617 void clearerr (void) { if (rep) rep->clearerr (); } |
| 618 | |
| 2117 | 619 private: |
| 620 | |
| 621 // The actual representation of this stream. | |
| 622 octave_base_stream *rep; | |
| 623 | |
| 5659 | 624 bool stream_ok (bool clear = true) const |
| 625 { | |
| 626 bool retval = true; | |
| 627 | |
| 628 if (rep) | |
| 10313 | 629 { |
| 630 if (clear) | |
| 631 rep->clear (); | |
| 632 } | |
| 5659 | 633 else |
| 10313 | 634 retval = false; |
| 5659 | 635 |
| 636 return retval; | |
| 637 } | |
| 4944 | 638 |
| 639 void invalid_operation (const std::string& who, const char *rw) | |
| 640 { | |
| 641 if (rep) | |
| 10313 | 642 rep->invalid_operation (who, rw); |
| 4944 | 643 } |
| 2117 | 644 }; |
| 645 | |
| 646 class | |
| 6109 | 647 OCTINTERP_API |
| 2117 | 648 octave_stream_list |
| 649 { | |
| 650 protected: | |
| 651 | |
|
8902
5d5db7a347c6
erase closed files from file list & cache lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
652 octave_stream_list (void) : list (), lookup_cache (list.end ()) { } |
| 2117 | 653 |
| 654 public: | |
| 655 | |
| 656 ~octave_stream_list (void) { } | |
| 657 | |
| 2926 | 658 static bool instance_ok (void); |
| 659 | |
| 6757 | 660 static int insert (octave_stream& os); |
| 2117 | 661 |
| 4468 | 662 static octave_stream |
| 663 lookup (int fid, const std::string& who = std::string ()); | |
| 664 | |
| 665 static octave_stream | |
| 666 lookup (const octave_value& fid, const std::string& who = std::string ()); | |
| 2117 | 667 |
| 3523 | 668 static int remove (int fid, const std::string& who = std::string ()); |
| 3341 | 669 static int remove (const octave_value& fid, |
| 10313 | 670 const std::string& who = std::string ()); |
| 2117 | 671 |
|
8902
5d5db7a347c6
erase closed files from file list & cache lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
672 static void clear (bool flush = true); |
| 2117 | 673 |
| 674 static string_vector get_info (int fid); | |
| 675 static string_vector get_info (const octave_value& fid); | |
| 676 | |
| 3523 | 677 static std::string list_open_files (void); |
| 2117 | 678 |
| 679 static octave_value open_file_numbers (void); | |
| 680 | |
| 2609 | 681 static int get_file_number (const octave_value& fid); |
| 682 | |
| 2117 | 683 private: |
| 684 | |
| 6757 | 685 typedef std::map<int, octave_stream> ostrl_map; |
| 2117 | 686 |
| 6757 | 687 ostrl_map list; |
| 2117 | 688 |
|
8902
5d5db7a347c6
erase closed files from file list & cache lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
689 mutable ostrl_map::const_iterator lookup_cache; |
|
5d5db7a347c6
erase closed files from file list & cache lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
690 |
| 2117 | 691 static octave_stream_list *instance; |
| 692 | |
|
13983
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
693 static void cleanup_instance (void) { delete instance; instance = 0; } |
|
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
694 |
| 6757 | 695 int do_insert (octave_stream& os); |
| 2117 | 696 |
| 3523 | 697 octave_stream do_lookup (int fid, const std::string& who = std::string ()) const; |
| 3341 | 698 octave_stream do_lookup (const octave_value& fid, |
| 10313 | 699 const std::string& who = std::string ()) const; |
| 2117 | 700 |
| 3523 | 701 int do_remove (int fid, const std::string& who = std::string ()); |
| 702 int do_remove (const octave_value& fid, const std::string& who = std::string ()); | |
| 2117 | 703 |
|
8902
5d5db7a347c6
erase closed files from file list & cache lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7017
diff
changeset
|
704 void do_clear (bool flush = true); |
| 2117 | 705 |
| 706 string_vector do_get_info (int fid) const; | |
| 707 string_vector do_get_info (const octave_value& fid) const; | |
| 708 | |
| 3523 | 709 std::string do_list_open_files (void) const; |
| 2117 | 710 |
| 711 octave_value do_open_file_numbers (void) const; | |
| 712 | |
| 2609 | 713 int do_get_file_number (const octave_value& fid) const; |
| 2117 | 714 }; |
| 715 | |
| 716 #endif |