OFLocalization.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#import "OFObject.h"
#import "OFString.h"

OF_ASSUME_NONNULL_BEGIN

#define OF_LOCALIZED(ID, ...)               \
    [[OFLocalization sharedLocalization]        \
        localizedStringForID: ID            \
            fallback: __VA_ARGS__, nil]

@class OFMutableArray OF_GENERIC(ObjectType);
@class OFDictionary OF_GENERIC(KeyType, ObjectType);

@interface OFLocalization: OFObject
{
    OFString *_Nullable _language, *_Nullable _territory;
    of_string_encoding_t _encoding;
    OFString *_decimalPoint;
    OFMutableArray OF_GENERIC(OFDictionary OF_GENERIC(OFString *, id) *)
        *_localizedStrings;
}

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

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

@property (readonly, nonatomic) of_string_encoding_t encoding;

@property (readonly, nonatomic) OFString *decimalPoint;

+ (instancetype)sharedLocalization;

+ (nullable OFString *)language;

+ (nullable OFString *)territory;

+ (of_string_encoding_t)encoding;

+ (OFString *)decimalPoint;

#ifdef OF_HAVE_FILES

+ (void)addLanguageDirectory: (OFString *)path;
#endif

- init;

#ifdef OF_HAVE_FILES

- (void)addLanguageDirectory: (OFString *)path;
#endif

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

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

OF_ASSUME_NONNULL_END