Up
Authors
- Richard Frith-Macdonald
-
Copyright: (C) 2005 Free Software Foundation, Inc.
NSString* const NSInconsistentArchiveException;
Specified in OpenStep to be raised by
NSArchiver
or subclasses if there are problems initializing or encoding.
Not currently used. NSInternalInconsistencyException usually raised instead.
NSString* const NSBundleDidLoadNotification;
Notification posted when a bundle is loaded. The notification object is the
NSBundle
itself. The notification also contains a
userInfo dictionary, containing the single key '
NSLoadedClasses
', mapped to an
NSArray
containing the names of each class and category loaded (as strings).
NSString* const NSLoadedClasses;
When an
NSBundle
loads classes and posts a
NSBundleDidLoadNotification
, its
userInfo dictionary contains this key, mapped to an
NSArray
containing the names of each class and category loaded (as strings).
NSString* const NSShowNonLocalizedStrings;
A user default affecting the behavior of
[NSBundle -localizedStringForKey:value:table:]
. If set, the value of the key will be returned as an uppercase string rather than any localized equivalent found. This can be useful during development to check where a given string in the UI is "coming from".
NSString* const NSClassDescriptionNeededForClassNotification;
Posted by
[NSClassDescription +classDescriptionForClass:]
when a class description cannot be found for a class. The implementation will check again after the notification is (synchronously) processed, allowing descriptions to be registered lazily.
NSString* const NSConnectionDidDieNotification;
Posted when an
NSConnection
is deallocated or it is notified its port is deactivated. (Note, connections to remote ports don't get such a notification.) Receivers should deregister themselves for notifications from the given connection.
NSString* const NSConnectionDidInitializeNotification;
NSString* const NSConnectionLocalCount;
NSString* const NSConnectionProxyCount;
NSString* const NSConnectionRepliesReceived;
NSString* const NSConnectionRepliesSent;
NSString* const NSConnectionReplyMode;
NSRunLoop
mode for
NSConnection
objects waiting for replies. Mainly used internally by distributed objects system.
NSString* const NSConnectionRequestsReceived;
NSString* const NSConnectionRequestsSent;
NSString* const NSFailedAuthenticationException;
Raised by an
NSConnection
on receiving a message that it or its delegate cannot authenticate.
const NSTimeInterval NSTimeIntervalSince1970;
Time interval between the unix standard reference date of 1 January 1970 and the OpenStep reference date of 1 January 2001
This number comes from:
(((31 years * 365 days) + 8 days for leap years) = total number of days
24 hours * 60 minutes * 60 seconds)
This ignores leap-seconds.
NSString* const GSNetworkNotificationCenterType;
NSString* const GSPublicNotificationCenterType;
NSString* const NSLocalNotificationCenterType;
NSString* const NSLocalizedDescriptionKey;
Key for user info dictionary component which describes the error in a human readable format.
NSString* const NSMACHErrorDomain;
Domain for system errors (on MACH).
NSString* const NSOSStatusErrorDomain;
Domain for system errors.
NSString* const NSPOSIXErrorDomain;
Domain for system and system library errors.
NSString* const NSUnderlyingErrorKey;
Where one error has caused another, the underlying error can be stored in the user info dictionary using this key.
NSString* const NSCharacterConversionException;
An exception when character set conversion fails.
NSString* const NSGenericException;
A generic exception for general purpose usage.
NSString* const NSInternalInconsistencyException;
An exception for cases where unexpected state is detected within an object.
NSString* const NSInvalidArgumentException;
An exception used when an invalid argument is passed to a method or function.
NSString* const NSMallocException;
An exception used when the system fails to allocate required memory.
NSString* const NSParseErrorException;
An exception used when some form of parsing fails.
NSString* const NSRangeException;
An exception used when an illegal range is encountered... usually this is used to provide more information than an invalid argument exception.
NSString* const GSFileHandleConnectCompletionNotification;
Notification posted when an asynchronous
NSFileHandle
connection attempt (to an FTP, HTTP, or other internet server) has succeeded.
NSString* const GSFileHandleNotificationError;
Message describing error in asynchronous
NSFileHandle
accept,read,write operation.
NSString* const GSFileHandleWriteCompletionNotification;
Notification posted when an asynchronous
NSFileHandle
write operation (to an FTP, HTTP, or other internet server) has succeeded.
NSString* const NSFileHandleConnectionAcceptedNotification;
Posted when one of the
NSFileHandle
methods
acceptConnectionInBackground...
succeeds and has connected to a stream-type socket in another process. The notification's
userInfo dictionary will contain the
NSFileHandle
for the near end of the connection (associated to the key '
NSFileHandleNotificationFileHandleItem
').
NSString* const NSFileHandleDataAvailableNotification;
Posted when one of the
NSFileHandle
methods
waitForDataInBackground...
has been informed that data is available. The receiving
NSFileHandle
is passed in the notification.
NSString* const NSFileHandleNotificationDataItem;
Dictionary key for
NSFileHandle
notifications used to access an
NSData
object containing received data.
NSString* const NSFileHandleNotificationFileHandleItem;
Dictionary key for
NSFileHandle
notifications used to mark the
NSFileHandle
that has established a stream-socket connection.
NSString* const NSFileHandleNotificationMonitorModes;
Dictionary key for
NSFileHandle
notifications postable to certain run loop modes, associated to an NSArray containing the modes allowed.
NSString* const NSFileHandleOperationException;
Exception raised when attempts to read from an
NSFileHandle
channel fail.
An exception used when a file error occurs.
NSString* const NSFileHandleReadCompletionNotification;
Posted when one of the
NSFileHandle
methods readDataInBackground... has consumed data. The receiving
NSFileHandle
is passed in the notification's
userInfo dictionary associated to the key '
NSFileHandleNotificationDataItem
'.
NSString* const NSFileHandleReadToEndOfFileCompletionNotification;
Posted when one of the
NSFileHandle
methods
readToEndOfFileInBackground...
has finished. The receiving
NSFileHandle
is passed in the notification's
userInfo dictionary associated to the key '
NSFileHandleNotificationDataItem
'.
NSString* const NSFileAppendOnly;
NSString* const NSFileCreationDate;
NSString* const NSFileDeviceIdentifier;
NSString* const NSFileExtensionHidden;
NSString* const NSFileGroupOwnerAccountID;
NSString* const NSFileGroupOwnerAccountName;
NSString* const NSFileHFSCreatorCode;
NSString* const NSFileHFSTypeCode;
NSString* const NSFileImmutable;
NSString* const NSFileModificationDate;
NSString* const NSFileOwnerAccountID;
NSString* const NSFileOwnerAccountName;
NSString* const NSFilePosixPermissions;
NSString* const NSFileReferenceCount;
NSString* const NSFileSize;
NSString* const NSFileSystemFileNumber;
NSString* const NSFileSystemFreeNodes;
NSString* const NSFileSystemFreeSize;
NSString* const NSFileSystemNodes;
NSString* const NSFileSystemNumber;
NSString* const NSFileSystemSize;
NSString* const NSFileType;
NSString* const NSFileTypeBlockSpecial;
NSString* const NSFileTypeCharacterSpecial;
NSString* const NSFileTypeDirectory;
NSString* const NSFileTypeFifo;
NSString* const NSFileTypeRegular;
NSString* const NSFileTypeSocket;
NSString* const NSFileTypeSymbolicLink;
NSString* const NSFileTypeUnknown;
const NSPoint NSZeroPoint;
Point at 0,0
const NSRect NSZeroRect;
Zero-size rectangle at 0,0
const NSSize NSZeroSize;
Zero size
const NSHashTableCallBacks NSIntHashCallBacks;
For sets of pointer-sized or smaller quantities.
const NSHashTableCallBacks NSNonOwnedPointerHashCallBacks;
For sets of pointers hashed by address.
const NSHashTableCallBacks NSNonRetainedObjectHashCallBacks;
For sets of objects without retaining and releasing.
const NSHashTableCallBacks NSObjectHashCallBacks;
For sets of objects; similar to
NSSet
.
const NSHashTableCallBacks NSOwnedPointerHashCallBacks;
For sets of pointers with transfer of ownership upon insertion.
const NSHashTableCallBacks NSPointerToStructHashCallBacks;
For sets of pointers to structs when the first field of the struct is the size of an int.
NSString* const NSInvalidArchiveOperationException;
An archiving error has occurred.
NSString* const NSInvalidUnarchiveOperationException;
An unarchiving error has occurred.
NSString* const NSUndefinedKeyException;
NSString* const NSKeyValueChangeIndexesKey;
Description forthcoming.
NSString* const NSKeyValueChangeKindKey;
Description forthcoming.
NSString* const NSKeyValueChangeNewKey;
Description forthcoming.
NSString* const NSKeyValueChangeOldKey;
Description forthcoming.
const NSMapTableKeyCallBacks NSIntMapKeyCallBacks;
For keys that are pointer-sized or smaller quantities.
const NSMapTableValueCallBacks NSIntMapValueCallBacks;
For values that are pointer-sized integer quantities.
const NSMapTableKeyCallBacks NSNonOwnedPointerMapKeyCallBacks;
For keys that are pointers not freed.
const NSMapTableValueCallBacks NSNonOwnedPointerMapValueCallBacks;
For values that are pointers not freed.
const NSMapTableKeyCallBacks NSNonOwnedPointerOrNullMapKeyCallBacks;
For keys that are pointers not freed, or 0.
const NSMapTableKeyCallBacks NSNonRetainedObjectMapKeyCallBacks;
For sets of objects without retaining and releasing.
const NSMapTableValueCallBacks NSNonRetainedObjectMapValueCallBacks;
For sets of objects without retaining and releasing.
const NSMapTableKeyCallBacks NSObjectMapKeyCallBacks;
For keys that are objects.
const NSMapTableValueCallBacks NSObjectMapValueCallBacks;
For values that are objects.
const NSMapTableKeyCallBacks NSOwnedPointerMapKeyCallBacks;
For keys that are pointers with transfer of ownership upon insertion.
const NSMapTableValueCallBacks NSOwnedPointerMapValueCallBacks;
For values that are pointers with transfer of ownership upon insertion.
NSString* const NSPortDidBecomeInvalidNotification;
Notification posted when an instance of
NSPort
or a subclass becomes invalid.
NSString* const NSPortTimeoutException;
NSString* const NSDefaultRunLoopMode;
Run loop mode used to deal with input sources other than NSConnections or dialog windows. Most commonly used. Defined in Foundation/NSRunLoop.h
.
NSString* const NSTaskDidTerminateNotification;
Notification posted when an
NSTask
terminates, either due to the subprocess ending or the
[NSTask -terminate]
method explicitly being called.
NSString* const NSThreadDidStartNotification;
Notification posted whenever a new thread is started up. This is a GNUstep extension.
NSString* const NSThreadWillExitNotification;
Notification posted when an
NSThread
instance receives an exit message, or an external thread has been deregistered.
NSString* const NSWillBecomeMultiThreadedNotification;
Notification posted the first time a new
NSThread
is created or a separate thread from another library is registered in an application. (The initial thread that a program starts with does
not post this notification.) Before such a notification has been posted you can assume the application is in single-threaded mode and locks are not necessary. Afterwards multiple threads
may be running.
NSString* const NSURLFileScheme;
NSString* const GSHTTPPropertyCertificateFileKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to specify the location of an SSL certificate file.
NSString* const GSHTTPPropertyKeyFileKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to specify the location of an SSL key file.
NSString* const GSHTTPPropertyLocalHostKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain local host.
NSString* const GSHTTPPropertyMethodKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain method (GET, POST, etc.).
NSString* const GSHTTPPropertyPasswordKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to specify the password for an SSL key file.
NSString* const GSHTTPPropertyProxyHostKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain proxy host.
NSString* const GSHTTPPropertyProxyPortKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain proxy port.
NSString* const NSHTTPPropertyErrorPageDataKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain error page data.
NSString* const NSHTTPPropertyRedirectionHeadersKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain redirection headers.
NSString* const NSHTTPPropertyServerHTTPVersionKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain HTTP version supported by server.
NSString* const NSHTTPPropertyStatusCodeKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain status code.
NSString* const NSHTTPPropertyStatusReasonKey;
Key for passing to
NSURLHandle
's
propertyForKey..
methods to obtain status reason.
NSString* const NSUndoManagerCheckpointNotification;
Notification posted whenever
NSUndoManager
opens or closes an undo group. The undo manager itself is the notification object, with no
userInfo dictionary.
NSString* const NSUndoManagerDidOpenUndoGroupNotification;
NSString* const NSUndoManagerDidRedoChangeNotification;
Notification posted after an
NSUndoManager
executes a redo operation.
NSString* const NSUndoManagerDidUndoChangeNotification;
Notification posted after an
NSUndoManager
executes an undo operation.
NSString* const NSUndoManagerWillCloseUndoGroupNotification;
Notification posted before an
NSUndoManager
closes an undo group.
NSString* const NSUndoManagerWillRedoChangeNotification;
Notification posted before an
NSUndoManager
will execute a redo operation.
NSString* const NSUndoManagerWillUndoChangeNotification;
Notification posted before an
NSUndoManager
will execute an undo operation.
NSString* const NSAMPMDesignation;
Key for locale dictionary: array of strings for AM and PM.
NSString* const NSArgumentDomain;
User defaults domain for process arguments. Command-line arguments (attribute-value pairs, as in "-NSFoo bar") are placed into this domain.
NSString* const NSCurrencyString;
Key for locale dictionary: text formatter string for monetary amounts.
NSString* const NSCurrencySymbol;
Key for locale dictionary: currency symbol.
NSString* const NSDateFormatString;
NSString* const NSDateTimeOrdering;
Key for locale dictionary: string with 'Y', 'M', 'D', and 'H' designating the default method of writing dates, as in "MDYH" for the U.S..
NSString* const NSDecimalDigits;
Key for locale dictionary: array of strings for 0-9.
NSString* const NSDecimalSeparator;
Key for locale dictionary: decimal separator.
NSString* const NSEarlierTimeDesignations;
Key for locale dictionary: adjectives that modify values in NSYearMonthWeekDesignations, as in "last", "previous", etc..
NSString* const NSFormalName;
Key for locale dictionary: formal name of language.
NSString* const NSGlobalDomain;
User defaults domain for system defaults.
NSString* const NSHourNameDesignations;
Array of arrays of NSStrings, first member of each specifying a time, followed by one or more colloquial names for the time, as in "(0, midnight), (12, noon, lunch)".
NSString* const NSInternationalCurrencyString;
Key for locale dictionary: three-letter ISO 4217 currency abbreviation.
NSString* const NSLanguageCode;
Key for locale dictionary: two-letter ISO code.
NSString* const NSLanguageName;
Key for locale dictionary: name of language.
NSString* const NSLaterTimeDesignations;
Key for locale dictionary: adjectives that modify values in NSYearMonthWeekDesignations, as in "next", "subsequent", etc..
NSString* const NSLocale;
Key for locale dictionary: name of locale.
NSString* const NSMonthNameArray;
Key for locale dictionary: names of months of year.
NSString* const NSNextDayDesignations;
Key for locale dictionary: one or more strings designating the next day, such as "tomorrow".
NSString* const NSNextNextDayDesignations;
Key for locale dictionary: one or more strings designating the next day, such as "day after tomorrow".
NSString* const NSPriorDayDesignations;
Key for locale dictionary: one or more strings designating the previous day, such as "yesterday".
NSString* const NSRegistrationDomain;
User defaults domain for application-registered "default defaults".
NSString* const NSShortDateFormatString;
NSString* const NSShortMonthNameArray;
Key for locale dictionary: abbreviations of months of year.
NSString* const NSShortTimeDateFormatString;
NSString* const NSShortWeekDayNameArray;
Key for locale dictionary: abbreviations of days of week.
NSString* const NSThisDayDesignations;
Key for locale dictionary: one or more strings designating the current day, such as "today".
NSString* const NSThousandsSeparator;
Key for locale dictionary: thousands separator.
NSString* const NSTimeDateFormatString;
NSString* const NSTimeFormatString;
NSString* const NSUserDefaultsDidChangeNotification;
Notification posted when a defaults synchronize has been performed (see
[NSUserDefaults -synchronize]
) and changes have been loaded in from disk.
NSString* const NSWeekDayNameArray;
Key for locale dictionary: names of days of week.
NSString* const NSYearMonthWeekDesignations;
Strings for "year", "month", "week".
NSString* const NSXMLParserErrorDomain;
Domain for errors
typedef struct autorelease_array_list array_list_struct;
Each pool holds its objects-to-be-released in a linked-list of these structures.
{ struct autorelease_array_list *next; unsigned size; unsigned count; id objects[0];}
typedef struct autorelease_thread_vars thread_vars_struct;
Each thread has its own copy of these variables.
{ NSAutoreleasePool *current_pool; // current pool for thread unsigned total_objects_count; // total #/autoreleased objects over thread's lifetime id *pool_cache; // cache of previously-allocated pools, int pool_cache_size; // used internally for recycling int pool_cache_count;}
typedef double NSTimeInterval;
Time interval difference between two dates, in seconds.
typedef enum ... NSCalculationError;
Enumerated type for specifying a decimal calculation error. Can be one of the following:
NSCalculationNoError
-
No error occurred.
-
NSCalculationLossOfPrecision
-
The number can't be represented in 38 significant digits.
NSCalculationOverflow
-
The number is too large to represent.
NSCalculationUnderflow
-
The number is too small to represent.
NSCalculationDivideByZero
-
The caller tried to divide by 0.
typedef struct ... NSDecimal;
Structure providing equivalent functionality, in conjunction with a set of functions, to the NSDecimalNumber
class.
typedef struct { signed char exponent; // Signed exponent - -128 to 127 BOOL isNegative; // Is this negative? BOOL validNumber; // Is this a valid number? unsigned char length; // digits in mantissa. unsigned char cMantissa[2*NSDecimalMaxDigit];} NSDecimal;
Instances can be initialized using the NSDecimalFromString(NSString *) function.
typedef enum ... NSRoundingMode;
Enumerated type for specifying decimal rounding behavior. Can be one of
NSRoundDown
(always round down),
NSRoundUp
(always round up),
NSRoundPlain
("normal" rounding (up from.5 or above, down otherwise),
NSRoundBankers
(as "Plain" but.5 rounds to make last remaining digit even). See the
<NSDecimalNumberBehaviors>
protocol.
typedef enum ... NSNotificationSuspensionBehavior;
Enumeration of possible values for specifying how
NSDistributedNotificationCenter
deals with notifications when the process to which the notification should be delivered is suspended:
{ NSNotificationSuspensionBehaviorDrop, // drop the notification NSNotificationSuspensionBehaviorCoalesce, // drop all for this process but the latest-sent notification NSNotificationSuspensionBehaviorHold, // queue all notifications for this process until it is resumed NSNotificationSuspensionBehaviorDeliverImmediately // resume the process and deliver}
typedef struct _NSHandler NSHandler;
The actual structure for an NSHandler. You shouldn't need to worry about it.
typedef struct _NSPoint NSPoint;
{ float x; float y;}
Represents a 2-d cartesian position.
typedef NSPoint* NSPointArray;
Array of NSPoint structs.
typedef NSPoint* NSPointPointer;
Pointer to NSPoint struct.
typedef struct _NSRect NSRect;
{ NSPoint origin; NSSize size;}
Rectangle.
typedef NSRect* NSRectArray;
Array of NSRect structs.
typedef enum _NSRectEdge NSRectEdge;
Sides of a rectangle.
{ NSMinXEdge, NSMinYEdge, NSMaxXEdge, NSMaxYEdge}
typedef NSRect* NSRectPointer;
Pointer to NSRect struct.
typedef struct _NSSize NSSize;
{ float width; float height;}
Floating point rectangle size.
typedef NSSize* NSSizeArray;
Array of NSSize structs.
typedef NSSize* NSSizePointer;
Pointer to NSSize struct.
typedef struct ... NSHashEnumerator;
Type for enumerating.
NB. Implementation detail ... in GNUstep the layout must correspond to that used by the GSIMap macros.
typedef void* NSHashTable;
Hash table type... an opaque pointer to a data structure.
typedef struct _NSHashTableCallBacks NSHashTableCallBacks;
Callback functions for an NSHashTable. See
NSCreateHashTable()
.
unsigned int (*hash)(NSHashTable *, const void *)
... Hashing function. NOTE: Elements with equal values must have equal hash function values. The default if NULL uses the pointer addresses directly.
BOOL (*isEqual)(NSHashTable *, const void *, const void *)
... Comparison function. The default if NULL uses '
==
'.
void (*retain)(NSHashTable *, const void *)
... Retaining function called when adding elements to the table. The default if NULL is a no-op (no reference counting).
void (*release)(NSHashTable *, void *)
... Releasing function called when a data element is removed from the table. The default if NULL is a no-op (no reference counting).
NSString *(*describe)(NSHashTable *, const void *)
... Description function. The default if NULL prints boilerplate.
typedef enum ... NSKeyValueChange;
Description forthcoming.
typedef enum ... NSKeyValueObservingOptions;
Description forthcoming.
typedef enum ... NSKeyValueSetMutationKind;
Description forthcoming.
typedef struct ... NSMapEnumerator;
Type for enumerating.
NB. Implementation detail ... in GNUstep the layout must correspond to that used by the GSIMap macros.
typedef void* NSMapTable;
Map table type... an opaque pointer to a data structure.
typedef struct _NSMapTableKeyCallBacks NSMapTableKeyCallBacks;
Callback functions for a key.
Comparison function. Must not modify either key.
Retaining function called when adding elements to table.
Notionally this must not modify the key (the key may not actually have a retain count, or the retain count may be stored externally to the key, but in practice this often actually changes a counter within the key).
Releasing function called when a data element is removed from the table. This may decrease a retain count or may actually destroy the key.
Description function. Generates a string describing the key and does not modify the key itself.
Quantity that is not a key to the map table.
typedef struct _NSMapTableValueCallBacks NSMapTableValueCallBacks;
Callback functions for a value.
typedef struct ... NSArgumentInfo;
Info about layout of arguments. Extended from the original OpenStep version to let us know if the arg is passed in registers or on the stack.
NB. This no longer exists in Rhapsody/MacOS.
typedef struct { int offset; unsigned size; const char *type; unsigned align; // extension, available only ifndef NO_GNUSTEP unsigned qual; // extension, available only ifndef NO_GNUSTEP BOOL isReg; // extension, available only ifndef NO_GNUSTEP} NSArgumentInfo;
NB. The offset and register information may not always be reliable. In the past it was dependent on locally maintained platform dependent information. In the future it may depend on layout information supplied by the compiler.
typedef enum ... NSNotificationCoalescing;
Enumeration of possible ways to combine notifications when dealing with
NSNotificationQueue
:
{ NSNotificationNoCoalescing, // don't combine NSNotificationCoalescingOnName, // combine all registered with same name NSNotificationCoalescingOnSender // combine all registered with same object}
typedef enum ... NSPostingStyle;
Enumeration of possible timings for distribution of notifications handed to an
NSNotificationQueue
:
{ NSPostWhenIdle, // post when runloop is idle NSPostASAP, // post soon NSPostNow // post synchronously}
typedef enum _NSComparisonResult NSComparisonResult;
Contains values NSOrderedSame
, NSOrderedAscending
NSOrderedDescending
, for left hand side equals, less than, or greater than right hand side.
typedef enum ... NSSearchPathDirectory;
Enumeration of possible requested directory type specifiers for
NSSearchPathForDirectoriesInDomains()
function. These correspond to the subdirectories that may be found under, e.g., $GNUSTEP_SYSTEM_ROOT, such as "Library" and "Applications".
{ NSApplicationDirectory, NSDemoApplicationDirectory, NSDeveloperApplicationDirectory, NSAdminApplicationDirectory, NSLibraryDirectory, NSDeveloperDirectory, NSUserDirectory, NSDocumentationDirectory, NSAllApplicationsDirectory, NSAllLibrariesDirectory, GSLibrariesDirectory, GSToolsDirectory, GSApplicationSupportDirectory}
typedef enum ... NSSearchPathDomainMask;
Mask type for
NSSearchPathForDirectoriesInDomains()
function. A bitwise OR of one or more of
NSUserDomainMask, NSLocalDomainMask, NSNetworkDomainMask, NSSystemDomainMask, NSAllDomainsMask
.
typedef SOCKET NSSocketNativeHandle;
Native socket type.
typedef enum ... NSPropertyListFormat;
Specifies the serialisation format for a serialised property list.
NSPropertyListGNUstepFormat extension of OpenStep format
NSPropertyListGNUstepBinaryFormat efficient, hardware independent
NSPropertyListOpenStepFormat the most human-readable format
NSPropertyListXMLFormat_v1_0 portable and readable
typedef enum ... NSPropertyListMutabilityOptions;
Describes the mutability to use when generating objects during deserialisation of a property list.
NSPropertyListImmutable all objects in created list are immutable
NSPropertyListMutableContainers dictionaries and arrays are mutable
NSPropertyListMutableContainersAndLeaves dictionaries, arrays, strings and data objects are mutable
typedef struct _NSRange NSRange;
{ unsigned int location; unsigned int length;}
The NSRange type is used to specify ranges of locations, typically items in an array, characters in a string, and bytes in a data object.
As 'boundary' or 'fencepost' errors are a particularly common problem in programming, it is important that you understand how an NSRange works.
An NSRange consists of a location and a length. The points that are considered to lie in a range are the integers from the location to the location plus the length, so the number of points in a range is the length of the range plus one.
However, if you consider these points like the marks on a ruler, you can only store information between points. So the number of items that can be stored in a range is the length of the range.
typedef NSRange* NSRangePointer;
Pointer to an NSRange structure.
typedef enum ... RunLoopEventType;
Enumeration of event types that an
NSRunLoop
watcher can watch for. See
[NSRunLoop -addEvent:type:watcher:forMode:]
. This is a GNUstep extension.
{ ET_RDESC, // Watch for descriptor becoming readable. ET_WDESC, // Watch for descriptor becoming writeable. ET_RPORT, // Watch for message arriving on port. ET_EDESC // Watch for descriptor with out-of-band data.}
typedef enum _NSStringEncoding NSStringEncoding;
Enumeration of available encodings for converting between bytes and characters (in NSString
s). The ones that are shared with OpenStep and Cocoa are: NSASCIIStringEncoding, NSNEXTSTEPStringEncoding, NSJapaneseEUCStringEncoding, NSUTF8StringEncoding, NSISOLatin1StringEncoding, NSSymbolStringEncoding, NSNonLossyASCIIStringEncoding, NSShiftJISStringEncoding, NSISOLatin2StringEncoding, NSUnicodeStringEncoding, NSWindowsCP1251StringEncoding, NSWindowsCP1252StringEncoding, NSWindowsCP1253StringEncoding, NSWindowsCP1254StringEncoding, NSWindowsCP1250StringEncoding, NSISO2022JPStringEncoding, NSMacOSRomanStringEncoding, NSProprietaryStringEncoding
.
Additional encodings available under GNUstep are: NSKOI8RStringEncoding, NSISOLatin3StringEncoding, NSISOLatin4StringEncoding, NSISOCyrillicStringEncoding, NSISOArabicStringEncoding, NSISOGreekStringEncoding, NSISOHebrewStringEncoding, NSISOLatin5StringEncoding, NSISOLatin6StringEncoding, NSISOThaiStringEncoding, NSISOLatin7StringEncoding, NSISOLatin8StringEncoding, NSISOLatin9StringEncoding, NSGB2312StringEncoding, NSUTF7StringEncoding, NSGSM0338StringEncoding, NSBIG5StringEncoding, NSKoreanEUCStringEncoding
.
typedef unsigned short int unichar;
Type for representing unicode characters. (16-bit)
typedef enum ... NSURLHandleStatus;
Enumerated type returned by
[NSURLHandle -status]
:
{ NSURLHandleNotLoaded NSURLHandleLoadSucceeded, NSURLHandleLoadInProgress, NSURLHandleLoadFailed}
typedef struct ... GSNumberInfo;
Cache info for internal use by NSNumber concrete subclasses.
typedef enum ... NSXMLParserError;
Description forthcoming.
typedef struct _NSZone NSZone;
Primary structure representing an
NSZone
. Technically it consists of a set of function pointers for zone upkeep functions plus some other things-
{ // Functions for zone. void *(*malloc)(struct _NSZone *zone, size_t size); void *(*realloc)(struct _NSZone *zone, void *ptr, size_t size); void (*free)(struct _NSZone *zone, void *ptr); void (*recycle)(struct _NSZone *zone); BOOL (*check)(struct _NSZone *zone); BOOL (*lookup)(struct _NSZone *zone, void *ptr); // Zone statistics (not always maintained). struct NSZoneStats (*stats)(struct _NSZone *zone); size_t gran; // Zone granularity (passed in on initialization) NSString *name; // Name of zone (default is 'nil') NSZone *next; // Pointer used for internal management of multiple zones.}
BOOL NSDeallocateZombies;
Enable/disable object deallocation.
If zombies are enabled, objects are by default not deallocated, and memory leaks. The NSDeallocateZombies variable lets you say that the the memory used by zombies should be freed.
Doing this makes the behavior of zombies similar to that when zombies are not enabled... the memory occupied by the zombie may be re-used for other purposes, at which time the isa pointer may be overwritten and the zombie behavior will cease.
The default value of this boolean is NO
, but this can be controlled by the NSDeallocateZombies environment variable.
BOOL NSZombieEnabled;
Enable/disable zombies.
When an object is deallocated, its isa pointer is normally modified to the hexadecimal value 0xdeadface, so that any attempt to send a message to the deallocated object will cause a crash, and examination of the object within the debugger will show the 0xdeadface value... making it obvious why the program crashed.
Turning on zombies changes this behavior so that the isa pointer is modified to be that of the NSZombie class. When messages are sent to the object, instead of crashing, NSZombie will use NSLog()
to produce an error message. By default the memory used by the object will not really be freed, so error messages will continue to be generated whenever a message is sent to the object, and the object instance variables will remain available for examination by the debugger.
The default value of this boolean is NO
, but this can be controlled by the NSZombieEnabled environment variable.
NSUncaughtExceptionHandler* _NSUncaughtExceptionHandler;
enum _NSRectEdge enum _NSRectEdge;
Description forthcoming.
struct _NSPoint struct _NSPoint;
Description forthcoming.
struct _NSRect struct _NSRect;
Description forthcoming.
struct _NSSize struct _NSSize;
Description forthcoming.
struct _NSMapTableValueCallBacks struct _NSMapTableValueCallBacks;
Retaining function called when adding elements to table.
Notionally this must not modify the element (the element may not actually have a retain count, or the retain count may be stored externally to the element, but in practice this often actually changes a counter within the element).
Releasing function called when a data element is removed from the table. This may decrease a retain count or may actually destroy the element.
Description function. Generates a string describing the element and does not modify the element itself.
struct _NSNotificationQueueList struct _NSNotificationQueueList;
int _NSLogDescriptor;
A variable holding the file descriptor to which
NSLogv()
messages are written by default. GNUstep initialises this to stderr.
You may change this, but for thread safety should use the lock provided by
GSLogLock()
to protect the change.
NSLog_printf_handler* _NSLog_printf_handler;
A pointer to a function used to actually write the log data.
GNUstep initialises this to a function implementing the standard behavior for logging, but you may change this in your program in order to implement any custom behavior you wish. You should use the lock returned by GSLogLock()
to protect any change you make.
Calls from NSLogv()
to the function pointed to by this variable are protected by a lock, and should therefore be thread safe.
This function should accept a single NSString argument and return void.
The default implementation in GNUstep performs as follows -
-
Converts the string to be logged to data in the default CString encoding or, if that is not possible, to UTF8 data.
-
If the system supports writing to syslog and the user default to say that logging should be done to syslog (GSLogSyslog) is set, writes the data to the syslog.
On an mswindows system, where syslog is not available, the GSLogSyslog user default controls whether or not data is written to the system event log,
-
Otherwise, writes the data to the file descriptor stored in the variable _NSLogDescriptor
, which is set by default to stderr.
Your program may change this descriptor... but you should protect changes using the lock provided by GSLogLock()
.
NB. If the write to the descriptor fails, and the system supports writing to syslog, then the log is written to syslog as if the appropriate user default had been set.
NSRecursiveLock* gnustep_global_lock;
Global lock to be used by classes when operating on any global data that invoke other methods which also access global; thus, creating the potential for deadlock.
struct _NSRange struct _NSRange;
Description forthcoming.
struct objc_class _NSConstantStringClassReference;
For internal use with NeXT runtime; needed, until Apple Radar 2870817 is fixed.
NSZone* __nszone_private_hidden_atomic_zone;
Description forthcoming.
NSZone* __nszone_private_hidden_default_zone;
Description forthcoming.
struct NSZoneStats struct NSZoneStats;
NSZoneStats
is the structure returned by the
NSZoneStats()
function that summarizes the current usage of a zone. It is similar to the structure
mstats in the GNU C library. It has 5 fields of type
size_t
-
bytes_total
-
This is the total size of memory managed by the zone, in bytes.
chunks_used
-
This is the number of memory chunks in use in the zone.
bytes_used
-
This is the number of bytes in use.
chunks_free
-
This is the number of memory chunks that are not in use.
bytes_free
-
This is the number of bytes managed by the zone that are not in use.
struct _NSZone struct _NSZone;
Primary structure representing an
NSZone
. Technically it consists of a set of function pointers for zone upkeep functions plus some other things-
{ // Functions for zone. void *(*malloc)(struct _NSZone *zone, size_t size); void *(*realloc)(struct _NSZone *zone, void *ptr, size_t size); void (*free)(struct _NSZone *zone, void *ptr); void (*recycle)(struct _NSZone *zone); BOOL (*check)(struct _NSZone *zone); BOOL (*lookup)(struct _NSZone *zone, void *ptr); // Zone statistics (not always maintained). struct NSZoneStats (*stats)(struct _NSZone *zone); size_t gran; // Zone granularity (passed in on initialization) NSString *name; // Name of zone (default is 'nil') NSZone *next; // Pointer used for internal management of multiple zones.}
Up