Commits

Bob Ippolito committed 85d32cb

reference bug #836247 from TODO

Comments (0)

Files changed (2)

pyobjc/Doc/TODO.html

 <h2>TODO list</h2>
 <h2>Contents</h2>
 <ul>
-<li><a href="#introduction" id="id1" name="id1">Introduction</a></li>
-<li><a href="#important-items" id="id2" name="id2">Important items</a><ul>
-<li><a href="#better-documentation" id="id3" name="id3">Better documentation</a></li>
-<li><a href="#test-suite" id="id4" name="id4">Test suite</a></li>
+<li><a href="#introduction" id="id2" name="id2">Introduction</a></li>
+<li><a href="#important-items" id="id3" name="id3">Important items</a><ul>
+<li><a href="#better-documentation" id="id4" name="id4">Better documentation</a></li>
+<li><a href="#test-suite" id="id5" name="id5">Test suite</a></li>
 </ul>
 </li>
-<li><a href="#less-important-items" id="id5" name="id5">Less important items</a><ul>
-<li><a href="#refactor-some-parts-of-the-bridge" id="id6" name="id6">Refactor some parts of the bridge</a></li>
-<li><a href="#support-for-gnustep" id="id7" name="id7">Support for GNUstep</a></li>
-<li><a href="#plugin-bundles" id="id8" name="id8">Plugin bundles</a></li>
-<li><a href="#project-templates" id="id9" name="id9">Project templates</a></li>
-<li><a href="#complete-cocoa-wrapping" id="id10" name="id10">Complete Cocoa wrapping</a></li>
-<li><a href="#pickle-support" id="id11" name="id11">Pickle support</a></li>
-<li><a href="#nscoder-support" id="id12" name="id12">NSCoder support</a></li>
-<li><a href="#copy" id="id13" name="id13"><code><span>-copy</span></code></a></li>
-<li><a href="#known-issues" id="id14" name="id14">Known issues</a></li>
-<li><a href="#code-cleanup" id="id15" name="id15">Code cleanup</a></li>
-<li><a href="#cleanup-examples" id="id16" name="id16">Cleanup Examples</a></li>
-<li><a href="#performance-tuning-testing" id="id17" name="id17">Performance tuning/testing</a></li>
-<li><a href="#add-freelists" id="id18" name="id18">Add freelists</a></li>
-<li><a href="#formal-protocols-distributed-objects" id="id19" name="id19">Formal Protocols, Distributed Objects</a></li>
-<li><a href="#links-to-apple-documentation" id="id20" name="id20">Links to Apple documentation</a></li>
-<li><a href="#implement-more-of-nsmutabledictionary-in-oc-pythondictionary" id="id21" name="id21">Implement more of NSMutableDictionary in OC_PythonDictionary</a></li>
-<li><a href="#clean-up-oc-pythonobject" id="id22" name="id22">Clean up OC_PythonObject</a></li>
-<li><a href="#rewrite-scripts-find-raw-pointers-py" id="id23" name="id23">Rewrite scripts/find-raw-pointers.py</a></li>
-<li><a href="#finish-struct-wrapper-m" id="id24" name="id24">Finish struct-wrapper.m</a></li>
-<li><a href="#finish-refactoring-of-the-code-generator-scripts" id="id25" name="id25">Finish refactoring of the code-generator scripts</a></li>
-<li><a href="#setup-py-cleanup" id="id26" name="id26">setup.py cleanup</a></li>
-<li><a href="#unique-proxies-for-python-objects" id="id27" name="id27">Unique proxies for Python objects</a></li>
-<li><a href="#nsdecimal-vs-decimal" id="id28" name="id28">NSDecimal vs decimal</a></li>
-<li><a href="#nsset-vs-set" id="id29" name="id29">NSSet vs set</a></li>
-<li><a href="#python-2-4" id="id30" name="id30">Python 2.4</a></li>
-<li><a href="#nslog-stringwithformat" id="id31" name="id31">NSLog, stringWithFormat, ...</a></li>
+<li><a href="#less-important-items" id="id6" name="id6">Less important items</a><ul>
+<li><a href="#refactor-some-parts-of-the-bridge" id="id7" name="id7">Refactor some parts of the bridge</a></li>
+<li><a href="#support-for-gnustep" id="id8" name="id8">Support for GNUstep</a></li>
+<li><a href="#plugin-bundles" id="id9" name="id9">Plugin bundles</a></li>
+<li><a href="#project-templates" id="id10" name="id10">Project templates</a></li>
+<li><a href="#complete-cocoa-wrapping" id="id11" name="id11">Complete Cocoa wrapping</a></li>
+<li><a href="#pickle-support" id="id12" name="id12">Pickle support</a></li>
+<li><a href="#nscoder-support" id="id13" name="id13">NSCoder support</a></li>
+<li><a href="#copy" id="id14" name="id14"><code><span>-copy</span></code></a></li>
+<li><a href="#known-issues" id="id15" name="id15">Known issues</a></li>
+<li><a href="#code-cleanup" id="id16" name="id16">Code cleanup</a></li>
+<li><a href="#cleanup-examples" id="id17" name="id17">Cleanup Examples</a></li>
+<li><a href="#performance-tuning-testing" id="id18" name="id18">Performance tuning/testing</a></li>
+<li><a href="#add-freelists" id="id19" name="id19">Add freelists</a></li>
+<li><a href="#formal-protocols-distributed-objects" id="id20" name="id20">Formal Protocols, Distributed Objects</a></li>
+<li><a href="#links-to-apple-documentation" id="id21" name="id21">Links to Apple documentation</a></li>
+<li><a href="#implement-more-of-nsmutabledictionary-in-oc-pythondictionary" id="id22" name="id22">Implement more of NSMutableDictionary in OC_PythonDictionary</a></li>
+<li><a href="#clean-up-oc-pythonobject" id="id23" name="id23">Clean up OC_PythonObject</a></li>
+<li><a href="#rewrite-scripts-find-raw-pointers-py" id="id24" name="id24">Rewrite scripts/find-raw-pointers.py</a></li>
+<li><a href="#finish-struct-wrapper-m" id="id25" name="id25">Finish struct-wrapper.m</a></li>
+<li><a href="#finish-refactoring-of-the-code-generator-scripts" id="id26" name="id26">Finish refactoring of the code-generator scripts</a></li>
+<li><a href="#setup-py-cleanup" id="id27" name="id27">setup.py cleanup</a></li>
+<li><a href="#unique-proxies-for-python-objects" id="id28" name="id28">Unique proxies for Python objects</a></li>
+<li><a href="#nsdecimal-vs-decimal" id="id29" name="id29">NSDecimal vs decimal</a></li>
+<li><a href="#nsset-vs-set" id="id30" name="id30">NSSet vs set</a></li>
+<li><a href="#python-2-4" id="id31" name="id31">Python 2.4</a></li>
+<li><a href="#nslog-stringwithformat" id="id32" name="id32">NSLog, stringWithFormat, ...</a></li>
 </ul>
 </li>
 </ul>
-<h2><a href="#id1" name="introduction">Introduction</a></h2>
+<h2><a href="#id2" name="introduction">Introduction</a></h2>
 <p>This document contains an (incomplete) list of work items.</p>
-<h2><a href="#id2" name="important-items">Important items</a></h2>
-<h3><a href="#id3" name="better-documentation">Better documentation</a></h3>
+<h2><a href="#id3" name="important-items">Important items</a></h2>
+<h3><a href="#id4" name="better-documentation">Better documentation</a></h3>
 <ul>
 <li>There should be more developer and and end-user documentation.</li>
 <li>The tutorials should have screenshots for the website.</li>
 <li>build_html should include a step that performs syntax highlighting for
 Python and Objective-C code snippets.</li>
 </ul>
-<h3><a href="#id4" name="test-suite">Test suite</a></h3>
+<h3><a href="#id5" name="test-suite">Test suite</a></h3>
 <p>The test suite needs to be enhanced.</p>
 <ul>
 <li>Somehow find a way to check code-coverage of the unittests.</li>
 <li>Add tests for OC_PythonArray, OC_PythonDict to unittest.c</li>
 </ul>
 <p>The first two bullets require at least some GUI tests.</p>
-<h2><a href="#id5" name="less-important-items">Less important items</a></h2>
-<h3><a href="#id6" name="refactor-some-parts-of-the-bridge">Refactor some parts of the bridge</a></h3>
+<h2><a href="#id6" name="less-important-items">Less important items</a></h2>
+<h3><a href="#id7" name="refactor-some-parts-of-the-bridge">Refactor some parts of the bridge</a></h3>
 <p>From the top of my head:</p>
 <ul>
 <li>Restructure selector.m, this file is too long and complicated. We could
 do away with the difference between method implemented in Python and
 Objective-C.</li>
+<li>Remove the need for <code><span>pyobjc_classMethods</span></code>, you should be able to call
+class methods in the obvious way.  This would (finally) close <a href="http://sourceforge.net/tracker/index.php?func=detail&amp;aid=836247&amp;group_id=14534&amp;atid=114534">836247</a>.</li>
+</ul>
+<ul>
 <li>Likewise for class-builder.m, this file is way to large.</li>
 <li>We've several types that wrap pointer values, such as <code><span>SessionWrapper</span></code> in
 <code><span>Modules/AppKit</span></code>. Should add a function for creating these types, 
 possibly exposed to C code.</li>
 </ul>
-<h3><a href="#id7" name="support-for-gnustep">Support for GNUstep</a></h3>
+<h3><a href="#id8" name="support-for-gnustep">Support for GNUstep</a></h3>
 <p>The current SVN version contains some support for GNUstep, this needs to
 be enhanced.</p>
 <p>Unless somebody actually starts working on this GNUstep support will slowly
 fade away.</p>
-<h3><a href="#id8" name="plugin-bundles">Plugin bundles</a></h3>
+<h3><a href="#id9" name="plugin-bundles">Plugin bundles</a></h3>
 <p>Allow for more than one class to show up in the bundle via
 <code><span>+[NSBundle</span> <span>bundleForClass:]</span></code>.  The implementation of this would statically
 allocate some fixed large number of class wrappers in the __OBJC section of
 the py2app bundletemplate.  The class builder would have a &quot;stack&quot; of
 allocation spaces for classes, and the bundletemplate would push/pop this
 stack.</p>
-<h3><a href="#id9" name="project-templates">Project templates</a></h3>
+<h3><a href="#id10" name="project-templates">Project templates</a></h3>
 <p>Nobody seems to care enough about the templates to actually maintain them, this
 is a shame.</p>
 <ul>
 <p>This would require Python 2.3 on Jaguar.</p>
 </li>
 </ul>
-<h3><a href="#id10" name="complete-cocoa-wrapping">Complete Cocoa wrapping</a></h3>
+<h3><a href="#id11" name="complete-cocoa-wrapping">Complete Cocoa wrapping</a></h3>
 <p>We do not yet have a 100% coverage of the Cocoa API's. We also need code in
 the testsuite that checks if the function wrappers are working as expected.</p>
 <p>Not all constants and enums from Cocoa are currently wrapped.  The annotations
 please report it as a bug and/or post to pyobjc-dev about the issue.  This is
 one area we intend to improve after the release of 1.2 when our new
 wrapper-generators are in a more complete state.</p>
-<h3><a href="#id11" name="pickle-support">Pickle support</a></h3>
+<h3><a href="#id12" name="pickle-support">Pickle support</a></h3>
 <p>Objective-C objects don't support pickling.</p>
 <p>This is post-1.2 work, in general this is a hard problem because it may 
 involve object cycles that cross the Python-ObjC boundary.</p>
-<h3><a href="#id12" name="nscoder-support">NSCoder support</a></h3>
+<h3><a href="#id13" name="nscoder-support">NSCoder support</a></h3>
 <p>It might be useful to add default implementations of <code><span>encodeWithCoder:</span></code> and
 <code><span>initWithCoder:</span></code> methods to Python subclasses of Objective-C classes that 
 implement these.  Note that property list types should already be serializable
 (<code><span>int</span></code>, <code><span>long</span></code>, <code><span>unicode</span></code>, <code><span>list</span></code>, <code><span>tuple</span></code>, <code><span>dict</span></code>).</p>
 <p>See also <cite>Pickle support</cite>.</p>
-<h3><a href="#id13" name="copy"><code><span>-copy</span></code></a></h3>
+<h3><a href="#id14" name="copy"><code><span>-copy</span></code></a></h3>
 <p>There are issues with implementing <code><span>-copy</span></code> in python, these need to be fixed.</p>
 <p>Specifically, overriding an existing <code><span>-copy</span></code> implementation does not work 
 unless <code><span>__slots__</span> <span>==</span> <span>()</span></code></p>
-<h3><a href="#id14" name="known-issues">Known issues</a></h3>
+<h3><a href="#id15" name="known-issues">Known issues</a></h3>
 <p>It is impossible to support methods with a variable number of arguments in the
 generic code (you have to re-implement almost all of the logic of these 
 methods in order to know how many and which types of arguments are expected).
 we should provide custom wrappers, otherwise we should document alternatives.</p>
 <p>Limitations such as the above should be clearly documented elsewhere, these
 are not necessarily TODO items.</p>
-<h3><a href="#id15" name="code-cleanup">Code cleanup</a></h3>
+<h3><a href="#id16" name="code-cleanup">Code cleanup</a></h3>
 <ul>
 <li>Check all error/exception messages</li>
 <li>Check/cleanup error handling</li>
 <code><span>Modules/objc/struct-wrapper.m</span></code>)</li>
 <li>Use the <code><span>CArray</span></code> API whenever appropriate.</li>
 </ul>
-<h3><a href="#id16" name="cleanup-examples">Cleanup Examples</a></h3>
+<h3><a href="#id17" name="cleanup-examples">Cleanup Examples</a></h3>
 <p>The CurrencyConverter example should be removed, this should be the same as the
 final step of the tutorial. It isn't at the moment because additional cruft in
 the example.</p>
 <li>how to integrate with MacPython</li>
 <li>how to use PIL with Cocoa</li>
 </ul>
-<h3><a href="#id17" name="performance-tuning-testing">Performance tuning/testing</a></h3>
+<h3><a href="#id18" name="performance-tuning-testing">Performance tuning/testing</a></h3>
 <p>Design and implement a set of performance tests for the bridge. Use this to 
 investigate and fix any possible performance problems.</p>
-<h3><a href="#id18" name="add-freelists">Add freelists</a></h3>
+<h3><a href="#id19" name="add-freelists">Add freelists</a></h3>
 <p>PyObjCSelector objects and PyObjCObject objects are created on
 a regular basis, we should check if using freelists would speed this up. See
 also <cite>Performance tuning/testing</cite>.</p>
-<h3><a href="#id19" name="formal-protocols-distributed-objects">Formal Protocols, Distributed Objects</a></h3>
+<h3><a href="#id20" name="formal-protocols-distributed-objects">Formal Protocols, Distributed Objects</a></h3>
 <p><code><span>DO</span></code> seems to use formal protocols, we don't fully support those. There is 
 an equivalent to <code><span>@protocol(Foo)</span></code>, but it is not yet possible to define
 new protocols in Python.</p>
-<h3><a href="#id20" name="links-to-apple-documentation">Links to Apple documentation</a></h3>
+<h3><a href="#id21" name="links-to-apple-documentation">Links to Apple documentation</a></h3>
 <p>Links to Apple documentation are not stable, can we add a layer of indirection
 here, e.g. link to the PyObjC website that will redirect to the right
 location?</p>
 <p>We should also provide links to locally installed documentation,
 especially in the documentation that will be installed on the users machine.</p>
-<h3><a href="#id21" name="implement-more-of-nsmutabledictionary-in-oc-pythondictionary">Implement more of NSMutableDictionary in OC_PythonDictionary</a></h3>
+<h3><a href="#id22" name="implement-more-of-nsmutabledictionary-in-oc-pythondictionary">Implement more of NSMutableDictionary in OC_PythonDictionary</a></h3>
 <p>The implementation of OC_PythonDictionary is very minimal, we should add
 additional methods in the NSMutableDictionary interface if those can be 
 implemented efficiently. The default implementation will take care of the
 methods we cannot implement efficiently.</p>
 <p>And the same is true of OC_PythonArray</p>
-<h3><a href="#id22" name="clean-up-oc-pythonobject">Clean up OC_PythonObject</a></h3>
+<h3><a href="#id23" name="clean-up-oc-pythonobject">Clean up OC_PythonObject</a></h3>
 <p>The code is a mess.</p>
-<h3><a href="#id23" name="rewrite-scripts-find-raw-pointers-py">Rewrite scripts/find-raw-pointers.py</a></h3>
+<h3><a href="#id24" name="rewrite-scripts-find-raw-pointers-py">Rewrite scripts/find-raw-pointers.py</a></h3>
 <p>This is a script for finding 'difficult' methods. The script should be 
 refactored to make it easier to create readable reports.</p>
-<h3><a href="#id24" name="finish-struct-wrapper-m">Finish struct-wrapper.m</a></h3>
+<h3><a href="#id25" name="finish-struct-wrapper-m">Finish struct-wrapper.m</a></h3>
 <p>We need more unittests and an implementation of the extended slice interface.</p>
 <p>Why does the GC support cause an assertion failure when it is enabled?</p>
-<h3><a href="#id25" name="finish-refactoring-of-the-code-generator-scripts">Finish refactoring of the code-generator scripts</a></h3>
+<h3><a href="#id26" name="finish-refactoring-of-the-code-generator-scripts">Finish refactoring of the code-generator scripts</a></h3>
 <ol type="1">
 <li>Change code-generator scripts to use loadBundleFunctions, etc.</li>
 <li>Move the code-generator scripts to <code><span>PyObjCTools</span></code>, to make it easier
 for others to generate wrappers.</li>
 <li>Install <code><span>pyobjc-api.h</span></code>.</li>
 </ol>
-<h3><a href="#id26" name="setup-py-cleanup">setup.py cleanup</a></h3>
+<h3><a href="#id27" name="setup-py-cleanup">setup.py cleanup</a></h3>
 <ul>
 <li>Use 'WrapperGenerator.py', probably need to create a custom build action
 for that.</li>
 </ul>
-<h3><a href="#id27" name="unique-proxies-for-python-objects">Unique proxies for Python objects</a></h3>
+<h3><a href="#id28" name="unique-proxies-for-python-objects">Unique proxies for Python objects</a></h3>
 <p>Some Cocoa/CoreFoundation API's basically require that <code><span>a[0]</span> <span>is</span> <span>a[0]</span></code>. The
 container wrappers contain support for that, but we should try to move that
 into the generic core: there should be at most one Objective-C proxy object
 alive for every Python object (just like there's at most one Python proxy for
 every Objective-C object).</p>
-<h3><a href="#id28" name="nsdecimal-vs-decimal">NSDecimal vs decimal</a></h3>
+<h3><a href="#id29" name="nsdecimal-vs-decimal">NSDecimal vs decimal</a></h3>
 <p>Check if it is possible to wrap <code><span>NSDecimal</span></code> using <code><span>decimal</span></code> (and v.v.).</p>
 <p>Only implement this when it is possible to convert without loss of information.</p>
-<h3><a href="#id29" name="nsset-vs-set">NSSet vs set</a></h3>
+<h3><a href="#id30" name="nsset-vs-set">NSSet vs set</a></h3>
 <p>Check if it is possible to wrap <code><span>NSSet</span></code> using <code><span>set</span></code> (and v.v.).</p>
 <p>Only implement this when it is possible to convert without loss of information.</p>
-<h3><a href="#id30" name="python-2-4">Python 2.4</a></h3>
+<h3><a href="#id31" name="python-2-4">Python 2.4</a></h3>
 <p>Python 2.4 introduces a decorator syntax. Add convenience functions that
 make it easier to use decorators with PyObjC.</p>
 <p>Also add example programs using decorators. Actually, first add the example(s)
         def myIntMethod_(self, value):
                 pass
 </pre>
-<h3><a href="#id31" name="nslog-stringwithformat">NSLog, stringWithFormat, ...</a></h3>
+<h3><a href="#id32" name="nslog-stringwithformat">NSLog, stringWithFormat, ...</a></h3>
 <p>Functions and methods that use format strings are not properly wrapped. Fix
 that.</p>
 </body>

pyobjc/Doc/TODO.txt

   do away with the difference between method implemented in Python and
   Objective-C.
 
+* Remove the need for ``pyobjc_classMethods``, you should be able to call
+  class methods in the obvious way.  This would (finally) close `836247`__.
+
+.. __: http://sourceforge.net/tracker/index.php?func=detail&aid=836247&group_id=14534&atid=114534
+
 * Likewise for class-builder.m, this file is way to large.
 
 * We've several types that wrap pointer values, such as ``SessionWrapper`` in