postal/RSPiX/Src/GREEN/BLiT/RPrint.h

////////////////////////////////////////////////////////////////////////////////
//
// Copyright 2016 RWS Inc, All Rights Reserved
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of version 2 of the GNU General Public License as published by
// the Free Software Foundation
//
// 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
//
// May or may not join blit.h
#ifndef RPRINT_H
#define RPRINT_H
/****************************************************** QUICK CHECK
	//-------------------------- Higher Level
	char* print(char* pszFormat,...);
	char* print(short sX,short sY,char* pszFormat,...);
	char* print(RImage* pimDst,short sX,short sY,char* pszFormat,...);
	short SetEffectAbs(Effect eEffect,short sVal); // absolute:
	short SetEffect(Effect eEffect,double dVal); // relative:
	short SetColor(ULONG ulForeColor,ULONG ulBackColor=0,ULONG ulShadowColor=0);
	short SetDestination(RImage* pimDst,RRect* prColumn = NULL);
	void SetJustifyRight();
	void SetJustifyCenter();
	void SetJustifyLeft();
	void SetWordWrap(short sOn = TRUE);
	void ResetEffects(); // includes tab and to relative
	void ResetMode(); // all zero
	void SetMode(Mode eMode,short sVal); // 0 = off
	short SetFont(short sCellH,RFont* pFont = NULL);
	void	GetPos(short *psX,short *psY,short *psW,short *psH);
	short	GetWidth(char* pszString); // see m_sNumChar,ms_szLineText,ms_sCharPosX
	RFont* GetFont() { return m_pfnCurFont; }
	short SetColumn(short sX,short sY,short sW,short sH);
//****************************************************** QUICK CHECK */

#include "BLIT.H"
//====================
class RPrint
	{
public:
	//-------------------------- Public members

	U32	m_ForegroundColor;
	U32	m_BackgroundColor;	// 0 = OFF
	U32	m_ShadowColor;	// Used if offsets are not zero!
	RImage*	m_pimDst;
	RRect		m_rClip;	// used for wrapping..

	// Printing Modes: Default is left justify, proportional
	// Note: JUSTIFY_F & JUSTIFY_R are not independent
	typedef enum
		{
		UNPROPORTIONAL = 1, // 0 = Proportional
		WORD_WRAP = 2,	// 0 = RAW
		FIELD = 4,	// 0 = line mode => SYTEM FLAG!
		JUSTIFY_ON = 8,	// 0 = Left Justified
		JUSTIFY_FULL = 16, // 0 = Check JUSTIFY_RIGHT
		JUSTIFY_RIGHT = 32, // 0 = Center justified
		TAB_STOP = 64, // 0 = disble
		DECIMAL_STOP = 128, // 0 = disble
		} Mode;

	// NEW generic use of varying effects:
	// A floating point value array (default),
	// a short array (optional), and a short value array
	// for each letter effect.  A byte list will flag
	// use of the absolute (short) values:
	typedef enum
		{
		STRETCH = 0,ITALIC,BOLD,SHADOW_X,SHADOW_Y,TAB,UP_W,UP_H,ADD_W,ADD_H,
		NUM_OF_EFFECTS
		}	Effect; // binary
	//-------------------------- Higher Level
	char* print(char* pszFormat,...);
	char* print(short sX,short sY,char* pszFormat,...);
	char* print(RImage* pimDst,short sX,short sY,char* pszFormat,...);
	short SetEffectAbs(Effect eEffect,short sVal); // absolute:
	short SetEffect(Effect eEffect,double dVal); // relative:
	short SetColor(ULONG ulForeColor,ULONG ulBackColor=0,ULONG ulShadowColor=0);
	short SetDestination(RImage* pimDst,RRect* prColumn = NULL);
	short SetColumn(short sX,short sY,short sW,short sH);
	void SetJustifyRight();
	void SetJustifyCenter();
	void SetJustifyLeft();
	void SetJustifyFull();
	void SetWordWrap(short sOn = TRUE);
	void ResetEffects(); // includes tab and to relative
	void ResetMode(); // all zero
	void SetMode(Mode eMode,short sVal); // 0 = off
	short SetFont(short sCellH,RFont* pFont = NULL);
	void	GetPos(short *psX,short *psY = NULL,short *psW = NULL,short *psH = NULL);
	short	GetWidth(char* pszString);
	RFont* GetFont() { return m_pfnCurFont; }
	//-------------------------- Lower Level
	//void OffsetShadow();
	char* printInt(char* pszInput);
	void GetPropEffX(short sX,short sE,short sNext,
								  short *psEffX = NULL,short *psEffE = NULL,
								  short *psEffNext = NULL);
	short GetPropCellX(short sChar,short *psX = NULL,short *psE = NULL,
			short *psNext = NULL,short sFirst = FALSE);
	char* ScanLine(char* pszInput);
	void  FormatText();
	void	DrawText();
	short GetBlitW(UCHAR c);
	short FrameIt(); // 1= fresh line, -1 = off bottom
	void	printLine();
	void ClearTabs(); // both types
	short IsClipped(short sX,short sY,short sW,short sH);
	char*	GetNextLine(); // characters from inputted text to be line formatted, NULL = done.
	short IsWhiteSpace(short sChar)
		{ if ((sChar == ' ')||(sChar == '\t')) return 1; return 0;}
	short SetCellW();

	//-------------------------- Construction
	RPrint();
	~RPrint();
public:

	short m_sCurX;	// lower left cursor position
	short m_sCurY;

	Mode	m_eModes;	// Set different text modes
	// a 0 signals using the Height relative value
	U8		m_aAbsFlag[NUM_OF_EFFECTS]; 
	S16	m_aAbsEffect[NUM_OF_EFFECTS]; // go by this...
	float	m_aARelEffect[NUM_OF_EFFECTS]; 

	//----------------------------- More parameters
	RFont*	m_pfnCurFont; // The high level font

	short m_sNumTabStops;
	short m_sNumDecStops;
	short *m_psTabStops;
	short *m_psDecStops;

	//----------------------------- Working variables
	RFont::RFontSet* m_pCurFontSet; // set to NULL initially.
	float	m_fWidthScale;				// Compared to current font
	float m_fHeightScale;			// Compared to current font

	short	m_sCellH;	// Current Visual Letter Height:
	short m_sCellW;	// Curent maximum width based on effects

	short m_sUP_W;		// Max width or fixed grid width
	short m_sUP_H;		// Max width or fixed grid width

	short m_sNumWhite;
	//---------------
	short m_sNumChar;
	short m_sExtX;
	//----------------------------- Static variables
	static	UCHAR	ms_szLineText[1024]; // Stores a line at a time
	static	short	ms_sCharPosX[1024]; // positions of each character in the line...
	static	char	ms_szInput[4096]; //
	};

//====================
#endif