StringReader Struct Reference

#include <StringReader.h>

Overview

The StringReader type.

Definition at line 47 of file StringReader.h.

Inheritance diagram for StringReader:

Properties
char *	head
	The StringReader head. More...
Object	object
	The superclass. More...
String *	string
	The String to read. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_StringReader (void)
	The StringReader archetype. More...
StringReader *	initWithCharacters (StringReader *self, const char *chars)
	Initializes this StringReader with the specified C string. More...
StringReader *	initWithString (StringReader *self, String *string)
	Initializes this StringReader with the specified String. More...
Unicode	next (StringReader *self)
Unicode	next (StringReader *self, StringReaderMode mode)
	Consumes the next Unicode code point in this StringReader using the given mode. More...
Unicode	peek (StringReader *self)
	Peeks at the next Unicode code point from this StringReader without advancing head. More...
int	read (StringReader *self)
	Reads a single Unicode code point from this StringReader. More...
int	readToken (StringReader *self, const Unicode *charset, Unicode *stop)
String *	readToken (StringReader *self, const Unicode *charset, Unocide *stop)
	Reads characters from this StringReader until a character in charset is encountered. More...
void	reset (StringReader *self)
	Resets this StringReader, placing the head before the beginning of the String. More...
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

Protected Attributes
StringReaderInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

head

char* StringReader::head

The StringReader head.

Definition at line 63 of file StringReader.h.

interface

StringReaderInterface* StringReader::interface

protected

The interface.

Definition at line 58 of file StringReader.h.

object

Object StringReader::object

The superclass.

Definition at line 52 of file StringReader.h.

string

String* StringReader::string

(

void

)

The String to read.

Definition at line 68 of file StringReader.h.

Method Details

_StringReader()

Class * _StringReader

(

void

)

The StringReader archetype.

Returns

The StringReader Class.

Definition at line 192 of file StringReader.c.

                           {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "StringReader",
            .superclass = _Object(),
            .instanceSize = sizeof(StringReader),
            .interfaceOffset = offsetof(StringReader, interface),
            .interfaceSize = sizeof(StringReaderInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

initWithCharacters()

StringReader * initWithCharacters	(	StringReader *	self,
		const char *	chars
	)

Initializes this StringReader with the specified C string.

Parameters

self	The StringReader.
chars	The null-terminated C string to read.

Returns

The initialized StringReader, or NULL on error.

Definition at line 64 of file StringReader.c.

                                                                               {
 
    String *string = str(chars);
 
    self = $(self, initWithString, string);
 
    release(string);
 
    return self;
}

initWithString()

StringReader * initWithString	(	StringReader *	self,
		String *	string
	)

Initializes this StringReader with the specified String.

Parameters

self	The StringReader.
string	The String to read.

Returns

The initialized StringReader, or NULL on error.

Definition at line 79 of file StringReader.c.

                                                                        {
 
    self = (StringReader *) super(Object, self, init);
    if (self) {
        self->string = retain(string);
        $(self, reset);
    }
    return self;
}

next() [1/2]

Unicode next

(

StringReader *

self

)

next() [2/2]

Unicode next	(	StringReader *	self,
		StringReaderMode	mode
	)

Consumes the next Unicode code point in this StringReader using the given mode.

Parameters

self	The StringReader.
mode	The StringReaderMode.

Returns

The next Unicode code point, or -1 if the StringReader is exhausted.

Definition at line 93 of file StringReader.c.

                                                               {
    Unicode c;
 
    const int bytes = mbtowc(&c, self->head, MB_CUR_MAX);
    if (bytes > 0) {
        if (mode == StringReaderRead) {
            self->head += bytes;
        }
        return c;
    }
 
    return READER_EOF;
}

peek()

Unicode peek

(

StringReader *

self

)

Peeks at the next Unicode code point from this StringReader without advancing head.

Parameters

self	The StringReader.

Returns

The next Unicode code point, or -1 if the StringReader is exhausted.

Remarks

This method is shorthand for $(reader, next, StringReaderPeek).

Definition at line 111 of file StringReader.c.

                                        {
    return $(self, next, StringReaderPeek);
}

read()

Unicode read

(

StringReader *

self

)

Reads a single Unicode code point from this StringReader.

Parameters

self	The StringReader.

Returns

The Unicode code point, or -1 if the StringReader is exhausted.

Remarks

This method is shorthand for $(reader, next, StringReaderRead).

readToken() [1/2]

int readToken	(	StringReader *	self,
		const Unicode *	charset,
		Unicode *	stop
	)

Definition at line 127 of file StringReader.c.

                                                                                    {
 
    while (true) {
        const Unicode c = $(self, peek);
        if (c == READER_EOF || wcschr(charset, c) == NULL) {
            break;
        }
        $(self, read);
    }
 
    const char *start = self->head;
 
    while (true) {
        const Unicode c = $(self, peek);
        if (c == READER_EOF || wcschr(charset, c)) {
            if (stop) {
                *stop = c;
            }
            break;
        }
        $(self, read);
    }
 
    if (self->head - start > 0) {
        const Range range = {
            .location = start - self->string->chars,
            .length = self->head - start
        };
        return $(self->string, substring, range);
    }
 
    return NULL;
}

readToken() [2/2]

String * readToken	(	StringReader *	self,
		const Unicode *	charset,
		Unocide *	stop
	)

Reads characters from this StringReader until a character in charset is encountered.

Parameters

self	The StringReader.
charset	The array of potential stop characters.
stop	Optionally returns the stop character from charset.

Returns

The token accumulated before stop, or NULL if the StringReader is exhausted.

reset()

void reset

(

StringReader *

self

)

Resets this StringReader, placing the head before the beginning of the String.

Parameters

self	The StringReader.

Definition at line 165 of file StringReader.c.

                                      {
    self->head = self->string->chars;
}

---

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

• Sources/Objectively/StringReader.h
• Sources/Objectively/StringReader.c