URL Struct Reference

#include <URL.h>

Overview

Uniform Resource Locators (RFC 3986).

See also

http://www.ietf.org/rfc/rfc3986.txt

Definition at line 44 of file URL.h.

Inheritance diagram for URL:

Properties
String *	fragment
	The fragment. More...
String *	host
	The host. More...
Object	object
	The superclass. More...
String *	path
	The path. More...
unsigned short	port
	The port. More...
String *	query
	The query. More...
String *	scheme
	The scheme, or protocol. More...
String *	urlString
	The URL String. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_URL (void)
	The URL archetype. More...
URL *	baseURL (const URL *self)
URL *	initWithCharacters (URL *self, const char *chars)
	Initializes this URL with the specified characters. More...
URL *	initWithString (URL *self, const String *string)
	Initializes this URL with the specified String. More...
Array *	pathComponents (const URL *self)
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
URLInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

fragment

String* URL::fragment

The fragment.

Definition at line 60 of file URL.h.

host

String* URL::host

The host.

Definition at line 65 of file URL.h.

interface

URLInterface* URL::interface

protected

The interface.

Definition at line 55 of file URL.h.

object

Object URL::object

The superclass.

Definition at line 49 of file URL.h.

path

String* URL::path

The path.

Definition at line 70 of file URL.h.

port

unsigned short URL::port

The port.

Definition at line 75 of file URL.h.

query

String* URL::query

The query.

Definition at line 80 of file URL.h.

scheme

String* URL::scheme

The scheme, or protocol.

Definition at line 85 of file URL.h.

urlString

String* URL::urlString

The URL String.

Definition at line 90 of file URL.h.

Method Details

_URL()

Class * _URL

(

void

)

The URL archetype.

Returns

The URL Class.

Definition at line 248 of file URL.c.

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

baseURL()

URL * baseURL

(

const URL *

self

)

Parameters

self

The URL.

Returns

The base URL (scheme, host, and port) of this URL.

Definition at line 108 of file URL.c.

                                     {
 
    MutableString *string = $(alloc(MutableString), init);
 
    $(string, appendString, self->scheme);
    $(string, appendFormat, "://");
 
    if (self->host) {
        $(string, appendString, self->host);
    }
 
    if (self->port) {
        $(string, appendFormat, ":%u", self->port);
    }
 
    URL *baseURL = $(alloc(URL), initWithString, (String *) string);
 
    release(string);
 
    return baseURL;
}

initWithCharacters()

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

Initializes this URL with the specified characters.

Parameters

self	The URL.
chars	The URL characters.

Returns

The initialized URL, or NULL on error.

Definition at line 136 of file URL.c.

                                                             {
 
    assert(chars);
 
    self = (URL *) super(Object, self, init);
    if (self) {
 
        Range *ranges;
        if ($(_re, matchesCharacters, chars, 0, &ranges)) {
 
            self->urlString = $(alloc(String), initWithCharacters, chars);
 
            Range *scheme = &ranges[1];
            Range *host = &ranges[2];
            Range *port = &ranges[3];
            Range *path = &ranges[4];
            Range *query = &ranges[5];
            Range *fragment = &ranges[6];
 
            self->scheme = $(self->urlString, substring, *scheme);
 
            if (host->location > -1) {
                self->host = $(self->urlString, substring, *host);
 
                if (port->location > -1) {
                    const char *s = self->urlString->chars + port->location + 1;
                    self->port = strtoul(s, NULL, 10);
                }
            }
 
            if (path->location > -1) {
                self->path = $(self->urlString, substring, *path);
            }
 
            if (query->location > -1) {
 
                query->location++;
                query->length--;
 
                self->query = $(self->urlString, substring, *query);
            }
 
            if (fragment->location > -1) {
 
                fragment->location++;
                fragment->length--;
 
                self->fragment = $(self->urlString, substring, *fragment);
            }
 
            free(ranges);
        } else {
            self = release(self);
        }
    }
 
    return self;
}

initWithString()

URL * initWithString	(	URL *	self,
		const String *	string
	)

Initializes this URL with the specified String.

Parameters

self	The URL.
string	The URL String.

Returns

The initialized URL, or NULL on error.

Definition at line 199 of file URL.c.

                                                            {
 
    assert(string);
 
    return $(self, initWithCharacters, string->chars);
}

pathComponents()

Array * pathComponents

(

const URL *

self

)

Parameters

self

The URL.

Returns

The path components of this URL.

Definition at line 210 of file URL.c.

                                              {
 
    return $(self->path, componentsSeparatedByCharacters, "/");
}

---

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

• Sources/Objectively/URL.h
• Sources/Objectively/URL.c