timestamp.h

Go to the documentation of this file.

/*
 * Present - Date/Time Library
 *
 * Definition of the Timestamp structure and declarations of the corresponding
 * functions
 *
 * This file may be included individually ONLY if being used by a C compiler.
 * However, it is recommended (and required for C++ projects) to include
 * "present.h" rather than these individual header files.
 *
 * Licensed under the MIT License.
 * For details, see LICENSE.
 */

#include <time.h>

#include "present/internal/cpp-guard.h"
#include "present/internal/header-utils.h"
#include "present/internal/types.h"

#include "present/internal/present-timestamp-data.h"

#ifndef _PRESENT_TIMESTAMP_H_
#define _PRESENT_TIMESTAMP_H_

/*
 * Forward Declarations
 */

struct ClockTime;
struct Date;
struct MonthDelta;
struct TimeDelta;

/*
 * C++ Class / C Struct Definition
 */

struct PRESENT_API Timestamp {
    present_bool has_error;

    struct {
        unsigned int invalid_clock_time : 1,
                     invalid_date       : 1;
    } errors;

    /* Internal data representation */
    struct PresentTimestampData data_;

#ifdef __cplusplus

    static Timestamp create(const time_t time);

    static Timestamp create(
        const struct tm & tm,
        const TimeDelta & time_zone_offset);
    static Timestamp create_utc(const struct tm & tm);
    static Timestamp create_local(const struct tm & tm);

    static Timestamp create(
        const Date & date,
        const ClockTime & clock_time,
        const TimeDelta & time_zone_offset);
    static Timestamp create_utc(
            const Date & date,
            const ClockTime & clock_time);
    static Timestamp create_local(
        const Date & date,
        const ClockTime & clock_time);

    static Timestamp now();

    static Timestamp epoch();

    time_t get_time_t() const;

    struct tm get_struct_tm(const TimeDelta & time_zone_offset) const;
    struct tm get_struct_tm_utc() const;
    struct tm get_struct_tm_local() const;

    Date get_date(const TimeDelta & time_zone_offset) const;
    Date get_date_utc() const;
    Date get_date_local() const;

    ClockTime get_clock_time(const TimeDelta & time_zone_offset) const;
    ClockTime get_clock_time_utc() const;
    ClockTime get_clock_time_local() const;

    TimeDelta difference(const Timestamp & other) const;
    TimeDelta absolute_difference(const Timestamp & other) const;

    Timestamp & operator+=(const TimeDelta & delta);
    Timestamp & operator+=(const DayDelta & delta);
    Timestamp & operator+=(const MonthDelta & delta);
    Timestamp & operator-=(const TimeDelta & delta);
    Timestamp & operator-=(const DayDelta & delta);
    Timestamp & operator-=(const MonthDelta & delta);

    friend const Timestamp operator+(
            const Timestamp & lhs,
            const TimeDelta & rhs);
    friend const Timestamp operator+(
            const TimeDelta & lhs,
            const Timestamp & rhs);

    friend const Timestamp operator+(
            const Timestamp & lhs,
            const DayDelta & rhs);
    friend const Timestamp operator+(
            const DayDelta & lhs,
            const Timestamp & rhs);

    friend const Timestamp operator+(
            const Timestamp & lhs,
            const MonthDelta & rhs);
    friend const Timestamp operator+(
            const MonthDelta & lhs,
            const Timestamp & rhs);

    friend const Timestamp operator-(
            const Timestamp & lhs,
            const TimeDelta & rhs);

    friend const Timestamp operator-(
            const Timestamp & lhs,
            const DayDelta & rhs);

    friend const Timestamp operator-(
            const Timestamp & lhs,
            const MonthDelta & rhs);

    static short compare(const Timestamp & lhs, const Timestamp & rhs);

    friend bool operator==(const Timestamp & lhs, const Timestamp & rhs);
    friend bool operator!=(const Timestamp & lhs, const Timestamp & rhs);

    friend bool operator<(const Timestamp & lhs, const Timestamp & rhs);
    friend bool operator<=(const Timestamp & lhs, const Timestamp & rhs);
    friend bool operator>(const Timestamp & lhs, const Timestamp & rhs);
    friend bool operator>=(const Timestamp & lhs, const Timestamp & rhs);
#endif
};

/*
 * C Method Declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

PRESENT_API struct Timestamp
Timestamp_from_time_t(const time_t time);

PRESENT_API void
Timestamp_ptr_from_time_t(
        struct Timestamp * const result,
        const time_t time);


PRESENT_API struct Timestamp
Timestamp_from_struct_tm(
        const struct tm tm,
        const struct TimeDelta * const time_zone_offset);

PRESENT_API void
Timestamp_ptr_from_struct_tm(
        struct Timestamp * const result,
        const struct tm tm,
        const struct TimeDelta * const time_zone_offset);

PRESENT_API struct Timestamp
Timestamp_from_struct_tm_utc(const struct tm tm);

PRESENT_API void
Timestamp_ptr_from_struct_tm_utc(
        struct Timestamp * const result,
        const struct tm tm);

PRESENT_API struct Timestamp
Timestamp_from_struct_tm_local(const struct tm tm);

PRESENT_API void
Timestamp_ptr_from_struct_tm_local(
        struct Timestamp * const result,
        const struct tm tm);


PRESENT_API struct Timestamp
Timestamp_create(
        const struct Date * const date,
        const struct ClockTime * const clock_time,
        const struct TimeDelta * const time_zone_offset);

PRESENT_API void
Timestamp_ptr_create(
        struct Timestamp * const result,
        const struct Date * const date,
        const struct ClockTime * const clock_time,
        const struct TimeDelta * const time_zone_offset);

PRESENT_API struct Timestamp
Timestamp_create_utc(
        const struct Date * const date,
        const struct ClockTime * const clock_time);

PRESENT_API void
Timestamp_ptr_create_utc(
        struct Timestamp * const result,
        const struct Date * const date,
        const struct ClockTime * const clock_time);

PRESENT_API struct Timestamp
Timestamp_create_local(
        const struct Date * const date,
        const struct ClockTime * const clock_time);

PRESENT_API void
Timestamp_ptr_create_local(
        struct Timestamp * const result,
        const struct Date * const date,
        const struct ClockTime * const clock_time);


PRESENT_API struct Timestamp
Timestamp_now(void);

PRESENT_API void
Timestamp_ptr_now(struct Timestamp * const result);

PRESENT_API struct Timestamp
Timestamp_epoch(void);

PRESENT_API void
Timestamp_ptr_epoch(struct Timestamp * const result);


PRESENT_API time_t
Timestamp_get_time_t(const struct Timestamp * const self);


PRESENT_API struct tm
Timestamp_get_struct_tm(
        const struct Timestamp * const self,
        const struct TimeDelta * const time_zone_offset);

PRESENT_API struct tm
Timestamp_get_struct_tm_utc(const struct Timestamp * const self);

PRESENT_API struct tm
Timestamp_get_struct_tm_local(const struct Timestamp * const self);


PRESENT_API struct Date
Timestamp_get_date(
        const struct Timestamp * const self,
        const struct TimeDelta * const time_zone_offset);

PRESENT_API struct Date
Timestamp_get_date_utc(const struct Timestamp * const self);

PRESENT_API struct Date
Timestamp_get_date_local(const struct Timestamp * const self);


PRESENT_API struct ClockTime
Timestamp_get_clock_time(
        const struct Timestamp * const self,
        const struct TimeDelta * const time_zone_offset);

PRESENT_API struct ClockTime
Timestamp_get_clock_time_utc(const struct Timestamp * const self);

PRESENT_API struct ClockTime
Timestamp_get_clock_time_local(const struct Timestamp * const self);


PRESENT_API struct TimeDelta
Timestamp_difference(
        const struct Timestamp * const self,
        const struct Timestamp * const other);

PRESENT_API struct TimeDelta
Timestamp_absolute_difference(
        const struct Timestamp * const self,
        const struct Timestamp * const other);


PRESENT_API void
Timestamp_add_TimeDelta(
        struct Timestamp * const self,
        const struct TimeDelta * const delta);

PRESENT_API void
Timestamp_add_DayDelta(
        struct Timestamp * const self,
        const struct DayDelta * const delta);

PRESENT_API void
Timestamp_add_MonthDelta(
        struct Timestamp * const self,
        const struct MonthDelta * const delta);

PRESENT_API void
Timestamp_subtract_TimeDelta(
        struct Timestamp * const self,
        const struct TimeDelta * const delta);

PRESENT_API void
Timestamp_subtract_DayDelta(
        struct Timestamp * const self,
        const struct DayDelta * const delta);

PRESENT_API void
Timestamp_subtract_MonthDelta(
        struct Timestamp * const self,
        const struct MonthDelta * const delta);

PRESENT_API short
Timestamp_compare(
        const struct Timestamp * const lhs,
        const struct Timestamp * const rhs);

PRESENT_API present_bool
Timestamp_equal(
        const struct Timestamp * const lhs,
        const struct Timestamp * const rhs);

PRESENT_API present_bool
Timestamp_less_than(
        const struct Timestamp * const lhs,
        const struct Timestamp * const rhs);

PRESENT_API present_bool
Timestamp_less_than_or_equal(
        const struct Timestamp * const lhs,
        const struct Timestamp * const rhs);

PRESENT_API present_bool
Timestamp_greater_than(
        const struct Timestamp * const lhs,
        const struct Timestamp * const rhs);

PRESENT_API present_bool
Timestamp_greater_than_or_equal(
        const struct Timestamp * const lhs,
        const struct Timestamp * const rhs);

#ifdef __cplusplus
}
#endif

#endif /* _PRESENT_TIMESTAMP_H_ */