git.mutantstargoat.com Git - freeglut/blob - src/freeglut_structure.c

   1 /*
   2  * freeglut_structure.c
   3  *
   4  * Windows and menus need tree structure
   5  *
   6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
   7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
   8  * Creation date: Sat Dec 18 1999
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a
  11  * copy of this software and associated documentation files (the "Software"),
  12  * to deal in the Software without restriction, including without limitation
  13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  14  * and/or sell copies of the Software, and to permit persons to whom the
  15  * Software is furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included
  18  * in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  24  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  25  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  */
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 #include "../include/GL/freeglut.h"
  33 #include "freeglut_internal.h"
  34
  35
  36 /* -- GLOBAL EXPORTS ------------------------------------------------------- */
  37
  38 /*
  39  * The SFG_Structure container holds information about windows and menus
  40  * created between glutInit() and glutMainLoop() return.
  41  */
  42
  43 SFG_Structure fgStructure = { { NULL, NULL },  /* The list of windows       */
  44                               { NULL, NULL },  /* The list of menus         */
  45                               NULL,            /* The current window        */
  46                               NULL,            /* The current menu          */
  47                               NULL,            /* The menu OpenGL context   */
  48                               NULL,            /* The game mode window      */
  49                               0,               /* The current new window ID */
  50                               0 };             /* The current new menu ID   */
  51
  52
  53 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
  54
  55 void fgClearCallBacks( SFG_Window *window )
  56 {
  57     int i;
  58     for( i = 0; i < TOTAL_CALLBACKS; ++i )
  59         window->CallBacks[ i ] = NULL;
  60 }
  61
  62 /*
  63  * This private function creates, opens and adds to the hierarchy
  64  * a freeglut window complete with OpenGL context and stuff...
  65  *
  66  * If parent is set to NULL, the window created will be a topmost one.
  67  */
  68 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
  69                             int x, int y, int w, int h, GLboolean gameMode )
  70 {
  71     /*
  72      * Have the window object created
  73      */
  74     SFG_Window *window = (SFG_Window *)calloc( sizeof(SFG_Window), 1 );
  75     int fakeArgc = 0;
  76
  77     fgClearCallBacks( window );
  78
  79     /*
  80      * If the freeglut internals haven't been initialized yet,
  81      * do it now. Hack's idea courtesy of Chris Purnell...
  82      */
  83     if( !fgState.Time.Set )
  84         glutInit( &fakeArgc, NULL );
  85
  86     /*
  87      * Initialize the object properties
  88      */
  89     window->ID = ++fgStructure.WindowID;
  90
  91     fgListInit( &window->Children );
  92     if( parent != NULL )
  93     {
  94         fgListAppend( &parent->Children, &window->Node );
  95         window->Parent = parent;
  96     }
  97     else
  98         fgListAppend( &fgStructure.Windows, &window->Node );
  99
 100     /*
 101      * Set the default mouse cursor and reset the modifiers value
 102      */
 103     window->State.Cursor    = GLUT_CURSOR_INHERIT;
 104     window->State.Modifiers = 0xffffffff;
 105
 106     window->IsMenu = fgState.BuildingAMenu ;
 107
 108     /*
 109      * Open the window now. The fgOpenWindow() function is system
 110      * dependant, and resides in freeglut_window.c. Uses fgState.
 111      */
 112     fgOpenWindow( window, title, x, y, w, h, gameMode,
 113                   (parent != NULL) ? TRUE : FALSE );
 114
 115     return window;
 116 }
 117
 118 /*
 119  * This private function creates a menu and adds it to the menus list
 120  */
 121 SFG_Menu* fgCreateMenu( FGCBMenu menuCallback )
 122 {
 123     int x = 100, y = 100, w = 100, h = 100 ;
 124     SFG_Window *current_window = fgStructure.Window ;
 125
 126     /*
 127      * Have the menu object created
 128      */
 129     SFG_Menu* menu = (SFG_Menu *)calloc( sizeof(SFG_Menu), 1 );
 130     int fakeArgc = 0;
 131
 132     /*
 133      * If the freeglut internals haven't been initialized yet,
 134      * do it now. Hack's idea courtesy of Chris Purnell...
 135      */
 136     if( !fgState.Time.Set )
 137         glutInit( &fakeArgc, NULL );
 138
 139     menu->ParentWindow = fgStructure.Window ;
 140
 141     /*
 142      * Create a window for the menu to reside in.  Set the
 143      * global variable BuildingAMenu to true so we can ensure
 144      * it is created without decorations.
 145      */
 146     fgState.BuildingAMenu = TRUE ;
 147
 148     fgCreateWindow ( NULL, NULL, x, y, w, h, FALSE ) ;
 149     menu->Window = fgStructure.Window ;
 150     glutDisplayFunc ( fgDisplayMenu ) ;
 151
 152     /*
 153      * While BuildingAMenu is true, all windows built have no decorations.
 154      * That's not a good default behavior, so let's set it false again.
 155      */
 156     fgState.BuildingAMenu = FALSE ;
 157
 158     glutHideWindow () ;  /* Hide the window for now */
 159     fgSetWindow ( current_window ) ;
 160
 161     /*
 162      * Initialize the object properties:
 163      */
 164     menu->ID       = ++fgStructure.MenuID;
 165     menu->Callback = menuCallback;
 166     menu->ActiveEntry = NULL ;
 167
 168     fgListInit( &menu->Entries );
 169     fgListAppend( &fgStructure.Menus, &menu->Node );
 170
 171     /*
 172      * Newly created menus implicitly become current ones
 173      */
 174     fgStructure.Menu = menu;
 175
 176     return menu;
 177 }
 178
 179 /*
 180  * Linked list of windows to destroy ... this is so we don't destroy a
 181  * window from the middle of its callback.  Some C compilers take an
 182  * extremely dim view of this.
 183  */
 184
 185 static SFG_WindowList* WindowsToDestroy = (SFG_WindowList*)NULL ;
 186
 187 /*
 188  * Function to add a window to the linked list of windows to destroy.
 189  * Subwindows are automatically added because they hang from the window
 190  * structure.
 191  */
 192 void fgAddToWindowDestroyList ( SFG_Window* window, GLboolean needToClose )
 193 {
 194     SFG_WindowList *new_list_entry =
 195         ( SFG_WindowList* )malloc( sizeof(SFG_WindowList ) );
 196     new_list_entry->window = window;
 197     new_list_entry->needToClose = needToClose;
 198     new_list_entry->next = WindowsToDestroy;
 199     WindowsToDestroy = new_list_entry;
 200
 201     /*
 202      * Check if the window is the current one...
 203      */
 204     if( fgStructure.Window == window )
 205         fgStructure.Window = NULL;
 206
 207     /*
 208      * Clear all window callbacks except Destroy, which will
 209      * be invoked later.  Right now, we are potentially carrying
 210      * out a freeglut operation at the behest of a client callback,
 211      * so we are reluctant to re-enter the client with the Destroy
 212      * callback, right now.  The others are all wiped out, however,
 213      * to ensure that they are no longer called after this point.
 214      */
 215     {
 216         void *destroy = FETCH_WCB( *window, Destroy );
 217         fgClearCallBacks( window );
 218         FETCH_WCB( *window, Destroy ) = destroy;
 219     }
 220
 221
 222     /*
 223      * If the destroyed window has the highest window ID number, decrement
 224      * the window ID number.
 225      *
 226      * XXX Do we REALLY want to *ever* recycle window IDs?  Integers are
 227      * XXX plentiful, and clients may rely upon the implied promise in
 228      * XXX the GLUT docs to not recycle these.  (I can't remember if it
 229      * XXX is explicit.)
 230      *
 231      * XXX If we *do* want to do this, we should actually recompute the
 232      * XXX highest window-ID; the new highest may not in fact be one less
 233      * XXX than what we have just deleted.
 234      */
 235     if ( window->ID == fgStructure.WindowID )
 236         fgStructure.WindowID--;
 237
 238     /*
 239      * Check the execution state.  If this has been called from
 240      * "glutDestroyWindow", a statement in that function will reset the
 241      * "ExecState" after this function returns.
 242      */
 243     if( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION )
 244         /*
 245          * Set the execution state flag to drop out of the main loop.
 246          */
 247         if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
 248             fgState.ExecState = GLUT_EXEC_STATE_STOP;
 249 }
 250
 251 /*
 252  * Function to close down all the windows in the "WindowsToDestroy" list
 253  */
 254 void fgCloseWindows( )
 255 {
 256     SFG_WindowList *window_ptr = WindowsToDestroy;
 257     WindowsToDestroy = ( SFG_WindowList* )NULL;
 258     /* In case the destroy callbacks cause more windows to be closed */
 259
 260     while( window_ptr )
 261     {
 262         SFG_WindowList *next = window_ptr->next;
 263         fgDestroyWindow( window_ptr->window, window_ptr->needToClose );
 264         free( window_ptr );
 265         window_ptr = next;
 266
 267         if( !window_ptr )
 268         {
 269             window_ptr = WindowsToDestroy;
 270             WindowsToDestroy = ( SFG_WindowList* )NULL;
 271         }
 272     }
 273 }
 274
 275 /*
 276  * This function destroys a window and all of its subwindows. Actually,
 277  * another function, defined in freeglut_window.c is called, but this is
 278  * a whole different story...
 279  */
 280 void fgDestroyWindow( SFG_Window* window, GLboolean needToClose )
 281 {
 282     SFG_Window* subWindow;
 283     int menu_index ;
 284
 285     assert( window != NULL );
 286     freeglut_assert_ready;
 287
 288     while ( (subWindow = (SFG_Window *)window->Children.First) != NULL )
 289         fgDestroyWindow( subWindow, needToClose );
 290
 291     /*
 292      * XXX Since INVOKE_WCB() tests the function pointer, why not make
 293      * XXX this unconditional?  Overhead is close to nil, and it would
 294      * XXX clarify the code by omitting a conditional test.
 295      */
 296     if ( FETCH_WCB( *window, Destroy ) )
 297     {
 298       SFG_Window *activeWindow = fgStructure.Window ;
 299       INVOKE_WCB( *window, Destroy, ( ) );
 300       fgSetWindow ( activeWindow ) ;
 301     }
 302
 303     if ( window->Parent != NULL )
 304         fgListRemove( &window->Parent->Children, &window->Node );
 305     else
 306         fgListRemove( &fgStructure.Windows, &window->Node );
 307
 308     if ( window->ActiveMenu != NULL )
 309       fgDeactivateMenu ( window ) ;
 310
 311     for ( menu_index = 0; menu_index < 3; menu_index ++ )
 312     {
 313       if ( window->Menu[menu_index] != NULL )
 314         window->Menu[menu_index]->ParentWindow = NULL ;
 315     }
 316
 317     if( needToClose == TRUE )
 318         fgCloseWindow( window );
 319     free( window );
 320     if ( fgStructure.Window == window )
 321         fgStructure.Window = NULL ;
 322     fgClearCallBacks( window );
 323 }
 324
 325 /*
 326  * This is a helper static function that removes a menu (given its pointer)
 327  * from any windows that can be accessed from a given parent...
 328  */
 329 static void fghRemoveMenuFromWindow( SFG_Window* window, SFG_Menu* menu )
 330 {
 331     SFG_Window *subWindow;
 332     int i;
 333
 334     /*
 335      * Check if the menu is attached to the current window,
 336      * if so, have it detached (by overwriting with a NULL):
 337      */
 338     for( i=0; i<3; i++ )
 339         if( window->Menu[ i ] == menu )
 340             window->Menu[ i ] = NULL;
 341
 342     /*
 343      * Call this function for all of the window's children recursively:
 344      */
 345     for( subWindow = (SFG_Window *)window->Children.First; subWindow;
 346          subWindow = (SFG_Window *)subWindow->Node.Next)
 347         fghRemoveMenuFromWindow( subWindow, menu );
 348 }
 349
 350 /*
 351  * This is a static helper function that removes menu references
 352  * from another menu, given two pointers to them...
 353  */
 354 static void fghRemoveMenuFromMenu( SFG_Menu* from, SFG_Menu* menu )
 355 {
 356   SFG_MenuEntry *entry;
 357
 358   for( entry = (SFG_MenuEntry *)from->Entries.First;
 359        entry;
 360        entry = (SFG_MenuEntry *)entry->Node.Next )
 361     if (entry->SubMenu == menu)
 362       entry->SubMenu = NULL;
 363 }
 364
 365 /*
 366  * This function destroys a menu specified by the parameter. All menus
 367  * and windows are updated to make sure no ill pointers hang around.
 368  */
 369 void fgDestroyMenu( SFG_Menu* menu )
 370 {
 371   SFG_Window *window;
 372   SFG_Menu *from;
 373   SFG_MenuEntry *entry;
 374
 375   assert( menu != NULL );
 376   freeglut_assert_ready;
 377
 378   /*
 379    * First of all, have all references to this menu removed from all windows:
 380    */
 381   for( window = (SFG_Window *)fgStructure.Windows.First;
 382        window;
 383        window = (SFG_Window *)window->Node.Next )
 384     fghRemoveMenuFromWindow( window, menu );
 385
 386   /*
 387    * Now proceed with removing menu entries that lead to this menu
 388    */
 389   for( from = (SFG_Menu *)fgStructure.Menus.First;
 390        from;
 391        from = (SFG_Menu *)from->Node.Next )
 392     fghRemoveMenuFromMenu( from, menu );
 393
 394   /*
 395    * If the programmer defined a destroy callback, call it
 396    * A. Donev: But first make this the active menu
 397    */
 398   if ( menu->Destroy != NULL )
 399   {
 400     SFG_Menu *activeMenu=fgStructure.Menu;
 401     fgStructure.Menu = menu;
 402     menu->Destroy () ;
 403     fgStructure.Menu = activeMenu;
 404   }
 405
 406   /*
 407    * Now we are pretty sure the menu is not used anywhere
 408    * and that we can remove all of its entries
 409    */
 410   while( (entry = (SFG_MenuEntry *)menu->Entries.First) != NULL )
 411   {
 412     fgListRemove(&menu->Entries, &entry->Node);
 413
 414     if( entry->Text )
 415         free( entry->Text );
 416     entry->Text = NULL;
 417
 418     free( entry );
 419     entry = NULL;
 420   }
 421
 422   if ( fgStructure.Window == menu->Window )
 423     fgSetWindow ( menu->ParentWindow ) ;
 424   fgDestroyWindow ( menu->Window, TRUE ) ;
 425   fgListRemove( &fgStructure.Menus, &menu->Node );
 426   if( fgStructure.Menu == menu )
 427     fgStructure.Menu = NULL;
 428
 429   free( menu );
 430 }
 431
 432 /*
 433  * This function should be called on glutInit(). It will prepare the internal
 434  * structure of freeglut to be used in the application. The structure will be
 435  * destroyed using fgDestroyStructure() on glutMainLoop() return. In that
 436  * case further use of freeglut should be preceeded with a glutInit() call.
 437  */
 438 void fgCreateStructure( void )
 439 {
 440   /*
 441    * We will be needing two lists: the first containing windows,
 442    * and the second containing the user-defined menus.
 443    * Also, no current window/menu is set, as none has been created yet.
 444    */
 445
 446   fgListInit(&fgStructure.Windows);
 447   fgListInit(&fgStructure.Menus);
 448 }
 449
 450 /*
 451  * This function is automatically called on glutMainLoop() return.
 452  * It should deallocate and destroy all remnants of previous
 453  * glutInit()-enforced structure initialization...
 454  */
 455 void fgDestroyStructure( void )
 456 {
 457   SFG_Window *window;
 458   SFG_Menu *menu;
 459
 460   freeglut_assert_ready;
 461
 462   /*
 463    * Make sure all windows and menus have been deallocated
 464    */
 465   while( (menu = (SFG_Menu *)fgStructure.Menus.First) != NULL )
 466     fgDestroyMenu( menu );
 467
 468   while( (window = (SFG_Window *)fgStructure.Windows.First) != NULL )
 469     fgDestroyWindow( window, TRUE );
 470 }
 471
 472 /*
 473  * Helper function to enumerate through all registered top-level windows
 474  */
 475 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator )
 476 {
 477   SFG_Window *window;
 478
 479   assert( (enumCallback != NULL) && (enumerator != NULL) );
 480   freeglut_assert_ready;
 481
 482   /*
 483    * Check every of the top-level windows
 484    */
 485   for( window = (SFG_Window *)fgStructure.Windows.First;
 486        window;
 487        window = (SFG_Window *)window->Node.Next )
 488   {
 489     enumCallback( window, enumerator );
 490     if( enumerator->found == TRUE )
 491       return;
 492   }
 493 }
 494
 495 /*
 496  * Helper function to enumerate through all a window's subwindows
 497  * (single level descent)
 498  */
 499 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
 500                        SFG_Enumerator* enumerator )
 501 {
 502   SFG_Window *child;
 503
 504   assert( (enumCallback != NULL) && (enumerator != NULL) );
 505   freeglut_assert_ready;
 506
 507   for( child = (SFG_Window *)window->Children.First;
 508        child;
 509        child = (SFG_Window *)child->Node.Next )
 510   {
 511     enumCallback( child, enumerator );
 512     if( enumerator->found == TRUE )
 513       return;
 514   }
 515 }
 516
 517 /*
 518  * A static helper function to look for a window given its handle
 519  */
 520 static void fghcbWindowByHandle( SFG_Window *window,
 521                                  SFG_Enumerator *enumerator )
 522 {
 523     freeglut_return_if_fail( enumerator->found == FALSE );
 524
 525 #if TARGET_HOST_UNIX_X11
 526     #define WBHANDLE (Window)
 527 #elif TARGET_HOST_WIN32
 528     #define WBHANDLE (HWND)
 529 #endif
 530
 531     /*
 532      * Check the window's handle. Hope this works. Looks ugly. That's for sure.
 533      */
 534     if( window->Window.Handle == WBHANDLE (enumerator->data) )
 535     {
 536         enumerator->found = TRUE;
 537         enumerator->data = window;
 538
 539         return;
 540     }
 541
 542     /*
 543      * Otherwise, check this window's children
 544      */
 545     fgEnumSubWindows( window, fghcbWindowByHandle, enumerator );
 546
 547 #undef WBHANDLE
 548 }
 549
 550 /*
 551  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
 552  * first window in the queue matching the specified window handle.
 553  * The function is defined in freeglut_structure.c file.
 554  */
 555 SFG_Window* fgWindowByHandle
 556 #if TARGET_HOST_UNIX_X11
 557 ( Window hWindow )
 558 #elif TARGET_HOST_WIN32
 559 ( HWND hWindow )
 560 #endif
 561 {
 562     SFG_Enumerator enumerator;
 563
 564     /*
 565      * This is easy and makes use of the windows enumeration defined above
 566      */
 567     enumerator.found = FALSE;
 568     enumerator.data = (void *)hWindow;
 569     fgEnumWindows( fghcbWindowByHandle, &enumerator );
 570
 571     if( enumerator.found == TRUE )
 572         return( SFG_Window *) enumerator.data;
 573     return NULL;
 574 }
 575
 576 /*
 577  * A static helper function to look for a window given its ID
 578  */
 579 static void fghcbWindowByID( SFG_Window *window, SFG_Enumerator *enumerator )
 580 {
 581     /*
 582      * Make sure we do not overwrite our precious results...
 583      */
 584     freeglut_return_if_fail( enumerator->found == FALSE );
 585
 586     /*
 587      * Check the window's handle. Hope this works. Looks ugly. That's for sure.
 588      */
 589     if( window->ID == (int) (enumerator->data) ) /* XXX int/ptr conversion! */
 590     {
 591         enumerator->found = TRUE;
 592         enumerator->data = window;
 593
 594         return;
 595     }
 596
 597     /*
 598      * Otherwise, check this window's children
 599      */
 600     fgEnumSubWindows( window, fghcbWindowByID, enumerator );
 601 }
 602
 603 /*
 604  * This function is similiar to the previous one, except it is
 605  * looking for a specified (sub)window identifier. The function
 606  * is defined in freeglut_structure.c file.
 607  */
 608 SFG_Window* fgWindowByID( int windowID )
 609 {
 610     SFG_Enumerator enumerator;
 611
 612     /*
 613      * Uses a method very similiar for fgWindowByHandle...
 614      */
 615     enumerator.found = FALSE;
 616     enumerator.data = (void *) windowID; /* XXX int/pointer conversion! */
 617     fgEnumWindows( fghcbWindowByID, &enumerator );
 618     if( enumerator.found == TRUE )
 619         return( SFG_Window *) enumerator.data;
 620     return NULL;
 621 }
 622
 623 /*
 624  * Looks up a menu given its ID. This is easier that fgWindowByXXX
 625  * as all menus are placed in a single doubly linked list...
 626  */
 627 SFG_Menu* fgMenuByID( int menuID )
 628 {
 629     SFG_Menu *menu = NULL;
 630
 631     freeglut_assert_ready;
 632
 633     /*
 634      * It's enough to check all entries in fgStructure.Menus...
 635      */
 636     for( menu = (SFG_Menu *)fgStructure.Menus.First;
 637          menu;
 638          menu = (SFG_Menu *)menu->Node.Next )
 639         if( menu->ID == menuID )
 640             return menu;
 641     return NULL;
 642 }
 643
 644 /*
 645  * List functions...
 646  */
 647 void fgListInit(SFG_List *list)
 648 {
 649     list->First = NULL;
 650     list->Last = NULL;
 651 }
 652
 653 void fgListAppend(SFG_List *list, SFG_Node *node)
 654 {
 655     SFG_Node *ln;
 656
 657     if ( (ln = (SFG_Node *)list->Last) != NULL )
 658     {
 659         ln->Next = node;
 660         node->Prev = ln;
 661     }
 662     else
 663     {
 664         node->Prev = NULL;
 665         list->First = node;
 666     }
 667
 668     node->Next = NULL;
 669     list->Last = node;
 670 }
 671
 672 void fgListRemove(SFG_List *list, SFG_Node *node)
 673 {
 674     SFG_Node *ln;
 675
 676     if ( (ln = (SFG_Node *)node->Next) != NULL )
 677         ln->Prev = node->Prev;
 678     if ( (ln = (SFG_Node *)node->Prev) != NULL )
 679         ln->Next = node->Next;
 680     if ( (ln = (SFG_Node *)list->First) == node )
 681         list->First = node->Next;
 682     if ( (ln = (SFG_Node *)list->Last) == node )
 683         list->Last = node->Prev;
 684 }
 685
 686 int fgListLength(SFG_List *list)
 687 {
 688     SFG_Node *node;
 689     int length = 0;
 690
 691     for( node = (SFG_Node *)list->First; node; node = (SFG_Node *)node->Next )
 692         ++length;
 693
 694     return length;
 695 }
 696
 697 /*** END OF FILE ***/