home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / programm / language / gcc222.lha / g++-include / streambuf.h < prev    next >
C/C++ Source or Header  |  1992-07-19  |  16KB  |  443 lines
  1. //    This is part of the iostream library, providing -*- C++ -*- input/output.
  2. //    Copyright (C) 1991 Per Bothner.
  3. //
  4. //    This library is free software; you can redistribute it and/or
  5. //    modify it under the terms of the GNU Library General Public
  6. //    License as published by the Free Software Foundation; either
  7. //    version 2 of the License, or (at your option) any later version.
  8. //
  9. //    This library is distributed in the hope that it will be useful,
  10. //    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. //    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12. //    Library General Public License for more details.
  13. //
  14. //    You should have received a copy of the GNU Library General Public
  15.  
  16.  
  17. #ifndef _STREAMBUF_H
  18. #define _STREAMBUF_H
  19. #ifdef __GNUG__
  20. #pragma interface
  21. #endif
  22.  
  23. #include <_G_config.h>
  24. #ifdef _G_NEED_STDARG_H
  25. #include <stdarg.h>
  26. #endif
  27. #ifndef fpos_t
  28. #define fpos_t _G_fpos_t
  29. #endif
  30.  
  31. #ifndef EOF
  32. #define EOF (-1)
  33. #endif
  34. #ifndef NULL
  35. #define NULL ((void*)0)
  36. #endif
  37.  
  38. class ostream; class streambuf; class backupbuf;
  39.  
  40. #ifdef _G_FRIEND_BUG
  41. extern int __UNDERFLOW(streambuf*);
  42. extern int __OVERFLOW(streambuf*, int);
  43. #endif
  44. extern "C" int __underflow(streambuf*);
  45. extern "C" int __overflow(streambuf*, int);
  46.  
  47. typedef _G_off_t streamoff;
  48. typedef _G_off_t streampos; // Should perhaps be _G_fpos_t ?
  49.  
  50. typedef unsigned long __fmtflags;
  51. typedef unsigned char __iostate;
  52.  
  53. struct _ios_fields { // The data members of an ios.
  54.     streambuf *_strbuf;
  55.     ostream* _tie;
  56.     int _width;
  57.     __fmtflags _flags;
  58.     char _fill;
  59.     __iostate _state;
  60.     unsigned short _precision;
  61. };
  62.  
  63. #define _IOS_GOOD    0
  64. #define _IOS_EOF    1
  65. #define _IOS_FAIL    2
  66. #define _IOS_BAD    4
  67.  
  68. #define _IOS_INPUT    1
  69. #define _IOS_OUTPUT    2
  70. #define _IOS_ATEND    4
  71. #define _IOS_APPEND    8
  72. #define _IOS_TRUNC    16
  73. #define _IOS_NOCREATE    32
  74. #define _IOS_NOREPLACE    64
  75.  
  76. #ifdef _STREAM_COMPAT
  77. enum state_value {
  78.     _good = _IOS_GOOD,
  79.     _eof = _IOS_EOF,
  80.     _fail = _IOS_FAIL,
  81.     _bad = _IOS_BAD };
  82. enum open_mode {
  83.     input = _IOS_INPUT,
  84.     output = _IOS_OUTPUT,
  85.     atend = _IOS_ATEND,
  86.     append = _IOS_APPEND };
  87. #endif
  88.  
  89. class ios : public _ios_fields {
  90.   public:
  91.     typedef __fmtflags fmtflags;
  92.     typedef __iostate iostate;
  93.     enum io_state {
  94.     goodbit = _IOS_GOOD,
  95.     eofbit = _IOS_EOF,
  96.     failbit = _IOS_FAIL,
  97.     badbit = _IOS_BAD };
  98.     enum open_mode {
  99.     in = _IOS_INPUT,
  100.     out = _IOS_OUTPUT,
  101.     ate = _IOS_ATEND,
  102.     app = _IOS_APPEND,
  103.     trunc = _IOS_TRUNC,
  104.     nocreate = _IOS_NOCREATE,
  105.     noreplace = _IOS_NOREPLACE };
  106.     enum seek_dir { beg, cur, end};
  107.     enum { skipws=01, left=02, right=04, internal=010,
  108.        dec=020, oct=040, hex=0100,
  109.        showbase=0200, showpoint=0400, uppercase=01000, showpos=02000,
  110.        scientific=04000, fixed=0100000, unitbuf=020000, stdio=040000,
  111.        dont_close=0x80000000 //Don't delete streambuf on stream destruction
  112.        };
  113.  
  114.     ostream* tie() const { return _tie; }
  115.     ostream* tie(ostream* val) { ostream* save=_tie; _tie=val; return save; }
  116.  
  117.     // Methods to change the format state.
  118.     char fill() const { return _fill; }
  119.     char fill(char newf) { char oldf = _fill; _fill = newf; return oldf; }
  120.     fmtflags flags() const { return _flags; }
  121.     fmtflags flags(fmtflags new_val) {
  122.     fmtflags old_val = _flags; _flags = new_val; return old_val; }
  123.     int precision() const { return _precision; }
  124.     int precision(int newp) {
  125.     unsigned short oldp = _precision; _precision = (unsigned short)newp;
  126.     return oldp; }
  127.     fmtflags setf(fmtflags val) {
  128.     fmtflags oldbits = _flags;
  129.     _flags |= val; return oldbits; }
  130.     fmtflags setf(fmtflags val, fmtflags mask) {
  131.     fmtflags oldbits = _flags;
  132.     _flags = (_flags & ~mask) | (val & mask); return oldbits; }
  133.     fmtflags unsetf(fmtflags mask) {
  134.     fmtflags oldbits = _flags & mask;
  135.     _flags &= ~mask; return oldbits; }
  136.     int width() const { return _width; }
  137.     int width(int val) { int save = _width; _width = val; return save; }
  138.  
  139.     static const unsigned long basefield;
  140.     static const unsigned long adjustfield;
  141.     static const unsigned long floatfield;
  142.  
  143.     streambuf* rdbuf() const { return _strbuf; }
  144.     void clear(iostate state = 0) { _state = state; }
  145.     void set(iostate flag) { _state |= flag; } // In ANSI but not AT&T.
  146.     int good() const { return _state == 0; }
  147.     int eof() const { return _state & ios::eofbit; }
  148.     int fail() const { return _state & (ios::badbit|ios::failbit); }
  149.     int bad() const { return _state & ios::badbit; }
  150.     int rdstate() const { return _state; }
  151.     operator void*() const { return fail() ? (void*)0 : (void*)(-1); }
  152.     int operator!() const { return fail(); }
  153.  
  154. #ifdef _STREAM_COMPAT
  155.     void unset(state_value flag) { _state &= ~flag; }
  156.     void close();
  157.     int is_open();
  158.     int readable();
  159.     int writable();
  160. #endif
  161.  
  162.   protected:
  163.     ios(streambuf* sb = 0, ostream* tie = 0);
  164.     ~ios();
  165. };
  166.  
  167. #if __GNUG__==1
  168. typedef int _seek_dir;
  169. #else
  170. typedef ios::seek_dir _seek_dir;
  171. #endif
  172.  
  173. // Magic numbers and bits for the _flags field.
  174. // The magic numbers use the high-order bits of _flags;
  175. // the remaining bits are abailable for variable flags.
  176. // Note: The magic numbers must all be negative if stdio
  177. // emulation is desired.
  178.  
  179. #define _IO_MAGIC 0xFBAD0000 /* Magic number */
  180. #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
  181. #define _IO_MAGIC_MASK 0xFFFF0000
  182. #define _S_USER_BUF 1 /* User owns buffer; don't delete it on close. */
  183. #define _S_UNBUFFERED 2
  184. #define _S_NO_READS 4 /* Reading not allowed */
  185. #define _S_NO_WRITES 8 /* Writing not allowd */
  186. #define _S_EOF_SEEN 0x10
  187. #define _S_ERR_SEEN 0x20
  188. #define _S_DELETE_DONT_CLOSE 0x40
  189. #define _S_LINKED 0x80 // Set if linked (using _chain) to streambuf::_list_all.
  190. #define _S_IN_BACKUP 0x100
  191. #define _S_LINE_BUF 0x200
  192. #define _S_TIED_PUT_GET 0x400 // Set if put and get pointer logicly tied.
  193. #define _S_CURRENTLY_PUTTING 0x800
  194. #define _S_IS_BACKUPBUF 0x4000
  195. #define _S_IS_FILEBUF 0x8000
  196.  
  197. // A streammarker remembers a position in a buffer.
  198. // You are guaranteed to be able to seek back to it if it is saving().
  199. class streammarker {
  200.     friend class streambuf;
  201. #ifdef _G_FRIEND_BUG
  202.     friend int __UNDERFLOW(streambuf*);
  203. #else
  204.     friend int __underflow(streambuf*);
  205. #endif
  206.     struct streammarker *_next;  // Only if saving()
  207.     streambuf *_sbuf; // Only valid if saving().
  208.     streampos _spos; // -2: means that _pos is valid.
  209.     void set_streampos(streampos sp) { _spos = sp; }
  210.     void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
  211.     // If _pos >= 0, it points to _buf->Gbase()+_pos.
  212.     // if _pos < 0, it points to _buf->eBptr()+_pos.
  213.     int _pos;
  214.   public:
  215.     streammarker(streambuf *sb);
  216.     ~streammarker();
  217.     int saving() { return  _spos == -2; }
  218.     int delta(streammarker&);
  219.     int delta();
  220. };
  221.  
  222. struct __streambuf {
  223.     // NOTE: If this is changed, also change __FILE in stdio/stdio.h!
  224.     int _flags;        /* High-order word is _IO_MAGIC; rest is flags. */
  225.     char* _gptr;    /* Current get pointer */
  226.     char* _egptr;    /* End of get area. */
  227.     char* _eback;    /* Start of putback+get area. */
  228.     char* _pbase;    /* Start of put area. */
  229.     char* _pptr;    /* Current put pointer. */
  230.     char* _epptr;    /* End of put area. */
  231.     char* _base;    /* Start of reserve area. */
  232.     char* _ebuf;    /* End of reserve area. */
  233.     struct streambuf *_chain;
  234.  
  235.     // The following fields are used to support backing up and undo.
  236.     friend class streammarker;
  237.     char *_other_gbase; // Pointer to start of non-current get area.
  238.     char *_aux_limit;  // Pointer to first valid character of backup area,
  239.     char *_other_egptr; // Pointer to end of non-current get area.
  240.     streammarker *_markers;
  241.  
  242. #define __HAVE_COLUMN /* temporary */
  243.     // 1+column number of pbase(); 0 is unknown.
  244.     unsigned short _cur_column;
  245.     char _unused;
  246.     char _shortbuf[1];
  247. };
  248.  
  249. extern unsigned __adjust_column(unsigned start, const char *line, int count);
  250.  
  251. struct streambuf : private __streambuf {
  252.     friend class ios;
  253.     friend class istream;
  254.     friend class ostream;
  255.     friend class streammarker;
  256. #ifdef _G_FRIEND_BUG
  257.     friend int __UNDERFLOW(streambuf*);
  258. #else
  259.     friend int __underflow(streambuf*);
  260. #endif
  261.   protected:
  262.     static streambuf* _list_all; /* List of open streambufs. */
  263.     streambuf*& xchain() { return _chain; }
  264.     void _un_link();
  265.     void _link_in();
  266.     char* gptr() const { return _gptr; }
  267.     char* pptr() const { return _pptr; }
  268.     char* egptr() const { return _egptr; }
  269.     char* epptr() const { return _epptr; }
  270.     char* pbase() const { return _pbase; }
  271.     char* eback() const { return _eback; }
  272.     char* ebuf() const { return _ebuf; }
  273.     char* base() const { return _base; }
  274.     void xput_char(char c) { *_pptr++ = c; }
  275.     int xflags() { return _flags; }
  276.     int xflags(int f) { int fl = _flags; _flags = f; return fl; }
  277.     void xsetflags(int f) { _flags |= f; }
  278.     void xsetflags(int f, int mask) { _flags = (_flags & ~mask) | (f & mask); }
  279.     void gbump(int n) { _gptr += n; }
  280.     void pbump(int n) { _pptr += n; }
  281.     void setb(char* b, char* eb, int a=0);
  282.     void setp(char* p, char* ep) { _pbase=_pptr=p; _epptr=ep; }
  283.     void setg(char* eb, char* g, char *eg) { _eback=eb; _gptr=g; _egptr=eg; }
  284.     char *shortbuf() { return _shortbuf; }
  285.  
  286.     int in_backup() { return _flags & _S_IN_BACKUP; }
  287.     // The start of the main get area:  FIXME:  wrong for write-mode filebuf?
  288.     char *Gbase() { return in_backup() ? _other_gbase : _eback; }
  289.     // The end of the main get area:
  290.     char *eGptr() { return in_backup() ? _other_egptr : _egptr; }
  291.     // The start of the backup area:
  292.     char *Bbase() { return in_backup() ? _eback : _other_gbase; }
  293.     char *Bptr() { return _aux_limit; }
  294.     // The end of the backup area:
  295.     char *eBptr() { return in_backup() ? _egptr : _other_egptr; }
  296.     char *Nbase() { return _other_gbase; }
  297.     char *eNptr() { return _other_egptr; }
  298.     int have_backup() { return _other_gbase != NULL; }
  299.     int have_markers() { return _markers != NULL; }
  300.     int _least_marker();
  301.     void switch_to_main_get_area();
  302.     void switch_to_backup_area();
  303.     void free_backup_area();
  304.     void unsave_markers(); // Make all streammarkers !saving().
  305.     int put_mode() { return _flags & _S_CURRENTLY_PUTTING; }
  306.     int switch_to_get_mode();
  307.     
  308.     streambuf(int flags=0);
  309.   public:
  310.     static int flush_all();
  311.     static void flush_all_linebuffered(); // Flush all line buffered files.
  312.     virtual int underflow() = 0; // Leave public for now
  313.     virtual int overflow(int c = EOF) = 0; // Leave public for now
  314.     virtual int doallocate();
  315.     virtual streampos seekoff(streamoff, _seek_dir, int mode=ios::in|ios::out);
  316.     virtual streampos seekpos(streampos pos, int mode = ios::in|ios::out);
  317.     int seekmark(streammarker& mark, int delta = 0);
  318.     int sputbackc(char c);
  319.     int sungetc();
  320.     virtual ~streambuf();
  321.     int unbuffered() { return _flags & _S_UNBUFFERED ? 1 : 0; }
  322.     int linebuffered() { return _flags & _S_LINE_BUF ? 1 : 0; }
  323.     void unbuffered(int i)
  324.     { if (i) _flags |= _S_UNBUFFERED; else _flags &= ~_S_UNBUFFERED; }
  325.     void linebuffered(int i)
  326.     { if (i) _flags |= _S_LINE_BUF; else _flags &= ~_S_LINE_BUF; }
  327.     int allocate() { // For AT&T compatibility
  328.     if (base() || unbuffered()) return 0;
  329.     else return doallocate(); }
  330.     // Allocate a buffer if needed; use _shortbuf if appropriate.
  331.     void allocbuf() { if (base() == NULL) doallocbuf(); }
  332.     void doallocbuf();
  333.     virtual int sync();
  334.     virtual int pbackfail(int c);
  335.     virtual int ungetfail();
  336.     virtual streambuf* setbuf(char* p, int len);
  337.     int in_avail() { return _egptr - _gptr; }
  338.     int out_waiting() { return _pptr - _pbase; }
  339.     virtual int sputn(const char* s, int n);
  340.     int padn(char pad, int n); // Emit 'n' copies of 'pad'.
  341.     virtual int sgetn(char* s, int n);
  342.     int ignore(int);
  343.     virtual int get_column();
  344.     virtual int set_column(int);
  345.     long sgetline(char* buf, _G_size_t n, char delim, int putback_delim);
  346.     int sbumpc() {
  347.     if (_gptr >= _egptr && __underflow(this) == EOF) return EOF;
  348.     else return *(unsigned char*)_gptr++; }
  349.     int sgetc() {
  350.     if (_gptr >= _egptr && __underflow(this) == EOF) return EOF;
  351.     else return *(unsigned char*)_gptr; }
  352.     int snextc() {
  353.     if (++_gptr >= _egptr && __underflow(this) == EOF) return EOF;
  354.     else return *(unsigned char*)_gptr; }
  355.     int sputc(int c) {
  356.     if (_pptr >= _epptr) return __overflow(this, (unsigned char)c);
  357.     return *_pptr++ = c, (unsigned char)c; }
  358.     void stossc() { if (_gptr < _egptr) _gptr++; }
  359.     int vscan(char const *fmt0, _G_va_list ap, ios::iostate* = NULL);
  360.     int vform(char const *fmt0, _G_va_list ap);
  361. #if 0 /* Work in progress */
  362.     int collumn();  // Current collumn number (of put pointer). -1 is unknown.
  363.     void collumn(int c);  // Set collumn number of put pointer to c.
  364. #endif
  365. };
  366.  
  367. // A backupbuf is a streambuf with full backup and savepoints on reading.
  368. // All standard streambufs in the GNU iostream library are backupbufs.
  369.  
  370. // A backupbuf may have two get area:
  371. // - The main get area, and (sometimes) the putback area.
  372. // Whichever one of these contains the gptr is the current get area;
  373. // the other one is the non-current get area.
  374.  
  375. class backupbuf : public streambuf {
  376.     friend class streammarker;
  377.   protected:
  378.     backupbuf(int flags=0) : streambuf(flags|_S_IS_BACKUPBUF) { }
  379.   public:
  380.     virtual int pbackfail(int c);
  381.     virtual int underflow();
  382.     virtual int overflow(int c = EOF);
  383. };
  384.  
  385. struct __file_fields {
  386.     short _fileno;
  387.     int _blksize;
  388.     fpos_t _offset;
  389. //    char* _save_gptr;  char* _save_egptr;
  390. };
  391.  
  392. class filebuf : public backupbuf {
  393.   protected:
  394.     struct __file_fields _fb;
  395.     void init();
  396.   public:
  397.     filebuf();
  398.     filebuf(int fd);
  399.     filebuf(int fd, char* p, int len);
  400.     ~filebuf();
  401.     filebuf* attach(int fd);
  402.     filebuf* open(const char *filename, const char *mode);
  403.     filebuf* open(const char *filename, int mode, int prot = 0664);
  404.     virtual int underflow();
  405.     virtual int overflow(int c = EOF);
  406.     int is_open() { return _fb._fileno >= 0; }
  407.     int fd() { return is_open() ? _fb._fileno : EOF; }
  408.     filebuf* close();
  409.     virtual int doallocate();
  410.     virtual streampos seekoff(streamoff, _seek_dir, int mode=ios::in|ios::out);
  411.     int sputn(const char* s, int n);
  412.     int sgetn(char* s, int n);
  413.     virtual int sync();
  414.   protected: // See documentation in filebuf.C.
  415. //    virtual int pbackfail(int c);
  416.     int is_reading() { return eback() != egptr(); }
  417.     char* cur_ptr() { return is_reading() ?  gptr() : pptr(); }
  418.     /* System's idea of pointer */
  419.     char* file_ptr() { return eGptr(); }
  420.     int do_write(const char *data, int to_do);
  421.     int do_flush() { return do_write(_pbase, _pptr-_pbase); }
  422.     // Low-level operations (Usually invoke system calls.)
  423.     virtual _G_ssize_t sys_read(char* buf, _G_size_t size);
  424.     virtual fpos_t sys_seek(fpos_t, _seek_dir);
  425.     virtual _G_ssize_t sys_write(const void*, long);
  426.     virtual int sys_stat(void*); // Actually, a (struct stat*)
  427.     virtual int sys_close();
  428. };
  429.  
  430. #ifdef _STREAM_COMPAT
  431. inline int ios::readable() { return !(rdbuf()->_flags & _S_NO_READS); }
  432. inline int ios::writable() { return !(rdbuf()->_flags & _S_NO_WRITES); }
  433. inline int ios::is_open() { return (rdbuf()->_flags & _S_NO_READS+_S_NO_WRITES)
  434.                 != _S_NO_READS+_S_NO_WRITES; }
  435. #endif
  436. inline ios::ios(streambuf* sb /* = 0 */, ostream* tie /* = 0 */) {
  437.         _tie = tie; _strbuf=sb; _state=0; _width=0; _fill=' ';
  438.         _flags=ios::skipws; _precision=6; }
  439. inline ios::~ios() {
  440.     if (!(_flags & (unsigned int)ios::dont_close)) delete _strbuf; }
  441.  
  442. #endif /* _STREAMBUF_H */
  443.