OFString.h

Go to the documentation of this file.

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

#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif

#import "objfw-defs.h"

#ifdef OF_HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif

#include <stdarg.h>
#include <stdint.h>

#import "OFObject.h"
#import "OFSerialization.h"
#import "OFJSONRepresentation.h"
#import "OFMessagePackRepresentation.h"

OF_ASSUME_NONNULL_BEGIN

@class OFConstantString;

#if !defined(__cplusplus) || __cplusplus < 201103L
typedef uint_least16_t char16_t;
typedef uint_least32_t char32_t;
#endif
typedef char32_t of_unichar_t;

typedef enum of_string_encoding_t {
    /*
     * UTF-8 *has* to be 0, so that if the @ref OFLocalization singleton is
     * `nil`, `[OFLocalization encoding]` returns UTF-8.
     */
    OF_STRING_ENCODING_UTF_8,
    OF_STRING_ENCODING_ASCII,
    OF_STRING_ENCODING_ISO_8859_1,
    OF_STRING_ENCODING_ISO_8859_2,
    OF_STRING_ENCODING_ISO_8859_3,
    OF_STRING_ENCODING_ISO_8859_15,
    OF_STRING_ENCODING_WINDOWS_1251,
    OF_STRING_ENCODING_WINDOWS_1252,
    OF_STRING_ENCODING_CODEPAGE_437,
    OF_STRING_ENCODING_CODEPAGE_850,
    OF_STRING_ENCODING_CODEPAGE_858,
    OF_STRING_ENCODING_MAC_ROMAN,
    OF_STRING_ENCODING_KOI8_R,
    OF_STRING_ENCODING_KOI8_U,
    OF_STRING_ENCODING_AUTODETECT = 0xFF
} of_string_encoding_t;

enum {
    OF_STRING_SEARCH_BACKWARDS = 1,
    OF_STRING_SKIP_EMPTY       = 2
};

#ifdef OF_HAVE_BLOCKS

typedef void (^of_string_line_enumeration_block_t)(OFString *line, bool *stop);
#endif

@class OFArray OF_GENERIC(ObjectType);
@class OFURL;

@interface OFString: OFObject <OFCopying, OFMutableCopying, OFComparing,
    OFSerialization, OFJSONRepresentation, OFMessagePackRepresentation>
+ (instancetype)string;

+ (instancetype)stringWithUTF8String: (const char *)UTF8String;

+ (instancetype)stringWithUTF8String: (const char *)UTF8String
                  length: (size_t)UTF8StringLength;

+ (instancetype)stringWithUTF8StringNoCopy: (char *)UTF8String
                  freeWhenDone: (bool)freeWhenDone;

+ (instancetype)stringWithCString: (const char *)cString
             encoding: (of_string_encoding_t)encoding;

+ (instancetype)stringWithCString: (const char *)cString
             encoding: (of_string_encoding_t)encoding
               length: (size_t)cStringLength;

+ (instancetype)stringWithData: (OFData *)data
              encoding: (of_string_encoding_t)encoding;

+ (instancetype)stringWithString: (OFString *)string;

+ (instancetype)stringWithCharacters: (const of_unichar_t *)characters
                  length: (size_t)length;

+ (instancetype)stringWithUTF16String: (const char16_t *)string;

+ (instancetype)stringWithUTF16String: (const char16_t *)string
                   length: (size_t)length;

+ (instancetype)stringWithUTF16String: (const char16_t *)string
                byteOrder: (of_byte_order_t)byteOrder;

+ (instancetype)stringWithUTF16String: (const char16_t *)string
                   length: (size_t)length
                byteOrder: (of_byte_order_t)byteOrder;

+ (instancetype)stringWithUTF32String: (const char32_t *)string;

+ (instancetype)stringWithUTF32String: (const char32_t *)string
                   length: (size_t)length;

+ (instancetype)stringWithUTF32String: (const char32_t *)string
                byteOrder: (of_byte_order_t)byteOrder;

+ (instancetype)stringWithUTF32String: (const char32_t *)string
                   length: (size_t)length
                byteOrder: (of_byte_order_t)byteOrder;

+ (instancetype)stringWithFormat: (OFConstantString *)format, ...;

#ifdef OF_HAVE_FILES

+ (instancetype)stringWithContentsOfFile: (OFString *)path;

+ (instancetype)stringWithContentsOfFile: (OFString *)path
                encoding: (of_string_encoding_t)encoding;
#endif

#if defined(OF_HAVE_FILES) || defined(OF_HAVE_SOCKETS)

+ (instancetype)stringWithContentsOfURL: (OFURL *)URL;

+ (instancetype)stringWithContentsOfURL: (OFURL *)URL
                   encoding: (of_string_encoding_t)encoding;
#endif

+ (OFString *)pathWithComponents: (OFArray OF_GENERIC(OFString *) *)components;

- initWithUTF8String: (const char *)UTF8String;

- initWithUTF8String: (const char *)UTF8String
          length: (size_t)UTF8StringLength;

- initWithUTF8StringNoCopy: (char *)UTF8String
          freeWhenDone: (bool)freeWhenDone;

- initWithCString: (const char *)cString
     encoding: (of_string_encoding_t)encoding;

- initWithCString: (const char *)cString
     encoding: (of_string_encoding_t)encoding
       length: (size_t)cStringLength;

- initWithData: (OFData *)data
      encoding: (of_string_encoding_t)encoding;

- initWithString: (OFString *)string;

- initWithCharacters: (const of_unichar_t *)characters
          length: (size_t)length;

- initWithUTF16String: (const char16_t *)string;

- initWithUTF16String: (const char16_t *)string
           length: (size_t)length;

- initWithUTF16String: (const char16_t *)string
        byteOrder: (of_byte_order_t)byteOrder;

- initWithUTF16String: (const char16_t *)string
           length: (size_t)length
        byteOrder: (of_byte_order_t)byteOrder;

- initWithUTF32String: (const char32_t *)string;

- initWithUTF32String: (const char32_t *)string
           length: (size_t)length;

- initWithUTF32String: (const char32_t *)string
        byteOrder: (of_byte_order_t)byteOrder;

- initWithUTF32String: (const char32_t *)string
           length: (size_t)length
        byteOrder: (of_byte_order_t)byteOrder;

- initWithFormat: (OFConstantString *)format, ...;

- initWithFormat: (OFConstantString *)format
       arguments: (va_list)arguments;

#ifdef OF_HAVE_FILES

- initWithContentsOfFile: (OFString *)path;

- initWithContentsOfFile: (OFString *)path
        encoding: (of_string_encoding_t)encoding;
#endif

#if defined(OF_HAVE_FILES) || defined(OF_HAVE_SOCKETS)

- initWithContentsOfURL: (OFURL *)URL;

- initWithContentsOfURL: (OFURL *)URL
           encoding: (of_string_encoding_t)encoding;
#endif

- (size_t)getCString: (char *)cString
       maxLength: (size_t)maxLength
        encoding: (of_string_encoding_t)encoding;

- (size_t)getLossyCString: (char *)cString
        maxLength: (size_t)maxLength
         encoding: (of_string_encoding_t)encoding;

- (const char *)cStringWithEncoding: (of_string_encoding_t)encoding
    OF_RETURNS_INNER_POINTER;

- (const char *)lossyCStringWithEncoding: (of_string_encoding_t)encoding
    OF_RETURNS_INNER_POINTER;

- (const char *)UTF8String OF_RETURNS_INNER_POINTER;

- (size_t)length;

- (size_t)cStringLengthWithEncoding: (of_string_encoding_t)encoding;

- (size_t)UTF8StringLength;

- (of_comparison_result_t)caseInsensitiveCompare: (OFString *)otherString;

- (of_unichar_t)characterAtIndex: (size_t)index;

- (void)getCharacters: (of_unichar_t *)buffer
          inRange: (of_range_t)range;

- (of_range_t)rangeOfString: (OFString *)string;

- (of_range_t)rangeOfString: (OFString *)string
            options: (int)options;

- (of_range_t)rangeOfString: (OFString *)string
            options: (int)options
              range: (of_range_t)range;

- (bool)containsString: (OFString *)string;

- (OFString *)substringWithRange: (of_range_t)range;

- (OFString *)stringByAppendingString: (OFString *)string;

- (OFString *)stringByAppendingFormat: (OFConstantString *)format, ...;

- (OFString *)stringByAppendingFormat: (OFConstantString *)format
                arguments: (va_list)arguments;

- (OFString *)stringByAppendingPathComponent: (OFString *)component;

- (OFString *)stringByPrependingString: (OFString *)string;

- (OFString *)stringByReplacingOccurrencesOfString: (OFString *)string
                    withString: (OFString *)replacement;

- (OFString *)stringByReplacingOccurrencesOfString: (OFString *)string
                    withString: (OFString *)replacement
                       options: (int)options
                         range: (of_range_t)range;

- (OFString *)uppercaseString;

- (OFString *)lowercaseString;

- (OFString *)capitalizedString;

- (OFString *)stringByDeletingLeadingWhitespaces;

- (OFString *)stringByDeletingTrailingWhitespaces;

- (OFString *)stringByDeletingEnclosingWhitespaces;

- (bool)hasPrefix: (OFString *)prefix;

- (bool)hasSuffix: (OFString *)suffix;

- (OFArray OF_GENERIC(OFString *) *)componentsSeparatedByString:
    (OFString *)delimiter;

- (OFArray OF_GENERIC(OFString *) *)
    componentsSeparatedByString: (OFString *)delimiter
            options: (int)options;

- (OFArray OF_GENERIC(OFString *) *)pathComponents;

- (OFString *)lastPathComponent;

- (OFString *)pathExtension;

- (OFString *)stringByDeletingLastPathComponent;

- (OFString *)stringByDeletingPathExtension;

- (OFString *)stringByStandardizingPath;

- (OFString *)stringByStandardizingURLPath;

- (intmax_t)decimalValue;

- (uintmax_t)hexadecimalValue;

- (uintmax_t)octalValue;

- (float)floatValue;

- (double)doubleValue;

- (const of_unichar_t *)characters OF_RETURNS_INNER_POINTER;

- (const char16_t *)UTF16String OF_RETURNS_INNER_POINTER;

- (const char16_t *)UTF16StringWithByteOrder: (of_byte_order_t)byteOrder
    OF_RETURNS_INNER_POINTER;

- (size_t)UTF16StringLength;

- (const char32_t *)UTF32String OF_RETURNS_INNER_POINTER;

- (const char32_t *)UTF32StringWithByteOrder: (of_byte_order_t)byteOrder
    OF_RETURNS_INNER_POINTER;

- (OFData *)dataWithEncoding: (of_string_encoding_t)encoding;

#ifdef OF_HAVE_UNICODE_TABLES

- (OFString *)decomposedStringWithCanonicalMapping;

- (OFString *)decomposedStringWithCompatibilityMapping;
#endif

#ifdef OF_HAVE_FILES

- (void)writeToFile: (OFString *)path;

- (void)writeToFile: (OFString *)path
       encoding: (of_string_encoding_t)encoding;
#endif

#ifdef OF_HAVE_BLOCKS

- (void)enumerateLinesUsingBlock: (of_string_line_enumeration_block_t)block;
#endif
@end

#ifdef __cplusplus
extern "C" {
#endif
extern of_string_encoding_t of_string_parse_encoding(OFString *);
extern size_t of_string_utf8_encode(of_unichar_t, char *);
extern ssize_t of_string_utf8_decode(const char *, size_t, of_unichar_t *);
extern size_t of_string_utf16_length(const char16_t *);
extern size_t of_string_utf32_length(const char32_t *);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END

#import "OFConstantString.h"
#import "OFMutableString.h"
#import "OFString+CryptoHashing.h"
#import "OFString+JSONValue.h"
#import "OFString+Serialization.h"
#import "OFString+URLEncoding.h"
#import "OFString+XMLEscaping.h"
#import "OFString+XMLUnescaping.h"

#if !defined(NSINTEGER_DEFINED) && !__has_feature(modules)
/*
 * Very *ugly* hack required for string boxing literals to work.
 *
 * This hack is needed in order to work with `@class NSString` from Apple's
 * objc/NSString.h - which is included when using modules - as
 * @compatibility_alias does not work if @class has been used before.
 * For some reason, this makes Clang refer to OFString for string box literals
 * and not to NSString (which would result in a linker error, but would be the
 * correct behavior).
 *
 * TODO: Submit a patch for Clang that makes the boxing classes configurable!
 */
@interface NSString: OFString
@end
#endif