/*
-Copyright (C) 2001-2006, William Joseph.
-All Rights Reserved.
+ Copyright (c) 2001, Loki software, inc.
+ modifications (c) 2001, Id software, inc.
+ All rights reserved.
-This file is part of GtkRadiant.
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
-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.
+ Redistributions of source code must retain the above copyright notice, this list
+ of conditions and the following disclaimer.
-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.
+ Redistributions in binary form must reproduce the above copyright notice, this
+ list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
-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
-*/
+ Neither the name of Loki software nor the names of its contributors may be used
+ to endorse or promote products derived from this software without specific prior
+ written permission.
-#if !defined(INCLUDED_IDATASTREAM_H)
-#define INCLUDED_IDATASTREAM_H
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
-#include <cstddef>
+#ifndef _ISTREAM_H_
+#define _ISTREAM_H_
-class StreamBase
-{
-public:
- typedef std::size_t size_type;
- typedef unsigned char byte_type;
-};
+/*!
+ API for data streams
-/// \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;
-};
+ Based on an initial implementation by Loki software
+ modified to be abstracted and shared across modules
-/// \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;
-};
+ NOTE: why IDataStream and not IStream? because IStream is defined in windows IDL headers
+ */
-class SeekableStream
+class IDataStream
{
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;
-};
+IDataStream();
+virtual ~IDataStream();
-/// \brief A seekable read-only byte-stream.
-class SeekableInputStream : public InputStream, public SeekableStream
-{
-};
+virtual void IncRef() = 0; ///< Increment the number of references to this object
+virtual void DecRef() = 0; ///< Decrement the reference count
-/// \brief A seekable write-only byte-stream.
-class SeekableOutputStream : public OutputStream, public SeekableStream
-{
+virtual unsigned long GetPosition() const = 0;
+virtual unsigned long Seek( long lOff, int nFrom ) = 0;
+virtual void SetLength( unsigned long nNewLen ) = 0;
+virtual unsigned long GetLength() const = 0;
+
+virtual char* ReadString( char* pBuf, unsigned long nMax ) = 0;
+virtual unsigned long Read( void* pBuf, unsigned long nCount ) = 0;
+virtual unsigned long Write( const void* pBuf, unsigned long nCount ) = 0;
+virtual int GetChar() = 0;
+virtual int PutChar( int c ) = 0;
+
+virtual void printf( const char*, ... ) = 0; ///< completely matches the usual printf behaviour
+
+virtual void Abort() = 0;
+virtual void Flush() = 0;
+virtual void Close() = 0;
};
-#endif
+#endif // _ISTREAM_H_
projects / xonotic / netradiant.git / blobdiff