src/OFString.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011
 *   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.
 */

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

#import "OFObject.h"

typedef uint32_t of_unichar_t;

typedef enum of_string_encoding_t {
        OF_STRING_ENCODING_UTF_8,
        OF_STRING_ENCODING_ISO_8859_1,
        OF_STRING_ENCODING_ISO_8859_15,
        OF_STRING_ENCODING_WINDOWS_1252
} of_string_encoding_t;

#ifdef __cplusplus
extern "C" {
#endif
extern int of_string_check_utf8(const char*, 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);
#ifdef __cplusplus
}
#endif

@class OFArray;
@class OFURL;

@interface OFString: OFObject <OFCopying, OFMutableCopying, OFComparing>
{
        char   *string;
        size_t length;
        BOOL   isUTF8;
}

+ string;

+ stringWithCString: (const char*)str;

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

+ stringWithCString: (const char*)str
           encoding: (of_string_encoding_t)encoding
             length: (size_t)len;

+ stringWithCString: (const char*)str
             length: (size_t)len;

+ stringWithFormat: (OFString*)fmt, ...;

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

+ stringWithString: (OFString*)str;

+ stringWithContentsOfFile: (OFString*)path;

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

+ stringWithContentsOfURL: (OFURL*)url;

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

- initWithCString: (const char*)str;

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

- initWithCString: (const char*)str
         encoding: (of_string_encoding_t)encoding
           length: (size_t)len;

- initWithCString: (const char*)str
           length: (size_t)len;

- initWithFormat: (OFString*)fmt, ...;

- initWithFormat: (OFString*)fmt
       arguments: (va_list)args;

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

- initWithPath: (OFString*)first
     arguments: (va_list)args;

- initWithString: (OFString*)str;

- 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*)cString;

- (size_t)length;

- (size_t)cStringLength;

- (BOOL)isUTF8;

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

- (of_unichar_t)characterAtIndex: (size_t)index;

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

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

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

- (OFString*)substringFromIndex: (size_t)start
                        toIndex: (size_t)end;

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

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

- (OFString*)stringByDeletingLeadingWhitespaces;

- (OFString*)stringByDeletingTrailingWhitespaces;

- (OFString*)stringByDeletingLeadingAndTrailingWhitespaces;

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

- (of_unichar_t*)unicodeString;

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

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