blob: 92799e975c8b76c9196eceb2dbe354d24c5637d1 [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#include <Carbon/Carbon.h>
11#include <QuickTime/QuickTime.h>
Jack Jansen9d8b96c2000-07-14 22:16:45 +000012
Jack Jansen94bebc02001-08-08 13:17:31 +000013/*
14** Helper routines for error codes and such.
15*/
Raymond Hettingerec6eb362004-11-05 07:02:59 +000016char *PyMac_StrError(int); /* strerror with mac errors */
Jack Jansen3305d242003-11-20 13:28:19 +000017extern PyObject *PyMac_OSErrException; /* Exception for OSErr */
18PyObject *PyMac_GetOSErrException(void); /* Initialize & return it */
Jack Jansen94bebc02001-08-08 13:17:31 +000019PyObject *PyErr_Mac(PyObject *, int); /* Exception with a mac error */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000020PyObject *PyMac_Error(OSErr); /* Uses PyMac_GetOSErrException */
21extern OSErr PyMac_GetFullPathname(FSSpec *, char *, int); /* convert
22 fsspec->path */
Jack Jansen94bebc02001-08-08 13:17:31 +000023/*
24** These conversion routines are defined in mactoolboxglue.c itself.
25*/
26int PyMac_GetOSType(PyObject *, OSType *); /* argument parser for OSType */
27PyObject *PyMac_BuildOSType(OSType); /* Convert OSType to PyObject */
28
29PyObject *PyMac_BuildNumVersion(NumVersion);/* Convert NumVersion to PyObject */
30
31int PyMac_GetStr255(PyObject *, Str255); /* argument parser for Str255 */
32PyObject *PyMac_BuildStr255(Str255); /* Convert Str255 to PyObject */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000033PyObject *PyMac_BuildOptStr255(Str255); /* Convert Str255 to PyObject,
34 NULL to None */
Jack Jansen94bebc02001-08-08 13:17:31 +000035
36int PyMac_GetRect(PyObject *, Rect *); /* argument parser for Rect */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000037PyObject *PyMac_BuildRect(Rect *); /* Convert Rect to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000038
39int PyMac_GetPoint(PyObject *, Point *); /* argument parser for Point */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000040PyObject *PyMac_BuildPoint(Point); /* Convert Point to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000041
Raymond Hettingerec6eb362004-11-05 07:02:59 +000042int PyMac_GetEventRecord(PyObject *, EventRecord *); /* argument parser for
43 EventRecord */
44PyObject *PyMac_BuildEventRecord(EventRecord *); /* Convert EventRecord to
45 PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000046
47int PyMac_GetFixed(PyObject *, Fixed *); /* argument parser for Fixed */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000048PyObject *PyMac_BuildFixed(Fixed); /* Convert Fixed to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000049int PyMac_Getwide(PyObject *, wide *); /* argument parser for wide */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000050PyObject *PyMac_Buildwide(wide *); /* Convert wide to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000051
52/*
53** The rest of the routines are implemented by extension modules. If they are
54** dynamically loaded mactoolboxglue will contain a stub implementation of the
55** routine, which imports the module, whereupon the module's init routine will
56** communicate the routine pointer back to the stub.
57** If USE_TOOLBOX_OBJECT_GLUE is not defined there is no glue code, and the
58** extension modules simply declare the routine. This is the case for static
59** builds (and could be the case for MacPython CFM builds, because CFM extension
60** modules can reference each other without problems).
61*/
62
Jack Jansenf57a4a22001-05-17 22:11:44 +000063#ifdef USE_TOOLBOX_OBJECT_GLUE
64/*
65** These macros are used in the module init code. If we use toolbox object glue
66** it sets the function pointer to point to the real function.
67*/
Jack Jansen0268ac82001-05-22 22:34:56 +000068#define PyMac_INIT_TOOLBOX_OBJECT_NEW(object, rtn) { \
Jack Jansenf57a4a22001-05-17 22:11:44 +000069 extern PyObject *(*PyMacGluePtr_##rtn)(object); \
70 PyMacGluePtr_##rtn = _##rtn; \
71}
Jack Jansen0268ac82001-05-22 22:34:56 +000072#define PyMac_INIT_TOOLBOX_OBJECT_CONVERT(object, rtn) { \
73 extern int (*PyMacGluePtr_##rtn)(PyObject *, object *); \
Jack Jansenf57a4a22001-05-17 22:11:44 +000074 PyMacGluePtr_##rtn = _##rtn; \
75}
76#else
77/*
78** If we don't use toolbox object glue the init macros are empty. Moreover, we define
79** _xxx_New to be the same as xxx_New, and the code in mactoolboxglue isn't included.
80*/
Jack Jansen0268ac82001-05-22 22:34:56 +000081#define PyMac_INIT_TOOLBOX_OBJECT_NEW(object, rtn)
82#define PyMac_INIT_TOOLBOX_OBJECT_CONVERT(object, rtn)
Jack Jansenf57a4a22001-05-17 22:11:44 +000083#endif /* USE_TOOLBOX_OBJECT_GLUE */
84
Jack Jansena5bca572001-08-03 15:39:27 +000085/* macfs exports */
Jack Jansenfabd00f2001-09-01 23:39:58 +000086int PyMac_GetFSSpec(PyObject *, FSSpec *); /* argument parser for FSSpec */
87PyObject *PyMac_BuildFSSpec(FSSpec *); /* Convert FSSpec to PyObject */
88
89int PyMac_GetFSRef(PyObject *, FSRef *); /* argument parser for FSRef */
90PyObject *PyMac_BuildFSRef(FSRef *); /* Convert FSRef to PyObject */
Jack Jansena5bca572001-08-03 15:39:27 +000091
Jack Jansen9d8b96c2000-07-14 22:16:45 +000092/* AE exports */
93extern PyObject *AEDesc_New(AppleEvent *); /* XXXX Why passed by address?? */
Jack Jansenb2a57722003-01-17 23:11:17 +000094extern PyObject *AEDesc_NewBorrowed(AppleEvent *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +000095extern int AEDesc_Convert(PyObject *, AppleEvent *);
96
97/* Cm exports */
98extern PyObject *CmpObj_New(Component);
99extern int CmpObj_Convert(PyObject *, Component *);
100extern PyObject *CmpInstObj_New(ComponentInstance);
101extern int CmpInstObj_Convert(PyObject *, ComponentInstance *);
102
103/* Ctl exports */
104extern PyObject *CtlObj_New(ControlHandle);
105extern int CtlObj_Convert(PyObject *, ControlHandle *);
106
107/* Dlg exports */
108extern PyObject *DlgObj_New(DialogPtr);
109extern int DlgObj_Convert(PyObject *, DialogPtr *);
Jack Jansenadd58f92001-02-09 15:59:18 +0000110extern PyObject *DlgObj_WhichDialog(DialogPtr);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000111
112/* Drag exports */
113extern PyObject *DragObj_New(DragReference);
114extern int DragObj_Convert(PyObject *, DragReference *);
115
116/* List exports */
117extern PyObject *ListObj_New(ListHandle);
118extern int ListObj_Convert(PyObject *, ListHandle *);
119
120/* Menu exports */
121extern PyObject *MenuObj_New(MenuHandle);
122extern int MenuObj_Convert(PyObject *, MenuHandle *);
123
124/* Qd exports */
125extern PyObject *GrafObj_New(GrafPtr);
126extern int GrafObj_Convert(PyObject *, GrafPtr *);
127extern PyObject *BMObj_New(BitMapPtr);
128extern int BMObj_Convert(PyObject *, BitMapPtr *);
129extern PyObject *QdRGB_New(RGBColor *);
130extern int QdRGB_Convert(PyObject *, RGBColor *);
131
Jack Jansen50bf1482000-12-12 22:13:03 +0000132/* Qdoffs exports */
133extern PyObject *GWorldObj_New(GWorldPtr);
134extern int GWorldObj_Convert(PyObject *, GWorldPtr *);
135
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000136/* Qt exports */
137extern PyObject *TrackObj_New(Track);
138extern int TrackObj_Convert(PyObject *, Track *);
139extern PyObject *MovieObj_New(Movie);
140extern int MovieObj_Convert(PyObject *, Movie *);
141extern PyObject *MovieCtlObj_New(MovieController);
Jack Jansenf57a4a22001-05-17 22:11:44 +0000142extern int MovieCtlObj_Convert(PyObject *, MovieController *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000143extern PyObject *TimeBaseObj_New(TimeBase);
144extern int TimeBaseObj_Convert(PyObject *, TimeBase *);
145extern PyObject *UserDataObj_New(UserData);
146extern int UserDataObj_Convert(PyObject *, UserData *);
147extern PyObject *MediaObj_New(Media);
148extern int MediaObj_Convert(PyObject *, Media *);
149
150/* Res exports */
151extern PyObject *ResObj_New(Handle);
152extern int ResObj_Convert(PyObject *, Handle *);
153extern PyObject *OptResObj_New(Handle);
154extern int OptResObj_Convert(PyObject *, Handle *);
155
156/* TE exports */
157extern PyObject *TEObj_New(TEHandle);
158extern int TEObj_Convert(PyObject *, TEHandle *);
159
160/* Win exports */
161extern PyObject *WinObj_New(WindowPtr);
162extern int WinObj_Convert(PyObject *, WindowPtr *);
163extern PyObject *WinObj_WhichWindow(WindowPtr);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000164
Jack Jansen537a69f2001-11-05 14:39:22 +0000165/* CF exports */
Jack Jansen4eb45e72003-05-27 21:39:58 +0000166extern PyObject *CFObj_New(CFTypeRef);
167extern int CFObj_Convert(PyObject *, CFTypeRef *);
Jack Jansen537a69f2001-11-05 14:39:22 +0000168extern PyObject *CFTypeRefObj_New(CFTypeRef);
169extern int CFTypeRefObj_Convert(PyObject *, CFTypeRef *);
170extern PyObject *CFStringRefObj_New(CFStringRef);
171extern int CFStringRefObj_Convert(PyObject *, CFStringRef *);
172extern PyObject *CFMutableStringRefObj_New(CFMutableStringRef);
173extern int CFMutableStringRefObj_Convert(PyObject *, CFMutableStringRef *);
174extern PyObject *CFArrayRefObj_New(CFArrayRef);
175extern int CFArrayRefObj_Convert(PyObject *, CFArrayRef *);
176extern PyObject *CFMutableArrayRefObj_New(CFMutableArrayRef);
177extern int CFMutableArrayRefObj_Convert(PyObject *, CFMutableArrayRef *);
178extern PyObject *CFDictionaryRefObj_New(CFDictionaryRef);
179extern int CFDictionaryRefObj_Convert(PyObject *, CFDictionaryRef *);
180extern PyObject *CFMutableDictionaryRefObj_New(CFMutableDictionaryRef);
181extern int CFMutableDictionaryRefObj_Convert(PyObject *, CFMutableDictionaryRef *);
182extern PyObject *CFURLRefObj_New(CFURLRef);
183extern int CFURLRefObj_Convert(PyObject *, CFURLRef *);
184extern int OptionalCFURLRefObj_Convert(PyObject *, CFURLRef *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000185
186#ifdef __cplusplus
187 }
188#endif
Jack Jansen47ec1412002-09-10 12:32:47 +0000189#endif