month-delta.h

Go to the documentation of this file.

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

#ifndef _PRESENT_MONTH_DELTA_H_
#define _PRESENT_MONTH_DELTA_H_

/*
 * Forward Declarations
 */

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

struct PRESENT_API MonthDelta {
    /* Internal data representation */
    struct PresentMonthDeltaData data_;

#ifdef __cplusplus

    static MonthDelta from_months(int_month_delta months);

    static MonthDelta from_years(int_year_delta years);

    static MonthDelta zero();

    int_month_delta months() const;

    int_year_delta years() const;

    double years_decimal() const;

    bool is_negative() const;

    void negate();

    MonthDelta operator-() const;

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

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

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

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

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

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

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

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

/*
 * C Method Declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

PRESENT_API struct MonthDelta
MonthDelta_from_months(int_month_delta months);

PRESENT_API void
MonthDelta_ptr_from_months(
        struct MonthDelta * const result,
        int_month_delta months);

PRESENT_API struct MonthDelta
MonthDelta_from_years(int_year_delta years);

PRESENT_API void
MonthDelta_ptr_from_years(
        struct MonthDelta * const result,
        int_year_delta years);

PRESENT_API struct MonthDelta
MonthDelta_zero(void);

PRESENT_API void
MonthDelta_ptr_zero(struct MonthDelta * const result);

PRESENT_API int_month_delta
MonthDelta_months(const struct MonthDelta * const self);

PRESENT_API int_year_delta
MonthDelta_years(const struct MonthDelta * const self);

PRESENT_API double
MonthDelta_years_decimal(const struct MonthDelta * const self);

PRESENT_API present_bool
MonthDelta_is_negative(const struct MonthDelta * const self);

PRESENT_API void
MonthDelta_negate(struct MonthDelta * const self);

PRESENT_API void
MonthDelta_multiply_by(struct MonthDelta * const self, long scale_factor);

PRESENT_API void
MonthDelta_divide_by(struct MonthDelta * const self, long scale_factor);

PRESENT_API void
MonthDelta_add(
        struct MonthDelta * const self,
        const struct MonthDelta * const other);

PRESENT_API void
MonthDelta_subtract(
        struct MonthDelta * const self,
        const struct MonthDelta * const other);

PRESENT_API short
MonthDelta_compare(
        const struct MonthDelta * const lhs,
        const struct MonthDelta * const rhs);

PRESENT_API present_bool
MonthDelta_equal(
        const struct MonthDelta * const lhs,
        const struct MonthDelta * const rhs);

PRESENT_API present_bool
MonthDelta_less_than(
        const struct MonthDelta * const lhs,
        const struct MonthDelta * const rhs);

PRESENT_API present_bool
MonthDelta_less_than_or_equal(
        const struct MonthDelta * const lhs,
        const struct MonthDelta * const rhs);

PRESENT_API present_bool
MonthDelta_greater_than(
        const struct MonthDelta * const lhs,
        const struct MonthDelta * const rhs);

PRESENT_API present_bool
MonthDelta_greater_than_or_equal(
        const struct MonthDelta * const lhs,
        const struct MonthDelta * const rhs);

#ifdef __cplusplus
}
#endif

#endif /* _PRESENT_MONTH_DELTA_H_ */