blob: 2286ebe1a99efe576239dd572e773582736953fc [file] [log] [blame]
Jack Jansen9d8b96c2000-07-14 22:16:45 +00001/*
Jack Jansen94bebc02001-08-08 13:17:31 +00002** pymactoolbox.h - globals defined in mactoolboxglue.c
Jack Jansen9d8b96c2000-07-14 22:16:45 +00003*/
Jack Jansen47ec1412002-09-10 12:32:47 +00004#ifndef Py_PYMACTOOLBOX_H
5#define Py_PYMACTOOLBOX_H
Jack Jansen9d8b96c2000-07-14 22:16:45 +00006#ifdef __cplusplus
7 extern "C" {
8#endif
9
Jack Jansen9f66b4a2001-05-19 12:32:39 +000010#ifdef WITHOUT_FRAMEWORKS
Jack Jansen9d8b96c2000-07-14 22:16:45 +000011#include <Memory.h>
12#include <Dialogs.h>
13#include <Menus.h>
14#include <Controls.h>
15#include <Components.h>
16#include <Lists.h>
17#include <Movies.h>
18#include <Errors.h>
Jack Jansen537a69f2001-11-05 14:39:22 +000019#include <CFBase.h>
20#include <CFArray.h>
21#include <CFData.h>
22#include <CFDictionary.h>
23#include <CFString.h>
24#include <CFURL.h>
Jack Jansen9f66b4a2001-05-19 12:32:39 +000025#else
26#include <Carbon/Carbon.h>
27#include <QuickTime/QuickTime.h>
28#endif
Jack Jansen9d8b96c2000-07-14 22:16:45 +000029
Jack Jansen94bebc02001-08-08 13:17:31 +000030/*
31** Helper routines for error codes and such.
32*/
33char *PyMac_getscript(void); /* Get the default encoding for our 8bit character set */
34char *PyMac_StrError(int); /* strerror with mac errors */
35PyObject *PyErr_Mac(PyObject *, int); /* Exception with a mac error */
36PyObject *PyMac_Error(OSErr); /* Uses PyMac_GetOSErrException */
Jack Jansen7b049462001-09-10 22:09:30 +000037extern OSErr PyMac_GetFullPathname(FSSpec *, char *, int); /* convert fsspec->path */
Jack Jansen21ed16a2002-08-02 14:11:24 +000038#ifdef WITH_NEXT_FRAMEWORK
39extern char *PyMac_GetAppletScriptFile(void); /* Return applet script file or NULL */
40#endif
Jack Jansen94bebc02001-08-08 13:17:31 +000041/*
42** These conversion routines are defined in mactoolboxglue.c itself.
43*/
44int PyMac_GetOSType(PyObject *, OSType *); /* argument parser for OSType */
45PyObject *PyMac_BuildOSType(OSType); /* Convert OSType to PyObject */
46
47PyObject *PyMac_BuildNumVersion(NumVersion);/* Convert NumVersion to PyObject */
48
49int PyMac_GetStr255(PyObject *, Str255); /* argument parser for Str255 */
50PyObject *PyMac_BuildStr255(Str255); /* Convert Str255 to PyObject */
51PyObject *PyMac_BuildOptStr255(Str255); /* Convert Str255 to PyObject, NULL to None */
52
53int PyMac_GetRect(PyObject *, Rect *); /* argument parser for Rect */
54PyObject *PyMac_BuildRect(Rect *); /* Convert Rect to PyObject */
55
56int PyMac_GetPoint(PyObject *, Point *); /* argument parser for Point */
57PyObject *PyMac_BuildPoint(Point); /* Convert Point to PyObject */
58
59int PyMac_GetEventRecord(PyObject *, EventRecord *); /* argument parser for EventRecord */
60PyObject *PyMac_BuildEventRecord(EventRecord *); /* Convert EventRecord to PyObject */
61
62int PyMac_GetFixed(PyObject *, Fixed *); /* argument parser for Fixed */
63PyObject *PyMac_BuildFixed(Fixed); /* Convert Fixed to PyObject */
64int PyMac_Getwide(PyObject *, wide *); /* argument parser for wide */
65PyObject *PyMac_Buildwide(wide *); /* Convert wide to PyObject */
66
67/*
68** The rest of the routines are implemented by extension modules. If they are
69** dynamically loaded mactoolboxglue will contain a stub implementation of the
70** routine, which imports the module, whereupon the module's init routine will
71** communicate the routine pointer back to the stub.
72** If USE_TOOLBOX_OBJECT_GLUE is not defined there is no glue code, and the
73** extension modules simply declare the routine. This is the case for static
74** builds (and could be the case for MacPython CFM builds, because CFM extension
75** modules can reference each other without problems).
76*/
77
Jack Jansenf57a4a22001-05-17 22:11:44 +000078#ifdef USE_TOOLBOX_OBJECT_GLUE
79/*
80** These macros are used in the module init code. If we use toolbox object glue
81** it sets the function pointer to point to the real function.
82*/
Jack Jansen0268ac82001-05-22 22:34:56 +000083#define PyMac_INIT_TOOLBOX_OBJECT_NEW(object, rtn) { \
Jack Jansenf57a4a22001-05-17 22:11:44 +000084 extern PyObject *(*PyMacGluePtr_##rtn)(object); \
85 PyMacGluePtr_##rtn = _##rtn; \
86}
Jack Jansen0268ac82001-05-22 22:34:56 +000087#define PyMac_INIT_TOOLBOX_OBJECT_CONVERT(object, rtn) { \
88 extern int (*PyMacGluePtr_##rtn)(PyObject *, object *); \
Jack Jansenf57a4a22001-05-17 22:11:44 +000089 PyMacGluePtr_##rtn = _##rtn; \
90}
91#else
92/*
93** If we don't use toolbox object glue the init macros are empty. Moreover, we define
94** _xxx_New to be the same as xxx_New, and the code in mactoolboxglue isn't included.
95*/
Jack Jansen0268ac82001-05-22 22:34:56 +000096#define PyMac_INIT_TOOLBOX_OBJECT_NEW(object, rtn)
97#define PyMac_INIT_TOOLBOX_OBJECT_CONVERT(object, rtn)
Jack Jansenf57a4a22001-05-17 22:11:44 +000098#endif /* USE_TOOLBOX_OBJECT_GLUE */
99
Jack Jansena5bca572001-08-03 15:39:27 +0000100/* macfs exports */
Jack Jansenfabd00f2001-09-01 23:39:58 +0000101int PyMac_GetFSSpec(PyObject *, FSSpec *); /* argument parser for FSSpec */
102PyObject *PyMac_BuildFSSpec(FSSpec *); /* Convert FSSpec to PyObject */
103
104int PyMac_GetFSRef(PyObject *, FSRef *); /* argument parser for FSRef */
105PyObject *PyMac_BuildFSRef(FSRef *); /* Convert FSRef to PyObject */
Jack Jansena5bca572001-08-03 15:39:27 +0000106
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000107/* AE exports */
108extern PyObject *AEDesc_New(AppleEvent *); /* XXXX Why passed by address?? */
Jack Jansenb2a57722003-01-17 23:11:17 +0000109extern PyObject *AEDesc_NewBorrowed(AppleEvent *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000110extern int AEDesc_Convert(PyObject *, AppleEvent *);
111
112/* Cm exports */
113extern PyObject *CmpObj_New(Component);
114extern int CmpObj_Convert(PyObject *, Component *);
115extern PyObject *CmpInstObj_New(ComponentInstance);
116extern int CmpInstObj_Convert(PyObject *, ComponentInstance *);
117
118/* Ctl exports */
119extern PyObject *CtlObj_New(ControlHandle);
120extern int CtlObj_Convert(PyObject *, ControlHandle *);
121
122/* Dlg exports */
123extern PyObject *DlgObj_New(DialogPtr);
124extern int DlgObj_Convert(PyObject *, DialogPtr *);
Jack Jansenadd58f92001-02-09 15:59:18 +0000125extern PyObject *DlgObj_WhichDialog(DialogPtr);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000126
127/* Drag exports */
128extern PyObject *DragObj_New(DragReference);
129extern int DragObj_Convert(PyObject *, DragReference *);
130
131/* List exports */
132extern PyObject *ListObj_New(ListHandle);
133extern int ListObj_Convert(PyObject *, ListHandle *);
134
135/* Menu exports */
136extern PyObject *MenuObj_New(MenuHandle);
137extern int MenuObj_Convert(PyObject *, MenuHandle *);
138
139/* Qd exports */
140extern PyObject *GrafObj_New(GrafPtr);
141extern int GrafObj_Convert(PyObject *, GrafPtr *);
142extern PyObject *BMObj_New(BitMapPtr);
143extern int BMObj_Convert(PyObject *, BitMapPtr *);
144extern PyObject *QdRGB_New(RGBColor *);
145extern int QdRGB_Convert(PyObject *, RGBColor *);
146
Jack Jansen50bf1482000-12-12 22:13:03 +0000147/* Qdoffs exports */
148extern PyObject *GWorldObj_New(GWorldPtr);
149extern int GWorldObj_Convert(PyObject *, GWorldPtr *);
150
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000151/* Qt exports */
152extern PyObject *TrackObj_New(Track);
153extern int TrackObj_Convert(PyObject *, Track *);
154extern PyObject *MovieObj_New(Movie);
155extern int MovieObj_Convert(PyObject *, Movie *);
156extern PyObject *MovieCtlObj_New(MovieController);
Jack Jansenf57a4a22001-05-17 22:11:44 +0000157extern int MovieCtlObj_Convert(PyObject *, MovieController *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000158extern PyObject *TimeBaseObj_New(TimeBase);
159extern int TimeBaseObj_Convert(PyObject *, TimeBase *);
160extern PyObject *UserDataObj_New(UserData);
161extern int UserDataObj_Convert(PyObject *, UserData *);
162extern PyObject *MediaObj_New(Media);
163extern int MediaObj_Convert(PyObject *, Media *);
164
165/* Res exports */
166extern PyObject *ResObj_New(Handle);
167extern int ResObj_Convert(PyObject *, Handle *);
168extern PyObject *OptResObj_New(Handle);
169extern int OptResObj_Convert(PyObject *, Handle *);
170
171/* TE exports */
172extern PyObject *TEObj_New(TEHandle);
173extern int TEObj_Convert(PyObject *, TEHandle *);
174
175/* Win exports */
176extern PyObject *WinObj_New(WindowPtr);
177extern int WinObj_Convert(PyObject *, WindowPtr *);
178extern PyObject *WinObj_WhichWindow(WindowPtr);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000179
Jack Jansen537a69f2001-11-05 14:39:22 +0000180/* CF exports */
181extern PyObject *CFTypeRefObj_New(CFTypeRef);
182extern int CFTypeRefObj_Convert(PyObject *, CFTypeRef *);
183extern PyObject *CFStringRefObj_New(CFStringRef);
184extern int CFStringRefObj_Convert(PyObject *, CFStringRef *);
185extern PyObject *CFMutableStringRefObj_New(CFMutableStringRef);
186extern int CFMutableStringRefObj_Convert(PyObject *, CFMutableStringRef *);
187extern PyObject *CFArrayRefObj_New(CFArrayRef);
188extern int CFArrayRefObj_Convert(PyObject *, CFArrayRef *);
189extern PyObject *CFMutableArrayRefObj_New(CFMutableArrayRef);
190extern int CFMutableArrayRefObj_Convert(PyObject *, CFMutableArrayRef *);
191extern PyObject *CFDictionaryRefObj_New(CFDictionaryRef);
192extern int CFDictionaryRefObj_Convert(PyObject *, CFDictionaryRef *);
193extern PyObject *CFMutableDictionaryRefObj_New(CFMutableDictionaryRef);
194extern int CFMutableDictionaryRefObj_Convert(PyObject *, CFMutableDictionaryRef *);
195extern PyObject *CFURLRefObj_New(CFURLRef);
196extern int CFURLRefObj_Convert(PyObject *, CFURLRef *);
197extern int OptionalCFURLRefObj_Convert(PyObject *, CFURLRef *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000198
199#ifdef __cplusplus
200 }
201#endif
Jack Jansen47ec1412002-09-10 12:32:47 +0000202#endif