icaltimezone.h

Go to the documentation of this file.

/*======================================================================
 FILE: icaltimezone.h
 CREATOR: Damon Chaplin 15 March 2001
 
 (C) COPYRIGHT 2001, Damon Chaplin <damon@ximian.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/
======================================================================*/
#ifndef ICALTIMEZONE_H
#define ICALTIMEZONE_H
 
#include "libical_ical_export.h"
#include "icalcomponent.h"
 
#include <stdio.h>
 
#if !defined(ICALTIMEZONE_DEFINED)
#define ICALTIMEZONE_DEFINED
typedef struct _icaltimezone icaltimezone;
#endif
 
/*
 * Creating/Destroying individual icaltimezones.
 */
 
LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_new(void);
 
LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_copy(icaltimezone *originalzone);
 
LIBICAL_ICAL_EXPORT void icaltimezone_free(icaltimezone *zone, int free_struct);
 
LIBICAL_ICAL_EXPORT void icaltimezone_set_tzid_prefix(const char *new_prefix);
 
/*
 * Accessing timezones.
 */
 
LIBICAL_ICAL_EXPORT void icaltimezone_free_builtin_timezones(void);
 
LIBICAL_ICAL_EXPORT icalarray *icaltimezone_get_builtin_timezones(void);
 
LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone(const char *location);
 
LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_offset(int offset,
                                                                                const char *tzname);
 
LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_tzid(const char *tzid);
 
LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_utc_timezone(void);
 
LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tzid(icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT const char *icaltimezone_get_location(icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tznames(icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT double icaltimezone_get_latitude(icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT double icaltimezone_get_longitude(icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT icalcomponent *icaltimezone_get_component(icaltimezone *zone);
 
LIBICAL_ICAL_EXPORT int icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp);
 
LIBICAL_ICAL_EXPORT const char *icaltimezone_get_display_name(icaltimezone *zone);
 
/*
 * Converting times between timezones.
 */
 
LIBICAL_ICAL_EXPORT void icaltimezone_convert_time(struct icaltimetype *tt,
                                                   icaltimezone *from_zone,
                                                   icaltimezone *to_zone);
 
/*
 * Getting offsets from UTC.
 */
 
LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset(icaltimezone *zone,
                                                    struct icaltimetype *tt, int *is_daylight);
 
LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone,
                                                                struct icaltimetype *tt,
                                                                int *is_daylight);
 
/*
 * Handling arrays of timezones. Mainly for internal use.
 */
LIBICAL_ICAL_EXPORT icalarray *icaltimezone_array_new(void);
 
LIBICAL_ICAL_EXPORT void icaltimezone_array_append_from_vtimezone(icalarray *timezones,
                                                                  icalcomponent *child);
 
LIBICAL_ICAL_EXPORT void icaltimezone_array_free(icalarray *timezones);
 
/*
 * By request (issue #112) make vtimezone functions public
 */
LIBICAL_ICAL_EXPORT void icaltimezone_expand_vtimezone(icalcomponent *comp,
                                                       int end_year, icalarray *changes);
 
LIBICAL_ICAL_EXPORT char *icaltimezone_get_location_from_vtimezone(icalcomponent *component);
 
LIBICAL_ICAL_EXPORT char *icaltimezone_get_tznames_from_vtimezone(icalcomponent *component);
 
/*
 * Truncate a VTIMEZONE component to the given start and end times.
 * If either time is null, then no truncation will occur at that point.
 * If either time is non-null, then it MUST be specified as UTC.
 * If the start time is non-null and ms_compatible is zero,
 * then the DTSTART of RRULEs will be adjusted to occur after the start time.
 * @since 3.0.6
 */
LIBICAL_ICAL_EXPORT void icaltimezone_truncate_vtimezone(icalcomponent *vtz,
                                                         icaltimetype start,
                                                         icaltimetype end,
                                                         int ms_compatible);
 
/*
 * @par Handling the default location the timezone files
 */
 
LIBICAL_ICAL_EXPORT const char *get_zone_directory(void);
 
LIBICAL_ICAL_EXPORT void set_zone_directory(const char *path);
 
LIBICAL_ICAL_EXPORT void free_zone_directory(void);
 
LIBICAL_ICAL_EXPORT void icaltimezone_release_zone_tab(void);
 
/*
 * @par Handling whether to use builtin timezone files
 */
LIBICAL_ICAL_EXPORT void icaltimezone_set_builtin_tzdata(int set);
 
LIBICAL_ICAL_EXPORT int icaltimezone_get_builtin_tzdata(void);
 
/*
 * Debugging Output.
 */
 
LIBICAL_ICAL_EXPORT int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp);
 
/* For the library only -- do not make visible */
extern const char *icaltimezone_tzid_prefix(void);
 
#endif /* ICALTIMEZONE_H */