path: root/src/tm.c

#include "date.h"

// wrappers around struct tm

static JanetMethod jd_tm_methods[] = {
	// raw mktime, returning time_t
	{"mktime",     jd_mktime},
	{"mktime!",    jd_mktime_inplace},
	{"timegm",     jd_timegm},
	{"timegm!",    jd_timegm_inplace},
	{"strftime",   jd_strftime},
	{NULL, NULL},
};

// WARNING: this only works if they're BOTH localtime or gmtime
static int jd_tm_compare(void *lhs, void *rhs) {
	struct tm lhp = (*(struct tm*)lhs);
	struct tm rhp = (*(struct tm*)rhs);
	time_t lhv = mktime(&lhp);
	time_t rhv = mktime(&rhp);
	return difftime(lhv, rhv);
}

// C99 specifies ALL fields to be int
struct jd_tm_key {
	const char  *key;
	const size_t off;
};
static const struct jd_tm_key jd_tm_keys[] = {
	{"sec",   offsetof(struct tm, tm_sec)},
	{"min",   offsetof(struct tm, tm_min)},
	{"hour",  offsetof(struct tm, tm_hour)},
	{"mday",  offsetof(struct tm, tm_mday)},
	{"mon",   offsetof(struct tm, tm_mon)},
	{"year",  offsetof(struct tm, tm_year)},
	{"wday",  offsetof(struct tm, tm_wday)},
	{"yday",  offsetof(struct tm, tm_yday)},
	{"isdst", offsetof(struct tm, tm_isdst)},
#ifdef TM_GMTOFF
	{"gmtoff", offsetof(struct tm, TM_GMTOFF)},
#endif
#ifdef TM_ZONE
	{"zone", offsetof(struct tm, TM_ZONE)},
#endif
	{NULL, 0},
};

static int jd_tm_get(void *p, Janet key, Janet *out) {
	if (!janet_checktype(key, JANET_KEYWORD)) {
		return 0;
	}

	// is it a method?
	if(janet_getmethod(janet_unwrap_keyword(key), jd_tm_methods, out)) {
		return 1;
	}

	const struct jd_tm_key *ptr = jd_tm_keys;
	while (ptr->key) {
		if (janet_keyeq(key, ptr->key)) {
#ifdef TM_GMTOFF
			if (janet_keyeq(key, "gmtoff")) {
				long val = *((long*)(p + ptr->off));
				*out = janet_wrap_s64(val);
				return 1;
			}
#endif
#ifdef TM_ZONE
			if (janet_keyeq(key, "zone")) {
				const char *val = *((const char **)(p + ptr->off));
				*out = janet_ckeywordv(val);
				return 1;
			}
#endif

			int val = *((int*)((unsigned char*)p + ptr->off));

			// exceptional values
			if (janet_keyeq(key, "year")) {
				val += 1900;
			} else if (janet_keyeq(key, "isdst")) {
				*out = val ? (val > 0 ? janet_wrap_true() : janet_ckeywordv("detect")) : janet_wrap_false();
				return 1;
			}

			*out = janet_wrap_integer(val);
			return 1;
		}
		ptr++;
	}

	return janet_checktype(*out, JANET_NIL);
}
static Janet jd_tm_next(void *p, Janet key) {
	(void) p;
	const struct jd_tm_key *ptr = jd_tm_keys;
	while (ptr->key) {
		if (janet_keyeq(key, ptr->key)) {
			return (++ptr)->key ? janet_ckeywordv(ptr->key) : janet_wrap_nil();
		}
		ptr++;
	}
	return janet_ckeywordv(jd_tm_keys[0].key);
}

static void jd_tm_put(void *data, Janet key, Janet value) {
	if (0
#ifdef TM_GMTOFF
		|| janet_keyeq(key, "gmtoff")
#endif
#ifdef TM_ZONE
		|| janet_keyeq(key, "zone")
#endif
	   ) {
		janet_panicf("%s is read-only", key);
	}
	// note that keyword, boolean are only valid for isdst
	if (!janet_checktypes(value, JANET_TFLAG_NUMBER | JANET_TFLAG_KEYWORD | JANET_TFLAG_BOOLEAN)) {
		janet_panicf("expected function or number, got %t", value);
	}
	const struct jd_tm_key *ptr = jd_tm_keys;
	while (ptr->key) {
		if (janet_keyeq(key, ptr->key)) {
			int *loc = (int*)((unsigned char*)data + ptr->off);
			if (janet_keyeq(key, "year")) {
				*loc = janet_unwrap_integer(value) - 1900;
			} else if (janet_keyeq(key, "isdst")) {
				*loc = janet_keyeq(value, "detect") ? -1 : (janet_truthy(value) ? 1 : 0);
			} else {
				*loc = janet_unwrap_integer(value);
			}
			return;
		}
		ptr++;
	}

	// do not fail in case someone tries to write an invalid field
	// people may want to write to gmtoff (for example) on a platform where that
	// doesn't exist, and this should not conditionally fail on some platforms
	// instead, silently do nothing
	return;
}

#define MAX_INT_STRLEN 1024
static void jd_tm_tostring(void *p, JanetBuffer *buffer) {
	janet_buffer_push_cstring(buffer, "{");
	char buf[MAX_INT_STRLEN];

	const struct jd_tm_key *ptr = jd_tm_keys;
	while (ptr->key) {
		void *loc = (void*)((unsigned char*)p + ptr->off);
		janet_buffer_push_cstring(buffer, ":");
		janet_buffer_push_cstring(buffer, ptr->key);
		janet_buffer_push_cstring(buffer, " ");

		// exceptional values
		if (!strcmp(ptr->key, "year")) {
			snprintf(buf, MAX_INT_STRLEN, "%d", *(int*)loc + 1900);
		} else if (!strcmp(ptr->key, "isdst")) {
			strcpy(buf, *(int*)loc ? (*(int*)loc > 0 ? "true" : ":detect") : "false");
#ifdef TM_ZONE
		} else if (!strcmp(ptr->key, "zone")) {
			char *zone = *(char**)loc;
			if (zone) {
				buf[0] = ':';
				strcpy(buf+1, zone);
			} else {
				strcpy(buf, "\"\"");
			}
#endif
#ifdef TM_GMTOFF
		} else if (!strcmp(ptr->key, "gmtoff")) {
			snprintf(buf, MAX_INT_STRLEN, "%ld", *(long*)loc);
#endif
		} else {
			snprintf(buf, MAX_INT_STRLEN, "%d", *(int*)loc);
		}
		janet_buffer_push_cstring(buffer, buf);

		if ((++ptr)->key) janet_buffer_push_cstring(buffer, " ");
	}

	janet_buffer_push_cstring(buffer, "}");
}

static const JanetAbstractType jd_tm_t = {
	"date/tm",
	NULL,
	NULL,
	jd_tm_get,
	jd_tm_put,
	NULL,
	NULL,
	jd_tm_tostring,
	jd_tm_compare,
	NULL,
	jd_tm_next,
	JANET_ATEND_NEXT
};

struct tm *jd_gettm(Janet *argv, int32_t n) {
	return (struct tm*)janet_getabstract(argv, n, &jd_tm_t);
}

struct tm *jd_maketm(void) {
	return janet_abstract(&jd_tm_t, sizeof(struct tm));
}

struct tm *jd_opttm(Janet *argv, int32_t argc, int32_t n) {
    if (n >= argc || janet_checktype(argv[n], JANET_NIL)) {
		return NULL;
	}
	return jd_gettm(argv, n);
}

JANET_FN(jd_tm,
		"(tm {:sec 0 ...})",
		"Construct a date/tm object from a compatible dictionary.") {
	janet_fixarity(argc, 1);
	JanetDictView view = janet_getdictionary(argv, 0);

	struct tm *out = jd_maketm();
	memset(out, 0, sizeof(struct tm));
#ifdef TM_GMTOFF
	out->TM_GMTOFF = 0;
#endif

	for (int32_t i = 0; i < view.cap; i++) {
		const JanetKV e = view.kvs[i];
		if (!janet_truthy(e.key)) continue;
		const struct jd_tm_key *ptr = jd_tm_keys;
		while (ptr->key) {
			if (janet_keyeq(e.key, ptr->key)) {
				int *target  = (int*)((unsigned char*)out + ptr->off);

				// exceptional values
				if (!strcmp(ptr->key, "year")) {
					*target = janet_unwrap_integer(e.value) - 1900;
#ifdef TM_ZONE
				} else if (!strcmp(ptr->key, "zone")) {
					janet_panic("cannot set zone name");
#endif
#ifdef TM_GMTOFF
				} else if (!strcmp(ptr->key, "gmtoff")) {
					janet_panic("cannot set gmt offset");
#endif
				} else if (!strcmp(ptr->key, "isdst")) {
					*target = janet_keyeq(e.value, "detect") ? -1 : (janet_truthy(e.value) ? 1 : 0);
				} else {
					*target = janet_unwrap_integer(e.value);
				}
				break;
			}
			ptr++;
		}
	}
	return janet_wrap_abstract(out);
}

JANET_FN(jd_mktime,
		"(mktime tm)",
		"Convert a date/tm object as localtime to a normalized date/time object.") {
	janet_fixarity(argc, 1);
	struct tm *tm = jd_gettm(argv, 0);
	struct tm *nw = jd_maketm();
	*nw = *tm;
	time_t *time = jd_maketime();
	*time = mktime(nw);
	return janet_wrap_abstract(time);
}

JANET_FN(jd_mktime_inplace,
		"(mktime! tm)",
		"Convert a date/tm object as localtime to a normalized date/time object.\n"
		"The date/tm object will be normalized in-place via mutation.") {
	janet_fixarity(argc, 1);
	struct tm *tm = jd_gettm(argv, 0);
	time_t *time = jd_maketime();
	*time = mktime(tm);
	return janet_wrap_abstract(time);
}

JANET_FN(jd_timegm,
		"(timegm tm)",
		"Convert a date/tm object as UTC to a normalized date/time object.") {
	janet_fixarity(argc, 1);
	struct tm *tm = jd_gettm(argv, 0);
	struct tm *nw = jd_maketm();
	*nw = *tm;
	time_t *time = jd_maketime();
	*time = timegm(nw);
	return janet_wrap_abstract(time);
}

JANET_FN(jd_timegm_inplace,
		"(timegm! tm)",
		"Convert a date/tm object as UTC to a normalized date/time object.\n"
		"The date/tm object will be normalized in-place via mutation.") {
	janet_fixarity(argc, 1);
	struct tm *tm = jd_gettm(argv, 0);
	time_t *time = jd_maketime();
	*time = timegm(tm);
	return janet_wrap_abstract(time);
}

// strftime
struct strftime_format {
	const char *keyword;
	const char *format;
};
const static struct strftime_format strftime_formats[] = {
	/* :iso8601* based on ISO 8601:2004(E)
	 * All in basic format except unqualified :iso8601 which is in extended
	 * format (minus %z). The specification does not specify if mixing extended
	 * and basic formats is allowed, so we interpret it to be valid.
	 *
	 * We treat all inputs as local time with difference from UTC, since we have
	 * no easy way of knowing. This is technically non-compliant, but I think it
	 * can be forgiven, since we are otherwise compliant to 4.2.5.2 (basic).
	 */
	{"iso8601-calendar", "%Y%m%dT%H%M%S%z"},  // calendar date
	{"iso8601-ordinal",  "%Y%jT%H%M%S%z"},    // ordinal date: day-of-year
	{"iso8601-week",     "%YW%U%wT%H%M%S%z"}, // week date: week-of-year, weekday
	// same as -calendar but extended format (except for %z)
	{"iso8601",          "%FT%T%z"},
	/* :rfc3339 based on RFC 3339
	 * RFC 3339 is essentially an ISO 8601 profile with clarifications.
	 * As such, the non-compliance we have against ISO 8601 applies here.
	 *
	 * Additionally, RFC 3339 requires that the UTC offset contain a ":",
	 * (i.e the extended format is required) so we are also non-compliant there.
	 */
	{"rfc3339", "%F %T%z"},
	/* :html based on Dates and Times Microsyntaxes of WHATWG
	 * This impementation is fully compliant.
	 */
	{"html", "%F %T%z"},
	/* :email, :rfc5321, :rfc5322, :internet based on RFC 5322 #3.3
	 * They are all identical.
	 * This implementation is fully compliant.
	 * Note that according to the spec, these should be used against localtime.
	 * Additionally, note that the below are locale-dependent.
	 */
	{"email",    "%a, %d %b %Y %H:%M:%S %z"},
	{"rfc5321",  "%a, %d %b %Y %H:%M:%S %z"},
	{"rfc5322",  "%a, %d %b %Y %H:%M:%S %z"},
	{"internet", "%a, %d %b %Y %H:%M:%S %z"},
	// system/locale default format
	{"default", "%c"},
	{NULL, NULL},
};
JANET_FN(jd_strftime,
		"(strftime tm \"%c\")\n"
		"(strftime tm :iso8601)",
		"Format a string from the date/tm object.\n"
		"Has available preset formats.\n"
		"Note that some platforms may potentially treat tm as localtime.") {
	janet_fixarity(argc, 2);
	// tm is first for pseudo-OO
	struct tm *tm = jd_gettm(argv, 0);

	// determine format
	const char *format = NULL;

	// is it a preset?
	if (janet_checktype(argv[1], JANET_KEYWORD)) {
		const struct strftime_format *ptr = strftime_formats;
		while (ptr->keyword) {
			if (janet_keyeq(argv[1], ptr->keyword)) {
				format = ptr->format;
				break;
			}
			ptr++;
		}
	}

	// preset not found
	if (!format) format = janet_getcbytes(argv, 1);
	return janet_wrap_buffer(strftime_buffer(format, tm, NULL));
}

void jd_tm_register(JanetTable *env, const char *regprefix) {
	const JanetRegExt cfuns[] = {
		JANET_REG("tm",       jd_tm),
		JANET_REG("mktime",   jd_mktime),
		JANET_REG("mktime!",  jd_mktime_inplace),
		JANET_REG("timegm",   jd_timegm),
		JANET_REG("timegm!",  jd_timegm_inplace),
		JANET_REG("strftime", jd_strftime),
		JANET_REG_END
	};
	janet_cfuns_ext(env, regprefix, cfuns);
}