/[LeafOK_CVS]/lbbs/include/menu.h
ViewVC logotype

Contents of /lbbs/include/menu.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.34 - (show annotations)
Wed Nov 5 03:01:14 2025 UTC (4 months, 1 week ago) by sysadm
Branch: MAIN
Changes since 1.33: +14 -11 lines
Content type: text/x-chdr
Use enum / const int instead of macro define constant integers

1 /* SPDX-License-Identifier: GPL-3.0-or-later */
2 /*
3 * menu
4 * - configurable user interactive menu feature
5 *
6 * Copyright (C) 2004-2025 Leaflet <leaflet@leafok.com>
7 */
8
9 #ifndef _MENU_H_
10 #define _MENU_H_
11
12 #include "bbs_cmd.h"
13 #include "common.h"
14 #include "trie_dict.h"
15 #include <stdint.h>
16
17 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
32 typedef uint64_t MENU_ID;
33 typedef uint64_t MENU_ITEM_ID;
34 typedef uint64_t MENU_SCREEN_ID;
35
36 struct menu_item_t
37 {
38 int16_t row, col;
39 char action[MAX_MENUITEM_ACTION_LENGTH];
40 MENU_ID action_menu_id;
41 bbs_cmd_handler action_cmd_handler;
42 int8_t submenu;
43 int priv, level;
44 char name[MAX_MENUITEM_NAME_LENGTH];
45 char text[MAX_MENUITEM_TEXT_LENGTH];
46 };
47 typedef struct menu_item_t MENU_ITEM;
48
49 struct menu_title_t
50 {
51 int16_t row, col;
52 int8_t show;
53 char text[MAX_MENUTITLE_TEXT_LENGTH];
54 };
55 typedef struct menu_title_t MENU_TITLE;
56
57 struct menu_screen_t
58 {
59 char name[MAX_MENU_SCR_NAME_LENGTH];
60 int64_t buf_offset;
61 int64_t buf_length;
62 };
63 typedef struct menu_screen_t MENU_SCREEN;
64
65 struct menu_t
66 {
67 char name[MAX_MENU_NAME_LENGTH];
68 MENU_TITLE title;
69 char screen_name[MAX_MENU_SCR_NAME_LENGTH];
70 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 int16_t page_row, page_col;
76 int16_t page_item_limit;
77 int8_t use_filter;
78 bbs_cmd_handler filter_handler;
79 };
80 typedef struct menu_t MENU;
81
82 struct menu_set_t
83 {
84 int shmid;
85 void *p_reserved;
86 void *p_menu_pool;
87 void *p_menu_item_pool;
88 void *p_menu_screen_pool;
89 char *p_menu_screen_buf;
90 char *p_menu_screen_buf_free;
91 int16_t menu_count;
92 int16_t menu_item_count;
93 int16_t menu_screen_count;
94 TRIE_NODE *p_menu_name_dict;
95 TRIE_NODE *p_menu_screen_dict;
96 MENU_ID menu_id_path[MAX_MENU_DEPTH];
97 int16_t menu_item_pos[MAX_MENU_DEPTH];
98 int16_t choose_step;
99 int8_t menu_item_display[MAX_ITEMS_PER_MENU];
100 int16_t menu_item_r_row[MAX_ITEMS_PER_MENU];
101 int16_t menu_item_r_col[MAX_ITEMS_PER_MENU];
102 int16_t menu_item_page_id[MAX_ITEMS_PER_MENU];
103 int8_t allow_exit;
104 };
105 typedef struct menu_set_t MENU_SET;
106
107 extern MENU_SET bbs_menu;
108 extern MENU_SET top10_menu;
109
110 extern int load_menu(MENU_SET *p_menu_set, const char *conf_file);
111 extern int unload_menu(MENU_SET *p_menu_set);
112
113 extern int get_menu_shm_readonly(MENU_SET *p_menu_set);
114 extern int set_menu_shm_readonly(MENU_SET *p_menu_set);
115 extern int detach_menu_shm(MENU_SET *p_menu_set);
116
117 extern int display_menu_cursor(MENU_SET *p_menu_set, int show);
118 extern int menu_control(MENU_SET *p_menu_set, int key);
119 extern int display_menu(MENU_SET *p_menu_set);
120
121 inline MENU *get_menu(MENU_SET *p_menu_set, const char *menu_name)
122 {
123 MENU *value = NULL;
124
125 trie_dict_get(p_menu_set->p_menu_name_dict, menu_name, (int64_t *)&value);
126
127 return ((MENU *)value);
128 }
129
130 inline MENU *get_menu_by_id(MENU_SET *p_menu_set, MENU_ID menu_id)
131 {
132 if (menu_id < 0 || menu_id >= p_menu_set->menu_count)
133 {
134 return NULL;
135 }
136
137 return (MENU *)((char *)(p_menu_set->p_menu_pool) + sizeof(MENU) * menu_id);
138 }
139
140 inline MENU_ITEM *get_menu_item_by_id(MENU_SET *p_menu_set, MENU_ITEM_ID menu_item_id)
141 {
142 if (menu_item_id < 0 || menu_item_id >= p_menu_set->menu_item_count)
143 {
144 return NULL;
145 }
146
147 return (MENU_ITEM *)((char *)(p_menu_set->p_menu_item_pool) + sizeof(MENU_ITEM) * menu_item_id);
148 }
149
150 inline MENU_SCREEN *get_menu_screen_by_id(MENU_SET *p_menu_set, MENU_SCREEN_ID menu_screen_id)
151 {
152 if (menu_screen_id < 0 || menu_screen_id >= p_menu_set->menu_screen_count)
153 {
154 return NULL;
155 }
156
157 return (MENU_SCREEN *)((char *)(p_menu_set->p_menu_screen_pool) + sizeof(MENU_ITEM) * menu_screen_id);
158 }
159
160 #endif //_MENU_H_

webmaster@leafok.com
ViewVC Help
Powered by ViewVC 1.3.0-beta1