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);
57 File(const std::string &filename = std::string(),
58 File::Mode mode = File::Read);
61 bool isOpened() const;
62 File::Mode mode() const;
64 bool open(const std::string &filename, File::Mode mode);
65 bool write(const void *buffer, size_t length);
66 bool read(void *buffer, size_t length);
70 bool skip(size_t length);
73 virtual bool supportsOffsets() const = 0;
74 virtual File::Offset currentOffset() = 0;
75 virtual void setCurrentOffset(const File::Offset &offset);
77 virtual bool rawOpen(const std::string &filename, File::Mode mode) = 0;
78 virtual bool rawWrite(const void *buffer, size_t length) = 0;
79 virtual bool rawRead(void *buffer, size_t length) = 0;
80 virtual int rawGetc() = 0;
81 virtual void rawClose() = 0;
82 virtual void rawFlush() = 0;
83 virtual bool rawSkip(size_t length) = 0;
84 virtual int rawPercentRead() = 0;
91 inline bool File::isOpened() const
96 inline File::Mode File::mode() const
101 inline bool File::open(const std::string &filename, File::Mode mode)
106 m_isOpened = rawOpen(filename, mode);
112 inline bool File::write(const void *buffer, size_t length)
114 if (!m_isOpened || m_mode != File::Write) {
117 return rawWrite(buffer, length);
120 inline bool File::read(void *buffer, size_t length)
122 if (!m_isOpened || m_mode != File::Read) {
125 return rawRead(buffer, length);
128 inline int File::percentRead()
130 if (!m_isOpened || m_mode != File::Read) {
133 return rawPercentRead();
136 inline void File::close()
144 inline void File::flush(void)
146 if (m_mode == File::Write) {
151 inline int File::getc()
153 if (!m_isOpened || m_mode != File::Read) {
159 inline bool File::skip(size_t length)
161 if (!m_isOpened || m_mode != File::Read) {
164 return rawSkip(length);
169 operator<(const File::Offset &one, const File::Offset &two)
171 return one.chunk < two.chunk ||
172 (one.chunk == two.chunk && one.offsetInChunk < two.offsetInChunk);
176 operator==(const File::Offset &one, const File::Offset &two)
178 return one.chunk == two.chunk &&
179 one.offsetInChunk == two.offsetInChunk;
183 operator>=(const File::Offset &one, const File::Offset &two)
185 return one.chunk > two.chunk ||
186 (one.chunk == two.chunk && one.offsetInChunk >= two.offsetInChunk);
190 operator>(const File::Offset &one, const File::Offset &two)
196 operator<=(const File::Offset &one, const File::Offset &two)