source: libcfa/src/fstream.hfa @ 7e7a076

Last change on this file since 7e7a076 was 7e7a076, checked in by caparsons <caparson@…>, 2 months ago

added routines so fstreams could be acquired with the mutex stmt

  • Property mode set to 100644
File size: 5.1 KB
Line 
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//
7// fstream --
8//
9// Author           : Peter A. Buhr
10// Created On       : Wed May 27 17:56:53 2015
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Wed Jul 28 07:35:50 2021
13// Update Count     : 234
14//
15
16#pragma once
17
18#include "bits/weakso_locks.hfa"                                                // mutex_lock
19#include "iostream.hfa"
20#include <exception.hfa>
21
22
23// *********************************** ofstream ***********************************
24
25
26enum { ofstream_sepSize = 16 };
27struct ofstream {
28        void * file$;
29        bool sepDefault$;
30        bool sepOnOff$;
31        bool nlOnOff$;
32        bool prt$;                                                                                      // print text
33        bool sawNL$;
34        const char * sepCur$;
35        char separator$[ofstream_sepSize];
36        char tupleSeparator$[ofstream_sepSize];
37        multiple_acquisition_lock lock$;
38        bool acquired$;
39}; // ofstream
40
41// Satisfies ostream
42
43// private
44bool sepPrt$( ofstream & );
45void sepReset$( ofstream & );
46void sepReset$( ofstream &, bool );
47const char * sepGetCur$( ofstream & );
48void sepSetCur$( ofstream &, const char [] );
49bool getNL$( ofstream & );
50void setNL$( ofstream &, bool );
51bool getANL$( ofstream & );
52bool getPrt$( ofstream & );
53void setPrt$( ofstream &, bool );
54
55// public
56void sepOn( ofstream & );
57void sepOff( ofstream & );
58bool sepDisable( ofstream & );
59bool sepEnable( ofstream & );
60void nlOn( ofstream & );
61void nlOff( ofstream & );
62
63const char * sepGet( ofstream & );
64void sepSet( ofstream &, const char [] );
65const char * sepGetTuple( ofstream & );
66void sepSetTuple( ofstream &, const char [] );
67
68void ends( ofstream & );
69int fmt( ofstream &, const char format[], ... ) __attribute__(( format(printf, 2, 3) ));
70
71bool fail( ofstream & );
72void clear( ofstream & );
73int flush( ofstream & );
74void open( ofstream &, const char name[], const char mode[] ); // FIX ME: use default = "w"
75void open( ofstream &, const char name[] );
76void close( ofstream & );
77ofstream & write( ofstream &, const char data[], size_t size );
78
79void acquire( ofstream & );
80void release( ofstream & );
81
82void lock( ofstream & );
83void unlock( ofstream & );
84
85struct osacquire {
86        ofstream & os;
87};
88void ?{}( osacquire & acq, ofstream & );
89void ^?{}( osacquire & acq );
90
91void ?{}( ofstream & );
92void ?{}( ofstream &, const char name[], const char mode[] ); // FIX ME: use default = "w"
93void ?{}( ofstream &, const char name[] );
94void ^?{}( ofstream & );
95
96// private
97static inline ofstream & nl$( ofstream & os ) { return nl( os ); } // remember basic_ostream nl
98// public
99ofstream & nl( ofstream & os );                                                 // override basic_ostream nl
100
101extern ofstream & sout, & stdout, & serr, & stderr;             // aliases
102extern ofstream & exit, & abort;
103
104
105// *********************************** ifstream ***********************************
106
107
108struct ifstream {
109        void * file$;
110        bool nlOnOff$;
111        multiple_acquisition_lock lock$;
112        bool acquired$;
113}; // ifstream
114
115// Satisfies istream
116
117// public
118void nlOn( ifstream & );
119void nlOff( ifstream & );
120bool getANL( ifstream & );
121void ends( ifstream & );
122int fmt( ifstream &, const char format[], ... ) __attribute__(( format(scanf, 2, 3) ));
123
124bool fail( ifstream & is );
125void clear( ifstream & );
126bool eof( ifstream & is );
127void open( ifstream & is, const char name[], const char mode[] ); // FIX ME: use default = "r"
128void open( ifstream & is, const char name[] );
129void close( ifstream & is );
130ifstream & read( ifstream & is, char data[], size_t size );
131ifstream & ungetc( ifstream & is, char c );
132
133void acquire( ifstream & is );
134void release( ifstream & is );
135
136struct isacquire {
137        ifstream & is;
138};
139void ?{}( isacquire & acq, ifstream & is );
140void ^?{}( isacquire & acq );
141
142void ?{}( ifstream & is );
143void ?{}( ifstream & is, const char name[], const char mode[] ); // FIX ME: use default = "r"
144void ?{}( ifstream & is, const char name[] );
145void ^?{}( ifstream & is );
146
147extern ifstream & sin, & stdin;                                                 // aliases
148
149
150// *********************************** exceptions ***********************************
151
152
153exception Open_Failure {
154        union {
155                ofstream * ostream;
156                ifstream * istream;
157        };
158        // TEMPORARY: need polymorphic exceptions
159        int tag;                                                                                        // 1 => ostream; 0 => istream
160};
161
162void ?{}( Open_Failure & this, ofstream & );
163void ?{}( Open_Failure & this, ifstream & );
164
165exception Close_Failure {
166        union {
167                ofstream * ostream;
168                ifstream * istream;
169        };
170        // TEMPORARY: need polymorphic exceptions
171        int tag;                                                                                        // 1 => ostream; 0 => istream
172};
173
174void ?{}( Close_Failure & this, ofstream & );
175void ?{}( Close_Failure & this, ifstream & );
176
177exception Write_Failure {
178        union {
179                ofstream * ostream;
180                ifstream * istream;
181        };
182        // TEMPORARY: need polymorphic exceptions
183        int tag;                                                                                        // 1 => ostream; 0 => istream
184};
185
186void ?{}( Write_Failure & this, ofstream & );
187void ?{}( Write_Failure & this, ifstream & );
188
189exception Read_Failure {
190        union {
191                ofstream * ostream;
192                ifstream * istream;
193        };
194        // TEMPORARY: need polymorphic exceptions
195        int tag;                                                                                        // 1 => ostream; 0 => istream
196};
197
198void ?{}( Read_Failure & this, ofstream & );
199void ?{}( Read_Failure & this, ifstream & );
200
201// Local Variables: //
202// mode: c //
203// tab-width: 4 //
204// End: //
Note: See TracBrowser for help on using the repository browser.