icalperiod.h

Go to the documentation of this file.

/*======================================================================
 FILE: icalperiod.h
 CREATOR: eric 26 Jan 2001

 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

 The Original Code is eric. The Initial Developer of the Original
 Code is Eric Busboom
======================================================================*/

#ifndef ICALPERIOD_H
#define ICALPERIOD_H

#include "libical_ical_export.h"
#include "icalduration.h"
#include "icaltime.h"

#include <stdbool.h>

struct icalperiodtype {
    struct icaltimetype start;
    struct icaltimetype end;
    struct icaldurationtype duration;
};

#define ICALPERIODTYPE_INITIALIZER \
    {                              \
        ICALTIMETYPE_INITIALIZER,  \
        ICALTIMETYPE_INITIALIZER,  \
        ICALDURATIONTYPE_INITIALIZER}

LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_from_string(const char *str);

LIBICAL_ICAL_EXPORT const char *icalperiodtype_as_ical_string(struct icalperiodtype p);

LIBICAL_ICAL_EXPORT char *icalperiodtype_as_ical_string_r(struct icalperiodtype p);

LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);

LIBICAL_ICAL_EXPORT bool icalperiodtype_is_null_period(struct icalperiodtype p);

LIBICAL_ICAL_EXPORT bool icalperiodtype_is_valid_period(struct icalperiodtype p);

#endif /* !ICALTIME_H */