Started work adding more functions to stream, and changing to a new size type.

1 files changed, 33 insertions, 9 deletions

diff --git a/src/stream.h b/src/stream.h
index 0ea5560..e7db7af 100644
--- a/src/stream.h
+++ b/src/stream.h
@@ -8,6 +8,8 @@
 #ifndef BU_STREAM_H
 #define BU_STREAM_H
 
+#include "bu/config.h"
+
 #include <stdint.h>
 #include <stdio.h>
 
@@ -43,7 +45,7 @@ namespace Bu
                  *@param nBytes (size_t) Max data to read.
                  *@returns (size_t) Amount of data read.
                  */
-                virtual size_t read( void *pBuf, size_t nBytes ) = 0;
+                virtual size read( void *pBuf, size iBytes ) = 0;
 
                 /**
                  * Attempts to read a complete line from the stream.  This will stop
@@ -59,33 +61,33 @@ namespace Bu
                  *@param nBytes (size_t) Amount of data to write from pBuf.
                  *@returns (size_t) Amount of data actually written.
                  */
-                virtual size_t write( const void *pBuf, size_t nBytes ) = 0;
+                virtual size write( const void *pBuf, size iBytes ) = 0;
 
-                virtual size_t write( const Bu::FString &sBuf );
+                virtual size write( const Bu::FString &sBuf );
 
                 /**
                  * Get the current position in the stream.
                  *@returns (long) The current position in the stream.
                  */
-                virtual long tell() = 0;
+                virtual size tell() = 0;
 
                 /**
                  * Seek to a position in the stream relative to the current position.
                  *@param offset (long) Offset from current position to seek to.
                  */
-                virtual void seek( long offset ) = 0;
+                virtual void seek( size offset ) = 0;
 
                 /**
                  * Set position in the stream relative to the start of the stream.
                  *@param pos (long) The position.
                  */
-                virtual void setPos( long pos ) = 0;
+                virtual void setPos( size pos ) = 0;
 
                 /**
                  * Set position in the stream relative to the end of the stream.
                  *@param pos (long) The position.
                  */
-                virtual void setPosEnd( long pos ) = 0;
+                virtual void setPosEnd( size pos ) = 0;
 
                 /**
                  * Are we at the end of the stream?
@@ -158,10 +160,32 @@ namespace Bu
                  * removed from the end of the stream, but the content of the added
                  * data is undefined.
                  */
-                virtual void setSize( long iSize ) = 0;
+                virtual void setSize( size iSize ) = 0;
+
+                /**
+                 * Returns the size of the stream if the stream can have a size.  For
+                 * streams that do not (sockets, pipes, etc.) this should throw an
+                 * unsupported exception.
+                 */
+                virtual size getSize() const = 0;
 
-        public: // Filters
+                /**
+                 * Returns the block-size of the stream, if it has one.  This should
+                 * throw an unsupported exception.  In some cases the block size
+                 * returned will not represent quite the same thing, for example,
+                 * sockets will return their MTU, while files will return the
+                 * filesystem's block size, and memory buffers will throw an exception.
+                 */
+                virtual size getBlockSize() const = 0;
 
+                /**
+                 * If possible, this returns a string that can be used to describe how
+                 * to access the open stream.  Not all streams support this, such as
+                 * MemBuf, but for files it may give you a path to a file, for a socket
+                 * it may give you an ip address, etc.  If it isn't supported, an empty
+                 * string may be returned.
+                 */
+                virtual Bu::FString getLocation() const = 0;
 
         private: