GNOME.org
 

tracker r2658 - in trunk: . data docs/reference docs/reference/libtracker-module docs/reference/tracker-indexer src/tracker-indexer src/tracker-indexer/modules

Author: carlosg
Date: Thu Dec  4 17:20:34 2008
New Revision: 2658
URL: http://svn.gnome.org/viewvc/tracker?rev=2658&view=rev

Log:
2008-12-04  Carlos Garnacho  <carlos imendio com>

        Rename libtracker-indexer to libtracker-module for consistence, as
        it's not a library to make indexers, but to make modules.

        * src/tracker-indexer/Makefile.am: Rename the library to
        libtracker-module.

        * data/tracker-indexer-module-1.0.pc.in: Moved to
        * data/tracker-module-1.0.pc.in: Added

        * docs/reference/tracker-indexer: Moved to
        * docs/reference/libtracker-module: Adapt to new modules API.

        * configure.ac:
        * data/Makefile.am:
        * docs/reference/Makefile.am: Misc changes.

        * src/tracker-indexer/modules/Makefile.am: Compile modules as
        libtracker-module-*.so, instead of libtracker-indexer-*.so

        * src/tracker-indexer/tracker-indexer-module.c: Just load
        libtracker-module-*.so.

        * src/tracker-indexer/tracker-module-file.c:
        * src/tracker-indexer/tracker-module-metadata-utils.c: Add a few docs.

Added:
   trunk/data/tracker-module-1.0.pc.in
      - copied, changed from r2657, /trunk/data/tracker-indexer-module-1.0.pc.in
   trunk/docs/reference/libtracker-module/
   trunk/docs/reference/libtracker-module/Makefile.am
      - copied, changed from r2657, /trunk/docs/reference/tracker-indexer/Makefile.am
   trunk/docs/reference/libtracker-module/adding-categories-and-properties.sgml
      - copied, changed from r2657, /trunk/docs/reference/tracker-indexer/adding-categories-and-properties.sgml
   trunk/docs/reference/libtracker-module/libtracker-module-docs.sgml
      - copied, changed from r2657, /trunk/docs/reference/tracker-indexer/tracker-indexer-docs.sgml
   trunk/docs/reference/libtracker-module/libtracker-module-sections.txt
   trunk/docs/reference/libtracker-module/version.xml.in
      - copied, changed from r2657, /trunk/docs/reference/tracker-indexer/version.xml.in
   trunk/docs/reference/libtracker-module/writing-an-extractor.sgml
      - copied, changed from r2657, /trunk/docs/reference/tracker-indexer/writing-an-extractor.sgml
   trunk/docs/reference/libtracker-module/writing-an-indexer-module.sgml
      - copied, changed from r2657, /trunk/docs/reference/tracker-indexer/writing-an-indexer-plugin.sgml
Removed:
   trunk/data/tracker-indexer-module-1.0.pc.in
   trunk/docs/reference/tracker-indexer/Makefile.am
   trunk/docs/reference/tracker-indexer/adding-categories-and-properties.sgml
   trunk/docs/reference/tracker-indexer/tracker-indexer-docs.sgml
   trunk/docs/reference/tracker-indexer/tracker-indexer-sections.txt
   trunk/docs/reference/tracker-indexer/version.xml.in
   trunk/docs/reference/tracker-indexer/writing-an-extractor.sgml
   trunk/docs/reference/tracker-indexer/writing-an-indexer-plugin.sgml
Modified:
   trunk/ChangeLog
   trunk/configure.ac
   trunk/data/Makefile.am
   trunk/docs/reference/Makefile.am
   trunk/src/tracker-indexer/Makefile.am
   trunk/src/tracker-indexer/modules/Makefile.am
   trunk/src/tracker-indexer/tracker-indexer-module.c
   trunk/src/tracker-indexer/tracker-module-file.c
   trunk/src/tracker-indexer/tracker-module-metadata-utils.c

Modified: trunk/configure.ac
==============================================================================
--- trunk/configure.ac	(original)
+++ trunk/configure.ac	Thu Dec  4 17:20:34 2008
@@ -1170,15 +1170,15 @@
 	data/modules/Makefile
 	data/services/Makefile
 	data/tracker.pc
-	data/tracker-indexer-module-1.0.pc
+	data/tracker-module-1.0.pc
 	docs/Makefile
 	docs/design/Makefile
 	docs/manpages/Makefile
 	docs/reference/Makefile
 	docs/reference/libtracker-common/Makefile
 	docs/reference/libtracker-common/version.xml
-	docs/reference/tracker-indexer/Makefile
-	docs/reference/tracker-indexer/version.xml
+	docs/reference/libtracker-module/Makefile
+	docs/reference/libtracker-module/version.xml
 	filters/application/Makefile
 	filters/Makefile
 	filters/text/Makefile

Modified: trunk/data/Makefile.am
==============================================================================
--- trunk/data/Makefile.am	(original)
+++ trunk/data/Makefile.am	Thu Dec  4 17:20:34 2008
@@ -15,7 +15,7 @@
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = 			\
 	tracker.pc			\
-	tracker-indexer-module-1.0.pc
+	tracker-module-1.0.pc
 
 if ENABLE_LIBTRACKERGTK
 pkgconfig_DATA += libtracker-gtk.pc

Copied: trunk/data/tracker-module-1.0.pc.in (from r2657, /trunk/data/tracker-indexer-module-1.0.pc.in)
==============================================================================
--- /trunk/data/tracker-indexer-module-1.0.pc.in	(original)
+++ trunk/data/tracker-module-1.0.pc.in	Thu Dec  4 17:20:34 2008
@@ -7,5 +7,5 @@
 Description: A library to develop tracker indexer modules
 Version: @VERSION@
 Requires: glib-2.0 pango
-Libs: -L${libdir}/tracker -ltracker-common -ltracker-indexer
+Libs: -L${libdir}/tracker -ltracker-module
 Cflags: -I${includedir}/tracker-1.0

Modified: trunk/docs/reference/Makefile.am
==============================================================================
--- trunk/docs/reference/Makefile.am	(original)
+++ trunk/docs/reference/Makefile.am	Thu Dec  4 17:20:34 2008
@@ -2,5 +2,5 @@
 
 SUBDIRS = 			\
 	libtracker-common 	\
-	tracker-indexer
+	libtracker-module
 

Copied: trunk/docs/reference/libtracker-module/Makefile.am (from r2657, /trunk/docs/reference/tracker-indexer/Makefile.am)
==============================================================================
--- /trunk/docs/reference/tracker-indexer/Makefile.am	(original)
+++ trunk/docs/reference/libtracker-module/Makefile.am	Thu Dec  4 17:20:34 2008
@@ -3,10 +3,10 @@
 AUTOMAKE_OPTIONS = 1.6
 
 # The name of the module.
-DOC_MODULE=tracker-indexer
+DOC_MODULE=libtracker-module
 
 # The top-level SGML file.
-DOC_MAIN_SGML_FILE=tracker-indexer-docs.sgml
+DOC_MAIN_SGML_FILE=libtracker-module-docs.sgml
 
 # Extra options to supply to gtkdoc-scan
 # SCAN_OPTIONS=--deprecated-guards="G_GNUC_DEPRECATED"
@@ -68,12 +68,12 @@
 	version.xml				\
 	adding-categories-and-properties.sgml	\
 	writing-an-extractor.sgml		\
-	writing-an-indexer-plugin.sgml
+	writing-an-indexer-module.sgml
 
 expand_content_files =				\
 	adding-categories-and-properties.sgml	\
 	writing-an-extractor.sgml		\
-	writing-an-indexer-plugin.sgml
+	writing-an-indexer-module.sgml
 
 # Images to copy into HTML directory
 HTML_IMAGES =

Copied: trunk/docs/reference/libtracker-module/adding-categories-and-properties.sgml (from r2657, /trunk/docs/reference/tracker-indexer/adding-categories-and-properties.sgml)
==============================================================================

Copied: trunk/docs/reference/libtracker-module/libtracker-module-docs.sgml (from r2657, /trunk/docs/reference/tracker-indexer/tracker-indexer-docs.sgml)
==============================================================================
--- /trunk/docs/reference/tracker-indexer/tracker-indexer-docs.sgml	(original)
+++ trunk/docs/reference/libtracker-module/libtracker-module-docs.sgml	Thu Dec  4 17:20:34 2008
@@ -1,9 +1,10 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
-<!ENTITY tracker-module SYSTEM "xml/tracker-module.xml">
-<!ENTITY tracker-metadata SYSTEM "xml/tracker-metadata.xml">
-<!ENTITY tracker-metadata-utils SYSTEM "xml/tracker-metadata-utils.xml">
+<!ENTITY tracker-module-file SYSTEM "xml/tracker-module-file.xml">
+<!ENTITY tracker-module-iteratable SYSTEM "xml/tracker-module-iteratable.xml">
+<!ENTITY tracker-module-metadata SYSTEM "xml/tracker-module-metadata.xml">
+<!ENTITY tracker-module-metadata-utils SYSTEM "xml/tracker-module-metadata-utils.xml">
 <!ENTITY adding-categories-and-properties SYSTEM "xml/adding-categories-and-properties.sgml">
 <!ENTITY writing-an-extractor SYSTEM "xml/writing-an-extractor.sgml">
 <!ENTITY writing-an-indexer-plugin SYSTEM "xml/writing-an-indexer-plugin.sgml">
@@ -31,13 +32,14 @@
 
     <chapter>
       <title>Modules</title>
-      &tracker-module;
+      &tracker-module-file;
+      &tracker-module-iteratable;
     </chapter>
 
     <chapter>
       <title>Metadata</title>
-      &tracker-metadata;
-      &tracker-metadata-utils;
+      &tracker-module-metadata;
+      &tracker-module-metadata-utils;
     </chapter>
 
     <part id="integrating-applications">

Added: trunk/docs/reference/libtracker-module/libtracker-module-sections.txt
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libtracker-module/libtracker-module-sections.txt	Thu Dec  4 17:20:34 2008
@@ -0,0 +1,44 @@
+<INCLUDE>libtracker-module/tracker-module-file.h</INCLUDE>
+<SECTION>
+<FILE>tracker-module-file</FILE>
+<TITLE>Module files</TITLE>
+TrackerModuleFile
+tracker_module_file_get_file
+tracker_module_file_get_service_type
+tracker_module_file_get_uri
+tracker_module_file_get_text
+tracker_module_file_get_metadata
+</SECTION>
+
+<INCLUDE>libtracker-module/tracker-module-iteratable.h</INCLUDE>
+<SECTION>
+<FILE>tracker-module-iteratable</FILE>
+<TITLE>Iteratable files</TITLE>
+TrackerModuleIteratable
+tracker_module_iteratable_iter_contents
+tracker_module_iteratable_get_count
+</SECTION>
+
+<INCLUDE>libtracker-module/tracker-module-metadata.h</INCLUDE>
+<SECTION>
+<FILE>tracker-module-metadata</FILE>
+<TITLE>Metadata Object</TITLE>
+TrackerModuleMetadata
+tracker_module_metadata_new
+tracker_module_metadata_clear_field
+tracker_module_metadata_add_take_string
+tracker_module_metadata_add_string
+tracker_module_metadata_add_int
+tracker_module_metadata_add_uint
+tracker_module_metadata_add_double
+tracker_module_metadata_add_float
+tracker_module_metadata_add_date
+</SECTION>
+
+<INCLUDE>libtracker-module/tracker-module-metadata-utils.h</INCLUDE>
+<SECTION>
+<FILE>tracker-module-metadata-utils</FILE>
+<TITLE>Metadata Convenience Fallback Functions</TITLE>
+tracker_module_metadata_utils_get_data
+tracker_module_metadata_utils_get_text
+</SECTION>

Copied: trunk/docs/reference/libtracker-module/version.xml.in (from r2657, /trunk/docs/reference/tracker-indexer/version.xml.in)
==============================================================================

Copied: trunk/docs/reference/libtracker-module/writing-an-extractor.sgml (from r2657, /trunk/docs/reference/tracker-indexer/writing-an-extractor.sgml)
==============================================================================
--- /trunk/docs/reference/tracker-indexer/writing-an-extractor.sgml	(original)
+++ trunk/docs/reference/libtracker-module/writing-an-extractor.sgml	Thu Dec  4 17:20:34 2008
@@ -162,6 +162,6 @@
 <!--
 Local variables:
 mode: sgml
-sgml-parent-document: ("tracker-indexer-docs.sgml" "book" "part" "chapter")
+sgml-parent-document: ("libtracker-module-docs.sgml" "book" "part" "chapter")
 End:
 -->

Copied: trunk/docs/reference/libtracker-module/writing-an-indexer-module.sgml (from r2657, /trunk/docs/reference/tracker-indexer/writing-an-indexer-plugin.sgml)
==============================================================================
--- /trunk/docs/reference/tracker-indexer/writing-an-indexer-plugin.sgml	(original)
+++ trunk/docs/reference/libtracker-module/writing-an-indexer-module.sgml	Thu Dec  4 17:20:34 2008
@@ -1,4 +1,4 @@
-<chapter id="writing-an-indexer-plugin">
+<chapter id="writing-an-indexer-module">
   <chapterinfo>
     <author>
       <firstname>Carlos</firstname>
@@ -11,7 +11,7 @@
     </author>
   </chapterinfo>
 
-  <title>Writing An Indexer Plugin</title>
+  <title>Writing An Indexer Module</title>
 
   <para>
     Tracker's indexer has a modular design, so applications can

Modified: trunk/src/tracker-indexer/Makefile.am
==============================================================================
--- trunk/src/tracker-indexer/Makefile.am	(original)
+++ trunk/src/tracker-indexer/Makefile.am	Thu Dec  4 17:20:34 2008
@@ -15,17 +15,17 @@
 	$(PANGO_CFLAGS)							\
 	$(GMODULE_CFLAGS)
 
-libtracker_indexerdir = $(libdir)/tracker
-libtracker_indexerincludedir=$(includedir)/tracker-1.0/libtracker-indexer/
-libtracker_indexer_LTLIBRARIES = libtracker-indexer.la
+libtracker_moduledir = $(libdir)/tracker
+libtracker_moduleincludedir=$(includedir)/tracker-1.0/libtracker-module/
+libtracker_module_LTLIBRARIES = libtracker-module.la
 
-libtracker_indexer_la_SOURCES =	 					\
+libtracker_module_la_SOURCES =	 					\
 	tracker-module-file.c						\
 	tracker-module-iteratable.c					\
 	tracker-module-metadata-utils.c					\
 	tracker-module-metadata.c
 
-libtracker_indexerinclude_HEADERS =					\
+libtracker_moduleinclude_HEADERS =					\
 	tracker-module-file.h						\
 	tracker-module-iteratable.h					\
 	tracker-module-metadata-utils.h					\
@@ -45,7 +45,7 @@
 	tracker-module-metadata-private.h
 
 tracker_indexer_LDADD =							\
-	libtracker-indexer.la						\
+	libtracker-module.la						\
 	$(top_builddir)/src/libtracker-data/libtracker-data.la		\
 	$(top_builddir)/src/libtracker-db/libtracker-db.la 		\
 	$(top_builddir)/src/libtracker-common/libtracker-common.la 	\

Modified: trunk/src/tracker-indexer/modules/Makefile.am
==============================================================================
--- trunk/src/tracker-indexer/modules/Makefile.am	(original)
+++ trunk/src/tracker-indexer/modules/Makefile.am	Thu Dec  4 17:20:34 2008
@@ -19,31 +19,30 @@
 	$(GMIME_CFLAGS)
 
 indexer_modules_LTLIBRARIES = 						\
-	libtracker-indexer-applications.la				\
-	libtracker-indexer-files.la					\
-	libtracker-indexer-gaim-conversations.la
+	libtracker-module-applications.la				\
+	libtracker-module-files.la					\
+	libtracker-module-gaim-conversations.la
 
 # Applications module
-libtracker_indexer_applications_la_SOURCES = applications.c
-libtracker_indexer_applications_la_LDFLAGS = $(module_flags)
-libtracker_indexer_applications_la_LIBADD = 				\
+libtracker_module_applications_la_SOURCES = applications.c
+libtracker_module_applications_la_LDFLAGS = $(module_flags)
+libtracker_module_applications_la_LIBADD = 				\
 	$(GMODULE_LIBS)							\
 	$(GIO_LIBS)							\
 	$(GLIB2_LIBS)
 
 # Files module
-libtracker_indexer_files_la_SOURCES = files.c
-libtracker_indexer_files_la_LDFLAGS = $(module_flags)
-libtracker_indexer_files_la_LIBADD = 					\
-	$(top_builddir)/src/libtracker-db/libtracker-db.la		\
+libtracker_module_files_la_SOURCES = files.c
+libtracker_module_files_la_LDFLAGS = $(module_flags)
+libtracker_module_files_la_LIBADD = 					\
 	$(GMODULE_LIBS)							\
 	$(GIO_LIBS)							\
 	$(GLIB2_LIBS)
 
 # Instant messaging module
-libtracker_indexer_gaim_conversations_la_SOURCES = gaim-conversations.c
-libtracker_indexer_gaim_conversations_la_LDFLAGS = $(module_flags)
-libtracker_indexer_gaim_conversations_la_LIBADD = 			\
+libtracker_module_gaim_conversations_la_SOURCES = gaim-conversations.c
+libtracker_module_gaim_conversations_la_LDFLAGS = $(module_flags)
+libtracker_module_gaim_conversations_la_LIBADD = 			\
 	$(GMODULE_LIBS)							\
 	$(GIO_LIBS)							\
 	$(GLIB2_LIBS)
@@ -51,10 +50,10 @@
 if HAVE_GCONF
 
 indexer_modules_LTLIBRARIES += 						\
-	libtracker-indexer-evolution.la
+	libtracker-module-evolution.la
 
 # Evolution
-libtracker_indexer_evolution_la_SOURCES =				\
+libtracker_module_evolution_la_SOURCES =				\
 	evolution-common.c						\
 	evolution-common.h						\
 	evolution-imap.c						\
@@ -63,8 +62,8 @@
 	evolution-pop.h							\
 	evolution.c
 
-libtracker_indexer_evolution_la_LDFLAGS = $(module_flags)
-libtracker_indexer_evolution_la_LIBADD = 				\
+libtracker_module_evolution_la_LDFLAGS = $(module_flags)
+libtracker_module_evolution_la_LIBADD = 				\
 	$(GMODULE_LIBS)							\
 	$(GLIB2_LIBS)							\
 	$(GCONF_LIBS)							\

Modified: trunk/src/tracker-indexer/tracker-indexer-module.c
==============================================================================
--- trunk/src/tracker-indexer/tracker-indexer-module.c	(original)
+++ trunk/src/tracker-indexer/tracker-indexer-module.c	Thu Dec  4 17:20:34 2008
@@ -51,7 +51,7 @@
 
 	indexer_module = TRACKER_INDEXER_MODULE (module);
 
-	full_name = g_strdup_printf ("libtracker-indexer-%s", indexer_module->name);
+	full_name = g_strdup_printf ("libtracker-module-%s", indexer_module->name);
 	path = g_build_filename (INDEXER_MODULES_DIR, full_name, NULL);
 
 	indexer_module->module = g_module_open (path, G_MODULE_BIND_LOCAL);

Modified: trunk/src/tracker-indexer/tracker-module-file.c
==============================================================================
--- trunk/src/tracker-indexer/tracker-module-file.c	(original)
+++ trunk/src/tracker-indexer/tracker-module-file.c	Thu Dec  4 17:20:34 2008
@@ -145,6 +145,14 @@
         }
 }
 
+/**
+ * tracker_module_file_get_file:
+ * @file: A #TrackerModuleFile
+ *
+ * Returns a #GFile corresponding to the file managed by #TrackerModuleFile.
+ *
+ * Returns: a #GFile, this object should not be unreferenced.
+ **/
 GFile *
 tracker_module_file_get_file (TrackerModuleFile *file)
 {
@@ -198,6 +206,14 @@
         return TRACKER_MODULE_FILE_GET_CLASS (file)->get_text (file);
 }
 
+/**
+ * tracker_module_file_get_metadata:
+ * @file: A #TrackerModuleFile
+ *
+ * Extracts all the metadata corresponding to @file in the current state.
+ *
+ * Returns: A #TrackerModuleMetadata containing all the extracted metadata.
+ **/
 TrackerModuleMetadata *
 tracker_module_file_get_metadata (TrackerModuleFile *file)
 {

Modified: trunk/src/tracker-indexer/tracker-module-metadata-utils.c
==============================================================================
--- trunk/src/tracker-indexer/tracker-module-metadata-utils.c	(original)
+++ trunk/src/tracker-indexer/tracker-module-metadata-utils.c	Thu Dec  4 17:20:34 2008
@@ -746,10 +746,10 @@
 }
 
 /**
- * tracker_metadata_utils_get_text:
- * @path: Path to a local file
+ * tracker_module_metadata_utils_get_text:
+ * @file: A #GFile
  *
- * Gets the text from a given file, if the file is considered as
+ * Gets the text from @file, if the file is considered as
  * containing plain text, it will be extracted, else this function
  * will resort to the installed text filters for the file MIME type.
  *
@@ -782,8 +782,8 @@
 }
 
 /**
- * tracker_metadata_utils_get_data:
- * @path: Path to a local file
+ * tracker_module_metadata_utils_get_data:
+ * @file: A #GFile
  *
  * Returns a #TrackerModuleMetadata filled in with all the
  * metadata that could be extracted for the given file.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]