src/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 "OFJSONEncoding.h"

#import "macros.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;

/* 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_check_utf8(const char*, size_t, size_t*);
extern size_t of_string_unicode_to_utf8(of_unichar_t, char*);
extern size_t of_string_utf8_to_unicode(const char*, size_t, of_unichar_t*);
extern size_t of_string_position_to_index(const char*, size_t);
extern size_t of_string_index_to_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, OFJSON>
#ifdef OF_HAVE_PROPERTIES
@property (readonly) size_t length;
#endif

+ string;

+ stringWithUTF8String: (const char*)UTF8String;

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

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

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

+ stringWithString: (OFString*)string;

+ stringWithUnicodeString: (const of_unichar_t*)string;

+ stringWithUnicodeString: (const of_unichar_t*)string
                byteOrder: (of_endianess_t)byteOrder;

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

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

+ stringWithUTF16String: (const uint16_t*)string;

+ stringWithUTF16String: (const uint16_t*)string
              byteOrder: (of_endianess_t)byteOrder;

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

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

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

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

+ stringWithContentsOfFile: (OFString*)path;

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

+ stringWithContentsOfURL: (OFURL*)URL;

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

- initWithUTF8String: (const char*)UTF8String;

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

- 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_endianess_t)byteOrder;

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

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

- initWithUTF16String: (const uint16_t*)string;

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

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

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

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

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

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

- 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;

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

- (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;

- (size_t)indexOfFirstOccurrenceOfString: (OFString*)string;

- (size_t)indexOfLastOccurrenceOfString: (OFString*)string;

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

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

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

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

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

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

- (OFString*)uppercaseString;

- (OFString*)lowercaseString;

- (OFString*)stringByDeletingLeadingWhitespaces;

- (OFString*)stringByDeletingTrailingWhitespaces;

- (OFString*)stringByDeletingEnclosingWhitespaces;

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

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

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

- (OFArray*)pathComponents;

- (OFString*)lastPathComponent;

- (OFString*)stringByDeletingLastPathComponent;

- (intmax_t)decimalValue;

- (uintmax_t)hexadecimalValue;

- (float)floatValue;

- (double)doubleValue;

- (const of_unichar_t*)unicodeString;

- (const uint16_t*)UTF16String;

- (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"