egi_surfcontrols.h

/*---------------------------------------------------------------------
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.


Midas Zhou
midaszhou@yahoo.com(Not in use since 2022_03_01)
---------------------------------------------------------------------*/
#ifndef __EGI_SURFCONTROLS_H__
#define __EGI_SURFCONTROLS_H__

#include "egi_fbdev.h"
#include "egi_image.h"
#include "egi_FTsymbol.h"

/* Extern type definition, as in egi_surface.h */
typedef struct egi_surface_user		EGI_SURFUSER;

/* Type definition */
typedef struct egi_surface_box		ESURF_BOX;
typedef struct egi_surface_label	ESURF_LABEL;
typedef struct egi_surface_button	ESURF_BTN;
typedef struct egi_surface_tickbox	ESURF_TICKBOX;
typedef struct egi_surface_listbox	ESURF_LISTBOX;

typedef struct egi_menu_item 		EGI_MENUITEM;
typedef struct egi_surface_menulist	ESURF_MENULIST;


/***
			--- An EGI_SURFACE_BOX ---
 1. A simple box on surface.
*/
struct egi_surface_box {
	int		x0;	/* Origin position relative to its container */
	int		y0;
	EGI_IMGBUF	*imgbuf;

	/* Reactions / Operations */
	// On_Touch:
	// On_Click:
	// On_dblClick:

	unsigned char data[];
};
ESURF_BOX 	*egi_surfBox_create(EGI_IMGBUF *imgbuf, int xi, int yi, int x0, int y0, int w, int h);
void 	egi_surfBox_free(ESURF_BOX **box);
bool 	egi_point_on_surfBox(const ESURF_BOX *box, int x, int y);
void 	egi_surfBox_writeFB(FBDEV *fbdev, const ESURF_BOX *box,  int cx0, int cy0);


/***
			--- An EGI_SURFACE_LABEL ---
 1. A simple label on surface.
*/
struct egi_surface_label {
	int		x0;	/* Origin position relative to its container */
	int		y0;
	EGI_IMGBUF	*imgbuf;	/* As bk image */

	EGI_IMGBUF	*imgbuf_effect;  /* effect/hightlight image */
	int		w;	/* Width and heigh for text, in case imgbuf==NULL. */
	int		h;
#define ESURF_LABTEXT_MAX	512
	char		text[ESURF_LABTEXT_MAX];	/* content */
	EGI_IMGBUF	*front_imgbuf;	/* As front image, under TEXT.
					 * NOW: A ref. pointer only!
					 */

	/* Reactions / Operations */
	// On_Touch:
	// On_Click:
	// On_dblClick:
};
ESURF_LABEL 	*egi_surfLab_create(EGI_IMGBUF *imgbuf, int xi, int yi, int x0, int y0, int w, int h);
void 	egi_surfLab_free(ESURF_LABEL **lab);
void 	egi_surfLab_writeFB(FBDEV *fbdev, const ESURF_LABEL *lab, FT_Face face, int fw, int fh, EGI_16BIT_COLOR color, int cx0, int cy0);
void 	egi_surfLab_updateText( ESURF_LABEL *lab, const char *fmt, ... );

/***
			--- An EGI_SURFACE_BUTTON ---
 1. A simple button on surface.
*/
enum {
	SURFBTN_IMGBUF_NORMAL  =0,
	SURFBTN_IMGBUF_EFFECT  =1,
	SURFBTN_IMGBUF_PRESSED =2,
};
struct egi_surface_button {
	int		x0;	/* Origin position relative to its container */
	int		y0;
	EGI_IMGBUF	*imgbuf; /* To hold normal button image */
				 /* OR: Use its subimg to hold effect/pressed/... images */

	EGI_IMGBUF	*imgbuf_effect;  /* Partial OR whole size */
	EGI_IMGBUF	*imgbuf_pressed;
	bool		pressed;
	/* Reactions / Operations */
	// On_Touch:
	// On_Click:
	// On_dblClick:
};
ESURF_BTN *egi_surfBtn_create(EGI_IMGBUF *imgbuf, int xi, int yi, int x0, int y0, int w, int h);
void 	egi_surfBtn_free(ESURF_BTN **sbtn);
void    egi_surfBtn_writeFB(FBDEV *fbdev, const ESURF_BTN *btn, int type, int cx0, int cy0);
bool 	egi_point_on_surfBtn(const ESURF_BTN *sbtn, int x, int y);


/***
			--- An EGI_SURFACE_TICKBOX ---
 1. A simple TickBox on surface.
*/
struct egi_surface_tickbox {
	int		x0;	/* Origin position relative to its container */
	int		y0;
	EGI_IMGBUF	*imgbuf_unticked;  /* BOX size included */

	EGI_IMGBUF	*imgbuf_ticked;	   /* To create based on imgbuf_unticked */
	bool		ticked;

	/* Reactions / Operations */
	// On_Click:
};
ESURF_TICKBOX *egi_surfTickBox_create(EGI_IMGBUF *imgbuf, int xi, int yi, int x0, int y0, int w, int h);
void 	egi_surfTickBox_free(ESURF_TICKBOX **tbox);
bool 	egi_point_on_surfTickBox(const ESURF_TICKBOX *tbox, int x, int y);
void 	egi_surfTickBox_writeFB(FBDEV *fbdev, const ESURF_TICKBOX *tbox,  int cx0, int cy0);


/***
			--- An EGI_SURFACE_MENULIST ---
 1. A control of MenuList (on surface). A MenuList consists of certain number of MenuItems,
    with description on it, and linked to a SURFPROG.
 2. If a MenuItem in a MenuList links to a sub_MenuList, it is called a NodeItem.
 3. A sub_MenuList has a node number, which is the item index of its upper/parent MenuList.
 4. A MenuList Tree consists of sub_MenuLists linked finally to a root MenuList.

			--- Behaviours ---
 1. Cursor hovers over an NodeItem to expand it, while hovers over an MenuItems to make
    that sub_MenuList as the last visible one.
 2. Click on an MenuItems to run its linked script/program.
 3. Click on an NodeItem to close/disappear the whole MenuList Tree.
 5. RightClick to close/disappear the whole MenuList Tree.
 6. Click elsewhere to close/disappear the whole MenuList Tree.

			!!! --- WARNING --- !!!
 5. A MenuList tree MUST be assmebled/built from end branch sub_MenuLists to the root MenuList.

 6. A Selection Tree is the path of menu selection, all selected sub_MenuLists are visibly expanded.
 7. A root MenuList maintains a path[] to map out the selection MenuList tree.
 8. The ROOT MenuList and the END MenuList shares the same fidx value, which is the index of the final selected MenuItem.
 9. A NodeItem is not like a MenuItem, when it's selected/touched, it expends linked submenulist, but the fidx is always -1!
 10. Menu_selection is a Top_Layer_Operation, it takes all events exclusively.
*/

/* EGI_MENUITEM: free operation in _surfMenuList_free */
struct egi_menu_item {
#define EGI_MENU_DESCRIPT_MAXLEN 256
	int 		id;		/* >0! The unique number to identify a MenuItem in the WHOLE menulist tree!  MidasHK_2022-05-03
					 * It will pass out through SURFUSER.retval to the Owner/Caller of the menusurface.
					 */
	char 		*descript;	/* Menu description, displaying on the menu item */
	bool		ticked;		/* TBD */
	bool		valid;		/* TBD */

	ESURF_MENULIST	*mlist;		/* Links to a ESURF_MENULIST
					 * 1. If mlist==NULL: it's a MenuItem.
					 * 2. If mlist!=NULL: it's a NodeItem, and fdix=-1 for selection!
				         */
	const char	*run_script;	/* ESURF_PROG prog_path + argv */
};

/* ESURF_MENULIST */
struct egi_surface_menulist {
	int 		mode;		/* A mode defines the postion of the root MenuList and its growth/path orientation.
				         * Root at one corner of a rectangle, and grows diagonally!
					 */
#define MENULIST_ROOTMODE_LEFT_BOTTOM		0  /* Root at Left_bottom corner, grow up to right_top corner. */
#define MENULIST_ROOTMODE_RIGHT_BOTTOM		1
#define MENULIST_ROOTMODE_LEFT_TOP		2
#define MENULIST_ROOTMODE_RIGHT_TOP		3

	bool		root;		/* True: If a root MenuList */
	int		node;		/* Node numeber, For a sub_MenuList: as the item index of its upper/parent MenuList.
					 * Init. as -1, NOT a NodeItem.
					 */

	int 		x0;		/* For the root MenuList: Origin coordinates, relative to its container/screen. */
	int 		y0;		/* For sub MenuList, if offset from normal aligment position. usually set y0 only.
					 * As normal alignment: first MenuItem of the expanded sub_MenuList shall align with
					 * the linked NodeItem.
					 *		    --  --
					 *		--  --> --
					 *		--> --
					 *		--
					 *	    --> --
					 *	    --
					 *	   (LEFT_BOTTOM ROOT)
					 */

	int 		mw;		/* Size for each menu piece. */
	int 		mh;
#define ESURF_MENULIST_OVERLAP	  5  	/* horizontal overlap value between two nearby MenuLists */

	FT_Face 	face;		/* Font face */
	int		fw;		/* font size, default as 12.  */
	int		fh;

	/* Colors */
#define ESURF_MENULIST_BKGCOLOR		WEGI_COLOR_GRAY5; //DARKGRAY
	EGI_16BIT_COLOR bkgcolor;	/* Menu base color, BKG color */
#define ESURF_MENULIST_SIDECOLOR	WEGI_COLOR_GRAY2;
	EGI_16BIT_COLOR sidecolor;	/* Color for side/edge lines */
#define ESURF_MENULIST_HLTCOLOR		WEGI_COLOR_ORANGE
	EGI_16BIT_COLOR hltcolor;	/* Highlight color */
#define ESURF_MENULIST_FONTCOLOR        WEGI_COLOR_WHITE
	EGI_16BIT_COLOR fontcolor;	/* Font color */

	/* Items */
	EGI_MENUITEM	*mitems;	/* Pointer to menu items */
#define ESURF_MENUILIST_MITEMS_GROWSIZE	8
	unsigned int 	capacity;	/* Total capacity for mitems[] */
	int 		mcnt;		/* Total number of valid menus in mitems. */

	/* --- Following is for the root MenuList Only --- */
	int 		depth;		/* Levels of sub_MenuLists / Depth of the MenuList tree
					 * How many visible/expanded sub_MenuLists! depth of the MenuList tree.
					 *  1. Unexpanded sub_MenuLists is NOT counted in.
					 *  2. If only a root_MenuList, then depth==0!
					*/

#define ESURF_MENULIST_DEPTH_MAX	32
	//int		path[ESURF_MENULIST_DEPTH_MAX];
	ESURF_MENULIST  **path;	/* The selection tree path.
				 * An array of pointers to MenuLists, to map out current selected MenuLists tree(layout):
				 *  1. Expended/visible MenuLists: path[0]->path[1]->...->path[depth].
				 *  2. ONLY for a root_MenuList!, Init. allocated as: *path[ESURF_MENULIST_DEPTH_MAX]
				 *  3. egi_surfMenuList_create(): Init. path[0] pointer to root MenuList itself.
				 *  4. !!! Dirty data in path[] NOT cleared, use memeber 'depth' as its limit.
				 */

	int		fidx;		/* !!! Only for the root MenuList and the end MenuList, others all -1.
					 * For NodeItem, it's fidx value is always -1!
					 * 1, The final item index as of path[depth]->mitems[],
					 * 2, If <0, No item selected on current path[depth]->mitems[] ??
					 */
};
ESURF_MENULIST *egi_surfMenuList_create(int mode, bool root, int x0, int y0, int mw, int mh,
						FT_Face face, int fw, int fh, unsigned int capacity);
void	egi_surfMenuList_free(ESURF_MENULIST **mlist);
int 	egi_surfMenuList_getMaxOffset(const ESURF_MENULIST *mlist, int Ox, int Oy, int *offYU, int *offYD, int *offXR, int *offXL);
int 	egi_surfMenuList_getMaxLayoutSize(const ESURF_MENULIST *mlist, int *w, int *h);
int 	egi_surfMenuList_addItem(ESURF_MENULIST *mlist, const char *descript, ESURF_MENULIST *submlist, const char *run_script);
int 	egi_surfMenuList_getItemID(ESURF_MENULIST *mlist);
void 	egi_surfMenuList_writeFB(FBDEV *fbdev, const ESURF_MENULIST *mlist, int offx, int offy, int select_idx);
int 	egi_surfMenuList_updatePath(ESURF_MENULIST *mlist, int px, int py); /* Pick the menu item, and update path and fidx */
int 	egi_surfMenuList_runMenuProg(const ESURF_MENULIST *mlist);

/***
			--- An EGI_SURFACE_LISTBOX ---
 1. A simple ListBox with vertical scroll bar
 2. ListBoxH == ScrollBarH
*/
struct egi_surface_listbox {
	int		x0;		/* Origin position relative to its container */
	int		y0;
	EGI_IMGBUF	*imgbuf;  	/* Whole listbox area, include vertical scroll bar */
				  	/* (ListboxW + ScrollBarW) * ListBoxH */

	/* List items */
#define ESURF_LISTBOX_ITEM_MAXLEN	256
	char 		(*list)[ESURF_LISTBOX_ITEM_MAXLEN];	/* ALL item array */
					/* !!! WARNING !!!
					 * To ensure space of list[TotalItems].
		 			*/

	size_t		ListCapacity;	/* Capacity of list space, init as 16. */
#define ESURF_LISTBOX_CAPACITY_GROWSIZE	32

	int		TotalItems;	/* Total item in list[] */

	int 		FirstIdx;	/* Index of list[] for the first item displayed in ListBox, <0 Invalid.
					 * 1. Init. as -1 when ListBox created.
					 * 2. ListBox displays items from the FirstIdx item before mouse_event triggers.
					 * 3. To temprarily store first item index.
					 * 4. It changes as mouse_event scroll the ListBox.

					 * Usually FristIdx set as previous SelecteIdx.
					 */

	int		SelectIdx;	/* Index of list[] for currently selected Item, <0 Invalid.
					 * As confirmed selected item index of var_SelectIdx.
					 * 1. Init as -1 when  ListBox created.
					 * 2. When ListBox surface quits, it returns a NON_nagetive value as index of list[]
				  	 *    OR return -1, as cancelling the selection, by clicking on SURFBNT_CLOSE.
					 */
	int 		var_SelectIdx;	/* As an interim variable for listbox_mouse_event function, <0 Invalid.
					 * 1. It will be modified when mouse points to a list item in the ListBox, however
					 *    it will NOT be saved to SelectIdx, until it's clicked to confirm the selection.
					 * 2. Init. as -1 when ListBox created.
					 */
//	bool		init_mevent; 	/* It's token(0) to initlize static variables in listbox_mouse_event */

	/* Font */
	FT_Face 	face;		/* Init as egi_appfonts.regular */
	int 		fh;		/* Font Height and Width, Init as 12 */
	int		fw;

	/* For list box area */
        int 		ListBoxW; 	/* List area size, WITHOUT scroll bar */
	int 		ListBoxH;
	int		ListBarH;	/* Line spacing,  Height of each list bar */

	int		MaxViewItems; 	/* Max. items int the ListBox
					 * MaxViewItems = listbox->ListBoxH/listbox->ListBarH XXX+2! --2 for partial items.
					 */

        EGI_IMGBUF      *ListImgbuf;	/* For ListFB.virt_fb */
        FBDEV           ListFB;		/* virtual FB for list content write */

	/* For scroll bar area */
#define ESURF_LISTBOX_SCROLLBAR_WIDTH	10
        int 		ScrollBarW;	/* Size of vertical scroll area */
        int 		ScrollBarH;     /* == ListBoxH */
        //int SBx0, SBy0;      /* SCroll bar origin relative to its container. (this surface) */

	/* For scroll Guiding Block   */
	int 		pastPos;	/* Height of scroll area above the Scroll slider, stands for passed/viewed content. */
	int 		GuideBlockH;	/* control 	block height */
	int 		GuideBlockW;	/* == ScrollAreaW */
	bool		GuideBlockDownHold;  /* If GuideBlock is hold_down for dragging */

	/* Reactions / Operations */
};

ESURF_LISTBOX 	*egi_surfListBox_create(EGI_IMGBUF *imgbuf, int xi, int yi, int x0, int y0, int w, int h, int fw, int fh, int ListBarH);
void	egi_surfListBox_free(ESURF_LISTBOX **listbox);
int 	egi_surfListBox_addItem(ESURF_LISTBOX *listbox, const char *pstr);
void 	egi_surfListBox_redraw(EGI_SURFUSER *psurfuser, ESURF_LISTBOX *listbox);
int 	egi_surfListBox_adjustFirstIdx(ESURF_LISTBOX *listbox, int delt); /* FirstIdx driver pastPos */
int 	egi_surfListBox_adjustPastPos(ESURF_LISTBOX *listbox, int delt);  /* pastPos driver FirstIdx */
int 	egi_surfListBox_PxySelectItem(EGI_SURFUSER *surfuser, ESURF_LISTBOX *listbox, int px, int py);



/***
			--- An EGI_VSCROLLBAR ---
 1. A simple vertical scroll bar
*/
typedef struct egi_vscrollbar EGI_VSCROLLBAR;
struct egi_vscrollbar {
	int		x0;		/* Origin position relative to its container */
	int		y0;

#define VSCROLLBAR_BKG_COLOR	COLOR_DarkGray
#define VSCROLLBAR_BLOCK_COLOR	COLOR_LightSalmon

	EGI_16BIT_COLOR	 bkgColor;	/* scroll bar bkg color */
	EGI_16BIT_COLOR	 blockColor;	/* ScrollGuideBlock Color */


	/* Underlying data length */
	unsigned int    maxLen;		/* Max length of all data ---> takes for ScrollBarH */
	unsigned int	winLen; 	/* Window scope/length of displayed data ----> takes for GuideBlockH */
	unsigned int 	pastLen;	/* Past data length, as passed/viewed content ---> takes for pastPos */

	/* Geometrical variables */
       	int 		ScrollBarW;	/* Width of scroll area  */
        int 		ScrollBarH;     /* Hight of scroll area ---> in proportion to maxLen */
        //int SBx0, SBy0;      /* SCroll bar origin relative to its container. (this surface) */

	/* For Guiding Block. Origin at TOP.   */
	int 		GuideTopPos;	/* Height of scroll area above the Scroll slider, stands for passed/viewed content. */
	int 		GuideBlockH;	/* Height of the Block ---> in proportion to winLen */
	int 		GuideBlockW;	/* Normally same as ScrollBarW */
	bool		GuideBlockDownHold;  /* If GuideBlock is hold_down for dragging */
};
EGI_VSCROLLBAR *egi_VScrollBar_create(int x0, int y0, int height, int width);
void egi_VScrollBar_free(EGI_VSCROLLBAR **vsbar);
void egi_VScrollBar_writeFB(FBDEV* fbdev, const EGI_VSCROLLBAR *vsbar);
int egi_VScrollBar_updateValues(EGI_VSCROLLBAR *vsbar, int barH, unsigned int maxLen, unsigned int winLen, unsigned int pastLen);
bool egi_VScrollBar_pxyInVSBar(EGI_VSCROLLBAR *vsbar, int px, int py);
bool egi_VScrollBar_pxyOnGuide(EGI_VSCROLLBAR *vsbar, int px, int py);
int egi_VScrollBar_clickUpdateValues(EGI_VSCROLLBAR *vsbar, int mx, int my);
int egi_VScrollBar_dyUpdateValues(EGI_VSCROLLBAR *vsbar, int dy);

/* <<<<< Standard Common Surfaces >>>>> */
int egi_crun_stdSurfInfo(const UFT8_PCHAR name, const UFT8_PCHAR info, int x0, int y0, int sw, int sh);

#define STDSURFCONFIRM_RET_OK        0
#define STDSURFCONFIRM_RET_CANCEL    1
int egi_crun_stdSurfConfirm(const UFT8_PCHAR name, const UFT8_PCHAR info, int x0, int y0, int sw, int sh);

#endif