OFOptionsParser.h

/*
 * Copyright (c) 2008-2024 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"
 
@class OFMapTable;
 
OF_ASSUME_NONNULL_BEGIN
 
typedef struct {
    OFUnichar shortOption;
 
    OFString *__unsafe_unretained _Nullable longOption;
 
    signed char hasArgument;
 
    bool *_Nullable isSpecifiedPtr;
 
    OFString *__autoreleasing _Nullable *_Nullable argumentPtr;
} OFOptionsParserOption;
 
OF_SUBCLASSING_RESTRICTED
@interface OFOptionsParser: OFObject
{
    OFOptionsParserOption *_options;
    OFMapTable *_longOptions;
    OFArray OF_GENERIC(OFString *) *_arguments;
    size_t _index, _subIndex;
    OFUnichar _lastOption;
    OFString *_Nullable _lastLongOption, *_Nullable _argument;
    bool _done;
}
 
@property (readonly, nonatomic) OFUnichar lastOption;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *lastLongOption;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *argument;
 
@property (readonly, nonatomic)
    OFArray OF_GENERIC(OFString *) *remainingArguments;
 
+ (instancetype)parserWithOptions: (const OFOptionsParserOption *)options;
 
- (instancetype)init OF_UNAVAILABLE;
 
- (instancetype)initWithOptions: (const OFOptionsParserOption *)options
    OF_DESIGNATED_INITIALIZER;
 
- (OFUnichar)nextOption;
@end
 
OF_ASSUME_NONNULL_END