Up

Functions

Authors

Richard Frith-Macdonald

Copyright: (C) 2005 Free Software Foundation, Inc.


Contents -

  1. Function index
  2. Macro index
  3. GNUstep macros
  4. GSBlocks macros
  5. GSVersionMacros macros
  6. GSObjCRuntime macros
  7. NSDebug+GNUstepBase macros
  8. NSLock+GNUstepBase macros
  9. GSBlocks functions
  10. GSVersionMacros functions
  11. GSObjCRuntime functions
  12. GSIArray functions
  13. GSIMap functions
  14. GSFunctions functions
  15. GSLocale functions
  16. NSDebug+GNUstepBase functions
  17. NSThread+GNUstepBase functions
  18. Unicode functions

Function index

Function

Macro index

Macro

GNUstep macros

ASSIGN

ASSIGN(object, value)
Availability: OpenStep

ASSIGN(object,value) assigns the value to the object with appropriate retain and release operations.
Use this to avoid retain/release errors.

ASSIGNCOPY

ASSIGNCOPY(object, value)
Availability: OpenStep

ASSIGNCOPY(object,value) assigns a copy of the value to the object with release of the original.
Use this to avoid retain/release errors.

AUTORELEASE

AUTORELEASE(object)
Availability: OpenStep

Basic autorelease operation... calls [NSObject -autorelease]
Deprecated... pointless on modern processors. Simply call the -autorelease method.

CHECK_INDEX_RANGE_ERROR

CHECK_INDEX_RANGE_ERROR(INDEX, OVER)
Availability: OpenStep

Checks whether INDEX is strictly less than OVER (within C array space). INDEX and OVER must be unsigned integers (NSUInteger).

CREATE_AUTORELEASE_POOL

CREATE_AUTORELEASE_POOL(X)
Availability: OpenStep

DEPRECATED... use NSAutoreleasePool *X = [NSAutoreleasePool new]

DESTROY

DESTROY(object)
Availability: OpenStep

DESTROY() is a release operation which also sets the variable to be a nil pointer for tidiness - we can't accidentally use a DESTROYED object later. It also makes sure to set the variable to nil before releasing the object - to avoid side-effects of the release trying to reference the object being released through the variable.

GSLocalizedStaticString

GSLocalizedStaticString(key, comment)
Availability: OpenStep

This function (macro) is a GNUstep extensions, and it is used to localize static strings. Here is an example of a static string:

NSString *message = @"Hi there";... some code... NSLog (message);

This string can not be localized using the standard openstep functions/macros. By using this gnustep extension, you can localize it as follows:

NSString *message = GSLocalizedStaticString (@"Hi there", @"Greeting");... some code... NSLog (NSLocalizedString (message, @""));

When the tools generate the Localizable.strings file from the source code, they will ignore the NSLocalizedString call while they will extract the string (and the comment) to localize from the GSLocalizedStaticString call.

When the code is compiled, instead, the GSLocalizedStaticString call is ignored (discarded, it is a macro which simply expands to key), while the NSLocalizedString will actually look up the string for translation in the Localizable.strings file.

Please note that there is currently no macro/function to localize static strings using different tables. If you need that functionality, you have either to prepare the localization tables by hand, or to rewrite your code in such a way as not to use static strings.


GS_RANGE_CHECK

GS_RANGE_CHECK(RANGE, SIZE)
Availability: OpenStep

To be used inside a method for making sure that a range does not specify anything outside the size of an array/string. Raises exception if range extends beyond [0,size]. Size must be an unsigned integer (NSUInteger).

RECREATE_AUTORELEASE_POOL

RECREATE_AUTORELEASE_POOL(X)
Availability: OpenStep

DEPRECATED... use [X release]; X = [NSAutoreleasePool new]

RELEASE

RELEASE(object)
Availability: OpenStep

Basic release operation... calls [NSObject -release]
Deprecated... pointless on modern processors. Simply call the -release method.

RETAIN

RETAIN(object)
Availability: OpenStep

Basic retain operation... calls [NSObject -retain]
Deprecated... pointless on modern processors. Simply call the -retain method.

TEST_AUTORELEASE

TEST_AUTORELEASE(object)
Availability: OpenStep

Tested autorelease - only invoke the objective-c method if the receiver is not nil.
Deprecated... pointless on modern processors. Simply call the -autorelease method.

TEST_RELEASE

TEST_RELEASE(object)
Availability: OpenStep

Tested release - only invoke the objective-c method if the receiver is not nil.
Deprecated ... pointless on modern processors. Simply call the -release method.

TEST_RETAIN

TEST_RETAIN(object)
Availability: OpenStep

Tested retain - only invoke the objective-c method if the receiver is not nil.
Deprecated ... pointless on modern processors. Simply call the -retain method.

_

_(X)
Availability: OpenStep

This function (macro) is a GNUstep extension.

_(@"My string to translate")

is basically equivalent to

NSLocalizedString(@"My string to translate", @"")

It is useful when you need to translate an application very quickly, as you just need to enclose all strings inside _() . But please note that when you use this macro, you are not taking advantage of comments for the translator, so consider using NSLocalizedString instead when you need a comment.

You may define GS_LOCALISATION_BUNDLE_ID to the bundle identifier of the bundle which is to provide the localisation information.
This can be used when compiling a single file by specifying something like '-D GS_LOCALISATION_BUNDLE_ID=$(FRAMEWORK_NAME)' in your make file.
If this is not defined, the localisation is provided by your application's main bundle exactly like the NSLocalizedString function.

Alternatively you may define GS_LOCALISATION_BUNDLE to be the bundle to be used to prvide the localisation information.


__

__(X)
Availability: OpenStep

This function (macro) is a GNUstep extension.

__(@"My string to translate")

is exactly the same as

GSLocalizedStaticString(@"My string to translate", @"")

It is useful when you need to translate an application very quickly. You would use it as follows for static strings:

NSString *message = __(@"Hello there");... more code... NSLog (_(messages));

But please note that when you use this macro, you are not taking advantage of comments for the translator, so consider using GSLocalizedStaticString instead when you need a comment.


GSBlocks macros

CALL_BLOCK

CALL_BLOCK(block, args,...)
Availability: OpenStep

Calls a block. Works irrespective of whether the compiler supports blocks.

CALL_BLOCK_NO_ARGS

CALL_BLOCK_NO_ARGS(block)
Availability: OpenStep

Calls a block without arguments.

GSVersionMacros macros

GS_API_LATEST

GS_API_LATEST
Availability: OpenStep

A constant to represent a feature which is still present in the latest version. This is the highest possible version number.
eg.
#if OS_API_VERSION (GS_API_MACOSX, GS_API_LATEST)
denotes code present from the initial MacOS-X version onwards.

GS_API_MACOSX

GS_API_MACOSX
Availability: OpenStep

The version number of the first MacOS-X implementation.
eg.
#if OS_API_VERSION (GS_API_MACOSX, GS_API_LATEST)
denotes code present from the initial MacOS-X version onwards.

GS_API_NONE

GS_API_NONE
Availability: OpenStep

A constant which is the lowest possible version number (0) so that when used as the removal version (second argument of the GS_API_VERSION or OS_API_VERSION macro) represents a feature which is not present in any version.
eg.
#if OS_API_VERSION (GS_API_NONE, GS_API_NONE)
denotes code not present in OpenStep/OPENSTEP/MacOS-X

GS_API_OPENSTEP

GS_API_OPENSTEP
Availability: OpenStep

The version number of the first OPENSTEP implementation.
eg.
#if OS_API_VERSION (GS_API_OPENSTEP, GS_API_LATEST)
denotes code present from the initial OPENSTEP version onwards.

GS_API_OSSPEC

GS_API_OSSPEC
Availability: OpenStep

The version number of the initial OpenStep specification.
eg.
#if OS_API_VERSION (GS_API_OSSPEC, GS_API_LATEST)
denotes code present from the OpenStep specification onwards.

GS_API_VERSION

GS_API_VERSION(ADD, REM)
Availability: OpenStep

Macro to check a defined GNUstep version number (GS_GNUSTEP_V) against the supplied arguments. Returns true if no GNUstep version is specified, or if ADD <= version < REM, where ADD is the version number at which a feature guarded by the macro was introduced and REM is the version number at which it was removed.

The version number arguments are six digit integers where the first two digits are the major version number, the second two are the minor version number and the last two are the subminor number (all left padded with a zero where necessary). However, for convenience you can also use any of several predefined constants... GS_API_NONE , GS_API_LATEST , GS_API_OSSPEC , GS_API_OPENSTEP , GS_API_MACOSX

Also see OS_API_VERSION

NB. If you are changing the API (eg adding a new feature) you need to control the visibility io the new header file code using
#if GS_API_VERSION(ADD,GS_API_LATEST)
where ADD is the version number of the next minor release after the most recent one.
As a general principle you should not change the API with changing subminor version numbers... as that tends to confuse people (though Apple has sometimes done it).


OS_API_VERSION

OS_API_VERSION(ADD, REM)
Availability: OpenStep

Macro to check a defined OpenStep/OPENSTEP/MacOS-X version against the supplied arguments. Returns true if no version is specified, or if ADD <= version < REM, where ADD is the version number at which a feature guarded by the macro was introduced and REM is the version number at which it was removed.

The version number arguments are six digit integers where the first two digits are the major version number, the second two are the minor version number and the last two are the subminor number (all left padded with a zero where necessary). However, for convenience you can also use any of several predefined constants... GS_API_NONE , GS_API_LATEST , GS_API_OSSPEC , GS_API_OPENSTEP , GS_API_MACOSX

Also see GS_API_VERSION


GSObjCRuntime macros

GS_MAX_OBJECTS_FROM_STACK

GS_MAX_OBJECTS_FROM_STACK
Availability: OpenStep

The number of objects to try to get from varargs into an array on the stack... if there are more than this, use the heap. NB. This MUST be a multiple of 2

GS_USEIDLIST

GS_USEIDLIST(firstObject, code,...)
Availability: OpenStep

This is a macro designed to minimise the use of memory allocation and deallocation when you need to work with a vararg list of objects.
The objects are unpacked from the vararg list into a 'C' array and then a code fragment you specify is able to make use of them before that 'C' array is destroyed.

The firstObject argument is the name of the formal parameter in your method or function which precedes the ',...' denoting variable args.

The code argument is a piece of objective-c code to be executed to make use of the objects stored in the 'C' array.
When this code is called the unsigned integer '__count' will contain the number of objects unpacked, and the pointer '__objects' will point to the unpacked objects, ie. firstObject followed by the vararg arguments up to (but not including) the first nil.


GS_USEIDPAIRLIST

GS_USEIDPAIRLIST(firstObject, code,...)
Availability: OpenStep

This is a macro designed to minimise the use of memory allocation and deallocation when you need to work with a vararg list of objects.
The objects are unpacked from the vararg list into two 'C' arrays and then a code fragment you specify is able to make use of them before that 'C' array is destroyed.

The firstObject argument is the name of the formal parameter in your method or function which precedes the ',...' denoting variable args.

The code argument is a piece of objective-c code to be executed to make use of the objects stored in the 'C' arrays.
When this code is called the unsigned integer '__count' will contain the number of objects unpacked, the pointer '__objects' will point to the first object in each pair, and the pointer '__pairs' will point to an array containing the second halves of the pairs of objects whose first halves are in '__objects'.
This lets you pack a list of the form 'key, value, key, value,...' into an array of keys and an array of values.


NSDebug+GNUstepBase macros

GSOnceFLog

GSOnceFLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

Macro to log a message only the first time it is encountered.
Not entirely thread safe... but that's not really important, it just means that it's possible for the message to be logged more than once if two threads call it simultaneously when it has not already been called.
Use this from inside a function. Pass an NSString as a format, followed by zero or more arguments for the format string. Example: GSOnceFLog(@"This function is deprecated, use another");

GSOnceMLog

GSOnceMLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

Macro to log a message only the first time it is encountered.
Not entirely thread safe... but that's not really important, it just means that it's possible for the message to be logged more than once if two threads call it simultaneously when it has not already been called.
Use this from inside a method. Pass an NSString as a format followed by zero or more arguments for the format string.
Example: GSOnceMLog(@"This method is deprecated, use another");

NSDebugFLLog

NSDebugFLLog(level, format, args,...)
Availability: Not in OpenStep/MacOS-X

This macro is like NSDebugLLog() but includes the name and location of the function in which the macro is used as part of the log output.

NSDebugFLog

NSDebugFLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

This macro is a shorthand for NSDebugFLLog() using then default debug level... 'dflt'

NSDebugFRLog

NSDebugFRLog(object, msg)
Availability: Not in OpenStep/MacOS-X

This macro saves the name and location of the function in which the macro is used, along with a short string msg as the tag associated with a recorded object.

NSDebugLLog

NSDebugLLog(level, format, args,...)
Availability: Not in OpenStep/MacOS-X

NSDebugLLog() is the basic debug logging macro used to display log messages using NSLog() , if debug logging was enabled at compile time and the appropriate logging level was set at runtime.

Debug logging which can be enabled/disabled by defining GSDIAGNOSE when compiling and also setting values in the mutable set which is set up by NSProcessInfo. GSDIAGNOSE is defined automatically unless diagnose=no is specified in the make arguments.

NSProcess initialises a set of strings that are the names of active debug levels using the '--GNU-Debug=...' command line argument. Each command-line argument of that form is removed from NSProcessInfo 's list of arguments and the variable part (...) is added to the set. This means that as far as the program proper is concerned, it is running with the same arguments as if debugging had not been enabled.

For instance, to debug the NSBundle class, run your program with '--GNU-Debug=NSBundle' You can of course supply multiple '--GNU-Debug=...' arguments to output debug information on more than one thing.

NSUserDefaults also adds debug levels from the array given by the GNU-Debug key... but these values will not take effect until the +standardUserDefaults method is called... so they are useless for debugging NSUserDefaults itself or for debugging any code executed before the defaults system is used.

To embed debug logging in your code you use the NSDebugLLog() or NSDebugLog() macro. NSDebugLog() is just NSDebugLLog() with the debug level set to 'dflt'. So, to activate debug statements that use NSDebugLog() , you supply the '--GNU-Debug=dflt' argument to your program.

You can also change the active debug levels under your programs control - NSProcessInfo has a [-debugSet] method that returns the mutable set that contains the active debug levels - your program can modify this set.

Two debug levels have a special effect - 'dflt' is the level used for debug logs statements where no debug level is specified, and 'NoWarn' is used to *disable* warning messages.

As a convenience, there are four more logging macros you can use - NSDebugFLog() , NSDebugFLLog() , NSDebugMLog() and NSDebugMLLog() . These are the same as the other macros, but are specifically for use in either functions or methods and prepend information about the file, line and either function or class/method in which the message was generated.


NSDebugLog

NSDebugLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

This macro is a shorthand for NSDebugLLog() using then default debug level... 'dflt'

NSDebugMLLog

NSDebugMLLog(level, format, args,...)
Availability: Not in OpenStep/MacOS-X

This macro is like NSDebugLLog() but includes the name and location of the method in which the macro is used as part of the log output.

NSDebugMLog

NSDebugMLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

This macro is a shorthand for NSDebugMLLog() using then default debug level... 'dflt'

NSDebugMRLog

NSDebugMRLog(object, msg)
Availability: Not in OpenStep/MacOS-X

This macro saves the name and location of the method in which the macro is used, along with a short string msg as the tag associated with a recorded object.

NSWarnFLog

NSWarnFLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

This macro is like NSWarnLog() but includes the name and location of the function in which the macro is used as part of the log output.

NSWarnLog

NSWarnLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

NSWarnLog() is the basic debug logging macro used to display warning messages using NSLog() , if warn logging was not disabled at compile time and the disabling logging level was not set at runtime.

Warning messages which can be enabled/disabled by defining GSWARN when compiling.

You can also disable these messages at runtime by supplying a '--GNU-Debug=NoWarn' argument to the program, or by adding 'NoWarn' to the user default array named 'GNU-Debug'.

These logging macros are intended to be used when the software detects something that it not necessarily fatal or illegal, but looks like it might be a programming error. eg. attempting to remove 'nil' from an NSArray, which the Spec/documentation does not prohibit, but which a well written program should not be attempting (since an NSArray object cannot contain a 'nil').

NB. The 'warn=yes' option is understood by the GNUstep make package to mean that GSWARN should be defined, and the 'warn=no' means that GSWARN should be undefined. Default is to define it.

To embed debug logging in your code you use the NSWarnLog() macro.

As a convenience, there are two more logging macros you can use - NSWarnFLog() , and NSWarnMLog() . These are specifically for use in either functions or methods and prepend information about the file, line and either function or class/method in which the message was generated.


NSWarnMLog

NSWarnMLog(format, args,...)
Availability: Not in OpenStep/MacOS-X

This macro is like NSWarnLog() but includes the name and location of the method in which the macro is used as part of the log output.

NSLock+GNUstepBase macros

GS_INITIALIZED_LOCK

GS_INITIALIZED_LOCK(IDENT, CLASSNAME)
Availability: Not in OpenStep/MacOS-X

Returns IDENT which will be initialized to an instance of a CLASSNAME in a thread safe manner. If IDENT has been previously initialized this macro merely returns IDENT. IDENT is considered uninitialized, if it contains nil . CLASSNAME must be either NSLock, NSRecursiveLock or one of their subclasses. See [NSLock +newLockAt:] for details. This macro is intended for code that cannot insure that a lock can be initialized in thread safe manner otherwise.
 NSLock *my_lock = nil;

 void function (void)
 {
   [GS_INITIALIZED_LOCK(my_lock, NSLock) lock];
   do_work ();
   [my_lock unlock];
 }

 

GSBlocks functions

_Block_copy

void* _Block_copy(void* );
Availability: OpenStep

_Block_copy and _Block_release are weakly imported, but can be assumed to be available whenever a feature using blocks is accessed by an application.

_Block_release

void _Block_release(void* );
Availability: OpenStep

Description forthcoming.

GSVersionMacros functions

gs_consumed

void gs_consumed(id o);
Availability: OpenStep

Description forthcoming.

GSObjCRuntime functions

GSAutoreleasedBuffer

void* GSAutoreleasedBuffer(unsigned int size);
Availability: OpenStep

Quickly return autoreleased data storage area.

GSCGetInstanceVariableDefinition

GSIVar GSCGetInstanceVariableDefinition(Class cls, const char* name);
Availability: OpenStep

Deprecated.. use class_getInstanceVariable()

GSClassFromName

Class GSClassFromName(const char* name);
Availability: OpenStep

GSClassFromName() is deprecated... use objc_lookUpClass()

GSClassList

unsigned int GSClassList(Class* buffer, unsigned int max, BOOL clearCache);
Availability: OpenStep

Deprecated... use objc_getClassList()

GSClassNameFromObject

const char* GSClassNameFromObject(id obj);
Availability: OpenStep

GSClassNameFromObject() is deprecated... use object_getClass() in conjunction with class_getName()

GSClassSwizzle

void GSClassSwizzle(id instance, Class newClass);
Availability: OpenStep

Function to change the class of the specified instance to newClass. This handles memory debugging issues in GNUstep-base and also deals with class finalisation issues in a garbage collecting environment, so you should use this function rather than attempting to swizzle class pointers directly.

GSFlushMethodCacheForClass

void GSFlushMethodCacheForClass(Class cls);
Availability: OpenStep

Deprecated.. does nothing.

GSGetMethod

GSMethod GSGetMethod(Class cls, SEL sel, BOOL searchInstanceMethods, BOOL searchSuperClasses);
Availability: OpenStep

Returns the pointer to the method structure for the selector in the specified class. Depending on searchInstanceMethods, this function searches either instance or class methods. Depending on searchSuperClassesm this function searches either the specified class only or also its superclasses.
To obtain the implementation pointer IMP use returnValue->method_imp which should be safe across all runtimes.
It should be safe to use this function in +load implementations.
This function should currently (June 2004) be considered WIP. Please follow potential changes (Name, parameters,...) closely until it stabilizes.

GSLastErrorStr

const char* GSLastErrorStr(long int error_id);
Availability: BaseAdditions
Likely to be changed/moved/removed at 1.15.0

Description forthcoming.

GSNameFromClass

const char* GSNameFromClass(Class cls);
Availability: OpenStep

GSNameFromClass() is deprecated... use class_getName()

GSNameFromSelector

const char* GSNameFromSelector(SEL sel);
Availability: OpenStep

GSNameFromSelector() is deprecated... use sel_getName()

GSObjCAddClassBehavior

void GSObjCAddClassBehavior(Class receiver, Class behavior);
Availability: OpenStep

A Behavior can be seen as a "Protocol with an implementation" or a "Class without any instance variables". A key feature of behaviors is that they give a degree of multiple inheritance.

Behavior methods, when added to a class, override the class's superclass methods, but not the class's methods.

Whan a behavior class is added to a receiver class, not only are the methods defined in the behavior class added, but the methods from the behavior's class hierarchy are also added (unless already present).

It's not the case that a class adding behaviors from another class must have "no instance vars". The receiver class just has to have the same layout as the behavior class (optionally with some additional ivars after those of the behavior class).

This function provides Behaviors without adding any new syntax to the Objective C language. Simply define a class with the methods you want to add, then call this function with that class as the behavior argument.

This function should be called in the +initialize method of the receiver.

If you add several behaviors to a class, be aware that the order of the additions is significant.


GSObjCAddClassOverride

void GSObjCAddClassOverride(Class receiver, Class override);
Availability: OpenStep

An Override can be seen as a "category implemented as a separate class and manually added to the receiver class under program control, rather than automatically added by the compiler/runtime.

Override methods, when added to a receiver class, replace the class's class's methods of the same name (or are added if the class did not define methods with that name).

It's not the case that a class adding overrides from another class must have "no instance vars". The receiver class just has to have the same layout as the override class (optionally with some additional ivars after those of the override class).

This function provides overrides without adding any new syntax to the Objective C language. Simply define a class with the methods you want to add, then call this function with that class as the override argument.

This function should usually be called in the +initialize method of the receiver.

If you add several overrides to a class, be aware that the order of the additions is significant.


GSObjCAddClasses

void GSObjCAddClasses(NSArray* classes);
Availability: OpenStep

The classes argument is an array of NSValue objects containing pointers to classes previously created by the GSObjCMakeClass() function.

GSObjCAddMethods

void GSObjCAddMethods(Class cls, Method* list, BOOL replace);
Availability: OpenStep

Given a NULL terminated list of methods, add them to the class.
If the method already exists in a superclass, the new version overrides that one, but if the method already exists in the class itsself, the new one is quietly ignored (replace==NO) or replaced with the new version (if replace==YES).
To add class methods, cls should be the metaclass of the class to which the methods are being added.

GSObjCAllSubclassesOfClass

NSArray* GSObjCAllSubclassesOfClass(Class cls);
Availability: OpenStep

Returns an autoreleased array of subclasses of Class cls, including subclasses of subclasses.

GSObjCBehaviorDebug

BOOL GSObjCBehaviorDebug(int setget);
Availability: OpenStep

Turn on (YES), off (NO) or test (-1) behavior debugging.

GSObjCClass

Class GSObjCClass(id obj);
Availability: OpenStep

GSObjCClass() is deprecated... use object_getClass()

GSObjCDirectSubclassesOfClass

NSArray* GSObjCDirectSubclassesOfClass(Class cls);
Availability: OpenStep

Returns an autoreleased array containing subclasses directly descendent of Class cls.

GSObjCFindVariable

BOOL GSObjCFindVariable(id obj, const char* name, const char** type, unsigned int* size, int* offset);
Availability: OpenStep

This function is used to locate information about the instance variable of obj called name. It returns YES if the variable was found, NO otherwise. If it returns YES, then the values pointed to by type, size, and offset will be set (except where they are null pointers).

GSObjCGetInstanceVariableDefinition

GSIVar GSObjCGetInstanceVariableDefinition(Class cls, NSString* name);
Availability: OpenStep

Deprecated.. use class_getInstanceVariable()

GSObjCGetVal

id GSObjCGetVal(NSObject* self, const char* key, SEL sel, const char* type, unsigned int size, int offset);
Availability: OpenStep

This is used internally by the key-value coding methods, to get a value from an object either via an accessor method (if sel is supplied), or via direct access (if type, size, and offset are supplied).
Automatic conversion between NSNumber and C scalar types is performed.
If type is null and can't be determined from the selector, the [NSObject -handleQueryWithUnboundKey:] method is called to try to get a value.

GSObjCGetVariable

void GSObjCGetVariable(id obj, int offset, unsigned int size, void* data);
Availability: OpenStep

Gets the value from an instance variable in obj
This function performs no checking... you should use it only where you are providing information from a call to GSObjCFindVariable() and you know that the data area provided is the correct size.

GSObjCIsClass

BOOL GSObjCIsClass(Class cls);
Availability: OpenStep

GSObjCIsClass() is deprecated... use object_getClass() in conjunction with class_isMetaClass()

GSObjCIsInstance

BOOL GSObjCIsInstance(id obj);
Availability: OpenStep

GSObjCIsInstance() is deprecated... use object_getClass() in conjunction with class_isMetaClass()

GSObjCIsKindOf

BOOL GSObjCIsKindOf(Class cls, Class other);
Availability: OpenStep

Test to see if class inherits from another class The argument to this function must NOT be nil.

GSObjCMakeClass

NSValue* GSObjCMakeClass(NSString* name, NSString* superName, NSDictionary* iVars);
Availability: OpenStep

references: http://www.macdevcenter.com/pub/a/mac/2002/05/31/runtime_parttwo.html?page=1 http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC/9objc_runtime_reference/chapter_5_section_1.html http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC/9objc_runtime_reference/chapter_5_section_21.html ObjcRuntimeUtilities.m by Nicola Pero

Create a Class structure for use by the ObjectiveC runtime and return an NSValue object pointing to it. The class will not be added to the runtime (you must do that later using the GSObjCAddClasses() function).

The iVars dictionary lists the instance variable names and their types.


GSObjCMethodNames

NSArray* GSObjCMethodNames(id obj, BOOL recurse);
Availability: OpenStep

This method returns an array listing the names of all the instance methods available to obj, whether they belong to the class of obj or one of its superclasses.
If obj is a class, this returns the class methods.
Returns nil if obj is nil .

GSObjCSetVal

void GSObjCSetVal(NSObject* self, const char* key, id val, SEL sel, const char* type, unsigned int size, int offset);
Availability: OpenStep

This is used internally by the key-value coding methods, to set a value in an object either via an accessor method (if sel is supplied), or via direct access (if type, size, and offset are supplied).
Automatic conversion between NSNumber and C scalar types is performed.
If type is null and can't be determined from the selector, the [NSObject -handleTakeValue:forUnboundKey:] method is called to try to set a value.

GSObjCSetVariable

void GSObjCSetVariable(id obj, int offset, unsigned int size, const void* data);
Availability: OpenStep

Sets the value in an instance variable in obj
This function performs no checking... you should use it only where you are providing information from a call to GSObjCFindVariable() and you know that the data area provided is the correct size.

GSObjCSuper

Class GSObjCSuper(Class cls);
Availability: OpenStep

GSObjCSuper() is deprecated... use class_getSuperclass()

GSObjCVariableNames

NSArray* GSObjCVariableNames(id obj, BOOL recurse);
Availability: OpenStep

This method returns an array listing the names of all the instance variables present in the instance obj, whether they belong to the class of obj or one of its superclasses.
Returns nil if obj is nil.

GSObjCVersion

int GSObjCVersion(Class cls);
Availability: OpenStep

GSObjCVersion() is deprecated... use class_getVersion()

GSPrintf

BOOL GSPrintf(FILE* fptr, NSString* format,...);
Availability: OpenStep

Prints a message to fptr using the format string provided and any additional arguments. The format string is interpreted as by the NSString formatted initialisers, and understands the '%@' syntax for printing an object.

The data is written to the file pointer in the default CString encoding if possible, as a UTF8 string otherwise.

This function is recommended for printing general log messages. For debug messages use NSDebugLog() and friends. For error logging use NSLog() , and for warnings you might consider NSWarnLog() .


GSProtocolFromName

Protocol* GSProtocolFromName(const char* name);
Availability: OpenStep

Returns a protocol object with the corresponding name. This function searches the registered classes for any protocol with the supplied name. If one is found, it is cached in for future requests. If efficiency is a factor then use GSRegisterProtocol() to insert a protocol explicitly into the cache used by this function. If no protocol is found this function returns nil.

GSProtocolGetMethodDescriptionRecursive

struct objc_method_description GSProtocolGetMethodDescriptionRecursive(Protocol* aProtocol, SEL aSel, BOOL isRequired, BOOL isInstance);
Availability: OpenStep

A variant of protocol_getMethodDescription which recursively searches parent protocols if the requested selector isn't found in the given protocol. Returns a {NULL, NULL} structure if the requested selector couldn't be found.

GSRegisterProtocol

void GSRegisterProtocol(Protocol* proto);
Availability: OpenStep

Registers proto in the cache used by GSProtocolFromName() .

GSSelectorFromName

SEL GSSelectorFromName(const char* name);
Availability: OpenStep

GSSelectorFromName() is deprecated... use sel_getUid()

GSSelectorFromNameAndTypes

SEL GSSelectorFromNameAndTypes(const char* name, const char* types);
Availability: OpenStep

Return the selector for the specified name and types.
Returns a nul pointer if the name is nul.
Creates a new selector if necessary.
Code must NOT rely on this providing a selector with type information.

GSSelectorTypesMatch

BOOL GSSelectorTypesMatch(const char* types1, const char* types2);
Availability: OpenStep

Compare only the type information ignoring qualifiers, the frame layout and register markers. Unlike sel_types_match, this function also handles comparisons of types with and without any layout information.

GSSkipTypeQualifierAndLayoutInfo

const char* GSSkipTypeQualifierAndLayoutInfo(const char* types);
Availability: OpenStep

Takes full type information and skips forward to the actual type as specified in the _C_... constants.

GSTypesFromSelector

const char* GSTypesFromSelector(SEL sel);
Availability: OpenStep

Return the type information from the specified selector.
May return a nul pointer if the selector was a nul pointer or if it was not typed (or if the runtime does not support typed selectors).
Code must NOT rely on this providing any type information.

GSIArray functions

GSIArrayAddItem

void GSIArrayAddItem(GSIArray array, GSIArrayItem item);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayAddItemNoRetain

void GSIArrayAddItemNoRetain(GSIArray array, GSIArrayItem item);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayCapacity

unsigned int GSIArrayCapacity(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayCheckSort

void GSIArrayCheckSort(GSIArray array, NSComparisonResult(*) sorter);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayClear

void GSIArrayClear(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayCopyWithZone

GSIArray GSIArrayCopyWithZone(GSIArray array, NSZone* zone);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayCount

unsigned int GSIArrayCount(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayEmpty

void GSIArrayEmpty(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayGrow

void GSIArrayGrow(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayGrowTo

void GSIArrayGrowTo(GSIArray array, unsigned int next);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayInitWithZoneAndCapacity

GSIArray GSIArrayInitWithZoneAndCapacity(GSIArray array, NSZone* zone, size_t capacity);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayInitWithZoneAndStaticCapacity

GSIArray GSIArrayInitWithZoneAndStaticCapacity(GSIArray array, NSZone* zone, size_t capacity, GSIArrayItem* buffer);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayInsertItem

void GSIArrayInsertItem(GSIArray array, GSIArrayItem item, unsigned int index);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayInsertItemNoRetain

void GSIArrayInsertItemNoRetain(GSIArray array, GSIArrayItem item, unsigned int index);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayInsertSorted

void GSIArrayInsertSorted(GSIArray array, GSIArrayItem item, NSComparisonResult(*) sorter);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayInsertSortedNoRetain

void GSIArrayInsertSortedNoRetain(GSIArray array, GSIArrayItem item, NSComparisonResult(*) sorter);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayInsertionPosition

unsigned int GSIArrayInsertionPosition(GSIArray array, GSIArrayItem item, NSComparisonResult(*) sorter);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayItemAtIndex

GSIArrayItem GSIArrayItemAtIndex(GSIArray array, unsigned int index);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayItems

GSIArrayItem* GSIArrayItems(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayLastItem

GSIArrayItem GSIArrayLastItem(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayRemoveAllItems

void GSIArrayRemoveAllItems(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayRemoveItemAtIndex

void GSIArrayRemoveItemAtIndex(GSIArray array, unsigned int index);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayRemoveItemAtIndexNoRelease

void GSIArrayRemoveItemAtIndexNoRelease(GSIArray array, unsigned int index);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayRemoveItemsFromIndex

void GSIArrayRemoveItemsFromIndex(GSIArray array, unsigned int index);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArrayRemoveLastItem

void GSIArrayRemoveLastItem(GSIArray array);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArraySearch

unsigned int GSIArraySearch(GSIArray array, GSIArrayItem item, NSComparisonResult(*) sorter);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIArraySetItemAtIndex

void GSIArraySetItemAtIndex(GSIArray array, GSIArrayItem item, unsigned int index);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMap functions

GSIMapAddKey

GSIMapNode GSIMapAddKey(GSIMapTable map, GSIMapKey key);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapAddKeyNoRetain

GSIMapNode GSIMapAddKeyNoRetain(GSIMapTable map, GSIMapKey key);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapAddNodeToBucket

void GSIMapAddNodeToBucket(GSIMapBucket bucket, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapAddNodeToMap

void GSIMapAddNodeToMap(GSIMapTable map, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapAddPair

GSIMapNode GSIMapAddPair(GSIMapTable map, GSIMapKey key, GSIMapVal value);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapAddPairNoRetain

GSIMapNode GSIMapAddPairNoRetain(GSIMapTable map, GSIMapKey key, GSIMapVal value);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapBucketForKey

GSIMapBucket GSIMapBucketForKey(GSIMapTable map, GSIMapKey key);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapCleanMap

void GSIMapCleanMap(GSIMapTable map);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapCountByEnumeratingWithStateObjectsCount

NSUInteger GSIMapCountByEnumeratingWithStateObjectsCount(GSIMapTable map, NSFastEnumerationState* state, id* stackbuf, NSUInteger len);
Availability: Not in OpenStep/MacOS-X

Used to implement fast enumeration methods in classes that use GSIMap for their data storage.

GSIMapEmptyMap

void GSIMapEmptyMap(GSIMapTable map);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapEndEnumerator

void GSIMapEndEnumerator(GSIMapEnumerator enumerator);
Availability: Not in OpenStep/MacOS-X

Tidies up after map enumeration... effectively destroys the enumerator.

GSIMapEnumeratorBucket

GSIMapBucket GSIMapEnumeratorBucket(GSIMapEnumerator enumerator);
Availability: Not in OpenStep/MacOS-X

Returns the bucket from which the next node in the enumeration will come. Once the next node has been enumerated, you can use the bucket and node to remove the node from the map using the GSIMapRemoveNodeFromMap() function.

GSIMapEnumeratorForMap

GSIMapEnumerator_t GSIMapEnumeratorForMap(GSIMapTable map);
Availability: Not in OpenStep/MacOS-X

Enumerating
Create an return an enumerator for the specified map.
You must call GSIMapEndEnumerator() when you have finished with the enumerator.
WARNING You should not alter a map while an enumeration is in progress. The results of doing so are reasonably unpredictable.
Remember, DON'T MESS WITH A MAP WHILE YOU'RE ENUMERATING IT.

GSIMapEnumeratorNextNode

GSIMapNode GSIMapEnumeratorNextNode(GSIMapEnumerator enumerator);
Availability: Not in OpenStep/MacOS-X

Returns the next node in the map, or a nul pointer if at the end.

GSIMapFirstNode

GSIMapNode GSIMapFirstNode(GSIMapTable map);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapFreeNode

void GSIMapFreeNode(GSIMapTable map, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapInitWithZoneAndCapacity

void GSIMapInitWithZoneAndCapacity(GSIMapTable map, NSZone* zone, uintptr_t capacity);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapLinkNodeIntoBucket

void GSIMapLinkNodeIntoBucket(GSIMapBucket bucket, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapMoreNodes

void GSIMapMoreNodes(GSIMapTable map, unsigned int required);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapNodeForKey

GSIMapNode GSIMapNodeForKey(GSIMapTable map, GSIMapKey key);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapNodeForKeyInBucket

GSIMapNode GSIMapNodeForKeyInBucket(GSIMapTable map, GSIMapBucket bucket, GSIMapKey key);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapNodeForSimpleKey

GSIMapNode GSIMapNodeForSimpleKey(GSIMapTable map, GSIMapKey key);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapPickBucket

GSIMapBucket GSIMapPickBucket(unsigned int hash, GSIMapBucket buckets, uintptr_t bucketCount);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapRemangleBuckets

void GSIMapRemangleBuckets(GSIMapTable map, GSIMapBucket old_buckets, uintptr_t old_bucketCount, GSIMapBucket new_buckets, uintptr_t new_bucketCount);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapRemoveAndFreeNode

GSIMapNode GSIMapRemoveAndFreeNode(GSIMapTable map, uintptr_t bkt, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapRemoveKey

BOOL GSIMapRemoveKey(GSIMapTable map, GSIMapKey key);
Availability: Not in OpenStep/MacOS-X

Removes the item for the specified key from the map. If the key was present, returns YES, otherwise returns NO.

GSIMapRemoveNodeFromBucket

void GSIMapRemoveNodeFromBucket(GSIMapBucket bucket, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapRemoveNodeFromMap

void GSIMapRemoveNodeFromMap(GSIMapTable map, GSIMapBucket bkt, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapRemoveWeak

void GSIMapRemoveWeak(GSIMapTable map);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapResize

void GSIMapResize(GSIMapTable map, uintptr_t new_capacity);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapRightSizeMap

void GSIMapRightSizeMap(GSIMapTable map, uintptr_t capacity);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSIMapUnlinkNodeFromBucket

void GSIMapUnlinkNodeFromBucket(GSIMapBucket bucket, GSIMapNode node);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSFunctions functions

GSFindNamedFile

NSString* GSFindNamedFile(NSArray* paths, NSString* aName, NSString* anExtension);
Availability: BaseAdditions
Likely to be changed/moved/removed at 1.15.0

Try to locate file/directory (aName).( anExtension (aName).(anExtension) in paths. Will return the first found or nil if nothing is found.
Deprecated... may be removed in later release.

GSLocale functions

GSDefaultLanguageLocale

NSString* GSDefaultLanguageLocale();
Availability: OpenStep

Returns the locale string for LC_MESSAGES

GSDomainFromDefaultLocale

NSDictionary* GSDomainFromDefaultLocale();
Availability: OpenStep

Set the current locale to the system default, and backup what it was previously (should have been @"C").
Restore the current locale to what we backed up (again, should be restored to @"C")

GSLanguageFromLocale

NSString* GSLanguageFromLocale(NSString* locale);
Availability: OpenStep

Returns a language name string for a given locale. e.g. GSLanguageFromLocale(@"en_CA") returns @"CanadaEnglish"

GSLanguagesFromLocale

NSArray* GSLanguagesFromLocale(NSString* locale);
Availability: OpenStep

Convenience function which calls GSLocaleVariants to expand the given locale to a list of variants, and then calls GSLanguageFromLocale on each. e.g. GSLanguagesFromLocale(@"en_CA") returns (@"CanadaEnglish", @"English")

GSLocaleVariants

NSArray* GSLocaleVariants(NSString* locale);
Availability: OpenStep

Return an array of variants of a locale, formed by stripping off parts of the identifier, ordered from most similar to least similar. e.g. GSLocaleVariants(@"en_CA") returns (@"en_CA", @"en").

GSSetLocale

NSString* GSSetLocale(int category, NSString* locale);
Availability: OpenStep

Description forthcoming.

GSSetLocaleC

const char* GSSetLocaleC(int category, const char* loc);
Availability: OpenStep

Description forthcoming.

NSDebug+GNUstepBase functions

GSDebugFunctionMsg

NSString* GSDebugFunctionMsg(const char* func, const char* file, int line, NSString* fmt);
Availability: Not in OpenStep/MacOS-X

Used to produce a format string for logging a message with function location details.

GSDebugMethodMsg

NSString* GSDebugMethodMsg(id obj, SEL sel, const char* file, int line, NSString* fmt);
Availability: Not in OpenStep/MacOS-X

Used to produce a format string for logging a message with method location details.

GSDebugSet

BOOL GSDebugSet(NSString* level);
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

NSThread+GNUstepBase functions

GSCurrentThread

NSThread* GSCurrentThread();
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

GSCurrentThreadDictionary

NSMutableDictionary* GSCurrentThreadDictionary();
Availability: Not in OpenStep/MacOS-X

Description forthcoming.

Unicode functions

GSEncodingForRegistry

NSStringEncoding GSEncodingForRegistry(NSString* registry, NSString* encoding);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Returns the NSStringEncoding that matches the specified character set registry and encoding information. For instance, for the iso8859-5 character set, the registry is iso8859 and the encoding is 5, and the returned NSStringEncoding is NSISOCyrillicStringEncoding. If there is no specific encoding, use @"0". Returns GSUndefinedEncoding if there is no match.

GSEncodingFromLocale

NSStringEncoding GSEncodingFromLocale(const char* clocale);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Try to deduce the string encoding from the locale string clocale. This function looks in the Locale.encodings file installed as part of GNUstep Base if the encoding cannot be deduced from the clocale string itself. If clocale isn't set or no match can be found, returns GSUndefinedEncoding.

GSFromUnicode

BOOL GSFromUnicode(unsigned char** dst, unsigned int* size, const unichar* src, unsigned int slen, NSStringEncoding enc, NSZone* zone, unsigned int options);
Availability: Not in OpenStep/MacOS-X

Function to convert from 16-bit unicode to 8-bit data.

The dst argument is a pointer to a pointer to a buffer in which the converted data is to be stored. If it is a null pointer, this function discards converted data, and is used only to determine the length of the converted data. If the zone argument is non-nul, the function is free to allocate a larger buffer if necessary, and store this new buffer in the dst argument. It will *NOT* deallocate the original buffer!

The size argument is a pointer to the initial size of the destination buffer. If the function changes the buffer size, this value will be altered to the new size. This is measured in bytes.

The src argument is a pointer to the 16-bit unicode string which is to be converted to 8-bit data.

The slen argument is the length of the 16-bit unicode string which is to be converted to 8-bit data. This is measured in 16-bit characters, not bytes.

The enc argument specifies the encoding type of the 8-bit byte sequence which is to be produced from the 16-bit unicode.

The zone argument specifies a memory zone in which the function may allocate a buffer to return data in. If this is nul, the function will fail if the originally supplied buffer is not big enough (unless dst is a null pointer... indicating that converted data is to be discarded).
If the library is built for garbage collecting, the zone argument is used only as a marker to say whether the function may allocate memory (zone is non-null) or not (zone is null).

The options argument controls some special behavior.

On return, the function result is a flag indicating success (YES) or failure ( NO), and on success, the value stored in size is the number of bytes in the converted data. The converted data itself is stored in the location given by dst.
NB. If the value stored in dst has been changed, it is a pointer to allocated memory which the caller is responsible for freeing, and the caller is still responsible for freeing the original buffer.


GSToUnicode

BOOL GSToUnicode(unichar** dst, unsigned int* size, const unsigned char* src, unsigned int slen, NSStringEncoding enc, NSZone* zone, unsigned int options);
Availability: Not in OpenStep/MacOS-X

Function to convert from 8-bit data to 16-bit unicode characters.

The dst argument is a pointer to a pointer to a buffer in which the converted string is to be stored. If it is a null pointer, this function discards converted data, and is used only to determine the length of the converted string. If the zone argument is non-nul, the function is free to allocate a larger buffer if necessary, and store this new buffer in the dst argument. It will *NOT* deallocate the original buffer!

The size argument is a pointer to the initial size of the destination buffer. If the function changes the buffer size, this value will be altered to the new size. This is measured in 16-bit unicode characters, not bytes.

The src argument is a pointer to the byte sequence which is to be converted to 16-bit unicode.

The slen argument is the length of the byte sequence which is to be converted to 16-bit unicode. This is measured in bytes.

The enc argument specifies the encoding type of the 8-bit byte sequence which is to be converted to 16-bit unicode.

The zone argument specifies a memory zone in which the function may allocate a buffer to return data in. If this is nul, the function will fail if the originally supplied buffer is not big enough (unless dst is a null pointer... indicating that converted data is to be discarded).
If the library is built for garbage collecting, the zone argument is used only as a marker to say whether the function may allocate memory (zone is non-null) or not (zone is null).

The options argument controls some special behavior.

On return, the function result is a flag indicating success (YES) or failure ( NO), and on success, the value stored in size is the number of characters in the converted string. The converted string itself is stored in the location given by dst.
NB. If the value stored in dst has been changed, it is a pointer to allocated memory which the caller is responsible for freeing, and the caller is still responsible for freeing the original buffer.


GSUnicode

unsigned int GSUnicode(const unichar* chars, unsigned int length, BOOL* isASCII, BOOL* isLatin1);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Function to check a block of data for validity as a unicode string and say whether it contains solely ASCII or solely Latin1 data.
Any leading BOM must already have been removed and the data must already be in native byte order.
Returns the number of characters which were found valid.

uni_cop

unsigned char uni_cop(unichar u);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Description forthcoming.

uni_is_decomp

unichar* uni_is_decomp(unichar u);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Description forthcoming.

uni_isnonsp

BOOL uni_isnonsp(unichar u);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Description forthcoming.

uni_tolower

unichar uni_tolower(unichar ch);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Uses direct access into a two-level table to map cases.
The two-level table method is less space efficient (but still not bad) than a single table and a linear search, but it reduces the number of conditional statements to just one.

uni_toupper

unichar uni_toupper(unichar ch);
Availability: Not in OpenStep/MacOS-X, BaseAdditions Likely to be changed/moved/removed at 1.15.0

Uses direct access into a two-level table to map cases.
The two-level table method is less space efficient (but still not bad) than a single table and a linear search, but it reduces the number of conditional statements to just one.


Up