Pure code janitoring: Shuffled the order of some of the case statements
[freeglut] / src / freeglut_menu.c
index c7760d9..3b3a5cb 100644 (file)
 #include "config.h"
 #endif
 
-#define  G_LOG_DOMAIN  "freeglut-menu"
-
 #include "../include/GL/freeglut.h"
 #include "freeglut_internal.h"
 
-/*
- * TODO BEFORE THE STABLE RELEASE:
- *
- * Wouldn't 1.0 have been "the" stable release?  Now we are past 2.0,
- * so this comment is probably just out of date.  (20031026; rkr)
- *
- * Think about the possibility of doing the menu on layers *or* using the
- * native window system instead of OpenGL.
- */
-
 /* -- DEFINITIONS ---------------------------------------------------------- */
 
 /*
  * symbolic constant, FREEGLUT_MENU_ITEM_BORDER, or such.)
  */
 #if TARGET_HOST_WIN32
-#define FREEGLUT_MENU_FONT    GLUT_BITMAP_8_BY_13
+#define  FREEGLUT_MENU_FONT    GLUT_BITMAP_8_BY_13
 #else
-#define FREEGLUT_MENU_FONT    GLUT_BITMAP_HELVETICA_18
+#define  FREEGLUT_MENU_FONT    GLUT_BITMAP_HELVETICA_18
 #endif
 
-#define FREEGLUT_MENU_HEIGHT  (glutBitmapHeight(FREEGLUT_MENU_FONT) + FREEGLUT_MENU_BORDER)
+#define  FREEGLUT_MENU_HEIGHT  (glutBitmapHeight(FREEGLUT_MENU_FONT) + FREEGLUT_MENU_BORDER)
 #define  FREEGLUT_MENU_BORDER   2
 
 
 /*
- * 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};
@@ -99,7 +86,6 @@ static float menu_pen_hfore [4] = {0.0f,  0.0f,  0.0f,  1.0f};
 static float menu_pen_hback [4] = {1.0f,  1.0f,  1.0f,  1.0f};
 #endif
 
-
 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
 
 /*
@@ -171,11 +157,11 @@ 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 ) )
   {
     int menuID = ( y - FREEGLUT_MENU_BORDER ) / FREEGLUT_MENU_HEIGHT ;
 
@@ -190,7 +176,7 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
 
     /*
      * If this is not the same as the last active menu entry, deactivate the
-     * previous entry. Specifically, if the previous active entry was a
+     * previous entry.  Specifically, if the previous active entry was a
      * submenu then deactivate it.
      */
     if ( menu->ActiveEntry && ( menuEntry != menu->ActiveEntry ) )
@@ -225,12 +211,12 @@ static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
         menuEntry->SubMenu->X = menu->X + menu->Width ;
         menuEntry->SubMenu->Y = menu->Y + menuEntry->Ordinal * FREEGLUT_MENU_HEIGHT ;
 
-        if ( menuEntry->SubMenu->X + menuEntry->SubMenu->Width > glutGet (GLUT_SCREEN_WIDTH ) )
-        menuEntry->SubMenu->X = menu->X - menuEntry->SubMenu->Width;
+        if ( menuEntry->SubMenu->X + menuEntry->SubMenu->Width > glutGet ( GLUT_SCREEN_WIDTH ) )
+          menuEntry->SubMenu->X = menu->X - menuEntry->SubMenu->Width ;
 
-        if ( menuEntry->SubMenu->Y + menuEntry->SubMenu->Height > glutGet (GLUT_SCREEN_HEIGHT ) )
-        menuEntry->SubMenu->Y -= (menuEntry->SubMenu->Height -
-           FREEGLUT_MENU_HEIGHT - 2*FREEGLUT_MENU_BORDER);
+        if ( menuEntry->SubMenu->Y + menuEntry->SubMenu->Height > glutGet ( GLUT_SCREEN_HEIGHT ) )
+          menuEntry->SubMenu->Y -= ( menuEntry->SubMenu->Height -
+                            FREEGLUT_MENU_HEIGHT - 2 * FREEGLUT_MENU_BORDER ) ;
 
         fgSetWindow ( menuEntry->SubMenu->Window ) ;
         glutPositionWindow ( menuEntry->SubMenu->X, menuEntry->SubMenu->Y ) ;
@@ -539,7 +525,6 @@ void fgActivateMenu( SFG_Window* window, int button )
   glutPopWindow () ;
   glutShowWindow () ;
   menu->Window->ActiveMenu = menu ;
-
 }
 
 /*
@@ -769,20 +754,9 @@ 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 +767,9 @@ void FGAPIENTRY glutSetMenu( int menuID )
 {
     SFG_Menu* menu = fgMenuByID( menuID );
 
-    freeglut_assert_ready; freeglut_return_if_fail( menu != NULL );
+    freeglut_assert_ready;
+    freeglut_return_if_fail( menu != NULL );
 
-    /*
-     * The current menu pointer is stored in fgStructure.Menu
-     */
     fgStructure.Menu = menu;
 }
 
@@ -808,14 +780,9 @@ 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 );
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu != NULL );
 
-    /*
-     * Fill in the appropriate values...
-     */
     menuEntry->Text = strdup( label );
     menuEntry->ID   = value;
 
@@ -824,9 +791,6 @@ void FGAPIENTRY glutAddMenuEntry( const char* label, int value )
      */
     fgListAppend( &fgStructure.Menu->Entries, &menuEntry->Node );
 
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -838,16 +802,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;
@@ -857,14 +815,7 @@ void FGAPIENTRY glutAddSubMenu( const char* label, int subMenuID )
    */
   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,20 +826,15 @@ 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 );
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu );
 
     /*
      * 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 );
+    freeglut_return_if_fail( menuEntry );
 
     /*
      * We want it to become a normal menu entry, so:
@@ -899,10 +845,6 @@ void FGAPIENTRY glutChangeToMenuEntry( int item, const char* label, int value )
     menuEntry->Text = strdup( label );
     menuEntry->ID      = value;
     menuEntry->SubMenu = NULL;
-
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -914,35 +856,26 @@ 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 );
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu );
+    freeglut_return_if_fail( subMenu );
 
     /*
      * 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 );
+    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();
 }
 
@@ -953,36 +886,21 @@ 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 );
+    freeglut_assert_ready;
+    freeglut_return_if_fail( fgStructure.Menu );
 
     /*
      * 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 );
+    freeglut_return_if_fail( menuEntry );
 
-    /*
-     * Removing a menu entry is quite simple...
-     */
     fgListRemove( &fgStructure.Menu->Entries, &menuEntry->Node );
-
-    /*
-     * Free the entry label string, too
-     */
-    free( menuEntry->Text );
+    if ( menuEntry->Text )
+      free( menuEntry->Text );
 
     free( menuEntry );
-
-    /*
-     * Update the menu's dimensions now
-     */
     fghCalculateMenuBoxSize();
 }
 
@@ -992,10 +910,13 @@ void FGAPIENTRY glutRemoveMenuItem( int item )
 void FGAPIENTRY glutAttachMenu( int button )
 {
     freeglut_assert_ready;
+
     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;
 
     /*
@@ -1010,10 +931,13 @@ void FGAPIENTRY glutAttachMenu( int button )
 void FGAPIENTRY glutDetachMenu( int button )
 {
     freeglut_assert_ready;
-    freeglut_return_if_fail( fgStructure.Window != NULL );
+
+    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;
 }