From http://www.jwz.org/xscreensaver/xscreensaver-5.35.tar.gz
[xscreensaver] / hacks / xlockmore.h
index 23f350e995d76c4eb04910e8155554290cc6559d..5572580d8e6e4dfe226e1768cd3bbe978080451d 100644 (file)
@@ -1,5 +1,5 @@
 /* xlockmore.h --- xscreensaver compatibility layer for xlockmore modules.
- * xscreensaver, Copyright (c) 1997 Jamie Zawinski <jwz@netscape.com>
+ * xscreensaver, Copyright (c) 1997-2012 Jamie Zawinski <jwz@jwz.org>
  *
  * Permission to use, copy, modify, distribute, and sell this software and its
  * documentation for any purpose is hereby granted without fee, provided that
  *
  * The definitions in this file make it possible to compile an xlockmore
  * module into a standalone program, and thus use it with xscreensaver.
- * By Jamie Zawinski <jwz@netscape.com> on 10-May-97; based on the ideas
+ * By Jamie Zawinski <jwz@jwz.org> on 10-May-97; based on the ideas
  * in the older xlock.h by Charles Hannum <mycroft@ai.mit.edu>.  (I had
  * to redo it, since xlockmore has diverged so far from xlock...)
  */
 
-#if !defined(PROGCLASS) || !defined(HACK_INIT) || !defined(HACK_DRAW)
-ERROR!  Define PROGCLASS, HACK_INIT, and HACK_DRAW before including xlockmore.h
-#endif
-
-#include "config.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif /* HAVE_CONFIG_H */
 
 #ifndef __STDC__
 ERROR!  Sorry, xlockmore.h requires ANSI C (gcc, for example.)
@@ -28,23 +26,17 @@ ERROR!  Sorry, xlockmore.h requires ANSI C (gcc, for example.)
      and cpp-based stringification of tokens.) */
 #endif
 
-#include <stdio.h>
-#include <math.h>
+#include "screenhackI.h"
 #include "xlockmoreI.h"
 
-#ifdef USE_GL
-# include <GL/glx.h>
-  extern GLXContext init_GL (ModeInfo *);
-# define FreeAllGL(dpy) /* */
-#endif
+# define ENTRYPOINT static
 
 /* Accessor macros for the ModeInfo structure
  */
-
 #define MI_DISPLAY(MI)         ((MI)->dpy)
 #define MI_WINDOW(MI)          ((MI)->window)
-#define MI_NUM_SCREENS(MI)     (1)     /* Only manage one screen at a time; */
-#define MI_SCREEN(MI)          (0)     /*  this might be fragile... */
+#define MI_NUM_SCREENS(MI)     ((MI)->num_screens)
+#define MI_SCREEN(MI)          ((MI)->screen_number)
 #define MI_WIN_WHITE_PIXEL(MI) ((MI)->white)
 #define MI_WIN_BLACK_PIXEL(MI) ((MI)->black)
 #define MI_NPIXELS(MI)         ((MI)->npixels)
@@ -52,10 +44,12 @@ ERROR!  Sorry, xlockmore.h requires ANSI C (gcc, for example.)
 #define MI_WIN_WIDTH(MI)       ((MI)->xgwa.width)
 #define MI_WIN_HEIGHT(MI)      ((MI)->xgwa.height)
 #define MI_WIN_DEPTH(MI)       ((MI)->xgwa.depth)
+#define MI_DEPTH(MI)           ((MI)->xgwa.depth)
 #define MI_WIN_COLORMAP(MI)    ((MI)->xgwa.colormap)
 #define MI_VISUAL(MI)          ((MI)->xgwa.visual)
 #define MI_GC(MI)              ((MI)->gc)
 #define MI_PAUSE(MI)           ((MI)->pause)
+#define MI_DELAY(MI)           ((MI)->pause)
 #define MI_WIN_IS_FULLRANDOM(MI)((MI)->fullrandom)
 #define MI_WIN_IS_VERBOSE(MI)   (False)
 #define MI_WIN_IS_INSTALL(MI)   (True)
@@ -73,6 +67,29 @@ ERROR!  Sorry, xlockmore.h requires ANSI C (gcc, for example.)
 #define MI_CYCLES(MI)          ((MI)->cycles)
 #define MI_BATCHCOUNT(MI)      ((MI)->batchcount)
 #define MI_SIZE(MI)            ((MI)->size)
+#define MI_IS_DRAWN(MI)                ((MI)->is_drawn)
+#define MI_IS_FPS(MI)          ((MI)->fps_p)
+#define MI_NCOLORS(MI)         ((MI)->npixels)
+#define MI_NAME(MI)            (progname)
+
+#define MI_COLORMAP(MI)                (MI_WIN_COLORMAP((MI)))
+#define MI_WIDTH(MI)           (MI_WIN_WIDTH((MI)))
+#define MI_HEIGHT(MI)          (MI_WIN_HEIGHT((MI)))
+#define MI_IS_ICONIC(MI)       (MI_WIN_IS_ICONIC((MI)))
+#define MI_IS_WIREFRAME(MI)    (MI_WIN_IS_WIREFRAME((MI)))
+#define MI_IS_MONO(MI)         (MI_WIN_IS_MONO((MI)))
+#define MI_COUNT(MI)           (MI_BATCHCOUNT((MI)))
+#define MI_BLACK_PIXEL(MI)     (MI_WIN_BLACK_PIXEL(MI))
+#define MI_WHITE_PIXEL(MI)     (MI_WIN_WHITE_PIXEL(MI))
+#define MI_IS_FULLRANDOM(MI)   (MI_WIN_IS_FULLRANDOM(MI))
+#define MI_IS_VERBOSE(MI)      (MI_WIN_IS_VERBOSE(MI))
+#define MI_IS_INSTALL(MI)      (MI_WIN_IS_INSTALL(MI))
+#define MI_IS_DEBUG(MI)                (False)
+#define MI_IS_MOUSE(MI)                (False)
+
+#define MI_CLEARWINDOW(mi) XClearWindow(MI_DISPLAY(mi), MI_WINDOW(mi))
+
+#define FreeAllGL(dpy)         /* */
 
 /* Some other utility macros.
  */
@@ -90,61 +107,93 @@ ERROR!  Sorry, xlockmore.h requires ANSI C (gcc, for example.)
 /* Maximum possible number of colors (*not* default number of colors.) */
 #define NUMCOLORS 256
 
-/* The globals that screenhack.c expects (initialized by xlockmore.c).
- */
-char *defaults[100];
-XrmOptionDescRec options[100];
 
-/* Prototypes for the actual drawing routines...
- */
-extern void HACK_INIT(ModeInfo *);
-extern void HACK_DRAW(ModeInfo *);
+/* In an Xlib world, we define two global symbols here:
+   a struct in `MODULENAME_xscreensaver_function_table',
+   and a pointer to that in `xscreensaver_function_table'.
 
-#ifdef HACK_FREE
-  extern void HACK_FREE(ModeInfo *);
+   In a Cocoa or Android world, we only define the prefixed symbol;
+   the un-prefixed symbol does not exist.
+ */
+#ifdef HAVE_MOBILE
+# define XSCREENSAVER_LINK(NAME)
 #else
-# define HACK_FREE 0
+# define XSCREENSAVER_LINK(NAME) \
+   struct xscreensaver_function_table *xscreensaver_function_table = &NAME;
 #endif
 
 
-/* Emit code for the entrypoint used by screenhack.c, and pass control
-   down into xlockmore.c with the appropriate parameters.
- */
+# if !defined(USE_GL) || defined(HAVE_COCOA) || defined(HAVE_ANDROID)
+#  define xlockmore_pick_gl_visual 0
+#  define xlockmore_validate_gl_visual 0
+# endif  /* !USE_GL || HAVE_COCOA || HAVE_ANDROID */
 
-char *progclass = PROGCLASS;
-
-void screenhack (Display *dpy, Window window)
-{
-  xlockmore_screenhack (dpy, window,
+# ifdef USE_GL
+#  define XLOCKMORE_FPS xlockmore_gl_compute_fps
+# else
+#  define XLOCKMORE_FPS xlockmore_do_fps
+# endif
 
 #ifdef WRITABLE_COLORS
-                       True,
+# undef WRITABLE_COLORS
+# define WRITABLE_COLORS 1
 #else
-                       False,
+# define WRITABLE_COLORS 0
 #endif
 
-#ifdef UNIFORM_COLORS
-                       True,
+#if defined(UNIFORM_COLORS)
+# define XLOCKMORE_COLOR_SCHEME color_scheme_uniform
+#elif defined(SMOOTH_COLORS)
+# define XLOCKMORE_COLOR_SCHEME color_scheme_smooth
+#elif defined(BRIGHT_COLORS)
+# define XLOCKMORE_COLOR_SCHEME color_scheme_bright
 #else
-                       False,
+# define XLOCKMORE_COLOR_SCHEME color_scheme_default
 #endif
 
-#ifdef SMOOTH_COLORS
-                       True,
-#else
-                       False,
-#endif
+/* This is the macro that links this program in with the rest of
+   xscreensaver.  For example:
 
-#ifdef BRIGHT_COLORS
-                       True,
-#else
-                       False,
-#endif
-
-                       HACK_INIT,
-                       HACK_DRAW,
-                       HACK_FREE);
-}
+     XSCREENSAVER_MODULE   ("Atlantis", atlantis)
+     XSCREENSAVER_MODULE_2 ("GLMatrix", glmatrix, matrix)
 
+   CLASS:   a string, the class name for resources.
+   NAME:    a token, the name of the executable.  Should be the same
+            as CLASS, but downcased.
+   PREFIX:  the symbol used in the function names, e.g., `draw_atlantis'.
 
-const char *app_defaults = DEFAULTS ;
+   NAME and PREFIX are usually the same.  If they are not, use
+   XSCREENSAVER_MODULE_2() instead of XSCREENSAVER_MODULE().
+ */
+#define XSCREENSAVER_MODULE_2(CLASS,NAME,PREFIX)                       \
+                                                                       \
+  static struct xlockmore_function_table                               \
+        NAME ## _xlockmore_function_table = {                  \
+          CLASS,                                                       \
+          DEFAULTS,                                                    \
+          WRITABLE_COLORS,                                             \
+          XLOCKMORE_COLOR_SCHEME,                                      \
+          init_    ## PREFIX,                                          \
+          draw_    ## PREFIX,                                          \
+          reshape_ ## PREFIX,                                          \
+          refresh_ ## PREFIX,                                          \
+          release_ ## PREFIX,                                          \
+          PREFIX   ## _handle_event,                                   \
+          & PREFIX ## _opts,                                           \
+          0                                                            \
+  };                                                                   \
+                                                                       \
+  struct xscreensaver_function_table                                   \
+        NAME ## _xscreensaver_function_table = {                       \
+          0, 0, 0,                                                     \
+          xlockmore_setup,                                             \
+          & NAME ## _xlockmore_function_table,                         \
+          0, 0, 0, 0, 0,                                               \
+           XLOCKMORE_FPS,                                              \
+           xlockmore_pick_gl_visual,                                   \
+          xlockmore_validate_gl_visual };                              \
+                                                                       \
+  XSCREENSAVER_LINK (NAME ## _xscreensaver_function_table)
+
+#define XSCREENSAVER_MODULE(CLASS,PREFIX)                              \
+      XSCREENSAVER_MODULE_2(CLASS,PREFIX,PREFIX)