GRAPHICS: Add a new MacCursor class for handling CURS/crsr cursors

1 files changed, 83 insertions, 0 deletions

diff --git a/graphics/maccursor.h b/graphics/maccursor.h
new file mode 100644
index 0000000000..fac78d97a4
--- /dev/null
+++ b/graphics/maccursor.h
@@ -0,0 +1,83 @@
+/* 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 2
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+/**
+ * @file
+ * Macintosh cursor decoding used in engines:
+ * - mohawk
+ * - sci
+ * - scumm
+ */
+
+#include "common/stream.h"
+
+#ifndef GRAPHICS_MACCURSOR_H
+#define GRAPHICS_MACCURSOR_H
+
+namespace Graphics {
+
+/**
+ * A Mac crsr or CURS cursor
+ * TODO: Think about making a base class with WinCursor
+ */
+class MacCursor {
+public:
+	MacCursor();
+	~MacCursor();
+
+	/** Return the cursor's width. */
+	uint16 getWidth() const { return 16; }
+	/** Return the cursor's height. */
+	uint16 getHeight() const { return 16; }
+	/** Return the cursor's hotspot's x coordinate. */
+	uint16 getHotspotX() const { return _hotspotX; }
+	/** Return the cursor's hotspot's y coordinate. */
+	uint16 getHotspotY() const { return _hotspotY; }
+	/** Return the cursor's transparent key. */
+	byte getKeyColor() const { return 0xFF; }
+
+	const byte *getSurface() const { return _surface; }
+	const byte *getPalette() const { return _palette; }
+
+	/** Read the cursor's data out of a stream. */
+	bool readFromStream(Common::SeekableReadStream &stream, bool forceMonochrome = false);
+
+private:
+	bool readFromCURS(Common::SeekableReadStream &stream);
+	bool readFromCRSR(Common::SeekableReadStream &stream, bool forceMonochrome);
+
+	byte *_surface;
+	byte _palette[256 * 3];
+
+	uint16 _hotspotX; ///< The cursor's hotspot's x coordinate.
+	uint16 _hotspotY; ///< The cursor's hotspot's y coordinate.
+
+	/** Clear the cursor. */
+	void clear();
+};
+
+} // End of namespace Graphics
+
+#endif