Updated docs for better html.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@2680 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Adam Fedor 1998-01-02 19:23:58 +00:00
parent e6395ff746
commit 5fbbf08ce3
18 changed files with 96 additions and 522 deletions

View file

@ -1,17 +1,23 @@
Fri Jan 2 13:04:53 1998 Adam Fedor <fedor@spanky.doc.com>
Fri Jan 2 13:04:53 1998 Adam Fedor <fedor@doc.com>
* doc/Makefile.postamble: Generate texi from tmpl.texi files.
* doc/Makefile.postamble: Generate html,texi from tmpl.texi files.
* doc/announce.tmpl.texi: Renamed from announce.texi
* doc/faq.tmpl.texi: Likewise.
* doc/gnustep-base.tmpl.texi: Likewise.
* doc/gnustep-howto.tmpl.texi: Likewise.
* doc/gnustep-zones.tmpl.texi: Likewise.
* doc/coding-standards.tmpl.texi: Likewise.
* doc/install.tmpl.texi: Likewise.
* doc/manual.tmpl.texi: Likewise.
* doc/news.tmpl.texi: Likewise.
* doc/readme.tmpl.texi: Likewise.
* doc/todo.tmpl.texi: Likewise.
* NSZone.texi: Removed.
* STATUS: removed.
* MACHINES: removed.
* doc/status.tmpl.texi: New file.
Wed Dec 31 13:58:51 1997 Adam Fedor <fedor@doc.com>
* STATUS: Updated status on a few classes.

View file

@ -34,9 +34,11 @@ TEXI2HTML = texi2html
ORIG_FILES = \
version.tmpl.texi \
gnustep-gui.tmpl.texi \
gnustep-base.tmpl.texi \
gnustep-howto.tmpl.texi \
gnustep-zones.tmpl.texi \
announce.tmpl.texi \
coding-standards.tmpl.texi \
install.tmpl.texi \
news.tmpl.texi \
readme.tmpl.texi \
@ -46,17 +48,17 @@ faq.tmpl.texi
TEXI_FILES = \
version.texi \
gnustep-gui.texi \
gnustep-base.texi \
gnustep-howto.texi \
gnustep-zones.texi \
announce.texi \
coding-standards.texi \
install.texi \
news.texi \
readme.texi \
status.texi \
todo.texi \
faq.texi \
coding-standards.texi \
gnustep-howto.texi \
gnustep-zones.texi
TEXT_FILES = \
TODO INSTALL NEWS CODING-STANDARDS README ANNOUNCE FAQ STATUS GNUstep-HOWTO
@ -66,9 +68,9 @@ PS_FILES = gnustep-base.dvi
HTML_FILES = gnustep-base_toc.html
DVI_FILES = gnustep-base.dvi
TOP_DOC_FILES = README INSTALL NEWS GNUstep-HOWTO
RCS_FILES = $(TEXI_FILES) GNUmakefile Makefile.postamble
DIST_FILES = $(RCS_FILES) texinfo.tex $(TEXT_FILES)
TOP_DOC_FILES = TODO README INSTALL NEWS ANNOUNCE STATUS GNUstep-HOWTO
RCS_FILES = $(ORIG_FILES) GNUmakefile Makefile.postamble
DIST_FILES = $(RCS_FILES) $(TEXT_FILES)
-include Makefile.preamble

View file

@ -60,7 +60,9 @@
after-clean::
rm -f version.texi
rm -f $(TEXT_FILES)
rm -f $(ORIG_FILES:.tmpl.texi=.texi)
rm -f *.info
rm -f *.html
rm -f gnustep-base.dvi gnustep-base.aux gnustep-base.log \
gnustep-base.toc gnustep-base.cl \
gnustep-base.cp gnustep-base.cps gnustep-base.fn gnustep-base.fns \
@ -193,7 +195,11 @@ TODO: version.tmpl.texi todo.tmpl.texi
> todo.texi ; \
$(MAKEINFO) $(TEXT_FLAGS) -o TODO $(srcdir)/todo.texi
CODING-STANDARDS: version.tmpl.texi coding-standards.texi
CODING-STANDARDS: version.tmpl.texi coding-standards.tmpl.texi
sed -e 's,@email{\([^}]*\)},<\1>,g' \
$(srcdir)/coding-standards.tmpl.texi \
| sed -e 's,@url{\([^}]*\)},@samp{\1},g' \
> coding-standards.texi ; \
$(MAKEINFO) $(TEXT_FLAGS) -o CODING-STANDARDS \
$(srcdir)/coding-standards.texi

View file

@ -1,7 +1,7 @@
@chapter GNU Objective-C Class Library
@c set the vars GNUSTEP_BASE_VERSION and GCC_VERSION
@include version.texi
@c set the vars GNUSTEP-BASE-VERSION and GCC-VERSION
@include version.tmpl.texi
The GNUstep Base Library (libgnustep-base) is a library of
general-purpose, non-graphical Objective C objects written by Andrew
@ -134,7 +134,7 @@ does *not* do:
The library is available by anonymous ftp at URL:
@smallexample
ftp://prep.ai.mit.edu/pub/gnu/libgnustep-base-@value{GNUSTEP_BASE_VERSION}.tar.gz
ftp://prep.ai.mit.edu/pub/gnu/libgnustep-base-@value{GNUSTEP-BASE-VERSION}.tar.gz
@end smallexample
Since @samp{prep} is heavily loaded, you are encouraged to use GNU
mirror sites.

View file

@ -1,9 +1,9 @@
@chapter GNUstep Base Library
@chapter Announcement
@c set the vars GNUSTEP_BASE_VERSION and GNUSTEP_BASE_GCC_VERSION
@include version.texi
@c set the vars GNUSTEP-BASE-VERSION and GNUSTEP-BASE-GCC-VERSION
@include version.tmpl.texi
The GNUstep Base Library, version @value{GNUSTEP_BASE_VERSION}, is now
The GNUstep Base Library, version @value{GNUSTEP-BASE-VERSION}, is now
available.
@section What is the GNUstep Base Library?
@ -26,17 +26,17 @@ distribution.
@section Where can you get it? How can you compile it?
@ifset GNUSTEP_BASE_FTP_MACHINE
The libgnustep-base-@value{GNUSTEP_BASE_VERSION}.tar.gz distribution file has been
placed on @samp{@value{GNUSTEP_BASE_FTP_MACHINE}} in
@samp{@value{GNUSTEP_BASE_FTP_DIRECTORY}}.
@ifset GNUSTEP-BASE-FTP-MACHINE
The libgnustep-base-@value{GNUSTEP-BASE-VERSION}.tar.gz distribution file has been
placed on @samp{@value{GNUSTEP-BASE-FTP-MACHINE}} in
@samp{@value{GNUSTEP-BASE-FTP-DIRECTORY}}.
@end ifset
@ifclear GNUSTEP_BASE_FTP_MACHINE
The libgnustep-base-@value{GNUSTEP_BASE_VERSION}.tar.gz distribution file has not
@ifclear GNUSTEP-BASE-FTP-MACHINE
The libgnustep-base-@value{GNUSTEP-BASE-VERSION}.tar.gz distribution file has not
been made available by anonymous ftp.
@end ifclear
The library requires gcc @value{GNUSTEP_BASE_GCC_VERSION} or higher.
The library requires gcc @value{GCC-VERSION} or higher.
Significant sections of the library do not work with the NeXT runtime,
so we recommend using gcc instead of NeXT's cc. See the @samp{INSTALL}
file for more instructions about compiling and installing the library.

View file

@ -16,9 +16,7 @@
@c @definfoenclose url `, '
@c @end ifinfo
@iftex
@chapter GNUstep Frequently Asked Questions with Answers
@end iftex
Maintained by Andrew McCallum @email{mccallum@@gnu.org}, with
contributions by Adam Fedor @email{fedor@@gnu.org},

View file

@ -26,7 +26,7 @@ This file documents the GNUstep BASE Library.
@subtitle DRAFT Edition for GNUstep BASE Library @value{GNUSTEP-BASE-VERSION}
@subtitle Last revision Jan 1998
@c @subtitle For GCC Version @value{GNUSTEP-BASE-GCC}
@author Andrew McCallum
@author Andrew McCallum and Adam Fedor
@sp 1
@end ifclear
Copyright @copyright{} 1998 Free Software Foundation

View file

@ -1,9 +1,9 @@
\input texinfo @c -*-texinfo-*-
@setfilename gnustep-howto.texi
@chapter GNUstep Installation
@chapter Installation
@paragraphindent 4
@c @paragraphindent 4
@ignore
This file gives a quick introduction to installing GNUstep.
@ -109,11 +109,9 @@ make-3.75.tar.gz (You need GNU make to compile GNUstep).
gcc-2.7.2.1-objc-970318.diff.gz (patch needed for using gcc 2.7.2.x)
From the gstep-base distribution (gcc-2.7.2.1-objc.diff) or
ftp://alpha.gnu.org/gnu/gnustep
ftp://ftp.gnustep.org/pub/gnustep/developer
ftp://zarquon.mathi.uni-heidelberg.de/pub/GNUstep/developer/releases
gdb-4.16-objc-971112.diff.gz (A patch for easier debugging of Objective-C).
ftp://alpha.gnu.org/gnu/gnustep
ftp://ftp.gnustep.org/pub/gnustep/developer
tiff-v3.4beta036-tar.gz (The TIFF library), or
tiff-970711.tar.gz
@ -130,28 +128,27 @@ gstep-base-0.4.0.tar.gz (Foundation)
gstep-gui-0.4.0.tar.gz (AppKit)
gstep-xdps-0.4.0.tar.gz (X11/PostScript backend)
ftp://ftp.gnu.org/pub/gnu
ftp://ftp.gnustep.org/pub/gnustep
ftp://alpha.gnu.org/gnu/gnustep
ftp://zarquon.mathi.uni-heidelberg.de/pub/GNUstep
libFoundation-0.8.0.tar.gz (Foundation)
ftp://zarquon.mathi.uni-heidelberg.de/pub/GNUstep
ftp://alpha.gnu.org/gnu/gnustep
ftp://zarquon.mathi.uni-heidelberg.de/pub/GNUstep
FoundationExt-0.8.1.tar.gz (Foundation extentions (optional))
ftp://ftp.gnu.org/pub/gnu
ftp://ftp.gnustep.org/pub/gnustep
ftp://zarquon.mathi.uni-heidelberg.de/pub/GNUstep
ftp://alpha.gnu.org/gnu/gnustep
ftp://zarquon.mathi.uni-heidelberg.de/pub/GNUstep
@end example
You may get either one of the Foundations libraries (you only need to
take one of them, not both) gstep-base or libFoundation.
Note that you should get the latest version available, not
necessarily the one listed here. For the more adventurous, and since the
project is still in development, it might be better to get the latest snapshot
located in the snap or snapshot subdirectories at alpha.gnu.org/gnu/gnustep
or the other ftp locations.
Note that you should get the latest version available, not necessarily
the one listed here. For the more adventurous, and since the project is
still in development, it might be better to get the latest snapshot
located in the snap or snapshot subdirectories at
ftp://alpha.gnu.org/gnu/gnustep or the other appropriate ftp locations.
For the following instructions, some version numbers are replaced by XXX.
You shoule replace the 'X's with the version of the package you have.

View file

@ -3,9 +3,9 @@
@c data files, please ignore the references to them below.
@c set the vars GNUSTEP_BASE_VERSION and GNUSTEP_BASE_GCC_VERSION
@include version.texi
@include version.tmpl.texi
@ifset INSTALL_ONLY
@ifset TEXT_ONLY
This file documents the installation of the GNUstep Base Library,
@samp{libgnustep-base}. Copyright (C) 1993, 1994, 1996, 1997 Free Software
Foundation, Inc. You may copy, distribute, and modify it freely as long

View file

@ -1,9 +1,9 @@
@c set the vars GNUSTEP_BASE_VERSION and GNUSTEP_BASE_GCC_VERSION
@include version.texi
@c set the vars GNUSTEP-BASE-VERSION and GNUSTEP-BASE-GCC-VERSION
@include version.tmpl.texi
THIS INFORMATION IS OUT-OF-DATE.
The library requires gcc @value{GNUSTEP_BASE_GCC_VERSION} or higher. The
The library requires gcc @value{GCC-VERSION} or higher. The
library does not work with the NEXTSTEP 3.2 compiler because that
version of NeXT's cc cannot handle nested functions. Until a later
release from NeXT, NEXTSTEP users will have to install gcc. See the

View file

@ -19,8 +19,8 @@ END-INFO-DIR-ENTRY
@end format
@end ifinfo
@c set the vars GNUSTEP_BASE_VERSION and GCC_VERSION
@include version.texi
@c set the vars GNUSTEP-BASE-VERSION and GCC-VERSION
@include version.tmpl.texi
@ifinfo
This file documents the features and implementation of The GNU
@ -65,8 +65,8 @@ Free Software Foundation instead of in the original English.
@title GNU Objective C Class Library
@sp 3
@c @subtitle last updated Oct 26, 1993
@subtitle Version @value{GNUSTEP_BASE_VERSION}
@subtitle (for use with @samp{gcc} version @value{GCC_VERSION})
@subtitle Version @value{GNUSTEP-BASE-VERSION}
@subtitle (for use with @samp{gcc} version @value{GCC-VERSION})
@author Andrew Kachites McCallum (mccallum@@gnu.ai.mit.edu)
@page
@vskip 0pt plus 1filll
@ -134,8 +134,8 @@ saved copy
This manual documents how to install and use the GNU Objective-C
Class Library (or @samp{libgnustep-base}), version
@value{GNUSTEP_BASE_VERSION}, for use with @samp{gcc} version
@value{GCC_VERSION}.
@value{GNUSTEP-BASE-VERSION}, for use with @samp{gcc} version
@value{GCC-VERSION}.
It is nothing but a skeleton now, mostly containing rough notes.
In the future it will be fleshed out and the text will be polished.

View file

@ -1,12 +1,10 @@
@include version.texi
@ifset NEWS_ONLY
@chapter News about GNUstep Base Library
@include version.tmpl.texi
@chapter News
The currently released version of the library is
@samp{@value{GNUSTEP_BASE_VERSION}}.
@end ifset
@samp{@value{GNUSTEP-BASE-VERSION}}.
@section Noteworthy changes since version @samp{0.2.1}
@section Noteworthy changes in version @samp{0.4.0}
@itemize @bullet
@ -21,23 +19,23 @@ checks, and everything else.
allocate shared VM memory.
@item Big NSTimeZone improvements, as well as inclusion of time zone files,
from Yoo C. Chung <wacko@@laplace.snu.ac.kr>.
from Yoo C. Chung @email{wacko@@laplace.snu.ac.kr}.
@item Major improvements to distributed objects and many related clases
from Richard Frith-Macdonald <richard@@brainstorm.co.uk>. Also added a
from Richard Frith-Macdonald @email{richard@@brainstorm.co.uk}. Also added a
nameserver.
@item Major rewrite of NSString, include Unicode strings from Stevo
Crvenkovski <stevoc@@lotus.mpt.com.mk>
Crvenkovski @email{stevoc@@lotus.mpt.com.mk}
@item A rewrite of the NSBundle class from Adam Fedor <fedor@@gnu.org>.
@item A rewrite of the NSBundle class from Adam Fedor @email{fedor@@gnu.org}
@item Addition of a C-language style stream package.
@item Better support for threads and locking.
@item Support for running on Windows from Scott Christley
<scottc@@net-community.com>
@email{scottc@@net-community.com}
@item Many, many, many, many bug fixes and new classes.
@ -54,17 +52,17 @@ the way various other names were changed.
@item The library now requires a patch to gcc-2.7.2. The patch adds
thread-safe features to the GNU Objective C runtime. Each thread has
its own exception handler and assertion handler, thanks to Yoo C. Chung
<wacko@@power1.snu.ac.kr>.
@email{wacko@@power1.snu.ac.kr}.
@item Distributed Objects is much improved. Exceptions in the server
are sent back to the client. Ungracefully closed connections are
gracefully handled.
@item NSUserDefaults has been implemented, thanks to Georg Tuparev
<tuparev@@NMR.EMBL-Heidelberg.DE>.
@email{tuparev@@NMR.EMBL-Heidelberg.DE}.
@item NSScanner has been implemented, thanks to Eric Norum
<Eric.Norum@@usask.ca>.
@email{Eric.Norum@@usask.ca}.
@item NSCharacterSet has a new caching scheme, and is now faster than
NeXT's implementation, thanks to Adam Fedor.
@ -80,12 +78,12 @@ NSAutoreleasePool should be thread-safe.
better commented.
@item The NSHashTable and NSMapTable functions have been implemented,
thanks to Albin Jones <albin.jones@@dartmouth.edu>. Albin has also
thanks to Albin Jones @email{albin.jones@@dartmouth.edu}. Albin has also
implemented underlying GNU functions that provide functions for arrays
and linked lists of C-type variables.
@item The NSThread class has been implemented. Thanks to Scott
Christley <scottc@@net-community.com>, the NSLock class has been
Christley @email{scottc@@net-community.com}, the NSLock class has been
implemented.
@item A RunLoop class has been implemented, and is used for listening to
@ -156,8 +154,8 @@ NSAllocateMemoryPages, NSDeallocateMemoryPages, NSCopyMemoryPages.
@itemize @bullet
@item Can be made as a shared library by passing @samp{--enabled-shared} to
`configure'. Thanks to Jan Kybic <kybic@@earn.cvut.cz> and Bryan Headley
<bwh@@mail.lnd.coretech.com> for suggestions.
`configure'. Thanks to Jan Kybic @email{kybic@@earn.cvut.cz} and Bryan Headley
@email{bwh@@mail.lnd.coretech.com} for suggestions.
@item New classes NSSet, NSMutableSet, NSCountedSet. New concrete
classes NSGSet, NSGMutableSet, NSGCountedSet. New test program nsset.m.
@ -175,7 +173,7 @@ a Tree, and a LinkedList that winds its way through the leaves of the
tree; the LinkedList nodes also have pointers back to the tree nodes.)
@item NSTimeZone implemented, thanks to Peter Burka
<peter@@bert.psyc.upei.ca>
@email{peter@@bert.psyc.upei.ca}
@item NSData fixes, thanks to Adam Fedor.
@ -283,8 +281,8 @@ Eventually I'll separate the classes too.
@item
Included an outline for the GNU Objective C Language Manual. The GNU
project is looking for volunteers to help flesh it out. Send email to
Martin Michlmayr <tbm@@ihq.com> or Andrew McCallum
<mccallum@@gnu.ai.mit.edu>.
Martin Michlmayr @email{tbm@@ihq.com} or Andrew McCallum
@email{mccallum@@gnu.ai.mit.edu}.
@item
Include the AUTHORS file, needed for legal reasons. Include the
@ -303,7 +301,7 @@ implementations back in Collection.m.
@itemize @bullet
@item
Thanks to Adam Fedor <fedor@@boulder.colorado.edu>, classes NSBundle,
Thanks to Adam Fedor @email{fedor@@boulder.colorado.edu}, classes NSBundle,
NSNumber and NSValue are now operational. He also provided stubs for
NSArray, NSCoder and NSDictionary.
@ -343,19 +341,19 @@ Newly implemented classes: MallocAddress, NSString, NSMutableString,
NSCString, NSMutableCString.
@item
Thanks to Pieter Schoenmakers <tiggr@@es.ele.tue.nl> we have a new
Thanks to Pieter Schoenmakers @email{tiggr@@es.ele.tue.nl} we have a new
version of the gcc-string.patch that should apply more smoothly.
@item
Thanks to Adam Fedor <fedor@@boulder.colorado.edu> for a bug fix to
Thanks to Adam Fedor @email{fedor@@boulder.colorado.edu} for a bug fix to
NXStringTable's.
@item
Thanks to Mark Lakata <lakata@@nsdssp.lbl.gov> for a bug fix to NSZone.c.
Thanks to Mark Lakata @email{lakata@@nsdssp.lbl.gov} for a bug fix to NSZone.c.
@ignore
@item
Thanks to Jeremy Bettis <jbettis@cse.unl.edu> for implementing NSDate.
Thanks to Jeremy Bettis @email{jbettis@cse.unl.edu} for implementing NSDate.
(We're waiting for the assignment paperwork to go through before it's
included in the release.)
@end ignore
@ -431,7 +429,7 @@ InvalidationListening.
@item Some bug fixes: Fixed the assert typo in Storage.m. The Time
class now compiles under Solaris. Fixed insertion bug in CircularArray.
NXStringTable_scan.l can now be compiled with lex, not just flex,
(thanks to Adam Fedor <adam@@bastille.rmnug.org>). Properly detect the
(thanks to Adam Fedor @email{adam@@bastille.rmnug.org}). Properly detect the
difference between gcc running under NEXTSTEP and NeXT's cc. Using
autoconf version 2.0. Renamed DelegateList to DelegatePool. Renamed
some collection hierarchy methods for better consistency.
@ -449,7 +447,7 @@ NeXT-compatible zone functions.
@itemize @bullet
@item A NeXT-compatible NXStringTable object, thanks to Adam Fedor
<adam@@bastille.rmnug.org>.
@email{adam@@bastille.rmnug.org}.
@item
SplayTree and RBTree classes now operational. More methods in Time

View file

@ -1,7 +1,7 @@
@chapter GNUstep Base Library README
@chapter Readme
@c set the vars GNUSTEP_BASE_VERSION and GCC_VERSION
@include version.texi
@c set the vars GNUSTEP-BASE-VERSION and GCC-VERSION
@include version.tmpl.texi
@include base-desc.texi
@ -21,16 +21,11 @@ will be forthcoming, but the library needs to settle first. For now I
recommend skipping @file{gnustep-base.info} and reading the header files
instead. The headers for the classes are in @file{./src/include}.
The GNUstep FAQ contains an outline of the class heirarchy, as well as a
The FAQ contains an outline of the class heirarchy, as well as a
list of the differences between GNUstep and NeXT's implementation of
OpenStep, and GNUstep's improvements over NeXT's implementation. The
FAQ can be found in @file{doc/GNUstep-FAQ}.
Outdated, preliminary documentation is available via @samp{texinfo} in
the files @samp{gnustep-base.info} and @samp{gnustep-base.texi}.
Because texinfo doesn't yet handle @code{@@deftypemethod}, this
documentation cannot yet be compiled into more readable forms.
@section Overview of the classes
Here is partial list of non-OpenStep classes, grouped by functionality.

View file

@ -1,6 +1,6 @@
@chapter GNU Objective-C Class Library To Do list, and Questions.
@c set the vars GOBJC_VERSION and GCC_VERSION
@include version.texi
@chapter Todo
@c set the vars GSTEP-BASE-VERSION and GCC-VERSION
@include version.tmpl.texi
This TODO list is out of date.

View file

@ -38,7 +38,7 @@ DIST_FILES = \
config/config.nested.c config/config.nextcc.h config/config.nextrt.m \
config/config.vsprintf.c \
README.ULTRIX README.ucblib \
STATUS COPYING COPYING.LIB ChangeLog \
COPYING COPYING.LIB ChangeLog \
configure Version \
config.guess mkinstalldirs install-sh config.sub \
gcc-2.7.2-objc.diff \

View file

@ -1,34 +0,0 @@
The testers of the various ports to different machines.
A machine's presence in this list does not imply that the latest
version of libobjects works on that machine. Mostly this list
provides you with people you can contact who have had experience with
libobjects on these machines. This list is probably out of date.
i386-unknown-linux jbettis@cse.unl.edu (Jeremy Bettis)
i386-freebsd2.0 cracauer@wavehh.hanse.de (Martin Cracauer)
i386-solaris2.4 james.gledhill@brite.com (James Gledhill)
i386-esix james.gledhill@brite.com (James Gledhill)
sparc-sun-sunos4.1.3 mccallum@cs.rochester.edu (Andrew McCallum)
cracauer@wavehh.hanse.de (Martin Cracauer)
sparc-sun-solaris2.3 pkr@kom.auc.dk (Peter Kristensen)
james.gledhill@brite.com (James Gledhill)
m68k-next-nextstep3.3p1 jbettis@cse.unl.edu (Jeremy Bettis)
m68k-next-nextstep3.2 ebariaux@ulb.ac.be (Eric Bariaux)
m68k-amiga-amigaos3.1 fog@cyberspace.org (Federico Di Gregorio)
hppa1.1-hp-hpux9 mooney@golem.phys.ndsu.NoDak.edu (Timothy Mooney)
mips-sgi-irix5.2 mccallum@gnu.ai.mit.edu (Andrew McCallum)
cracauer@wavehh.hanse.de (Martin Cracauer)
ebariaux@ulb.ac.be (Eric Bariaux)
sparc-sun-solaris2.5 fedor@doc.com(Adam Fedor)
The uniq'ed list:
jbettis@cse.unl.edu (Jeremy Bettis),
cracauer@wavehh.hanse.de (Martin Cracauer),
james.gledhill@brite.com (James Gledhill),
pkr@kom.auc.dk (Peter Kristensen),
ebariaux@ulb.ac.be (Eric Bariaux),
fog@cyberspace.org (Federico Di Gregorio),
mooney@golem.phys.ndsu.NoDak.edu (Timothy Mooney),
fedor@doc.com(Adam Fedor)

394
STATUS
View file

@ -1,394 +0,0 @@
Status of GNUstep classes, protocols and functions
**************************************************
Key:
[10] - complete and tested
[8] - missing a few non-core methods, definitely usable
[6] - missing several methods, but core is there, usable
[4] - begun, but missing core functionality, not usable
[2] - skeleton
[0] - nothing there
Classes
=======
(Many classes do not raise the proper NSExceptions yet.)
* NSArchiver:: [8]
Doesn't yet call -awakeAfterUsingCoder:.
* NSArray:: [9]
* NSAssertionHandler:: [9]
* NSAutoreleasePool:: [9]
But not exception- safe
* NSBundle:: [8]
* NSCalendarDate:: [7]
* NSCharacterSet:: [8]
decomposableCharacterSet and illegalCharacter set missing
* NSCoder:: [8]
Missing class name substitution methods.
* NSConditionLock:: [8]
* NSConnection:: [7]
GNU Connection, however, needs:
* to handle retain/release/dealloc properly
* to be integrated with NSInvocation
* to incorporate futzing with low-level TCP-backend for better speed
* to have UDP-backend work
* to cache ConnectedCoder's for better speed
* Thread-safety overhaul, this is major
* NSCountedSet:: [8]
* NSData:: [8]
* NSDate:: [8]
* NSDeserializer:: [7]
* NSDictionary:: [8]
* NSDistantObject:: [7]
* NSEnumerator:: [9]
* NSException:: [9]
But this needs integration with new, better
* NSInvocation:: [3]
* NSLock:: [8]
* NSMethodSignature:: [4]
* NSMutableArray:: [8]
* NSMutableCharacterSet:: [7]
* NSMutableData:: [8]
* NSMutableDictionary:: [8]
* NSMutableSet:: [8]
* NSMutableString:: [8]
* NSNotification:: [9]
* NSNotificationCenter:: [9]
* NSNotificationQueue:: [6]
Needs integration with NSRunLoop, and efficiency improvements
* NSNumber:: [9]
* NSObject:: [10]
* NSProcessInfo:: [9]
* NSProxy:: [7]
* NSRecursiveLock:: [8]
* NSRunLoop:: [8]
NSTimer's not yet working, but everything else should be
* NSScanner:: [8]
* NSSerializer:: [7]
* NSSet:: [8]
* NSString:: [8]
Careful, relationship with GNU String is tricky; this could
also use fixing.
* NSThread:: [8]
* NSTimeZone:: [8]
* NSTimeZoneDetail:: [8]
* NSTimer:: [6]
Working out bugs with returning doubles.
* NSUnarchiver:: [8]
See NSArchvier
* NSUserDefaults:: [8]
* NSValue:: [9]
Cross-Class Projects, or GNU-related foundations for GNUstep classes
====================================================================
* Finish subclasses of Port class: Ports based on UDP, pflocal
sockets, and shared memory.
* String classes will get some organizational work.
Protocols
=========
* NSCoding:: [9]
* NSCopying:: [9]
* NSLocking:: [9]
* NSMutableCopying:: [9]
* NSObjCTypeSerializationCallBack:: [9]
* NSObject (Protocol):: [9]
Functions
=========
Memory Allocation Functions
---------------------------
[8] Get the Virtual Memory Page Size
`unsigned NSPageSize (void)'
`unsigned NSLogPageSize (void)'
`unsigned NSRoundDownToMultipleOfPageSize (unsigned BYTECOUNT)'
`unsigned NSRoundUpToMultipleOfPageSize (unsigned BYTECOUNT)'
[2] Get the Amount of Real Memory
`unsigned NSRealMemoryAvailable (void)'
[8] Allocate or Free Virtual Memory
`void *NSAllocateMemoryPages (unsigned BYTECOUNT)'
`void NSDeallocateMemoryPages (void *POINTER, unsigned BYTECOUNT)'
`void NSCopyMemoryPages (const void *SOURCE, void *DESTINATION, unsigned BYTECOUNT)'
[8] Child and Merge Zones
void NSMergeZone(NSZone *zonep)
NSZone *NSCreateChildZone(NSZone *parentZone, size_t startSize, size_t granularity, int canFree)
[9] Get a Zone
`NSZone *NSCreateZone (unsigned STARTSIZE, unsigned GRANULARITY, BOOL CANFREE)'
`NSZone *NSDefaultMallocZone (void)'
`NSZone *NSZoneFromPointer (void *POINTER)'
[10] Allocate or Free Memory in a Zone
`void *NSZoneMalloc (NSZone *ZONE,'
`void *NSZoneCalloc (NSZone *ZONE, unsigned NUMELEMS, unsigned NUMBYTES)'
`void *NSZoneRealloc (NSZone *ZONE, void *POINTER, unsigned SIZE)'
`void NSRecycleZone (NSZone *ZONE)'
`void NSZoneFree (NSZone *ZONE, void *POINTER)'
[9] Name a Zone
But the function names are wrong
`void NSSetZoneName (NSZone *ZONE, NSString *name)'
`NSString *NSZoneName (NSZone *ZONE)'
Object Allocation Functions
---------------------------
[10] Allocate or Free an Object
`NSObject *NSAllocateObject (Class ACLASS, unsigned EXTRABYTES, NSZone *ZONE)'
`NSObject *NSCopyObject(NSObject *ANOBJECT, unsigned EXTRABYTES, NSZone *ZONE)'
`void NSDeallocateObject (NSObject *ANOBJECT)'
[9] Decide Whether to Retain an Object
`BOOL NSShouldRetainWithZone (NSObject *ANOBJECT, NSZone *REQUESTEDZONE)'
[9] Modify the Number of References to an Object
`BOOL NSDecrementExtraRefCountWasZero(id ANOBJECT)'
`void NSIncrementExtraRefCount(id ANOBJECT)'
Error-Handling Functions
------------------------
[9] Change the Top-level Error Handler
``NSUncaughtException'Handler *`NSGetUncaughtException'Handler(void)'
`void `NSSetUncaughtException'Handler(`NSUncaughtException'Handler *HANDLER)'
[9] Macros to Handle an Exception
`NS_DURING'
`NS_ENDHANDLER'
`NS_HANDLER'
`NS_VALUERETURN(VALUE, TYPE)'
`NS_VOIDRETURN'
[9] Call the Assertion Handler from the Body of an Objective-C Method
`NSAssert(BOOL CONDITION, NSString *DESCRIPTION)'
`NSAssert1(BOOL CONDITION, NSString *DESCRIPTION, ARG)'
`NSAssert2(BOOL CONDITION, NSString *DESCRIPTION, ARG1, ARG2)'
`NSAssert3(BOOL CONDITION, NSString *DESCRIPTION, ARG1, ARG2, ARG3)'
`NSAssert4(BOOL CONDITION, NSString *DESCRIPTION, ARG1, ARG2, ARG3, ARG4)'
`NSAssert5(BOOL CONDITION, NSString *DESCRIPTION, ARG1, ARG2, ARG3, ARG4, ARG5)'
[9] Call the Assertion Handler from the Body of a C Function
`NSCAssert(BOOL CONDITION, NSString *DESCRIPTION)'
`NSCAssert1(BOOL CONDITION, NSString *DESCRIPTION, ARG)'
`NSCAssert2(BOOL CONDITION, NSString *DESCRIPTION, ARG1, ARG2)'
`NSCAssert3(BOOL CONDITION, NSString *DESCRIPTION, ARG1, ARG2, ARG3)'
`NSCAssert4(BOOL CONDITION, NSString *DESCRIPTION, arg1, ARG2, ARG3, ARG4)'
`NSCAssert5(BOOL CONDITION, NSString *DESCRIPTION, ARG1, ARG2, ARG3, ARG4, ARG5)'
[9] Validate a Parameter
`NSParameterAssert(BOOL CONDITION)'
`NSCParameterAssert(BOOL CONDITION)'
Geometric Functions
-------------------
[10] Create Basic Structures
`NSPoint NSMakePoint(float X, float Y)'
`NSSize NSMakeSize(float W, float H)'
`NSRect NSMakeRect(float X, float Y, float W, float H)'
`NSRange NSMakeRange(unsigned int LOCATION, unsigned int LENGTH)'
[10] Get a Rectangle's Coordinates
`float NSMaxX(NSRect ARECT)'
`float NSMaxY(NSRect ARECT)'
`float NSMidX(NSRect ARECT)'
`float NSMidY(NSRect ARECT)'
`float NSMinX(NSRect ARECT)'
`float NSMinY(NSRect ARECT)'
`float NSWidth(NSRect ARECT)'
`float NSHeight(NSRect ARECT)'
[10] Modify a Copy of a Rectangle
`NSRect NSInsetRect(NSRect ARECT, float DX, float DY)'
`NSRect NSOffsetRect(NSRect ARECT, float DX, float DY)'
`void NSDivideRect(NSRect INRECT, NSRect *SLICE, NSRect *REMAINDER, float AMOUNT, NSRectEdge EDGE)'
`NSRect NSIntegralRect(NSRect ARECT)'
[10] Compute a Third Rectangle from Two Rectangles
`NSRect NSUnionRect(NSRect ARECT, NSRect BRECT)'
`NSRect NSIntersectionRect(NSRect ARECT, NSRect BRECT)'
[10] Test Geometric Relationships
`BOOL NSEqualRects(NSRect ARECT, NSRect BRECT)'
`BOOL NSEqualSizes(NSSize ASIZE, NSSize BSIZE)'
`BOOL NSEqualPoints(NSPoint APOINT, NSPoint BPOINT)'
`BOOL NSIsEmptyRect(NSRect ARECT)'
`BOOL NSMouseInRect(NSPoint APOINT, NSRect ARECT, BOOL FLIPPED)'
`BOOL NSPointInRect(NSPoint APOINT, NSRect ARECT)'
`BOOL NSContainsRect(NSRect ARECT, NSRect BRECT)'
[10] Get a String Representation
`NSString *NSStringFromPoint(NSPoint APOINT)'
`NSString *NSStringFromRect(NSRect ARECT)'
`NSString *NSStringFromSize(NSSize ASIZE)'
Range Functions
---------------
[9] Query a Range
`BOOL NSEqualRanges(NSRange RANGE1, NSRange RANGE2)'
`unsigned NSMaxRange(NSRange RANGE)'
`BOOL NSLocationInRange(unsigned LOCATION, NSRange RANGE)'
[9] Compute a Range from Two Other Ranges
`NSRange NSUnionRange(NSRange RANGE1, NSRange RANGE2)'
`NSRange NSIntersectionRange(NSRange RANGE1, NSRange RANGE2)'
[9] Get a String Representation
`NSString *NSStringFromRange(NSRange RANGE)'
Hash Table Functions
--------------------
[8]
Create a Table
`NSHashTable * NSCreateHashTable(NSHashTableCallBacks CALLBACKS, unsigned CAPACITY)'
`NSHashTable * NSCreateHashTableWithZone(NSHashTableCallBacks CALLBACKS, unsigned CAPACITY, NSZone * ZONE)'
`NSHashTable * NSCopyHashTableWithZone(NSHashTable * TABLE, NSZone * ZONE)'
Free a Table
`void NSFreeHashTable(NSHashTable * TABLE)'
`void NSResetHashTable(NSHashTable * TABLE)'
Compare Two Tables
`BOOL NSCompareHashTables(NSHashTable * TABLE1, NSHashTable * TABLE2)'
Get the Number of Items
`unsigned NSCountHashTable(NSHashTable * TABLE)'
Returns the number of elements in TABLE.
Retrieve Items
`void * NSHashGet(NSHashTable * TABLE, const void * POINTER)'
`NSArray * NSAllHashTableObjects(NSHashTable * TABLE)'
`NSHashEnumerator NSEnumerateHashTable(NSHashTable * TABLE)'
`void * NSNextHashEnumeratorItem(NSHashEnumerator * ENUMERATOR)'
Add or Remove an Item
`void NSHashInsert(NSHashTable * TABLE, const void * POINTER)'
`void NSHashInsertKnownAbsent(NSHashTable * TABLE, const void * POINTER)'
`void * NSHashInsertIfAbsent(NSHashTable * TABLE, const void * POINTER)'
`void NSHashRemove(NSHashTable * TABLE, const void * POINTER)'
Get a String Representation
`NSString * NSStringFromHashTable(NSHashTable * TABLE)'
Map Table Functions
-------------------
[8]
Create a Table
`NSMapTable * NSCreateMapTable(NSMapTableKeyCallBacks KEYCALLBACKS, NSMapTableValueCallBacks VALUECALLBACKS, unsigned CAPACITY)'
`NSMapTable * NSCreateMapTableWithZone(NSMapTableKeyCallBacks KEYCALLBACKS, NSMapTableValueCallBacks VALUECALLBACKS, unsigned CAPACITY,'
`NSMapTable * NSCopyMapTableWithZone(NSMapTable * TABLE, NSZone * ZONE)'
Free a Table
`void NSFreeMapTable(NSMapTable * TABLE)'
`void NSResetMapTable(NSMapTable * TABLE)'
Compare Two Tables:
`BOOL NSCompareMapTables(NSMapTable * TABLE1, NSMapTable * TABLE2)'
Get the Number of Items
`unsigned NSCountMapTable(NSMapTable * TABLE)'
Retrieve Items
`BOOL NSMapMember(NSMapTable * TABLE, const void * KEY, void ** ORIGINALKEY, void ** VALUE)'
`void * NSMapGet(NSMapTable * TABLE,'
`NSMapEnumerator NSEnumerateMapTable(NSMapTable * TABLE)'
`BOOL NSNextMapEnumeratorPair(NSMapEnumerator * ENUMERATOR, void ** KEY, void ** VALUE)'
`NSArray * NSAllMapTableKeys(NSMapTable * TABLE)'
`NSArray * NSAllMapTableValues(NSMapTable * TABLE)'
Add or Remove an Item
`void NSMapInsert(NSMapTable * TABLE, const void * KEY, const void * VALUE)'
`void * NSMapInsertIfAbsent(NSMapTable * TABLE, const void * KEY, const void * VALUE)'
`void NSMapInsertKnownAbsent(NSMapTable * TABLE, const void * KEY, const void * VALUE)'
`void NSMapRemove(NSMapTable * TABLE,'
`NSString *NSStringFromMapTable(NSMapTable *TABLE)'
Miscellaneous Functions
-----------------------
[7] Get Information about a User
`NSString *NSUserName(void)'
`NSString *NSHomeDirectory(void)'
`NSString *NSHomeDirectoryForUser(NSString *USERNAME)'
[9] Log an Error Message
`void NSLog(NSString *format,...'
`void NSLogv(NSString * FORMAT, va_list ARGS)'
[8] Get Localized Versions of Strings
`NSString * NSLocalizedString(NSString * KEY, NSString * COMMENT)'
`NSString * NSLocalizedStringFromTable(NSString * KEY, NSString * TABLENAME, NSString * COMMENT)'
`NSString * NSLocalizedStringFromTableInBundle(NSString * KEY, NSString * TABLENAME, NSBundle * ABUNDLE, NSString * COMMENT)'
[9] Convert to and from a String
`Class NSClassFromString(NSString *ACLASSNAME)'
`SEL NSSelectorFromString(NSString *ASELECTORNAME)'
`NSString *NSStringFromClass(Class ACLASS)'
`NSString *NSStringFromSelector(SEL ASELECTOR)'
[0] Compose a Message To Be Sent Later to an Object
`NSInvocation *NS_INVOCATION(Class ACLASS, INSTANCEMESSAGE)'
`NSInvocation *NS_MESSAGE(id ANOBJECT, INSTANCEMESSAGE)'