blob: fd15975270b691bceb8ba95ec82d4b35a1fbd0bb [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>
Ronald Oussoren5640ce22008-06-05 12:58:24 +000011
12#ifndef __LP64__
Jack Jansen9f66b4a2001-05-19 12:32:39 +000013#include <QuickTime/QuickTime.h>
Ronald Oussoren5640ce22008-06-05 12:58:24 +000014#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +000015
Jack Jansen94bebc02001-08-08 13:17:31 +000016/*
17** Helper routines for error codes and such.
18*/
Raymond Hettingerec6eb362004-11-05 07:02:59 +000019char *PyMac_StrError(int); /* strerror with mac errors */
Jack Jansen3305d242003-11-20 13:28:19 +000020extern PyObject *PyMac_OSErrException; /* Exception for OSErr */
21PyObject *PyMac_GetOSErrException(void); /* Initialize & return it */
Jack Jansen94bebc02001-08-08 13:17:31 +000022PyObject *PyErr_Mac(PyObject *, int); /* Exception with a mac error */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000023PyObject *PyMac_Error(OSErr); /* Uses PyMac_GetOSErrException */
Ronald Oussoren5640ce22008-06-05 12:58:24 +000024#ifndef __LP64__
Raymond Hettingerec6eb362004-11-05 07:02:59 +000025extern OSErr PyMac_GetFullPathname(FSSpec *, char *, int); /* convert
26 fsspec->path */
Ronald Oussoren5640ce22008-06-05 12:58:24 +000027#endif /* __LP64__ */
28
Jack Jansen94bebc02001-08-08 13:17:31 +000029/*
30** These conversion routines are defined in mactoolboxglue.c itself.
31*/
32int PyMac_GetOSType(PyObject *, OSType *); /* argument parser for OSType */
33PyObject *PyMac_BuildOSType(OSType); /* Convert OSType to PyObject */
34
35PyObject *PyMac_BuildNumVersion(NumVersion);/* Convert NumVersion to PyObject */
36
37int PyMac_GetStr255(PyObject *, Str255); /* argument parser for Str255 */
38PyObject *PyMac_BuildStr255(Str255); /* Convert Str255 to PyObject */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000039PyObject *PyMac_BuildOptStr255(Str255); /* Convert Str255 to PyObject,
40 NULL to None */
Jack Jansen94bebc02001-08-08 13:17:31 +000041
42int PyMac_GetRect(PyObject *, Rect *); /* argument parser for Rect */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000043PyObject *PyMac_BuildRect(Rect *); /* Convert Rect to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000044
45int PyMac_GetPoint(PyObject *, Point *); /* argument parser for Point */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000046PyObject *PyMac_BuildPoint(Point); /* Convert Point to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000047
Raymond Hettingerec6eb362004-11-05 07:02:59 +000048int PyMac_GetEventRecord(PyObject *, EventRecord *); /* argument parser for
49 EventRecord */
50PyObject *PyMac_BuildEventRecord(EventRecord *); /* Convert EventRecord to
51 PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000052
53int PyMac_GetFixed(PyObject *, Fixed *); /* argument parser for Fixed */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000054PyObject *PyMac_BuildFixed(Fixed); /* Convert Fixed to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000055int PyMac_Getwide(PyObject *, wide *); /* argument parser for wide */
Raymond Hettingerec6eb362004-11-05 07:02:59 +000056PyObject *PyMac_Buildwide(wide *); /* Convert wide to PyObject */
Jack Jansen94bebc02001-08-08 13:17:31 +000057
58/*
59** The rest of the routines are implemented by extension modules. If they are
60** dynamically loaded mactoolboxglue will contain a stub implementation of the
61** routine, which imports the module, whereupon the module's init routine will
62** communicate the routine pointer back to the stub.
63** If USE_TOOLBOX_OBJECT_GLUE is not defined there is no glue code, and the
64** extension modules simply declare the routine. This is the case for static
65** builds (and could be the case for MacPython CFM builds, because CFM extension
66** modules can reference each other without problems).
67*/
68
Jack Jansenf57a4a22001-05-17 22:11:44 +000069#ifdef USE_TOOLBOX_OBJECT_GLUE
70/*
71** These macros are used in the module init code. If we use toolbox object glue
72** it sets the function pointer to point to the real function.
73*/
Jack Jansen0268ac82001-05-22 22:34:56 +000074#define PyMac_INIT_TOOLBOX_OBJECT_NEW(object, rtn) { \
Jack Jansenf57a4a22001-05-17 22:11:44 +000075 extern PyObject *(*PyMacGluePtr_##rtn)(object); \
76 PyMacGluePtr_##rtn = _##rtn; \
77}
Jack Jansen0268ac82001-05-22 22:34:56 +000078#define PyMac_INIT_TOOLBOX_OBJECT_CONVERT(object, rtn) { \
79 extern int (*PyMacGluePtr_##rtn)(PyObject *, object *); \
Jack Jansenf57a4a22001-05-17 22:11:44 +000080 PyMacGluePtr_##rtn = _##rtn; \
81}
82#else
83/*
84** If we don't use toolbox object glue the init macros are empty. Moreover, we define
85** _xxx_New to be the same as xxx_New, and the code in mactoolboxglue isn't included.
86*/
Jack Jansen0268ac82001-05-22 22:34:56 +000087#define PyMac_INIT_TOOLBOX_OBJECT_NEW(object, rtn)
88#define PyMac_INIT_TOOLBOX_OBJECT_CONVERT(object, rtn)
Jack Jansenf57a4a22001-05-17 22:11:44 +000089#endif /* USE_TOOLBOX_OBJECT_GLUE */
90
Jack Jansena5bca572001-08-03 15:39:27 +000091/* macfs exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +000092#ifndef __LP64__
Jack Jansenfabd00f2001-09-01 23:39:58 +000093int PyMac_GetFSSpec(PyObject *, FSSpec *); /* argument parser for FSSpec */
94PyObject *PyMac_BuildFSSpec(FSSpec *); /* Convert FSSpec to PyObject */
Ronald Oussoren5640ce22008-06-05 12:58:24 +000095#endif /* !__LP64__ */
Jack Jansenfabd00f2001-09-01 23:39:58 +000096
97int PyMac_GetFSRef(PyObject *, FSRef *); /* argument parser for FSRef */
98PyObject *PyMac_BuildFSRef(FSRef *); /* Convert FSRef to PyObject */
Jack Jansena5bca572001-08-03 15:39:27 +000099
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000100/* AE exports */
101extern PyObject *AEDesc_New(AppleEvent *); /* XXXX Why passed by address?? */
Jack Jansenb2a57722003-01-17 23:11:17 +0000102extern PyObject *AEDesc_NewBorrowed(AppleEvent *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000103extern int AEDesc_Convert(PyObject *, AppleEvent *);
104
105/* Cm exports */
106extern PyObject *CmpObj_New(Component);
107extern int CmpObj_Convert(PyObject *, Component *);
108extern PyObject *CmpInstObj_New(ComponentInstance);
109extern int CmpInstObj_Convert(PyObject *, ComponentInstance *);
110
111/* Ctl exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000112#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000113extern PyObject *CtlObj_New(ControlHandle);
114extern int CtlObj_Convert(PyObject *, ControlHandle *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000115#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000116
117/* Dlg exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000118#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000119extern PyObject *DlgObj_New(DialogPtr);
120extern int DlgObj_Convert(PyObject *, DialogPtr *);
Jack Jansenadd58f92001-02-09 15:59:18 +0000121extern PyObject *DlgObj_WhichDialog(DialogPtr);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000122#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000123
124/* Drag exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000125#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000126extern PyObject *DragObj_New(DragReference);
127extern int DragObj_Convert(PyObject *, DragReference *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000128#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000129
130/* List exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000131#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000132extern PyObject *ListObj_New(ListHandle);
133extern int ListObj_Convert(PyObject *, ListHandle *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000134#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000135
136/* Menu exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000137#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000138extern PyObject *MenuObj_New(MenuHandle);
139extern int MenuObj_Convert(PyObject *, MenuHandle *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000140#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000141
142/* Qd exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000143#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000144extern PyObject *GrafObj_New(GrafPtr);
145extern int GrafObj_Convert(PyObject *, GrafPtr *);
146extern PyObject *BMObj_New(BitMapPtr);
147extern int BMObj_Convert(PyObject *, BitMapPtr *);
148extern PyObject *QdRGB_New(RGBColor *);
149extern int QdRGB_Convert(PyObject *, RGBColor *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000150#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000151
Jack Jansen50bf1482000-12-12 22:13:03 +0000152/* Qdoffs exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000153#ifndef __LP64__
Jack Jansen50bf1482000-12-12 22:13:03 +0000154extern PyObject *GWorldObj_New(GWorldPtr);
155extern int GWorldObj_Convert(PyObject *, GWorldPtr *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000156#endif /* !__LP64__ */
Jack Jansen50bf1482000-12-12 22:13:03 +0000157
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000158/* Qt exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000159#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000160extern PyObject *TrackObj_New(Track);
161extern int TrackObj_Convert(PyObject *, Track *);
162extern PyObject *MovieObj_New(Movie);
163extern int MovieObj_Convert(PyObject *, Movie *);
164extern PyObject *MovieCtlObj_New(MovieController);
Jack Jansenf57a4a22001-05-17 22:11:44 +0000165extern int MovieCtlObj_Convert(PyObject *, MovieController *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000166extern PyObject *TimeBaseObj_New(TimeBase);
167extern int TimeBaseObj_Convert(PyObject *, TimeBase *);
168extern PyObject *UserDataObj_New(UserData);
169extern int UserDataObj_Convert(PyObject *, UserData *);
170extern PyObject *MediaObj_New(Media);
171extern int MediaObj_Convert(PyObject *, Media *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000172#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000173
174/* Res exports */
175extern PyObject *ResObj_New(Handle);
176extern int ResObj_Convert(PyObject *, Handle *);
177extern PyObject *OptResObj_New(Handle);
178extern int OptResObj_Convert(PyObject *, Handle *);
179
180/* TE exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000181#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000182extern PyObject *TEObj_New(TEHandle);
183extern int TEObj_Convert(PyObject *, TEHandle *);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000184#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000185
186/* Win exports */
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000187#ifndef __LP64__
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000188extern PyObject *WinObj_New(WindowPtr);
189extern int WinObj_Convert(PyObject *, WindowPtr *);
190extern PyObject *WinObj_WhichWindow(WindowPtr);
Ronald Oussoren5640ce22008-06-05 12:58:24 +0000191#endif /* !__LP64__ */
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000192
Jack Jansen537a69f2001-11-05 14:39:22 +0000193/* CF exports */
Jack Jansen4eb45e72003-05-27 21:39:58 +0000194extern PyObject *CFObj_New(CFTypeRef);
195extern int CFObj_Convert(PyObject *, CFTypeRef *);
Jack Jansen537a69f2001-11-05 14:39:22 +0000196extern PyObject *CFTypeRefObj_New(CFTypeRef);
197extern int CFTypeRefObj_Convert(PyObject *, CFTypeRef *);
198extern PyObject *CFStringRefObj_New(CFStringRef);
199extern int CFStringRefObj_Convert(PyObject *, CFStringRef *);
200extern PyObject *CFMutableStringRefObj_New(CFMutableStringRef);
201extern int CFMutableStringRefObj_Convert(PyObject *, CFMutableStringRef *);
202extern PyObject *CFArrayRefObj_New(CFArrayRef);
203extern int CFArrayRefObj_Convert(PyObject *, CFArrayRef *);
204extern PyObject *CFMutableArrayRefObj_New(CFMutableArrayRef);
205extern int CFMutableArrayRefObj_Convert(PyObject *, CFMutableArrayRef *);
206extern PyObject *CFDictionaryRefObj_New(CFDictionaryRef);
207extern int CFDictionaryRefObj_Convert(PyObject *, CFDictionaryRef *);
208extern PyObject *CFMutableDictionaryRefObj_New(CFMutableDictionaryRef);
209extern int CFMutableDictionaryRefObj_Convert(PyObject *, CFMutableDictionaryRef *);
210extern PyObject *CFURLRefObj_New(CFURLRef);
211extern int CFURLRefObj_Convert(PyObject *, CFURLRef *);
212extern int OptionalCFURLRefObj_Convert(PyObject *, CFURLRef *);
Jack Jansen9d8b96c2000-07-14 22:16:45 +0000213
214#ifdef __cplusplus
215 }
216#endif
Jack Jansen47ec1412002-09-10 12:32:47 +0000217#endif