Initial commit

engines/glk/streams.h

@@ -0,0 +1,697 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef GLK_STREAMS_H
+#define GLK_STREAMS_H
+
+#include "common/scummsys.h"
+#include "common/file.h"
+#include "common/savefile.h"
+#include "common/str.h"
+#include "glk/glk_types.h"
+
+namespace Glk {
+
+#define SAVEGAME_VERSION 1
+
+class Window;
+class Streams;
+
+enum FileUsage {
+	fileusage_Data = 0x00,
+	fileusage_SavedGame = 0x01,
+	fileusage_Transcript = 0x02,
+	fileusage_InputRecord = 0x03,
+	fileusage_TypeMask = 0x0f,
+
+	fileusage_TextMode = 0x100,
+	fileusage_BinaryMode = 0x000
+};
+
+enum FileMode {
+	filemode_Write = 0x01,
+	filemode_Read = 0x02,
+	filemode_ReadWrite = 0x03,
+	filemode_WriteAppend = 0x05
+};
+
+enum SeekMode {
+	seekmode_Start = 0,
+	seekmode_Current = 1,
+	seekmode_End = 2
+};
+
+struct StreamResult {
+	uint _readCount;
+	uint _writeCount;
+};
+typedef StreamResult stream_result_t;
+
+/**
+ * File details
+ */
+struct FileReference {
+	uint _rock;
+	int _slotNumber;
+	Common::String _description;
+	Common::String _filename;
+	FileUsage _fileType;
+	bool _textMode;
+	gidispatch_rock_t _dispRock;
+
+	/**
+	 * Constructor
+	 */
+	FileReference();
+
+	/**
+	 * Constructor
+	 */
+	FileReference(int slot, const Common::String &desc, uint usage, uint rock = 0);
+
+	/**
+	 * Destructor
+	 */
+	~FileReference();
+
+	/**
+	 * Get savegame filename
+	 */
+	const Common::String getSaveName() const;
+
+	/**
+	 * Returns true if the given file exists
+	 */
+	bool exists() const;
+
+	/**
+	 * Delete the given file
+	 */
+	void deleteFile();
+};
+
+typedef FileReference *frefid_t;
+typedef Common::Array< Common::SharedPtr<FileReference> > FileRefArray;
+
+
+/**
+ * Base class for streams
+ */
+class Stream {
+public:
+	Streams *_streams;
+	Stream *_prev;
+	Stream *_next;
+	uint _rock;
+	gidispatch_rock_t _dispRock;
+	bool _unicode;
+	uint _readCount;
+	uint _writeCount;
+	bool _readable, _writable;
+public:
+	/**
+	 * Constructor
+	 */
+	Stream(Streams *streams, bool readable, bool writable, uint rock, bool unicode);
+
+	/**
+	 * Destructor
+	 */
+	virtual ~Stream();
+
+	/**
+	 * Get the next stream
+	 */
+	Stream *getNext(uint *rock) const;
+
+	/**
+	 * Get the rock value for the stream
+	 */
+	uint getRock() const {
+		return _rock;
+	}
+
+	/**
+	 * Fill out the total amount read and/or written
+	 */
+	void fillResult(StreamResult *result);
+
+	/**
+	 * Close and delete the stream
+	 */
+	void close(StreamResult *result = nullptr);
+
+	/**
+	 * Write a character
+	 */
+	virtual void putChar(unsigned char ch) = 0;
+
+	/**
+	 * Write a unicode character
+	 */
+	virtual void putCharUni(uint32 ch) = 0;
+
+	/**
+	 * Write a buffer
+	 */
+	virtual void putBuffer(const char *buf, size_t len) = 0;
+
+	/**
+	 * Write a unicode character
+	 */
+	virtual void putBufferUni(const uint32 *buf, size_t len) = 0;
+
+	/**
+	 * Remove a string from the end of the stream, if indeed it is at the end
+	 */
+	virtual void unputBuffer(const char *buf, size_t len) {}
+
+	/**
+	 * Remove a string from the end of the stream, if indeed it is at the end
+	 */
+	virtual void unputBufferUni(const uint32 *buf, size_t len) {}
+
+	/**
+	 * Send a line to the stream with a trailing newline
+	 */
+	void echoLine(const char *buf, uint len) {
+		putBuffer(buf, len);
+		putChar('\n');
+	};
+
+	/**
+	 * Send a line to the stream with a trailing newline
+	 */
+	void echoLineUni(const uint32 *buf, uint len) {
+		putBufferUni(buf, len);
+		putCharUni('\n');
+	}
+
+	virtual uint getPosition() const {
+		return 0;
+	}
+
+	virtual void setPosition(int pos, uint seekMode) {}
+
+	virtual void setStyle(uint val) {}
+
+	/**
+	 * Get a character from the stream
+	 */
+	virtual int getChar() {
+		return -1;
+	}
+
+	/**
+	 * Get a unicode character from the stream
+	 */
+	virtual int getCharUni() {
+		return -1;
+	}
+
+	/**
+	 * Get a buffer
+	 */
+	virtual uint getBuffer(char *buf, uint len) {
+		return 0;
+	}
+
+	/**
+	 * Get a unicode buffer
+	 */
+	virtual uint getBufferUni(uint32 *buf, uint len) {
+		return 0;
+	}
+
+	/**
+	 * Get a line
+	 */
+	virtual uint getLine(char *buf, uint len) {
+		return 0;
+	}
+
+	/**
+	 * Get a unicode line
+	 */
+	virtual uint getLineUni(uint32 *ubuf, uint len) {
+		return 0;
+	}
+
+	/**
+	 * Set a hyperlink
+	 */
+	virtual void setHyperlink(uint linkVal) {}
+
+	/**
+	 * Set the style colors
+	 */
+	virtual void setZColors(uint fg, uint bg);
+
+	/**
+	 * Set the reverse video style
+	 */
+	virtual void setReverseVideo(bool reverse);
+
+	/**
+	 * Cast a stream to a ScummVM write stream
+	 */
+	virtual operator Common::WriteStream *() const { return nullptr; }
+
+	/**
+	 * Cast a stream to a ScummVM read stream
+	 */
+	virtual operator Common::SeekableReadStream *() const { return nullptr; }
+};
+typedef Stream *strid_t;
+
+/**
+ * Implements the stream for writing text to a window
+ */
+class WindowStream : public Stream {
+private:
+	Window *_window;
+public:
+	/**
+	 * Constructor
+	 */
+	WindowStream(Streams *streams, Window *window, uint rock = 0, bool unicode = true) :
+		Stream(streams, false, true, rock, unicode), _window(window) {}
+
+	/**
+	 * Destructor
+	 */
+	~WindowStream() override;
+
+	/**
+	 * Close the stream
+	 */
+	virtual void close(StreamResult *result = nullptr);
+
+	/**
+	 * Write a character
+	 */
+	void putChar(unsigned char ch) override;
+
+	/**
+	 * Write a unicode character
+	 */
+	void putCharUni(uint32 ch) override;
+
+	/**
+	 * Write a buffer
+	 */
+	void putBuffer(const char *buf, size_t len) override;
+
+	/**
+	 * Write a unicode character
+	 */
+	void putBufferUni(const uint32 *buf, size_t len) override;
+
+	/**
+	 * Remove a string from the end of the stream, if indeed it is at the end
+	 */
+	void unputBuffer(const char *buf, size_t len) override;
+
+	/**
+	 * Remove a string from the end of the stream, if indeed it is at the end
+	 */
+	void unputBufferUni(const uint32 *buf, size_t len) override;
+
+	void setStyle(uint val) override;
+
+	/**
+	 * Set a hyperlink
+	 */
+	void setHyperlink(uint linkVal) override;
+
+	/**
+	 * Set the style colors
+	 */
+	void setZColors(uint fg, uint bg) override;
+
+	/**
+	 * Set the reverse video style
+	 */
+	void setReverseVideo(bool reverse) override;
+};
+
+/**
+ * Implements an in-memory stream
+ */
+class MemoryStream : public Stream {
+private:
+	void *_buf;     ///< unsigned char* for latin1, uint* for unicode
+	void *_bufPtr;
+	void *_bufEnd;
+	void *_bufEof;
+	size_t _bufLen; ///< # of bytes for latin1, # of 4-byte words for unicode
+	gidispatch_rock_t _arrayRock;
+public:
+	/**
+	 * Constructor
+	 */
+	MemoryStream(Streams *streams, void *buf, size_t buflen, FileMode mode, uint rock = 0, bool unicode = true);
+
+	/**
+	 * Destructor
+	 */
+	~MemoryStream() override;
+
+	/**
+	 * Write a character
+	 */
+	void putChar(unsigned char ch) override;
+
+	/**
+	 * Write a unicode character
+	 */
+	void putCharUni(uint32 ch) override;
+
+	/**
+	 * Write a buffer
+	 */
+	void putBuffer(const char *buf, size_t len) override;
+
+	/**
+	 * Write a unicode character
+	 */
+	void putBufferUni(const uint32 *buf, size_t len) override;
+
+	uint getPosition() const override;
+
+	void setPosition(int pos, uint seekMode) override;
+
+	/**
+	 * Get a character from the stream
+	 */
+	int getChar() override;
+
+	/**
+	 * Get a unicode character from the stream
+	 */
+	int getCharUni() override;
+
+	/**
+	 * Get a buffer
+	 */
+	uint getBuffer(char *buf, uint len) override;
+
+	/**
+	 * Get a unicode buffer
+	 */
+	uint getBufferUni(uint32 *buf, uint len) override;
+
+	/**
+	 * Get a line
+	 */
+	uint getLine(char *buf, uint len) override;
+
+	/**
+	 * Get a unicode line
+	 */
+	uint getLineUni(uint32 *ubuf, uint len) override;
+};
+
+/**
+ * Base class for I/O streams
+ */
+class IOStream : public Stream {
+private:
+	Common::SeekableReadStream *_inStream;
+	Common::WriteStream *_outStream;
+	uint _lastOp;                 ///< 0, filemode_Write, or filemode_Read
+private:
+	/**
+	 * Ensure the stream is ready for the given operation
+	 */
+	void ensureOp(FileMode mode);
+
+	/**
+	 * Put a UTF8 character
+	 */
+	void putCharUtf8(uint val);
+
+	/**
+	 * Get a UTF8 character
+	 */
+	int getCharUtf8();
+protected:
+	bool _textFile;
+public:
+	/**
+	 * Constructor
+	 */
+	IOStream(Streams *streams, bool readable, bool writable, uint rock, bool unicode) :
+		Stream(streams, readable, writable, rock, unicode) {}
+	IOStream(Streams *streams, uint rock = 0) : Stream(streams, false, false, rock, false),
+		_inStream(nullptr), _outStream(nullptr), _lastOp(0), _textFile(false) {}
+	IOStream(Streams *streams, Common::SeekableReadStream *inStream, uint rock = 0) :
+		Stream(streams, true, false, rock, false), _inStream(inStream), _outStream(nullptr), _lastOp(0), _textFile(false) {}
+	IOStream(Streams *streams, Common::WriteStream *outStream, uint rock = 0) :
+		Stream(streams, false, true, rock, false), _inStream(nullptr), _outStream(outStream), _lastOp(0), _textFile(false) {}
+
+	/**
+	 * Sets the stream to use
+	 */
+	void setStream(Common::SeekableReadStream *rs) {
+		_inStream = rs;
+		_outStream = nullptr;
+		_readable = true;
+		_writable = false;
+	}
+
+	/**
+	 * Sets the stream to use
+	 */
+	void setStream(Common::WriteStream *ws) {
+		_inStream = nullptr;
+		_outStream = ws;
+		_readable = false;
+		_writable = true;
+	}
+
+	/**
+	 * Write a character
+	 */
+	void putChar(unsigned char ch) override;
+
+	/**
+	 * Write a unicode character
+	 */
+	void putCharUni(uint32 ch) override;
+
+	/**
+	 * Write a buffer
+	 */
+	void putBuffer(const char *buf, size_t len) override;
+
+	/**
+	 * Write a unicode character
+	 */
+	void putBufferUni(const uint32 *buf, size_t len) override;
+
+	uint getPosition() const override;
+
+	void setPosition(int pos, uint seekMode) override;
+
+	/**
+	 * Get a character from the stream
+	 */
+	int getChar() override;
+
+	/**
+	 * Get a unicode character from the stream
+	 */
+	int getCharUni() override;
+
+	/**
+	 * Get a buffer
+	 */
+	uint getBuffer(char *buf, uint len) override;
+
+	/**
+	 * Get a unicode buffer
+	 */
+	uint getBufferUni(uint32 *buf, uint len) override;
+
+	/**
+	 * Get a line
+	 */
+	uint getLine(char *buf, uint len) override;
+
+	/**
+	 * Get a unicode line
+	 */
+	uint getLineUni(uint32 *ubuf, uint len) override;
+
+	/**
+	 * Cast a stream to a ScummVM write stream
+	 */
+	operator Common::WriteStream *() const override { return _outStream; }
+
+	/**
+	 * Cast a stream to a ScummVM read stream
+	 */
+	operator Common::SeekableReadStream *() const override { return _inStream; }
+};
+
+/**
+ * Implements a file stream
+ */
+class FileStream : public IOStream {
+private:
+	Common::File _file;
+	Common::InSaveFile *_inSave;
+	Common::OutSaveFile *_outSave;
+public:
+	/**
+	 * Constructor
+	 */
+	FileStream(Streams *streams, frefid_t fref, uint fmode, uint rock, bool unicode);
+
+	/**
+	 * Destructor
+	 */
+	~FileStream() override;
+};
+
+/**
+ * Streams manager
+ */
+class Streams {
+	friend class Stream;
+private:
+	Stream *_streamList;
+	Stream *_currentStream;
+	FileRefArray _fileReferences;
+private:
+	/**
+	 * Adds a created stream to the list
+	 */
+	void addStream(Stream *stream);
+
+	/**
+	 * Remove a stream
+	 */
+	void removeStream(Stream *stream);
+public:
+	/**
+	 * Constructor
+	 */
+	Streams();
+
+	/**
+	 * Destructor
+	 */
+	~Streams();
+
+	/**
+	 * Open a file stream
+	 */
+	FileStream *openFileStream(frefid_t fref, uint fmode, uint rock = 0, bool unicode = false);
+
+	/**
+	 * Open a ScummVM read stream
+	 */
+	IOStream *openStream(Common::SeekableReadStream *rs, uint rock = 0);
+
+	/**
+	 * Open a ScummVM write stream
+	 */
+	IOStream *openStream(Common::WriteStream *ws, uint rock = 0);
+
+	/**
+	 * Open a window stream
+	 */
+	WindowStream *openWindowStream(Window *window);
+
+	/**
+	 * Open a memory stream
+	 */
+	MemoryStream *openMemoryStream(void *buf, size_t buflen, FileMode mode, uint rock = 0, bool unicode = true);
+
+	/**
+	 * Delete a stream
+	 */
+	void deleteStream(Stream *stream) {
+		delete stream;
+	}
+
+	/**
+	 * Start an Iteration through streams
+	 */
+	Stream *getFirst(uint *rock);
+
+	/**
+	 * Set the current output stream
+	 */
+	void setCurrent(Stream *stream) {
+		assert(!stream || stream->_writable);
+		_currentStream = stream;
+	}
+
+	/**
+	 * Gets the current output stream
+	 */
+	Stream *getCurrent() const {
+		return _currentStream;
+	}
+
+	/**
+	 * Prompt for a savegame to load or save, and populate a file reference from the result
+	 */
+	frefid_t createByPrompt(uint usage, FileMode fmode, uint rock);
+
+	/**
+	 * Create a new file reference
+	 */
+	frefid_t createRef(int slot, const Common::String &desc, uint usage, uint rock);
+
+	/**
+	 * Create a new file reference
+	 */
+	frefid_t createRef(const Common::String &filename, uint usage, uint rock);
+
+	/**
+	 * Create a new temporary file reference
+	 */
+	frefid_t createTemp(uint usage, uint rock);
+
+	/**
+	 * Create a new file reference from an old one
+	 */
+	frefid_t createFromRef(frefid_t fref, uint usage, uint rock);
+
+	/**
+	 * Delete a file reference
+	 */
+	void deleteRef(frefid_t fref);
+
+	/**
+	 * Iterates to the next file reference following the specified one,
+	 * or the first if null is passed
+	 */
+	frefid_t iterate(frefid_t fref, uint *rock);
+};
+
+} // End of namespace Glk
+
+#endif