DateFormatter Struct Reference

#include <DateFormatter.h>

Overview

Date formatting and parsing.

Definition at line 48 of file DateFormatter.h.

Inheritance diagram for DateFormatter:

Properties
const char *	fmt
	The UTF-8 encoded format string.
Object	object
	The superclass.
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_DateFormatter (void)
	The DateFormatter archetype.
Date *	dateFromCharacters (const DateFormatter *self, const char *chars)
	Parses a Date from the specified UTF-8 encoded C string.
Date *	dateFromString (const DateFormatter *self, const String *string)
	Parses a Date from the specified String.
DateFormatter *	initWithFormat (DateFormatter *self, const char *fmt)
	Initializes a DateFormatter with the specified format string.
String *	stringFromDate (const DateFormatter *self, const Date *date)
	Yields a String representation of the specified Date instance.
Methods inherited from Object
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
DateFormatterInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

fmt

const char* DateFormatter::fmt

The UTF-8 encoded format string.

Definition at line 64 of file DateFormatter.h.

interface

DateFormatterInterface* DateFormatter::interface

protected

The interface.

Definition at line 59 of file DateFormatter.h.

object

Object DateFormatter::object

The superclass.

Definition at line 53 of file DateFormatter.h.

Method Details

_DateFormatter()

Class * _DateFormatter

(

void

)

The DateFormatter archetype.

Returns

The DateFormatter Class.

Definition at line 132 of file DateFormatter.c.

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

dateFromCharacters()

Date * dateFromCharacters	(	const DateFormatter *	self,
		const char *	chars
	)

Parses a Date from the specified UTF-8 encoded C string.

Parameters

self	The DateFormatter.
chars	The UTF-8 encoded C string to parse.

Returns

A Date instance, or NULL on error.

Definition at line 40 of file DateFormatter.c.

                                                                              {
 
#if defined(_WIN32)
  fprintf(stderr, "WARNING: %s: not implemented (Windows)\n", __func__);
#else
  if (chars) {
    struct tm time;
 
    const char *res = strptime(chars, self->fmt, &time);
    if (res) {
      const Time t = { .tv_sec = mktime(&time) };
      return $(alloc(Date), initWithTime, &t);
    }
  }
#endif
 
  return NULL;
}

dateFromString()

Date * dateFromString	(	const DateFormatter *	self,
		const String *	string
	)

Parses a Date from the specified String.

Parameters

self	The DateFormatter.
string	The String to parse.

Returns

A Date instance, or NULL on error.

Definition at line 63 of file DateFormatter.c.

                                                                             {
 
  if (string) {
    return $(self, dateFromCharacters, string->chars);
  }
 
  return NULL;
}

initWithFormat()

DateFormatter * initWithFormat	(	DateFormatter *	self,
		const char *	fmt
	)

Initializes a DateFormatter with the specified format string.

Parameters

self	The DateFormatter.
fmt	The format string.

Returns

The initialized DateFormatter, or NULL on error.

Definition at line 76 of file DateFormatter.c.

                                                                           {
 
  self = (DateFormatter *) super(Object, self, init);
  if (self) {
    self->fmt = fmt ?: DATEFORMAT_ISO8601;
  }
 
  return self;
}

stringFromDate()

String * stringFromDate	(	const DateFormatter *	self,
		const Date *	date
	)

Yields a String representation of the specified Date instance.

Parameters

self	The DateFormatter.
date	The Date to format.

Returns

The String representation of the Date, or NULL on error.

Definition at line 90 of file DateFormatter.c.

                                                                           {
 
  const time_t seconds = date->time.tv_sec;
  struct tm time;
 
#if defined(_WIN32)
  int err = localtime_s(&time, &seconds);
  assert(err == 0);
#else
  ident res = localtime_r(&seconds, &time);
  assert(res == &time);
#endif
 
  char *str = calloc(1024, sizeof(char));
  assert(str);
 
  const size_t length = strftime(str, 1024, self->fmt, &time);
  str = realloc(str, length + 1 * sizeof(char));
  assert(str);
 
  return $(alloc(String), initWithMemory, str, length);
}

---

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

• Sources/Objectively/DateFormatter.h
• Sources/Objectively/DateFormatter.c