icaltime.h

Go to the documentation of this file.

/*======================================================================
 FILE: icaltime.h
 CREATOR: eric 02 June 2000
 
 (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
 
 This library is free software; you can redistribute it and/or modify
 it under the terms of either:
 
    The LGPL as published by the Free Software Foundation, version
    2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
 
 Or:
 
    The Mozilla Public License Version 2.0. You may obtain a copy of
    the License at https://www.mozilla.org/MPL/
 
 The Original Code is eric. The Initial Developer of the Original
 Code is Eric Busboom
======================================================================*/
 
#ifndef ICALTIME_H
#define ICALTIME_H
 
#include "libical_ical_export.h"
 
#include <time.h>
 
/* An opaque struct representing a timezone. We declare this here to avoid
   a circular dependency. */
#if !defined(ICALTIMEZONE_DEFINED)
#define ICALTIMEZONE_DEFINED
typedef struct _icaltimezone icaltimezone;
#endif
 
struct icaltime_span
{
    time_t start;       
    time_t end;         
    int is_busy;        
};
 
typedef struct icaltime_span icaltime_span;
 
struct icaltimetype
{
    int year;           
    int month;          
    int day;
    int hour;
    int minute;
    int second;
 
    int is_date;        
    int is_daylight;    
    const icaltimezone *zone;  
};
 
typedef struct icaltimetype icaltimetype;
 
#define ICALTIMETYPE_INITIALIZER { 0, 0, 0, 0, 0, 0, 0, 0, 0}
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_time(void);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_date(void);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_current_time_with_zone(const icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_today(void);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_timet_with_zone(const time_t tm,
                                                                      const int is_date,
                                                                      const icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_string(const char *str);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_day_of_year(const int doy, const int year);
 
LIBICAL_ICAL_EXPORT time_t icaltime_as_timet(const struct icaltimetype);
 
LIBICAL_ICAL_EXPORT time_t icaltime_as_timet_with_zone(const struct icaltimetype tt,
                                                       const icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT const char *icaltime_as_ical_string(const struct icaltimetype tt);
 
LIBICAL_ICAL_EXPORT char *icaltime_as_ical_string_r(const struct icaltimetype tt);
 
LIBICAL_ICAL_EXPORT const icaltimezone *icaltime_get_timezone(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT const char *icaltime_get_tzid(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_set_timezone(struct icaltimetype *t,
                                                              const icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT int icaltime_day_of_year(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT int icaltime_day_of_week(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT int icaltime_start_doy_week(const struct icaltimetype t, int fdow);
 
LIBICAL_ICAL_EXPORT int icaltime_week_number(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT int icaltime_is_null_time(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT int icaltime_is_valid_time(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT int icaltime_is_date(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT int icaltime_is_utc(const struct icaltimetype t);
 
LIBICAL_ICAL_EXPORT int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b);
 
LIBICAL_ICAL_EXPORT int icaltime_compare_date_only(const struct icaltimetype a,
                                                   const struct icaltimetype b);
 
LIBICAL_ICAL_EXPORT int icaltime_compare_date_only_tz(const struct icaltimetype a,
                                                      const struct icaltimetype b,
                                                      icaltimezone *tz);
 
LIBICAL_ICAL_EXPORT void icaltime_adjust(struct icaltimetype *tt,
                                         const int days, const int hours,
                                         const int minutes, const int seconds);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_normalize(const struct icaltimetype tt);
 
LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_convert_to_zone(const struct icaltimetype tt,
                                                                 icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT int icaltime_days_in_month(const int month, const int year);
 
LIBICAL_ICAL_EXPORT int icaltime_is_leap_year(const int year);
 
LIBICAL_ICAL_EXPORT int icaltime_days_in_year(const int year);
 
LIBICAL_ICAL_EXPORT struct icaltime_span icaltime_span_new(struct icaltimetype dtstart,
                                                           struct icaltimetype dtend, int is_busy);
 
LIBICAL_ICAL_EXPORT int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2);
 
LIBICAL_ICAL_EXPORT int icaltime_span_contains(icaltime_span *s, icaltime_span *container);
 
#endif /* !ICALTIME_H */