String.h

Go to the documentation of this file.

/*
 * Objectively: Ultra-lightweight object oriented framework for GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <ctype.h>
#include <wctype.h>
#include <stdarg.h>
 
#include <Objectively/Array.h>
#include <Objectively/Data.h>
 
typedef wchar_t Unicode;
 
typedef enum {
    STRING_ENCODING_ASCII = 1,
    STRING_ENCODING_LATIN1,
    STRING_ENCODING_LATIN2,
    STRING_ENCODING_MACROMAN,
    STRING_ENCODING_UTF16,
    STRING_ENCODING_UTF32,
    STRING_ENCODING_UTF8,
    STRING_ENCODING_WCHAR,
} StringEncoding;
 
typedef struct StringInterface StringInterface;
 
struct String {
 
    Object object;
 
    StringInterface *interface;
 
    char *chars;
 
    size_t length;
};
 
typedef struct MutableString MutableString;
 
struct StringInterface {
 
    ObjectInterface objectInterface;
 
    Order (*compareTo)(const String *self, const String *other, const Range range);
 
    Array *(*componentsSeparatedByCharacters)(const String *self, const char *chars);
 
    Array *(*componentsSeparatedByString)(const String *self, const String *string);
 
    Data *(*getData)(const String *self, StringEncoding encoding);
 
    _Bool (*hasPrefix)(const String *self, const String *prefix);
 
    _Bool (*hasSuffix)(const String *self, const String *suffix);
 
    String *(*initWithBytes)(String *self, const uint8_t *bytes, size_t length, StringEncoding encoding);
 
    String *(*initWithCharacters)(String *self, const char *chars);
 
    String *(*initWithContentsOfFile)(String *self, const char *path, StringEncoding encoding);
 
    String *(*initWithData)(String *self, const Data *data, StringEncoding encoding);
 
    String *(*initWithFormat)(String *self, const char *fmt, ...);
 
    String *(*initWithMemory)(String *self, const ident mem, size_t length);
 
    String *(*initWithVaList)(String *self, const char *fmt, va_list args);
 
    String *(*lowercaseString)(const String *self);
 
    MutableString *(*mutableCopy)(const String *self);
 
    Range (*rangeOfCharacters)(const String *self, const char *chars, const Range range);
 
    Range (*rangeOfString)(const String *self, const String *string, const Range range);
 
    String *(*stringWithBytes)(const uint8_t *bytes, size_t length, StringEncoding encoding);
 
    String *(*stringWithCharacters)(const char *chars);
 
    String *(*stringWithContentsOfFile)(const char *path, StringEncoding encoding);
 
    String *(*stringWithData)(const Data *data, StringEncoding encoding);
 
    String *(*stringWithFormat)(const char *fmt, ...);
 
    String *(*stringWithMemory)(const ident mem, size_t length);
 
    String *(*substring)(const String *self, const Range range);
 
    String *(*trimmedString)(const String *self);
 
    String *(*uppercaseString)(const String *self);
 
    _Bool (*writeToFile)(const String *self, const char *path, StringEncoding encoding);
};
 
OBJECTIVELY_EXPORT Class *_String(void);
 
OBJECTIVELY_EXPORT const char *NameForStringEncoding(StringEncoding encoding);
 
OBJECTIVELY_EXPORT StringEncoding StringEncodingForName(const char *name);
 
OBJECTIVELY_EXPORT Order StringCompare(const ident a, const ident b);
 
OBJECTIVELY_EXPORT String *str(const char *fmt, ...);
 
OBJECTIVELY_EXPORT char *strtrim(const char *s);