lbbs/include/menu.h

/* SPDX-License-Identifier: GPL-3.0-or-later */
/*
 * menu
 *   - configurable user interactive menu feature
 *
 * Copyright (C) 2004-2025  Leaflet <leaflet@leafok.com>
 */

#ifndef _MENU_H_
#define _MENU_H_

#include "bbs_cmd.h"
#include "common.h"
#include "trie_dict.h"
#include <stdint.h>

enum menu_constant_t
{
        MAX_MENU_NAME_LENGTH = 30,
        MAX_ITEMS_PER_MENU = 256,
        MAX_MENUITEM_NAME_LENGTH = 256,
        MAX_MENUITEM_TEXT_LENGTH = 200,
        MAX_MENUITEM_ACTION_LENGTH = 30,
        MAX_MENUTITLE_TEXT_LENGTH = 100,
        MAX_MENU_SCR_NAME_LENGTH = 20,
        MAX_MENU_SCR_BUF_LENGTH = 2000,
        MAX_MENUS = 256,
        MAX_MENUITEMS = 5120,
        MAX_MENU_DEPTH = 50,
};

typedef uint64_t MENU_ID;
typedef uint64_t MENU_ITEM_ID;
typedef uint64_t MENU_SCREEN_ID;

struct menu_item_t
{
        int16_t row, col;
        char action[MAX_MENUITEM_ACTION_LENGTH];
        MENU_ID action_menu_id;
        bbs_cmd_handler action_cmd_handler;
        int8_t submenu;
        int priv, level;
        char name[MAX_MENUITEM_NAME_LENGTH];
        char text[MAX_MENUITEM_TEXT_LENGTH];
};
typedef struct menu_item_t MENU_ITEM;

struct menu_title_t
{
        int16_t row, col;
        int8_t show;
        char text[MAX_MENUTITLE_TEXT_LENGTH];
};
typedef struct menu_title_t MENU_TITLE;

struct menu_screen_t
{
        char name[MAX_MENU_SCR_NAME_LENGTH];
        int64_t buf_offset;
        int64_t buf_length;
};
typedef struct menu_screen_t MENU_SCREEN;

struct menu_t
{
        char name[MAX_MENU_NAME_LENGTH];
        MENU_TITLE title;
        char screen_name[MAX_MENU_SCR_NAME_LENGTH];
        MENU_SCREEN_ID screen_id;
        int8_t screen_show;
        int16_t screen_row, screen_col;
        MENU_ITEM_ID items[MAX_ITEMS_PER_MENU];
        int16_t item_count;
        int16_t page_row, page_col;
        int16_t page_item_limit;
        int8_t use_filter;
        bbs_cmd_handler filter_handler;
};
typedef struct menu_t MENU;

struct menu_set_t
{
        char shm_name[FILE_PATH_LEN];
        size_t shm_size;
        void *p_reserved;
        void *p_menu_pool;
        void *p_menu_item_pool;
        void *p_menu_screen_pool;
        char *p_menu_screen_buf;
        char *p_menu_screen_buf_free;
        int16_t menu_count;
        int16_t menu_item_count;
        int16_t menu_screen_count;
        TRIE_NODE *p_menu_name_dict;
        TRIE_NODE *p_menu_screen_dict;
        MENU_ID menu_id_path[MAX_MENU_DEPTH];
        int16_t menu_item_pos[MAX_MENU_DEPTH];
        int16_t choose_step;
        int8_t menu_item_display[MAX_ITEMS_PER_MENU];
        int16_t menu_item_r_row[MAX_ITEMS_PER_MENU];
        int16_t menu_item_r_col[MAX_ITEMS_PER_MENU];
        int16_t menu_item_page_id[MAX_ITEMS_PER_MENU];
        int8_t allow_exit;
};
typedef struct menu_set_t MENU_SET;

extern MENU_SET bbs_menu;
extern MENU_SET top10_menu;

extern int load_menu(MENU_SET *p_menu_set, const char *conf_file);
extern int unload_menu(MENU_SET *p_menu_set);

extern int get_menu_shm_readonly(MENU_SET *p_menu_set);
extern int set_menu_shm_readonly(MENU_SET *p_menu_set);
extern int detach_menu_shm(MENU_SET *p_menu_set);

extern int display_menu_cursor(MENU_SET *p_menu_set, int show);
extern int menu_control(MENU_SET *p_menu_set, int key);
extern int display_menu(MENU_SET *p_menu_set);

inline MENU *get_menu(MENU_SET *p_menu_set, const char *menu_name)
{
        MENU *value = NULL;

        trie_dict_get(p_menu_set->p_menu_name_dict, menu_name, (int64_t *)&value);

        return ((MENU *)value);
}

inline MENU *get_menu_by_id(MENU_SET *p_menu_set, MENU_ID menu_id)
{
        if (menu_id < 0 || menu_id >= p_menu_set->menu_count)
        {
                return NULL;
        }

        return (MENU *)((char *)(p_menu_set->p_menu_pool) + sizeof(MENU) * menu_id);
}

inline MENU_ITEM *get_menu_item_by_id(MENU_SET *p_menu_set, MENU_ITEM_ID menu_item_id)
{
        if (menu_item_id < 0 || menu_item_id >= p_menu_set->menu_item_count)
        {
                return NULL;
        }

        return (MENU_ITEM *)((char *)(p_menu_set->p_menu_item_pool) + sizeof(MENU_ITEM) * menu_item_id);
}

inline MENU_SCREEN *get_menu_screen_by_id(MENU_SET *p_menu_set, MENU_SCREEN_ID menu_screen_id)
{
        if (menu_screen_id < 0 || menu_screen_id >= p_menu_set->menu_screen_count)
        {
                return NULL;
        }

        return (MENU_SCREEN *)((char *)(p_menu_set->p_menu_screen_pool) + sizeof(MENU_ITEM) * menu_screen_id);
}

#endif //_MENU_H_
1	sysadm	1.32	/* SPDX-License-Identifier: GPL-3.0-or-later */
2			/*
3			* menu
4			* - configurable user interactive menu feature
5			*
6	sysadm	1.33	* Copyright (C) 2004-2025 Leaflet <leaflet@leafok.com>
7	sysadm	1.32	*/
8	sysadm	1.1
9	sysadm	1.7	#ifndef _MENU_H_
10			#define _MENU_H_
11
12	sysadm	1.26	#include "bbs_cmd.h"
13	sysadm	1.11	#include "common.h"
14	sysadm	1.15	#include "trie_dict.h"
15	sysadm	1.16	#include <stdint.h>
16	sysadm	1.11
17	sysadm	1.34	enum menu_constant_t
18			{
19			MAX_MENU_NAME_LENGTH = 30,
20			MAX_ITEMS_PER_MENU = 256,
21			MAX_MENUITEM_NAME_LENGTH = 256,
22			MAX_MENUITEM_TEXT_LENGTH = 200,
23			MAX_MENUITEM_ACTION_LENGTH = 30,
24			MAX_MENUTITLE_TEXT_LENGTH = 100,
25			MAX_MENU_SCR_NAME_LENGTH = 20,
26			MAX_MENU_SCR_BUF_LENGTH = 2000,
27			MAX_MENUS = 256,
28			MAX_MENUITEMS = 5120,
29			MAX_MENU_DEPTH = 50,
30			};
31	sysadm	1.1
32	sysadm	1.16	typedef uint64_t MENU_ID;
33			typedef uint64_t MENU_ITEM_ID;
34			typedef uint64_t MENU_SCREEN_ID;
35
36	sysadm	1.14	struct menu_item_t
37	sysadm	1.5	{
38	sysadm	1.17	int16_t row, col;
39	sysadm	1.20	char action[MAX_MENUITEM_ACTION_LENGTH];
40	sysadm	1.16	MENU_ID action_menu_id;
41	sysadm	1.18	bbs_cmd_handler action_cmd_handler;
42	sysadm	1.17	int8_t submenu;
43	sysadm	1.16	int priv, level;
44	sysadm	1.20	char name[MAX_MENUITEM_NAME_LENGTH];
45			char text[MAX_MENUITEM_TEXT_LENGTH];
46	sysadm	1.1	};
47	sysadm	1.14	typedef struct menu_item_t MENU_ITEM;
48	sysadm	1.2
49	sysadm	1.14	struct menu_title_t
50	sysadm	1.5	{
51	sysadm	1.16	int16_t row, col;
52			int8_t show;
53	sysadm	1.20	char text[MAX_MENUTITLE_TEXT_LENGTH];
54	sysadm	1.2	};
55	sysadm	1.14	typedef struct menu_title_t MENU_TITLE;
56	sysadm	1.2
57	sysadm	1.14	struct menu_screen_t
58	sysadm	1.5	{
59	sysadm	1.16	char name[MAX_MENU_SCR_NAME_LENGTH];
60			int64_t buf_offset;
61			int64_t buf_length;
62	sysadm	1.2	};
63	sysadm	1.14	typedef struct menu_screen_t MENU_SCREEN;
64	sysadm	1.1
65	sysadm	1.14	struct menu_t
66	sysadm	1.5	{
67	sysadm	1.20	char name[MAX_MENU_NAME_LENGTH];
68	sysadm	1.9	MENU_TITLE title;
69	sysadm	1.19	char screen_name[MAX_MENU_SCR_NAME_LENGTH];
70	sysadm	1.16	MENU_SCREEN_ID screen_id;
71			int8_t screen_show;
72			int16_t screen_row, screen_col;
73			MENU_ITEM_ID items[MAX_ITEMS_PER_MENU];
74			int16_t item_count;
75	sysadm	1.21	int16_t page_row, page_col;
76			int16_t page_item_limit;
77	sysadm	1.24	int8_t use_filter;
78			bbs_cmd_handler filter_handler;
79	sysadm	1.1	};
80	sysadm	1.14	typedef struct menu_t MENU;
81	sysadm	1.1
82	sysadm	1.14	struct menu_set_t
83	sysadm	1.5	{
84	sysadm	1.35	char shm_name[FILE_PATH_LEN];
85			size_t shm_size;
86	sysadm	1.16	void *p_reserved;
87			void *p_menu_pool;
88			void *p_menu_item_pool;
89			void *p_menu_screen_pool;
90			char *p_menu_screen_buf;
91			char *p_menu_screen_buf_free;
92			int16_t menu_count;
93			int16_t menu_item_count;
94			int16_t menu_screen_count;
95	sysadm	1.15	TRIE_NODE *p_menu_name_dict;
96	sysadm	1.16	TRIE_NODE *p_menu_screen_dict;
97			MENU_ID menu_id_path[MAX_MENU_DEPTH];
98			int16_t menu_item_pos[MAX_MENU_DEPTH];
99			int16_t choose_step;
100	sysadm	1.17	int8_t menu_item_display[MAX_ITEMS_PER_MENU];
101			int16_t menu_item_r_row[MAX_ITEMS_PER_MENU];
102			int16_t menu_item_r_col[MAX_ITEMS_PER_MENU];
103	sysadm	1.21	int16_t menu_item_page_id[MAX_ITEMS_PER_MENU];
104	sysadm	1.27	int8_t allow_exit;
105	sysadm	1.2	};
106	sysadm	1.14	typedef struct menu_set_t MENU_SET;
107	sysadm	1.5
108	sysadm	1.28	extern MENU_SET bbs_menu;
109	sysadm	1.30	extern MENU_SET top10_menu;
110	sysadm	1.4
111	sysadm	1.9	extern int load_menu(MENU_SET p_menu_set, const char conf_file);
112	sysadm	1.16	extern int unload_menu(MENU_SET *p_menu_set);
113
114	sysadm	1.27	extern int get_menu_shm_readonly(MENU_SET *p_menu_set);
115	sysadm	1.22	extern int set_menu_shm_readonly(MENU_SET *p_menu_set);
116			extern int detach_menu_shm(MENU_SET *p_menu_set);
117	sysadm	1.16
118	sysadm	1.23	extern int display_menu_cursor(MENU_SET *p_menu_set, int show);
119	sysadm	1.16	extern int menu_control(MENU_SET *p_menu_set, int key);
120			extern int display_menu(MENU_SET *p_menu_set);
121
122			inline MENU get_menu(MENU_SET p_menu_set, const char *menu_name)
123			{
124			MENU *value = NULL;
125	sysadm	1.10
126	sysadm	1.16	trie_dict_get(p_menu_set->p_menu_name_dict, menu_name, (int64_t *)&value);
127	sysadm	1.10
128	sysadm	1.16	return ((MENU *)value);
129			}
130	sysadm	1.10
131	sysadm	1.16	inline MENU get_menu_by_id(MENU_SET p_menu_set, MENU_ID menu_id)
132			{
133			if (menu_id < 0 \|\| menu_id >= p_menu_set->menu_count)
134			{
135			return NULL;
136			}
137
138	sysadm	1.31	return (MENU )((char )(p_menu_set->p_menu_pool) + sizeof(MENU) * menu_id);
139	sysadm	1.16	}
140
141			inline MENU_ITEM get_menu_item_by_id(MENU_SET p_menu_set, MENU_ITEM_ID menu_item_id)
142			{
143			if (menu_item_id < 0 \|\| menu_item_id >= p_menu_set->menu_item_count)
144			{
145			return NULL;
146			}
147	sysadm	1.10
148	sysadm	1.31	return (MENU_ITEM )((char )(p_menu_set->p_menu_item_pool) + sizeof(MENU_ITEM) * menu_item_id);
149	sysadm	1.16	}
150	sysadm	1.10
151	sysadm	1.16	inline MENU_SCREEN get_menu_screen_by_id(MENU_SET p_menu_set, MENU_SCREEN_ID menu_screen_id)
152			{
153			if (menu_screen_id < 0 \|\| menu_screen_id >= p_menu_set->menu_screen_count)
154			{
155			return NULL;
156			}
157	sysadm	1.10
158	sysadm	1.31	return (MENU_SCREEN )((char )(p_menu_set->p_menu_screen_pool) + sizeof(MENU_ITEM) * menu_screen_id);
159	sysadm	1.16	}
160	sysadm	1.4
161	sysadm	1.7	#endif //_MENU_H_
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1