date.h

Go to the documentation of this file.

/*
 * Present - Date/Time Library
 *
 * Definition of the Date 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-date-data.h"

#ifndef _PRESENT_DATE_H_
#define _PRESENT_DATE_H_

/*
 * Forward Declaraions
 */

struct DayDelta;
struct MonthDelta;

/*
 * Helper Struct Definitions
 */

struct PresentWeekYear {
    int_week_of_year week;
    int_year year;
};

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

struct PRESENT_API Date {
    present_bool has_error;

    struct {
        unsigned int month_out_of_range         : 1,
                     day_out_of_range           : 1,
                     week_of_year_out_of_range  : 1,
                     day_of_week_out_of_range   : 1;
    } errors;

    /* Internal data representation */
    struct PresentDateData data_;

#ifdef __cplusplus

    static Date create(int_year year);

    static Date create(int_year year, int_month month);

    static Date create(int_year year, int_month month, int_day day);

    static Date from_year_day(
        int_year year,
        int_day_of_year day_of_year);

    static Date from_year_week_day(
        int_year year,
        int_week_of_year week_of_year,
        int_day_of_week day_of_week);

    int_year year() const;

    int_month month() const;

    int_day day() const;

    int_day_of_year day_of_year() const;

    PresentWeekYear week_of_year() const;

    int_day_of_week day_of_week() const;

    DayDelta difference(const Date & other) const;
    DayDelta absolute_difference(const Date & other) const;

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

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

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

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

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

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

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

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

/*
 * C Method Declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

PRESENT_API struct Date
Date_from_year(int_year year);

PRESENT_API void
Date_ptr_from_year(struct Date * const result, int_year year);

PRESENT_API struct Date
Date_from_year_month(int_year year, int_month month);

PRESENT_API void
Date_ptr_from_year_month(
        struct Date * const result,
        int_year year,
        int_month month);

PRESENT_API struct Date
Date_from_year_month_day(int_year year, int_month month, int_day day);

PRESENT_API void
Date_ptr_from_year_month_day(
        struct Date * const result,
        int_year year,
        int_month month,
        int_day day);

#define Date_create(...)    \
    PRESENT_OVERLOAD_MAX_3(__VA_ARGS__, \
        Date_from_year_month_day,       \
        Date_from_year_month,           \
        Date_from_year,                 \
        dummy)(__VA_ARGS__)

#define Date_ptr_create(result, ...)    \
    PRESENT_OVERLOAD_MAX_3(__VA_ARGS__, \
        Date_ptr_from_year_month_day,   \
        Date_ptr_from_year_month,       \
        Date_ptr_from_year,             \
        dummy)(result, __VA_ARGS__)

PRESENT_API struct Date
Date_from_year_day(int_year year, int_day_of_year day_of_year);

PRESENT_API void
Date_ptr_from_year_day(
        struct Date * const result,
        int_year year,
        int_day_of_year day_of_year);

PRESENT_API struct Date
Date_from_year_week_day(
        int_year year,
        int_week_of_year week_of_year,
        int_day_of_week day_of_week);

PRESENT_API void
Date_ptr_from_year_week_day(
        struct Date * const result,
        int_year year,
        int_week_of_year week_of_year,
        int_day_of_week day_of_week);

PRESENT_API int_year
Date_year(const struct Date * const self);

PRESENT_API int_month
Date_month(const struct Date * const self);

PRESENT_API int_day
Date_day(const struct Date * const self);

PRESENT_API int_day_of_year
Date_day_of_year(const struct Date * const self);

PRESENT_API struct PresentWeekYear
Date_week_of_year(const struct Date * const self);

PRESENT_API int_day_of_week
Date_day_of_week(const struct Date * const self);

PRESENT_API struct DayDelta
Date_difference(
        const struct Date * const self,
        const struct Date * const other);

PRESENT_API struct DayDelta
Date_absolute_difference(
        const struct Date * const self,
        const struct Date * const other);

PRESENT_API void
Date_add_DayDelta(
        struct Date * const self,
        const struct DayDelta * const delta);

PRESENT_API void
Date_add_MonthDelta(
        struct Date * const self,
        const struct MonthDelta * const delta);

PRESENT_API void
Date_subtract_DayDelta(
        struct Date * const self,
        const struct DayDelta * const delta);

PRESENT_API void
Date_subtract_MonthDelta(
        struct Date * const self,
        const struct MonthDelta * const delta);

PRESENT_API short
Date_compare(
        const struct Date * const lhs,
        const struct Date * const rhs);

PRESENT_API present_bool
Date_equal(const struct Date * const lhs, const struct Date * const rhs);

PRESENT_API present_bool
Date_less_than(const struct Date * const lhs, const struct Date * const rhs);

PRESENT_API present_bool
Date_less_than_or_equal(
        const struct Date * const lhs,
        const struct Date * const rhs);

PRESENT_API present_bool
Date_greater_than(
        const struct Date * const lhs,
        const struct Date * const rhs);

PRESENT_API present_bool
Date_greater_than_or_equal(
        const struct Date * const lhs,
        const struct Date * const rhs);

#ifdef __cplusplus
}
#endif

#endif /* _PRESENT_DATE_H_ */