OFINIFile.h

/*
 * 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"
#import "OFINISection.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFIRI;
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);

OF_SUBCLASSING_RESTRICTED
@interface OFINIFile: OFObject
{
    OFMutableArray OF_GENERIC(OFINISection *) *_sections;
    OFMutableDictionary OF_GENERIC(OFString *, OFINISection *)
        *_sectionsMap;
}

@property (readonly, nonatomic) OFArray OF_GENERIC(OFINISection *) *sections;

@property (readonly, nonatomic) OFArray OF_GENERIC(OFINISection *) *categories
    OF_DEPRECATED(ObjFW, 1, 2, "Use -[sections] instead");

+ (instancetype)fileWithIRI: (OFIRI *)IRI;

+ (instancetype)fileWithIRI: (OFIRI *)IRI encoding: (OFStringEncoding)encoding;
 
- (instancetype)init OF_UNAVAILABLE;

- (instancetype)initWithIRI: (OFIRI *)IRI;

- (instancetype)initWithIRI: (OFIRI *)IRI
           encoding: (OFStringEncoding)encoding
    OF_DESIGNATED_INITIALIZER;

- (OFINISection *)sectionForName: (OFString *)name;

- (OFINISection *)categoryForName: (OFString *)name
    OF_DEPRECATED(ObjFW, 1, 2, "Use -[sectionForName:] instead");

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

- (void)writeToIRI: (OFIRI *)IRI encoding: (OFStringEncoding)encoding;
@end
 
OF_ASSUME_NONNULL_END