[evolution-data-server] e-cal-backend.h readability cleanups.

[Matthew Barnes <mbarnes src gnome org>]

commit c1aa2d6cd499be29bac69f8f0dcd52dbb48edd90
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sat Oct 6 15:42:41 2012 -0400

    e-cal-backend.h readability cleanups.

 calendar/libedata-cal/e-cal-backend.h |  421 +++++++++++++++++++++++++--------
 1 files changed, 319 insertions(+), 102 deletions(-)
---
diff --git a/calendar/libedata-cal/e-cal-backend.h b/calendar/libedata-cal/e-cal-backend.h
index dba8678..b09b7b5 100644
--- a/calendar/libedata-cal/e-cal-backend.h
+++ b/calendar/libedata-cal/e-cal-backend.h
@@ -32,16 +32,24 @@
 
 #include <libedata-cal/e-data-cal.h>
 
-G_BEGIN_DECLS
-
-
-
-#define E_TYPE_CAL_BACKEND            (e_cal_backend_get_type ())
-#define E_CAL_BACKEND(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_CAL_BACKEND, ECalBackend))
-#define E_CAL_BACKEND_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_CAL_BACKEND, ECalBackendClass))
-#define E_IS_CAL_BACKEND(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_CAL_BACKEND))
-#define E_IS_CAL_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_CAL_BACKEND))
-#define E_CAL_BACKEND_GET_CLASS(obj)  (E_CAL_BACKEND_CLASS (G_OBJECT_GET_CLASS (obj)))
+/* Standard GObject macros */
+#define E_TYPE_CAL_BACKEND \
+	(e_cal_backend_get_type ())
+#define E_CAL_BACKEND(obj) \
+	(G_TYPE_CHECK_INSTANCE_CAST \
+	((obj), E_TYPE_CAL_BACKEND, ECalBackend))
+#define E_CAL_BACKEND_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_CAST \
+	((cls), E_TYPE_CAL_BACKEND, ECalBackendClass))
+#define E_IS_CAL_BACKEND(obj) \
+	(G_TYPE_CHECK_INSTANCE_TYPE \
+	((obj), E_TYPE_CAL_BACKEND))
+#define E_IS_CAL_BACKEND_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_TYPE \
+	((cls), E_TYPE_CAL_BACKEND))
+#define E_CAL_BACKEND_GET_CLASS(obj) \
+	(G_TYPE_INSTANCE_GET_CLASS \
+	((obj), E_TYPE_CAL_BACKEND, ECalBackendClass))
 
 /**
  * CLIENT_BACKEND_PROPERTY_OPENED:
@@ -135,6 +143,8 @@ G_BEGIN_DECLS
  **/
 #define CAL_BACKEND_PROPERTY_REVISION			"revision"
 
+G_BEGIN_DECLS
+
 struct _ECalBackendCache;
 
 typedef struct _ECalBackend ECalBackend;
@@ -150,111 +160,318 @@ struct _ECalBackendClass {
 	EBackendClass parent_class;
 
 	/* Virtual methods */
-        void	(* get_backend_property)	(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *prop_name);
-        void	(* set_backend_property)	(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *prop_name, const gchar *prop_value);
-
-	void	(* open)			(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, gboolean only_if_exists);
-	void	(* remove)			(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable);
-
-	void	(* refresh)			(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable);
-	void	(* get_object)			(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *uid, const gchar *rid);
-	void	(* get_object_list)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *sexp);
-	void	(* get_free_busy)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *users, time_t start, time_t end);
-	void	(* create_objects)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *calobjs);
-	void	(* modify_objects)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *calobjs, CalObjModType mod);
-	void	(* remove_objects)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *ids, CalObjModType mod);
-	void	(* receive_objects)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *calobj);
-	void	(* send_objects)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *calobj);
-	void	(* get_attachment_uris)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *uid, const gchar *rid);
-	void	(* discard_alarm)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *uid, const gchar *rid, const gchar *auid);
-	void	(* get_timezone)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *tzid);
-	void	(* add_timezone)		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *tzobject);
-
-	void	(* start_view)			(ECalBackend *backend, EDataCalView *view);
-	void	(* stop_view)			(ECalBackend *backend, EDataCalView *view);
+	void		(*get_backend_property)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *prop_name);
+        void		(*set_backend_property)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *prop_name,
+						 const gchar *prop_value);
+
+	void		(*open)			(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 gboolean only_if_exists);
+	void		(*remove)		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable);
+
+	void		(*refresh)		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable);
+	void		(*get_object)		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *uid,
+						 const gchar *rid);
+	void		(*get_object_list)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *sexp);
+	void		(*get_free_busy)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *users,
+						 time_t start,
+						 time_t end);
+	void		(*create_objects)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *calobjs);
+	void		(*modify_objects)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *calobjs,
+						 CalObjModType mod);
+	void		(*remove_objects)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *ids,
+						 CalObjModType mod);
+	void		(*receive_objects)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *calobj);
+	void		(*send_objects)		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *calobj);
+	void		(*get_attachment_uris)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *uid,
+						 const gchar *rid);
+	void		(*discard_alarm)	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *uid,
+						 const gchar *rid,
+						 const gchar *auid);
+	void		(*get_timezone)		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *tzid);
+	void		(*add_timezone)		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *tzobject);
+
+	void		(*start_view)		(ECalBackend *backend,
+						 EDataCalView *view);
+	void		(*stop_view)		(ECalBackend *backend,
+						 EDataCalView *view);
 
 	/* Internal methods for use only in the pcs */
-	icaltimezone *(* internal_get_timezone) (ECalBackend *backend, const gchar *tzid);
+	icaltimezone *	(*internal_get_timezone)
+						(ECalBackend *backend,
+						 const gchar *tzid);
 };
 
-GType		e_cal_backend_get_type			(void);
-
+GType		e_cal_backend_get_type		(void) G_GNUC_CONST;
 icalcomponent_kind
-		e_cal_backend_get_kind			(ECalBackend *backend);
+		e_cal_backend_get_kind		(ECalBackend *backend);
 ESourceRegistry *
-		e_cal_backend_get_registry		(ECalBackend *backend);
-gboolean	e_cal_backend_is_opened			(ECalBackend *backend);
-gboolean	e_cal_backend_is_opening		(ECalBackend *backend);
-gboolean	e_cal_backend_is_readonly		(ECalBackend *backend);
-gboolean	e_cal_backend_is_removed		(ECalBackend *backend);
-
-const gchar *	e_cal_backend_get_cache_dir		(ECalBackend *backend);
-void		e_cal_backend_set_cache_dir		(ECalBackend *backend, const gchar *cache_dir);
-gchar *		e_cal_backend_create_cache_filename	(ECalBackend *backend, const gchar *uid, const gchar *filename, gint fileindex);
-
-void		e_cal_backend_add_client		(ECalBackend *backend, EDataCal *cal);
-void		e_cal_backend_remove_client		(ECalBackend *backend, EDataCal *cal);
-
-void		e_cal_backend_add_view			(ECalBackend *backend, EDataCalView *view);
-void		e_cal_backend_remove_view		(ECalBackend *backend, EDataCalView *view);
-void		e_cal_backend_foreach_view		(ECalBackend *backend, gboolean (* callback) (EDataCalView *view, gpointer user_data), gpointer user_data);
-
-void		e_cal_backend_set_notification_proxy	(ECalBackend *backend, ECalBackend *proxy);
-
-void		e_cal_backend_get_backend_property	(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *prop_name);
-void		e_cal_backend_set_backend_property	(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *prop_name, const gchar *prop_value);
-
-void		e_cal_backend_open			(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, gboolean only_if_exists);
-void		e_cal_backend_remove			(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable);
-void		e_cal_backend_refresh			(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable);
-void		e_cal_backend_get_object		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *uid, const gchar *rid);
-void		e_cal_backend_get_object_list		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *sexp);
-void		e_cal_backend_get_free_busy		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *users, time_t start, time_t end);
-void		e_cal_backend_create_objects		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *calobjs);
-void		e_cal_backend_modify_objects		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *calobjs, CalObjModType mod);
-void		e_cal_backend_remove_objects		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const GSList *ids, CalObjModType mod);
-void		e_cal_backend_receive_objects		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *calobj);
-void		e_cal_backend_send_objects		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *calobj);
-void		e_cal_backend_get_attachment_uris	(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *uid, const gchar *rid);
-void		e_cal_backend_discard_alarm		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *uid, const gchar *rid, const gchar *auid);
-void		e_cal_backend_get_timezone		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *tzid);
-void		e_cal_backend_add_timezone		(ECalBackend *backend, EDataCal *cal, guint32 opid, GCancellable *cancellable, const gchar *tzobject);
-icaltimezone *	e_cal_backend_internal_get_timezone	(ECalBackend *backend, const gchar *tzid);
-void		e_cal_backend_start_view		(ECalBackend *backend, EDataCalView *view);
-void		e_cal_backend_stop_view			(ECalBackend *backend, EDataCalView *view);
-
-void		e_cal_backend_notify_component_created	(ECalBackend *backend,
-							 /* const */ ECalComponent *component);
-void		e_cal_backend_notify_component_modified	(ECalBackend *backend,
-							 /* const */ ECalComponent *old_component,
-							 /* const */ ECalComponent *new_component);
-void		e_cal_backend_notify_component_removed	(ECalBackend *backend,
-							 const ECalComponentId *id,
-							 /* const */ ECalComponent *old_component,
-							 /* const */ ECalComponent *new_component);
+		e_cal_backend_get_registry	(ECalBackend *backend);
+gboolean	e_cal_backend_is_opened		(ECalBackend *backend);
+gboolean	e_cal_backend_is_opening	(ECalBackend *backend);
+gboolean	e_cal_backend_is_readonly	(ECalBackend *backend);
+gboolean	e_cal_backend_is_removed	(ECalBackend *backend);
+
+const gchar *	e_cal_backend_get_cache_dir	(ECalBackend *backend);
+void		e_cal_backend_set_cache_dir	(ECalBackend *backend,
+						 const gchar *cache_dir);
+gchar *		e_cal_backend_create_cache_filename
+						(ECalBackend *backend,
+						 const gchar *uid,
+						 const gchar *filename,
+						 gint fileindex);
+
+void		e_cal_backend_add_client	(ECalBackend *backend,
+						 EDataCal *cal);
+void		e_cal_backend_remove_client	(ECalBackend *backend,
+						 EDataCal *cal);
+
+void		e_cal_backend_add_view		(ECalBackend *backend,
+						 EDataCalView *view);
+void		e_cal_backend_remove_view	(ECalBackend *backend,
+						 EDataCalView *view);
+void		e_cal_backend_foreach_view	(ECalBackend *backend,
+						 gboolean (*callback) (EDataCalView *view,
+						                       gpointer user_data),
+						                       gpointer user_data);
+
+void		e_cal_backend_set_notification_proxy
+						(ECalBackend *backend,
+						 ECalBackend *proxy);
+
+void		e_cal_backend_get_backend_property
+						(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *prop_name);
+void		e_cal_backend_set_backend_property
+						(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *prop_name,
+						 const gchar *prop_value);
+
+void		e_cal_backend_open		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 gboolean only_if_exists);
+void		e_cal_backend_remove		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable);
+void		e_cal_backend_refresh		(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable);
+void		e_cal_backend_get_object	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *uid,
+						 const gchar *rid);
+void		e_cal_backend_get_object_list	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *sexp);
+void		e_cal_backend_get_free_busy	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *users,
+						 time_t start,
+						 time_t end);
+void		e_cal_backend_create_objects	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *calobjs);
+void		e_cal_backend_modify_objects	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *calobjs,
+						 CalObjModType mod);
+void		e_cal_backend_remove_objects	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const GSList *ids,
+						 CalObjModType mod);
+void		e_cal_backend_receive_objects	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *calobj);
+void		e_cal_backend_send_objects	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *calobj);
+void		e_cal_backend_get_attachment_uris
+						(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *uid,
+						 const gchar *rid);
+void		e_cal_backend_discard_alarm	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *uid,
+						 const gchar *rid,
+						 const gchar *auid);
+void		e_cal_backend_get_timezone	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *tzid);
+void		e_cal_backend_add_timezone	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GCancellable *cancellable,
+						 const gchar *tzobject);
+icaltimezone *	e_cal_backend_internal_get_timezone
+						(ECalBackend *backend,
+						 const gchar *tzid);
+void		e_cal_backend_start_view	(ECalBackend *backend,
+						 EDataCalView *view);
+void		e_cal_backend_stop_view		(ECalBackend *backend,
+						 EDataCalView *view);
+
+void		e_cal_backend_notify_component_created
+						(ECalBackend *backend,
+						 ECalComponent *component);
+void		e_cal_backend_notify_component_modified
+						(ECalBackend *backend,
+						 ECalComponent *old_component,
+						 ECalComponent *new_component);
+void		e_cal_backend_notify_component_removed
+						(ECalBackend *backend,
+						 const ECalComponentId *id,
+						 ECalComponent *old_component,
+						 ECalComponent *new_component);
 
 #ifndef E_CAL_DISABLE_DEPRECATED
-void		e_cal_backend_notify_object_created	(ECalBackend *backend, const gchar *calobj);
-void		e_cal_backend_notify_objects_added	(ECalBackend *backend, EDataCalView *view, const GSList *objects);
-void		e_cal_backend_notify_object_modified	(ECalBackend *backend, const gchar *old_object, const gchar *object);
-void		e_cal_backend_notify_objects_modified	(ECalBackend *backend, EDataCalView *view, const GSList *objects);
-void		e_cal_backend_notify_object_removed	(ECalBackend *backend, const ECalComponentId *id, const gchar *old_object, const gchar *new_object);
-void		e_cal_backend_notify_objects_removed	(ECalBackend *backend, EDataCalView *view, const GSList *ids);
+void		e_cal_backend_notify_object_created
+						(ECalBackend *backend,
+						 const gchar *calobj);
+void		e_cal_backend_notify_objects_added
+						(ECalBackend *backend,
+						 EDataCalView *view,
+						 const GSList *objects);
+void		e_cal_backend_notify_object_modified
+						(ECalBackend *backend,
+						 const gchar *old_object,
+						 const gchar *object);
+void		e_cal_backend_notify_objects_modified
+						(ECalBackend *backend,
+						 EDataCalView *view,
+						 const GSList *objects);
+void		e_cal_backend_notify_object_removed
+						(ECalBackend *backend,
+						 const ECalComponentId *id,
+						 const gchar *old_object,
+						 const gchar *new_object);
+void		e_cal_backend_notify_objects_removed
+						(ECalBackend *backend,
+						 EDataCalView *view,
+						 const GSList *ids);
 #endif
 
-void		e_cal_backend_notify_error		(ECalBackend *backend, const gchar *message);
-void		e_cal_backend_notify_readonly		(ECalBackend *backend, gboolean is_readonly);
-void		e_cal_backend_notify_online		(ECalBackend *backend, gboolean is_online);
-void		e_cal_backend_notify_opened		(ECalBackend *backend, GError *error);
-void		e_cal_backend_notify_property_changed	(ECalBackend *backend, const gchar *prop_name, const gchar *prop_value);
-
-void		e_cal_backend_empty_cache		(ECalBackend *backend, struct _ECalBackendCache *cache);
+void		e_cal_backend_notify_error	(ECalBackend *backend,
+						 const gchar *message);
+void		e_cal_backend_notify_readonly	(ECalBackend *backend,
+						 gboolean is_readonly);
+void		e_cal_backend_notify_online	(ECalBackend *backend,
+						 gboolean is_online);
+void		e_cal_backend_notify_opened	(ECalBackend *backend,
+						 GError *error);
+void		e_cal_backend_notify_property_changed
+						(ECalBackend *backend,
+						 const gchar *prop_name,
+						 const gchar *prop_value);
+
+void		e_cal_backend_empty_cache	(ECalBackend *backend,
+						 struct _ECalBackendCache *cache);
 
 /* protected functions for subclasses */
-void		e_cal_backend_set_is_removed		(ECalBackend *backend, gboolean is_removed);
+void		e_cal_backend_set_is_removed	(ECalBackend *backend,
+						 gboolean is_removed);
 
-void		e_cal_backend_respond_opened		(ECalBackend *backend, EDataCal *cal, guint32 opid, GError *error);
+void		e_cal_backend_respond_opened	(ECalBackend *backend,
+						 EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
 
 G_END_DECLS
 
-#endif
+#endif /* E_CAL_BACKEND_H */