mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-25 17:51:01 +00:00
a2a14fcb8d
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@34412 72102866-910b-0410-8b05-ffd578937521
148 lines
5 KiB
Objective-C
148 lines
5 KiB
Objective-C
/* GSInternal
|
|
Copyright (C) 2009 Free Software Foundation, Inc.
|
|
|
|
Written by: Richard Frith-Macdonald <rfm@gnu.org>
|
|
|
|
This file is part of the GNUstep Base Library.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free
|
|
Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
MA 02111 USA.
|
|
*/
|
|
|
|
|
|
/* This file defines macros for managing internal (hidden) instance variables
|
|
* of a public class so that users of the public class don't need to recompile
|
|
* their code when the class implementation is changed in new versions of the
|
|
* library.
|
|
*
|
|
* The public class MUST declare its instance variables (after any public
|
|
* instance variables which are part of the unchanging public API) using
|
|
* code of the form:
|
|
* #if GS_NONFRAGILE
|
|
* # if defined(GS_X_IVARS)
|
|
* @public GS_X_IVARS;
|
|
* # endif
|
|
* #else
|
|
* @private id _internal GS_UNUSED_IVAR;
|
|
* #endif
|
|
*
|
|
* In the non fragile case, this means that the public header has nothing
|
|
* visible, but the ivars defined in GS_X_IVARS are visible within the
|
|
* implementation.
|
|
*
|
|
* In the fragile case, the '_internal' instance variable is visible in the
|
|
* public header, but as an opaque private instance variable, while macros
|
|
* from this file allow the actual memory to be accessed either as a private
|
|
* class. The use of a private class rather than simple heap memory is
|
|
* necessary for garbage collection... the runtime is able to ensure that
|
|
* garbage collection works properly for the instance variables in the
|
|
* private class.
|
|
*
|
|
* Before including the header file containing the public class declaration,
|
|
* you must define GS_X_IVARS (where X is the class name) to be the
|
|
* list of actual instance variable declarations for the class.
|
|
*
|
|
* Before including this file, you must define 'GSInternal' to be the name
|
|
* of your public class with * 'Internal' appended.
|
|
* eg. if your class is called 'MyClass' then use the following define:
|
|
* #define GSInternal MyClassInternal
|
|
*
|
|
* After including this file you can use the GS_PRIVATE_INTERNAL() macro
|
|
* to declare the private subclass used to hold real instance variables.
|
|
* The argument to this macro is the public class name (the GS_X_IVARS
|
|
* list must also be defined).
|
|
*
|
|
* You use GS_CREATE_INTERNAL() in your intialiser to create the object
|
|
* holding the internal instance variables, and GS_DESTROY_INTERNAL() to
|
|
* get rid of that object in your -dealloc method.
|
|
* You use GS_COPY_INTERNAL() in your implementations of -copyWithZone:
|
|
* and -mutableCopyWithZone: in order to get the default copying behavior
|
|
* for the internal class (a single copy of all the instance variables).
|
|
*
|
|
* Instance variables are referenced using the 'internal->ivar' suntax or
|
|
* the GSIV(classname,object,ivar) macro.
|
|
*
|
|
*/
|
|
#if !GS_NONFRAGILE
|
|
|
|
/* Code for when we don't have non-fragile instance variables
|
|
*/
|
|
|
|
/* Start declaration of internal ivars.
|
|
*/
|
|
#define GS_PRIVATE_INTERNAL(name) \
|
|
@interface name ## Internal : NSObject \
|
|
{ \
|
|
@public \
|
|
GS_##name##_IVARS; \
|
|
} \
|
|
@end \
|
|
@implementation name ## Internal \
|
|
@end
|
|
|
|
/* Create holder for internal ivars.
|
|
*/
|
|
#define GS_CREATE_INTERNAL(name) \
|
|
if (nil == _internal) { _internal = [name ## Internal new]; }
|
|
|
|
/* Destroy holder for internal ivars.
|
|
*/
|
|
#define GS_DESTROY_INTERNAL(name) \
|
|
if (nil != _internal) { [_internal release]; _internal = nil; }
|
|
|
|
/* Create a new copy of the current object's internal class and place
|
|
* it in the destination instance. This produces a bitwise copy, and you
|
|
* may wish to perform further action to deepen the copy after using this
|
|
* macro.
|
|
* Use this only where D is a new copy of the current instance.
|
|
*/
|
|
#define GS_COPY_INTERNAL(D,Z) (D)->_internal = NSCopyObject(_internal, 0, (Z));
|
|
|
|
/* Checks to see if internal instance variables exist ... use in -dealloc if
|
|
* there is any chance that the instance is being deallocated before they
|
|
* were created.
|
|
*/
|
|
#define GS_EXISTS_INTERNAL (nil == _internal ? NO : YES)
|
|
|
|
#undef internal
|
|
#define internal ((GSInternal*)_internal)
|
|
#undef GSIVar
|
|
#define GSIVar(X,Y) (((GSInternal*)((X)->_internal))->Y)
|
|
|
|
#else /* GS_NONFRAGILE */
|
|
|
|
/* We have support for non-fragile ivars
|
|
*/
|
|
|
|
#define GS_PRIVATE_INTERNAL(name)
|
|
|
|
#define GS_CREATE_INTERNAL(name)
|
|
|
|
#define GS_DESTROY_INTERNAL(name)
|
|
|
|
#define GS_COPY_INTERNAL(D,Z)
|
|
|
|
#define GS_EXISTS_INTERNAL YES
|
|
|
|
/* Define constant to reference internal ivars.
|
|
*/
|
|
#undef internal
|
|
#define internal self
|
|
#undef GSIVar
|
|
#define GSIVar(X,Y) ((X)->Y)
|
|
|
|
#endif /* GS_NONFRAGILE */
|
|
|
|
|