TiberianDawn/EDIT.CPP

/*
**	Command & Conquer(tm)
**	Copyright 2025 Electronic Arts Inc.
**
**	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/>.
*/

/* $Header:   F:\projects\c&c\vcs\code\edit.cpv   2.18   16 Oct 1995 16:48:16   JOE_BOSTIC  $ */
/***********************************************************************************************
 ***             C O N F I D E N T I A L  ---  W E S T W O O D   S T U D I O S               ***
 ***********************************************************************************************
 *                                                                                             *
 *                 Project Name : Command & Conquer                                            *
 *                                                                                             *
 *                    File Name : EDIT.CPP                                                     *
 *                                                                                             *
 *                   Programmer : Joe L. Bostic, Maria del Mar McCready Legg                   *
 *                                                                                             *
 *                   Start Date : 01/15/95                                                     *
 *                                                                                             *
 *                  Last Update : June 25, 1995 [JLB]                                          *
 *                                                                                             *
 *---------------------------------------------------------------------------------------------*
 * Functions:                                                                                  *
 *   EditClass::Action -- Handles input events.                                                *
 *   EditClass::Draw_Background -- Draw the background to the edit gadget.                     *
 *   EditClass::Draw_Me -- Draws the edit box and embedded text.                               *
 *   EditClass::Draw_Text -- Draws the edit gadget text.                                       *
 *   EditClass::EditClass -- Normal constructor for edit class object.                         *
 *   EditClass::Handle_Key -- Handles keyboard input to edit gadget.                           *
 *   EditClass::Set_Text -- Sets the text to the edit gadget.                                  *
 *   EditClass::~EditClass -- Default destructor for the edit gadget.                          *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */

#include	"function.h"


/***********************************************************************************************
 * EditClass::EditClass -- Normal constructor for edit class object.                           *
 *                                                                                             *
 *    This is the normal constructor used to create an edit object.                            *
 *                                                                                             *
 * INPUT:   id    -- The ID number for this edit object. This is the ID number that will be    *
 *                   returned by the Input() function when the <RETURN> key is pressed if this *
 *                   gadget has the keyboard input focus.                                      *
 *                                                                                             *
 *          text  -- Referenct to the text buffer that the edit gadget will modify as keyboard *
 *                   input is processed. The value that this buffer contains is the default    *
 *                   text displayed.                                                           *
 *                                                                                             *
 *          maxlen-- The maximum size of the text buffer specified. This length INCLUDES the   *
 *                   trailing null character so a simple sizeof() function call can be used.   *
 *                                                                                             *
 *          flags -- These are the text print control flags. It is used to control how the     *
 *                   text looks in the edit box. Use the normal TPF_??? flags.                 *
 *                                                                                             *
 *          x,y   -- The pixel coordinates of the upper left corner of the edit gadget area.   *
 *                                                                                             *
 *          w,h   -- The pixel dimensions of the edit box. If either of these are no provided, *
 *                   or set to -1, then the dimension is determined from the string itself.    *
 *                                                                                             *
 *          sytle -- This style flag parameter control what kind of characters are allowed in  *
 *                   the edit box. The initial string in the text buffer may contain illegal   *
 *                   characters, but they are NOT removed regardless of this parameter.        *
 *                                                                                             *
 * OUTPUT:     none                                                                            *
 * WARNINGS:   none                                                                            *
 * HISTORY:                                                                                    *
 *   01/05/1995 MML : Created.                                                                 *
 *   01/21/1995 JLB : Modified.                                                                *
 *=============================================================================================*/
EditClass::EditClass(int id, char * text, int max_len, TextPrintType flags, int x, int y, int w, int h, EditStyle style) :
	ControlClass (id, x, y, w, h, LEFTPRESS), String(text)
{
	TextFlags = flags;
	EditFlags = style;
	Color = CC_GREEN;
	Set_Text(text, max_len);

	if (w == -1 || h == -1) {
		Fancy_Text_Print(TXT_NONE, 0, 0, TBLACK, TBLACK, TextFlags);

		if (h == -1) {
			Height = FontHeight+2;
		}
		if (w == -1) {
			if (strlen(String) > 0) {
				Width = String_Pixel_Width(String) + 6;
			} else {
				Width = ((Char_Pixel_Width('X')+FontXSpacing) * (MaxLength+1)) + 2;
			}
    	}
	}
	IsReadOnly = 0;
}


/***********************************************************************************************
 * EditClass::~EditClass -- Default destructor for the edit gadget.                            *
 *                                                                                             *
 *    This default destructor removes the focus setting if it currently has it.                *
 *                                                                                             *
 * INPUT:   none                                                                               *
 *                                                                                             *
 * OUTPUT:  none                                                                               *
 *                                                                                             *
 * WARNINGS:   none                                                                            *
 *                                                                                             *
 * HISTORY:                                                                                    *
 *   01/24/1995 JLB : Created.                                                                 *
 *=============================================================================================*/
EditClass::~EditClass(void)
{
	if (Has_Focus()) {
		Clear_Focus();
	}
}


/***********************************************************************************************
 * EditClass::Set_Text -- Sets the text to the edit gadget.                                    *
 *                                                                                             *
 *    Use this routine to change the text that this edit gadget refers to.                     *
 *                                                                                             *
 * INPUT:   text     -- Reference to the character array that this edit gadget will be         *
 *                      modifying.                                                             *
 *          max_len  -- The maximum size of the buffer that will be modified.                  *
 *                                                                                             *
 * OUTPUT:  none                                                                               *
 * WARNINGS:   none                                                                            *
 * HISTORY:                                                                                    *
 *   01/21/1995 JLB : Created.                                                                 *
 *=============================================================================================*/
void EditClass::Set_Text(char * text, int max_len)
{
	String = text;
	MaxLength = max_len-1;
	Length = strlen(String);
	Flag_To_Redraw();
}


/***********************************************************************************************
 * EditClass::Draw_Me -- Draws the edit box and embedded text.                                 *
 *                                                                                             *
 *    This routine will render the edit box. This will show the box outline as well as any     *
 *    text it may contain.                                                                     *
 *                                                                                             *
 * INPUT:   forced   -- Should the edit box be drawn even if it thinks it doesn't have to?     *
 *                                                                                             *
 * OUTPUT:  Was the edit box drawn?                                                            *
 *                                                                                             *
 * WARNINGS:   none                                                                            *
 *                                                                                             *
 * HISTORY:                                                                                    *
 *   06/25/1995 JLB : Created.                                                                 *
 *=============================================================================================*/
int EditClass::Draw_Me(int forced)
{
	if (ControlClass::Draw_Me(forced)) {
		/*
		**	Hide the mouse.
		*/
		if (LogicPage == &SeenBuff) {
			Conditional_Hide_Mouse(X, Y, X+Width, Y+Height);
		}

		/*
		**	Draw the body & set text color.
		*/
		Draw_Background();

		/*
		**	Display the text.
		*/
		Draw_Text(String);

		/*
		**	Display the mouse.
		*/
		if (LogicPage == &SeenBuff) {
			Conditional_Show_Mouse();
		}

		return(true);
	}
	return(false);
}


/***********************************************************************************************
 * EditClass::Action -- Handles input events.                                                  *
 *                                                                                             *
 *    This routine will handle all mouse and keyboard events directed at this edit box         *
 *    gadget. For keyboard events, this will insert the characters into the edit box.          *
 *                                                                                             *
 * INPUT:   flags -- The event flag that triggered this function call.                         *
 *                                                                                             *
 *          key   -- Reference to the keyboard/mouse event that triggered this function call.  *
 *                                                                                             *
 * OUTPUT:  Should the list be processed further?                                              *
 *                                                                                             *
 * WARNINGS:   none                                                                            *
 *                                                                                             *
 * HISTORY:                                                                                    *
 *   06/25/1995 JLB : Created.                                                                 *
 *=============================================================================================*/
int EditClass::Action(unsigned flags, KeyNumType & key)
{

	/*
	** If this is a read-only edit box, it's a display-only device
	*/
	if (IsReadOnly) {
		return(false);
	}

	/*
	**	If the left mouse button is pressed over this gadget, then set the focus to
	**	this gadget. The event flag is cleared so that no button ID number is returned.
	*/
	if ((flags & LEFTPRESS)) {
		flags &= ~LEFTPRESS;
		Set_Focus();
		Flag_To_Redraw();		// force to draw cursor
	}

	/*
	**	Handle keyboard events here. Normally, the key is added to the string, but if the
	**	RETURN key is pressed, then the button ID number is returned from the Input()
	**	function.
	*/
	if ((flags & KEYBOARD) && Has_Focus()) {

		/*
		**	Process the keyboard character. If indicated, consume this keyboard event
		**	so that the edit gadget ID number is not returned.
		*/
		if (key == KN_ESC) {

			Clear_Focus();
			flags = 0;

		} else {

			KeyASCIIType ascii = (KeyASCIIType)(Keyboard::To_ASCII(key) & 0x00ff);

			/*
			** Allow numeric keypad presses to map to ascii numbers
			*/
			if ((key & WWKEY_VK_BIT) && ascii >='0' && ascii <= '9'){
				key &= ~WWKEY_VK_BIT;

				if ( (!(flags & LEFTRELEASE)) && (!(flags & RIGHTRELEASE))){
					if (Handle_Key (ascii) ) {
						flags &= ~KEYBOARD;
						key = KN_NONE;
					}
				}

			}else{

				/*
				** Filter out all special keys except return and backspace
				*/
				if ((!(key & WWKEY_VK_BIT) && ascii >= ' ' && ascii <= 127)
					|| key == KN_RETURN || key == KN_BACKSPACE){


					if ( (!(flags & LEFTRELEASE)) && (!(flags & RIGHTRELEASE))){
						if (Handle_Key(Keyboard::To_ASCII(key))) {
							flags &= ~KEYBOARD;
							key = KN_NONE;
						}
					}
				}else{
					//if (key & WWKEY_RLS_BIT){
					//	if ( (!(flags & LEFTRELEASE)) && (!(flags & RIGHTRELEASE))){
							flags &= ~KEYBOARD;
							key = KN_NONE;
					//	}
					//}
				}
			}
		}
	}

	return(ControlClass::Action(flags, key));
}


/***********************************************************************************************
 * EditClass::Draw_Background -- Draw the background to the edit gadget.                       *
 *                                                                                             *
 *    This routine will redraw the edit gadget background. The overlaying text is handled by   *
 *    a different routine. The mouse is guaranteed to be hidden when this routine is called.   *
 *                                                                                             *
 * INPUT:   none                                                                               *
 *                                                                                             *
 * OUTPUT:  none                                                                               *
 *                                                                                             *
 * WARNINGS:   none                                                                            *
 *                                                                                             *
 * HISTORY:                                                                                    *
 *   01/21/1995 JLB : Created.                                                                 *
 *=============================================================================================*/
void EditClass::Draw_Background(void)
{
	Draw_Box (X, Y, Width, Height, BOXSTYLE_GREEN_BOX, true);
}


/***********************************************************************************************
 * EditClass::Draw_Text -- Draws the edit gadget text.                                         *
 *                                                                                             *
 *    This routine is called when the edit gadget text needs to be drawn. The background has   *
 *    already been drawn by the time this function is called. The mouse is guaranteed to be    *
 *    hidden as well.                                                                          *
 *                                                                                             *
 * INPUT:   text  -- The text to draw in the edit gadget.                                      *
 *                                                                                             *
 * OUTPUT:  none                                                                               *
 *                                                                                             *
 * WARNINGS:   none                                                                            *
 *                                                                                             *
 * HISTORY:                                                                                    *
 *   01/21/1995 JLB : Created.                                                                 *
 *=============================================================================================*/
void EditClass::Draw_Text(char const * text)
{
	if (FontPtr == GradFont6Ptr) {
		TextPrintType flags;

		if (Has_Focus()) {
			flags = TPF_BRIGHT_COLOR;
		} else {
			flags = (TextPrintType)0;
		}

		Conquer_Clip_Text_Print(text, X+1, Y+1, Color, TBLACK, TextFlags | flags, Width-2);

		if (Has_Focus() && strlen(text) < MaxLength &&
				(String_Pixel_Width(text) + String_Pixel_Width ("_") < Width-2) ) {
			Conquer_Clip_Text_Print( "_", X+1+String_Pixel_Width(text), Y+1, Color, TBLACK, TextFlags | flags);
		}
	} else {
		Conquer_Clip_Text_Print(text, X+1, Y+1, Has_Focus() ? BLUE : WHITE, TBLACK, TextFlags, Width-2);

		if (Has_Focus() && strlen(text) < MaxLength &&
				(String_Pixel_Width(text) + String_Pixel_Width ("_") < Width-2) ) {
			Conquer_Clip_Text_Print("_",X+1+String_Pixel_Width(text),Y+1,BLUE,TBLACK, TextFlags);
		}
	}

}


/***********************************************************************************************
 * EditClass::Handle_Key -- Handles keyboard input to edit gadget.                             *
 *                                                                                             *
 *    This is the gruntwork routine that processes keyboard input to the edit gadget. This     *
 *    routine will be called when keyboard input has been detected and this gadget has the     *
 *    current focus.                                                                           *
 *                                                                                             *
 * INPUT:   ascii -- The ASCII key code that was fetched from the keyboard buffer.             *
 *                                                                                             *
 * OUTPUT:  bool; Should this keyboard input NOT cause the gadget ID number to be returned     *
 *                from the controlling Input() routine? Typically, the return value would be   *
 *                true unless the focus is lost due to the <RETURN> key being pressed.         *
 *                                                                                             *
 * WARNINGS:   none                                                                            *
 * HISTORY:                                                                                    *
 *   01/21/1995 JLB : Created.                                                                 *
 *=============================================================================================*/
bool EditClass::Handle_Key(KeyASCIIType ascii)
{
	switch (ascii) {
		/*
		**	Handle the special case of a non-keyboard event. It is possible that this
		**	key code might be passed to this routine if this routine has been overridden
		**	and the key event was consumed.
		*/
		case 0:
			break;

		/*
		**	If the return key is pressed, then remove the focus from this edit
		**	gadget but otherwise let the normal gadget processing proceed. This
		**	causes the gadget ID number to be returned from the Input() function
		**	so that the controlling program will know that the text can be
		**	processed.
		*/
		case KA_RETURN:
			Clear_Focus();
			return(false);

		/*
		**	When the BACKSPACE key is pressed, remove the last character in the edit string.
		*/
		case KA_BACKSPACE:
			if (Length) {
				Length--;
				String[Length] = '\0';
				Flag_To_Redraw();
			}
			break;

		/*
		**	If the keyboard event was not a recognized special key, then examine to see
		**	if it can legally be added to the edit string and do so if possible.
		*/
		default:

			/*
			**	Don't add a character if the length is greater than edit width.
			*/
			if ((String_Pixel_Width(String) + Char_Pixel_Width(ascii) ) >= (Width-2)) {
				break;
			}

			/*
			**	Don't add a character if the length is already at maximum.
			*/
			if (Length >= MaxLength) break;

			/*
			**	Invisible characters are never added to the string. This is
			**	especially true for spaces at the beginning of the string.
			*/
			if (!isgraph(ascii) && ascii != ' ') break;
			if (ascii == ' ' && Length == 0) break;

			/*
			**	If this is an upper case only edit gadget, then force the alphabetic
			**	character to upper case.
			*/
			if ((EditFlags & UPPERCASE) && isalpha(ascii)) {
				ascii = (KeyASCIIType)toupper(ascii);
			}

			if ((!(EditFlags & NUMERIC) || !isdigit(ascii)) &&
				(!(EditFlags & ALPHA) || !isalpha(ascii)) &&
				(!(EditFlags & MISC) || isalnum(ascii)) &&
				ascii != ' ') {
					break;
			}

			/*
			**	The character passed all legality checks, so add it to the edit string
			**	and flag this gadget to be redrawn. The manual flag to redraw is needed
			**	because the event flag has been cleared. This prevents the gadget's ID
			**	number from being returned just because the gadget has been edited.
			*/
			String[Length++] = ascii;
			String[Length] = '\0';
			Flag_To_Redraw();
			break;
	}
	return(true);
}