Make certain functions pure virtual so I won't forget to implement them
[libs/core.git] / source / io / slice.h
1 #ifndef MSP_IO_SLICE_H_
2 #define MSP_IO_SLICE_H_
3
4 #include "seekable.h"
5
6 namespace Msp {
7 namespace IO {
8
9 /**
10 Presents a part of seekable I/O object as if it was a complete object.  This
11 allows in-place access to embedded resources where the loader expects to
12 receive a complete file.
13
14 When a Slice is created, its read/write offset is placed at the beginning of
15 its range.  If the offset of the underlying object is changed, the Slice will
16 restore it before the next access.  This enables multiple Slices to be created
17 on top of the same object.
18 */
19 class Slice: public Seekable, public sigc::trackable
20 {
21 private:
22         Seekable &below;
23         SeekOffset start_offset;
24         SeekOffset length;
25         SeekOffset position;
26         bool sync_position;
27
28 public:
29         Slice(Seekable &, SeekOffset, SeekOffset);
30
31         virtual void set_block(bool);
32
33 private:
34         void flush();
35
36         unsigned prepare_op(unsigned, Mode);
37 protected:
38         virtual unsigned do_write(const char *, unsigned);
39         virtual unsigned do_read(char *, unsigned);
40
41 public:
42         virtual unsigned put(char);
43         virtual int get();
44
45         virtual const Handle &get_handle(Mode);
46
47         virtual SeekOffset seek(SeekOffset, SeekType);
48         virtual SeekOffset tell() const { return position; }
49 };
50
51 } // namespace IO
52 } // namespace Msp
53
54 #endif