scummvm/engines/saga2/document.h

/* 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
 * aint32 with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *
 * Based on the original sources
 *   Faery Tale II -- The Halls of the Dead
 *   (c) 1993-1996 The Wyrmkeep Entertainment Co.
 */

#ifndef SAGA2_DOCUMENT_H
#define SAGA2_DOCUMENT_H

#include "saga2/modal.h"

namespace Saga2 {

// prototypes
void appendBookText(char *string = NULL);
void appendScrollText(char *string = NULL);

int16 openBook(uint16);
int16 openScroll(uint16);
int16 openParchment(uint16);


// constants
const uint32    bookGroupID     = MKTAG('B', 'O', 'O', 'K');

const int maxVisiblePages = 2;

enum {
	pageLeft = 0,
	pageRight,
	pageUp,
	pageDown
};

enum pageOrientation {
	pageOrientVertical = 0,
	pageOrientHorizontal
};

class CDocumentAppearance {
public:
	Rect16          windowPos;                  //  Position of window on screen
	int16           numPages;                   //  Number of visible pages
	int16           orientation;                //  Orientation of pages
	uint8           *textColors;                //  Text color array
	Rect16          pageRect[maxVisiblePages];//  Array of visible page rects
	Rect16          closeRect;                  //  Close-box rectangle
	WindowDecoration *decoList;                 //  List of decorator panels
	int16           numDecos;                   //  Number of decorator panels
	hResID          groupID;                    //  Resource ID for decoration group
	hResID          decoID;                     //  Resource ID for decorations

	CDocumentAppearance(
	    Rect16      _windowPos,
	    int16       _numPages,
	    int16       _orientation,
	    uint8       *_textColors,
	    Rect16      _pageRect_0,
	    Rect16      _pageRect_1,
	    Rect16      _closeRect,
	    WindowDecoration *_decoList,
	    int16       _numDecos,
	    hResID      _groupID,
	    hResID      _decoID)
		:   windowPos(_windowPos),
		    numPages(_numPages),
		    orientation(_orientation),
		    textColors(_textColors),
		    closeRect(_closeRect),
		    decoList(_decoList),
		    numDecos(_numDecos),
		    groupID(_groupID),
		    decoID(_decoID) {
		pageRect[0]       = _pageRect_0;
		pageRect[1]       = _pageRect_1;
	}
};

//  Base class for scrolls, books, and parchments

class CDocument : public ModalWindow {

	friend class CScroll;
	friend class CBook;

private:
	enum {
		maxPages            = 32,
		maxLines            = 32,
		maxChars            = 32,
		textPictureOffset   = 1
	};

	struct ImageHeader {
		Point16     size;
		int16       compress;
		int8        data[2];
	};

	CDocumentAppearance &app;

	// image poiner array
	void            *images[maxPages];

	uint16          currentPage,
	                lineWidth,
	                pageHeight,
	                totalLines,
	                totalPages;

	gFont           *textFont;
	uint16          textHeight;
	uint16          pages;
	uint16          numLines[maxPages];
	uint16          lineLen[maxPages][maxLines];
	uint16          lineOffset[maxPages];
	Extent16        imageSizes[maxPages];
	bool            pageBreakSet;

	char            *scan;                  // for parsing book text.

	// string sizes
	uint16  maxSize;
	uint16  textSize;

	// image context
	hResContext *illustrationCon;

private:
	bool activate(gEventType why);       // activate the control
	void deactivate(void);

	void pointerMove(gPanelMessage &msg);
	bool pointerHit(gPanelMessage &msg);
	void pointerDrag(gPanelMessage &msg);
	void pointerRelease(gPanelMessage &msg);
	bool keyStroke(gPanelMessage &msg);

protected:
	void drawClipped(
	    gPort         &port,
	    const Point16 &offset,
	    const Rect16  &clipRect);

	void draw(void);                             // redraw the window

	void    renderText(void);
	void    makePages(void);
	bool    checkForPageBreak(char *string,
	                          uint16 index,
	                          int32 &offset);

	bool    checkForImage(char *string,
	                      uint16 index,
	                      uint16 pageIndex,
	                      int32 &offset);
	gPanel *keyTest(int16 key);
public:
	char            *origText;                  // the original text string
	char            *text;                      // the working text string

public:
	CDocument(CDocumentAppearance &app,
	          char            *buffer,        // buffer to edit
	          gFont           *font,          // font of the text
	          uint16          ident,          // control ID
	          AppFunc         *cmd = NULL);   // application command func
	~CDocument(void);

	void gotoPage(int8 page);

	APPFUNCV(cmdDocumentEsc);
	APPFUNCV(cmdDocumentLt);
	APPFUNCV(cmdDocumentRt);
	APPFUNCV(cmdDocumentUp);
	APPFUNCV(cmdDocumentDn);

//	void setText( char *text );
//	void appendText( char *string );
};

} // end of namespace Saga2

#endif