1 /**************************************************************************
3 * Copyright 2011 Zack Rusin
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 **************************************************************************/
27 #ifndef TRACE_FILE_HPP
28 #define TRACE_FILE_HPP
43 Offset(uint64_t _chunk = 0, uint32_t _offsetInChunk = 0)
45 offsetInChunk(_offsetInChunk)
48 uint32_t offsetInChunk;
52 static bool isZLibCompressed(const std::string &filename);
53 static bool isSnappyCompressed(const std::string &filename);
54 static File *createZLib(void);
55 static File *createSnappy(void);
56 static File *createForRead(const char *filename);
57 static File *createForWrite(const char *filename);
59 File(const std::string &filename = std::string(),
60 File::Mode mode = File::Read);
63 bool isOpened() const;
64 File::Mode mode() const;
66 bool open(const std::string &filename, File::Mode mode);
67 bool write(const void *buffer, size_t length);
68 size_t read(void *buffer, size_t length);
72 bool skip(size_t length);
75 virtual bool supportsOffsets() const = 0;
76 virtual File::Offset currentOffset() = 0;
77 virtual void setCurrentOffset(const File::Offset &offset);
79 virtual bool rawOpen(const std::string &filename, File::Mode mode) = 0;
80 virtual bool rawWrite(const void *buffer, size_t length) = 0;
81 virtual size_t rawRead(void *buffer, size_t length) = 0;
82 virtual int rawGetc() = 0;
83 virtual void rawClose() = 0;
84 virtual void rawFlush() = 0;
85 virtual bool rawSkip(size_t length) = 0;
86 virtual int rawPercentRead() = 0;
93 inline bool File::isOpened() const
98 inline File::Mode File::mode() const
103 inline bool File::open(const std::string &filename, File::Mode mode)
108 m_isOpened = rawOpen(filename, mode);
114 inline bool File::write(const void *buffer, size_t length)
116 if (!m_isOpened || m_mode != File::Write) {
119 return rawWrite(buffer, length);
122 inline size_t File::read(void *buffer, size_t length)
124 if (!m_isOpened || m_mode != File::Read) {
127 return rawRead(buffer, length);
130 inline int File::percentRead()
132 if (!m_isOpened || m_mode != File::Read) {
135 return rawPercentRead();
138 inline void File::close()
146 inline void File::flush(void)
148 if (m_mode == File::Write) {
153 inline int File::getc()
155 if (!m_isOpened || m_mode != File::Read) {
161 inline bool File::skip(size_t length)
163 if (!m_isOpened || m_mode != File::Read) {
166 return rawSkip(length);
171 operator<(const File::Offset &one, const File::Offset &two)
173 return one.chunk < two.chunk ||
174 (one.chunk == two.chunk && one.offsetInChunk < two.offsetInChunk);
178 operator==(const File::Offset &one, const File::Offset &two)
180 return one.chunk == two.chunk &&
181 one.offsetInChunk == two.offsetInChunk;
185 operator>=(const File::Offset &one, const File::Offset &two)
187 return one.chunk > two.chunk ||
188 (one.chunk == two.chunk && one.offsetInChunk >= two.offsetInChunk);
192 operator>(const File::Offset &one, const File::Offset &two)
198 operator<=(const File::Offset &one, const File::Offset &two)