time-delta.h

Go to the documentation of this file.

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

#ifndef _PRESENT_TIME_DELTA_H_
#define _PRESENT_TIME_DELTA_H_

/*
 * Forward Declarations
 */

struct DayDelta;

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

struct PRESENT_API TimeDelta {
    /* Internal data representation */
    struct PresentTimeDeltaData data_;

#ifdef __cplusplus

    static TimeDelta from_nanoseconds(int_delta nanoseconds);

    static TimeDelta from_microseconds(int_delta microseconds);

    static TimeDelta from_milliseconds(int_delta milliseconds);

    static TimeDelta from_seconds(int_delta seconds);

    static TimeDelta from_minutes(int_delta minutes);

    static TimeDelta from_hours(int_delta hours);

    static TimeDelta from_days(int_delta days);

    static TimeDelta from_weeks(int_delta weeks);

    static TimeDelta zero();

    int_delta nanoseconds() const;

    int_delta microseconds() const;
    double microseconds_decimal() const;

    int_delta milliseconds() const;
    double milliseconds_decimal() const;

    int_delta seconds() const;
    double seconds_decimal() const;

    int_delta minutes() const;
    double minutes_decimal() const;

    int_delta hours() const;
    double hours_decimal() const;

    int_delta days() const;
    double days_decimal() const;

    int_delta weeks() const;
    double weeks_decimal() const;

    DayDelta to_DayDelta_truncated() const;

    DayDelta to_DayDelta_rounded() const;

    DayDelta to_DayDelta_abs_ceil() const;

    bool is_negative() const;

    void negate();

    TimeDelta operator-() const;

    TimeDelta & operator*=(const long & scale_factor);
    TimeDelta & operator*=(const double & scale_factor);
    TimeDelta & operator/=(const long & scale_factor);
    TimeDelta & operator/=(const double & scale_factor);

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

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

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

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

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

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

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

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

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

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

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

/*
 * C Method Declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

PRESENT_API struct TimeDelta
TimeDelta_from_nanoseconds(int_delta nanoseconds);

PRESENT_API void
TimeDelta_ptr_from_nanoseconds(
        struct TimeDelta * const result,
        int_delta nanoseconds);

PRESENT_API struct TimeDelta
TimeDelta_from_microseconds(int_delta microseconds);

PRESENT_API void
TimeDelta_ptr_from_microseconds(
        struct TimeDelta * const result,
        int_delta microseconds);

PRESENT_API struct TimeDelta
TimeDelta_from_milliseconds(int_delta milliseconds);

PRESENT_API void
TimeDelta_ptr_from_milliseconds(
        struct TimeDelta * const result,
        int_delta milliseconds);

PRESENT_API struct TimeDelta
TimeDelta_from_seconds(int_delta seconds);

PRESENT_API void
TimeDelta_ptr_from_seconds(struct TimeDelta * const result, int_delta seconds);

PRESENT_API struct TimeDelta
TimeDelta_from_minutes(int_delta minutes);

PRESENT_API void
TimeDelta_ptr_from_minutes(struct TimeDelta * const result, int_delta minutes);

PRESENT_API struct TimeDelta
TimeDelta_from_hours(int_delta hours);

PRESENT_API void
TimeDelta_ptr_from_hours(struct TimeDelta * const result, int_delta hours);

PRESENT_API struct TimeDelta
TimeDelta_from_days(int_delta days);

PRESENT_API void
TimeDelta_ptr_from_days(struct TimeDelta * const result, int_delta days);

PRESENT_API struct TimeDelta
TimeDelta_from_weeks(int_delta weeks);

PRESENT_API void
TimeDelta_ptr_from_weeks(struct TimeDelta * const result, int_delta weeks);

PRESENT_API struct TimeDelta
TimeDelta_zero(void);

PRESENT_API void
TimeDelta_ptr_zero(struct TimeDelta * const result);

PRESENT_API int_delta
TimeDelta_nanoseconds(const struct TimeDelta * const self);

PRESENT_API int_delta
TimeDelta_microseconds(const struct TimeDelta * const self);

PRESENT_API double
TimeDelta_microseconds_decimal(const struct TimeDelta * const self);

PRESENT_API int_delta
TimeDelta_milliseconds(const struct TimeDelta * const self);

PRESENT_API double
TimeDelta_milliseconds_decimal(const struct TimeDelta * const self);

PRESENT_API int_delta
TimeDelta_seconds(const struct TimeDelta * const self);

PRESENT_API double
TimeDelta_seconds_decimal(const struct TimeDelta * const self);

PRESENT_API int_delta
TimeDelta_minutes(const struct TimeDelta * const self);

PRESENT_API double
TimeDelta_minutes_decimal(const struct TimeDelta * const self);

PRESENT_API int_delta
TimeDelta_hours(const struct TimeDelta * const self);

PRESENT_API double
TimeDelta_hours_decimal(const struct TimeDelta * const self);

PRESENT_API int_delta
TimeDelta_days(const struct TimeDelta * const self);

PRESENT_API double
TimeDelta_days_decimal(const struct TimeDelta * const self);

PRESENT_API int_delta
TimeDelta_weeks(const struct TimeDelta * const self);

PRESENT_API double
TimeDelta_weeks_decimal(const struct TimeDelta * const self);

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

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

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

PRESENT_API present_bool
TimeDelta_is_negative(const struct TimeDelta * const self);

PRESENT_API void
TimeDelta_negate(struct TimeDelta * const self);

PRESENT_API void
TimeDelta_multiply_by(struct TimeDelta * const self, const long scale_factor);

PRESENT_API void
TimeDelta_multiply_by_decimal(
        struct TimeDelta * const self,
        const double scale_factor);

PRESENT_API void
TimeDelta_divide_by(struct TimeDelta * const self, const long scale_factor);

PRESENT_API void
TimeDelta_divide_by_decimal(
        struct TimeDelta * const self,
        const double scale_factor);

PRESENT_API void
TimeDelta_add(
        struct TimeDelta * const self,
        const struct TimeDelta * const other);

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

PRESENT_API void
TimeDelta_subtract(
        struct TimeDelta * const self,
        const struct TimeDelta * const other);

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

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

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

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

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

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

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

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

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

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

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

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

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

#ifdef __cplusplus
}
#endif

#endif /* _PRESENT_TIME_DELTA_H_ */