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