OFOptionsParser.h

/*
 * 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"

@class OFMapTable;

OF_ASSUME_NONNULL_BEGIN

typedef struct of_options_parser_option_t {
    of_unichar_t shortOption;

    OFString *__unsafe_unretained _Nullable longOption;

    signed char hasArgument;

    bool *_Nullable isSpecifiedPtr;

    OFString *__autoreleasing _Nullable *_Nullable argumentPtr;
} of_options_parser_option_t;

@interface OFOptionsParser: OFObject
{
    of_options_parser_option_t *_options;
    OFMapTable *_longOptions;
    OFArray OF_GENERIC(OFString *) *_arguments;
    size_t _index, _subIndex;
    of_unichar_t _lastOption;
    OFString *_Nullable _lastLongOption, *_Nullable _argument;
    bool _done;
}

@property (readonly, nonatomic) of_unichar_t lastOption;

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

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

+ (instancetype)parserWithOptions: (const of_options_parser_option_t *)options;

- init OF_UNAVAILABLE;

- initWithOptions: (const of_options_parser_option_t *)options
    OF_DESIGNATED_INITIALIZER;

- (of_unichar_t)nextOption;

- (OFArray OF_GENERIC(OFString *) *)remainingArguments;
@end

OF_ASSUME_NONNULL_END