Add new Stream base class, internal-only for now.

src/common/Stream.h

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2006-2015 LOVE Development Team
+ * Copyright (c) 2006-2022 LOVE Development Team
  *
  * This software is provided 'as-is', without any express or implied
  * warranty.  In no event will the authors be held liable for any damages
@@ -24,41 +24,92 @@
 // LOVE
 #include <stddef.h>
 #include "Object.h"
+#include "int.h"
 
 namespace love
 {
 
+class Data;
+
 class Stream : public Object
 {
 public:
+
+	enum SeekOrigin
+	{
+		SEEKORIGIN_BEGIN,
+		SEEKORIGIN_CURRENT,
+		SEEKORIGIN_END,
+		SEEKORIGIN_MAX_ENUM
+	};
+
 	static love::Type type;
 
 	virtual ~Stream() {}
 
-	// getData and getSize are assumed to talk about
-	// the buffer
+	/**
+	 * Creates a new copy of the Stream, with the same settings as the original.
+	 * The seek position will be reset in the copy.
+	 **/
+	virtual Stream *clone() = 0;
 
 	/**
-	 * A callback, gets called when some Stream consumer exhausts the data
+	 * Gets whether read() is supported for this Stream.
 	 **/
-	virtual void fillBackBuffer() {}
+	virtual bool isReadable() const = 0;
 
 	/**
-	 * Get the front buffer, Streams are supposed to be (at least) double-buffered
+	 * Gets whether write() is supported for this Stream.
 	 **/
-	virtual const void *getFrontBuffer() const = 0;
+	virtual bool isWritable() const = 0;
 
 	/**
-	 * Get the size of any (and in particular the front) buffer
+	 * Gets whether seek(), tell(), and getSize() are supported for this Stream.
 	 **/
-	virtual size_t getSize() const = 0;
+	virtual bool isSeekable() const = 0;
 
 	/**
-	 * Swap buffers. Returns true if there is new data in the front buffer,
-     * false otherwise.
-	 * NOTE: If there is no back buffer ready, this call must be ignored
+	 * Reads data into the destination buffer, and returns the number of bytes
+	 * actually read.
 	 **/
-	virtual bool swapBuffers() = 0;
+	virtual int64 read(void *dst, int64 size) = 0;
+
+	/**
+	 * Reads data into a new Data object.
+	 **/
+	virtual Data *read(int64 size);
+
+	/**
+	 * Writes data from the source buffer into the Stream.
+	 **/
+	virtual bool write(const void *src, int64 size) = 0;
+
+	/**
+	 * Writes data from the source Data object into the Stream.
+	 **/
+	virtual bool write(Data *src, int64 offset, int64 size);
+	bool write(Data *src);
+
+	/**
+	 * Flushes all data written to the Stream.
+	 **/
+	virtual bool flush() = 0;
+
+	/**
+	 * Gets the total size of the Stream, if supported.
+	 **/
+	virtual int64 getSize() = 0;
+
+	/**
+	 * Sets the current position in the Stream, if supported.
+	 **/
+	virtual bool seek(int64 pos, SeekOrigin origin = SEEKORIGIN_BEGIN) = 0;
+
+	/**
+	 * Gets the current position in the Stream, if supported.
+	 **/
+	virtual int64 tell() = 0;
+
 }; // Stream
 
 } // love