day-delta.h

Go to the documentation of this file.

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

#ifndef _PRESENT_DAY_DELTA_H_
#define _PRESENT_DAY_DELTA_H_

/*
 * Forward Declarations
 */

struct TimeDelta;

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

struct PRESENT_API DayDelta {
    /* Internal data representation */
    struct PresentDayDeltaData data_;

#ifdef __cplusplus

    static DayDelta from_days(int_delta days);

    static DayDelta from_weeks(int_delta weeks);

    static DayDelta zero();

    int_delta days() const;

    int_delta weeks() const;

    double weeks_decimal() const;

    TimeDelta to_TimeDelta() const;

    bool is_negative() const;

    void negate();

    DayDelta operator-() const;

    DayDelta & operator++();
    DayDelta operator++(int);
    DayDelta & operator--();
    DayDelta operator--(int);

    DayDelta & operator*=(const long & scale_factor);
    DayDelta & operator/=(const long & scale_factor);

    friend const DayDelta operator*(
            const DayDelta & delta,
            const long & scale_factor);
    friend const DayDelta operator/(
            const DayDelta & delta,
            const long & scale_factor);

    DayDelta & operator+=(const DayDelta & other);
    DayDelta & operator-=(const DayDelta & other);

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

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

    static short compare(const DayDelta & lhs, const TimeDelta & rhs);
    static short compare(const TimeDelta & lhs, const DayDelta & rhs);

    friend bool operator==(const DayDelta & lhs, const DayDelta & rhs);
    friend bool operator==(const DayDelta & lhs, const TimeDelta & rhs);

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

    friend bool operator<(const DayDelta & lhs, const DayDelta & rhs);
    friend bool operator<(const DayDelta & lhs, const TimeDelta & rhs);

    friend bool operator<=(const DayDelta & lhs, const DayDelta & rhs);
    friend bool operator<=(const DayDelta & lhs, const TimeDelta & rhs);

    friend bool operator>(const DayDelta & lhs, const DayDelta & rhs);
    friend bool operator>(const DayDelta & lhs, const TimeDelta & rhs);

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

/*
 * C Method Declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

PRESENT_API struct DayDelta
DayDelta_from_days(int_delta days);

PRESENT_API void
DayDelta_ptr_from_days(struct DayDelta * const result, int_delta days);

PRESENT_API struct DayDelta
DayDelta_from_weeks(int_delta weeks);

PRESENT_API void
DayDelta_ptr_from_weeks(struct DayDelta * const result, int_delta weeks);

PRESENT_API struct DayDelta
DayDelta_zero(void);

PRESENT_API void
DayDelta_ptr_zero(struct DayDelta * const result);

PRESENT_API int_delta
DayDelta_days(const struct DayDelta * const self);

PRESENT_API int_delta
DayDelta_weeks(const struct DayDelta * const self);

PRESENT_API double
DayDelta_weeks_decimal(const struct DayDelta * const self);

PRESENT_API struct TimeDelta
DayDelta_to_TimeDelta(const struct DayDelta * const self);

PRESENT_API present_bool
DayDelta_is_negative(const struct DayDelta * const self);

PRESENT_API void
DayDelta_negate(struct DayDelta * const self);

PRESENT_API void
DayDelta_multiply_by(struct DayDelta * const self, long scale_factor);

PRESENT_API void
DayDelta_divide_by(struct DayDelta * const self, long scale_factor);

PRESENT_API void
DayDelta_add(
        struct DayDelta * const self,
        const struct DayDelta * const other);

PRESENT_API void
DayDelta_subtract(
        struct DayDelta * const self,
        const struct DayDelta * const other);

PRESENT_API short
DayDelta_compare(
        const struct DayDelta * const lhs,
        const struct DayDelta * const rhs);

PRESENT_API short
DayDelta_compare_to_TimeDelta(
        const struct DayDelta * const lhs,
        const struct TimeDelta * const rhs);

PRESENT_API present_bool
DayDelta_equal(
        const struct DayDelta * const lhs,
        const struct DayDelta * const rhs);

PRESENT_API present_bool
DayDelta_equal_TimeDelta(
        const struct DayDelta * const lhs,
        const struct TimeDelta * const rhs);

PRESENT_API present_bool
DayDelta_less_than(
        const struct DayDelta * const lhs,
        const struct DayDelta * const rhs);

PRESENT_API present_bool
DayDelta_less_than_TimeDelta(
        const struct DayDelta * const lhs,
        const struct TimeDelta * const rhs);

PRESENT_API present_bool
DayDelta_less_than_or_equal(
        const struct DayDelta * const lhs,
        const struct DayDelta * const rhs);

PRESENT_API present_bool
DayDelta_less_than_or_equal_TimeDelta(
        const struct DayDelta * const lhs,
        const struct TimeDelta * const rhs);

PRESENT_API present_bool
DayDelta_greater_than(
        const struct DayDelta * const lhs,
        const struct DayDelta * const rhs);

PRESENT_API present_bool
DayDelta_greater_than_TimeDelta(
        const struct DayDelta * const lhs,
        const struct TimeDelta * const rhs);

PRESENT_API present_bool
DayDelta_greater_than_or_equal(
        const struct DayDelta * const lhs,
        const struct DayDelta * const rhs);

PRESENT_API present_bool
DayDelta_greater_than_or_equal_TimeDelta(
        const struct DayDelta * const lhs,
        const struct TimeDelta * const rhs);

#ifdef __cplusplus
}
#endif

#endif /* _PRESENT_DAY_DELTA_H_ */