icaltimezone.h

Go to the documentation of this file.

/*======================================================================
 FILE: icaltimezone.h
 CREATOR: Damon Chaplin 15 March 2001

 SPDX-FileCopyrightText: 2001, Damon Chaplin <damon@ximian.com>
 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
======================================================================*/

#ifndef ICALTIMEZONE_H
#define ICALTIMEZONE_H

#include "libical_ical_export.h"
#include "icalcomponent.h"

#include <stdbool.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(const 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);

LIBICAL_ICAL_EXPORT const char *icaltimezone_tzid_prefix(void);

/*
 * 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(const icaltimezone *zone);

LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tznames(icaltimezone *zone);

LIBICAL_ICAL_EXPORT double icaltimezone_get_latitude(const icaltimezone *zone);

LIBICAL_ICAL_EXPORT double icaltimezone_get_longitude(const icaltimezone *zone);

LIBICAL_ICAL_EXPORT icalcomponent *icaltimezone_get_component(icaltimezone *zone);

LIBICAL_ICAL_EXPORT bool icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp);

LIBICAL_ICAL_EXPORT const char *icaltimezone_get_display_name(icaltimezone *zone);

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,
                                                    const struct icaltimetype *tt, int *is_daylight);

LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone,
                                                                const struct icaltimetype *tt,
                                                                int *is_daylight);


/*
 * Handling arrays of timezones. For internal use.
 */
LIBICAL_ICAL_NO_EXPORT icalarray *icaltimezone_array_new(void);

LIBICAL_ICAL_NO_EXPORT void icaltimezone_array_append_from_vtimezone(icalarray *timezones,
                                                                     icalcomponent *child);

LIBICAL_ICAL_NO_EXPORT void icaltimezone_array_free(icalarray *timezones);

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);

LIBICAL_ICAL_EXPORT void icaltimezone_truncate_vtimezone(icalcomponent *vtz,
                                                         icaltimetype start,
                                                         icaltimetype end,
                                                         bool ms_compatible);

/*
 * @par Handling the default location the timezone files
 */

LIBICAL_ICAL_EXPORT const char *icaltimezone_get_system_zone_directory(void);

LIBICAL_ICAL_EXPORT void icaltimezone_set_system_zone_directory(const char *zonepath);

LIBICAL_ICAL_EXPORT const char *icaltimezone_get_zone_directory(void);

LIBICAL_ICAL_EXPORT void icaltimezone_set_zone_directory(const char *path);

LIBICAL_ICAL_EXPORT void icaltimezone_free_zone_directory(void);

LIBICAL_ICAL_EXPORT void icaltimezone_set_builtin_tzdata(bool set);

LIBICAL_ICAL_EXPORT bool icaltimezone_get_builtin_tzdata(void);

/*
 * Debugging Output.
 */

LIBICAL_ICAL_EXPORT bool icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp);

#endif /* ICALTIMEZONE_H */