OFCharacterSet.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"

OF_ASSUME_NONNULL_BEGIN

@interface OFCharacterSet: OFObject
{
    OF_RESERVE_IVARS(OFCharacterSet, 4)
}

#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) OFCharacterSet *whitespaceCharacterSet;
@property (class, readonly, nonatomic) OFCharacterSet *newlineCharacterSet;
@property (class, readonly, nonatomic) OFCharacterSet *controlCharacterSet;
#endif

@property (readonly, nonatomic) OFCharacterSet *invertedSet;

+ (instancetype)characterSetWithCharactersInString: (OFString *)characters;

+ (instancetype)characterSetWithRange: (OFRange)range;

+ (OFCharacterSet *)whitespaceCharacterSet;

+ (OFCharacterSet *)newlineCharacterSet;

+ (OFCharacterSet *)controlCharacterSet;

- (instancetype)initWithCharactersInString: (OFString *)characters;

- (instancetype)initWithRange: (OFRange)range;

- (bool)characterIsMember: (OFUnichar)character;
@end

OF_ASSUME_NONNULL_END