-/*\r
-Copyright (c) 2001, Loki software, inc.\r
-modifications (c) 2001, Id software, inc.\r
-All rights reserved.\r
-\r
-Redistribution and use in source and binary forms, with or without modification, \r
-are permitted provided that the following conditions are met:\r
-\r
-Redistributions of source code must retain the above copyright notice, this list \r
-of conditions and the following disclaimer.\r
-\r
-Redistributions in binary form must reproduce the above copyright notice, this\r
-list of conditions and the following disclaimer in the documentation and/or\r
-other materials provided with the distribution.\r
-\r
-Neither the name of Loki software nor the names of its contributors may be used \r
-to endorse or promote products derived from this software without specific prior \r
-written permission. \r
-\r
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' \r
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE \r
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE \r
-DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY \r
-DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES \r
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; \r
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \r
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \r
-*/\r
-\r
-#ifndef _ISTREAM_H_\r
-#define _ISTREAM_H_\r
-\r
-/*!\r
-API for data streams\r
-\r
-Based on an initial implementation by Loki software\r
-modified to be abstracted and shared across modules\r
-\r
-NOTE: why IDataStream and not IStream? because IStream is defined in windows IDL headers\r
-*/\r
-\r
-class IDataStream\r
-{\r
-public: \r
- IDataStream();\r
- virtual ~IDataStream();\r
-\r
- virtual void IncRef () = 0; ///< Increment the number of references to this object\r
- virtual void DecRef () = 0; ///< Decrement the reference count\r
-\r
- virtual unsigned long GetPosition() const = 0;\r
- virtual unsigned long Seek(long lOff, int nFrom) = 0;\r
- virtual void SetLength(unsigned long nNewLen) = 0;\r
- virtual unsigned long GetLength() const = 0;\r
-\r
- virtual char* ReadString(char* pBuf, unsigned long nMax)=0;\r
- virtual unsigned long Read(void* pBuf, unsigned long nCount)=0;\r
- virtual unsigned long Write(const void* pBuf, unsigned long nCount)=0;\r
- virtual int GetChar()=0;\r
- virtual int PutChar(int c)=0;\r
-\r
- virtual void printf(const char*, ...) = 0; ///< completely matches the usual printf behaviour\r
-\r
- virtual void Abort()=0;\r
- virtual void Flush()=0;\r
- virtual void Close()=0;\r
-};\r
-\r
-#endif // _ISTREAM_H_\r
+/*
+ Copyright (C) 2001-2006, William Joseph.
+ All Rights Reserved.
+
+ This file is part of GtkRadiant.
+
+ GtkRadiant is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ GtkRadiant is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with GtkRadiant; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#if !defined( INCLUDED_IDATASTREAM_H )
+#define INCLUDED_IDATASTREAM_H
+
+#include <cstddef>
+
+class StreamBase
+{
+public:
+typedef std::size_t size_type;
+typedef unsigned char byte_type;
+};
+
+/// \brief A read-only byte-stream.
+class InputStream : public StreamBase
+{
+public:
+/// \brief Attempts to read the next \p length bytes from the stream to \p buffer.
+/// Returns the number of bytes actually stored in \p buffer.
+virtual size_type read( byte_type* buffer, size_type length ) = 0;
+};
+
+/// \brief A write-only byte-stream.
+class OutputStream : public StreamBase
+{
+public:
+/// \brief Attempts to write \p length bytes to the stream from \p buffer.
+/// Returns the number of bytes actually read from \p buffer.
+virtual size_type write( const byte_type* buffer, size_type length ) = 0;
+};
+
+class SeekableStream
+{
+public:
+typedef int offset_type;
+typedef std::size_t position_type;
+
+enum seekdir
+{
+ beg,
+ cur,
+ end,
+};
+
+/// \brief Sets the current \p position of the stream relative to the start.
+virtual position_type seek( position_type position ) = 0;
+/// \brief Sets the current \p position of the stream relative to either the start, end or current position.
+virtual position_type seek( offset_type offset, seekdir direction ) = 0;
+/// \brief Returns the current position of the stream.
+virtual position_type tell() const = 0;
+};
+
+/// \brief A seekable read-only byte-stream.
+class SeekableInputStream : public InputStream, public SeekableStream
+{
+};
+
+/// \brief A seekable write-only byte-stream.
+class SeekableOutputStream : public OutputStream, public SeekableStream
+{
+};
+
+#endif
projects / xonotic / netradiant.git / blobdiff