mmdolze
a151ee0fc4
1. Use <stdbool.h> if it is available but keep a compatibility shim in
shared/defines.h in case it is not.
2. Unbreak the circular header dependencies (mostly):
2a. client.c and client.h may NOT depend on 'struct Menu'. Use a void pointer
and casts instead.
2b. Separate the data type definitions in client.h and screen.h from
function prototypes which may require other data structures. This makes
header dependencies much more easy to maintain. Usually the data types
should have been moved to their own files but I (mmdolze) chose to
separate them using different header guards.
2c. Remove many now unused header includes.
Apply (old BSD-) style on menuscreens.c.
125 lines
3.6 KiB
C
125 lines
3.6 KiB
C
/** \file server/menu.h
|
|
* Defines all the menu data and actions.
|
|
*/
|
|
|
|
/* This file is part of LCDd, the lcdproc server.
|
|
*
|
|
* This file is released under the GNU General Public License.
|
|
* Refer to the COPYING file distributed with this package.
|
|
*
|
|
* Copyright (c) 1999, William Ferrell, Selene Scriven
|
|
* 2004, F5 Networks, Inc. - IP-address input
|
|
* 2005, Peter Marschall - error checks, ...
|
|
*/
|
|
|
|
#ifndef MENU_H
|
|
#define MENU_H
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
# include "config.h"
|
|
#endif
|
|
#ifdef HAVE_STDBOOL_H
|
|
# include <stdbool.h>
|
|
#endif
|
|
#include "shared/defines.h"
|
|
|
|
#include "shared/LL.h"
|
|
#include "menuitem.h"
|
|
|
|
/** A Menu is a MenuItem too.
|
|
* This definition is only for better understanding of this code.
|
|
*/
|
|
typedef MenuItem Menu;
|
|
|
|
/** Creates a new menu. */
|
|
Menu *menu_create(char *id, MenuEventFunc(*event_func),
|
|
char *text, Client *client);
|
|
|
|
/** Deletes menu from memory.
|
|
* Destructors will be called for all subitems.
|
|
* DO NOT CALL THIS FUNCTION, CALL menuitem_destroy INSTEAD !
|
|
*/
|
|
void menu_destroy(Menu *menu);
|
|
|
|
/** Adds an item to the menu */
|
|
void menu_add_item(Menu *menu, MenuItem *item);
|
|
|
|
/** Removes an item from the menu (does not destroy it) */
|
|
void menu_remove_item(Menu *menu, MenuItem *item);
|
|
|
|
/** Destroys and removes all items from the menu */
|
|
void menu_destroy_all_items(Menu *menu);
|
|
|
|
/** Enumeration function.
|
|
* Retrieves the first item from the list of items in the menu.
|
|
*/
|
|
static inline MenuItem *menu_getfirst_item(Menu *menu)
|
|
{
|
|
return (MenuItem*) ((menu != NULL)
|
|
? LL_GetFirst(menu->data.menu.contents)
|
|
: NULL);
|
|
}
|
|
|
|
/** Enumeration function.
|
|
* Retrieves the next item from the list of items in the menu.
|
|
* No other menu calls should be made between menu_first_item() and
|
|
* this function, to keep the list-cursor where it is.
|
|
*/
|
|
static inline MenuItem *menu_getnext_item(Menu *menu)
|
|
{
|
|
return (MenuItem*) ((menu != NULL)
|
|
? LL_GetNext(menu->data.menu.contents)
|
|
: NULL);
|
|
}
|
|
|
|
/** Retrieves the current (non-hidden) item from the list of items in the
|
|
* menu. */
|
|
MenuItem *menu_get_current_item(Menu *menu);
|
|
|
|
/** Finds an item in the menu by the given id. */
|
|
MenuItem *menu_find_item(Menu *menu, char *id, bool recursive);
|
|
|
|
/** sets the association member of a Menu. */
|
|
void menu_set_association(Menu *menu, void *assoc);
|
|
|
|
/** Resets it to initial state.
|
|
* DO NOT CALL THIS FUNCTION, CALL menuitem_reset_screen INSTEAD !
|
|
*/
|
|
void menu_reset(Menu *menu);
|
|
|
|
/** Builds the selected menuitem on screen using widgets.
|
|
* DO NOT CALL THIS FUNCTION, CALL menuitem_rebuild_screen INSTEAD !
|
|
*/
|
|
void menu_build_screen(Menu *menu, Screen *s);
|
|
|
|
/** Updates the widgets of the selected menuitem
|
|
* DO NOT CALL THIS FUNCTION, CALL menuitem_update_screen INSTEAD !
|
|
*/
|
|
void menu_update_screen(Menu *menu, Screen *s);
|
|
|
|
/**
|
|
* For predecessor-Check: returns selected subitem of menu if this subitem
|
|
* has no own screen (action, checkbox, ...) and this subitem has a
|
|
* predecessor and menu otherwise.
|
|
*
|
|
* @return NULL on error. */
|
|
MenuItem *menu_get_item_for_predecessor_check(Menu *menu);
|
|
|
|
/**
|
|
* For successor-Check: returns selected subitem of menu if
|
|
* this subitem has no own screen (action, checkbox, ...) or menu
|
|
* otherwise.
|
|
*
|
|
* @return NULL on error. */
|
|
MenuItem *menu_get_item_for_successor_check(Menu *menu);
|
|
|
|
/** Does something with the given input.
|
|
* key is only used if token is MENUTOKEN_OTHER.
|
|
* DO NOT CALL THIS FUNCTION, CALL menuitem_process_input INSTEAD !
|
|
*/
|
|
MenuResult menu_process_input(Menu *menu, MenuToken token, const char *key, unsigned int keymask);
|
|
|
|
/** positions current item pointer on subitem item_id. */
|
|
void menu_select_subitem(Menu *menu, char *item_id);
|
|
#endif
|