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
42 static bool isZLibCompressed(const std::string &filename);
43 static bool isSnappyCompressed(const std::string &filename);
45 File(const std::string &filename = std::string(),
46 File::Mode mode = File::Read);
49 bool isOpened() const;
50 File::Mode mode() const;
52 bool open(const std::string &filename, File::Mode mode);
53 bool write(const void *buffer, size_t length);
54 bool read(void *buffer, size_t length);
60 virtual bool rawOpen(const std::string &filename, File::Mode mode) = 0;
61 virtual bool rawWrite(const void *buffer, size_t length) = 0;
62 virtual bool rawRead(void *buffer, size_t length) = 0;
63 virtual int rawGetc() = 0;
64 virtual void rawClose() = 0;
65 virtual void rawFlush() = 0;
72 inline bool File::isOpened() const
77 inline File::Mode File::mode() const
82 inline bool File::open(const std::string &filename, File::Mode mode)
87 m_isOpened = rawOpen(filename, mode);
93 inline bool File::write(const void *buffer, size_t length)
95 if (!m_isOpened || m_mode != File::Write) {
98 return rawWrite(buffer, length);
101 inline bool File::read(void *buffer, size_t length)
103 if (!m_isOpened || m_mode != File::Read) {
106 return rawRead(buffer, length);
109 inline void File::close()
117 inline void File::flush(void)
119 if (m_mode == File::Write) {
124 inline int File::getc()
126 if (!m_isOpened || m_mode != File::Read) {
132 class ZLibFile : public File {
134 ZLibFile(const std::string &filename = std::string(),
135 File::Mode mode = File::Read);
139 virtual bool rawOpen(const std::string &filename, File::Mode mode);
140 virtual bool rawWrite(const void *buffer, size_t length);
141 virtual bool rawRead(void *buffer, size_t length);
142 virtual int rawGetc();
143 virtual void rawClose();
144 virtual void rawFlush();