OFLocale Class Reference

A class for querying the locale and retrieving localized strings. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFLocale:

Instance Methods
(instancetype)	- init
	Initializes an already allocated object.
(void)	- addLocalizationDirectoryIRI:
	Adds a directory to scan for localizations.
(OFString *)	- localizedStringForID:fallback:
	Returns the localized string for the specified ID, using the fallback string if it cannot be looked up or is missing.
(OFString *)	- localizedStringForID:fallback:arguments:
	Returns the localized string for the specified ID, using the fallback string if it cannot be looked up or is missing.
Instance Methods inherited from OFObject
(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.
(void)	- dealloc
	Deallocates the object.
(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.
(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.
(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.
(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.
(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.
(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.
(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.
(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded.
(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.
Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.
(unsigned int)	- retainCount
	Returns the retain count.
(bool)	- isProxy
	Returns whether the object is a proxy object.
(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.
(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.
(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.
(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(nullable id)	- performSelector:
	Performs the specified selector.
(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(bool)	- isEqual:
	Checks two objects for equality.
(instancetype)	- retain
	Increases the retain count.
(void)	- release
	Decreases the retain count.
(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.
(instancetype)	- self
	Returns the receiver.
(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.
(bool)	- retainWeakReference
	Retain a weak reference to this object.

Class Methods
(nullable OFLocale *)	+ currentLocale
	Returns the current OFLocale.
(nullable OFString *)	+ languageCode
	Returns the language code of the locale.
(nullable OFString *)	+ countryCode
	Returns the country code of the locale.
(OFStringEncoding)	+ encoding
	Returns the native 8-bit string encoding for the locale.
(nullable OFString *)	+ decimalSeparator
	Returns the decimal point of the system's locale.
(void)	+ addLocalizationDirectoryIRI:
	Adds a directory to scan for localizations.
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.
(void)	+ unload
	A method which is called when the class is unloaded from the runtime.
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.
(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.
(Class)	+ class
	Returns the class.
(OFString *)	+ className
	Returns the name of the class as a string.
(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.
(nullable Class)	+ superclass
	Returns the superclass of the class.
(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.
(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.
(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.
(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.
(OFString *)	+ description
	Returns a description for the class, which is usually the class name.
(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.
(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.
(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.
(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.
(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.
(id)	+ copy
	Returns the class.

Properties
OFString *	languageCode
	The language code of the locale for messages.
OFString *	countryCode
	The country code of the locale for messages.
OFStringEncoding	encoding
	The native 8-bit string encoding of the locale for messages.
OFString *	decimalSeparator
	The decimal separator of the locale.
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.

Detailed Description

A class for querying the locale and retrieving localized strings.

Method Documentation

addLocalizationDirectoryIRI: [1/2]

+ (void) addLocalizationDirectoryIRI:

(OFIRI *)

IRI

Adds a directory to scan for localizations.

Parameters

IRI	The IRI to the directory to scan for localizations

addLocalizationDirectoryIRI: [2/2]

- (void) addLocalizationDirectoryIRI:

(OFIRI *)

IRI

Adds a directory to scan for localizations.

Parameters

IRI	The IRI to the directory to scan for localizations

countryCode

+ (nullable OFString *) countryCode

Returns the country code of the locale.

If the country is unknown, nil is returned.

Returns

The country code of the locale.

currentLocale

+ (OFLocale *) currentLocale

Returns the current OFLocale.

Note

If you don't use OFApplication, you need to call this as early as possible to initialize the locale!

Returns

The current OFLocale instance

decimalSeparator

+ (nullable OFString *) decimalSeparator

Returns the decimal point of the system's locale.

Returns

The decimal point of the system's locale

encoding

+ (OFStringEncoding) encoding

Returns the native 8-bit string encoding for the locale.

This is useful to encode strings correctly for passing them to operating system calls.

If the native 8-bit encoding is unknown, UTF-8 is assumed.

Returns

The native 8-bit string encoding for the locale

init

- (instancetype) init

Initializes an already allocated object.

Derived classes may override this, but need to use the following pattern:

self = [super init];
 
@try {
        // Custom initialization code goes here.
} @catch (id e) {
        [self release];
        @throw e;
}
 
return self;

With ARC enabled, the following pattern needs to be used instead:

self = [super init];
 
// Custom initialization code goes here.
 
return self;

init may never return nil, instead an exception (for example OFInitializationFailedException) should be thrown.

Returns

An initialized object

Reimplemented from OFObject.

languageCode

+ (nullable OFString *) languageCode

Returns the language code of the locale.

If the language is unknown, nil is returned.

Returns

The language code of the locale.

localizedStringForID:fallback:

- (OFString *) localizedStringForID:		(OFConstantString *)	ID
fallback:		(id)	fallback
,		(...)

Returns the localized string for the specified ID, using the fallback string if it cannot be looked up or is missing.

Note

This takes a variadic argument, terminated by nil, that consists of pairs of variable names and variable values, which will be replaced inside the localized string. For example, you can pass @"name", @"foo", nil, causing %[name] to be replaced with foo in the localized string.

Generally, you want to use OF_LOCALIZED instead, which also takes care of the nil sentinel automatically.

Parameters

ID	The ID for the localized string
fallback	The fallback to use in case the localized string cannot be looked up or is missing. This can also be an array and use plural scripting, just like with the JSON localization files.

Returns

The localized string

localizedStringForID:fallback:arguments:

- (OFString *) localizedStringForID:		(OFConstantString *)	ID
fallback:		(id)	fallback
arguments:		(va_list)	arguments

Returns the localized string for the specified ID, using the fallback string if it cannot be looked up or is missing.

Note

This takes a variadic argument, terminated by nil and passed as va_list, that consists of pairs of variable names and variable values, which will be replaced inside the localized string. For example, you can pass @"name", @"foo", nil, causing %[name] to be replaced with foo in the localized string.

Generally, you want to use OF_LOCALIZED instead, which also takes care of the nil sentinel automatically.

Parameters

ID	The ID for the localized string
fallback	The fallback to use in case the localized string cannot be looked up or is missing. This can also be an array and use plural scripting, just like with the JSON localization files.
arguments	A va_list of arguments, consisting of pairs of variable names and values to replace in the localized string, terminated with nil

Returns

The localized string

Exceptions

OFInvalidFormatException

The string (either the fallback or the localized one) contains an invalid format

Property Documentation

countryCode

- (OFString *) countryCode

readwriteatomic

The country code of the locale for messages.

If the territory is unknown, it is nil.

encoding

- (OFStringEncoding) encoding

readnonatomicassign

The native 8-bit string encoding of the locale for messages.

This is useful to encode strings correctly for passing them to operating system calls.

If the native 8-bit encoding is unknown, UTF-8 is assumed.

languageCode

- (OFString *) languageCode

readwriteatomic

The language code of the locale for messages.

If the language is unknown, it is nil.

---

The documentation for this class was generated from the following files:

• src/OFLocale.h
• src/OFLocale.m