menu.h

Go to the documentation of this file.

/*
 * File:        menu.h
 * Purpose:     Menu functions header
 * Author:      Peter Ivanov
 * Modified by:
 * Created:     2007-05-19 11:31:29
 * Last modify: 2007-10-21 11:31:45 ivanovp {Time-stamp}
 * Copyright:   (C) Peter Ivanov, 2007
 * Licence:     GPL
 */
/**
 * \file menu.h
 * \brief Menu functions header
 * \author Peter Ivanov
 */
#ifndef __INCLUDE_MENU_H
#define __INCLUDE_MENU_H

#include <sys/types.h>

typedef struct menuPoint_t menuPoint_t;

/**
 * Struct for storing a menu point.
 *
 * @author Peter Ivanov
 */
struct menuPoint_t
{
    /**
     * Title of menu to display. Must be seven characters long!
     */
    char* menuTitle;

    /**
     * Sub-menu to invoke if menu is selected. 
     * You should set only one option of subMenu and menuHandlerCallback!
     */
    menuPoint_t* subMenu;

    /**
     * Function to call if menu is selected.
     * You should set only one option of subMenu and menuHandlerCallback!
     */
    void (*menuHandlerCallback) ();
};

/// Maximum level of menu depth
#define MENU_MAX_LEVEL          4
/// Maximum number of menu items on a level
#define MENU_MAX_MENU_ITEMS     255

extern menuPoint_t* currentMenu;
extern uint8_t currentMenuNumber;      ///< number of selected menu item
extern uint8_t currentMenuSize;        ///< number of menu items in actual menu point
extern int8_t currentMenuLevel;
extern menuPoint_t* parentMenu[MENU_MAX_LEVEL];
extern uint8_t parentMenuNumber[MENU_MAX_LEVEL];

/**
 * Initialize menu system. After this you should call MENU_handler
 * periodically.
 * Example:
<pre>
menuPoint_t rootMenu[] = 
{
    //1234567   sub-menu        callback function
    {"NRFTEST", NULL,           rf24lTest},
    {"IR TEST", NULL,           irTest},
    {"SET CLK", setClockMenu,   NULL},
    {"SET ALM", setAlarmMenu,   NULL},
    {NULL,      NULL,           NULL}   // end of menu
};

int main ()
{
    // ...
    MENU_init (rootMenu);
}
</pre>
 *
 * @author Peter Ivanov
 *
 * @param rootMenu Pointer to root menu.
 */
void MENU_init (menuPoint_t* rootMenu);

/**
 * Internally used function to print the actual menu item.
 *
 * @author Peter Ivanov
 */
void MENU_showCurrentMenuItem ();

/**
 * Internally used function to count the size of a menu.
 *
 * @author Peter Ivanov
 *
 * @param menu Pointer to menu.
 * @return Number of menu elements.
 */
uint8_t MENU_getMenuSize (menuPoint_t* menu);

/**
 * This function handles the events which comes from keyboard.
 * Before using this function, you should initialize the menu system. 
 * @see MENU_init
 *
 * Example:
<pre>
while (1) 
{
    buttonHandler ();
    if (buttonPressed)
    {
        MENU_handler (buttonPressed);
    }
    // ...
}
</pre>
 *
 * @author Peter Ivanov
 * 
 * @param buttonPressed The buttons which are pressed meanwhile.
 */
void MENU_handler (uint8_t buttonPressed);

#endif // __INCLUDE_MENU_H

---