diff options
Diffstat (limited to 'camel/providers/imapp/camel-imapp-store-summary.h')
| -rw-r--r-- | camel/providers/imapp/camel-imapp-store-summary.h | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/camel/providers/imapp/camel-imapp-store-summary.h b/camel/providers/imapp/camel-imapp-store-summary.h new file mode 100644 index 0000000000..154fe8798e --- /dev/null +++ b/camel/providers/imapp/camel-imapp-store-summary.h @@ -0,0 +1,102 @@ +/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ +/* + * Copyright (C) 2002 Ximian Inc. + * + * Authors: Michael Zucchi <notzed@ximian.com> + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of version 2 of the GNU General Public + * License as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public + * License along with this program; if not, write to the + * Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ + + +#ifndef _CAMEL_IMAPP_STORE_SUMMARY_H +#define _CAMEL_IMAPP_STORE_SUMMARY_H + +#ifdef __cplusplus +extern "C" { +#pragma } +#endif /* __cplusplus */ + +#include <camel/camel-object.h> +#include <camel/camel-store-summary.h> + +#define CAMEL_IMAPP_STORE_SUMMARY(obj) CAMEL_CHECK_CAST (obj, camel_imapp_store_summary_get_type (), CamelIMAPPStoreSummary) +#define CAMEL_IMAPP_STORE_SUMMARY_CLASS(klass) CAMEL_CHECK_CLASS_CAST (klass, camel_imapp_store_summary_get_type (), CamelIMAPPStoreSummaryClass) +#define CAMEL_IS_IMAP_STORE_SUMMARY(obj) CAMEL_CHECK_TYPE (obj, camel_imapp_store_summary_get_type ()) + +typedef struct _CamelIMAPPStoreSummary CamelIMAPPStoreSummary; +typedef struct _CamelIMAPPStoreSummaryClass CamelIMAPPStoreSummaryClass; + +typedef struct _CamelIMAPPStoreInfo CamelIMAPPStoreInfo; + +enum { + CAMEL_IMAPP_STORE_INFO_FULL_NAME = CAMEL_STORE_INFO_LAST, + CAMEL_IMAPP_STORE_INFO_LAST, +}; + +struct _CamelIMAPPStoreInfo { + CamelStoreInfo info; + char *full_name; +}; + +typedef struct _CamelIMAPPStoreNamespace CamelIMAPPStoreNamespace; + +struct _CamelIMAPPStoreNamespace { + char *path; /* display path */ + char *full_name; /* real name */ + char sep; /* directory separator */ +}; + +struct _CamelIMAPPStoreSummary { + CamelStoreSummary summary; + + struct _CamelIMAPPStoreSummaryPrivate *priv; + + /* header info */ + guint32 version; /* version of base part of file */ + guint32 capabilities; + CamelIMAPPStoreNamespace *namespace; /* eventually to be a list */ +}; + +struct _CamelIMAPPStoreSummaryClass { + CamelStoreSummaryClass summary_class; +}; + +CamelType camel_imapp_store_summary_get_type (void); +CamelIMAPPStoreSummary *camel_imapp_store_summary_new (void); + +/* TODO: this api needs some more work, needs to support lists */ +CamelIMAPPStoreNamespace *camel_imapp_store_summary_namespace_new(CamelIMAPPStoreSummary *s, const char *full_name, char dir_sep); +void camel_imapp_store_summary_namespace_set(CamelIMAPPStoreSummary *s, CamelIMAPPStoreNamespace *ns); +CamelIMAPPStoreNamespace *camel_imapp_store_summary_namespace_find_path(CamelIMAPPStoreSummary *s, const char *path); +CamelIMAPPStoreNamespace *camel_imapp_store_summary_namespace_find_full(CamelIMAPPStoreSummary *s, const char *full_name); + +/* converts to/from utf8 canonical nasmes */ +char *camel_imapp_store_summary_full_to_path(CamelIMAPPStoreSummary *s, const char *full_name, char dir_sep); +char *camel_imapp_store_summary_path_to_full(CamelIMAPPStoreSummary *s, const char *path, char dir_sep); + +CamelIMAPPStoreInfo *camel_imapp_store_summary_full_name(CamelIMAPPStoreSummary *s, const char *full_name); +CamelIMAPPStoreInfo *camel_imapp_store_summary_add_from_full(CamelIMAPPStoreSummary *s, const char *full_name, char dir_sep); + +/* a convenience lookup function. always use this if path known */ +char *camel_imapp_store_summary_full_from_path(CamelIMAPPStoreSummary *s, const char *path); + +/* helper macro's */ +#define camel_imapp_store_info_full_name(s, i) (camel_store_info_string((CamelStoreSummary *)s, (const CamelStoreInfo *)i, CAMEL_IMAPP_STORE_INFO_FULL_NAME)) + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* ! _CAMEL_IMAPP_STORE_SUMMARY_H */ |