00001 #ifndef __glutint_h__
00002 #define __glutint_h__
00003 
00004 /* Copyright (c) Mark J. Kilgard, 1994. */
00005 
00006 /* This program is freely distributable without licensing fees 
00007    and is provided without guarantee or warrantee expressed or 
00008    implied. This program is -not- in the public domain. */
00009 
00010 #ifdef __sgi
00011 #define SUPPORT_FORTRAN
00012 #endif
00013 #include <X11/Xlib.h>
00014 #include <GL/glx.h>
00015 #include <GL/glut.h>
00016 #ifdef __vms
00017 struct timeval {
00018   __int64 val;
00019 };
00020 extern int sys$gettim(struct timeval *);
00021 #else
00022 #include <sys/types.h>
00023 #include <sys/time.h>
00024 #endif
00025 #if defined(__vms)
00026 
00027 /* One TICK on VMS is 100 nanoseconds; 0.1 microseconds or
00028    0.0001 milliseconds. This means that there are 0.01
00029    ticks/ns, 10 ticks/us, 10,000 ticks/ms and 10,000,000
00030    ticks/second. */
00031 
00032 #define TICKS_PER_MILLISECOND 10000
00033 #define TICKS_PER_SECOND      10000000
00034 
00035 #define GETTIMEOFDAY(_x) (void) sys$gettim (_x);
00036 
00037 #define ADD_TIME(dest, src1, src2) { \
00038   (dest).val = (src1).val + (src2).val; \
00039 }
00040 
00041 #define TIMEDELTA(dest, src1, src2) { \
00042   (dest).val = (src1).val - (src2).val; \
00043 }
00044 
00045 #define IS_AFTER(t1, t2) ((t2).val > (t1).val)
00046 
00047 #define IS_AT_OR_AFTER(t1, t2) ((t2).val >= (t1).val)
00048 
00049 #else
00050 #if defined(SVR4) && !defined(sun)  /* Sun claims SVR4, but wants 2 args. */
00051 #define GETTIMEOFDAY(_x) gettimeofday(_x)
00052 #else
00053 #define GETTIMEOFDAY(_x) gettimeofday(_x, (struct timezone*) NULL)
00054 #endif
00055 #define ADD_TIME(dest, src1, src2) { \
00056   if(((dest).tv_usec = \
00057     (src1).tv_usec + (src2).tv_usec) >= 1000000) { \
00058     (dest).tv_usec -= 1000000; \
00059     (dest).tv_sec = (src1).tv_sec + (src2).tv_sec + 1; \
00060   } else { \
00061     (dest).tv_sec = (src1).tv_sec + (src2).tv_sec; \
00062     if(((dest).tv_sec >= 1) && (((dest).tv_usec <0))) { \
00063       (dest).tv_sec --;(dest).tv_usec += 1000000; \
00064     } \
00065   } \
00066 }
00067 #define TIMEDELTA(dest, src1, src2) { \
00068   if(((dest).tv_usec = (src1).tv_usec - (src2).tv_usec) < 0) { \
00069     (dest).tv_usec += 1000000; \
00070     (dest).tv_sec = (src1).tv_sec - (src2).tv_sec - 1; \
00071   } else { \
00072      (dest).tv_sec = (src1).tv_sec - (src2).tv_sec; \
00073   } \
00074 }
00075 #define IS_AFTER(t1, t2) \
00076   (((t2).tv_sec > (t1).tv_sec) || \
00077   (((t2).tv_sec == (t1).tv_sec) && \
00078   ((t2).tv_usec > (t1).tv_usec)))
00079 #define IS_AT_OR_AFTER(t1, t2) \
00080   (((t2).tv_sec > (t1).tv_sec) || \
00081   (((t2).tv_sec == (t1).tv_sec) && \
00082   ((t2).tv_usec >= (t1).tv_usec)))
00083 #endif
00084 #define GLUT_WIND_IS_RGB(x)         (((x) & GLUT_INDEX) == 0)
00085 #define GLUT_WIND_IS_INDEX(x)       (((x) & GLUT_INDEX) != 0)
00086 #define GLUT_WIND_IS_SINGLE(x)      (((x) & GLUT_DOUBLE) == 0)
00087 #define GLUT_WIND_IS_DOUBLE(x)      (((x) & GLUT_DOUBLE) != 0)
00088 #define GLUT_WIND_HAS_ACCUM(x)      (((x) & GLUT_ACCUM) != 0)
00089 #define GLUT_WIND_HAS_ALPHA(x)      (((x) & GLUT_ALPHA) != 0)
00090 #define GLUT_WIND_HAS_DEPTH(x)      (((x) & GLUT_DEPTH) != 0)
00091 #define GLUT_WIND_HAS_STENCIL(x)    (((x) & GLUT_STENCIL) != 0)
00092 #define GLUT_WIND_IS_MULTISAMPLE(x) (((x) & GLUT_MULTISAMPLE) != 0)
00093 #define GLUT_WIND_IS_STEREO(x)      (((x) & GLUT_STEREO) != 0)
00094 #define GLUT_WIND_IS_LUMINANCE(x)   (((x) & GLUT_LUMINANCE) != 0)
00095 #define GLUT_MAP_WORK               (1 << 0)
00096 #define GLUT_EVENT_MASK_WORK        (1 << 1)
00097 #define GLUT_REDISPLAY_WORK         (1 << 2)
00098 #define GLUT_CONFIGURE_WORK         (1 << 3)
00099 #define GLUT_COLORMAP_WORK          (1 << 4)
00100 #define GLUT_DEVICE_MASK_WORK       (1 << 5)
00101 #define GLUT_FINISH_WORK            (1 << 6)
00102 #define GLUT_DEBUG_WORK             (1 << 7)
00103 #define GLUT_DUMMY_WORK             (1 << 8)
00104 #define GLUT_FULL_SCREEN_WORK       (1 << 9)
00105 #define GLUT_OVERLAY_REDISPLAY_WORK (1 << 10)
00106 /* GLUT callback function types */
00107 typedef void (*GLUTdisplayCB) (void);
00108 typedef void (*GLUTreshapeCB) (int, int);
00109 typedef void (*GLUTkeyboardCB) (unsigned char, int, int);
00110 typedef void (*GLUTmouseCB) (int, int, int, int);
00111 typedef void (*GLUTmotionCB) (int, int);
00112 typedef void (*GLUTpassiveCB) (int, int);
00113 typedef void (*GLUTentryCB) (int);
00114 typedef void (*GLUTvisibilityCB) (int);
00115 typedef void (*GLUTidleCB) (void);
00116 typedef void (*GLUTtimerCB) (int);
00117 typedef void (*GLUTmenuStateCB) (int);  /* DEPRICATED. */
00118 typedef void (*GLUTmenuStatusCB) (int, int, int);
00119 typedef void (*GLUTselectCB) (int);
00120 typedef void (*GLUTspecialCB) (int, int, int);
00121 typedef void (*GLUTspaceMotionCB) (int, int, int);
00122 typedef void (*GLUTspaceRotateCB) (int, int, int);
00123 typedef void (*GLUTspaceButtonCB) (int, int);
00124 typedef void (*GLUTdialsCB) (int, int);
00125 typedef void (*GLUTbuttonBoxCB) (int, int);
00126 typedef void (*GLUTtabletMotionCB) (int, int);
00127 typedef void (*GLUTtabletButtonCB) (int, int, int, int);
00128 #ifdef SUPPORT_FORTRAN
00129 typedef void (*GLUTdisplayFCB) (void);
00130 typedef void (*GLUTreshapeFCB) (int *, int *);
00131 /* NOTE the pressed key is int, not unsigned char for Fortran! */
00132 typedef void (*GLUTkeyboardFCB) (int *, int *, int *);
00133 typedef void (*GLUTmouseFCB) (int *, int *, int *, int *);
00134 typedef void (*GLUTmotionFCB) (int *, int *);
00135 typedef void (*GLUTpassiveFCB) (int *, int *);
00136 typedef void (*GLUTentryFCB) (int *);
00137 typedef void (*GLUTvisibilityFCB) (int *);
00138 typedef void (*GLUTidleFCB) (void);
00139 typedef void (*GLUTtimerFCB) (int *);
00140 typedef void (*GLUTmenuStateFCB) (int *);  /* DEPRICATED. */
00141 typedef void (*GLUTmenuStatusFCB) (int *, int *, int *);
00142 typedef void (*GLUTselectFCB) (int *);
00143 typedef void (*GLUTspecialFCB) (int *, int *, int *);
00144 typedef void (*GLUTspaceMotionFCB) (int *, int *, int *);
00145 typedef void (*GLUTspaceRotateFCB) (int *, int *, int *);
00146 typedef void (*GLUTspaceButtonFCB) (int *, int *);
00147 typedef void (*GLUTdialsFCB) (int *, int *);
00148 typedef void (*GLUTbuttonBoxFCB) (int *, int *);
00149 typedef void (*GLUTtabletMotionFCB) (int *, int *);
00150 typedef void (*GLUTtabletButtonFCB) (int *, int *, int *, int *);
00151 #endif
00152 typedef struct _GLUTcolorcell GLUTcolorcell;
00153 struct _GLUTcolorcell {
00154   /* GLUT_RED, GLUT_GREEN, GLUT_BLUE */
00155   GLfloat component[3];
00156 };
00157 typedef struct _GLUTcolormap GLUTcolormap;
00158 struct _GLUTcolormap {
00159   Visual *visual;       /* visual of the colormap */
00160   Colormap cmap;        /* X colormap ID */
00161   int refcnt;           /* number of windows using colormap */
00162   int size;             /* number of cells in colormap */
00163   int transparent;      /* transparent pixel, or -1 if opaque */
00164   GLUTcolorcell *cells; /* array of cells */
00165   GLUTcolormap *next;   /* next colormap in list */
00166 };
00167 typedef struct _GLUTwindow GLUTwindow;
00168 typedef struct _GLUToverlay GLUToverlay;
00169 struct _GLUTwindow {
00170   int num;              /* small integer window id (0-based) */
00171   /* Window system related state. */
00172   Window win;           /* X window for GLUT window */
00173   GLXContext ctx;       /* OpenGL context GLUT glut window */
00174   XVisualInfo *vis;     /* visual for window */
00175   Colormap cmap;        /* RGB colormap for window; None if CI */
00176   GLUTcolormap *colormap;  /* colormap; NULL if RGBA */
00177   GLUToverlay *overlay; /* overlay; NULL if no overlay */
00178   Window renderWin;     /* X window for rendering (might be
00179                            overlay) */
00180   GLXContext renderCtx; /* OpenGL context for rendering (might
00181                            be overlay) */
00182   /* GLUT settable or visible window state. */
00183   int width;            /* window width in pixels */
00184   int height;           /* window height in pixels */
00185   int cursor;           /* cursor name */
00186   int visState;         /* visibility state (-1 is unknown) */
00187   int shownState;       /* if window mapped */
00188   int entryState;       /* entry state (-1 is unknown) */
00189   int damaged;          /* is layer damaged by expose? */
00190 #define GLUT_MAX_MENUS              3
00191 
00192   int menu[GLUT_MAX_MENUS];  /* attatched menu nums */
00193   /* Window relationship state. */
00194   GLUTwindow *parent;   /* parent window */
00195   GLUTwindow *children; /* list of children */
00196   GLUTwindow *siblings; /* list of siblings */
00197   /* Misc. non-API visible (hidden) state. */
00198   Bool fakeSingle;      /* faking single buffer with double */
00199   Bool forceReshape;    /* force reshape before display */
00200   Bool isDirect;        /* if direct context */
00201   long eventMask;       /* mask of X events selected for */
00202   int buttonUses;       /* number of button uses, ref cnt */
00203   int tabletPos[2];     /* tablet position (-1 is invalid) */
00204   /* Work list related state. */
00205   unsigned int workMask;  /* mask of window work to be done */
00206   GLUTwindow *prevWorkWin;  /* link list of windows to work on */
00207   Bool desiredMapState; /* how to mapped window if on map work
00208                            list */
00209   int desiredConfMask;  /* mask of desired window configuration 
00210                          */
00211   int desiredX;         /* desired X location */
00212   int desiredY;         /* desired Y location */
00213   int desiredWidth;     /* desired window width */
00214   int desiredHeight;    /* desired window height */
00215   int desiredStack;     /* desired window stack */
00216   /* Callbacks */
00217   GLUTdisplayCB display;  /* redraw callback */
00218   GLUTreshapeCB reshape;  /* resize callback (width,height) */
00219   GLUTmouseCB mouse;    /* mouse callback (button,state,x,y) */
00220   GLUTmotionCB motion;  /* motion callback (x,y) */
00221   GLUTpassiveCB passive;  /* passive motion callback (x,y) */
00222   GLUTentryCB entry;    /* window entry/exit callback (state) */
00223   GLUTkeyboardCB keyboard;  /* keyboard callback (ASCII,x,y) */
00224   GLUTvisibilityCB visibility;  /* visibility callback */
00225   GLUTspecialCB special;  /* special key callback */
00226   GLUTbuttonBoxCB buttonBox;  /* button box callback */
00227   GLUTdialsCB dials;    /* dials callback */
00228   GLUTspaceMotionCB spaceMotion;  /* Spaceball motion callback */
00229   GLUTspaceRotateCB spaceRotate;  /* Spaceball rotate callback */
00230   GLUTspaceButtonCB spaceButton;  /* Spaceball button callback */
00231   GLUTtabletMotionCB tabletMotion;  /* tablet motion callback */
00232   GLUTtabletButtonCB tabletButton;  /* tablet button callback */
00233 #ifdef SUPPORT_FORTRAN
00234   /* Special Fortran display callback unneeded since no
00235      parameters! */
00236   GLUTreshapeFCB freshape;  /* Fortran reshape callback */
00237   GLUTmouseFCB fmouse;  /* Fortran mouse callback */
00238   GLUTmotionFCB fmotion;  /* Fortran motion callback */
00239   GLUTpassiveFCB fpassive;  /* Fortran passive callback */
00240   GLUTentryFCB fentry;  /* Fortran entry callback */
00241   GLUTkeyboardFCB fkeyboard;  /* Fortran keyboard callback */
00242   GLUTvisibilityFCB fvisibility;  /* Fortran visibility
00243                                      callback */
00244   GLUTspecialFCB fspecial;  /* special key callback */
00245   GLUTbuttonBoxFCB fbuttonBox;  /* button box callback */
00246   GLUTdialsFCB fdials;  /* dials callback */
00247   GLUTspaceMotionFCB fspaceMotion;  /* Spaceball motion
00248                                        callback */
00249   GLUTspaceRotateFCB fspaceRotate;  /* Spaceball rotate
00250                                        callback */
00251   GLUTspaceButtonFCB fspaceButton;  /* Spaceball button
00252                                        callback */
00253   GLUTtabletMotionFCB ftabletMotion;  /* tablet motion callback 
00254 
00255                                        */
00256   GLUTtabletButtonFCB ftabletButton;  /* tablet button callback 
00257 
00258                                        */
00259 #endif
00260 };
00261 struct _GLUToverlay {
00262   Window win;
00263   GLXContext ctx;
00264   XVisualInfo *vis;     /* visual for window */
00265   Colormap cmap;        /* RGB colormap for window; None if CI */
00266   GLUTcolormap *colormap;  /* colormap; NULL if RGBA */
00267   int shownState;       /* if overlay window mapped */
00268   Bool fakeSingle;      /* faking single buffer with double */
00269   Bool isDirect;        /* if direct context */
00270   int damaged;          /* is layer damaged by expose? */
00271   int transparentPixel; /* transparent pixel value */
00272   GLUTdisplayCB display;  /* redraw callback */
00273   /* Special Fortran display callback unneeded since no
00274      parameters! */
00275 };
00276 typedef struct _GLUTstale GLUTstale;
00277 struct _GLUTstale {
00278   GLUTwindow *window;
00279   Window win;
00280   GLUTstale *next;
00281 };
00282 
00283 extern GLUTstale *__glutStaleWindowList;
00284 #define GLUT_OVERLAY_EVENT_FILTER_MASK \
00285   (ExposureMask | \
00286   StructureNotifyMask | \
00287   EnterWindowMask | \
00288   LeaveWindowMask)
00289 #define GLUT_DONT_PROPAGATE_FILTER_MASK \
00290   (ButtonReleaseMask | \
00291   ButtonPressMask | \
00292   KeyPressMask | \
00293   KeyReleaseMask | \
00294   PointerMotionMask | \
00295   Button1MotionMask | \
00296   Button2MotionMask | \
00297   Button3MotionMask)
00298 #define GLUT_HACK_STOP_PROPAGATE_MASK \
00299   (KeyPressMask | \
00300   KeyReleaseMask)
00301 typedef struct _GLUTmenu GLUTmenu;
00302 typedef struct _GLUTmenuItem GLUTmenuItem;
00303 struct _GLUTmenu {
00304   int id;               /* small integer menu id (0-based) */
00305   Window win;           /* X window for the menu */
00306   GLUTselectCB select;  /* callback function of menu */
00307   GLUTmenuItem *list;   /* list of menu entries */
00308   int num;              /* number of entries */
00309   Bool managed;         /* are the InputOnly windows size
00310                            validated? */
00311   int pixwidth;         /* width of menu in pixels */
00312   int pixheight;        /* height of menu in pixels */
00313   int submenus;         /* number of submenu entries */
00314   GLUTmenuItem *highlighted;  /* pointer to highlighted menu
00315                                  entry, NULL not highlighted */
00316   GLUTmenu *cascade;    /* currently cascading this menu  */
00317   GLUTmenuItem *anchor; /* currently anchored to this entry */
00318   int x;                /* current x origin relative to the
00319                            root window */
00320   int y;                /* current y origin relative to the
00321                            root window */
00322 #ifdef SUPPORT_FORTRAN
00323   GLUTselectFCB fselect;  /* callback function of menu */
00324 #endif
00325 };
00326 struct _GLUTmenuItem {
00327   Window win;           /* InputOnly X window for entry */
00328   GLUTmenu *menu;       /* menu entry belongs to */
00329   Bool isTrigger;       /* is a submenu trigger? */
00330   int value;            /* value to return for selecting this
00331                            entry; doubles as submenu id
00332                            (0-base) if submenu trigger */
00333   char *label;          /* strdup'ed label string */
00334   int len;              /* length of label string */
00335   int pixwidth;         /* width of X window in pixels */
00336   GLUTmenuItem *next;   /* next menu entry on list for menu */
00337 };
00338 typedef struct _GLUTtimer GLUTtimer;
00339 struct _GLUTtimer {
00340   GLUTtimer *next;      /* list of timers */
00341   struct timeval timeout;  /* time to be called */
00342   GLUTtimerCB func;     /* timer callback (value) */
00343   int value;            /* callback return value */
00344 #ifdef SUPPORT_FORTRAN
00345   GLUTtimerFCB ffunc;   /* Fortran timer callback */
00346 #endif
00347 };
00348 typedef struct _GLUTeventParser GLUTeventParser;
00349 struct _GLUTeventParser {
00350   int (*func) (XEvent *);
00351   GLUTeventParser *next;
00352 };
00353 /* Declarations to implement glutFullScreen support with
00354    mwm/4Dwm. */
00355 
00356 /* The following X property format is defined in Motif 1.1's
00357    Xm/MwmUtils.h, but GLUT should not depend on that header
00358    file. Note: Motif 1.2 expanded this structure with
00359    uninteresting fields (to GLUT) so just stick with the
00360    smaller Motif 1.1 structure. */
00361 typedef struct {
00362 #define MWM_HINTS_DECORATIONS   2
00363   long flags;
00364   long functions;
00365   long decorations;
00366   long input_mode;
00367 } MotifWmHints;
00368 /* private variables from glut_event.c */
00369 extern GLUTwindow *__glutWindowWorkList;
00370 extern int __glutWindowDamaged;
00371 #ifdef SUPPORT_FORTRAN
00372 extern GLUTtimer *__glutTimerList;
00373 extern GLUTtimer *__glutNewTimer;
00374 #endif
00375 
00376 /* private variables from glut_init.c */
00377 extern Atom __glutWMDeleteWindow;
00378 extern Display *__glutDisplay;
00379 extern unsigned int __glutDisplayMode;
00380 extern GLboolean __glutDebug;
00381 extern GLboolean __glutForceDirect;
00382 extern GLboolean __glutIconic;
00383 extern GLboolean __glutTryDirect;
00384 extern Window __glutRoot;
00385 extern XSizeHints __glutSizeHints;
00386 extern char **__glutArgv;
00387 extern char *__glutProgramName;
00388 extern int __glutArgc;
00389 extern int __glutConnectionFD;
00390 extern int __glutInitHeight;
00391 extern int __glutInitWidth;
00392 extern int __glutInitX;
00393 extern int __glutInitY;
00394 extern int __glutScreen;
00395 extern int __glutScreenHeight;
00396 extern int __glutScreenWidth;
00397 extern Atom __glutMotifHints;
00398 extern unsigned int __glutModifierMask;
00399 
00400 /* private variables from glut_menu.c */
00401 extern GLUTmenu *__glutCurrentMenu;
00402 extern GLUTmenuItem *__glutItemSelected;
00403 extern GLUTmenu *__glutMappedMenu;
00404 extern GLUTwindow *__glutMenuWindow;
00405 extern void (*__glutMenuStatusFunc) (int, int, int);
00406 
00407 /* private variables from glut_win.c */
00408 extern GLUTwindow **__glutWindowList;
00409 extern GLUTwindow *__glutCurrentWindow;
00410 extern int __glutWindowListSize;
00411 extern void (*__glutFreeOverlayFunc) (GLUToverlay *);
00412 
00413 /* private routines from glut_cindex.c */
00414 extern GLUTcolormap *__glutAssociateColormap(XVisualInfo * vis);
00415 extern void __glutFreeColormap(GLUTcolormap *);
00416 
00417 /* private routines from glut_event.c */
00418 extern void (*__glutUpdateInputDeviceMaskFunc) (GLUTwindow *);
00419 extern void __glutPutOnWorkList(GLUTwindow * window,
00420   int work_mask);
00421 extern void __glutRegisterEventParser(GLUTeventParser * parser);
00422 extern void __glutPostRedisplay(GLUTwindow * window, int layerMask);
00423 
00424 /* private routines from glut_init.c */
00425 extern void __glutOpenXConnection(char *display);
00426 extern void __glutInitTime(struct timeval *beginning);
00427 
00428 /* private routines for glut_menu.c */
00429 extern GLUTmenu *__glutGetMenu(Window win);
00430 extern GLUTmenu *__glutGetMenuByNum(int menunum);
00431 extern GLUTmenuItem *__glutGetMenuItem(GLUTmenu * menu,
00432   Window win, int *which);
00433 extern void __glutFinishMenu(Window win, int x, int y);
00434 extern void __glutMenuItemEnterOrLeave(GLUTmenuItem * item,
00435   int num, int type);
00436 extern void __glutPaintMenu(GLUTmenu * menu);
00437 extern void __glutSetMenu(GLUTmenu * menu);
00438 extern void __glutStartMenu(GLUTmenu * menu,
00439   GLUTwindow * window, int x, int y, int x_win, int y_win);
00440 
00441 /* private routines from glut_util.c */
00442 extern void __glutWarning(char *format,...);
00443 extern void __glutFatalError(char *format,...);
00444 extern void __glutFatalUsage(char *format,...);
00445 
00446 /* private routines from glut_win.c */
00447 extern GLUTwindow *__glutGetWindow(Window win);
00448 extern GLUTwindow *__glutToplevelOf(GLUTwindow * window);
00449 extern void __glutChangeWindowEventMask(long mask, Bool add);
00450 extern void __glutEstablishColormapsProperty(
00451   GLUTwindow * window);
00452 extern XVisualInfo *__glutDetermineVisual(
00453   unsigned int mode,
00454   Bool * fakeSingle,
00455   XVisualInfo * (getVisualInfo) (unsigned int));
00456 extern XVisualInfo *__glutGetVisualInfo(unsigned int mode);
00457 extern void __glutSetWindow(GLUTwindow * window);
00458 extern void __glutReshapeFunc(GLUTreshapeCB reshapeFunc,
00459   int callingConvention);
00460 extern void __glutDefaultReshape(int, int);
00461 extern void __glutSetupColormap(
00462   XVisualInfo * vi,
00463   GLUTcolormap ** colormap,
00464   Colormap * cmap);
00465 
00466 /* private routines from glut_ext.c */
00467 extern int __glutIsSupportedByGLX(char *);
00468 
00469 /* private routines from glut_input.c */
00470 extern void __glutUpdateInputDeviceMask(GLUTwindow * window);
00471 
00472 #endif /* __glutint_h__ */