Text.h

//
// $Id: Text.h,v 1.13 2007/03/08 19:59:21 will_mason Exp $
//
// vi: set ft=objc:

/*
 * ObjectiveLib - a library of containers and algorithms for Objective-C
 *
 * Copyright (c) 2004-2007
 * Will Mason
 *
 * Portions:
 *
 * Copyright (c) 1994
 * Hewlett-Packard Company
 *
 * Copyright (c) 1996,1997
 * Silicon Graphics Computer Systems, Inc.
 *
 * Copyright (c) 1997
 * Moscow Center for SPARC Technology
 *
 * Copyright (c) 1999 
 * Boris Fomitchev
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * You may contact the author at will_mason@users.sourceforge.net.
 */

#if !defined(TEXT_OL_GUARD)
#define TEXT_OL_GUARD

#include <ObjectiveLib/ObjectBase.h>
#if defined(OL_HAVE_INTTYPES_H)
#include <inttypes.h>
#else
#include <stdint.h>
#endif

typedef uint16_t olchar;

struct _OLTextReference;

@interface OLText :
#if defined(OL_NO_OPENSTEP)
    Object <OLStreamable>
#else
    NSObject <OLStreamable, NSCopying, NSCoding>
#endif
{
@protected
    struct _OLTextReference* reference;
}

#if defined(OL_NO_OPENSTEP)
+ (id) initialize;
#else
+ (void) initialize;
#endif

+ (id) textWithBytes: (const uint8_t*)bytes count: (unsigned)num encoding: (const char*)enc;

+ (id) textWithCString: (const char*)chs;

#if !defined(OL_NO_OPENSTEP)

+ (id) textWithNSString: (NSString*)str;
#endif

+ (id) textWithText: (OLText*)text;

/* @{ */

- (id) init;

- (id) initWithBytes: (const uint8_t*)bytes count: (unsigned)num encoding: (const char*)enc;

- (id) initWithChars: (const olchar*)chs count: (unsigned)num;

#if !defined(OL_NO_OPENSTEP)

- (id) initWithCoder: (NSCoder*)decoder;
#endif

#if defined(OL_NO_OPENSTEP)
- (id) initWithConstantString: (OLConstantString*)str;
#endif

- (id) initWithCString: (const char*)chs;

#if !defined(OL_NO_OPENSTEP)
- (id) initWithNSString: (NSString*)str;
#endif

- (id) initWithObjectInStream: (OLObjectInStream*)stream;

- (id) initWithText: (OLText*)text;

- (id) initWithText: (OLText*)text offset: (unsigned)roff count: (unsigned)num;

#if defined(OL_NO_OPENSTEP)
- (id) free;
#else
- (void) dealloc;
#endif
/* @} */

- (olchar) at: (unsigned)index;

- (uint8_t*) bytesWithEncoding: (const char*)enc returnedCount: (unsigned*)rc;

- (int) compare: (id)other;

#if defined(OL_NO_OPENSTEP)

- (id) copy;
#else

- (id) copyWithZone: (NSZone*)zone;
#endif

- (const char*) cString;

- (BOOL) empty;

#if !defined(OL_NO_OPENSTEP)

- (void) encodeWithCoder: (NSCoder*)encoder;
#endif

- (unsigned) findChar: (olchar)ch fromOffset: (unsigned)offset;

- (unsigned) findFirstNotOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findFirstOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findLastNotOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findLastOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findText: (OLText*)text fromOffset: (unsigned)offset;

- (void) getCharacters: (olchar*)buffer fromOffset: (unsigned)offset count: (unsigned)num;

- (unsigned) hash;

- (BOOL) isEqual: (id)object;

- (unsigned) length;

- (unsigned) maxSize;

- (uint8_t*) nullTerminatedBytesWithEncoding: (const char*)enc;

- (unsigned) rfindChar: (olchar)ch fromOffset: (unsigned)offset;

- (unsigned) size;

- (OLText*) substrFromOffset: (unsigned)offset count: (unsigned)num;

#if !defined(OL_NO_OPENSTEP)

- (NSString*) toNSString;
#endif

- (void) writeSelfToStream: (OLObjectOutStream*)stream;

@end

@interface OLTextBuffer :
#if defined(OL_NO_OPENSTEP)
    Object
#else
    NSObject <NSCopying>
#endif
{
@protected
    olchar*     begin;

    unsigned    size;

    unsigned    capacity;
}

+ (id) textBuffer;

+ (id) textBufferWithText: (OLText*)text;

/* @{ */

- (id) init;

- (id) initWithCapacity: (unsigned)cap;

- (id) initWithText: (OLText*)text;

#if defined(OL_NO_OPENSTEP)
- (id) free;
#else
- (void) dealloc;
#endif
/* @} */

- (OLTextBuffer*) appendChar: (olchar)ch;

- (OLTextBuffer*) appendChars: (const olchar*)chars fromOffset: (unsigned)offset count: (unsigned)num;

- (OLTextBuffer*) appendText: (OLText*)text;

- (OLTextBuffer*) appendTextBuffer: (OLTextBuffer*)buffer;

- (OLTextBuffer*) assignAt: (unsigned)index character: (olchar)ch;

- (olchar) at: (unsigned)index;

- (unsigned) capacity;

- (void) clear;

- (int) compare: (id)other;

#if defined(OL_NO_OPENSTEP)

- (id) copy;
#else

- (id) copyWithZone: (NSZone*)zone;
#endif

- (BOOL) empty;

- (OLTextBuffer*) eraseAt: (unsigned)index;

- (OLTextBuffer*) eraseFromOffset: (unsigned)offset count: (unsigned)num;

- (unsigned) findChar: (olchar)ch fromOffset: (unsigned)offset;

- (unsigned) findFirstNotOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findFirstOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findLastNotOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findLastOf: (OLText*)text fromOffset: (unsigned)offset;

- (unsigned) findText: (OLText*)text fromOffset: (unsigned)offset;

- (void) getCharacters: (olchar*)buffer fromOffset: (unsigned)offset count: (unsigned)num;

- (OLTextBuffer*) insertChar: (olchar)ch atOffset: (unsigned)offset;

- (OLTextBuffer*) insertChars: (const olchar*)chars atOffset: (unsigned)offset count: (unsigned)num;

- (OLTextBuffer*) insertText: (OLText*)text atOffset: (unsigned)offset;

- (BOOL) isEqual: (id)object;

- (unsigned) length;

- (OLTextBuffer*) replaceFromOffset: (unsigned)offset count: (unsigned)num withText: (OLText*)text;

- (void) reserve: (unsigned)cap;

- (OLTextBuffer*) resize: (unsigned)newLength filledWith: (olchar)ch;

- (OLTextBuffer*) reverse;

- (unsigned) rfindChar: (olchar)ch fromOffset: (unsigned)offset;

- (unsigned) size;

- (OLText*) substrFromOffset: (unsigned)offset count: (unsigned)num;

- (OLText*) text;

@end

#if defined(OL_NO_OPENSTEP)

@interface OLConstantString : Object
{
    char*       c_string;

    unsigned    len;
}

#if defined(__NEXT_RUNTIME__)

+ (id) class;

+ (void) load;
#endif

- (id) free;

#if defined(__NEXT_RUNTIME__)

- (id) class;
#endif

- (int) compare: (id)other;

- (id) copy;

- (const char*) cString;

- (unsigned) hash;

- (BOOL) isEqual: (id)other;

- (unsigned) length;

@end

#if defined(__NEXT_RUNTIME__)

extern struct objc_class _OLConstantStringClassReference;
#endif

#endif

#endif

---

Generated Sun Apr 22 15:17:59 2007, © 2004-2007 Will Mason