soma-io  4.7.0
cstreamdatasource.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 #ifndef SOMAIO_DATASOURCE_CSTREAMDATASOURCE_H
35 #define SOMAIO_DATASOURCE_CSTREAMDATASOURCE_H
36 //--- soma-io ----------------------------------------------------------------
38 #include <soma-io/datasource/datasource.h> // base class
39 //--- system -----------------------------------------------------------------
40 #include <cstdio>
41 //----------------------------------------------------------------------------
42 
43 namespace soma
44 {
45 
49  {
50  public:
51  CStreamDataSource( FILE *f = 0, int mode = Read );
52  virtual ~CStreamDataSource();
53 
54  virtual DataSource* clone() const;
55  virtual int iterateMode() const;
56  virtual bool isOpen() const;
58  virtual bool open ( int mode );
59  virtual void close();
60  virtual offset_t size() const;
61  virtual offset_t at() const;
62  virtual bool at( offset_t pos );
63  virtual long readBlock( char* data, unsigned long maxlen );
64  virtual long writeBlock( const char* data, unsigned long len );
65  virtual int getch();
66  virtual int putch( int ch );
67  virtual bool ungetch( int ch );
69  virtual bool allowsMemoryMapping() const;
70 
71  FILE *filePtr() const; // should it be non-const ?
72  void setFilePtr( FILE *f );
73 
74  protected:
75  FILE *_f;
76  };
77 
78 }
79 
80 #endif
FILE * filePtr() const
C stream data source: base class for all sources based on a FILE* (stdio streams) ...
virtual long readBlock(char *data, unsigned long maxlen)
int mode() const
access mode(s) (read/write): bitwise OR of Mode values
virtual bool allowsMemoryMapping() const
in the general case, memory mapping is not possible
CStreamDataSource(FILE *f=0, int mode=Read)
virtual int iterateMode() const
possible iteration mode(s): bitwise OR of IterateMode values
Abstraction layer for various data sources (file, buffer, socket...).
Definition: datasource.h:64
Definition: allocator.h:48
virtual offset_t size() const
virtual int putch(int ch)
void setFilePtr(FILE *f)
unsigned long long offset_t
Offsets are 64 bits if supported.
Definition: datasource.h:51
virtual offset_t at() const
virtual bool isOpen() const
virtual long writeBlock(const char *data, unsigned long len)
virtual DataSource * clone() const
virtual void close()
virtual bool open(int mode)
useless for a file descriptor: a fd is already open
virtual bool ungetch(int ch)