icalset.h

Go to the documentation of this file.

/* -*- Mode: C -*- */
/*
 $Id: icalset.h,v 1.15 2008-01-02 20:07:42 dothebart Exp $
 $Locker:  $

 (C) COPYRIGHT 2000, Eric Busboom, http://www.softwarestudio.org

 This program 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: http://www.fsf.org/copyleft/lesser.html

  Or:

    The Mozilla Public License Version 1.0. You may obtain a copy of
    the License at http://www.mozilla.org/MPL/

 The Original Code is eric. The Initial Developer of the Original
 Code is Eric Busboom


======================================================================*/

#ifndef ICALSET_H
#define ICALSET_H

#include <limits.h> /* For PATH_MAX */
#include <libical/ical.h>
#include "icalgauge.h"

#ifdef PATH_MAX
#define ICAL_PATH_MAX PATH_MAX
#else
#define ICAL_PATH_MAX 1024
#endif


typedef struct icalset_impl icalset;

typedef enum icalset_kind {
    ICAL_FILE_SET,
    ICAL_DIR_SET,
    ICAL_BDB_SET
} icalset_kind;

typedef struct icalsetiter
{
        icalcompiter iter;    /* icalcomponent_kind, pvl_elem iter */
        icalgauge* gauge;
        icalrecur_iterator* ritr; /*the last iterator*/
        icalcomponent* last_component; /*the pending recurring component to be processed  */
        const char* tzid; /* the calendar's timezone id */
} icalsetiter;

struct icalset_impl {
        icalset_kind kind;
        int size;
        char *dsn;
        icalset* (*init)(icalset* set, const char *dsn, void *options);
        void (*free)(icalset* set);
        const char* (*path)(icalset* set);
        void (*mark)(icalset* set);
        icalerrorenum (*commit)(icalset* set); 
        icalerrorenum (*add_component)(icalset* set, icalcomponent* comp);
        icalerrorenum (*remove_component)(icalset* set, icalcomponent* comp);
        int (*count_components)(icalset* set,
                             icalcomponent_kind kind);
        icalerrorenum (*select)(icalset* set, icalgauge* gauge);
        void (*clear)(icalset* set);
        icalcomponent* (*fetch)(icalset* set, const char* uid);
        icalcomponent* (*fetch_match)(icalset* set, icalcomponent *comp);
        int (*has_uid)(icalset* set, const char* uid);
        icalerrorenum (*modify)(icalset* set, icalcomponent *old,
                                     icalcomponent *newc);
        icalcomponent* (*get_current_component)(icalset* set);  
        icalcomponent* (*get_first_component)(icalset* set);
        icalcomponent* (*get_next_component)(icalset* set);
        icalsetiter (*icalset_begin_component)(icalset* set,
                                         icalcomponent_kind kind, icalgauge* gauge);
        icalcomponent* (*icalsetiter_to_next)(icalset* set, icalsetiter* i);
        icalcomponent* (*icalsetiter_to_prior)(icalset* set, icalsetiter* i);
};

int icalset_register_class(icalset *set);


icalset* icalset_new(icalset_kind kind, const char* dsn, void* options);

icalset* icalset_new_file(const char* path);
icalset* icalset_new_file_reader(const char* path);
icalset* icalset_new_file_writer(const char* path);

icalset* icalset_new_dir(const char* path);
icalset* icalset_new_file_reader(const char* path);
icalset* icalset_new_file_writer(const char* path);

void icalset_free(icalset* set);

const char* icalset_path(icalset* set);

void icalset_mark(icalset* set);

icalerrorenum icalset_commit(icalset* set); 

icalerrorenum icalset_add_component(icalset* set, icalcomponent* comp);
icalerrorenum icalset_remove_component(icalset* set, icalcomponent* comp);

int icalset_count_components(icalset* set,
                             icalcomponent_kind kind);

icalerrorenum icalset_select(icalset* set, icalgauge* gauge);

void icalset_clear_select(icalset* set);

icalcomponent* icalset_fetch(icalset* set, const char* uid);

int icalset_has_uid(icalset* set, const char* uid);
icalcomponent* icalset_fetch_match(icalset* set, icalcomponent *c);

icalerrorenum icalset_modify(icalset* set, icalcomponent *oldc,
                               icalcomponent *newc);

icalcomponent* icalset_get_current_component(icalset* set);
icalcomponent* icalset_get_first_component(icalset* set);
icalcomponent* icalset_get_next_component(icalset* set);

extern icalsetiter icalsetiter_null;

icalsetiter icalset_begin_component(icalset* set,
                                 icalcomponent_kind kind, icalgauge* gauge);

icalcomponent* icalsetiter_next(icalsetiter* i);
icalcomponent* icalsetiter_prior(icalsetiter* i);
icalcomponent* icalsetiter_deref(icalsetiter* i);

icalcomponent* icalsetiter_to_next(icalset* set, icalsetiter* i);
icalcomponent* icalsetiter_to_prior(icalset* set, icalsetiter* i);

#endif /* !ICALSET_H */