OFString.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * 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

#include <stdarg.h>
#include <inttypes.h>

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

@class OFConstantString;

typedef uint32_t of_unichar_t;

typedef enum of_string_encoding_t {
    OF_STRING_ENCODING_UTF_8,
    OF_STRING_ENCODING_ASCII,
    OF_STRING_ENCODING_ISO_8859_1,
    OF_STRING_ENCODING_ISO_8859_15,
    OF_STRING_ENCODING_WINDOWS_1252,
    OF_STRING_ENCODING_AUTODETECT = 0xFF
} of_string_encoding_t;

enum {
    OF_STRING_SEARCH_BACKWARDS = 1,
    OF_STRING_SKIP_EMPTY       = 2
};

/* FIXME */
#define OF_STRING_ENCODING_NATIVE OF_STRING_ENCODING_UTF_8

#ifdef OF_HAVE_BLOCKS
typedef void (^of_string_line_enumeration_block_t)(OFString *line, BOOL *stop);
#endif

#ifdef __cplusplus
extern "C" {
#endif
extern int of_string_utf8_check(const char*, size_t, size_t*);
extern size_t of_string_utf8_encode(of_unichar_t, char*);
extern size_t of_string_utf8_decode(const char*, size_t, of_unichar_t*);
extern size_t of_string_utf8_get_index(const char*, size_t);
extern size_t of_string_utf8_get_position(const char*, size_t, size_t);
extern size_t of_unicode_string_length(const of_unichar_t*);
extern size_t of_utf16_string_length(const uint16_t*);
#ifdef __cplusplus
}
#endif

@class OFArray;
@class OFURL;

@interface OFString: OFObject <OFCopying, OFMutableCopying, OFComparing,
    OFSerialization, OFJSONRepresentation>
#ifdef OF_HAVE_PROPERTIES
@property (readonly) size_t length;
#endif

+ (instancetype)string;

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

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

+ (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)stringWithString: (OFString*)string;

+ (instancetype)stringWithUnicodeString: (const of_unichar_t*)string;

+ (instancetype)stringWithUnicodeString: (const of_unichar_t*)string
                  byteOrder: (of_byte_order_t)byteOrder;

+ (instancetype)stringWithUnicodeString: (const of_unichar_t*)string
                 length: (size_t)length;

+ (instancetype)stringWithUnicodeString: (const of_unichar_t*)string
                  byteOrder: (of_byte_order_t)byteOrder
                 length: (size_t)length;

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

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

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

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

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

+ (instancetype)stringWithPath: (OFString*)firstComponent, ... OF_SENTINEL;

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

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

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

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

- initWithUTF8String: (const char*)UTF8String;

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

- initWithUTF8StringNoCopy: (const 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;

- initWithString: (OFString*)string;

- initWithUnicodeString: (const of_unichar_t*)string;

- initWithUnicodeString: (const of_unichar_t*)string
          byteOrder: (of_byte_order_t)byteOrder;

- initWithUnicodeString: (const of_unichar_t*)string
         length: (size_t)length;

- initWithUnicodeString: (const of_unichar_t*)string
          byteOrder: (of_byte_order_t)byteOrder
         length: (size_t)length;

- initWithUTF16String: (const uint16_t*)string;

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

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

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

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

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

- initWithPath: (OFString*)firstComponent, ... OF_SENTINEL;

- initWithPath: (OFString*)firstComponent
     arguments: (va_list)arguments;

- initWithContentsOfFile: (OFString*)path;

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

- initWithContentsOfURL: (OFURL*)URL;

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

- (const char*)UTF8String OF_RETURNS_INNER_POINTER;

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

- (size_t)length;

- (size_t)UTF8StringLength;

- (size_t)cStringLengthWithEncoding: (of_string_encoding_t)encoding;

- (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*)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*)componentsSeparatedByString: (OFString*)delimiter;

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

- (OFArray*)pathComponents;

- (OFString*)lastPathComponent;

- (OFString*)stringByDeletingLastPathComponent;

- (intmax_t)decimalValue;

- (uintmax_t)hexadecimalValue;

- (float)floatValue;

- (double)doubleValue;

- (const of_unichar_t*)unicodeString OF_RETURNS_INNER_POINTER;

- (const uint16_t*)UTF16String OF_RETURNS_INNER_POINTER;

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

#ifdef OF_HAVE_BLOCKS

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

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

#ifndef NSINTEGER_DEFINED
/* Required for string boxing literals to work */
@compatibility_alias NSString OFString;
#endif