Extended/updated objc documentation on constant string classes

From-SVN: r57247
This commit is contained in:
Nicola Pero 2002-09-17 13:51:40 +02:00 committed by Nicola Pero
parent 17656182f7
commit 838c4534d4
2 changed files with 33 additions and 10 deletions

View File

@ -1,3 +1,9 @@
Tue Sep 17 13:40:13 2002 Nicola Pero <n.pero@mi.flashnet.it>
* doc/objc.texi (Constant string objects): Extended documentation
to make clear that the constant string class ivar layout is
completely fixed.
2002-09-17 Roger Sayle <roger@eyesopen.com> 2002-09-17 Roger Sayle <roger@eyesopen.com>
* cfgrtl.c (flow_delete_block_noexpunge): Delete orphaned * cfgrtl.c (flow_delete_block_noexpunge): Delete orphaned

View File

@ -396,7 +396,7 @@ prefixing a C constant string with the character @samp{@@}:
id myString = @@"this is a constant string object"; id myString = @@"this is a constant string object";
@end example @end example
The constant string objects are usually instances of the The constant string objects are by default instances of the
@code{NXConstantString} class which is provided by the GNU Objective-C @code{NXConstantString} class which is provided by the GNU Objective-C
runtime. To get the definition of this class you must include the runtime. To get the definition of this class you must include the
@file{objc/NXConstStr.h} header file. @file{objc/NXConstStr.h} header file.
@ -409,8 +409,9 @@ as @code{NXConstantString}'s structure:
@example @example
@@interface NXConstantString : Object @@interface MyConstantStringClass
@{ @{
Class isa;
char *c_string; char *c_string;
unsigned int len; unsigned int len;
@} @}
@ -418,15 +419,31 @@ as @code{NXConstantString}'s structure:
@end example @end example
User class libraries may choose to inherit the customized constant @code{NXConstantString} inherits from @code{Object}; user class
string class from a different class than @code{Object}. There is no libraries may choose to inherit the customized constant string class
requirement in the methods the constant string class has to implement. from a different class than @code{Object}. There is no requirement in
the methods the constant string class has to implement, but the final
ivar layour of the class must be the compatible with the given
structure.
When a file is compiled with the @option{-fconstant-string-class} option, When the compiler creates the statically allocated constant string
all the constant string objects will be instances of the class specified object, the @code{c_string} field will be filled by the compiler with
as argument to this option. It is possible to have multiple compilation the string; the @code{length} field will be filled by the compiler with
units referring to different constant string classes, neither the the string length; the @code{isa} pointer will be filled with
compiler nor the linker impose any restrictions in doing this. @code{NULL} by the compiler, and it will later be fixed up automatically
at runtime by the GNU Objective-C runtime library to point to the class
which was set by the @option{-fconstant-string-class} option when the
object file is loaded (if you wonder how it works behind the scenes, the
name of the class to use, and the list of static objects to fixup, are
stored by the compiler in the object file in a place where the GNU
runtime library will find them at runtime).
As a result, when a file is compiled with the
@option{-fconstant-string-class} option, all the constant string objects
will be instances of the class specified as argument to this option. It
is possible to have multiple compilation units referring to different
constant string classes, neither the compiler nor the linker impose any
restrictions in doing this.
@c ========================================================================= @c =========================================================================
@node compatibility_alias @node compatibility_alias