Date Struct Reference

#include <Date.h>

Overview

Microsecond-precision immutable dates.

Definition at line 70 of file Date.h.

Inheritance diagram for Date:

Properties
Object	object
	The superclass. More...
Time	time
	The time. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_Date (void)
	The Date archetype. More...
Order	compareTo (const Date *self, const Date *other)
	Compares this Date to another. More...
Date *	date (void)
	Returns a new Date with the current Time. More...
Date *	dateWithTimeSinceNow (const Time interval)
	Returns a new Date with the given Time since now. More...
Date *	init (Date *self)
Date *	initWithTime (Date *self, const Time *time)
Time	timeSinceDate (const Date *self, const Date *date)
Time	timeSinceNow (const Date *self)
Time	timeSinceTime (const Date *self, const Time *time)
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
DateInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

interface

DateInterface* Date::interface

protected

The interface.

Definition at line 81 of file Date.h.

object

Object Date::object

The superclass.

Definition at line 75 of file Date.h.

time

Time Date::time

The time.

Definition at line 86 of file Date.h.

Method Details

_Date()

Class * _Date

(

void

)

The Date archetype.

Returns

The Date Class.

Definition at line 222 of file Date.c.

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

compareTo()

Order compareTo	(	const Date *	self,
		const Date *	other
	)

Compares this Date to another.

Parameters

self	The Date.
other	The Date to compare to.

Returns

The ordering of this Date compared to other.

Definition at line 74 of file Date.c.

                                                            {
 
    if (other) {
        const long seconds = self->time.tv_sec - other->time.tv_sec;
        if (seconds == 0) {
 
            const long microseconds = self->time.tv_usec - other->time.tv_usec;
            if (microseconds == 0) {
                return OrderSame;
            }
 
            return microseconds < 0 ? OrderAscending : OrderDescending;
        }
 
        return seconds < 0 ? OrderAscending : OrderDescending;
    }
 
    return OrderAscending;
}

date()

Date * date

(

void

)

Returns a new Date with the current Time.

Returns

The new Date, or NULL on error.

Definition at line 98 of file Date.c.

                        {
 
    return $$(Date, dateWithTimeSinceNow, NULL);
}

dateWithTimeSinceNow()

Date * dateWithTimeSinceNow

(

const Time

interval

)

Returns a new Date with the given Time since now.

Returns

The new Date, or NULL on error.

init()

Date * init

(

Date *

self

)

Initializes a Date with the current time.

Parameters

self

The Date.

Returns

The initialized Date, or NULL on error.

Definition at line 131 of file Date.c.

                              {
    return $(self, initWithTime, NULL);
}

initWithTime()

Date * initWithTime	(	Date *	self,
		const Time *	time
	)

Initializes a Date with the specified time.

Parameters

self	The Date.
time	The desired Time.

Returns

The initialized Date, or NULL on error.

Definition at line 139 of file Date.c.

                                                        {
 
    self = (Date *) super(Object, self, init);
    if (self) {
        if (time) {
            self->time = *time;
        } else {
            gettimeofday(&self->time, NULL);
        }
    }
 
    return self;
}

timeSinceDate()

Time timeSinceDate	(	const Date *	self,
		const Date *	date
	)

Parameters

self	The Date.
date	The Date from whence to return a Time delta.

Returns

The interval between this Date and date.

Remarks

If date is earlier than this Date, the returned interval will be negative.

Definition at line 157 of file Date.c.

                                                              {
 
    assert(date);
 
    return $(self, timeSinceTime, &date->time);
}

timeSinceNow()

Time timeSinceNow

(

const Date *

self

)

Parameters

self

The Date.

Returns

The interval between this Date and the current date.

Remarks

If this Date is later than the current date, the returned interval will be negative.

Definition at line 168 of file Date.c.

                                           {
 
    Date *date = $$(Date, date);
 
    Time time = $(self, timeSinceDate, date);
 
    release(date);
 
    return time;
}

timeSinceTime()

Time timeSinceTime	(	const Date *	self,
		const Time *	time
	)

Parameters

self	The Date.
time	A Time value.

Returns

The interval between this Date and time.

Remarks

If time is earlier than this Date, the returned interval will be negative.

Definition at line 183 of file Date.c.

                                                              {
 
    Time delta = {
        .tv_sec = self->time.tv_sec - time->tv_sec,
        .tv_usec = self->time.tv_usec - time->tv_usec
    };
 
    if (delta.tv_usec < 0) {
        delta.tv_sec--;
        delta.tv_usec += MSEC_PER_SEC;
    }
 
    return delta;
}

---

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

• Sources/Objectively/Date.h
• Sources/Objectively/Date.c