Got rid of the G_LOG_DOMAIN junk, per discussion on the mailing list.
[freeglut] / src / freeglut_menu.c
index 8a65c4e..2f373dc 100644 (file)
@@ -29,8 +29,6 @@
 #include "config.h"
 #endif
 
-#define  G_LOG_DOMAIN  "freeglut-menu"
-
 #include "../include/GL/freeglut.h"
 #include "freeglut_internal.h"
 
@@ -70,7 +68,7 @@
  */
 #if TARGET_HOST_WIN32
 #define FREEGLUT_MENU_FONT    GLUT_BITMAP_8_BY_13
-#elif TARGET_HOST_UNIX_X11
+#else
 #define FREEGLUT_MENU_FONT    GLUT_BITMAP_HELVETICA_18
 #endif
 
 
 
 /*
- * These variables should be moved into the freeglut global state, but for now,
- * we'll put them here.  They are for rendering the freeglut menu items.
+ * These variables are for rendering the freeglut menu items.
+ *
  * The choices are fore- and background, with and without h for Highlighting.
  * Old GLUT appeared to be system-dependant for its colors (sigh) so we are
  * too.  These variables should be stuffed into global state and initialized
  * via the glutInit*() system.
  */
-
 #if TARGET_HOST_WIN32
 static float menu_pen_fore  [4] = {0.0f,  0.0f,  0.0f,  1.0f};
 static float menu_pen_back  [4] = {0.85f, 0.85f, 0.85f, 1.0f};
@@ -103,7 +100,7 @@ static float menu_pen_hback [4] = {1.0f,  1.0f,  1.0f,  1.0f};
 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
 
 /*
- * Private static function to find a menu entry by index
+ * Private function to find a menu entry by index
  */
 static SFG_MenuEntry *fghFindMenuEntry( SFG_Menu* menu, int index )
 {
@@ -121,7 +118,7 @@ static SFG_MenuEntry *fghFindMenuEntry( SFG_Menu* menu, int index )
 }
 
 /*
- * Private static function to check for the current menu/sub menu activity state
+ * Private function to check for the current menu/sub menu activity state
  */
 static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
 {
@@ -134,9 +131,6 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
   for( menuEntry = (SFG_MenuEntry *)menu->Entries.First; menuEntry;
        menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next )
   {
-    /*
-     * Is that an active sub menu by any case?
-     */
     if( menuEntry->SubMenu != NULL && menuEntry->IsActive == TRUE )
     {
       /*
@@ -147,8 +141,8 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
       GLboolean return_status = fghCheckMenuStatus( window, menuEntry->SubMenu ) ;
 
       /*
-       * Reactivate the submenu as the checkMenuStatus may have turned it off if the mouse
-       * is in its parent menu entry.
+       * Reactivate the submenu as the checkMenuStatus may have turned it off
+       * if the mouse is in its parent menu entry.
        */
       menuEntry->SubMenu->IsActive = TRUE ;
       if ( return_status == TRUE )
@@ -162,9 +156,6 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
   x = window->State.MouseX;
   y = window->State.MouseY;
 
-  /*
-   * Mark all menu entries inactive...
-   */
   for( menuEntry = (SFG_MenuEntry *)menu->Entries.First; menuEntry;
        menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next )
   {
@@ -177,13 +168,12 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
   /*
    * Check if the mouse cursor is contained within the current menu box
    */
-  if ( ( x >= FREEGLUT_MENU_BORDER ) && ( x < menu->Width  - FREEGLUT_MENU_BORDER ) &&
-       ( y >= FREEGLUT_MENU_BORDER ) && ( y < menu->Height - FREEGLUT_MENU_BORDER ) &&
-       ( window == menu->Window ) )
+  if( ( x >= FREEGLUT_MENU_BORDER ) &&
+      ( x < menu->Width  - FREEGLUT_MENU_BORDER ) &&
+      ( y >= FREEGLUT_MENU_BORDER ) &&
+      ( y < menu->Height - FREEGLUT_MENU_BORDER ) &&
+      ( window == menu->Window ) )
   {
-    /*
-     * Calculation of the highlighted menu item is easy enough now:
-     */
     int menuID = ( y - FREEGLUT_MENU_BORDER ) / FREEGLUT_MENU_HEIGHT ;
 
     /*
@@ -192,15 +182,13 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
     menuEntry = fghFindMenuEntry( menu, menuID + 1 );
     assert( menuEntry != NULL );
 
-    /*
-     * Mark the menu as active...
-     */
     menuEntry->IsActive = TRUE;
     menuEntry->Ordinal = menuID;
 
     /*
-     * If this is not the same as the last active menu entry, deactivate the previous entry.
-     * Specifically, if the previous active entry was a submenu then deactivate it.
+     * If this is not the same as the last active menu entry, deactivate the
+     * previous entry. Specifically, if the previous active entry was a
+     * submenu then deactivate it.
      */
     if ( menu->ActiveEntry && ( menuEntry != menu->ActiveEntry ) )
     {
@@ -209,11 +197,6 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
     }
 
     menu->ActiveEntry = menuEntry ;
-
-    /*
-     * Don't forget about marking the current menu as active, too:
-     */
-
     menu->IsActive = TRUE;
 
     /*
@@ -231,9 +214,6 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
          * Set up the initial menu position now...
          */
 
-        /*
-         * Mark the menu as active, so that it gets displayed:
-         */
         menuEntry->SubMenu->IsActive = TRUE ;
 
         /*
@@ -247,7 +227,7 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
 
         if ( menuEntry->SubMenu->Y + menuEntry->SubMenu->Height > glutGet (GLUT_SCREEN_HEIGHT ) )
         menuEntry->SubMenu->Y -= (menuEntry->SubMenu->Height -
-           FREEGLUT_MENU_HEIGHT - 2*FREEGLUT_MENU_BORDER);
+            FREEGLUT_MENU_HEIGHT - 2*FREEGLUT_MENU_BORDER);
 
         fgSetWindow ( menuEntry->SubMenu->Window ) ;
         glutPositionWindow ( menuEntry->SubMenu->X, menuEntry->SubMenu->Y ) ;
@@ -258,13 +238,10 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
         fgSetWindow ( current_window ) ;
       }
 
-      /*
-       * ...then check the submenu's state:
-       */
       fghCheckMenuStatus( window, menuEntry->SubMenu );
 
       /*
-       * Even if the submenu turned up inactive, activate it because its parent entry is active
+       * Activate it because its parent entry is active
        */
       menuEntry->SubMenu->IsActive = TRUE ;
     }
@@ -788,21 +765,8 @@ void FGAPIENTRY glutDestroyMenu( int menuID )
 int FGAPIENTRY glutGetMenu( void )
 {
     freeglut_assert_ready;
-
-    /*
-     * Is there a current menu set?
-     */
     if( fgStructure.Menu != NULL )
-    {
-        /*
-         * Yes, there is indeed...
-         */
         return( fgStructure.Menu->ID );
-    }
-
-    /*
-     * No, there is no current menu at all
-     */
     return( 0 );
 }
 
@@ -813,11 +777,8 @@ void FGAPIENTRY glutSetMenu( int menuID )
 {
     SFG_Menu* menu = fgMenuByID( menuID );
 
-    freeglut_assert_ready; freeglut_return_if_fail( menu != NULL );
-
-    /*
-     * The current menu pointer is stored in fgStructure.Menu
-     */
+    freeglut_assert_ready;
+    freeglut_return_if_fail( menu != NULL );
     fgStructure.Menu = menu;
 }
 
@@ -828,14 +789,8 @@ void FGAPIENTRY glutAddMenuEntry( const char* label, int value )
 {
     SFG_MenuEntry* menuEntry = (SFG_MenuEntry *)calloc( sizeof(SFG_MenuEntry), 1 );
 
-    /*
-     * Make sure there is a current menu set
-     */
-    freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
-
-    /*
-     * Fill in the appropriate values...
-     */
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu != NULL );
     menuEntry->Text = strdup( label );
     menuEntry->ID   = value;
 
@@ -843,10 +798,6 @@ void FGAPIENTRY glutAddMenuEntry( const char* label, int value )
      * Have the new menu entry attached to the current menu
      */
     fgListAppend( &fgStructure.Menu->Entries, &menuEntry->Node );
-
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -858,16 +809,10 @@ void FGAPIENTRY glutAddSubMenu( const char* label, int subMenuID )
   SFG_MenuEntry* menuEntry = (SFG_MenuEntry *)calloc( sizeof(SFG_MenuEntry), 1 );
   SFG_Menu*      subMenu = fgMenuByID( subMenuID );
 
-  /*
-   * Make sure there is a current menu and the sub menu
-   * we want to attach actually exists...
-   */
-  freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
+  freeglut_assert_ready;
+  freeglut_return_if_fail( fgStructure.Menu != NULL );
   freeglut_return_if_fail( subMenu != NULL );
 
-  /*
-   * Fill in the appropriate values
-   */
   menuEntry->Text = strdup( label );
   menuEntry->SubMenu = subMenu;
   menuEntry->ID      = -1;
@@ -876,15 +821,7 @@ void FGAPIENTRY glutAddSubMenu( const char* label, int subMenuID )
    * Make the submenu's parent window be the menu's parent window
    */
   fghSetSubmenuParentWindow ( fgStructure.Menu->ParentWindow, subMenu ) ;
-
-  /*
-   * Have the new menu entry attached to the current menu
-   */
   fgListAppend( &fgStructure.Menu->Entries, &menuEntry->Node );
-
-  /*
-   * Update the menu's dimensions now
-   */
   fghCalculateMenuBoxSize();
 }
 
@@ -895,19 +832,9 @@ void FGAPIENTRY glutChangeToMenuEntry( int item, const char* label, int value )
 {
     SFG_MenuEntry* menuEntry = NULL;
 
-    /*
-     * Make sure there is a current menu set...
-     */
-    freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
-
-    /*
-     * Get n-th menu entry in the current menu, starting from one:
-     */
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu != NULL );
     menuEntry = fghFindMenuEntry( fgStructure.Menu, item );
-
-    /*
-     * Make sure the menu entry exists
-     */
     freeglut_return_if_fail( menuEntry != NULL );
 
     /*
@@ -920,9 +847,6 @@ void FGAPIENTRY glutChangeToMenuEntry( int item, const char* label, int value )
     menuEntry->ID      = value;
     menuEntry->SubMenu = NULL;
 
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -934,35 +858,22 @@ void FGAPIENTRY glutChangeToSubMenu( int item, const char* label, int subMenuID
     SFG_Menu*      subMenu = fgMenuByID( subMenuID );
     SFG_MenuEntry* menuEntry = NULL;
 
-    /*
-     * Make sure there is a current menu set and the sub menu exists...
-     */
-    freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
-    freeglut_return_if_fail( subMenu != NULL );
-
-    /*
-     * Get n-th menu entry in the current menu, starting from one:
-     */
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu );
+    freeglut_return_if_fail( subMenu );
     menuEntry = fghFindMenuEntry( fgStructure.Menu, item );
-
-    /*
-     * Make sure the menu entry exists
-     */
-    freeglut_return_if_fail( menuEntry != NULL );
+    freeglut_return_if_fail( menuEntry );
 
     /*
      * We want it to become a sub menu entry, so:
      */
-    if( menuEntry->Text != NULL )
+    if( menuEntry->Text )
         free( menuEntry->Text );
 
     menuEntry->Text = strdup( label );
     menuEntry->SubMenu = subMenu;
     menuEntry->ID      = -1;
 
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -973,36 +884,13 @@ void FGAPIENTRY glutRemoveMenuItem( int item )
 {
     SFG_MenuEntry* menuEntry;
 
-    /*
-     * Make sure there is a current menu set
-     */
-    freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
-
-    /*
-     * Get n-th menu entry in the current menu, starting from one:
-     */
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu );
     menuEntry = fghFindMenuEntry( fgStructure.Menu, item );
-
-    /*
-     * Make sure the menu entry exists
-     */
-    freeglut_return_if_fail( menuEntry != NULL );
-
-    /*
-     * Removing a menu entry is quite simple...
-     */
+    freeglut_return_if_fail( menuEntry );
     fgListRemove( &fgStructure.Menu->Entries, &menuEntry->Node );
-
-    /*
-     * Free the entry label string, too
-     */
     free( menuEntry->Text );
-
     free( menuEntry );
-
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -1012,20 +900,10 @@ void FGAPIENTRY glutRemoveMenuItem( int item )
 void FGAPIENTRY glutAttachMenu( int button )
 {
     freeglut_assert_ready;
-
-    /*
-     * There must be a current window and a current menu set:
-     */
-    freeglut_return_if_fail( fgStructure.Window != NULL || fgStructure.Menu != NULL );
-
-    /*
-     * Make sure the button value is valid (0, 1 or 2, see freeglut.h)
-     */
-    freeglut_return_if_fail( button == GLUT_LEFT_BUTTON || button == GLUT_MIDDLE_BUTTON || button == GLUT_RIGHT_BUTTON );
-
-    /*
-     * It is safe now to attach the menu
-     */
+    freeglut_return_if_fail( fgStructure.Window );
+    freeglut_return_if_fail( fgStructure.Menu );
+    freeglut_return_if_fail( button >= 0 );
+    freeglut_return_if_fail( button < FREEGLUT_MAX_MENUS );
     fgStructure.Window->Menu[ button ] = fgStructure.Menu;
 
     /*
@@ -1040,20 +918,10 @@ void FGAPIENTRY glutAttachMenu( int button )
 void FGAPIENTRY glutDetachMenu( int button )
 {
     freeglut_assert_ready;
-
-    /*
-     * There must be a current window set:
-     */
-    freeglut_return_if_fail( fgStructure.Window != NULL );
-
-    /*
-     * Make sure the button value is valid (0, 1 or 2, see freeglut.h)
-     */
-    freeglut_return_if_fail( button != 0 && button != 1 && button != 2 );
-
-    /*
-     * It is safe now to detach the menu
-     */
+    freeglut_return_if_fail( fgStructure.Window );
+    freeglut_return_if_fail( fgStructure.Menu );
+    freeglut_return_if_fail( button >= 0 );
+    freeglut_return_if_fail( button < FREEGLUT_MAX_MENUS );
     fgStructure.Window->Menu[ button ] = NULL;
 }