OFLocale.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
#import "OFString.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFIRI;


#define OF_LOCALIZED(ID, ...)                        \
    [[OFLocale currentLocale] localizedStringForID: ID       \
                         fallback: __VA_ARGS__, nil]
 
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFDictionary OF_GENERIC(KeyType, ObjectType);

OF_SUBCLASSING_RESTRICTED
@interface OFLocale: OFObject
{
    OFString *_Nullable _languageCode, *_Nullable _countryCode;
    OFStringEncoding _encoding;
    OFString *_decimalSeparator;
    OFMutableArray OF_GENERIC(OFDictionary OF_GENERIC(OFString *, id) *)
        *_localizedStrings;
}
 
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nullable, nonatomic) OFLocale *currentLocale;
@property (class, readonly, nullable, nonatomic) OFString *languageCode;
@property (class, readonly, nullable, nonatomic) OFString *countryCode;
@property (class, readonly, nonatomic) OFStringEncoding encoding;
@property (class, readonly, nullable, nonatomic) OFString *decimalSeparator;
#endif

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *languageCode;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *countryCode;

@property (readonly, nonatomic) OFStringEncoding encoding;

@property (readonly, nonatomic) OFString *decimalSeparator;

+ (nullable OFLocale *)currentLocale;

+ (nullable OFString *)languageCode;

+ (nullable OFString *)countryCode;

+ (OFStringEncoding)encoding;

+ (nullable OFString *)decimalSeparator;

+ (void)addLocalizationDirectoryIRI: (OFIRI *)IRI;
 
- (instancetype)init
    OF_DEPRECATED(ObjFW, 1, 1,
    "Manually creating an OFLocale is no longer necessary. "
    "Use +[OFLocale currentLocale] instead.");

- (void)addLocalizationDirectoryIRI: (OFIRI *)IRI;

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

- (OFString *)localizedStringForID: (OFConstantString *)ID
              fallback: (id)fallback
             arguments: (va_list)arguments;
@end
 
OF_ASSUME_NONNULL_END