GNOME.org
 

[tracker] libtracker-data: Cleaned up headers, and add tracker-data.h

commit 6e40041aaccd159320a1b24163eafebba443e184
Author: Martyn Russell <martyn lanedo com>
Date:   Fri Oct 2 12:31:15 2009 +0100

    libtracker-data: Cleaned up headers, and add tracker-data.h

 src/libtracker-data/Makefile.am            |    1 +
 src/libtracker-data/tracker-data-backup.h  |   32 +++++----
 src/libtracker-data/tracker-data-manager.h |   26 ++++---
 src/libtracker-data/tracker-data-query.h   |   18 +++--
 src/libtracker-data/tracker-data-update.h  |  103 ++++++++++++++-------------
 src/libtracker-data/tracker-data.h         |   42 +++++++++++
 src/libtracker-db/tracker-db-interface.h   |   81 +++++++++++-----------
 7 files changed, 180 insertions(+), 123 deletions(-)
---
diff --git a/src/libtracker-data/Makefile.am b/src/libtracker-data/Makefile.am
index a2b2ce5..71cee4b 100644
--- a/src/libtracker-data/Makefile.am
+++ b/src/libtracker-data/Makefile.am
@@ -30,6 +30,7 @@ libtracker_data_la_SOURCES = 						\
 	$(libtracker_data_la_VALASOURCES:.vala=.c)
 
 noinst_HEADERS =							\
+	tracker-data.h							\
 	tracker-data-backup.h						\
 	tracker-data-manager.h						\
 	tracker-data-query.h						\
diff --git a/src/libtracker-data/tracker-data-backup.h b/src/libtracker-data/tracker-data-backup.h
index 4375e06..fba5da7 100644
--- a/src/libtracker-data/tracker-data-backup.h
+++ b/src/libtracker-data/tracker-data-backup.h
@@ -18,27 +18,33 @@
  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA  02110-1301, USA.
  */
-#ifndef __TRACKER_DATA_BACKUP_H__
-#define __TRACKER_DATA_BACKUP_H__
+
+#ifndef __LIBTRACKER_DATA_BACKUP_H__
+#define __LIBTRACKER_DATA_BACKUP_H__
 
 #include <glib.h>
 #include <gio/gio.h>
 
 G_BEGIN_DECLS
 
-typedef void (*TrackerDataBackupFinished)   (GError *error, gpointer user_data);
+#if !defined (__LIBTRACKER_DATA_INSIDE__) && !defined (TRACKER_COMPILATION)
+#error "only <libtracker-data/tracker-data.h> must be included directly."
+#endif
 
-GQuark    tracker_data_backup_error_quark (void);
+typedef void (*TrackerDataBackupFinished) (GError *error, gpointer user_data);
 
-void      tracker_data_backup_save        (GFile *destination, GFile *journal,
-                                           TrackerDataBackupFinished callback,
-                                           gpointer user_data,
-                                           GDestroyNotify destroy);
-void      tracker_data_backup_restore     (GFile *backup, GFile *journal,
-                                           TrackerDataBackupFinished callback,
-                                           gpointer user_data,
-                                           GDestroyNotify destroy);
+GQuark tracker_data_backup_error_quark (void);
+void   tracker_data_backup_save        (GFile                     *destination,
+					GFile                     *journal,
+					TrackerDataBackupFinished  callback,
+					gpointer                   user_data,
+					GDestroyNotify             destroy);
+void   tracker_data_backup_restore     (GFile                     *backup,
+					GFile                     *journal,
+					TrackerDataBackupFinished  callback,
+					gpointer                   user_data,
+					GDestroyNotify             destroy);
 
 G_END_DECLS
 
-#endif /* __TRACKER_DATA_BACKUP_H__ */
+#endif /* __LIBTRACKER_DATA_BACKUP_H__ */
diff --git a/src/libtracker-data/tracker-data-manager.h b/src/libtracker-data/tracker-data-manager.h
index ba948dd..364851a 100644
--- a/src/libtracker-data/tracker-data-manager.h
+++ b/src/libtracker-data/tracker-data-manager.h
@@ -21,8 +21,8 @@
  * Boston, MA  02110-1301, USA.
  */
 
-#ifndef __TRACKER_DATA_MANAGER_H__
-#define __TRACKER_DATA_MANAGER_H__
+#ifndef __LIBTRACKER_DATA_MANAGER_H__
+#define __LIBTRACKER_DATA_MANAGER_H__
 
 #include <glib.h>
 
@@ -34,17 +34,19 @@
 
 G_BEGIN_DECLS
 
-gboolean            tracker_data_manager_init              (TrackerDBManagerFlags       flags,
-							    const gchar                *test_schema,
-							    gboolean                   *first_time,
-							    gboolean                   *need_journal);
-void                tracker_data_manager_shutdown          (void);
-
-gint64              tracker_data_manager_get_db_option_int64 (const gchar        *option);
-void                tracker_data_manager_set_db_option_int64 (const gchar        *option,
-							      gint64              value);
+#if !defined (__LIBTRACKER_DATA_INSIDE__) && !defined (TRACKER_COMPILATION)
+#error "only <libtracker-data/tracker-data.h> must be included directly."
+#endif
 
+gboolean tracker_data_manager_init                (TrackerDBManagerFlags  flags,
+						   const gchar           *test_schema,
+						   gboolean              *first_time,
+						   gboolean              *need_journal);
+void     tracker_data_manager_shutdown            (void);
+gint64   tracker_data_manager_get_db_option_int64 (const gchar           *option);
+void     tracker_data_manager_set_db_option_int64 (const gchar           *option,
+						   gint64                 value);
 
 G_END_DECLS
 
-#endif /* __TRACKER_DATA_MANAGER_H__ */
+#endif /* __LIBTRACKER_DATA_MANAGER_H__ */
diff --git a/src/libtracker-data/tracker-data-query.h b/src/libtracker-data/tracker-data-query.h
index fbc10ec..5d14273 100644
--- a/src/libtracker-data/tracker-data-query.h
+++ b/src/libtracker-data/tracker-data-query.h
@@ -21,8 +21,8 @@
  * Boston, MA  02110-1301, USA.
  */
 
-#ifndef __TRACKER_DATA_QUERY_H__
-#define __TRACKER_DATA_QUERY_H__
+#ifndef __LIBTRACKER_DATA_QUERY_H__
+#define __LIBTRACKER_DATA_QUERY_H__
 
 #include <glib.h>
 
@@ -34,11 +34,15 @@
 
 G_BEGIN_DECLS
 
-guint32              tracker_data_query_resource_id      (const gchar   *uri);
-TrackerDBResultSet  *tracker_data_query_sparql           (const gchar   *query,
-                                                          GError       **error);
-GPtrArray*           tracker_data_query_rdf_type         (guint32        id);
+#if !defined (__LIBTRACKER_DATA_INSIDE__) && !defined (TRACKER_COMPILATION)
+#error "only <libtracker-data/tracker-data.h> must be included directly."
+#endif
+
+guint32              tracker_data_query_resource_id (const gchar  *uri);
+TrackerDBResultSet  *tracker_data_query_sparql      (const gchar  *query,
+						     GError      **error);
+GPtrArray*           tracker_data_query_rdf_type    (guint32       id);
 
 G_END_DECLS
 
-#endif /* __TRACKER_DATA_QUERY_H__ */
+#endif /* __LIBTRACKER_DATA_QUERY_H__ */
diff --git a/src/libtracker-data/tracker-data-update.h b/src/libtracker-data/tracker-data-update.h
index 9bd06e8..07dfd07 100644
--- a/src/libtracker-data/tracker-data-update.h
+++ b/src/libtracker-data/tracker-data-update.h
@@ -19,8 +19,8 @@
  * Boston, MA  02110-1301, USA.
  */
 
-#ifndef __TRACKER_DATA_UPDATE_H__
-#define __TRACKER_DATA_UPDATE_H__
+#ifndef __LIBTRACKER_DATA_UPDATE_H__
+#define __LIBTRACKER_DATA_UPDATE_H__
 
 #include <glib.h>
 
@@ -30,6 +30,12 @@
 
 G_BEGIN_DECLS
 
+#if !defined (__LIBTRACKER_DATA_INSIDE__) && !defined (TRACKER_COMPILATION)
+#error "only <libtracker-data/tracker-data.h> must be included directly."
+#endif
+
+#define TRACKER_DATA_ERROR tracker_data_error_quark ()
+
 typedef enum  {
 	TRACKER_DATA_ERROR_UNKNOWN_CLASS,
 	TRACKER_DATA_ERROR_UNKNOWN_PROPERTY,
@@ -37,62 +43,59 @@ typedef enum  {
 	TRACKER_DATA_ERROR_CONSTRAINT
 } TrackerDataError;
 
-#define TRACKER_DATA_ERROR tracker_data_error_quark ()
+typedef void (*TrackerStatementCallback) (const gchar *subject, 
+					  const gchar *predicate, 
+					  const gchar *object,
+					  GPtrArray   *rdf_types,
+					  gpointer     user_data);
+typedef void (*TrackerCommitCallback)    (gpointer     user_data);
 
-GQuark   tracker_data_error_quark (void);
+GQuark   tracker_data_error_quark                   (void);
 
 /* Services  */
-void     tracker_data_delete_resource                   (const gchar         *uri);
-gboolean tracker_data_update_resource_uri               (const gchar         *old_uri,
-							 const gchar         *new_uri);
+void     tracker_data_delete_resource               (const gchar               *uri);
+gboolean tracker_data_update_resource_uri           (const gchar               *old_uri,
+						     const gchar               *new_uri);
+
 /* Metadata */
-void     tracker_data_delete_resource_description       (const gchar         *uri);
-void     tracker_data_delete_statement			(const gchar	     *subject,
-							 const gchar         *predicate,
-							 const gchar         *object,
-							 GError             **error);
-
-void     tracker_data_insert_statement			(const gchar	     *subject,
-							 const gchar         *predicate,
-							 const gchar         *object,
-							 GError             **error);
-void     tracker_data_insert_statement_with_uri		(const gchar	     *subject,
-							 const gchar         *predicate,
-							 const gchar         *object,
-							 GError             **error);
-void     tracker_data_insert_statement_with_string	(const gchar	     *subject,
-							 const gchar         *predicate,
-							 const gchar         *object,
-							 GError             **error);
-void     tracker_data_begin_transaction			(void);
-void     tracker_data_commit_transaction		(void);
-
-void     tracker_data_update_sparql			(const gchar       *update,
-							 GError	          **error);
-void     tracker_data_update_buffer_flush		(void);
+void     tracker_data_delete_resource_description   (const gchar               *uri);
+void     tracker_data_delete_statement              (const gchar               *subject,
+						     const gchar               *predicate,
+						     const gchar               *object,
+						     GError                   **error);
+void     tracker_data_insert_statement              (const gchar               *subject,
+						     const gchar               *predicate,
+						     const gchar               *object,
+						     GError                   **error);
+void     tracker_data_insert_statement_with_uri     (const gchar               *subject,
+						     const gchar               *predicate,
+						     const gchar               *object,
+						     GError                   **error);
+void     tracker_data_insert_statement_with_string  (const gchar               *subject,
+						     const gchar               *predicate,
+						     const gchar               *object,
+						     GError                   **error);
+void     tracker_data_begin_transaction             (void);
+void     tracker_data_commit_transaction            (void);
+void     tracker_data_update_sparql                 (const gchar               *update,
+						     GError                   **error);
+void     tracker_data_update_buffer_flush           (void);
 
 /* Volume handling */
-void tracker_data_update_enable_volume                  (const gchar         *udi,
-                                                         const gchar         *mount_path);
-void tracker_data_update_disable_volume                 (const gchar         *udi);
-void tracker_data_update_disable_all_volumes            (void);
-void tracker_data_update_reset_volume                   (const gchar         *uri);
+void     tracker_data_update_enable_volume          (const gchar               *udi,
+						     const gchar               *mount_path);
+void     tracker_data_update_disable_volume         (const gchar               *udi);
+void     tracker_data_update_disable_all_volumes    (void);
+void     tracker_data_update_reset_volume           (const gchar               *uri);
 
 /* Calling back */
-typedef void (*TrackerStatementCallback)                (const gchar *subject, 
-							 const gchar *predicate, 
-							 const gchar *object,
-							 GPtrArray   *rdf_types,
-							 gpointer user_data);
-typedef void (*TrackerCommitCallback)                   (gpointer user_data);
-
-void tracker_data_set_insert_statement_callback         (TrackerStatementCallback callback,
-							 gpointer                 user_data);
-void tracker_data_set_delete_statement_callback         (TrackerStatementCallback callback,
-							 gpointer                 user_data);
-void tracker_data_set_commit_statement_callback         (TrackerCommitCallback    callback,
-							 gpointer                 user_data);
+void     tracker_data_set_insert_statement_callback (TrackerStatementCallback   callback,
+						     gpointer                   user_data);
+void     tracker_data_set_delete_statement_callback (TrackerStatementCallback   callback,
+						     gpointer                   user_data);
+void     tracker_data_set_commit_statement_callback (TrackerCommitCallback      callback,
+						     gpointer                   user_data);
 
 G_END_DECLS
 
-#endif /* __TRACKER_DATA_UPDATE_H__ */
+#endif /* __LIBTRACKER_DATA_UPDATE_H__ */
diff --git a/src/libtracker-data/tracker-data.h b/src/libtracker-data/tracker-data.h
new file mode 100644
index 0000000..3247ab4
--- /dev/null
+++ b/src/libtracker-data/tracker-data.h
@@ -0,0 +1,42 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
+/*
+ * Copyright (C) 2009, Nokia (urho konttori nokia com)
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA  02110-1301, USA.
+ */
+
+#ifndef __LIBTRACKER_DATA_H__
+#define __LIBTRACKER_DATA_H__
+
+G_BEGIN_DECLS
+
+#if !defined (TRACKER_ENABLE_INTERNALS) && !defined (TRACKER_COMPILATION)
+#error "TRACKER_ENABLE_INTERNALS not defined, this must be defined to use tracker's internal functions"
+#endif
+
+#define __LIBTRACKER_DATA_INSIDE__
+
+#include "tracker-data-backup.h"
+#include "tracker-data-manager.h"
+#include "tracker-data-query.h"
+#include "tracker-data-update.h"
+#include "tracker-sparql-query.h"
+
+#undef __LIBTRACKER_DATA_INSIDE__
+
+G_END_DECLS
+
+#endif /* __LIBTRACKER_DATA_H__ */
diff --git a/src/libtracker-db/tracker-db-interface.h b/src/libtracker-db/tracker-db-interface.h
index 3dc03d0..ec16ba6 100644
--- a/src/libtracker-db/tracker-db-interface.h
+++ b/src/libtracker-db/tracker-db-interface.h
@@ -60,46 +60,46 @@ typedef enum {
 	TRACKER_DB_CORRUPT
 } TrackerDBInterfaceError;
 
-typedef struct TrackerDBInterface TrackerDBInterface;
+typedef struct TrackerDBInterface      TrackerDBInterface;
 typedef struct TrackerDBInterfaceIface TrackerDBInterfaceIface;
-typedef struct TrackerDBStatement TrackerDBStatement;
+typedef struct TrackerDBStatement      TrackerDBStatement;
 typedef struct TrackerDBStatementIface TrackerDBStatementIface;
-typedef struct TrackerDBResultSet TrackerDBResultSet;
+typedef struct TrackerDBResultSet      TrackerDBResultSet;
 typedef struct TrackerDBResultSetClass TrackerDBResultSetClass;
-typedef struct TrackerDBCursor TrackerDBCursor;
-typedef struct TrackerDBCursorIface TrackerDBCursorIface;
+typedef struct TrackerDBCursor         TrackerDBCursor;
+typedef struct TrackerDBCursorIface    TrackerDBCursorIface;
 
 struct TrackerDBInterfaceIface {
 	GTypeInterface iface;
 
-	TrackerDBStatement * (* create_statement)      (TrackerDBInterface  *interface,
-							const gchar	    *query);
-	TrackerDBResultSet * (* execute_query)	       (TrackerDBInterface  *interface,
-							GError		   **error,
-							const gchar	    *query);
-	void		     (* disconnect)	       (TrackerDBInterface  *interface);
-	void		     (* reconnect)	       (TrackerDBInterface  *interface);
+	TrackerDBStatement * (* create_statement) (TrackerDBInterface  *interface,
+						   const gchar	       *query);
+	TrackerDBResultSet * (* execute_query)	  (TrackerDBInterface  *interface,
+						   GError	      **error,
+						   const gchar	       *query);
+	void		     (* disconnect)	  (TrackerDBInterface  *interface);
+	void		     (* reconnect)	  (TrackerDBInterface  *interface);
 };
 
 struct TrackerDBStatementIface {
 	GTypeInterface iface;
 
-	void		     (* bind_double)	(TrackerDBStatement	 *stmt,
-						 int			  index,
-						 double			  value);
-	void		     (* bind_int)	(TrackerDBStatement	 *stmt,
-						 int			  index,
-						 int			  value);
-	void		     (* bind_text)	(TrackerDBStatement	 *stmt,
-						 int			  index,
-						 const gchar		 *value);
-	TrackerDBResultSet * (* execute)	(TrackerDBStatement	 *stmt,
-						 GError			**error);
-	void		     (* bind_int64)	(TrackerDBStatement	 *stmt,
-						 int			  index,
-						 gint64			  value);
-	TrackerDBCursor    * (* start_cursor)	(TrackerDBStatement	 *stmt,
-						 GError			**error);
+	void		     (* bind_double)	(TrackerDBStatement  *stmt,
+						 int		      index,
+						 double		      value);
+	void		     (* bind_int)	(TrackerDBStatement  *stmt,
+						 int		      index,
+						 int		      value);
+	void		     (* bind_text)	(TrackerDBStatement  *stmt,
+						 int		      index,
+						 const gchar	     *value);
+	TrackerDBResultSet * (* execute)	(TrackerDBStatement  *stmt,
+						 GError		    **error);
+	void		     (* bind_int64)	(TrackerDBStatement  *stmt,
+						 int		      index,
+						 gint64		      value);
+	TrackerDBCursor    * (* start_cursor)	(TrackerDBStatement  *stmt,
+						 GError		    **error);
 };
 
 struct TrackerDBResultSet {
@@ -113,19 +113,18 @@ struct TrackerDBResultSetClass {
 struct TrackerDBCursorIface {
 	GTypeInterface iface;
 
-	void          (*rewind)       (TrackerDBCursor *cursor);
-	gboolean      (*iter_next)    (TrackerDBCursor *cursor);
-	guint         (*get_n_columns)(TrackerDBCursor *cursor);
-	void          (*get_value)    (TrackerDBCursor *cursor, 
-					  guint            column,
-					  GValue          *value);
-
-	const gchar*  (*get_string)   (TrackerDBCursor *cursor, 
-				       guint            column);
-	gint          (*get_int)      (TrackerDBCursor *cursor, 
-				       guint            column);
-	gdouble       (*get_double)   (TrackerDBCursor *cursor, 
-				       guint            column);
+	void          (*rewind)        (TrackerDBCursor *cursor);
+	gboolean      (*iter_next)     (TrackerDBCursor *cursor);
+	guint         (*get_n_columns) (TrackerDBCursor *cursor);
+	void          (*get_value)     (TrackerDBCursor *cursor, 
+				        guint            column,
+				        GValue          *value);
+	const gchar*  (*get_string)    (TrackerDBCursor *cursor, 
+				        guint            column);
+	gint          (*get_int)       (TrackerDBCursor *cursor, 
+				        guint            column);
+	gdouble       (*get_double)    (TrackerDBCursor *cursor, 
+				        guint            column);
 };
 
 GQuark              tracker_db_interface_error_quark       (void);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]