icalvalue.h

Go to the documentation of this file.

/*======================================================================
 FILE: icalvalue.h
 CREATOR: eric 20 March 1999
 
 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
 
 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
 
 ======================================================================*/
 
#ifndef ICALVALUE_H
#define ICALVALUE_H
 
#include "libical_ical_export.h"
#include "icalvalueimpl.h"
 
#include <stdbool.h>

 
#define ICAL_BOOLEAN_TRUE 1
#define ICAL_BOOLEAN_FALSE 0
 
LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new(icalvalue_kind kind);

LIBICAL_ICAL_EXPORT icalvalue *icalvalue_clone(const icalvalue *value);
 
LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new_from_string(icalvalue_kind kind, const char *str);
 
LIBICAL_ICAL_EXPORT void icalvalue_free(icalvalue *value);
 
LIBICAL_ICAL_EXPORT bool icalvalue_is_valid(const icalvalue *value);
 
LIBICAL_ICAL_EXPORT const char *icalvalue_as_ical_string(const icalvalue *value);
 
LIBICAL_ICAL_EXPORT char *icalvalue_as_ical_string_r(const icalvalue *value);
 
LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_isa(const icalvalue *value);
 
LIBICAL_ICAL_EXPORT bool icalvalue_isa_value(void *);
 
LIBICAL_ICAL_EXPORT icalparameter_xliccomparetype icalvalue_compare(const icalvalue *a,
                                                                    const icalvalue *b);
 
/* Special, non autogenerated value accessors */
 
/* Defined in icalderivedvalue.h */
/* icalvalue* icalvalue_new_recur (struct icalrecurrencetype *v); */
/* void icalvalue_set_recur(icalvalue* value, struct icalrecurrencetype *v); */
/* struct icalrecurrencetype *icalvalue_get_recur(const icalvalue* value); */
 
/* icalvalue* icalvalue_new_trigger (struct icaltriggertype v); */
/* void icalvalue_set_trigger(icalvalue* value, struct icaltriggertype v); */
/* struct icaltriggertype icalvalue_get_trigger(const icalvalue* value); */
 
/* icalvalue* icalvalue_new_datetimeperiod (struct icaldatetimeperiodtype v); */
/* void icalvalue_set_datetimeperiod(icalvalue* value, */
/*                                struct icaldatetimeperiodtype v); */
/* struct icaldatetimeperiodtype icalvalue_get_datetimeperiod(const icalvalue* value); */
 
/* Convert enumerations */
 
LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_string_to_kind(const char *str);
 
LIBICAL_ICAL_EXPORT const char *icalvalue_kind_to_string(const icalvalue_kind kind);

LIBICAL_ICAL_EXPORT bool icalvalue_kind_is_valid(const icalvalue_kind kind);

LIBICAL_ICAL_EXPORT bool icalvalue_encode_ical_string(const char *szText,
                                                      char *szEncText, int MaxBufferLen);

LIBICAL_ICAL_EXPORT bool icalvalue_decode_ical_string(const char *szText,
                                                      char *szDecText, int nMaxBufferLen);
 
/* For the library only -- do not make visible */
extern void print_date_to_string(char *str, const struct icaltimetype *data);
extern void print_datetime_to_string(char *str, const struct icaltimetype *data);
 
#endif /*ICALVALUE_H */