/*
* 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 "OFString.h"
OF_ASSUME_NONNULL_BEGIN
/**
* @class OFMutableString OFMutableString.h ObjFW/ObjFW.h
*
* @brief A class for storing and modifying strings.
*/
@interface OFMutableString: OFString
/**
* @brief Sets the character at the specified index.
*
* @param character The character to set
* @param index The index where to set the character
*/
- (void)setCharacter: (OFUnichar)character atIndex: (size_t)index;
/**
* @brief Appends another OFString to the OFMutableString.
*
* @param string An OFString to append
*/
- (void)appendString: (OFString *)string;
/**
* @brief Appends the specified characters to the OFMutableString.
*
* @param characters An array of characters to append
* @param length The length of the array of characters
*/
- (void)appendCharacters: (const OFUnichar *)characters length: (size_t)length;
/**
* @brief Appends a UTF-8 encoded C string to the OFMutableString.
*
* @param UTF8String A UTF-8 encoded C string to append
* @throw OFInvalidEncodingException The C string is not in not in the correct
* encoding
*/
- (void)appendUTF8String: (const char *)UTF8String;
/**
* @brief Appends a UTF-8 encoded C string with the specified length to the
* OFMutableString.
*
* @param UTF8String A UTF-8 encoded C string to append
* @param UTF8StringLength The length of the UTF-8 encoded C string
* @throw OFInvalidEncodingException The C string is not in not in the correct
* encoding
*/
- (void)appendUTF8String: (const char *)UTF8String
length: (size_t)UTF8StringLength;
/**
* @brief Appends a C string with the specified encoding to the OFMutableString.
*
* @param cString A C string to append
* @param encoding The encoding of the C string
* @throw OFInvalidEncodingException The C string is not in not in the correct
* encoding
*/
- (void)appendCString: (const char *)cString
encoding: (OFStringEncoding)encoding;
/**
* @brief Appends a C string with the specified encoding and length to the
* OFMutableString.
*
* @param cString A C string to append
* @param encoding The encoding of the C string
* @param cStringLength The length of the UTF-8 encoded C string
* @throw OFInvalidEncodingException The C string is not in not in the correct
* encoding
*/
- (void)appendCString: (const char *)cString
encoding: (OFStringEncoding)encoding
length: (size_t)cStringLength;
/**
* @brief Appends a formatted string to the OFMutableString.
*
* See `printf` for the format syntax. As an addition, `%@` is available as
* format specifier for objects, `%C` for `OFUnichar` and `%S` for
* `const OFUnichar *`.
*
* @param format A format string which generates the string to append
* @throw OFInvalidFormatException The specified format is invalid
* @throw OFInvalidEncodingException The resulting string is not in not in UTF-8
* encoding
*/
- (void)appendFormat: (OFConstantString *)format, ...;
/**
* @brief Appends a formatted string to the OFMutableString.
*
* See printf for the format syntax. As an addition, `%@` is available as
* format specifier for objects, `%C` for `OFUnichar` and `%S` for
* `const OFUnichar *`.
*
* @param format A format string which generates the string to append
* @param arguments The arguments used in the format string
* @throw OFInvalidFormatException The specified format is invalid
*/
- (void)appendFormat: (OFConstantString *)format arguments: (va_list)arguments;
/**
* @brief Converts the string to uppercase.
*/
- (void)uppercase;
/**
* @brief Converts the string to lowercase.
*/
- (void)lowercase;
/**
* @brief Capitalizes the string.
*
* @note This only considers spaces, tabs and newlines to be word delimiters!
* Also note that this might change in the future to all word delimiters
* specified by Unicode!
*/
- (void)capitalize;
/**
* @brief Inserts a string at the specified index.
*
* @param string The string to insert
* @param index The index
*/
- (void)insertString: (OFString *)string atIndex: (size_t)index;
/**
* @brief Deletes the characters at the specified range.
*
* @param range The range of the characters which should be removed
*/
- (void)deleteCharactersInRange: (OFRange)range;
/**
* @brief Replaces the characters at the specified range.
*
* @param range The range of the characters which should be replaced
* @param replacement The string to the replace the characters with
*/
- (void)replaceCharactersInRange: (OFRange)range
withString: (OFString *)replacement;
/**
* @brief Replaces all occurrences of a string with another string.
*
* @param string The string to replace
* @param replacement The string with which it should be replaced
*/
- (void)replaceOccurrencesOfString: (OFString *)string
withString: (OFString *)replacement;
/**
* @brief Replaces all occurrences of a string in the specified range with
* another string.
*
* @param string The string to replace
* @param replacement The string with which it should be replaced
* @param options Options modifying search behavior
* Possible values: None yet
* @param range The range in which the string should be replaced
*/
- (void)replaceOccurrencesOfString: (OFString *)string
withString: (OFString *)replacement
options: (int)options
range: (OFRange)range;
/**
* @brief Deletes all whitespaces at the beginning of the string.
*/
- (void)deleteLeadingWhitespaces;
/**
* @brief Deletes all whitespaces at the end of the string.
*/
- (void)deleteTrailingWhitespaces;
/**
* @brief Deletes all whitespaces at the beginning and the end of the string.
*/
- (void)deleteEnclosingWhitespaces;
/**
* @brief Converts the mutable string to an immutable string.
*/
- (void)makeImmutable;
@end
OF_ASSUME_NONNULL_END