1 //
2 // "$Id: mac.H 8657 2011-05-12 11:50:43Z manolo $"
3 //
4 // Mac header file for the Fast Light Tool Kit (FLTK).
5 //
6 // Copyright 1998-2011 by Bill Spitzak and others.
7 //
8 // This library is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU Library General Public
10 // License as published by the Free Software Foundation; either
11 // version 2 of the License, or (at your option) any later version.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Library General Public License for more details.
17 //
18 // You should have received a copy of the GNU Library General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 // USA.
22 //
23 // Please report all bugs and problems on the following page:
24 //
25 // http://www.fltk.org/str.php
26 //
27
28 // Do not directly include this file, instead use <FL/x.H>. It will
29 // include this file if "__APPLE__" is defined. This is to encourage
30 // portability of even the system-specific code...
31 #ifndef FL_DOXYGEN
32
33 #if !defined(Fl_X_H)
34 # error "Never use <FL/mac.H> directly; include <FL/x.H> instead."
35 #endif // !Fl_X_H
36 #include <FL/Fl_Widget.H>
37
38 typedef void* Window; // this is really a pointer to the subclass FLWindow of NSWindow
39 typedef void* Fl_Offscreen; // this is really a CGContextRef
40 typedef void* Fl_Bitmask; // this is really a CGImageRef
41
42 #include <AvailabilityMacros.h>
43 #ifndef MAC_OS_X_VERSION_10_3
44 #define MAC_OS_X_VERSION_10_3 1030
45 #endif
46 #ifndef MAC_OS_X_VERSION_10_4
47 #define MAC_OS_X_VERSION_10_4 1040
48 #endif
49 #ifndef MAC_OS_X_VERSION_10_5
50 #define MAC_OS_X_VERSION_10_5 1050
51 #endif
52 #ifndef MAC_OS_X_VERSION_10_6
53 #define MAC_OS_X_VERSION_10_6 1060
54 #endif
55
56 #if !(defined(FL_LIBRARY) || defined(FL_INTERNALS)) // this part is used when compiling an application program
57
58 typedef void* Fl_Region;
59 typedef void* Fl_CGContextRef;
60 typedef void* Fl_PMPrintSettings;
61 typedef void* Fl_PMPageFormat;
62 typedef void* Fl_PMPrintSession;
63
64 #else // this part must be compiled when building the FLTK libraries
65
66 // Standard MacOS C/C++ includes...
67 #include <ApplicationServices/ApplicationServices.h>
68 #undef check // because of Fl::check()
69
70 typedef CGContextRef Fl_CGContextRef;
71 typedef PMPrintSettings Fl_PMPrintSettings;
72 typedef PMPageFormat Fl_PMPageFormat;
73 typedef PMPrintSession Fl_PMPrintSession;
74
75 typedef struct flCocoaRegion {
76 int count;
77 CGRect *rects;
78 } *Fl_Region; // a region is the union of a series of rectangles
79
80 # include "Fl_Window.H"
81
82 // Some random X equivalents
83 struct XPoint { int x, y; };
84 struct XRectangle {int x, y, width, height;};
85 #ifndef CGFLOAT_DEFINED //appears with 10.5 in CGBase.h
86 #if defined(__LP64__) && __LP64__
87 typedef double CGFloat;
88 #else
89 typedef float CGFloat;
90 #endif
91 #endif // CGFLOAT_DEFINED
92
93 extern CGRect fl_cgrectmake_cocoa(int x, int y, int w, int h);
XRectangleRegion(int x,int y,int w,int h)94 inline Fl_Region XRectangleRegion(int x, int y, int w, int h) {
95 Fl_Region R = (Fl_Region)malloc(sizeof(*R));
96 R->count = 1;
97 R->rects = (CGRect *)malloc(sizeof(CGRect));
98 *(R->rects) = fl_cgrectmake_cocoa(x, y, w, h);
99 return R;
100 }
XDestroyRegion(Fl_Region r)101 inline void XDestroyRegion(Fl_Region r) {
102 if(r) {
103 free(r->rects);
104 free(r);
105 }
106 }
107 extern void *fl_system_menu;
108 extern void *fl_default_cursor;
109
110 // This object contains all mac-specific stuff about a window:
111 // WARNING: this object is highly subject to change!
112 class Fl_X {
113
114 public:
115 Window xid; // pointer to the Cocoa window object (FLWindow*)
116 Fl_Offscreen other_xid; // pointer for offscreen bitmaps (overlay window)
117 Fl_Window *w; // FLTK window for
118 Fl_Region region;
119 Fl_Region subRegion; // region for this specific subwindow
120 Fl_X *next; // linked tree to support subwindows
121 Fl_X *xidChildren, *xidNext; // more subwindow tree
122 int wait_for_expose;
123 void *cursor; // is really NSCursor*
124 static Fl_X* first;
i(const Fl_Window * w)125 static Fl_X* i(const Fl_Window* w) {return w->i;}
126 static int fake_X_wm(const Fl_Window*,int&,int&,int&,int&,int&);
127 static void make(Fl_Window*);
128 void flush();
129 // Quartz additions:
130 CGContextRef gc; // graphics context (NULL when using QD)
131 static void q_fill_context(); // fill a Quartz context with current FLTK state
132 static void q_clear_clipping(); // remove all clipping from a Quartz context
133 static void q_release_context(Fl_X *x=0); // free all resources associated with fl_gc
134 static void q_begin_image(CGRect&, int x, int y, int w, int h);
135 static void q_end_image();
136 // Cocoa additions
137 void destroy(void);
138 void map(void);
139 void unmap(void);
140 int unlink(Fl_X* start = NULL);
141 void collapse(void);
142 WindowRef window_ref(void);
143 void set_key_window(void);
144 void set_cursor(Fl_Cursor);
145 static CGImageRef CGImage_from_window_rect(Fl_Window *win, int x, int y, int w, int h);
146 static unsigned char *bitmap_from_window_rect(Fl_Window *win, int x, int y, int w, int h, int *bytesPerPixel);
147 static Fl_Region intersect_region_and_rect(Fl_Region current, int x,int y,int w, int h);
148 static CGContextRef watch_cursor_image(void);
149 static CGContextRef help_cursor_image(void);
150 static CGContextRef nesw_cursor_image(void);
151 static CGContextRef nwse_cursor_image(void);
152 static CGContextRef none_cursor_image(void);
153 static void *get_carbon_function(const char *name);
154 private:
155 static void relink(Fl_Window*, Fl_Window*);
156 bool subwindow;
157 };
158
159 extern struct Fl_XMap {
160 RGBColor rgb;
161 ulong pen;
162 } *fl_current_xmap;
163 extern FL_EXPORT Window fl_window;
164
165 #endif // FL_LIBRARY || FL_INTERNALS
166
167 extern FL_EXPORT Fl_CGContextRef fl_gc;
168 extern FL_EXPORT class Fl_Sys_Menu_Bar *fl_sys_menu_bar;
169
170 extern Window fl_xid(const Fl_Window*);
171 void fl_clip_region(Fl_Region);
172
173 extern FL_EXPORT Fl_Bitmask fl_create_bitmask(int w, int h, const uchar *data);
174 extern FL_EXPORT Fl_Bitmask fl_create_alphamask(int w, int h, int d, int ld, const uchar *data);
175 extern FL_EXPORT void fl_delete_bitmask(Fl_Bitmask bm);
176 extern Fl_Offscreen fl_create_offscreen(int w, int h);
177 extern void fl_copy_offscreen(int x,int y,int w,int h, Fl_Offscreen gWorld, int srcx,int srcy);
178 extern void fl_delete_offscreen(Fl_Offscreen gWorld);
179 extern void fl_begin_offscreen(Fl_Offscreen gWorld);
180 extern void fl_end_offscreen();
181
182 extern FL_EXPORT int fl_parse_color(const char* p, uchar& r, uchar& g, uchar& b);
183 extern void fl_open_display();
184
185 #endif // FL_DOXYGEN
186
187 /** \defgroup group_macosx Mac OS X-specific symbols
188 Mac OS X-specific symbols declared in <FL/x.H> or <FL/gl.h>
189 @{ */
190
191 /** @brief Register a function called for each file dropped onto an application icon.
192 \e cb will be called with a single Unix-style file name and path.
193 If multiple files were dropped, \e cb will be called multiple times.
194 */
195 extern void fl_open_callback(void (*cb)(const char *));
196
197 /**
198 * \brief Attaches a callback to the "About myprog" item of the system application menu.
199 *
200 * \param cb a callback that will be called by "About myprog" menu item
201 * with NULL 1st argument.
202 * \param user_data a pointer transmitted as 2nd argument to the callback.
203 * \param shortcut optional shortcut to attach to the "About myprog" menu item (e.g., FL_META+'a')
204 */
205 extern void fl_mac_set_about( Fl_Callback *cb, void *user_data, int shortcut = 0);
206
207 /** \brief The version number of the running Mac OS X (e.g., 100604 for 10.6.4)
208 */
209 extern int fl_mac_os_version;
210
211 class Fl_Mac_App_Menu {
212 public:
213 /** Localizable text for the "About xxx" application menu item */
214 static const char *about;
215 /** Localizable text for the "Print Front Window" application menu item.
216 This menu item won't be displayed if Fl_Mac_App_Menu::print
217 is set to an empty string.
218 */
219 static const char *print;
220 /** Localizable text for the "Services" application menu item */
221 static const char *services;
222 /** Localizable text for the "Hide xxx" application menu item */
223 static const char *hide;
224 /** Localizable text for the "Hide Others" application menu item */
225 static const char *hide_others;
226 /** Localizable text for the "Show All" application menu item */
227 static const char *show;
228 /** Localizable text for the "Quit xxx" application menu item */
229 static const char *quit;
230 };
231
232 /** @} */
233
234 //
235 // End of "$Id: mac.H 8657 2011-05-12 11:50:43Z manolo $".
236 //
237
238