GNOME.org
 

[libgrss] Removed installation of internal headers Removed internal objects from public documentation Added Fe

commit 2d25465fb64f83d3679c7e31f172df14f33fc58d
Author: Roberto Guido <bob4mail gmail com>
Date:   Sun Mar 28 18:25:09 2010 +0200

    Removed installation of internal headers
    Removed internal objects from public documentation
    Added FeedsGroup in documentation
    Removed common.h file and merged related inclusions in utils.h

 doc/reference/libgrss-docs.sgml    |   15 +----------
 doc/reference/libgrss-sections.txt |   48 ++++++-----------------------------
 src/Makefile.am                    |   17 ++++++------
 src/common.h                       |   44 ---------------------------------
 src/feed-atom-handler.c            |    4 +--
 src/feed-atom-handler.h            |    3 +-
 src/feed-channel.h                 |    2 +-
 src/feed-enclosure.c               |    2 +-
 src/feed-enclosure.h               |    2 +-
 src/feed-handler.h                 |    3 +-
 src/feed-item.h                    |    4 +--
 src/feed-parser.c                  |    5 +--
 src/feed-parser.h                  |    3 +-
 src/feed-pie-handler.c             |    1 +
 src/feed-pie-handler.h             |    3 +-
 src/feed-rss-handler.c             |    1 +
 src/feed-rss-handler.h             |    3 +-
 src/feeds-group-handler.h          |    3 +-
 src/feeds-group.c                  |   17 ++++++++++--
 src/feeds-group.h                  |    6 ++--
 src/feeds-opml-group-handler.c     |    7 +----
 src/feeds-opml-group-handler.h     |    3 +-
 src/feeds-pool.h                   |    3 +-
 src/feeds-store.h                  |    4 +--
 src/feeds-subscriber.h             |    4 +--
 src/libgrss.h                      |   12 ++++++++-
 src/ns-handler.h                   |    4 +--
 src/utils.h                        |   14 +++++++++-
 28 files changed, 79 insertions(+), 158 deletions(-)
---
diff --git a/doc/reference/libgrss-docs.sgml b/doc/reference/libgrss-docs.sgml
index f4b81a1..c9e7c2f 100644
--- a/doc/reference/libgrss-docs.sgml
+++ b/doc/reference/libgrss-docs.sgml
@@ -30,27 +30,14 @@
     <xi:include href="xml/feed-channel.xml"/>
     <xi:include href="xml/feed-item.xml"/>
     <xi:include href="xml/feed-enclosure.xml"/>
-  </part>
-
-  <part id="libgrss-parser">
-    <title>Feeds Parsing</title>
-
     <xi:include href="xml/feed-parser.xml"/>
-    <xi:include href="xml/feed-handler.xml"/>
-
-    <chapter id="libgrss-available-parsers">
-      <xi:include href="xml/feed-rss-handler.xml"/>
-      <xi:include href="xml/feed-atom-handler.xml"/>
-      <xi:include href="xml/feed-pie-handler.xml"/>
-    </chapter>
-
-    <xi:include href="xml/ns-handler.xml"/>
   </part>
 
   <part id="libgrss-utils">
     <title>Useful Objects</title>
 
     <xi:include href="xml/feeds-pool.xml"/>
+    <xi:include href="xml/feeds-group.xml"/>
     <xi:include href="xml/feeds-subscriber.xml"/>
     <xi:include href="xml/feeds-store.xml"/>
   </part>
diff --git a/doc/reference/libgrss-sections.txt b/doc/reference/libgrss-sections.txt
index a184c0c..357d0fc 100644
--- a/doc/reference/libgrss-sections.txt
+++ b/doc/reference/libgrss-sections.txt
@@ -89,45 +89,6 @@ feed_parser_parse
 </SECTION>
 
 <SECTION>
-<FILE>feed-atom-handler</FILE>
-<TITLE>FeedAtomHandler</TITLE>
-FeedAtomHandler
-feed_atom_handler_new
-</SECTION>
-
-<SECTION>
-<FILE>feed-pie-handler</FILE>
-<TITLE>FeedPieHandler</TITLE>
-FeedPieHandler
-feed_pie_handler_new
-</SECTION>
-
-<SECTION>
-<FILE>feed-handler</FILE>
-<TITLE>FeedHandler</TITLE>
-FeedHandler
-feed_handler_set_ns_handler
-feed_handler_check_format
-feed_handler_parse
-</SECTION>
-
-<SECTION>
-<FILE>feed-rss-handler</FILE>
-<TITLE>FeedRssHandler</TITLE>
-FeedRssHandler
-feed_rss_handler_new
-</SECTION>
-
-<SECTION>
-<FILE>ns-handler</FILE>
-<TITLE>NSHandler</TITLE>
-NSHandler
-ns_handler_new
-ns_handler_channel
-ns_handler_item
-</SECTION>
-
-<SECTION>
 <FILE>feed-channel</FILE>
 <TITLE>FeedChannel</TITLE>
 FeedChannel
@@ -168,3 +129,12 @@ feed_channel_set_update_interval
 feed_channel_get_update_interval
 feed_channel_fetch
 </SECTION>
+
+<SECTION>
+<FILE>feeds-group</FILE>
+<TITLE>FeedsGroup</TITLE>
+FeedsGroup
+feeds_group_new
+feeds_group_parse_file
+feeds_group_export_file
+</SECTION>
diff --git a/src/Makefile.am b/src/Makefile.am
index e3d8afb..47bbfe9 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -11,26 +11,25 @@ INCLUDES = \
 LDADD = $(LIBGRSS_LT_LDFLAGS) -export-dynamic -rpath $(libdir)
 
 sources_private_h = \
+	feed-atom-handler.h        \
+	feed-handler.h             \
+	feed-rss-handler.h         \
+	feed-pie-handler.h         \
+	feeds-group-handler.h      \
+	feeds-opml-group-handler.h \
+	ns-handler.h               \
 	utils.h
 
 sources_public_h = \
-	common.h                   \
 	libgrss.h                  \
-	feed-atom-handler.h        \
 	feed-channel.h             \
 	feed-enclosure.h           \
-	feed-handler.h             \
 	feed-item.h                \
 	feed-parser.h              \
-	feed-rss-handler.h         \
-	feed-pie-handler.h         \
 	feeds-group.h              \
-	feeds-group-handler.h      \
-	feeds-opml-group-handler.h \
 	feeds-pool.h               \
 	feeds-store.h              \
-	feeds-subscriber.h         \
-	ns-handler.h
+	feeds-subscriber.h
 
 sources_c = \
 	$(marshal_source)          \
diff --git a/src/feed-atom-handler.c b/src/feed-atom-handler.c
index 72247ee..b58b8a4 100644
--- a/src/feed-atom-handler.c
+++ b/src/feed-atom-handler.c
@@ -28,9 +28,7 @@
 
 #include "feed-atom-handler.h"
 #include "utils.h"
-#include "feed-channel.h"
-#include "feed-item.h"
-#include "feed-enclosure.h"
+#include "feed-handler.h"
 #include "ns-handler.h"
 
 #define FEED_ATOM_HANDLER_GET_PRIVATE(o)	(G_TYPE_INSTANCE_GET_PRIVATE ((o), FEED_ATOM_HANDLER_TYPE, FeedAtomHandlerPrivate))
diff --git a/src/feed-atom-handler.h b/src/feed-atom-handler.h
index acdee4c..2f76ccb 100644
--- a/src/feed-atom-handler.h
+++ b/src/feed-atom-handler.h
@@ -21,8 +21,7 @@
 #ifndef __FEED_ATOM_HANDLER_H__
 #define __FEED_ATOM_HANDLER_H__
 
-#include "common.h"
-#include "feed-handler.h"
+#include "libgrss.h"
 
 #define FEED_ATOM_HANDLER_TYPE		(feed_atom_handler_get_type())
 #define FEED_ATOM_HANDLER(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), FEED_ATOM_HANDLER_TYPE, FeedAtomHandler))
diff --git a/src/feed-channel.h b/src/feed-channel.h
index bf54d8b..72bb461 100644
--- a/src/feed-channel.h
+++ b/src/feed-channel.h
@@ -21,7 +21,7 @@
 #ifndef __FEED_CHANNEL_H__
 #define __FEED_CHANNEL_H__
 
-#include "common.h"
+#include "libgrss.h"
 
 #define FEED_CHANNEL_TYPE		(feed_channel_get_type())
 #define FEED_CHANNEL(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), FEED_CHANNEL_TYPE, FeedChannel))
diff --git a/src/feed-enclosure.c b/src/feed-enclosure.c
index 04f5711..02d3891 100644
--- a/src/feed-enclosure.c
+++ b/src/feed-enclosure.c
@@ -18,8 +18,8 @@
  * Boston, MA  02110-1301, USA.
  */
 
-#include "feed-enclosure.h"
 #include "utils.h"
+#include "feed-enclosure.h"
 
 #define FEED_ENCLOSURE_GET_PRIVATE(obj)     (G_TYPE_INSTANCE_GET_PRIVATE ((obj), FEED_ENCLOSURE_TYPE, FeedEnclosurePrivate))
 
diff --git a/src/feed-enclosure.h b/src/feed-enclosure.h
index 0a193fd..990143d 100644
--- a/src/feed-enclosure.h
+++ b/src/feed-enclosure.h
@@ -21,7 +21,7 @@
 #ifndef __FEED_ENCLOSURE_H__
 #define __FEED_ENCLOSURE_H__
 
-#include "common.h"
+#include "libgrss.h"
 
 #define FEED_ENCLOSURE_TYPE		(feed_enclosure_get_type())
 #define FEED_ENCLOSURE(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), FEED_ENCLOSURE_TYPE, FeedEnclosure))
diff --git a/src/feed-handler.h b/src/feed-handler.h
index 48a5bd4..173d86b 100644
--- a/src/feed-handler.h
+++ b/src/feed-handler.h
@@ -21,8 +21,7 @@
 #ifndef __FEED_HANDLER_H__
 #define __FEED_HANDLER_H__
 
-#include "common.h"
-#include "feed-channel.h"
+#include "libgrss.h"
 #include "ns-handler.h"
 
 #define FEED_HANDLER_TYPE			(feed_handler_get_type ())
diff --git a/src/feed-item.h b/src/feed-item.h
index 08fec3c..298b853 100644
--- a/src/feed-item.h
+++ b/src/feed-item.h
@@ -21,9 +21,7 @@
 #ifndef __FEED_ITEM_H__
 #define __FEED_ITEM_H__
 
-#include "common.h"
-#include "feed-enclosure.h"
-#include "feed-channel.h"
+#include "libgrss.h"
 
 #define FEED_ITEM_TYPE		(feed_item_get_type())
 #define FEED_ITEM(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), FEED_ITEM_TYPE, FeedItem))
diff --git a/src/feed-parser.c b/src/feed-parser.c
index d95d381..11b8620 100644
--- a/src/feed-parser.c
+++ b/src/feed-parser.c
@@ -39,9 +39,8 @@
  * SECTION: feed-parser
  * @short_description: feed parser
  *
- * The #FeedParser is just a wrapper to the many #FeedHandler available:
- * given a #FeedChannel provides to identify his type and invoke the correct
- * parser
+ * The #FeedParser is a wrapper to the many handlers available: given a
+ * #FeedChannel provides to identify his type and invoke the correct parser.
  */
 
 #define FEED_PARSER_ERROR		feed_parser_error_quark()
diff --git a/src/feed-parser.h b/src/feed-parser.h
index 3c09ee8..d03b81a 100644
--- a/src/feed-parser.h
+++ b/src/feed-parser.h
@@ -21,8 +21,7 @@
 #ifndef __FEED_PARSER_H__
 #define __FEED_PARSER_H__
 
-#include "common.h"
-#include "feed-channel.h"
+#include "libgrss.h"
 
 #define FEED_PARSER_TYPE		(feed_parser_get_type())
 #define FEED_PARSER(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), FEED_PARSER_TYPE, FeedParser))
diff --git a/src/feed-pie-handler.c b/src/feed-pie-handler.c
index 4c7d4b1..c8ebe9d 100644
--- a/src/feed-pie-handler.c
+++ b/src/feed-pie-handler.c
@@ -25,6 +25,7 @@
  * Copyright (C) 2003-2009 Lars Lindner <lars lindner gmail com>
  */
 
+#include "feed-handler.h"
 #include "feed-pie-handler.h"
 #include "utils.h"
 #include "feed-channel.h"
diff --git a/src/feed-pie-handler.h b/src/feed-pie-handler.h
index fda08aa..33cea4f 100644
--- a/src/feed-pie-handler.h
+++ b/src/feed-pie-handler.h
@@ -21,8 +21,7 @@
 #ifndef __FEED_PIE_HANDLER_H__
 #define __FEED_PIE_HANDLER_H__
 
-#include "common.h"
-#include "feed-handler.h"
+#include "libgrss.h"
 
 #define FEED_PIE_HANDLER_TYPE		(feed_pie_handler_get_type())
 #define FEED_PIE_HANDLER(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), FEED_PIE_HANDLER_TYPE, FeedPieHandler))
diff --git a/src/feed-rss-handler.c b/src/feed-rss-handler.c
index 836a48a..bd018e7 100644
--- a/src/feed-rss-handler.c
+++ b/src/feed-rss-handler.c
@@ -34,6 +34,7 @@
  * Copyright (C) 2001 Ximian, Inc. - Chris Lahey <clahey ximian com>
  */
 
+#include "feed-handler.h"
 #include "feed-rss-handler.h"
 #include "utils.h"
 #include "feed-channel.h"
diff --git a/src/feed-rss-handler.h b/src/feed-rss-handler.h
index 84aa2f0..7ba0a62 100644
--- a/src/feed-rss-handler.h
+++ b/src/feed-rss-handler.h
@@ -21,8 +21,7 @@
 #ifndef __FEED_RSS_HANDLER_H__
 #define __FEED_RSS_HANDLER_H__
 
-#include "common.h"
-#include "feed-handler.h"
+#include "libgrss.h"
 
 #define FEED_RSS_HANDLER_TYPE		(feed_rss_handler_get_type())
 #define FEED_RSS_HANDLER(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), FEED_RSS_HANDLER_TYPE, FeedRssHandler))
diff --git a/src/feeds-group-handler.h b/src/feeds-group-handler.h
index 7eb82d8..dac1845 100644
--- a/src/feeds-group-handler.h
+++ b/src/feeds-group-handler.h
@@ -21,8 +21,7 @@
 #ifndef __FEEDS_GROUP_HANDLER_H__
 #define __FEEDS_GROUP_HANDLER_H__
 
-#include "common.h"
-#include "feed-channel.h"
+#include "libgrss.h"
 
 #define FEEDS_GROUP_HANDLER_TYPE		(feeds_group_handler_get_type ())
 #define FEEDS_GROUP_HANDLER(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), FEEDS_GROUP_HANDLER_TYPE, FeedsGroupHandler))
diff --git a/src/feeds-group.c b/src/feeds-group.c
index 5ecd173..06be717 100644
--- a/src/feeds-group.c
+++ b/src/feeds-group.c
@@ -31,7 +31,7 @@
  * @short_description: import and export group of channels
  *
  * #FeedsGroup is an utility to import and export list of #FeedChannels in
- * different formats, such as OPML
+ * different formats, such as OPML.
  */
 
 #define FEEDS_GROUP_ERROR		feeds_group_error_quark()
@@ -129,8 +129,19 @@ retrieve_group_handler (FeedsGroup *group, xmlDocPtr doc, xmlNodePtr cur)
 	return NULL;
 }
 
+/**
+ * feeds_group_parse_file:
+ * @group: a #FeedsGroup
+ * @path: path of the file to parse
+ * @error: location for eventual errors
+ *
+ * Parses the given file to obtain list of listed feeds
+ *
+ * Return value: a list of #FeedChannels, or NULL if an error occours and
+ * @error is set
+ */
 GList*
-feeds_group_parse_file (FeedsGroup *groups, const gchar *path, GError *error)
+feeds_group_parse_file (FeedsGroup *group, const gchar *path, GError *error)
 {
 	gchar *contents;
 	gsize len;
@@ -169,7 +180,7 @@ feeds_group_parse_file (FeedsGroup *groups, const gchar *path, GError *error)
 			break;
 		}
 
-		handler = retrieve_group_handler (groups, doc, cur);
+		handler = retrieve_group_handler (group, doc, cur);
 		if (handler == NULL)
 			break;
 
diff --git a/src/feeds-group.h b/src/feeds-group.h
index dfa5a6d..91c9c09 100644
--- a/src/feeds-group.h
+++ b/src/feeds-group.h
@@ -21,7 +21,7 @@
 #ifndef __FEEDS_GROUP_H__
 #define __FEEDS_GROUP_H__
 
-#include "common.h"
+#include "libgrss.h"
 
 #define FEEDS_GROUP_TYPE		(feeds_group_get_type())
 #define FEEDS_GROUP(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), FEEDS_GROUP_TYPE, FeedsGroup))
@@ -46,7 +46,7 @@ GType		feeds_group_get_type		() G_GNUC_CONST;
 
 FeedsGroup*	feeds_group_new			();
 
-GList*		feeds_group_parse_file		(FeedsGroup *groups, const gchar *path, GError *error);
-gboolean	feeds_group_export_file		(FeedsGroup *groups, GList *channels, const gchar *path, GError *error);
+GList*		feeds_group_parse_file		(FeedsGroup *group, const gchar *path, GError *error);
+gboolean	feeds_group_export_file		(FeedsGroup *group, GList *channels, const gchar *path, GError *error);
 
 #endif /* __FEEDS_GROUP_H__ */
diff --git a/src/feeds-opml-group-handler.c b/src/feeds-opml-group-handler.c
index 4c84f2a..2554ce1 100644
--- a/src/feeds-opml-group-handler.c
+++ b/src/feeds-opml-group-handler.c
@@ -26,6 +26,7 @@
  * Copyright (C) 2006-2010 Lars Lindner <lars lindner gmail com>
  */
 
+#include "feeds-group-handler.h"
 #include "feeds-opml-group-handler.h"
 #include "utils.h"
 #include "feed-channel.h"
@@ -48,12 +49,6 @@ G_DEFINE_TYPE_WITH_CODE (FeedsOpmlGroupHandler, feeds_opml_group_handler, G_TYPE
                          G_IMPLEMENT_INTERFACE (FEEDS_GROUP_HANDLER_TYPE,
                                                 feeds_group_handler_interface_init));
 
-static GQuark
-feeds_opml_group_handler_error_quark ()
-{
-	return g_quark_from_static_string ("feeds_opml_group_handler_error");
-}
-
 static void
 feeds_opml_group_handler_finalize (GObject *object)
 {
diff --git a/src/feeds-opml-group-handler.h b/src/feeds-opml-group-handler.h
index 39c341d..20dc22a 100644
--- a/src/feeds-opml-group-handler.h
+++ b/src/feeds-opml-group-handler.h
@@ -21,8 +21,7 @@
 #ifndef __FEEDS_OPML_GROUP_HANDLER_H__
 #define __FEEDS_OPML_GROUP_HANDLER_H__
 
-#include "common.h"
-#include "feeds-group-handler.h"
+#include "libgrss.h"
 
 #define FEEDS_OPML_GROUP_HANDLER_TYPE		(feeds_opml_group_handler_get_type())
 #define FEEDS_OPML_GROUP_HANDLER(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), FEEDS_OPML_GROUP_HANDLER_TYPE, FeedsOpmlGroupHandler))
diff --git a/src/feeds-pool.h b/src/feeds-pool.h
index 1fb1c10..204b925 100644
--- a/src/feeds-pool.h
+++ b/src/feeds-pool.h
@@ -21,8 +21,7 @@
 #ifndef __FEEDS_POOL_H__
 #define __FEEDS_POOL_H__
 
-#include "common.h"
-#include "feed-channel.h"
+#include "libgrss.h"
 
 #define FEEDS_POOL_TYPE			(feeds_pool_get_type())
 #define FEEDS_POOL(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), FEEDS_POOL_TYPE, FeedsPool))
diff --git a/src/feeds-store.h b/src/feeds-store.h
index a6e7b4d..4972f4a 100644
--- a/src/feeds-store.h
+++ b/src/feeds-store.h
@@ -20,9 +20,7 @@
 #ifndef __FEEDS_STORE_H__
 #define __FEEDS_STORE_H__
 
-#include "common.h"
-#include "feed-channel.h"
-#include "feed-item.h"
+#include "libgrss.h"
 
 #define FEEDS_STORE_TYPE		(feeds_store_get_type())
 #define FEEDS_STORE(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), FEEDS_STORE_TYPE, FeedsStore))
diff --git a/src/feeds-subscriber.h b/src/feeds-subscriber.h
index 18728db..1b37149 100644
--- a/src/feeds-subscriber.h
+++ b/src/feeds-subscriber.h
@@ -21,9 +21,7 @@
 #ifndef __FEEDS_SUBSCRIBER_H__
 #define __FEEDS_SUBSCRIBER_H__
 
-#include "common.h"
-#include "feed-channel.h"
-#include "feed-item.h"
+#include "libgrss.h"
 
 #define FEEDS_SUBSCRIBER_TYPE		(feeds_subscriber_get_type())
 #define FEEDS_SUBSCRIBER(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), FEEDS_SUBSCRIBER_TYPE, FeedsSubscriber))
diff --git a/src/libgrss.h b/src/libgrss.h
index 6e4c966..bc48c54 100644
--- a/src/libgrss.h
+++ b/src/libgrss.h
@@ -21,8 +21,18 @@
 #ifndef __LIBGRSS_H__
 #define __LIBGRSS_H__
 
-#include "feed-item.h"
+#include <libsoup/soup.h>
+
+#include <libxml/xmlerror.h>
+#include <libxml/uri.h>
+#include <libxml/parser.h>
+#include <libxml/entities.h>
+#include <libxml/HTMLparser.h>
+#include <libxml/xpath.h>
+
 #include "feed-channel.h"
+#include "feed-enclosure.h"
+#include "feed-item.h"
 #include "feed-parser.h"
 #include "feeds-store.h"
 #include "feeds-pool.h"
diff --git a/src/ns-handler.h b/src/ns-handler.h
index e845e44..bbaf433 100644
--- a/src/ns-handler.h
+++ b/src/ns-handler.h
@@ -21,9 +21,7 @@
 #ifndef __NS_HANDLER_H__
 #define __NS_HANDLER_H__
 
-#include "common.h"
-#include "feed-channel.h"
-#include "feed-item.h"
+#include "libgrss.h"
 
 #define NS_HANDLER_TYPE			(ns_handler_get_type())
 #define NS_HANDLER(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), NS_HANDLER_TYPE, NSHandler))
diff --git a/src/utils.h b/src/utils.h
index 77ac6b3..41d60a7 100644
--- a/src/utils.h
+++ b/src/utils.h
@@ -21,8 +21,18 @@
 #ifndef __UTILS_LIBGRSS_H__
 #define __UTILS_LIBGRSS_H__
 
-#include "common.h"
-#include "feed-channel.h"
+#define _XOPEN_SOURCE	600
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <strings.h>
+#include <time.h>
+#include <locale.h>
+#include <ctype.h>
+#include <unistd.h>
+
+#include "libgrss.h"
 
 #define PACKAGE			"libgrss"
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]