Mac/Modules/waste/wastesupport.py

   1 # This script generates a Python interface for an Apple Macintosh Manager.
   2 # It uses the "bgen" package to generate C code.
   3 # The function specifications are generated by scanning the mamager's header file,
   4 # using the "scantools" package (customized for this particular manager).
   5
   6 import string
   7
   8 # Declarations that change for each manager
   9 MACHEADERFILE = 'WASTE.h'               # The Apple header file
  10 MODNAME = 'waste'                               # The name of the module
  11 OBJECTNAME = 'waste'                    # The basic name of the objects used here
  12 KIND = 'Ptr'                            # Usually 'Ptr' or 'Handle'
  13
  14 # The following is *usually* unchanged but may still require tuning
  15 MODPREFIX = MODNAME                     # The prefix for module-wide routines
  16 OBJECTTYPE = "WEReference"              # The C type used to represent them
  17 OBJECTPREFIX = MODPREFIX + 'Obj'        # The prefix for object methods
  18 INPUTFILE = 'wastegen.py' # The file generated by the scanner
  19 TYPETESTFILE = 'wastetypetest.py'       # Another file generated by the scanner
  20 OUTPUTFILE = "wastemodule.c"    # The file generated by this program
  21
  22 from macsupport import *
  23
  24 # Create the type objects
  25 WEReference = OpaqueByValueType("WEReference", "wasteObj")
  26 ExistingWEReference = OpaqueByValueType("WEReference", "ExistingwasteObj")
  27 WEObjectReference = OpaqueByValueType("WEObjectReference", "WEOObj")
  28 StScrpHandle = OpaqueByValueType("StScrpHandle", "ResObj")
  29 RgnHandle = OpaqueByValueType("RgnHandle", "ResObj")
  30 EventModifiers = Type("EventModifiers", "H")
  31 FlavorType = OSTypeType("FlavorType")
  32 WESelector = OSTypeType("WESelector")
  33
  34 OptHandle = OpaqueByValueType("Handle", "OptResObj")
  35 OptSoupHandle = OpaqueByValueType("WESoupHandle", "OptResObj")
  36 OptStScrpHandle = OpaqueByValueType("StScrpHandle", "OptResObj")
  37
  38 WEStyleMode = Type("WEStyleMode", "H")
  39 WEActionKind = Type("WEActionKind", "h")
  40 WEAlignment = Type("WEAlignment", "B")
  41 WEEdge = Type("WEEdge", "B")
  42 WEDirection = Type("WEDirection", "h")
  43 WESoupHandle = OpaqueByValueType("WESoupHandle", "ResObj")
  44 WEFontTableHandle = OpaqueByValueType("WEFontTableHandle", "ResObj")
  45 WEFontTableHandle
  46 WERunInfo = OpaqueType("WERunInfo", "RunInfo")
  47
  48 AppleEvent = OpaqueType('AppleEvent', 'AEDesc')
  49 AppleEvent_ptr = OpaqueType('AppleEvent', 'AEDesc')
  50
  51 TextStyle = OpaqueType("TextStyle", "TextStyle")
  52 TextStyle_ptr = TextStyle
  53 LongPt = OpaqueType("LongPt", "LongPt")
  54 LongPt_ptr = LongPt
  55 LongRect = OpaqueType("LongRect", "LongRect")
  56 LongRect_ptr = LongRect
  57
  58 includestuff = includestuff + """
  59 #include <%s>""" % MACHEADERFILE + """
  60 #include <WEObjectHandlers.h>
  61 #include <WETabs.h>
  62
  63 /* Exported by Qdmodule.c: */
  64 extern PyObject *QdRGB_New(RGBColor *);
  65 extern int QdRGB_Convert(PyObject *, RGBColor *);
  66
  67 /* Exported by AEModule.c: */
  68 extern PyObject *AEDesc_New(AppleEvent *);
  69 extern int AEDesc_Convert(PyObject *, AppleEvent *);
  70
  71 /* Forward declaration */
  72 staticforward PyObject *WEOObj_New(WEObjectReference);
  73 staticforward PyObject *ExistingwasteObj_New(WEReference);
  74
  75 /*
  76 ** Parse/generate TextStyle records
  77 */
  78 static
  79 PyObject *TextStyle_New(itself)
  80         TextStylePtr itself;
  81 {
  82
  83         return Py_BuildValue("lllO&", (long)itself->tsFont, (long)itself->tsFace, (long)itself->tsSize, QdRGB_New,
  84                                 &itself->tsColor);
  85 }
  86
  87 static
  88 TextStyle_Convert(v, p_itself)
  89         PyObject *v;
  90         TextStylePtr p_itself;
  91 {
  92         long font, face, size;
  93
  94         if( !PyArg_ParseTuple(v, "lllO&", &font, &face, &size, QdRGB_Convert, &p_itself->tsColor) )
  95                 return 0;
  96         p_itself->tsFont = (short)font;
  97         p_itself->tsFace = (Style)face;
  98         p_itself->tsSize = (short)size;
  99         return 1;
 100 }
 101
 102 /*
 103 ** Parse/generate RunInfo records
 104 */
 105 static
 106 PyObject *RunInfo_New(itself)
 107         WERunInfo *itself;
 108 {
 109
 110         return Py_BuildValue("llhhO&O&", itself->runStart, itself->runEnd, itself->runHeight,
 111                 itself->runAscent, TextStyle_New, &itself->runStyle, WEOObj_New, itself->runObject);
 112 }
 113
 114 /* Conversion of long points and rects */
 115 int
 116 LongRect_Convert(PyObject *v, LongRect *r)
 117 {
 118         return PyArg_Parse(v, "(llll)", &r->left, &r->top, &r->right, &r->bottom);
 119 }
 120
 121 PyObject *
 122 LongRect_New(LongRect *r)
 123 {
 124         return Py_BuildValue("(llll)", r->left, r->top, r->right, r->bottom);
 125 }
 126
 127
 128 LongPt_Convert(PyObject *v, LongPt *p)
 129 {
 130         return PyArg_Parse(v, "(ll)", &p->h, &p->v);
 131 }
 132
 133 PyObject *
 134 LongPt_New(LongPt *p)
 135 {
 136         return Py_BuildValue("(ll)", p->h, p->v);
 137 }
 138
 139 /* Stuff for the callbacks: */
 140 static PyObject *callbackdict;
 141 WENewObjectUPP upp_new_handler;
 142 WEDisposeObjectUPP upp_dispose_handler;
 143 WEDrawObjectUPP upp_draw_handler;
 144 WEClickObjectUPP upp_click_handler;
 145
 146 static OSErr
 147 any_handler(WESelector what, WEObjectReference who, PyObject *args, PyObject **rv)
 148 {
 149         FlavorType tp;
 150         PyObject *key, *func;
 151
 152         if ( args == NULL ) return errAECorruptData;
 153
 154         tp = WEGetObjectType(who);
 155
 156         if( (key=Py_BuildValue("O&O&", PyMac_BuildOSType, tp, PyMac_BuildOSType, what)) == NULL)
 157                 return errAECorruptData;
 158         if( (func = PyDict_GetItem(callbackdict, key)) == NULL ) {
 159                 Py_DECREF(key);
 160                 return errAEHandlerNotFound;
 161         }
 162         Py_INCREF(func);
 163         *rv = PyEval_CallObject(func, args);
 164         Py_DECREF(func);
 165         Py_DECREF(key);
 166         if ( *rv == NULL ) {
 167                 PySys_WriteStderr("--Exception in callback: ");
 168                 PyErr_Print();
 169                 return errAEReplyNotArrived;
 170         }
 171         return 0;
 172 }
 173
 174 static pascal OSErr
 175 my_new_handler(Point *objectSize, WEObjectReference objref)
 176 {
 177         PyObject *args=NULL, *rv=NULL;
 178         OSErr err;
 179
 180         args=Py_BuildValue("(O&)", WEOObj_New, objref);
 181         err = any_handler(weNewHandler, objref, args, &rv);
 182         if (!err) {
 183                 if (!PyMac_GetPoint(rv, objectSize) )
 184                         err = errAECoercionFail;
 185         }
 186         if ( args ) Py_DECREF(args);
 187         if ( rv ) Py_DECREF(rv);
 188         return err;
 189 }
 190
 191 static pascal OSErr
 192 my_dispose_handler(WEObjectReference objref)
 193 {
 194         PyObject *args=NULL, *rv=NULL;
 195         OSErr err;
 196
 197         args=Py_BuildValue("(O&)", WEOObj_New, objref);
 198         err = any_handler(weDisposeHandler, objref, args, &rv);
 199         if ( args ) Py_DECREF(args);
 200         if ( rv ) Py_DECREF(rv);
 201         return err;
 202 }
 203
 204 static pascal OSErr
 205 my_draw_handler(Rect *destRect, WEObjectReference objref)
 206 {
 207         PyObject *args=NULL, *rv=NULL;
 208         OSErr err;
 209
 210         args=Py_BuildValue("O&O&", PyMac_BuildRect, destRect, WEOObj_New, objref);
 211         err = any_handler(weDrawHandler, objref, args, &rv);
 212         if ( args ) Py_DECREF(args);
 213         if ( rv ) Py_DECREF(rv);
 214         return err;
 215 }
 216
 217 static pascal Boolean
 218 my_click_handler(Point hitPt, EventModifiers modifiers,
 219                 unsigned long clickTime, WEObjectReference objref)
 220 {
 221         PyObject *args=NULL, *rv=NULL;
 222         int retvalue;
 223         OSErr err;
 224
 225         args=Py_BuildValue("O&llO&", PyMac_BuildPoint, hitPt,
 226                         (long)modifiers, (long)clickTime, WEOObj_New, objref);
 227         err = any_handler(weClickHandler, objref, args, &rv);
 228         if (!err)
 229                 retvalue = PyInt_AsLong(rv);
 230         else
 231                 retvalue = 0;
 232         if ( args ) Py_DECREF(args);
 233         if ( rv ) Py_DECREF(rv);
 234         return retvalue;
 235 }
 236
 237
 238 """
 239 finalstuff = finalstuff + """
 240 /* Return the object corresponding to the window, or NULL */
 241
 242 PyObject *
 243 ExistingwasteObj_New(w)
 244         WEReference w;
 245 {
 246         PyObject *it = NULL;
 247
 248         if (w == NULL)
 249                 it = NULL;
 250         else
 251                 WEGetInfo(weRefCon, (void *)&it, w);
 252         if (it == NULL || ((wasteObject *)it)->ob_itself != w)
 253                 it = Py_None;
 254         Py_INCREF(it);
 255         return it;
 256 }
 257 """
 258
 259 class WEMethodGenerator(OSErrMethodGenerator):
 260         """Similar to MethodGenerator, but has self as last argument"""
 261
 262         def parseArgumentList(self, args):
 263                 args, a0 = args[:-1], args[-1]
 264                 t0, n0, m0 = a0
 265                 if m0 != InMode:
 266                         raise ValueError, "method's 'self' must be 'InMode'"
 267                 self.itself = Variable(t0, "_self->ob_itself", SelfMode)
 268                 FunctionGenerator.parseArgumentList(self, args)
 269                 self.argumentList.append(self.itself)
 270
 271
 272
 273 class WEObjectDefinition(GlobalObjectDefinition):
 274         def outputCheckNewArg(self):
 275                 Output("""if (itself == NULL) {
 276                                         PyErr_SetString(waste_Error,"Cannot create null WE");
 277                                         return NULL;
 278                                 }""")
 279         def outputInitStructMembers(self):
 280                 GlobalObjectDefinition.outputInitStructMembers(self)
 281                 Output("WESetInfo(weRefCon, (void *)&it, itself);")
 282         def outputFreeIt(self, itselfname):
 283                 Output("WEDispose(%s);", itselfname)
 284
 285 class WEOObjectDefinition(GlobalObjectDefinition):
 286         def outputCheckNewArg(self):
 287                 Output("""if (itself == NULL) {
 288                                         Py_INCREF(Py_None);
 289                                         return Py_None;
 290                                 }""")
 291
 292 variablestuff = """
 293         callbackdict = PyDict_New();
 294         if (callbackdict == NULL || PyDict_SetItemString(d, "callbacks", callbackdict) != 0)
 295                 return;
 296         upp_new_handler = NewWENewObjectProc(my_new_handler);
 297         upp_dispose_handler = NewWEDisposeObjectProc(my_dispose_handler);
 298         upp_draw_handler = NewWEDrawObjectProc(my_draw_handler);
 299         upp_click_handler = NewWEClickObjectProc(my_click_handler);
 300 """
 301
 302
 303 # From here on it's basically all boiler plate...
 304
 305 # Test types used for existence
 306 ## execfile(TYPETESTFILE)
 307
 308 # Create the generator groups and link them
 309 module = MacModule(MODNAME, MODPREFIX, includestuff, finalstuff, initstuff, variablestuff)
 310 object = WEObjectDefinition(OBJECTNAME, OBJECTPREFIX, OBJECTTYPE)
 311 object2 = WEOObjectDefinition("WEO", "WEOObj", "WEObjectReference")
 312 module.addobject(object2)
 313 module.addobject(object)
 314
 315 # Create the generator classes used to populate the lists
 316 Function = OSErrFunctionGenerator
 317 Method = WEMethodGenerator
 318 Method2 = OSErrMethodGenerator
 319
 320 # Create and populate the lists
 321 functions = []
 322 methods = []
 323 methods2 = []
 324 execfile(INPUTFILE)
 325
 326 # A function written by hand:
 327 stdhandlers_body = """
 328         OSErr err;
 329         // install the sample object handlers for pictures and sounds
 330 #define kTypePicture                    'PICT'
 331 #define kTypeSound                              'snd '
 332
 333         if ( !PyArg_ParseTuple(_args, "") ) return NULL;
 334
 335         if ((err = WEInstallObjectHandler(kTypePicture, weNewHandler,
 336                                 (UniversalProcPtr) NewWENewObjectProc(HandleNewPicture), NULL)) != noErr)
 337                 goto cleanup;
 338
 339         if ((err = WEInstallObjectHandler(kTypePicture, weDisposeHandler,
 340                                 (UniversalProcPtr) NewWEDisposeObjectProc(HandleDisposePicture), NULL)) != noErr)
 341                 goto cleanup;
 342
 343         if ((err = WEInstallObjectHandler(kTypePicture, weDrawHandler,
 344                                 (UniversalProcPtr) NewWEDrawObjectProc(HandleDrawPicture), NULL)) != noErr)
 345                 goto cleanup;
 346
 347         if ((err = WEInstallObjectHandler(kTypeSound, weNewHandler,
 348                                 (UniversalProcPtr) NewWENewObjectProc(HandleNewSound), NULL)) != noErr)
 349                 goto cleanup;
 350
 351         if ((err = WEInstallObjectHandler(kTypeSound, weDrawHandler,
 352                                 (UniversalProcPtr) NewWEDrawObjectProc(HandleDrawSound), NULL)) != noErr)
 353                 goto cleanup;
 354
 355         if ((err = WEInstallObjectHandler(kTypeSound, weClickHandler,
 356                                 (UniversalProcPtr) NewWEClickObjectProc(HandleClickSound), NULL)) != noErr)
 357                 goto cleanup;
 358         Py_INCREF(Py_None);
 359         return Py_None;
 360
 361 cleanup:
 362         return PyMac_Error(err);
 363 """
 364
 365 inshandler_body = """
 366         OSErr err;
 367         FlavorType objectType;
 368         WESelector selector;
 369         PyObject *py_handler;
 370         UniversalProcPtr handler;
 371         WEReference we = NULL;
 372         PyObject *key;
 373
 374
 375         if ( !PyArg_ParseTuple(_args, "O&O&O|O&",
 376                         PyMac_GetOSType, &objectType,
 377                         PyMac_GetOSType, &selector,
 378                         &py_handler,
 379                         WEOObj_Convert, &we) ) return NULL;
 380
 381         if ( selector == weNewHandler ) handler = (UniversalProcPtr)upp_new_handler;
 382         else if ( selector == weDisposeHandler ) handler = (UniversalProcPtr)upp_dispose_handler;
 383         else if ( selector == weDrawHandler ) handler = (UniversalProcPtr)upp_draw_handler;
 384         else if ( selector == weClickHandler ) handler = (UniversalProcPtr)upp_click_handler;
 385         else return PyMac_Error(weUndefinedSelectorErr);
 386
 387         if ((key = Py_BuildValue("O&O&",
 388                         PyMac_BuildOSType, objectType,
 389                         PyMac_BuildOSType, selector)) == NULL )
 390                 return NULL;
 391
 392         PyDict_SetItem(callbackdict, key, py_handler);
 393
 394         err = WEInstallObjectHandler(objectType, selector, handler, we);
 395         if ( err ) return PyMac_Error(err);
 396         Py_INCREF(Py_None);
 397         return Py_None;
 398 """
 399
 400 stdhand = ManualGenerator("STDObjectHandlers", stdhandlers_body)
 401 inshand = ManualGenerator("WEInstallObjectHandler", inshandler_body)
 402
 403
 404 # Tab hook handlers. Could be parsed from WETabs.h, but this is just as simple.
 405 f = Method(OSErr, 'WEInstallTabHooks', (WEReference, 'we', InMode))
 406 methods.append(f)
 407 f = Method(OSErr, 'WERemoveTabHooks', (WEReference, 'we', InMode))
 408 methods.append(f)
 409 f = Method(Boolean, 'WEIsTabHooks', (WEReference, 'we', InMode))
 410 methods.append(f)
 411 f = Method(SInt16, 'WEGetTabSize', (WEReference, 'we', InMode))
 412 methods.append(f)
 413 f = Method(OSErr, 'WESetTabSize', (SInt16, 'tabWidth', InMode), (WEReference, 'we', InMode))
 414 methods.append(f)
 415
 416 # add the populated lists to the generator groups
 417 # (in a different wordl the scan program would generate this)
 418 for f in functions: module.add(f)
 419 module.add(stdhand)
 420 module.add(inshand)
 421 for f in methods: object.add(f)
 422 for f in methods2: object2.add(f)
 423
 424 # generate output (open the output file as late as possible)
 425 SetOutputFileName(OUTPUTFILE)
 426 module.generate()
 427