SoWin.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2025 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef _SO_WIN_
#define _SO_WIN_
 
#ifdef _WIN32
#  include <Inventor/Win/SoWinBeginStrict.h>
#  include <string.h>
#  include <windows.h>
#  include <memory>
#  include <Inventor/Win/SoXt2SoWin.h>
#  include <Inventor/Win/SoWinDef.h>
#  include <Inventor/SbBasic.h>
#  include <SoVersion.h>
#  include <Inventor/Gui/SoGui.h>
#  define RESOURCE_DLL "Error: SoWin resources not loaded\n Cannot find InventorR.DLL"
#else
#  include <Xm/Xm.h>
#endif
#include <Inventor/threads/SbThreadMutex.h>
#include <Inventor/helpers/SbGlContextHelper.h>
 
#include <Inventor/Win/SoInventorWinLibName.h>
 
#include <Inventor/SoModule.h>
SO_MODULE_HEADER(SoInventorWin, __INVENTORWINDLL)
 
#ifndef InventorWin_EXPORTS
#ifndef OIV_DISABLE_AUTOLINK
#  pragma comment(lib,__INVENTORWINLIB)
#endif
#endif
 
#include <Inventor/SbBasic.h>
#include <Inventor/SbLinear.h>
#include <Inventor/sys/SoDynamicLibManager.h>
 
class SbPList;
class SoEvent;
class SoWinEventHandler;
class SoOffscreenRenderer;
class SoConsole;
class SbConfig;
class SoAction;
 
#ifdef _WIN32
// Under _WIN32 certain messages are only sent to the toplevel window
// (unlike X where any window can get any event), so SoWin provides an
// additional service.  Other SoWin classes can register a "message
// hook" to request that any time a particular message is sent to the
// toplevel window it will also be sent to that class's window proc.
// This mechanism (generally) requires the cooperation of the app in
// calling SoWin::IsInventorMessage in its message loop (similar to the
// existing Windows requirement to call IsDialogMessage and so on).
class SoWinMessageHook;
 
// Define some undocumented Windows messages used in SoWinGLWidget
// (supposedly will be defined in NT 3.51 and/or Windows95)
#ifndef WM_ENTERSIZEMOVE
#define WM_ENTERSIZEMOVE 0x0231
#endif
#ifndef WM_EXITSIZEMOVE
#define WM_EXITSIZEMOVE  0x0232
#endif
 
// Need this decl for error handler (see comments there)
class SoError;
 
extern CRITICAL_SECTION SoWinGLSection;
 
#define SOWIN_ENTER_GL_SECTION()\
EnterCriticalSection(&SoWinGLSection)
 
#define SOWIN_LEAVE_GL_SECTION()\
LeaveCriticalSection(&SoWinGLSection)
 
#define SOWIN_LEAVE_GL_SECTIONR()\
{\
LeaveCriticalSection(&SoWinGLSection);\
return;\
}
 
#define SOWIN_LEAVE_GL_SECTIONRV(v)\
{\
LeaveCriticalSection(&SoWinGLSection);\
return v;\
}
 
#define SOWIN_TIMER_MSG SoWin::wmTimerMsg
#define SOWIN_WORK_MSG  SoWin::wmWorkMsg
 
#else
 
#define SOWIN_ENTER_GL_SECTION()
#define SOWIN_LEAVE_GL_SECTION()
#define SOWIN_LEAVE_GL_SECTIONR()
#define SOWIN_LEAVE_GL_SECTIONRV(v)
 
#endif  //_WIN32

class  SoWin {
 
 public:
  static SoWidget init(const char *appName,
                     const char *className = "Inventor");

  static void init( SoWidget topLevelWidget );

  static void init();
 
#if 1             SoDEPRECATED
  static SoWidget threadInit(const char *appName, const char *className = "Inventor");
SoDEPRECATED
  static void threadInit(SoWidget topLevelWidget);
SoDEPRECATED
  static void threadInit();
#endif 

  static bool isInitialized();

  static void finish();

  static int mainLoop();

  static void exit(int returnCode = 0);

  static SbBool nextEvent(XtAppContext appContext, XEvent *event);

  static Boolean dispatchEvent(XEvent *event);

  static XtAppContext getAppContext();
  static SbGlContextHelper::Display getDisplay();

  static SoWidget getTopLevelWidget();
 
  //
  // Convenience routines
  //

  static void show(SoWidget w);

  static void hide(SoWidget w);

  static XmString encodeString(char *s);

  static char *decodeString(XmString xs);

  static void setWidgetSize(SoWidget w, const SbVec2s &size);
  static SbVec2s getWidgetSize(SoWidget w);
 
  // Convenience routine which will return the ShellWidget 
  // containing the given widget. The widget tree is traversed up until
  // a shell widget is found (using XtIsShell()).
  static SoWidget getShellWidget(SoWidget w);

  static void createSimpleErrorDialog(SoWidget widget, char *dialogTitle, 
                                      char *errorStr1, char *errorStr2 = NULL);

  static void getPopupArgs(UINT *d, int scr, ArgList args, int *n);

  static void addColormapToShell(SoWidget widget, SoWidget shell);

  static SoConsole *getErrorConsole(void);

  static void doIdleTasks(void);
 
 private:
  static bool peekEvent(XEvent *event);
 
  // This method is obsolete.
  // Processes message hooks defined by SoWin classes so they can get
  // notification of messages that are only passed to toplevel window.
  // Intended to be called by app as first thing in its window proc
  // (at this we consider this better than subclassing toplevel window).
  //
  // SoWin::windowProc makes this call when SoWin creates toplevel window.
  static LRESULT isInventorMessage(HWND hwnd, UINT message,
                                   WPARAM wParam, LPARAM lParam);
 
  // called when thread terminates
  static void terminate(long terminateSyncTime = 100);
  
  // This method processes thread messages.  It returns TRUE
  // if a message was processed.
  static SbBool PreTranslateMessage(MSG *event);
  
  static UINT wmTimerMsg;
  static UINT wmWorkMsg;
  
  // Add/remove the passed event handler for X extension device events
  // (Xt does not handle extension events.)
  // Extension event types are queried from the server at runtime.
  static void addExtensionEventHandler(SoWidget w,
                                       int extensionEventType,
                                       XtEventHandler proc, 
                                       XtPointer clientData);
  static void removeExtensionEventHandler(SoWidget w,
                                          int extensionEventType,
                                          XtEventHandler proc, 
                                          XtPointer clientData);
  
  // register a class and add it to the registered class list.
  static ATOM registerClass(WNDCLASS *pWndClass, char *actualClassName);
  
  // get information about a class if it has been registered
  static SbBool getClassInfo(HINSTANCE hDll, const char *className,
                             char *actualClassName, WNDCLASS *pClassInfo);
  
  // Called at DLL process detach
  static void unregisterProcessClasses();
  
  // Message hook functions (see long comment above)
  static void addMessageHook(Hwnd hwnd, UINT msg);
  static void removeMessageHook(Hwnd hwnd, UINT msg);
  
  // These member functions only exist to let the Inventor WinMain
  // function save these values for when we actually get around to
  // creating a window (or windows).  --mmh
  
  static void  setInstance(Hinst hInst);
  static Hinst getInstance(void);
  
  static const SoDynamicLibManager::SafeLibraryHandle& getResDllSafeHandle();
  
  static void setPrevInstance(Hinst hInst);
  
  static void setCmdLine(LPSTR cmdLine);
  
  static void setCmdShow(int cmdShow);
  
  // _WIN32 needs this get method for the SoWinEventHandler::xtTimerCallback
  // because we can't specify "client data" when we create the timer.
  
  static SoWinEventHandler *getEventHandler();
  
  // _WIN32 needs this method to identify so-called User Interface (UI)
  // threads (as opposed to Worker threads).  Any thread that creates a
  // window is obligated to process messages for that window (and any
  // others it created) and is considered a UI thread. Therefore any
  // thread that creates an Open Inventor viewer is a UI thread.
  // Worker threads are typically not associated with any window and do
  // not process messages, therefore SoWin does not allow them to
  // schedule timers.  A worker thread might be used to compute data
  // and modify a scene graph.
  //
  // All classes derived from SoWinComponent should call this method.
  // If called with no parameter, uses the current thread id.
  
  static void registerUIThread(uint32_t threadId = 0);
  
  static void forwardQueryPalette(Window hWnd);
  static void forwardPaletteChanged(Window hWnd);
  
  static SbBool handleCtl3DMessage();
  
  static void setHandleCtl3DMessage(SbBool n);
  
  static void Ctl3dColorChange();
  
  // Note: The default error handler in SoError writes to stderr,
  // which is generally the "bit bucket" for _WIN32 apps, so we
  // setup this handler which pops up a message dialog.  --mmh
  static void errorHandlerCB(const SoError *error, void *data);
  static void errorHandlerCBMessageBox(const SoError *error, void *userData);
  
  // Access to shared offscreen renderer for UI components
  static SoOffscreenRenderer *getOffscreenRenderer();
  
  // Make sure offscreen renderer's bitmap is at least this big.
  // Returns actual current size.
  static SbVec2s &updateRendererSize(SbVec2s size);
  
  // MP
  static SbConfig * getConfig(void);
  static void setConfig(SbConfig *);
  static void setConfigFilename(char*);
  static char * getConfigFilename(void);
 
  static void addAccelerator(ACCEL accel);
 
 private:
  static FARPROC m_procCtl3dColorChange;
  static HINSTANCE m_hCtl3d;
  static void   getExtensionEventHandler(XEvent *event, SoWidget &w, 
                                         XtEventHandler &proc, 
                                         XtPointer &clientData);
  // register mutex 
  static SbThreadMutex *registerMutex;
  
 private:
  static void activeLoop();
 
  static int s_returnCode;
 
  static bool internalMainWidget;
  static SoWidget mainWidget;
  static SoWinEventHandler *eventHandler;
  static SbPList *handlerList;
  
  // flag indicates whether or not we are processing CTL3D messages
  static SbBool nHandleCtl3D;
  
  // Message hook list
  static SbPList *msgHookList;
  
  // Resource DLL
  static void loadResourceDll();
  
  // Save initial values passed into WinMain function.
  static Hinst hInstance;
  static Hinst hPrevInstance;
  static LPTSTR lpszCmdLine;
  static int nCmdShow;
  static SoDynamicLibManager::SafeLibraryHandle hResDll;
  
  // List of classes registered by SoWin
  struct RegisteredClassStruct
  {
    Hinst hinstance;
    SbString* className;
  };
  static SbPList registeredClassList;
  
  friend class SoWinTimerManager;
  friend class SoWinEventHandler;
  
  static HWND createThreadWindow(SoWinTimerManager *pTimerManager);
  
  // SoWin contains the generic window proc for Inventor windows.
  // Among other things, it converts appropriate messages into
  // Inventor events.
  //
  // SoWin also provides a winmain function for Inventor programs
  // that only make SoWin calls, but it is not a member function.
  // It is a separate entity in the library so it is only linked
  // in when the app doesn't have its own winmain.
  static LRESULT CALLBACK WindowProc(Hwnd hwnd, UINT message,
                                     WPARAM wParam, LPARAM lParam);
  
  // Offscreen renderer for UI components to share
  // (reduces number of on-screen OpenGL contexts required).
  static SoOffscreenRenderer *m_pRenderer;
  
  static SoConsole *errorConsole;
  static SbBool s_useOldErrorHandler;
 
  static SbConfig *config;
  static char *configFile;
 
  static HACCEL m_haccel;
 
  static int s_initRefCount;
  static bool shouldExit;
};
 

//
// #duplicated nextEvent(XtAppContext appContext, XEvent * event)
//
 
#ifdef _WIN32
#   include <Inventor/Win/SoWinEndStrict.h>
#endif
 
#endif  /* _SO_WIN_ */