NSString(OOExtensions) Category Reference

#include <NSStringOOExtensions.h>

Instance Methods
(NSData *)	- utf16DataWithBOM:
(uint32_t)	- oo_hash
(NSString *)	- stringByTrimmingLeadingCharactersInSet:
(NSString *)	- stringByTrimmingLeadingWhitespaceAndNewlineCharacters
(NSString *)	- stringByTrimmingTrailingCharactersInSet:
(NSString *)	- stringByTrimmingTrailingWhitespaceAndNewlineCharacters

Class Methods
(instancetype)	+ stringWithContentsOfUnicodeFile:
(instancetype)	+ stringWithUTF16String:

Detailed Description

Definition at line 30 of file NSStringOOExtensions.h.

Method Documentation

oo_hash

- (uint32_t) oo_hash

Definition at line 218 of file NSStringOOExtensions.m.

{
    NSUInteger i, length = [self length];
    uint32_t hash = 5381;
    for (i = 0; i < length; i++)
    {
        hash = ((hash << 5) + hash) /* 33 * hash */ ^ [self characterAtIndex:i];
    }
    return hash;
}

stringByTrimmingLeadingCharactersInSet:

- (NSString *) stringByTrimmingLeadingCharactersInSet:

(NSCharacterSet *)

characterSet

Definition at line 218 of file NSStringOOExtensions.m.

                                                    :(NSCharacterSet *)characterSet
{
    NSRange rangeOfFirstWantedCharacter = [self rangeOfCharacterFromSet:[characterSet invertedSet]];
    if (rangeOfFirstWantedCharacter.location == NSNotFound)  return @"";
    
    return [self substringFromIndex:rangeOfFirstWantedCharacter.location];
}

stringByTrimmingLeadingWhitespaceAndNewlineCharacters

- (NSString *) stringByTrimmingLeadingWhitespaceAndNewlineCharacters

Definition at line 218 of file NSStringOOExtensions.m.

{
    return [self stringByTrimmingLeadingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
}

stringByTrimmingTrailingCharactersInSet:

- (NSString *) stringByTrimmingTrailingCharactersInSet:

(NSCharacterSet *)

characterSet

Definition at line 218 of file NSStringOOExtensions.m.

                                                     :(NSCharacterSet *)characterSet
{
    NSRange rangeOfLastWantedCharacter = [self rangeOfCharacterFromSet:[characterSet invertedSet] options:NSBackwardsSearch];
    if (rangeOfLastWantedCharacter.location == NSNotFound)  return @"";
    
    return [self substringToIndex:rangeOfLastWantedCharacter.location+1]; // non-inclusive
}

stringByTrimmingTrailingWhitespaceAndNewlineCharacters

- (NSString *) stringByTrimmingTrailingWhitespaceAndNewlineCharacters

Definition at line 218 of file NSStringOOExtensions.m.

{
    return [self stringByTrimmingTrailingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
}

stringWithContentsOfUnicodeFile:

+ (instancetype) stringWithContentsOfUnicodeFile:

(NSString *)

path

Definition at line 218 of file NSStringOOExtensions.m.

                                                :(NSString *)path
{
    id              result = nil;
    BOOL            OK = YES;
    NSData          *data = nil;
    const uint8_t   *bytes = NULL;
    size_t          length = 0;
    const uint8_t   *effectiveBytes = NULL;
    size_t          effectiveLength = 0;
    
    data = [[NSData oo_dataWithOXZFile:path] retain];
    if (data == nil) OK = NO;
    
    if (OK)
    {
        length = [data length];
        bytes = [data bytes];
    }
    
    if (OK && 2 <= length && (length % sizeof(unichar)) == 0)
    {
        // Could be UTF-16
        unichar firstChar = bytes[0];
        firstChar = (firstChar << 8) | bytes[1];    // Endianism doesn't matter, because we test both orders of BOM.
        if (firstChar == 0xFFFE || firstChar == 0xFEFF)
        {
            // Consider it to be UTF-16.
            result = [NSString stringWithCharacters:(unichar *)(bytes + sizeof(unichar)) length:(length / sizeof(unichar)) - 1];
            if (result == nil) OK = NO;
        }
    }
    
    if (OK && result == nil)
    {
        // Not UTF-16. Try UTF-8.
        if (3 <= length && bytes[0] == 0xEF && bytes[1] == 0xBB && bytes[2] == 0xBF)
        {
            // File starts with UTF-8 BOM; skip it.
            effectiveBytes = bytes + 3;
            effectiveLength = length + 3;
        }
        else
        {
            effectiveBytes = bytes;
            effectiveLength = length;
        }
        
        // Attempt to interpret as UTF-8
        result = [[[NSString alloc] initWithBytes:effectiveBytes length:effectiveLength encoding:NSUTF8StringEncoding] autorelease];
    }
    
    if (OK && result == nil)
    {
        // Not UTF-16 or UTF-8. Use ISO-Latin-1 (which should work for any byte sequence).
        result = [[[NSString alloc] initWithBytes:effectiveBytes length:effectiveLength encoding:NSISOLatin1StringEncoding] autorelease];
    }
    
    [data release];
    return result;
}

stringWithUTF16String:

+ (instancetype) stringWithUTF16String:

(const unichar *)

chars

Definition at line 218 of file NSStringOOExtensions.m.

                                      :(const unichar *)chars
{
    size_t          length;
    const unichar   *end;
    
    if (chars == NULL) return nil;
    
    // Find length of string.
    end = chars;
    while (*end++) {}
    length = end - chars - 1;
    
    return [NSString stringWithCharacters:chars length:length];
}

utf16DataWithBOM:

- (NSData *) utf16DataWithBOM:

(BOOL)

includeByteOrderMark

Definition at line 218 of file NSStringOOExtensions.m.

                             :(BOOL)includeByteOrderMark
{
    size_t          lengthInChars;
    size_t          lengthInBytes;
    unichar         *buffer = NULL;
    unichar         *characters = NULL;
    
    // Calculate sizes
    lengthInChars = [self length];
    lengthInBytes = lengthInChars * sizeof(unichar);
    if (includeByteOrderMark) lengthInBytes += sizeof(unichar);
    
    // Allocate buffer
    buffer = malloc(lengthInBytes);
    if (buffer == NULL) return nil;
    
    // write BOM (native-endian) if desired
    characters = buffer;
    if (includeByteOrderMark)
    {
        *characters++ = 0xFEFF;
    }
    
    // Get the contents
    [self getCharacters:characters];
    
    // NSData takes ownership of the buffer.
    return [NSData dataWithBytesNoCopy:buffer length:lengthInBytes freeWhenDone:YES];
}

---

The documentation for this category was generated from the following files:

• src/Core/NSStringOOExtensions.h
• src/Core/NSStringOOExtensions.m