[freeglut] / src / Common / freeglut_menu.c

/*\r
 * freeglut_menu.c\r
 *\r
 * Pull-down menu creation and handling.\r
 *\r
 * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.\r
 * Written by Pawel W. Olszta, <olszta@sourceforge.net>\r
 * Creation date: Thu Dec 16 1999\r
 *\r
 * Permission is hereby granted, free of charge, to any person obtaining a\r
 * copy of this software and associated documentation files (the "Software"),\r
 * to deal in the Software without restriction, including without limitation\r
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,\r
 * and/or sell copies of the Software, and to permit persons to whom the\r
 * Software is furnished to do so, subject to the following conditions:\r
 *\r
 * The above copyright notice and this permission notice shall be included\r
 * in all copies or substantial portions of the Software.\r
 *\r
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS\r
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL\r
 * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
 */\r
\r
#define FREEGLUT_BUILDING_LIB\r
#include <GL/freeglut.h>\r
#include "freeglut_internal.h"\r
\r
/* -- DEFINITIONS ---------------------------------------------------------- */\r
\r
/*\r
 * FREEGLUT_MENU_FONT can be any freeglut bitmapped font.\r
 * (Stroked fonts would not be out of the question, but we'd need to alter\r
 *  code, since GLUT (hence freeglut) does not quite unify stroked and\r
 *  bitmapped font handling.)\r
 * Old UNIX/X11 GLUT (BSD, UNIX, IRIX, LINUX, HPUX, ...) used a system\r
 * font best approximated by an 18-pixel HELVETICA, I think.  MS-WINDOWS\r
 * GLUT used something closest to the 8x13 fixed-width font.  (Old\r
 * GLUT apparently uses host-system menus rather than building its own.\r
 * freeglut is building its own menus from scratch.)\r
 *\r
 * FREEGLUT_MENU_HEIGHT gives the height of ONE menu box.  This should be\r
 * the distances between two adjacent menu entries.  It should scale\r
 * automatically with the font choice, so you needn't alter it---unless you\r
 * use a stroked font.\r
 *\r
 * FREEGLUT_MENU_BORDER says how many pixels to allow around the edge of a\r
 * menu.  (It also seems to be the same as the number of pixels used as\r
 * a border around *items* to separate them from neighbors.  John says\r
 * that that wasn't the original intent...if not, perhaps we need another\r
 * symbolic constant, FREEGLUT_MENU_ITEM_BORDER, or such.)\r
 */\r
#if TARGET_HOST_MS_WINDOWS\r
#define  FREEGLUT_MENU_FONT    GLUT_BITMAP_8_BY_13\r
#else\r
#define  FREEGLUT_MENU_FONT    GLUT_BITMAP_HELVETICA_18\r
#endif\r
\r
#define  FREEGLUT_MENU_HEIGHT  (glutBitmapHeight(FREEGLUT_MENU_FONT) + \\r
                                FREEGLUT_MENU_BORDER)\r
#define  FREEGLUT_MENU_BORDER   2\r
\r
\r
/*\r
 * These variables are for rendering the freeglut menu items.\r
 *\r
 * The choices are fore- and background, with and without h for Highlighting.\r
 * Old GLUT appeared to be system-dependant for its colors (sigh) so we are\r
 * too.  These variables should be stuffed into global state and initialized\r
 * via the glutInit*() system.\r
 */\r
#if TARGET_HOST_MS_WINDOWS\r
static float menu_pen_fore  [4] = {0.0f,  0.0f,  0.0f,  1.0f};\r
static float menu_pen_back  [4] = {0.85f, 0.85f, 0.85f, 1.0f};\r
static float menu_pen_hfore [4] = {1.0f,  1.0f,  1.0f,  1.0f};\r
static float menu_pen_hback [4] = {0.15f, 0.15f, 0.45f, 1.0f};\r
#else\r
static float menu_pen_fore  [4] = {0.0f,  0.0f,  0.0f,  1.0f};\r
static float menu_pen_back  [4] = {0.70f, 0.70f, 0.70f, 1.0f};\r
static float menu_pen_hfore [4] = {0.0f,  0.0f,  0.0f,  1.0f};\r
static float menu_pen_hback [4] = {1.0f,  1.0f,  1.0f,  1.0f};\r
#endif\r
\r
\r
extern GLvoid fgPlatformGetGameModeVMaxExtent( SFG_Window* window, int* x, int* y );\r
\r
/* -- PRIVATE FUNCTIONS ---------------------------------------------------- */\r
\r
/*\r
 * Private function to find a menu entry by index\r
 */\r
static SFG_MenuEntry *fghFindMenuEntry( SFG_Menu* menu, int index )\r
{\r
    SFG_MenuEntry *entry;\r
    int i = 1;\r
\r
    for( entry = (SFG_MenuEntry *)menu->Entries.First;\r
         entry;\r
         entry = (SFG_MenuEntry *)entry->Node.Next )\r
    {\r
        if( i == index )\r
            break;\r
        ++i;\r
    }\r
\r
    return entry;\r
}\r
\r
/*\r
 * Deactivates a menu pointed by the function argument.\r
 */\r
static void fghDeactivateSubMenu( SFG_MenuEntry *menuEntry )\r
{\r
    SFG_MenuEntry *subMenuIter;\r
    /* Hide the present menu's window */\r
    fgSetWindow( menuEntry->SubMenu->Window );\r
    glutHideWindow( );\r
\r
    /* Forget about having that menu active anymore, now: */\r
    menuEntry->SubMenu->Window->ActiveMenu = NULL;\r
    menuEntry->SubMenu->IsActive = GL_FALSE;\r
    menuEntry->SubMenu->ActiveEntry = NULL;\r
\r
    /* Hide all submenu windows, and the root menu's window. */\r
    for ( subMenuIter = (SFG_MenuEntry *)menuEntry->SubMenu->Entries.First;\r
          subMenuIter;\r
          subMenuIter = (SFG_MenuEntry *)subMenuIter->Node.Next )\r
    {\r
        subMenuIter->IsActive = GL_FALSE;\r
\r
        /* Is that an active submenu by any case? */\r
        if( subMenuIter->SubMenu )\r
            fghDeactivateSubMenu( subMenuIter );\r
    }\r
\r
    fgSetWindow ( menuEntry->SubMenu->ParentWindow ) ;\r
}\r
\r
/*\r
 * Private function to get the virtual maximum screen extent\r
 */\r
#if TARGET_HOST_POSIX_X11\r
static GLvoid fgPlatformGetGameModeVMaxExtent( SFG_Window* window, int* x, int* y )\r
{\r
    int wx, wy;\r
    Window w;\r
\r
    XTranslateCoordinates(\r
        fgDisplay.Display,\r
        window->Window.Handle,\r
        fgDisplay.RootWindow,\r
        0, 0, &wx, &wy, &w);\r
\r
    *x = fgState.GameModeSize.X + wx;\r
    *y = fgState.GameModeSize.Y + wy;\r
}\r
#endif\r
\r
\r
static GLvoid fghGetVMaxExtent( SFG_Window* window, int* x, int* y )\r
{\r
    if( fgStructure.GameModeWindow )\r
                fgPlatformGetGameModeVMaxExtent ( window, x, y );\r
    else\r
    {\r
        *x = fgDisplay.ScreenWidth;\r
        *y = fgDisplay.ScreenHeight;\r
    }\r
}\r
\r
/*\r
 * Private function to check for the current menu/sub menu activity state\r
 */\r
static GLboolean fghCheckMenuStatus( SFG_Menu* menu )\r
{\r
    SFG_MenuEntry* menuEntry;\r
    int x, y;\r
\r
    /* First of all check any of the active sub menus... */\r
    for( menuEntry = (SFG_MenuEntry *)menu->Entries.First;\r
         menuEntry;\r
         menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next )\r
    {\r
        if( menuEntry->SubMenu && menuEntry->IsActive )\r
        {\r
            /*\r
             * OK, have the sub-menu checked, too. If it returns GL_TRUE, it\r
             * will mean that it caught the mouse cursor and we do not need\r
             * to regenerate the activity list, and so our parents do...\r
             */\r
            GLboolean return_status;\r
\r
            menuEntry->SubMenu->Window->State.MouseX =\r
                menu->Window->State.MouseX + menu->X - menuEntry->SubMenu->X;\r
            menuEntry->SubMenu->Window->State.MouseY =\r
                menu->Window->State.MouseY + menu->Y - menuEntry->SubMenu->Y;\r
            return_status = fghCheckMenuStatus( menuEntry->SubMenu );\r
\r
            if ( return_status )\r
                return GL_TRUE;\r
        }\r
    }\r
\r
    /* That much about our sub menus, let's get to checking the current menu: */\r
    x = menu->Window->State.MouseX;\r
    y = menu->Window->State.MouseY;\r
\r
    /* Check if the mouse cursor is contained within the current menu box */\r
    if( ( x >= FREEGLUT_MENU_BORDER ) &&\r
        ( x < menu->Width  - FREEGLUT_MENU_BORDER ) &&\r
        ( y >= FREEGLUT_MENU_BORDER ) &&\r
        ( y < menu->Height - FREEGLUT_MENU_BORDER )  )\r
    {\r
        int menuID = ( y - FREEGLUT_MENU_BORDER ) / FREEGLUT_MENU_HEIGHT;\r
\r
        /* The mouse cursor is somewhere over our box, check it out. */\r
        menuEntry = fghFindMenuEntry( menu, menuID + 1 );\r
        FREEGLUT_INTERNAL_ERROR_EXIT( menuEntry, "Cannot find menu entry",\r
                                      "fghCheckMenuStatus" );\r
\r
        menuEntry->IsActive = GL_TRUE;\r
        menuEntry->Ordinal = menuID;\r
\r
        /*\r
         * If this is not the same as the last active menu entry, deactivate\r
         * the previous entry.  Specifically, if the previous active entry\r
         * was a submenu then deactivate it.\r
         */\r
        if( menu->ActiveEntry && ( menuEntry != menu->ActiveEntry ) )\r
            if( menu->ActiveEntry->SubMenu )\r
                fghDeactivateSubMenu( menu->ActiveEntry );\r
\r
        if( menuEntry != menu->ActiveEntry )\r
        {\r
            menu->Window->State.Redisplay = GL_TRUE;\r
            if( menu->ActiveEntry )\r
                menu->ActiveEntry->IsActive = GL_FALSE;\r
        }\r
\r
        menu->ActiveEntry = menuEntry;\r
        menu->IsActive = GL_TRUE;  /* XXX Do we need this? */\r
\r
        /*\r
         * OKi, we have marked that entry as active, but it would be also\r
         * nice to have its contents updated, in case it's a sub menu.\r
         * Also, ignore the return value of the check function:\r
         */\r
        if( menuEntry->SubMenu )\r
        {\r
            if ( ! menuEntry->SubMenu->IsActive )\r
            {\r
                int max_x, max_y;\r
                SFG_Window *current_window = fgStructure.CurrentWindow;\r
\r
                /* Set up the initial menu position now... */\r
                menuEntry->SubMenu->IsActive = GL_TRUE;\r
\r
                /* Set up the initial submenu position now: */\r
                fghGetVMaxExtent(menu->ParentWindow, &max_x, &max_y);\r
                menuEntry->SubMenu->X = menu->X + menu->Width;\r
                menuEntry->SubMenu->Y = menu->Y +\r
                    menuEntry->Ordinal * FREEGLUT_MENU_HEIGHT;\r
\r
                if( menuEntry->SubMenu->X + menuEntry->SubMenu->Width > max_x )\r
                    menuEntry->SubMenu->X = menu->X - menuEntry->SubMenu->Width;\r
\r
                if( menuEntry->SubMenu->Y + menuEntry->SubMenu->Height > max_y )\r
                {\r
                    menuEntry->SubMenu->Y -= ( menuEntry->SubMenu->Height -\r
                                               FREEGLUT_MENU_HEIGHT -\r
                                               2 * FREEGLUT_MENU_BORDER );\r
                    if( menuEntry->SubMenu->Y < 0 )\r
                        menuEntry->SubMenu->Y = 0;\r
                }\r
\r
                fgSetWindow( menuEntry->SubMenu->Window );\r
                glutPositionWindow( menuEntry->SubMenu->X,\r
                                    menuEntry->SubMenu->Y );\r
                glutReshapeWindow( menuEntry->SubMenu->Width,\r
                                   menuEntry->SubMenu->Height );\r
                glutPopWindow( );\r
                glutShowWindow( );\r
                menuEntry->SubMenu->Window->ActiveMenu = menuEntry->SubMenu;\r
                fgSetWindow( current_window );\r
                menuEntry->SubMenu->Window->State.MouseX =\r
                    x + menu->X - menuEntry->SubMenu->X;\r
                menuEntry->SubMenu->Window->State.MouseY =\r
                    y + menu->Y - menuEntry->SubMenu->Y;\r
                fghCheckMenuStatus( menuEntry->SubMenu );\r
            }\r
\r
            /* Activate it because its parent entry is active */\r
            menuEntry->SubMenu->IsActive = GL_TRUE;  /* XXX Do we need this? */\r
        }\r
\r
        /* Report back that we have caught the menu cursor */\r
        return GL_TRUE;\r
    }\r
\r
    /* Looks like the menu cursor is somewhere else... */\r
    if( menu->ActiveEntry && menu->ActiveEntry->IsActive &&\r
        ( !menu->ActiveEntry->SubMenu ||\r
          !menu->ActiveEntry->SubMenu->IsActive ) )\r
    {\r
        menu->Window->State.Redisplay = GL_TRUE;\r
        menu->ActiveEntry->IsActive = GL_FALSE;\r
        menu->ActiveEntry = NULL;\r
    }\r
\r
    return GL_FALSE;\r
}\r
\r
/*\r
 * Displays a menu box and all of its submenus (if they are active)\r
 */\r
static void fghDisplayMenuBox( SFG_Menu* menu )\r
{\r
    SFG_MenuEntry *menuEntry;\r
    int i;\r
    int border = FREEGLUT_MENU_BORDER;\r
\r
    /*\r
     * Have the menu box drawn first. The +- values are\r
     * here just to make it more nice-looking...\r
     */\r
    /* a non-black dark version of the below. */\r
    glColor4f( 1.0f, 1.0f, 1.0f, 1.0f );\r
    glBegin( GL_QUAD_STRIP );\r
        glVertex2i( menu->Width         , 0                    );\r
        glVertex2i( menu->Width - border,                border);\r
        glVertex2i( 0                   , 0                    );\r
        glVertex2i(               border,                border);\r
        glVertex2i( 0                   , menu->Height         );\r
        glVertex2i(               border, menu->Height - border);\r
    glEnd( );\r
\r
    /* a non-black dark version of the below. */\r
    glColor4f( 0.5f, 0.5f, 0.5f, 1.0f );\r
    glBegin( GL_QUAD_STRIP );\r
        glVertex2i( 0                   , menu->Height         );\r
        glVertex2i(               border, menu->Height - border);\r
        glVertex2i( menu->Width         , menu->Height         );\r
        glVertex2i( menu->Width - border, menu->Height - border);\r
        glVertex2i( menu->Width         , 0                    );\r
        glVertex2i( menu->Width - border,                border);\r
    glEnd( );\r
\r
    glColor4fv( menu_pen_back );\r
    glBegin( GL_QUADS );\r
        glVertex2i(               border,                border);\r
        glVertex2i( menu->Width - border,                border);\r
        glVertex2i( menu->Width - border, menu->Height - border);\r
        glVertex2i(               border, menu->Height - border);\r
    glEnd( );\r
\r
    /* Check if any of the submenus is currently active... */\r
    for( menuEntry = (SFG_MenuEntry *)menu->Entries.First;\r
         menuEntry;\r
         menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next )\r
    {\r
        /* Has the menu been marked as active, maybe? */\r
        if( menuEntry->IsActive )\r
        {\r
            /*\r
             * That's truly right, and we need to have it highlighted.\r
             * There is an assumption that mouse cursor didn't move\r
             * since the last check of menu activity state:\r
             */\r
            int menuID = menuEntry->Ordinal;\r
\r
            /* So have the highlight drawn... */\r
            glColor4fv( menu_pen_hback );\r
            glBegin( GL_QUADS );\r
                glVertex2i( border,\r
                            (menuID + 0)*FREEGLUT_MENU_HEIGHT + border );\r
                glVertex2i( menu->Width - border,\r
                            (menuID + 0)*FREEGLUT_MENU_HEIGHT + border );\r
                glVertex2i( menu->Width - border,\r
                            (menuID + 1)*FREEGLUT_MENU_HEIGHT + border );\r
                glVertex2i( border,\r
                            (menuID + 1)*FREEGLUT_MENU_HEIGHT + border );\r
            glEnd( );\r
        }\r
    }\r
\r
    /* Print the menu entries now... */\r
\r
    glColor4fv( menu_pen_fore );\r
\r
    for( menuEntry = (SFG_MenuEntry *)menu->Entries.First, i = 0;\r
         menuEntry;\r
         menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next, ++i )\r
    {\r
        /* If the menu entry is active, set the color to white */\r
        if( menuEntry->IsActive )\r
            glColor4fv( menu_pen_hfore );\r
\r
        /* Move the raster into position... */\r
        /* Try to center the text - JCJ 31 July 2003*/\r
        glRasterPos2i(\r
            2 * border,\r
            ( i + 1 )*FREEGLUT_MENU_HEIGHT -\r
            ( int )( FREEGLUT_MENU_HEIGHT*0.3 - border )\r
        );\r
\r
        /* Have the label drawn, character after character: */\r
        glutBitmapString( FREEGLUT_MENU_FONT,\r
                          (unsigned char *)menuEntry->Text);\r
\r
        /* If it's a submenu, draw a right arrow */\r
        if( menuEntry->SubMenu )\r
        {\r
            int width = glutBitmapWidth( FREEGLUT_MENU_FONT, '_' );\r
            int x_base = menu->Width - 2 - width;\r
            int y_base = i*FREEGLUT_MENU_HEIGHT + border;\r
            glBegin( GL_TRIANGLES );\r
                glVertex2i( x_base, y_base + 2*border);\r
                glVertex2i( menu->Width - 2, y_base +\r
                            ( FREEGLUT_MENU_HEIGHT + border) / 2 );\r
                glVertex2i( x_base, y_base + FREEGLUT_MENU_HEIGHT - border );\r
            glEnd( );\r
        }\r
\r
        /* If the menu entry is active, reset the color */\r
        if( menuEntry->IsActive )\r
            glColor4fv( menu_pen_fore );\r
    }\r
}\r
\r
/*\r
 * Private static function to set the parent window of a submenu and all\r
 * of its submenus\r
 */\r
static void fghSetMenuParentWindow( SFG_Window *window, SFG_Menu *menu )\r
{\r
    SFG_MenuEntry *menuEntry;\r
\r
    menu->ParentWindow = window;\r
\r
    for( menuEntry = ( SFG_MenuEntry * )menu->Entries.First;\r
         menuEntry;\r
         menuEntry = ( SFG_MenuEntry * )menuEntry->Node.Next )\r
        if( menuEntry->SubMenu )\r
            fghSetMenuParentWindow( window, menuEntry->SubMenu );\r
}\r
\r
/*\r
 * Function to check for menu entry selection on menu deactivation\r
 */\r
static void fghExecuteMenuCallback( SFG_Menu* menu )\r
{\r
    SFG_MenuEntry *menuEntry;\r
\r
    /* First of all check any of the active sub menus... */\r
    for( menuEntry = (SFG_MenuEntry *)menu->Entries.First;\r
         menuEntry;\r
         menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next)\r
    {\r
        if( menuEntry->IsActive )\r
        {\r
            if( menuEntry->SubMenu )\r
                fghExecuteMenuCallback( menuEntry->SubMenu );\r
            else\r
                if( menu->Callback )\r
                {\r
                    SFG_Menu *save_menu = fgStructure.CurrentMenu;\r
                    fgStructure.CurrentMenu = menu;\r
                    menu->Callback( menuEntry->ID );\r
                    fgStructure.CurrentMenu = save_menu;\r
                }\r
\r
            return;\r
        }\r
    }\r
}\r
\r
\r
/*\r
 * Displays the currently active menu for the current window\r
 */\r
void fgDisplayMenu( void )\r
{\r
    SFG_Window* window = fgStructure.CurrentWindow;\r
    SFG_Menu* menu = NULL;\r
\r
    FREEGLUT_INTERNAL_ERROR_EXIT ( fgStructure.CurrentWindow, "Displaying menu in nonexistent window",\r
                                   "fgDisplayMenu" );\r
\r
    /* Check if there is an active menu attached to this window... */\r
    menu = window->ActiveMenu;\r
    freeglut_return_if_fail( menu );\r
\r
    fgSetWindow( menu->Window );\r
\r
    glPushAttrib( GL_DEPTH_BUFFER_BIT | GL_TEXTURE_BIT | GL_LIGHTING_BIT |\r
                  GL_POLYGON_BIT );\r
\r
    glDisable( GL_DEPTH_TEST );\r
    glDisable( GL_TEXTURE_2D );\r
    glDisable( GL_LIGHTING   );\r
    glDisable( GL_CULL_FACE  );\r
\r
    glMatrixMode( GL_PROJECTION );\r
    glPushMatrix( );\r
    glLoadIdentity( );\r
    glOrtho(\r
         0, glutGet( GLUT_WINDOW_WIDTH  ),\r
         glutGet( GLUT_WINDOW_HEIGHT ), 0,\r
        -1, 1\r
    );\r
\r
    glMatrixMode( GL_MODELVIEW );\r
    glPushMatrix( );\r
    glLoadIdentity( );\r
\r
    fghDisplayMenuBox( menu );\r
\r
    glPopAttrib( );\r
\r
    glMatrixMode( GL_PROJECTION );\r
    glPopMatrix( );\r
    glMatrixMode( GL_MODELVIEW );\r
    glPopMatrix( );\r
\r
    glutSwapBuffers( );\r
\r
    fgSetWindow ( window );\r
}\r
\r
/*\r
 * Activates a menu pointed by the function argument\r
 */\r
static void fghActivateMenu( SFG_Window* window, int button )\r
{\r
    int max_x, max_y;\r
\r
    /* We'll be referencing this menu a lot, so remember its address: */\r
    SFG_Menu* menu = window->Menu[ button ];\r
    SFG_Window* current_window = fgStructure.CurrentWindow;\r
\r
    /* If the menu is already active in another window, deactivate it there */\r
    if ( menu->ParentWindow )\r
      menu->ParentWindow->ActiveMenu = NULL ;\r
\r
    /* Mark the menu as active, so that it gets displayed: */\r
    window->ActiveMenu = menu;\r
    menu->IsActive = GL_TRUE;\r
    fghSetMenuParentWindow ( window, menu );\r
    fgState.ActiveMenus++;\r
\r
    /* Set up the initial menu position now: */\r
    fghGetVMaxExtent(menu->ParentWindow, &max_x, &max_y);\r
    fgSetWindow( window );\r
    menu->X = window->State.MouseX + glutGet( GLUT_WINDOW_X );\r
    menu->Y = window->State.MouseY + glutGet( GLUT_WINDOW_Y );\r
\r
    if( menu->X + menu->Width > max_x )\r
        menu->X -=menu->Width;\r
\r
    if( menu->Y + menu->Height > max_y )\r
    {\r
        menu->Y -=menu->Height;\r
        if( menu->Y < 0 )\r
            menu->Y = 0;\r
    }\r
\r
    menu->Window->State.MouseX =\r
        window->State.MouseX + glutGet( GLUT_WINDOW_X ) - menu->X;\r
    menu->Window->State.MouseY =\r
        window->State.MouseY + glutGet( GLUT_WINDOW_Y ) - menu->Y;\r
\r
    fgSetWindow( menu->Window );\r
    glutPositionWindow( menu->X, menu->Y );\r
    glutReshapeWindow( menu->Width, menu->Height );\r
    glutPopWindow( );\r
    glutShowWindow( );\r
    menu->Window->ActiveMenu = menu;\r
    fghCheckMenuStatus( menu );\r
    fgSetWindow( current_window );\r
}\r
\r
/*\r
 * Update Highlight states of the menu\r
 *\r
 * Current mouse position is in menu->Window->State.MouseX/Y.\r
 */\r
void fgUpdateMenuHighlight ( SFG_Menu *menu )\r
{\r
    fghCheckMenuStatus( menu );\r
}\r
\r
/*\r
 * Check whether an active menu absorbs a mouse click\r
 */\r
GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,\r
                              int mouse_x, int mouse_y )\r
{\r
    /*\r
     * Near as I can tell, this is the menu behaviour:\r
     *  - Down-click the menu button, menu not active:  activate\r
     *    the menu with its upper left-hand corner at the mouse\r
     *    location.\r
     *  - Down-click any button outside the menu, menu active:\r
     *    deactivate the menu\r
     *  - Down-click any button inside the menu, menu active:\r
     *    select the menu entry and deactivate the menu\r
     *  - Up-click the menu button, menu not active:  nothing happens\r
     *  - Up-click the menu button outside the menu, menu active:\r
     *    nothing happens\r
     *  - Up-click the menu button inside the menu, menu active:\r
     *    select the menu entry and deactivate the menu\r
     * Since menus can have submenus, we need to check this recursively.\r
     */\r
    if( window->ActiveMenu )\r
    {\r
        if( window == window->ActiveMenu->ParentWindow )\r
        {\r
            window->ActiveMenu->Window->State.MouseX =\r
                                       mouse_x - window->ActiveMenu->X;\r
            window->ActiveMenu->Window->State.MouseY =\r
                                       mouse_y - window->ActiveMenu->Y;\r
        }\r
\r
        /* In the menu, invoke the callback and deactivate the menu */\r
        if( fghCheckMenuStatus( window->ActiveMenu ) )\r
        {\r
            /*\r
             * Save the current window and menu and set the current\r
             * window to the window whose menu this is\r
             */\r
            SFG_Window *save_window = fgStructure.CurrentWindow;\r
            SFG_Menu *save_menu = fgStructure.CurrentMenu;\r
            SFG_Window *parent_window = window->ActiveMenu->ParentWindow;\r
            fgSetWindow( parent_window );\r
            fgStructure.CurrentMenu = window->ActiveMenu;\r
\r
            /* Execute the menu callback */\r
            fghExecuteMenuCallback( window->ActiveMenu );\r
            fgDeactivateMenu( parent_window );\r
\r
            /* Restore the current window and menu */\r
            fgSetWindow( save_window );\r
            fgStructure.CurrentMenu = save_menu;\r
        }\r
        else if( pressed )\r
            /*\r
             * Outside the menu, deactivate if it's a downclick\r
             *\r
             * XXX This isn't enough.  A downclick outside of\r
             * XXX the interior of our freeglut windows should also\r
             * XXX deactivate the menu.  This is more complicated.\r
             */\r
            fgDeactivateMenu( window->ActiveMenu->ParentWindow );\r
\r
        /*\r
         * XXX Why does an active menu require a redisplay at\r
         * XXX this point?  If this can come out cleanly, then\r
         * XXX it probably should do so; if not, a comment should\r
         * XXX explain it.\r
         */\r
        if( ! window->IsMenu )\r
            window->State.Redisplay = GL_TRUE;\r
\r
        return GL_TRUE;\r
    }\r
\r
    /* No active menu, let's check whether we need to activate one. */\r
    if( ( 0 <= button ) &&\r
        ( FREEGLUT_MAX_MENUS > button ) &&\r
        ( window->Menu[ button ] ) &&\r
        pressed )\r
    {\r
        /* XXX Posting a requisite Redisplay seems bogus. */\r
        window->State.Redisplay = GL_TRUE;\r
        fghActivateMenu( window, button );\r
        return GL_TRUE;\r
    }\r
\r
    return GL_FALSE;\r
}\r
\r
/*\r
 * Deactivates a menu pointed by the function argument.\r
 */\r
void fgDeactivateMenu( SFG_Window *window )\r
{\r
    SFG_Window *parent_window = NULL;\r
\r
    /* Check if there is an active menu attached to this window... */\r
    SFG_Menu* menu = window->ActiveMenu;\r
    SFG_MenuEntry *menuEntry;\r
\r
    /* Did we find an active window? */\r
    freeglut_return_if_fail( menu );\r
\r
    parent_window = menu->ParentWindow;\r
\r
    /* Hide the present menu's window */\r
    fgSetWindow( menu->Window );\r
    glutHideWindow( );\r
\r
    /* Forget about having that menu active anymore, now: */\r
    menu->Window->ActiveMenu = NULL;\r
    menu->ParentWindow->ActiveMenu = NULL;\r
    fghSetMenuParentWindow ( NULL, menu );\r
    menu->IsActive = GL_FALSE;\r
    menu->ActiveEntry = NULL;\r
\r
    fgState.ActiveMenus--;\r
\r
    /* Hide all submenu windows, and the root menu's window. */\r
    for ( menuEntry = ( SFG_MenuEntry * )menu->Entries.First;\r
          menuEntry;\r
          menuEntry = ( SFG_MenuEntry * )menuEntry->Node.Next )\r
    {\r
        menuEntry->IsActive = GL_FALSE;\r
\r
        /* Is that an active submenu by any case? */\r
        if( menuEntry->SubMenu )\r
            fghDeactivateSubMenu( menuEntry );\r
    }\r
\r
    fgSetWindow ( parent_window ) ;\r
}\r
\r
/*\r
 * Recalculates current menu's box size\r
 */\r
void fghCalculateMenuBoxSize( void )\r
{\r
    SFG_MenuEntry* menuEntry;\r
    int width = 0, height = 0;\r
\r
    /* Make sure there is a current menu set */\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
\r
    /* The menu's box size depends on the menu entries: */\r
    for( menuEntry = ( SFG_MenuEntry * )fgStructure.CurrentMenu->Entries.First;\r
         menuEntry;\r
         menuEntry = ( SFG_MenuEntry * )menuEntry->Node.Next )\r
    {\r
        /* Update the menu entry's width value */\r
        menuEntry->Width = glutBitmapLength(\r
            FREEGLUT_MENU_FONT,\r
            (unsigned char *)menuEntry->Text\r
        );\r
\r
        /*\r
         * If the entry is a submenu, then it needs to be wider to\r
         * accomodate the arrow. JCJ 31 July 2003\r
         */\r
        if (menuEntry->SubMenu )\r
            menuEntry->Width += glutBitmapLength(\r
                FREEGLUT_MENU_FONT,\r
                (unsigned char *)"_"\r
            );\r
\r
        /* Check if it's the biggest we've found */\r
        if( menuEntry->Width > width )\r
            width = menuEntry->Width;\r
\r
        height += FREEGLUT_MENU_HEIGHT;\r
    }\r
\r
    /* Store the menu's box size now: */\r
    fgStructure.CurrentMenu->Height = height + 2 * FREEGLUT_MENU_BORDER;\r
    fgStructure.CurrentMenu->Width  = width  + 4 * FREEGLUT_MENU_BORDER;\r
}\r
\r
\r
/* -- INTERFACE FUNCTIONS -------------------------------------------------- */\r
\r
/*\r
 * Creates a new menu object, adding it to the freeglut structure\r
 */\r
int FGAPIENTRY glutCreateMenu( void(* callback)( int ) )\r
{\r
    /* The menu object creation code resides in freeglut_structure.c */\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateMenu" );\r
    return fgCreateMenu( callback )->ID;\r
}\r
\r
#if TARGET_HOST_MS_WINDOWS\r
int FGAPIENTRY __glutCreateMenuWithExit( void(* callback)( int ), void (__cdecl *exit_function)(int) )\r
{\r
  __glutExitFunc = exit_function;\r
  return glutCreateMenu( callback );\r
}\r
#endif\r
\r
/*\r
 * Destroys a menu object, removing all references to it\r
 */\r
void FGAPIENTRY glutDestroyMenu( int menuID )\r
{\r
    SFG_Menu* menu;\r
\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDestroyMenu" );\r
    menu = fgMenuByID( menuID );\r
\r
    freeglut_return_if_fail( menu );\r
\r
    /* The menu object destruction code resides in freeglut_structure.c */\r
    fgDestroyMenu( menu );\r
}\r
\r
/*\r
 * Returns the ID number of the currently active menu\r
 */\r
int FGAPIENTRY glutGetMenu( void )\r
{\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetMenu" );\r
\r
    if( fgStructure.CurrentMenu )\r
        return fgStructure.CurrentMenu->ID;\r
\r
    return 0;\r
}\r
\r
/*\r
 * Sets the current menu given its menu ID\r
 */\r
void FGAPIENTRY glutSetMenu( int menuID )\r
{\r
    SFG_Menu* menu;\r
\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetMenu" );\r
    menu = fgMenuByID( menuID );\r
\r
    freeglut_return_if_fail( menu );\r
\r
    fgStructure.CurrentMenu = menu;\r
}\r
\r
/*\r
 * Adds a menu entry to the bottom of the current menu\r
 */\r
void FGAPIENTRY glutAddMenuEntry( const char* label, int value )\r
{\r
    SFG_MenuEntry* menuEntry;\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutAddMenuEntry" );\r
    menuEntry = (SFG_MenuEntry *)calloc( sizeof(SFG_MenuEntry), 1 );\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
\r
    menuEntry->Text = strdup( label );\r
    menuEntry->ID   = value;\r
\r
    /* Have the new menu entry attached to the current menu */\r
    fgListAppend( &fgStructure.CurrentMenu->Entries, &menuEntry->Node );\r
\r
    fghCalculateMenuBoxSize( );\r
}\r
\r
/*\r
 * Add a sub menu to the bottom of the current menu\r
 */\r
void FGAPIENTRY glutAddSubMenu( const char *label, int subMenuID )\r
{\r
    SFG_MenuEntry *menuEntry;\r
    SFG_Menu *subMenu;\r
\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutAddSubMenu" );\r
    menuEntry = ( SFG_MenuEntry * )calloc( sizeof( SFG_MenuEntry ), 1 );\r
    subMenu = fgMenuByID( subMenuID );\r
\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
    freeglut_return_if_fail( subMenu );\r
\r
    menuEntry->Text    = strdup( label );\r
    menuEntry->SubMenu = subMenu;\r
    menuEntry->ID      = -1;\r
\r
    fgListAppend( &fgStructure.CurrentMenu->Entries, &menuEntry->Node );\r
    fghCalculateMenuBoxSize( );\r
}\r
\r
/*\r
 * Changes the specified menu item in the current menu into a menu entry\r
 */\r
void FGAPIENTRY glutChangeToMenuEntry( int item, const char* label, int value )\r
{\r
    SFG_MenuEntry* menuEntry = NULL;\r
\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutChangeToMenuEntry" );\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
\r
    /* Get n-th menu entry in the current menu, starting from one: */\r
    menuEntry = fghFindMenuEntry( fgStructure.CurrentMenu, item );\r
\r
    freeglut_return_if_fail( menuEntry );\r
\r
    /* We want it to become a normal menu entry, so: */\r
    if( menuEntry->Text )\r
        free( menuEntry->Text );\r
\r
    menuEntry->Text    = strdup( label );\r
    menuEntry->ID      = value;\r
    menuEntry->SubMenu = NULL;\r
    fghCalculateMenuBoxSize( );\r
}\r
\r
/*\r
 * Changes the specified menu item in the current menu into a sub-menu trigger.\r
 */\r
void FGAPIENTRY glutChangeToSubMenu( int item, const char* label,\r
                                     int subMenuID )\r
{\r
    SFG_Menu*      subMenu;\r
    SFG_MenuEntry* menuEntry;\r
\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutChangeToSubMenu" );\r
    subMenu = fgMenuByID( subMenuID );\r
    menuEntry = NULL;\r
\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
    freeglut_return_if_fail( subMenu );\r
\r
    /* Get n-th menu entry in the current menu, starting from one: */\r
    menuEntry = fghFindMenuEntry( fgStructure.CurrentMenu, item );\r
\r
    freeglut_return_if_fail( menuEntry );\r
\r
    /* We want it to become a sub menu entry, so: */\r
    if( menuEntry->Text )\r
        free( menuEntry->Text );\r
\r
    menuEntry->Text    = strdup( label );\r
    menuEntry->SubMenu = subMenu;\r
    menuEntry->ID      = -1;\r
    fghCalculateMenuBoxSize( );\r
}\r
\r
/*\r
 * Removes the specified menu item from the current menu\r
 */\r
void FGAPIENTRY glutRemoveMenuItem( int item )\r
{\r
    SFG_MenuEntry* menuEntry;\r
\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutRemoveMenuItem" );\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
\r
    /* Get n-th menu entry in the current menu, starting from one: */\r
    menuEntry = fghFindMenuEntry( fgStructure.CurrentMenu, item );\r
\r
    freeglut_return_if_fail( menuEntry );\r
\r
    fgListRemove( &fgStructure.CurrentMenu->Entries, &menuEntry->Node );\r
    if ( menuEntry->Text )\r
      free( menuEntry->Text );\r
\r
    free( menuEntry );\r
    fghCalculateMenuBoxSize( );\r
}\r
\r
/*\r
 * Attaches a menu to the current window\r
 */\r
void FGAPIENTRY glutAttachMenu( int button )\r
{\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutAttachMenu" );\r
\r
    freeglut_return_if_fail( fgStructure.CurrentWindow );\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
\r
    freeglut_return_if_fail( button >= 0 );\r
    freeglut_return_if_fail( button < FREEGLUT_MAX_MENUS );\r
\r
    fgStructure.CurrentWindow->Menu[ button ] = fgStructure.CurrentMenu;\r
}\r
\r
/*\r
 * Detaches a menu from the current window\r
 */\r
void FGAPIENTRY glutDetachMenu( int button )\r
{\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDetachMenu" );\r
\r
    freeglut_return_if_fail( fgStructure.CurrentWindow );\r
    freeglut_return_if_fail( fgStructure.CurrentMenu );\r
\r
    freeglut_return_if_fail( button >= 0 );\r
    freeglut_return_if_fail( button < FREEGLUT_MAX_MENUS );\r
\r
    fgStructure.CurrentWindow->Menu[ button ] = NULL;\r
}\r
\r
/*\r
 * A.Donev: Set and retrieve the menu's user data\r
 */\r
void* FGAPIENTRY glutGetMenuData( void )\r
{\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetMenuData" );\r
    return fgStructure.CurrentMenu->UserData;\r
}\r
\r
void FGAPIENTRY glutSetMenuData(void* data)\r
{\r
    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetMenuData" );\r
    fgStructure.CurrentMenu->UserData=data;\r
}\r
\r
/*** END OF FILE ***/\r