Cleaned up a little redundancy in a comment on the {menu_pen_*} variables.
[freeglut] / src / freeglut_menu.c
index 45ff5ea..c9feea2 100644 (file)
 
 
 /*
- * 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};
@@ -768,21 +767,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 );
 }
 
@@ -793,11 +779,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;
 }
 
@@ -808,14 +791,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;
 
@@ -823,10 +800,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();
 }
 
@@ -838,16 +811,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;
@@ -856,15 +823,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();
 }
 
@@ -875,19 +834,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 );
 
     /*
@@ -900,9 +849,6 @@ void FGAPIENTRY glutChangeToMenuEntry( int item, const char* label, int value )
     menuEntry->ID      = value;
     menuEntry->SubMenu = NULL;
 
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -914,20 +860,10 @@ 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_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:
-     */
     menuEntry = fghFindMenuEntry( fgStructure.Menu, item );
-
-    /*
-     * Make sure the menu entry exists
-     */
     freeglut_return_if_fail( menuEntry != NULL );
 
     /*
@@ -940,9 +876,6 @@ void FGAPIENTRY glutChangeToSubMenu( int item, const char* label, int subMenuID
     menuEntry->SubMenu = subMenu;
     menuEntry->ID      = -1;
 
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -953,36 +886,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...
-     */
     fgListRemove( &fgStructure.Menu->Entries, &menuEntry->Node );
-
-    /*
-     * Free the entry label string, too
-     */
     free( menuEntry->Text );
-
     free( menuEntry );
-
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -992,20 +902,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;
 
     /*
@@ -1020,20 +920,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;
 }