OFLocalization Class Reference

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

#import <ObjFW/OFLocalization.h>

Inheritance diagram for OFLocalization:

Instance Methods
(id)	- init
	Initializes the OFLocalization singleton with the specified locale. More...
(void)	- addLanguageDirectory:
	Adds a directory to scan for language files. More...
(OFString *)	- localizedStringForID:fallback:
	Returns the localized string for the specified ID, using the fallback string if it cannot be looked up or is missing. More...
(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. More...
Instance Methods inherited from OFObject
(OFString *)	- className
	Returns the name of the object's class. More...
(OFString *)	- description
	Returns a description for the object. More...
(nullable void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...
(nullable void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool. More...
(nullable void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size. More...
(nullable void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool. More...
(void)	- dealloc
	Deallocates the object. More...
(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...
(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...
(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...
(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...
(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...
(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...
(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...
(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...
(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...
(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...
(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...
(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
(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. More...
(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...
(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver. More...
Instance Methods inherited from <OFObject>
(bool)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind. More...
(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class. More...
(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector. More...
(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector. More...
(nullable const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector. More...
(nullable id)	- performSelector:
	Performs the specified selector. More...
(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object. More...
(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects. More...
(bool)	- isEqual:
	Checks two objects for equality. More...
(uint32_t)	- hash
	Calculates a hash for the object. More...
(id)	- retain
	Increases the retain count. More...
(unsigned int)	- retainCount
	Returns the retain count. More...
(void)	- release
	Decreases the retain count. More...
(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
(id)	- self
	Returns the receiver. More...
(bool)	- isProxy
	Returns whether the object is a proxy object. More...
(bool)	- allowsWeakReference
	Returns whether the class allows weak references. More...
(bool)	- retainWeakReference
	Retain a weak reference to this object. More...

Class Methods
(instancetype)	+ sharedLocalization
	Returns the shared OFLocalization instance. More...
(nullable OFString *)	+ language
	Returns the language of the locale. More...
(nullable OFString *)	+ territory
	Returns the territory of the locale. More...
(of_string_encoding_t)	+ encoding
	Returns the native 8-bit string encoding for the locale. More...
(OFString *)	+ decimalPoint
	Returns the decimal point of the system's locale. More...
(void)	+ addLanguageDirectory:
	Adds a directory to scan for language files. More...
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...
(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...
(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...
(id)	+ new
	Allocates memory for a new instance and calls init on it. More...
(Class)	+ class
	Returns the class. More...
(OFString *)	+ className
	Returns the name of the class as a string. More...
(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...
(nullable Class)	+ superclass
	Returns the superclass of the class. More...
(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...
(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...
(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...
(nullable const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector. More...
(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...
(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...
(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...
(nullable IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method. More...
(nullable IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method. More...
(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...
(BOOL)	+ resolveClassMethod:
	Try to resolve the specified class method. More...
(BOOL)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...
(id)	+ copy
	Returns the class. More...

Properties
	readonly
of_string_encoding_t	encoding
OFString *	decimalPoint

Detailed Description

A class for querying the locale and retrieving localized strings.

Method Documentation

addLanguageDirectory:() [1/2]

+ (void) addLanguageDirectory:

(OFString *)

path

Adds a directory to scan for language files.

Parameters

path	The path to the directory to scan for language files

addLanguageDirectory:() [2/2]

- (void) addLanguageDirectory:

(OFString *)

path

Adds a directory to scan for language files.

Parameters

path	The path to the directory to scan for language files

decimalPoint()

+ (OFString *) decimalPoint

Returns the decimal point of the system's locale.

Returns

The decimal point of the system's locale

encoding()

+ (of_string_encoding_t) 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()

- (id) init

Initializes the OFLocalization singleton with the specified locale.

Warning

This sets the locale via setlocale()!

You should never call this yourself, except if you do not use OFApplication. In this case, you need to allocate exactly one instance of OFLocalization, which will be come the singleton, and call this method.

Reimplemented from OFObject.

language()

+ (nullable OFString *) language

Returns the language of the locale.

If the language is unknown, nil is returned.

Returns

The language of the locale.

localizedStringForID:fallback:()

- (OFString *) localizedStringForID:		(OFConstantString *)	ID
fallback:		(OFConstantString *)	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

Returns

The localized string

localizedStringForID:fallback:arguments:()

- (OFString *) localizedStringForID:		(OFConstantString *)	ID
fallback:		(OFConstantString *)	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
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

sharedLocalization()

+ (instancetype) sharedLocalization

Returns the shared OFLocalization instance.

Warning

If you don't use OFApplication, this might be nil! In this case, you need to manually allocate an instance and call init once.

Returns

The shared OFLocalization instance

territory()

+ (nullable OFString *) territory

Returns the territory of the locale.

If the territory is unknown, nil is returned.

Returns

The territory of the locale.

Property Documentation

decimalPoint

- (OFString *) decimalPoint

readnonatomicassign

The decimal point of the system's locale.

encoding

- (of_string_encoding_t) 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.

readonly

- readonly

readwriteatomic

The language of the locale for messages.

If the language is unknown, it is nil.

The territory of the locale for messages.

If the territory is unknown, it is nil.

---

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

• src/OFLocalization.h
• src/OFLocalization.m