Replace FL/x.H with FL/platform.H - step 1.

This first step replaces FL/x.H with FL/platform.H but keeps a small
FL/x.H that #include's FL/platform.H for backwards compatibility.
Documentation sources in documentation/src/*.dox have been fixed,
but references in other source files need to be fixed in another step.
Dependencies have been adjusted.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12640 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

3 files changed, 174 insertions, 136 deletions

diff --git a/FL/platform.H b/FL/platform.H
new file mode 100644
index 000000000..7b54856db
--- /dev/null
+++ b/FL/platform.H
@@ -0,0 +1,162 @@
+//
+// "$Id$"
+//
+// Platform header file for the Fast Light Tool Kit (FLTK).
+//
+// Copyright 1998-2018 by Bill Spitzak and others.
+//
+// This library is free software. Distribution and use rights are outlined in
+// the file "COPYING" which should have been included with this file.  If this
+// file is missing or damaged, see the license at:
+//
+//     http://www.fltk.org/COPYING.php
+//
+// Please report all bugs and problems on the following page:
+//
+//     http://www.fltk.org/str.php
+//
+
+// These are FLTK symbols that are necessary or useful for calling
+// platform specific functions. This file #include's certain platform
+// specific system header files that are necessary to declare platform
+// specific FLTK functions, for instance "Windows.h" under Windows.
+
+// You should include this file if (and ONLY if) you need to call
+// platform specific functions directly.
+
+// See FLTK documentation: chapter "Operating System Issues" on when
+// you need to #include <FL/platform.H>
+
+#if !defined(FL_PLATFORM_H) && !defined(FL_DOXYGEN)
+#  define FL_PLATFORM_H
+
+#   include <FL/Fl_Export.H>
+#   include <FL/platform_types.h>
+#   include <FL/fl_types.h> // for uchar
+class Fl_Window;
+
+#  ifdef WIN32
+#    include "win32.H"
+#  elif defined(__APPLE__)
+#    include "mac.H"
+#  elif defined(USE_SDL)
+#    pragma message "FL_PORTING: write a header file based on this file, win32.H, or mac.H to define the FLTK core internals"
+#    include "porting.H"
+#  elif defined(FL_PORTING)
+#    pragma message "FL_PORTING: write a header file based on this file, win32.H, or mac.H to define the FLTK core internals"
+#    include "porting.H"
+#  else // X11
+#   include <FL/fl_types.h>
+#   include <FL/Enumerations.H>
+#    if !defined(USE_X11)
+#      define USE_X11 1
+#    endif
+#    if defined(_ABIN32) || defined(_ABI64) // fix for broken SGI Irix X .h files
+#      pragma set woff 3322
+#    endif
+#    include <X11/Xlib.h>
+#    include <X11/Xutil.h>
+#    if defined(_ABIN32) || defined(_ABI64)
+#      pragma reset woff 3322
+#    endif
+#    include <X11/Xatom.h>
+
+FL_EXPORT void fl_open_display(Display*);
+
+// constant info about the X server connection:
+extern FL_EXPORT Display *fl_display;
+extern FL_EXPORT int fl_screen;
+extern FL_EXPORT XVisualInfo *fl_visual;
+extern FL_EXPORT Colormap fl_colormap;
+
+// drawing functions:
+extern FL_EXPORT GC fl_gc;
+FL_EXPORT ulong fl_xpixel(Fl_Color i);
+FL_EXPORT ulong fl_xpixel(uchar r, uchar g, uchar b);
+
+// feed events into fltk:
+FL_EXPORT int fl_handle(const XEvent&);
+
+// you can use these in Fl::add_handler() to look at events:
+extern FL_EXPORT const XEvent* fl_xevent;
+extern FL_EXPORT ulong fl_event_time;
+
+#if defined(FL_LIBRARY) || defined(FL_INTERNALS)
+extern FL_EXPORT Window fl_message_window;
+extern FL_EXPORT void *fl_xftfont;
+
+// access to core fonts:
+// This class provides a "smart pointer" that returns a pointer to an XFontStruct.
+// The global variable fl_xfont can be called wherever a bitmap "core" font is
+// needed, e.g. when rendering to a GL context under X11.
+// With Xlib / X11 fonts, fl_xfont will return the current selected font.
+// With XFT / X11 fonts, fl_xfont will attempt to return the bitmap "core" font most
+// similar to (usually the same as) the current XFT font.
+class FL_EXPORT Fl_XFont_On_Demand
+{
+public:
+  Fl_XFont_On_Demand(XFontStruct* p = NULL) : ptr(p) { }
+  Fl_XFont_On_Demand& operator=(const Fl_XFont_On_Demand& x)
+  { ptr = x.ptr;  return *this; }
+  Fl_XFont_On_Demand& operator=(XFontStruct* p)
+  { ptr = p;  return *this; }
+  XFontStruct* value();
+  operator XFontStruct*() { return value(); }
+  XFontStruct& operator*() { return *value(); }
+  XFontStruct* operator->() { return value(); }
+  bool operator==(const Fl_XFont_On_Demand& x) { return ptr == x.ptr; }
+  bool operator!=(const Fl_XFont_On_Demand& x) { return ptr != x.ptr; }
+private:
+  XFontStruct *ptr;
+};
+extern FL_EXPORT Fl_XFont_On_Demand fl_xfont;
+
+extern FL_EXPORT char fl_override_redirect; // hack into Fl_X::make_xid()
+extern FL_EXPORT int fl_background_pixel;  // hack into Fl_X::make_xid()
+
+#endif // FL_LIBRARY || FL_INTERNALS
+
+#  endif // X11
+
+//
+// cross-platform declarations
+//
+#if defined(FL_LIBRARY) || defined(FL_INTERNALS)
+#  include <FL/Fl_Window.H>
+
+class FL_EXPORT Fl_X {
+public:
+  Window xid;
+  Fl_Window* w;
+  Fl_Region region;
+  Fl_X *next;
+  // static variables, static functions and member functions
+  static Fl_X* first;
+  static Fl_X* i(const Fl_Window* w) {return (Fl_X*)w->i;}
+#  if defined(USE_X11) // for backward compatibility
+  static void make_xid(Fl_Window*, XVisualInfo* =fl_visual, Colormap=fl_colormap);
+  static Fl_X* set_xid(Fl_Window*, Window);
+#  endif
+};
+
+inline Window fl_xid(const Fl_Window* w) { Fl_X *xTemp = Fl_X::i(w); return xTemp ? xTemp->xid : 0; }
+#else
+extern FL_EXPORT Window fl_xid_(const Fl_Window* w);
+#  define fl_xid(w) fl_xid_(w)
+#endif // FL_LIBRARY || FL_INTERNALS
+
+extern FL_EXPORT Fl_Window* fl_find(Window xid);
+extern FL_EXPORT void fl_open_display();
+extern FL_EXPORT void fl_close_display();
+extern FL_EXPORT Window fl_window;
+extern FL_EXPORT Fl_Bitmask fl_create_bitmask(int w, int h, const uchar *data);
+extern FL_EXPORT Fl_Bitmask fl_create_alphamask(int w, int h, int d, int ld, const uchar *data);
+extern FL_EXPORT void fl_delete_bitmask(Fl_Bitmask bm);
+extern FL_EXPORT int fl_parse_color(const char* p, uchar& r, uchar& g, uchar& b);
+extern FL_EXPORT void fl_open_callback(void (*)(const char *));
+
+#endif // !FL_PLATFORM_H
+
+//
+// End of "$Id$".
+//
diff --git a/FL/platform_types.h b/FL/platform_types.h
index ab91f41a0..ce2e6718f 100644
--- a/FL/platform_types.h
+++ b/FL/platform_types.h
@@ -1,7 +1,7 @@
 /*
  * "$Id$"
  *
- * Copyright 2016 by Bill Spitzak and others.
+ * Copyright 2016-2018 by Bill Spitzak and others.
  *
  * This library is free software. Distribution and use rights are outlined in
  * the file "COPYING" which should have been included with this file.  If this
@@ -14,8 +14,8 @@
  *     http://www.fltk.org/str.php
  */
 
-#ifndef PLATFORM_TYPES_H
-#define PLATFORM_TYPES_H
+#ifndef FL_PLATFORM_TYPES_H
+#define FL_PLATFORM_TYPES_H
 
 /* Platform-dependent types are defined here.
   These types must be defined by any platform:
@@ -120,7 +120,7 @@ typedef struct __GLXcontextRec *GLContext;
 #  define FL_CONTROL	FL_META   /**< An alias for FL_META on WIN32 and X11, or FL_CTRL on MacOS X */
 #endif
 
-#endif /* PLATFORM_TYPES_H */
+#endif /* FL_PLATFORM_TYPES_H */
 
 /*
  * End of "$Id$".
diff --git a/FL/x.H b/FL/x.H
index e3191618d..4fb9873a1 100644
--- a/FL/x.H
+++ b/FL/x.H
@@ -1,9 +1,9 @@
 //
 // "$Id$"
 //
-// X11 header file for the Fast Light Tool Kit (FLTK).
+// *Deprecated* platform header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2017 by Bill Spitzak and others.
+// Copyright 1998-2018 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
 // the file "COPYING" which should have been included with this file.  If this
@@ -16,139 +16,15 @@
 //     http://www.fltk.org/str.php
 //
 
-// These are internal fltk symbols that are necessary or useful for
-// calling Xlib.  You should include this file if (and ONLY if) you
-// need to call Xlib directly.  These symbols may not exist on non-X
-// systems.
+// IMPORTANT: This file is deprecated since FLTK 1.4.0. DO NOT include it.
+// FL/x.H will be removed in a future FLTK release.
+
+// Please #include <FL/platform.H> instead if you really need it. See
+// documentation in FL/platform.H to decide whether you need that file.
 
 #if !defined(Fl_X_H) && !defined(FL_DOXYGEN) 
 #  define Fl_X_H
-
-#   include <FL/Fl_Export.H>
-#   include <FL/platform_types.h>
-#   include <FL/fl_types.h> // for uchar
-class Fl_Window;
-
-#  ifdef WIN32
-#    include "win32.H"
-#  elif defined(__APPLE__)
-#    include "mac.H"
-#  elif defined(USE_SDL)
-#    pragma message "FL_PORTING: write a header file based on this file, win32.H, or mac.H to define the FLTK core internals"
-#    include "porting.H"
-#  elif defined(FL_PORTING)
-#    pragma message "FL_PORTING: write a header file based on this file, win32.H, or mac.H to define the FLTK core internals"
-#    include "porting.H"
-#  else // X11
-#   include <FL/fl_types.h>
-#   include <FL/Enumerations.H>
-#    if !defined(USE_X11)
-#      define USE_X11 1
-#    endif
-#    if defined(_ABIN32) || defined(_ABI64) // fix for broken SGI Irix X .h files
-#      pragma set woff 3322
-#    endif
-#    include <X11/Xlib.h>
-#    include <X11/Xutil.h>
-#    if defined(_ABIN32) || defined(_ABI64)
-#      pragma reset woff 3322
-#    endif
-#    include <X11/Xatom.h>
-
-FL_EXPORT void fl_open_display(Display*);
-
-// constant info about the X server connection:
-extern FL_EXPORT Display *fl_display;
-extern FL_EXPORT int fl_screen;
-extern FL_EXPORT XVisualInfo *fl_visual;
-extern FL_EXPORT Colormap fl_colormap;
-
-// drawing functions:
-extern FL_EXPORT GC fl_gc;
-FL_EXPORT ulong fl_xpixel(Fl_Color i);
-FL_EXPORT ulong fl_xpixel(uchar r, uchar g, uchar b);
-
-// feed events into fltk:
-FL_EXPORT int fl_handle(const XEvent&);
-
-// you can use these in Fl::add_handler() to look at events:
-extern FL_EXPORT const XEvent* fl_xevent;
-extern FL_EXPORT ulong fl_event_time;
-
-#if defined(FL_LIBRARY) || defined(FL_INTERNALS)
-extern FL_EXPORT Window fl_message_window;
-extern FL_EXPORT void *fl_xftfont;
-
-// access to core fonts:
-// This class provides a "smart pointer" that returns a pointer to an XFontStruct.
-// The global variable fl_xfont can be called wherever a bitmap "core" font is
-// needed, e.g. when rendering to a GL context under X11.
-// With Xlib / X11 fonts, fl_xfont will return the current selected font.
-// With XFT / X11 fonts, fl_xfont will attempt to return the bitmap "core" font most
-// similar to (usually the same as) the current XFT font.
-class FL_EXPORT Fl_XFont_On_Demand
-{
-public:
-  Fl_XFont_On_Demand(XFontStruct* p = NULL) : ptr(p) { }
-  Fl_XFont_On_Demand& operator=(const Fl_XFont_On_Demand& x)
-  { ptr = x.ptr;  return *this; }
-  Fl_XFont_On_Demand& operator=(XFontStruct* p)
-  { ptr = p;  return *this; }
-  XFontStruct* value();
-  operator XFontStruct*() { return value(); }
-  XFontStruct& operator*() { return *value(); }
-  XFontStruct* operator->() { return value(); }
-  bool operator==(const Fl_XFont_On_Demand& x) { return ptr == x.ptr; }
-  bool operator!=(const Fl_XFont_On_Demand& x) { return ptr != x.ptr; }
-private:
-  XFontStruct *ptr;
-};
-extern FL_EXPORT Fl_XFont_On_Demand fl_xfont;
-
-extern FL_EXPORT char fl_override_redirect; // hack into Fl_X::make_xid()
-extern FL_EXPORT int fl_background_pixel;  // hack into Fl_X::make_xid()
-
-#endif // FL_LIBRARY || FL_INTERNALS
-
-#  endif // X11
-
-//
-// cross-platform declarations
-//
-#if defined(FL_LIBRARY) || defined(FL_INTERNALS)
-#  include <FL/Fl_Window.H>
-
-class FL_EXPORT Fl_X {
-public:
-  Window xid;
-  Fl_Window* w;
-  Fl_Region region;
-  Fl_X *next;
-  // static variables, static functions and member functions
-  static Fl_X* first;
-  static Fl_X* i(const Fl_Window* w) {return (Fl_X*)w->i;}
-#  if defined(USE_X11) // for backward compatibility
-  static void make_xid(Fl_Window*, XVisualInfo* =fl_visual, Colormap=fl_colormap);
-  static Fl_X* set_xid(Fl_Window*, Window);
-#  endif
-};
-
-inline Window fl_xid(const Fl_Window* w) { Fl_X *xTemp = Fl_X::i(w); return xTemp ? xTemp->xid : 0; }
-#else
-extern FL_EXPORT Window fl_xid_(const Fl_Window* w);
-#  define fl_xid(w) fl_xid_(w)
-#endif // FL_LIBRARY || FL_INTERNALS
-
-extern FL_EXPORT Fl_Window* fl_find(Window xid);
-extern FL_EXPORT void fl_open_display();
-extern FL_EXPORT void fl_close_display();
-extern FL_EXPORT Window fl_window;
-extern FL_EXPORT Fl_Bitmask fl_create_bitmask(int w, int h, const uchar *data);
-extern FL_EXPORT Fl_Bitmask fl_create_alphamask(int w, int h, int d, int ld, const uchar *data);
-extern FL_EXPORT void fl_delete_bitmask(Fl_Bitmask bm);
-extern FL_EXPORT int fl_parse_color(const char* p, uchar& r, uchar& g, uchar& b);
-extern FL_EXPORT void fl_open_callback(void (*)(const char *));
-
+#  include <FL/platform.H>
 #endif // !Fl_X_H
 
 //