source: libcfa/src/fstream.cfa@ 6e93819

Last change on this file since 6e93819 was d0cfcbe1, checked in by Peter A. Buhr <pabuhr@…>, 2 years ago

change setter routines in basic_i/ostream to return previous state

  • Property mode set to 100644
File size: 11.5 KB
RevLine 
[86bd7c1f]1//
2// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
[356189a]7// fstream.c --
[86bd7c1f]8//
[90c3b1c]9// Author : Peter A. Buhr
[86bd7c1f]10// Created On : Wed May 27 17:56:53 2015
[5d125e4]11// Last Modified By : Peter A. Buhr
[d0cfcbe1]12// Last Modified On : Fri Aug 18 10:41:17 2023
13// Update Count : 541
[86bd7c1f]14//
15
[f451177]16#include "fstream.hfa" // also includes iostream.hfa
[51b73452]17
[90c3b1c]18#include <stdio.h> // vfprintf, vfscanf
19#include <stdlib.h> // exit
20#include <stdarg.h> // varargs
[b431515]21#include <string.h> // strncpy, strerror
[91c389a]22#include <assert.h>
[8a25be9]23#include <errno.h> // errno
[51b73452]24
[cce4648]25#pragma GCC visibility push(default)
26
[7baff35]27
[8d321f9]28// *********************************** ofstream ***********************************
[65240bb]29
30
[53ba273]31#define IO_MSG "I/O error: "
[6ba0659]32
[7ce2483]33// private
34void ?{}( ofstream & os, void * file ) with( os ) {
[3bf3b6b]35 file$ = file;
36 sepDefault$ = true;
37 sepOnOff$ = false;
38 nlOnOff$ = true;
39 prt$ = false;
40 sawNL$ = false;
[6c5d92f]41 sepSetCur$( os, sepGet( os ) );
[5cb2b8c]42 sepSet( os, " " );
43 sepSetTuple( os, ", " );
[65240bb]44} // ?{}
[0583064b]45
[f5d9c37]46inline bool getNL$( ofstream & os ) { return os.sawNL$; }
[d0cfcbe1]47inline bool setNL$( ofstream & os, bool state ) { bool temp = os.sawNL$; os.sawNL$ = state; return temp; }
[f5d9c37]48inline bool getANL$( ofstream & os ) { return os.nlOnOff$; }
[d0cfcbe1]49inline bool setANL$( ofstream & os, bool state ) { bool temp = os.nlOnOff$; os.nlOnOff$ = state; return temp; }
[f5d9c37]50
[7ce2483]51inline bool sepPrt$( ofstream & os ) { setNL$( os, false ); return os.sepOnOff$; }
52inline void sepReset$( ofstream & os ) { os.sepOnOff$ = os.sepDefault$; }
53inline void sepReset$( ofstream & os, bool reset ) { os.sepDefault$ = reset; os.sepOnOff$ = os.sepDefault$; }
54inline const char * sepGetCur$( ofstream & os ) { return os.sepCur$; }
55inline void sepSetCur$( ofstream & os, const char sepCur[] ) { os.sepCur$ = sepCur; }
[f5d9c37]56
[7ce2483]57inline bool getPrt$( ofstream & os ) { return os.prt$; }
[d0cfcbe1]58inline bool setPrt$( ofstream & os, bool state ) { bool temp = os.prt$; os.prt$ = state; return temp; }
[7ce2483]59
[c52f033]60inline void lock( ofstream & os ) with( os ) { lock( os.lock$ ); }
[7ce2483]61inline void unlock( ofstream & os ) { unlock( os.lock$ ); }
[829c907]62
[9ebd778]63// public
[6c5d92f]64void ?{}( ofstream & os ) { os.file$ = 0p; }
[7ce2483]65void ?{}( ofstream & os, const char name[], const char mode[] ) { open( os, name, mode ); }
66void ?{}( ofstream & os, const char name[] ) { open( os, name, "w" ); }
67void ^?{}( ofstream & os ) { close( os ); }
[4cae032]68
[f5d9c37]69void nlOn( ofstream & os ) { os.nlOnOff$ = true; }
70void nlOff( ofstream & os ) { os.nlOnOff$ = false; }
[09687aa]71
[f5d9c37]72void sep( ofstream & os ) { os.sepOnOff$ = ! getNL$( os ); }
73void nosep( ofstream & os ) { os.sepOnOff$ = false; }
[6152c81]74
[f5d9c37]75bool sepOn( ofstream & os ) {
[6c5d92f]76 bool temp = os.sepDefault$;
77 os.sepDefault$ = true;
78 if ( os.sepOnOff$ ) sepReset$( os ); // start of line ?
[53ba273]79 return temp;
[f5d9c37]80} // sepOn
[90c3b1c]81
[f5d9c37]82bool sepOff( ofstream & os ) {
83 bool temp = os.sepDefault$;
84 os.sepDefault$ = false;
85 sepReset$( os );
86 return temp;
87} // sepOff
[200fcb3]88
[6c5d92f]89const char * sepGet( ofstream & os ) { return os.separator$; }
[e3fea42]90void sepSet( ofstream & os, const char s[] ) {
[9ebd778]91 assert( s );
[b431515]92 strncpy( os.separator$, s, ofstream_sepSize - 1 );
93 os.separator$[ofstream_sepSize - 1] = '\0';
[9ebd778]94} // sepSet
95
[6c5d92f]96const char * sepGetTuple( ofstream & os ) { return os.tupleSeparator$; }
[e3fea42]97void sepSetTuple( ofstream & os, const char s[] ) {
[9ebd778]98 assert( s );
[b431515]99 strncpy( os.tupleSeparator$, s, ofstream_sepSize - 1 );
100 os.tupleSeparator$[ofstream_sepSize - 1] = '\0';
[9ebd778]101} // sepSet
102
[65240bb]103void ends( ofstream & os ) {
[6c5d92f]104 if ( getANL$( os ) ) nl( os );
105 else setPrt$( os, false ); // turn off
[65240bb]106 if ( &os == &exit ) exit( EXIT_FAILURE );
107 if ( &os == &abort ) abort();
108} // ends
109
[7ce2483]110bool fail( ofstream & os ) { return os.file$ == 0 || ferror( (FILE *)(os.file$) ); }
111void clear( ofstream & os ) { clearerr( (FILE *)(os.file$) ); }
112int flush( ofstream & os ) { return fflush( (FILE *)(os.file$) ); }
[6ba0659]113
[e3fea42]114void open( ofstream & os, const char name[], const char mode[] ) {
[8dcb832]115 FILE * file;
116 for ( cnt; 10 ) {
117 errno = 0;
118 file = fopen( name, mode );
119 if ( file != 0p || errno != EINTR ) break; // timer interrupt ?
120 if ( cnt == 9 ) abort( "ofstream open EINTR spinning exceeded" );
121 } // for
[d1a9ff5]122 if ( file == 0p ) {
[874b16e]123 throw (open_failure){ os };
[8d321f9]124 // abort | IO_MSG "open output file \"" | name | "\"" | nl | strerror( errno );
[93c2e0a]125 } // if
[cce4648]126 (os){ file }; // initialize
[6ba0659]127} // open
128
[7ce2483]129void open( ofstream & os, const char name[] ) { open( os, name, "w" ); }
[8da74119]130
[7ce2483]131void close( ofstream & os ) with( os ) {
[3bf3b6b]132 if ( (FILE *)(file$) == 0p ) return;
133 if ( (FILE *)(file$) == (FILE *)stdout || (FILE *)(file$) == (FILE *)stderr ) return;
[6ba0659]134
[8dcb832]135 int ret;
136 for ( cnt; 10 ) {
137 errno = 0;
138 ret = fclose( (FILE *)(file$) );
139 if ( ret != EOF || errno != EINTR ) break; // timer interrupt ?
140 if ( cnt == 9 ) abort( "ofstream open EINTR spinning exceeded" );
141 } // for
142 if ( ret == EOF ) {
[874b16e]143 throw (close_failure){ os };
[ba0d2ea]144 // abort | IO_MSG "close output" | nl | strerror( errno );
[356189a]145 } // if
[7ce2483]146 file$ = 0p; // safety after close
[6ba0659]147} // close
148
[e3fea42]149ofstream & write( ofstream & os, const char data[], size_t size ) {
[6ba0659]150 if ( fail( os ) ) {
[874b16e]151 throw (write_failure){ os };
[ba0d2ea]152 // abort | IO_MSG "attempt write I/O on failed stream";
[6ba0659]153 } // if
154
[6c5d92f]155 if ( fwrite( data, 1, size, (FILE *)(os.file$) ) != size ) {
[874b16e]156 throw (write_failure){ os };
[ba0d2ea]157 // abort | IO_MSG "write" | nl | strerror( errno );
[839ccbb]158 } // if
[86bd7c1f]159 return os;
[839ccbb]160} // write
[51b73452]161
[09687aa]162int fmt( ofstream & os, const char format[], ... ) {
[5d125e4]163 va_list args;
[829c907]164 va_start( args, format );
[cce4648]165
[8dcb832]166 int len;
167 for ( cnt; 10 ) {
168 errno = 0;
[7a1b7e6]169 disable_interrupts();
[8dcb832]170 len = vfprintf( (FILE *)(os.file$), format, args );
[7a1b7e6]171 enable_interrupts();
[8dcb832]172 if ( len != EOF || errno != EINTR ) break; // timer interrupt ?
173 if ( cnt == 9 ) abort( "ofstream fmt EINTR spinning exceeded" );
174 } // for
[bbdf954]175 if ( len == EOF ) { // error writing ?
176 abort | IO_MSG "invalid write";
[90c3b1c]177 } // if
[5d125e4]178 va_end( args );
[b72bad4f]179
[6c5d92f]180 setPrt$( os, true ); // called in output cascade
181 sepReset$( os ); // reset separator
[90c3b1c]182 return len;
[829c907]183} // fmt
184
[fd8f88f]185static ofstream soutFile = { (FILE *)stdout };
[a87d40b]186ofstream & sout = soutFile, & stdout = soutFile;
[fd8f88f]187static ofstream serrFile = { (FILE *)stderr };
[a87d40b]188ofstream & serr = serrFile, & stderr = serrFile;
[51b73452]189
[e474cf09]190static ofstream lsoutFile = { (FILE *)stdout };
191ofstream & lsout = lsoutFile;
192
[fd8f88f]193static ofstream exitFile = { (FILE *)stdout };
[65240bb]194ofstream & exit = exitFile;
[fd8f88f]195static ofstream abortFile = { (FILE *)stderr };
[65240bb]196ofstream & abort = abortFile;
[5cb2b8c]197
[f451177]198ofstream & nl( ofstream & os ) {
199 nl$( os ); // call basic_ostream nl
200 flush( os );
201 return os;
202} // nl
[90c3b1c]203
[00e9be9]204
[8d321f9]205// *********************************** ifstream ***********************************
[65240bb]206
[51b73452]207
[09687aa]208// private
[7ce2483]209void ?{}( ifstream & is, void * file ) with( is ) {
[3bf3b6b]210 file$ = file;
211 nlOnOff$ = false;
[65240bb]212} // ?{}
[09687aa]213
[c8371b5]214bool getANL$( ifstream & os ) { return os.nlOnOff$; }
[d0cfcbe1]215bool setANL$( ifstream & os, bool state ) { bool temp = os.nlOnOff$; os.nlOnOff$ = state; return temp; }
[c8371b5]216
[7ce2483]217inline void lock( ifstream & os ) with( os ) { lock( os.lock$ ); }
218inline void unlock( ifstream & os ) { unlock( os.lock$ ); }
219
[09687aa]220// public
[6c5d92f]221void ?{}( ifstream & is ) { is.file$ = 0p; }
[7ce2483]222void ?{}( ifstream & is, const char name[], const char mode[] ) { open( is, name, mode ); }
223void ?{}( ifstream & is, const char name[] ) { open( is, name, "r" ); }
224void ^?{}( ifstream & is ) { close( is ); }
[4cae032]225
[7ce2483]226bool fail( ifstream & is ) { return is.file$ == 0p || ferror( (FILE *)(is.file$) ); }
227void clear( ifstream & is ) { clearerr( (FILE *)(is.file$) ); }
[00e9be9]228
[c8371b5]229void nlOn( ifstream & os ) { os.nlOnOff$ = true; }
230void nlOff( ifstream & os ) { os.nlOnOff$ = false; }
231
232void ends( ifstream & is ) {}
[e474cf09]233
[c8371b5]234bool eof( ifstream & is ) { return feof( (FILE *)(is.file$) ) != 0; }
[6ba0659]235
[e3fea42]236void open( ifstream & is, const char name[], const char mode[] ) {
[8dcb832]237 FILE * file;
238 for ( cnt; 10 ) {
239 errno = 0;
240 file = fopen( name, mode );
241 if ( file != 0p || errno != EINTR ) break; // timer interrupt ?
242 if ( cnt == 9 ) abort( "ifstream open EINTR spinning exceeded" );
243 } // for
[d1a9ff5]244 if ( file == 0p ) {
[874b16e]245 throw (open_failure){ is };
[8d321f9]246 // abort | IO_MSG "open input file \"" | name | "\"" | nl | strerror( errno );
[93c2e0a]247 } // if
[cce4648]248 (is){ file }; // initialize
[90c3b1c]249} // open
[6ba0659]250
[7ce2483]251void open( ifstream & is, const char name[] ) { open( is, name, "r" ); }
[8da74119]252
[7ce2483]253void close( ifstream & is ) with( is ) {
[3bf3b6b]254 if ( (FILE *)(file$) == 0p ) return;
255 if ( (FILE *)(file$) == (FILE *)stdin ) return;
[90c3b1c]256
[8dcb832]257 int ret;
258 for ( cnt; 10 ) {
259 errno = 0;
260 ret = fclose( (FILE *)(file$) );
261 if ( ret != EOF || errno != EINTR ) break; // timer interrupt ?
262 if ( cnt == 9 ) abort( "ifstream close EINTR spinning exceeded" );
263 } // for
264 if ( ret == EOF ) {
[874b16e]265 throw (close_failure){ is };
[ba0d2ea]266 // abort | IO_MSG "close input" | nl | strerror( errno );
[356189a]267 } // if
[8dcb832]268 file$ = 0p; // safety after close
[90c3b1c]269} // close
270
[00e9be9]271ifstream & read( ifstream & is, char data[], size_t size ) {
[6ba0659]272 if ( fail( is ) ) {
[874b16e]273 throw (read_failure){ is };
[ba0d2ea]274 // abort | IO_MSG "attempt read I/O on failed stream";
[6ba0659]275 } // if
276
[6c5d92f]277 if ( fread( data, size, 1, (FILE *)(is.file$) ) == 0 ) {
[874b16e]278 throw (read_failure){ is };
[ba0d2ea]279 // abort | IO_MSG "read" | nl | strerror( errno );
[6ba0659]280 } // if
[86bd7c1f]281 return is;
[6ba0659]282} // read
[356189a]283
[09687aa]284ifstream &ungetc( ifstream & is, char c ) {
[6ba0659]285 if ( fail( is ) ) {
[ff2a33e]286 abort | IO_MSG "attempt ungetc I/O on failed stream";
[6ba0659]287 } // if
[51b73452]288
[6c5d92f]289 if ( ungetc( c, (FILE *)(is.file$) ) == EOF ) {
[ff2a33e]290 abort | IO_MSG "ungetc" | nl | strerror( errno );
[6ba0659]291 } // if
292 return is;
293} // ungetc
[51b73452]294
[09687aa]295int fmt( ifstream & is, const char format[], ... ) {
[5d125e4]296 va_list args;
[829c907]297 va_start( args, format );
[8dcb832]298
299 int len;
300 for () { // no check for EINTR limit waiting for keyboard input
301 errno = 0;
[7a1b7e6]302 disable_interrupts();
[8dcb832]303 len = vfscanf( (FILE *)(is.file$), format, args );
[7a1b7e6]304 enable_interrupts();
[8dcb832]305 if ( len != EOF || errno != EINTR ) break; // timer interrupt ?
306 } // for
[bbdf954]307 if ( len == EOF ) { // EOF or matching failure ?
308 if ( ! feof( (FILE *)(is.file$) ) && ferror( (FILE *)(is.file$) ) ) {
[ff2a33e]309 abort | IO_MSG "invalid read";
[90c3b1c]310 } // if
311 } // if
[5d125e4]312 va_end( args );
[90c3b1c]313 return len;
[829c907]314} // fmt
[51b73452]315
[fd8f88f]316static ifstream sinFile = { (FILE *)stdin };
[a87d40b]317ifstream & sin = sinFile, & stdin = sinFile;
[86bd7c1f]318
[91e52be]319
[8d321f9]320// *********************************** exceptions ***********************************
[91e52be]321
322
[874b16e]323static vtable(open_failure) open_failure_vt;
[a5a6a1a8]324
325// exception I/O constructors
[874b16e]326void ?{}( open_failure & ex, ofstream & ostream ) with(ex) {
327 virtual_table = &open_failure_vt;
[3bf3b6b]328 ostream = &ostream;
329 tag = 1;
[a5a6a1a8]330} // ?{}
331
[874b16e]332void ?{}( open_failure & ex, ifstream & istream ) with(ex) {
333 virtual_table = &open_failure_vt;
[3bf3b6b]334 istream = &istream;
335 tag = 0;
[a5a6a1a8]336} // ?{}
337
338
[874b16e]339static vtable(close_failure) close_failure_vt;
[ba0d2ea]340
341// exception I/O constructors
[874b16e]342void ?{}( close_failure & ex, ofstream & ostream ) with(ex) {
343 virtual_table = &close_failure_vt;
[3bf3b6b]344 ostream = &ostream;
345 tag = 1;
[ba0d2ea]346} // ?{}
347
[874b16e]348void ?{}( close_failure & ex, ifstream & istream ) with(ex) {
349 virtual_table = &close_failure_vt;
[3bf3b6b]350 istream = &istream;
351 tag = 0;
[ba0d2ea]352} // ?{}
353
354
[874b16e]355static vtable(write_failure) write_failure_vt;
[ba0d2ea]356
357// exception I/O constructors
[874b16e]358void ?{}( write_failure & ex, ofstream & ostream ) with(ex) {
359 virtual_table = &write_failure_vt;
[3bf3b6b]360 ostream = &ostream;
361 tag = 1;
[ba0d2ea]362} // ?{}
363
[874b16e]364void ?{}( write_failure & ex, ifstream & istream ) with(ex) {
365 virtual_table = &write_failure_vt;
[3bf3b6b]366 istream = &istream;
367 tag = 0;
[ba0d2ea]368} // ?{}
369
370
[874b16e]371static vtable(read_failure) read_failure_vt;
[ba0d2ea]372
373// exception I/O constructors
[874b16e]374void ?{}( read_failure & ex, ofstream & ostream ) with(ex) {
375 virtual_table = &read_failure_vt;
[3bf3b6b]376 ostream = &ostream;
377 tag = 1;
[ba0d2ea]378} // ?{}
379
[874b16e]380void ?{}( read_failure & ex, ifstream & istream ) with(ex) {
381 virtual_table = &read_failure_vt;
[3bf3b6b]382 istream = &istream;
383 tag = 0;
[ba0d2ea]384} // ?{}
385
[874b16e]386// void throwopen_failure( ofstream & ostream ) {
387// open_failure exc = { ostream };
[ba0d2ea]388// }
389
[874b16e]390// void throwopen_failure( ifstream & istream ) {
391// open_failure exc = { istream };
[ba0d2ea]392// }
[91e52be]393
[86bd7c1f]394// Local Variables: //
395// tab-width: 4 //
396// End: //
Note: See TracBrowser for help on using the repository browser.