icalparser.h

Go to the documentation of this file.

/*======================================================================
 FILE: icalparser.h
 CREATOR: eric 20 April 1999
 
 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
 
 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
 
  The original code is icalparser.h
======================================================================*/
 
#ifndef ICALPARSER_H
#define ICALPARSER_H
 
#include "libical_ical_export.h"
#include "icalcomponent.h"


typedef struct icalparser_impl icalparser;

typedef enum icalparser_state
{
    ICALPARSER_ERROR,

    ICALPARSER_SUCCESS,

    ICALPARSER_BEGIN_COMP,

    ICALPARSER_END_COMP,

    ICALPARSER_IN_PROGRESS
} icalparser_state;
 
typedef char *(*icalparser_line_gen_func)(char *s, size_t size, void *d);

LIBICAL_ICAL_EXPORT icalparser *icalparser_new(void);

LIBICAL_ICAL_EXPORT icalcomponent *icalparser_add_line(icalparser *parser, char *str);

LIBICAL_ICAL_EXPORT icalcomponent *icalparser_clean(icalparser *parser);

LIBICAL_ICAL_EXPORT icalparser_state icalparser_get_state(icalparser *parser);

LIBICAL_ICAL_EXPORT void icalparser_free(icalparser *parser);

LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse(icalparser *parser,
                                                    icalparser_line_gen_func line_gen_func);

LIBICAL_ICAL_EXPORT void icalparser_set_gen_data(icalparser *parser, void *data);

LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse_string(const char *str);

enum icalparser_ctrl
{
    ICALPARSER_CTRL_KEEP,
    ICALPARSER_CTRL_OMIT,
    ICALPARSER_CTRL_ERROR
};

LIBICAL_ICAL_EXPORT enum icalparser_ctrl icalparser_get_ctrl(void);

LIBICAL_ICAL_EXPORT void icalparser_set_ctrl(enum icalparser_ctrl ctrl);
 
/***********************************************************************
 * Parser support functions
 ***********************************************************************/

LIBICAL_ICAL_EXPORT char *icalparser_get_line(icalparser *parser,
                                              icalparser_line_gen_func line_gen_func);
 
LIBICAL_ICAL_EXPORT char *icalparser_string_line_generator(char *out, size_t buf_size, void *d);
 
#endif /* !ICALPARSE_H */