Initial commit

engines/hugo/display.h

@@ -0,0 +1,197 @@
+/* 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/>.
+ *
+ */
+
+/*
+ * This code is based on original Hugo Trilogy source code
+ *
+ * Copyright (c) 1989-1995 David P. Gray
+ *
+ */
+
+#ifndef HUGO_DISPLAY_H
+#define HUGO_DISPLAY_H
+
+#include "graphics/surface.h"
+#include "graphics/fonts/dosfont.h"
+
+namespace Common {
+class ReadStream;
+class SeekableReadStream;
+class WriteStream;
+}
+
+namespace Hugo {
+enum OverlayState {kOvlUndef, kOvlForeground, kOvlBackground}; // Overlay state
+
+static const int kCenter = -1;                      // Used to center text in x
+
+
+class Screen {
+public:
+	struct Rect {                                 // Rectangle used in Display list
+		int16 _x;                                    // Position in dib
+		int16 _y;                                    // Position in dib
+		int16 _dx;                                   // width
+		int16 _dy;                                   // height
+	};
+
+	Screen(HugoEngine *vm);
+	virtual ~Screen();
+
+	virtual void loadFont(int16 fontId) = 0;
+	virtual void loadFontArr(Common::ReadStream &in) = 0;
+
+	int16    fontHeight() const;
+	int16    stringLength(const char *s) const;
+
+	void     displayBackground();
+	virtual void displayFrame(const int sx, const int sy, Seq *seq, const bool foreFl) = 0;
+	void     displayList(int update, ...);
+	void     displayRect(const int16 x, const int16 y, const int16 dx, const int16 dy);
+	void     drawBoundaries();
+	void     drawRectangle(const bool filledFl, const int16 x1, const int16 y1, const int16 x2, const int16 y2, const int color);
+	void     drawShape(const int x, const int y, const int color1, const int color2);
+	void     updateStatusText();
+	void     updatePromptText(const char *command, char cursor);
+	void     drawStatusText();
+	void     displayStatusText();
+	void     drawPromptText();
+	void     displayPromptText();
+	void     freeScreen();
+	void     hideCursor();
+	void     initDisplay();
+	void     initNewScreenDisplay();
+	virtual void loadPalette(Common::SeekableReadStream &in) = 0;
+	void     moveImage(ImagePtr srcImage, const int16 x1, const int16 y1, const int16 dx, int16 dy, const int16 width1, ImagePtr dstImage, const int16 x2, const int16 y2, const int16 width2);
+	void     remapPal(uint16 oldIndex, uint16 newIndex);
+	void     resetInventoryObjId();
+	void     restorePal(Common::ReadStream *f);
+	void     savePal(Common::WriteStream *f) const;
+	void     setBackgroundColor(const uint16 color);
+	void     setCursorPal();
+	void     selectInventoryObjId(const int16 objId);
+	void     shadowStr(int16 sx, const int16 sy, const char *s, const byte color);
+	void     showCursor();
+	void     userHelp() const;
+	void     writeStr(int16 sx, const int16 sy, const char *s, const byte color);
+	Common::Rect drawDosText(byte x, byte y, const char *text, byte color);
+	byte getDosMessageBoxBorder() const;
+	Common::KeyState dosMessageBox(const Common::String &text, bool protect = false, TtsOptions ttsOptions = kTtsReplaceNewlines);
+	Common::String dosPromptBox(const Common::String &text);
+	Common::KeyState getKey();
+
+	Icondib &getIconBuffer();
+	Viewdib &getBackBuffer();
+	Viewdib &getBackBufferBackup();
+	Viewdib &getFrontBuffer();
+	Viewdib &getGUIBuffer();
+
+protected:
+	HugoEngine *_vm;
+
+	static const int kRectListSize = 16;            // Size of add/restore rect lists
+	static const int kBlitListSize = kRectListSize * 2; // Size of dirty rect blit list
+	static const int kShapeSize = 24;
+	static const int kFontLength = 128;             // Number of chars in font
+	static const int kFontSize = 1200;              // Max size of font data
+	static const int kNumFonts = 3;                 // Number of dib fonts
+	static const byte stdMouseCursorHeight = 20;
+	static const byte stdMouseCursorWidth = 12;
+
+	bool fontLoadedFl[kNumFonts];
+
+	// Fonts used in dib (non-GDI)
+	byte *_arrayFont[kNumFonts];
+	byte  _fnt;                                     // Current font number
+	byte  _fontdata[kNumFonts][kFontSize];          // Font data
+	byte *_font[kNumFonts][kFontLength];            // Ptrs to each char
+	int16 _arrayFontSize[kNumFonts];
+	byte *_mainPalette;
+	byte *_curPalette;
+	byte _paletteSize;
+
+	Graphics::DosFont _dosFont;
+
+	Viewdib _frontBuffer;
+	Graphics::Surface _frontSurface;
+
+	inline bool isInX(const int16 x, const Rect *rect) const;
+	inline bool isInY(const int16 y, const Rect *rect) const;
+	inline bool isOverlapping(const Rect *rectA, const Rect *rectB) const;
+
+private:
+	byte      _iconImage[kInvDx * kInvDy];
+
+	Icondib _iconBuffer;                          // Inventory icon DIB
+
+	int16 mergeLists(Rect *list, Rect *blist, const int16 len, int16 blen);
+	int16 center(const char *s) const;
+
+	Viewdib _backBuffer;
+	Viewdib _GUIBuffer;                              // User interface images
+	Viewdib _backBufferBackup;                       // Backup _backBuffer during inventory
+	Viewdib _frontBufferBoxBackup;                   // Backup _frontBuffer during DOS message boxes
+
+	// Formerly static variables used by displayList()
+	int16  _dlAddIndex, _dlRestoreIndex;               // Index into add/restore lists
+	Rect _dlRestoreList[kRectListSize];              // The restore list
+	Rect _dlAddList[kRectListSize];                  // The add list
+	Rect _dlBlistList[kBlitListSize];                // The blit list
+	//
+
+	void createPal();
+	void merge(const Rect *rectA, Rect *rectB);
+	void writeChr(const int sx, const int sy, const byte color, const char *local_fontdata);
+};
+
+class Screen_v1d : public Screen {
+public:
+	Screen_v1d(HugoEngine *vm);
+	~Screen_v1d() override;
+
+	void loadFont(int16 fontId) override;
+	void loadFontArr(Common::ReadStream &in) override;
+
+	void displayFrame(const int sx, const int sy, Seq *seq, const bool foreFl) override;
+
+	void loadPalette(Common::SeekableReadStream &in) override;
+protected:
+	OverlayState findOvl(Seq *seqPtr, ImagePtr dstPtr, uint16 y);
+};
+
+class Screen_v1w : public Screen {
+public:
+	Screen_v1w(HugoEngine *vm);
+	~Screen_v1w() override;
+
+	void loadFont(int16 fontId) override;
+	void loadFontArr(Common::ReadStream &in) override;
+
+	void displayFrame(const int sx, const int sy, Seq *seq, const bool foreFl) override;
+
+	void loadPalette(Common::SeekableReadStream &in) override;
+protected:
+	OverlayState findOvl(Seq *seqPtr, ImagePtr dstPtr, uint16 y);
+};
+
+} // End of namespace Hugo
+
+#endif //HUGO_DISPLAY_H