soma-io  4.5.0
filedatasource.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_FILEDATASOURCE_H
35 #define SOMAIO_DATASOURCE_FILEDATASOURCE_H
36 
37 #ifndef _WIN32
38  #define CARTO_FILEDS_AS_FD
39 #endif
40 //--- soma-io ----------------------------------------------------------------
42 #ifdef CARTO_FILEDS_AS_FD
43  #include <soma-io/datasource/fddatasource.h> // base class
44 #else
45  #include <soma-io/datasource/cstreamdatasource.h> // base class
46 #endif
47 //--- system -----------------------------------------------------------------
48 #include <string>
49 //----------------------------------------------------------------------------
50 
51 namespace soma
52 {
53 
54  class FileDataSource :
55  #ifdef CARTO_FILEDS_AS_FD
56  public FDDataSource
57  #else
58  public CStreamDataSource
59  #endif
60  {
61  public:
62  FileDataSource( const std::string & filename, offset_t offset = 0,
63  int mode = Read );
64  virtual ~FileDataSource();
65  virtual std::string url() const;
66  offset_t initialOffset() const;
67 
68  virtual DataSource* clone() const;
69  virtual bool open( int mode );
70  virtual bool allowsMemoryMapping() const;
71  virtual offset_t size() const;
72  virtual offset_t at() const;
73  virtual bool at( offset_t pos );
74 
75  private:
76  std::string _url;
77  offset_t _offset;
78  };
79 
80 }
81 
82 #endif
C stream data source: base class for all sources based on a FILE* (stdio streams) ...
File Descriptor data source: base class for all sources based on a file descriptor.
Definition: fddatasource.h:46
virtual bool open(int mode)
useless for a file descriptor: a fd is already open
virtual bool allowsMemoryMapping() const
in the general case, memory mapping is not possible
FileDataSource(const std::string &filename, offset_t offset=0, int mode=Read)
virtual DataSource * clone() const
Abstraction layer for various data sources (file, buffer, socket...).
Definition: datasource.h:64
virtual offset_t at() const
int mode() const
access mode(s) (read/write): bitwise OR of Mode values
#define soma
Definition: soma_config.h:38
unsigned long long offset_t
Offsets are 64 bits if supported.
Definition: datasource.h:51
virtual std::string url() const
virtual ~FileDataSource()
offset_t initialOffset() const
virtual offset_t size() const