Source

pyobjc / pyobjc / Doc / api-notes-macosx.txt

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
==============================================
Notes on supported APIs and classes on MacOS X
==============================================

.. :author: Ronald Oussoren

.. Contents::

TODO: Add documentation about weak linking (see intro.txt).


Introduction
------------

This document describes the restrictions w.r.t. supported APIs and classes
on MacOS X. In general you can use classes and global functions just like
in Objective-C (e.g. the Apple developer documentaton applies), but in some
cases there are special considerations.

We also do not provide access to global functions that are not usefull for
Python programs, those functions are listed below.

This document list the examples to the basic rules. If a method uses pointers
to return additional values, the Python wrapper for that method returns a tuple
containing the original return value and the additional values. You don't have
to pass values for those arguments, unless the method uses the values you
pass in.

This document is target at the latest supported version of MacOS X (currenlty
MacOS X 10.2.x), unless specifically noted the same restrictions apply to 
earlier versions of MacOS X. Earlier versions of the OS have less extensive
APIs, PyObjC does *not* provide a compatibility layer.

Frameworks not listed below are not wrapped by PyObjC, they can still be
accessed although without access to constants and global functions defined
by those frameworks.

This document is not entirely complete, but does cover the most used APIs.

Core objective-C runtime
------------------------

Class Protocol
..............

* ``descriptionForClassMethod:``, ``descriptionForInstanceMethod``
  These methods are not supported, protocols are hardly ever used explicitly
  in Cocoa therefore this should not be a problem.

Addressbook framework
---------------------

We do not provide access to the global functions in that framework, because
the same functionality can be accessed by using the object-oriented interface.

AppKit framework
----------------

``NSPoint`` is a tuple of 2 floats, or use ``AppKit.NSMakePoint(x, y)``.

``NSSize`` is a tuple of 2 floats, or use ``AppKit.NSMakeSize(h, w)``.

``NSRect`` is a tuple of an ``NSPoint`` and an ``NSSize``, or 
use ``AppKit.NSMakeRect(x, y, h, w)``.

The callback methods for the NSSheet API's have a non-default signature
and no fixed name. You should therefore explicitly specify the signature. This
is done by calling the ``endSheetMethod`` function after defining your
callback::
	
	class MYClass (NSObject):
		def mysheetDidEnd(self, panel, returnCode, contextInfo):
			""" Actual implementation goes here """
			pass

		mysheetDidEnd = PyObjCTools.AppHelper.endSheetMethod(
			mysheetDidEnd)

Unless otherwise noted, all ``contextInfo`` arguments are passed as integers,
not as arbitrary pointers.


Class NSApplication
...................

``NSModalSession`` objects are wrapped as opaque values. You can check if
two wrapper objects refer to the same session object by comparing their
``ptr`` attributes.

Class NSBezierPath
..................

* ``getLineDash:count:phase:``
  This method is not supported, I (Ronald) could not find a way to detect the
  required size for the pattern buffer. 

* ``appendBezierPathWithGlyphs:count:inFont:``
  The first argument is a list of integers, count should be at most the lenght
  of the first argument.

* ``appendBezierPathWithPoints:count:``
  The first argument is a list of points, count should be at most the lenght
  of the first argument. 

* ``setAssociatedPoints:atIndex:``
  Implementing this method in Python is not yet supported.

Class ``NSBitmapImageRep``
..........................

* ``getBitMapDataPlanes``
  This method is not supported (yet)

* ``getTIFFCompressionTypes:count:``
  This method is not supported (yet)

* ``initWithBitmapDataPlanes:pixesWide:pixelsHigh:bitPerSample:samplesPerPixel:hasAlpha:isPlanar:colorSpaceName:bytesPerRow:bitsPerPixel:``
  This method is not supported (yet)

Class ``NSFont``
................

* ``positionsForCompositeSequence:numberOfGlyphs:pointArray:``
  This method is not supported (yet)


Class ``NSGraphicsContext``
...........................

* ``focusStack``
  This method is not supported.

* ``setFocusStack``
  This method is not supported.

* ``graphicsPort``
  This method is not yet supported, MacPython doesn't wrap ``CGContextRef``
  at the moment.

Class ``NSLayoutManager``
.........................

* ``getGlyphs:range:``
  This method is not yet supported

* ``getGlyphsInRange:glyphs:characterIndexes:glyphInscriptions:elasticBits:``
  This method is not yet supported

* ``getGlyphsInRange:glyphs:characterIndexes:glyphInscriptions:elasticBits:bidiLevels:``
  This method is not yet supported

* ``rectArrayForCharacterRange:withinSelectedCharacterRange:inTextContainer:rectCount:``
  This method is not yet supported

* ``rectArrayForGlyphRange:withinSelectedGlyphRange:inTextContainer:rectCount:``
  This method is not yet supported

Class ``NSMatrix``
..................

* ``sortUsingFunction:context``
  Calling this method from Python is supported, overriding it in Python
  is not. The ``context`` can be an arbitrary python object.

Class ``NSMovie``
.................

The return value of ``QTMovie`` and the sole argument of ``initWithMovie:``
are QT.Movie objects. Using these methods requires the use of MacPython 2.3.

Class ``NSOpenGLContext``
.........................

* ``getValues:forParameter:``
  This method is not yet supported.

* ``setValues:forParameter:``
  This method is not yet supported.

* ``setOffScreen:width:height:rowbytes:``
  This method is not yet supported.

Class ``NSOpenGLPixelFormat``
.............................

* ``getValues:forAttribute:forVirtualScreen:``

  This method is not yet supported

* ``initWithAttributes:``

  This method is not yet supported

Class ``NSQuickDrawView``
.........................

* ``qdPort``

  This method returns an instance from a type Carbon.QuickDraw. This 
  requires MacPython.

Class ``NSSimpleHorizontalTypesetter``
......................................

* ``baseOfTypesetterGlyphInfo``
  This method is not yet supported

* ``layoutGlyphsInHorizontalLineFragment:baseline:``
  This method is not yet supported


Class ``NSView``
................

* ``sortSubviewsUsingFunction:context:``
  Calling this method from Python is supported, overriding it in Python
  is not. The ``context`` can be an arbitrary python object.

Class ``NSWindow``
..................

* ``graphicsPort``
  This method is not yet supported

* ``initWithWindowRef:``
  This method is not yet supported

* ``windowRef``
  This method is not yet supported

Foundation framework
--------------------

NOTE: The list below is mostly based on scripts that find methods that can
not be automaticly handled by the bridge. We have not yet performed a manual
search for such methods in the Cocoa documentation.

The ``-forward::`` method is not supported. It's functionality can be accessed
using the python function ``apply``. The ``performv::`` method is also not
supported, with a simular work-around.

Class ``NSArray``
.................

* ``initWithObjects:``, ``arrayWithObjects:``
  These methods are not supported, use ``initWithArray:`` instead.

* ``getObjects:``
  This method is not supported, accessing the objects using the usual
  accessor methods is just as efficient as using this method.

* ``getObjects:inRange:``
  This method is not supported, accessing the objects using the usual
  accessor methods is just as efficient as using this method.

* ``sortedArrayUsingFunction:context:`` and ``sortedArrayUsingFunction:context:hint``
  These methods can be called from Python, but you cannot override them
  from Python. This limitation will be lifted in a future version of PyObjC.

  The ``context`` can be an arbitrary python object.

Class ``NSBundle``
..................

* ``bundleForClass:``
  This method does not work correctly for classes defined in Python, these
  all seem be defined in the ``mainBundle()``. As a workaround you can use
  the function ``objc.pluginBundle(name)`` to find the NSBundle for your
  Python based bundle. See Examples/PrefPane for an example of its usage.

Class ``NSCoder``
.................

The following methods are not supported in the current version of PyObjC.
This limitation will be lifted in a future version of the bridge.

* ``encodeValuesOfObjCType:``

  Use multiple calls to ``encodeValueOfObjCType:at:`` instead.

* ``decodeValuesOfObjCType:``

  Use multiple calls to ``decodeValueOfObjCType:at:`` instead. Note that
  that won't work if your trying to read back data that was written using
  ``encodeValuesOfObjCType:``.

The method ``decodeBytesWithoutReturnedLength:`` is not supported, use 
``decodeBytesWithReturnedLength:`` instead. It is not possible to safely
represent the return value of this method in Python.


Class ``NSData``
................

* ``initWithBytesNoCopy:length:``
  This method is not supported, use ``initWithBytes:length:`` instead.

* ``initWithBytesNoCopy:length:freeWhenDone:``
  This method is not supported, use ``initWithBytes:length:`` instead.

* ``dataWithBytesNoCopy:length:``
  This method is not supported, use ``dataWithBytes:length:`` instead.

* ``dataWithBytesNoCopy:length:freeWhenDone:``
  This method is not supported, use ``dataWithBytes:length:`` instead.

* ``deserializeAlignedBytesLengthAtCursor:``
  This is a depricated method, see Apple documentation.

* ``deserializeBytes:length:atCursor:``
  This is a depricated method, see Apple documentation.

* ``deserializeDataAt:ofObjCType:atCursor:context:``
  This is a depricated method, see Apple documentation.

* ``deserializeIntAtCursor:``
  This is a depricated method, see Apple documentation.

* ``deserializeInts:count:atCursor:``
  This is a depricated method, see Apple documentation.

* ``deserializeInts:count:atIndex:``
  This is a depricated method, see Apple documentation.

* ``getBytes:``, ``getBytes:length:``, ``getBytes:range:``
  Use ``bytes`` instead, and then use subscripting to get the
  desired range.


Class ``NSDictionary``
......................

The (undocumented) methods ``getKeys:``, ``getObjects:`` and 
``getObjects:andKeys:`` are not supported.

Class ``NSFault``
.................

The ``extraData`` argument/return value for ``-extraData`` and 
``setTargetClassextraData:`` is represented as an integer.

Class ``NSMutableArray``
........................

* ``sortUsingFunction:context:``, ``sortUsingFunction:context:range:``
  Calling this method from Python is supported, overriding it in a subclass
  is not. This limitation will be fixed in a later version of PyObjC.

  The ``context`` can be an arbitrary python object.

Class ``NSNetService``
......................

* ``addresses``
  When calling this from Python this methods returns a tuple of adress-info
  tuples, like the values returned by ``socket.getpeeraddr()``. 

Class ``NSScriptObjectSpecifier``
.................................

* ``indicesOfObjectsByEvaluatingWithContainer:count:``
  Implementing this in Python is not supported yet. We're looking for a way
  to avoid leaking the returned buffer, as we cannot return a pointer to an
  internal datastructure.

Class ``NSSet``
...............

* ``initWithObjects:``, ``setWithObjects:``
  This method is not supported, use ``initWithArray:`` instead.


Class ``NSString``
..................

Objective-C strings are usually represented as instances of a subclass of
the Python type ``unicode``. It is possible to access the "real" Objective-C
string by using the method ``NSString``. This should only be necessary when
dealing with mutable strings, or when you want to access methods that don't
have a Python equivalent.

* ``initWithCharactersNoCopy:length:freeWhenDone:`` 
  This method is unsupported because we cannot guarantee that the buffer wil
  be available as long as the string is. Use ``initWithCharacters:`` instead.

* ``getCharacters:`` and ``getCharacters:range:``
  These methods are not supported at the moment. This limitation will be liften
  in a future version of the bridge.

* ``getCString:maxLength:range:remainingRange:`` and ``getCString:maxLength:``
  Calling these methods from Python is supported, overriding them from 
  Python is not. This limitation will be liften in a future version of the
  bridge.

* ``getCString:``
  This method is not supported. Use ``getCString:maxLength:`` instead (using
  the length of the string as the maximum length). This limitation will be
  liften in a future version of the bridge.

InterfaceBuilder framework
--------------------------

I (Ronald) have not found documentation for this framework, therefore the
following methods with a "difficult" signature are not supported.

Please let me know if there is documentation for this framework.

Class ``IBObjCSourceParser``
............................

* ``parseClass:``

Class ``NSView``
................

* ``objectAtPoint:rect:``
  Defined in a catagory on ``NSView``.

Class ``NSIBObjectData``
........................

* ``restoreFromObjectDataInfo:``

* ``snapshotIntoObjectDataInfo:``

Class ``IBObjectContainer``
...........................

* ``decodeObjectToIntMapTableForKey:fromCoder:alwaysCreate:``

* ``decodeObjectToObjectMapTableForKey:fromCoder:alwaysCreate:``

Class ``IBXMLDecoder``
......................

* ``allocObjectWithClassName:``

Class ``IBSplitScrollView``
...........................

* ``getMinimumX:maximumX:``


PreferencePanes framework
-------------------------

This framework seems to define usefull classes like ``NSAuthorization`` and
``NSKeychain``, but these are not documented and some usefull methods have
a hard signature.

The only documented class, ``NSPreferencePane`` is fully supported.

ScreenSaver framework
---------------------

Class ``ScreenSaverDefaults``
.............................

This class is fully supported.

Class ``ScreenSaverView``
.........................

This class is fully supported.