Cleanups of the following types: - correct return values from g_return_*()

2007-04-16  Kjartan Maraas  <kmaraas@gnome.org>

	* src/yelp-db-pager.c: (db_pager_params), (node_get_title):
	* src/yelp-db-print-pager.c: (db_print_pager_params):
	* src/yelp-debug.c:
	* src/yelp-info-pager.c: (info_pager_parse):
	* src/yelp-info-parser.c: (open_info_file), (process_indirect_map),
	(get_value_after):
	* src/yelp-main.c: (main_save_session),
	(slowly_and_stupidly_obtain_timestamp):
	* src/yelp-man-pager.c: (man_pager_parse):
	* src/yelp-print.c: (print_jobs_run),
	(yelp_print_load_config_from_file), (yelp_print_get_print_info):
	* src/yelp-search-pager.c: (s_startElement), (s_endElement),
	(s_characters), (s_declEntity), (s_getEntity), (slow_search_setup):
	* src/yelp-toc-pager.c: (toc_process_pending),
	(process_read_scrollkeeper), (process_omf_pending),
	(process_mandir_pending), (toc_add_doc_info):
	* src/yelp-utils.c: (yelp_get_info_paths), (yelp_get_man_paths),
	(convert_info_uri):
	* src/yelp-window.c:
	* src/yelp-xslt-pager.c:
	Cleanups of the following types:
	- correct return values from g_return_*()
	- mark som functions static
	- fix shadowing variables
	- NULL vs. 0
	- ANSIfication of function declarations
	- Constification

svn path=/trunk/; revision=2805

14 files changed, 79 insertions, 134 deletions

diff --git a/ChangeLog b/ChangeLog
index 8e478582..d6b649c0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,33 @@
+2007-04-16  Kjartan Maraas  <kmaraas@gnome.org>
+
+	* src/yelp-db-pager.c: (db_pager_params), (node_get_title):
+	* src/yelp-db-print-pager.c: (db_print_pager_params):
+	* src/yelp-debug.c:
+	* src/yelp-info-pager.c: (info_pager_parse):
+	* src/yelp-info-parser.c: (open_info_file), (process_indirect_map),
+	(get_value_after):
+	* src/yelp-main.c: (main_save_session),
+	(slowly_and_stupidly_obtain_timestamp):
+	* src/yelp-man-pager.c: (man_pager_parse):
+	* src/yelp-print.c: (print_jobs_run),
+	(yelp_print_load_config_from_file), (yelp_print_get_print_info):
+	* src/yelp-search-pager.c: (s_startElement), (s_endElement),
+	(s_characters), (s_declEntity), (s_getEntity), (slow_search_setup):
+	* src/yelp-toc-pager.c: (toc_process_pending),
+	(process_read_scrollkeeper), (process_omf_pending),
+	(process_mandir_pending), (toc_add_doc_info):
+	* src/yelp-utils.c: (yelp_get_info_paths), (yelp_get_man_paths),
+	(convert_info_uri):
+	* src/yelp-window.c:
+	* src/yelp-xslt-pager.c:
+	Cleanups of the following types:
+	- correct return values from g_return_*()
+	- mark som functions static
+	- fix shadowing variables
+	- NULL vs. 0
+	- ANSIfication of function declarations
+	- Constification
+
 ==================== 2.18.1 ====================
 2007-04-09  Shaun McCance  <shaunm@gnome.org>
 
diff --git a/src/yelp-db-pager.c b/src/yelp-db-pager.c
index a6787489..928c8d20 100644
--- a/src/yelp-db-pager.c
+++ b/src/yelp-db-pager.c
@@ -295,8 +295,8 @@ db_pager_params (YelpPager *pager)
 
     debug_print (DB_FUNCTION, "entering\n");
 
-    g_return_val_if_fail (pager != NULL, FALSE);
-    g_return_val_if_fail (YELP_IS_DB_PAGER (pager), FALSE);
+    g_return_val_if_fail (pager != NULL, NULL);
+    g_return_val_if_fail (YELP_IS_DB_PAGER (pager), NULL);
     priv = YELP_DB_PAGER (pager)->priv;
 
     if (yelp_pager_get_state (pager) >= YELP_PAGER_STATE_ERROR)
@@ -496,10 +496,12 @@ node_get_title (DBWalker *walker, gchar *type)
 {
     gchar *title = NULL;
     xmlChar *node_name = (xmlChar *) walker->cur->name;
-    xmlNodePtr child = NULL;
     xmlNodePtr title_node = NULL;
 
     if (xmlStrcmp (node_name, BAD_CAST "refentry")) {
+
+    	xmlNodePtr child = NULL;
+
 	/*refentry is special cased below */
 	title_node = node_find_child (walker->cur, type);
 	if (!title_node) {
diff --git a/src/yelp-db-print-pager.c b/src/yelp-db-print-pager.c
index 8e184004..734d7deb 100644
--- a/src/yelp-db-print-pager.c
+++ b/src/yelp-db-print-pager.c
@@ -228,8 +228,8 @@ db_print_pager_params (YelpPager *pager)
 
     doc_info = yelp_pager_get_doc_info (pager);
 
-    g_return_val_if_fail (pager != NULL, FALSE);
-    g_return_val_if_fail (YELP_IS_DB_PRINT_PAGER (pager), FALSE);
+    g_return_val_if_fail (pager != NULL, NULL);
+    g_return_val_if_fail (YELP_IS_DB_PRINT_PAGER (pager), NULL);
     priv = YELP_DB_PRINT_PAGER (pager)->priv;
 
     if (yelp_pager_get_state (pager) >= YELP_PAGER_STATE_ERROR)
diff --git a/src/yelp-debug.c b/src/yelp-debug.c
index 34aa56df..ae47c52b 100644
--- a/src/yelp-debug.c
+++ b/src/yelp-debug.c
@@ -27,7 +27,7 @@
 
 #include "yelp-debug.h"
 
-GDebugKey debug_keys[] = {
+static const GDebugKey debug_keys[] = {
 	{ "function-calls",   DB_FUNCTION },
 	{ "function-args",    DB_ARG }, 
 	{ "enable-profiling", DB_PROFILE },
diff --git a/src/yelp-info-pager.c b/src/yelp-info-pager.c
index 2c674c22..98843615 100644
--- a/src/yelp-info-pager.c
+++ b/src/yelp-info-pager.c
@@ -171,7 +171,7 @@ info_pager_parse (YelpPager *pager)
     GError        *error = NULL;
     YelpInfoPagerPriv *priv;
 
-    g_return_val_if_fail (YELP_IS_INFO_PAGER (pager), FALSE);
+    g_return_val_if_fail (YELP_IS_INFO_PAGER (pager), NULL);
     priv = YELP_INFO_PAGER (pager)->priv;
 
     doc_info = yelp_pager_get_doc_info (pager);
diff --git a/src/yelp-info-parser.c b/src/yelp-info-parser.c
index c462aac7..c6eb89a0 100644
--- a/src/yelp-info-parser.c
+++ b/src/yelp-info-parser.c
@@ -93,8 +93,8 @@ page_type (char *page)
     return PAGE_OTHER;
 }
 
-static char
-*open_info_file (char *file)
+static char *
+open_info_file (char *file)
 {
 	GIOChannel *channel = NULL;
 	int i;
@@ -157,8 +157,8 @@ find_info_part (gchar *part_name, gchar *base)
 
 }
 
-static char
-*process_indirect_map (char *page, gchar * file)
+static char *
+process_indirect_map (char *page, gchar * file)
 {
 	char **lines;
 	char **ptr;
@@ -253,8 +253,8 @@ static GHashTable
 	return table;
 }
 
-static char
-*get_value_after (char *source, char *required)
+static char *
+get_value_after (char *source, char *required)
 {
 	char *ret, *ret_cp;
 	char *source_cp;
diff --git a/src/yelp-main.c b/src/yelp-main.c
index 5203f6a2..d4a1dd11 100644
--- a/src/yelp-main.c
+++ b/src/yelp-main.c
@@ -157,7 +157,7 @@ main_save_session (GnomeClient        *client,
 	gint                    i=1;
 	gint                    arg_len = 1;
 	gboolean                store_open_urls = FALSE;
-	DBusGProxy             *proxy = NULL;
+	/* DBusGProxy             *proxy = NULL; */
 	GError                 *error = NULL;
 
 	/*proxy = main_dbus_get_proxy ();
@@ -268,7 +268,7 @@ slowly_and_stupidly_obtain_timestamp (Display *xdisplay)
 				       0,
 				       CopyFromParent,
 				       CopyFromParent,
-				       CopyFromParent,
+				       (Visual *)CopyFromParent,
 				       CWOverrideRedirect | CWEventMask,
 				       &attrs);
 		
@@ -294,7 +294,7 @@ slowly_and_stupidly_obtain_timestamp (Display *xdisplay)
 	return event.xproperty.time;
 }
 
-DBusGProxy *
+static DBusGProxy *
 main_dbus_get_proxy (void)
 {
 	if (!connection)
@@ -306,7 +306,7 @@ main_dbus_get_proxy (void)
 					  "org.gnome.YelpService");
 }
 
-gboolean
+static gboolean
 main_is_running (void)
 {
 	DBusGProxy *proxy = NULL;
diff --git a/src/yelp-man-pager.c b/src/yelp-man-pager.c
index a7d7ba71..150bd7ae 100644
--- a/src/yelp-man-pager.c
+++ b/src/yelp-man-pager.c
@@ -228,7 +228,7 @@ man_pager_parse (YelpPager *pager)
     GError        *error = NULL;
     gint           i;
 
-    g_return_val_if_fail (YELP_IS_MAN_PAGER (pager), FALSE);
+    g_return_val_if_fail (YELP_IS_MAN_PAGER (pager), NULL);
 
     doc_info = yelp_pager_get_doc_info (pager);
     filename = yelp_doc_info_get_filename (doc_info);
diff --git a/src/yelp-print.c b/src/yelp-print.c
index 7ce42c4a..42989b8f 100644
--- a/src/yelp-print.c
+++ b/src/yelp-print.c
@@ -159,7 +159,7 @@ print_present_config_dialog (YelpPrintInfo *info)
 }
 
 static gboolean 
-print_jobs_run ()
+print_jobs_run (void)
 {
     YelpPrintInfo * info = current_jobs->data;
     info->started = TRUE;
@@ -172,7 +172,7 @@ print_jobs_run ()
 }
 
 static GtkPrintSettings * 
-yelp_print_load_config_from_file ()
+yelp_print_load_config_from_file (void)
 {
     GtkPrintSettings *settings;
 
@@ -222,8 +222,8 @@ yelp_print_info_free (YelpPrintInfo *info)
     
 }
 
-YelpPrintInfo *
-yelp_print_get_print_info ()
+static YelpPrintInfo *
+yelp_print_get_print_info (void)
 {
   YelpPrintInfo *info;
   
diff --git a/src/yelp-search-pager.c b/src/yelp-search-pager.c
index 63aa8edc..77209f09 100644
--- a/src/yelp-search-pager.c
+++ b/src/yelp-search-pager.c
@@ -1022,7 +1022,7 @@ sk_characters (void *empty, const xmlChar *ch,
     }
 }
 
-void s_startElement(void *data,
+static void s_startElement(void *data,
 		  const xmlChar * name,
 		  const xmlChar ** attrs)
 {
@@ -1093,7 +1093,7 @@ void s_startElement(void *data,
     return;
 }
 
-void s_endElement(void * data,
+static void s_endElement(void * data,
 		const xmlChar * name)
 {
     SearchContainer *c = (SearchContainer *) data;
@@ -1116,7 +1116,7 @@ void s_endElement(void * data,
     return;
 }
 
-void s_characters(void * data,
+static void s_characters(void * data,
 		  const xmlChar * ch,
 		  int len)
 {
@@ -1133,6 +1133,7 @@ void s_characters(void * data,
     if (c->html && c->search_status != SEARCH_DOC)
 	c->search_status = SEARCH_DOC;
     if (c->search_status != NOT_SEARCHING) {
+	gchar *location;
 	gchar *tmp = g_utf8_casefold ((gchar *) ch, len);
 	gint i = 0;
 	gchar *s_term = c->search_term[i];
@@ -1143,7 +1144,7 @@ void s_characters(void * data,
 		continue;
 	    }
 
-	    gchar *location = strstr (tmp, s_term);	    
+	    location = strstr (tmp, s_term);	    
 	    if (location) {
 		gchar before = *(location-1);
 		gchar after = *(location+strlen(s_term));
@@ -1196,7 +1197,7 @@ void s_characters(void * data,
     return;
 }
 
-void s_declEntity (void *data, const xmlChar *name, int type,
+static void s_declEntity (void *data, const xmlChar *name, int type,
 		  const xmlChar *pID, const xmlChar *sID,
 		  xmlChar *content)
 {
@@ -1210,7 +1211,8 @@ void s_declEntity (void *data, const xmlChar *name, int type,
     return;
 }
 
-xmlEntityPtr s_getEntity (void *data, const xmlChar *name)
+static xmlEntityPtr
+s_getEntity (void *data, const xmlChar *name)
 {
     SearchContainer *c = (SearchContainer *) data;
     xmlEntityPtr t = xmlGetPredefinedEntity(name);
@@ -1444,7 +1446,7 @@ slow_search_setup (YelpSearchPager *pager)
     gint      terms_number = 0;
     gint required_no = 0;
 
-    static xmlSAXHandler sk_sax_handler = { 0, };
+    static xmlSAXHandler sk_sax_handler = { NULL, };
     xmlParserCtxtPtr parser;
     if (langs && langs[0])
 	lang = (gchar *) langs[0];
@@ -1734,7 +1736,7 @@ slow_search_process (YelpSearchPager *pager)
     }
 }
 
-gchar *
+static gchar *
 search_clean_snippet (gchar *snippet, gchar **terms)
 {    
     /* This is probably what you want to change */
@@ -1828,7 +1830,7 @@ search_clean_snippet (gchar *snippet, gchar **terms)
     return result;
 }
 
-void
+static void
 search_parse_result (YelpSearchPager *pager, SearchContainer *c)
 {    
     xmlNode *child;
@@ -1862,7 +1864,7 @@ search_parse_result (YelpSearchPager *pager, SearchContainer *c)
     xmlFreeDoc (snippet_doc);
 }
 
-void
+static void
 process_man_result (YelpSearchPager *pager, gchar *result, gchar **terms)
 {
     gchar ** split = g_strsplit (result, "\n", -1);
@@ -1987,7 +1989,7 @@ process_info_result (YelpSearchPager *pager, gchar *result, gchar **terms)
 
 }
 
-void
+static void
 search_process_man (YelpSearchPager *pager, gchar **terms)
 {
     gchar *command;
@@ -2015,7 +2017,7 @@ search_process_man (YelpSearchPager *pager, gchar **terms)
     return;
 }
 
-void
+static void
 search_process_info (YelpSearchPager *pager, gchar **terms)
 {
     gchar *command;
diff --git a/src/yelp-toc-pager.c b/src/yelp-toc-pager.c
index 71c1b818..0f1a1852 100644
--- a/src/yelp-toc-pager.c
+++ b/src/yelp-toc-pager.c
@@ -122,7 +122,6 @@ static gboolean      toc_process_pending       (YelpTocPager      *pager);
 
 
 static gboolean      process_read_menu         (YelpTocPager      *pager);
-static gboolean      process_xslt              (YelpTocPager      *pager);
 static gboolean      process_read_scrollkeeper (YelpTocPager      *pager,
                                                 gchar             *content_list);
 static gboolean      process_omf_pending       (YelpTocPager      *pager);
@@ -468,7 +467,6 @@ toc_process_pending (YelpTocPager *pager)
 #ifdef ENABLE_INFO
 	process_info_pending,
 #endif
-	/* process_xslt, */
 	process_cleanup,
 	NULL
     };
@@ -567,7 +565,7 @@ sk_characters (void          *pager,
 static gboolean
 process_read_scrollkeeper (YelpTocPager *pager, gchar *content_list)
 {
-    static xmlSAXHandler sk_sax_handler = { 0, };
+    static xmlSAXHandler sk_sax_handler = { NULL, };
 
     if (!sk_sax_handler.startElement) {
 	sk_sax_handler.startElement = sk_startElement;
@@ -813,12 +811,13 @@ process_omf_pending (YelpTocPager *pager)
      * it doesn't exist, then we create a list of omf files to process
      * with the process_read_scrollkeeper() function */
     if (first_call) {
+	const gchar * const * langs = g_get_language_names ();
+
 	first_call = FALSE;
 
 	sk_file = g_build_filename (yelp_dot_dir(), "sk-content-list.last", NULL);
 	    
 	/* get current language */
-	const gchar * const * langs = g_get_language_names ();
 	if (langs && langs[0])
 	    lang = (gchar *) langs[0];
 	else
@@ -1342,7 +1341,6 @@ process_mandir_pending (YelpTocPager *pager)
 	xmlXPathContextPtr xpath;
 	xmlXPathObjectPtr  obj;
 
-	/* NOTE: this document is free()'d at the end of the process_xslt function */
 	priv->man_doc = xmlCtxtReadFile (priv->parser, DATADIR "/yelp/man.xml", NULL,
 					 XML_PARSE_NOBLANKS | XML_PARSE_NOCDATA  |
 					 XML_PARSE_NOENT    | XML_PARSE_NOERROR  |
@@ -1933,92 +1931,6 @@ process_read_menu (YelpTocPager *pager)
 }
 
 static gboolean
-process_xslt (YelpTocPager *pager)
-{
-    GError *error = NULL;
-    xmlDocPtr outdoc = NULL;
-    YelpTocPagerPriv *priv = pager->priv;
-    gchar **params = NULL;
-    gint  params_i = 0;
-    gint  params_max = 10;
-    GtkIconInfo *info;
-    GtkIconTheme *theme = (GtkIconTheme *) yelp_settings_get_icon_theme ();
-
-    if (!priv->toc_doc)
-	return FALSE;
-
-    /* only create and parse the stylesheet on the first call to this function */
-    if (!priv->stylesheet) {
-	priv->stylesheet = xsltParseStylesheetFile (BAD_CAST TOC_STYLESHEET);
-    }
-
-    if (!priv->stylesheet) {
-	g_set_error (&error, YELP_ERROR, YELP_ERROR_PROC,
-		     _("The table of contents could not be processed. The "
-		       "file ‘%s’ is either missing or is not a valid XSLT "
-		       "stylesheet."),
-		     TOC_STYLESHEET);
-	yelp_pager_error (YELP_PAGER (pager), error);
-	goto done;
-    }
-
-    priv->transformContext = xsltNewTransformContext (priv->stylesheet,
-						      priv->toc_doc);
-    priv->transformContext->_private = pager;
-    xsltRegisterExtElement (priv->transformContext,
-			    BAD_CAST "document",
-			    BAD_CAST YELP_NAMESPACE,
-			    (xsltTransformFunction) xslt_yelp_document);
-
-    params = g_new0 (gchar *, params_max);
-    yelp_settings_params (&params, &params_i, &params_max);
-
-    if ((params_i + 10) >= params_max - 1) {
-	params_max += 10;
-	params = g_renew (gchar *, params, params_max);
-    }
-
-    info = gtk_icon_theme_lookup_icon (theme, "yelp-icon-big", 192, 0);
-    if (info) {
-	params[params_i++] = "help_icon";
-	params[params_i++] = g_strdup_printf ("\"%s\"",
-					      gtk_icon_info_get_filename (info));
-	params[params_i++] = "help_icon_size";
-	params[params_i++] = g_strdup_printf ("%i",
-					      gtk_icon_info_get_base_size (info));
-	gtk_icon_info_free (info);
-    }
-
-    params[params_i++] = NULL;
-
-    outdoc = xsltApplyStylesheetUser (priv->stylesheet,
-				      priv->toc_doc,
-				      (const gchar **)params, NULL, NULL,
-				      priv->transformContext);
-    /* Don't do this */
-    g_signal_emit_by_name (pager, "finish");
-
- done:
-    if (params) {
-	for (params_i = 0; params[params_i] != NULL; params_i++)
-	    if (params_i % 2 == 1)
-		g_free ((gchar *) params[params_i]);
-    }
-    if (outdoc)
-	xmlFreeDoc (outdoc);
-    if (priv->toc_doc) {
-	xmlFreeDoc (priv->toc_doc);
-	priv->toc_doc = NULL;
-    }
-    if (priv->transformContext) {
-	xsltFreeTransformContext (priv->transformContext);
-	priv->transformContext = NULL;
-    }
-
-    return FALSE;
-}
-
-static gboolean
 process_cleanup (YelpTocPager *pager)
 {
     YelpTocPagerPriv *priv = pager->priv;
@@ -2062,7 +1974,8 @@ toc_add_doc_info (YelpTocPager *pager, YelpDocInfo *doc_info)
     xmlNodePtr node;
     xmlNodePtr new;
     gchar     *text;
-    gchar     *category;
+    const gchar *category;
+    YelpTocPagerPriv *priv = pager->priv;
 
     g_return_if_fail (pager != NULL);
     if (doc_info == NULL)
@@ -2077,8 +1990,6 @@ toc_add_doc_info (YelpTocPager *pager, YelpDocInfo *doc_info)
 	return;
     }
 
-    YelpTocPagerPriv *priv = pager->priv;
-
     g_hash_table_insert (priv->unique_hash,
 			 (gchar *) yelp_doc_info_get_id (doc_info),
 			 doc_info);
diff --git a/src/yelp-utils.c b/src/yelp-utils.c
index fb8cd37d..d1d92da9 100644
--- a/src/yelp-utils.c
+++ b/src/yelp-utils.c
@@ -867,7 +867,7 @@ convert_man_uri (gchar *uri, gboolean trust_uri)
 }
 
 gchar **
-yelp_get_info_paths ( )
+yelp_get_info_paths (void)
 {
     /* Get the infopath, either from the INFOPATH envar,
        or from the default infopath_d.
@@ -891,7 +891,7 @@ yelp_get_info_paths ( )
 
 
 gchar **
-yelp_get_man_paths ()
+yelp_get_man_paths (void)
 {
 	return mandirs;
 }
@@ -996,7 +996,7 @@ convert_info_uri (gchar   *uri)
 		    /* In dir, they've specified the subdir but not the
 		     * info file name.  Here, do some work to get the name
 		     *  ...*/
-		    gchar *real_filename;
+		    const gchar *real_filename;
 
 		    g_dir_close (dir);
 		    dir = g_dir_open (test_filename, 0, NULL);
diff --git a/src/yelp-window.c b/src/yelp-window.c
index de10350d..4bf5764e 100644
--- a/src/yelp-window.c
+++ b/src/yelp-window.c
@@ -2221,7 +2221,7 @@ tree_drag_data_get_cb (GtkWidget         *widget,
     g_free (uri);
 }
 
-void
+static void
 tree_row_expand_cb (GtkTreeView *view, GtkTreePath *path,
 		    GtkTreeViewColumn *column, YelpWindow *window)
 {
diff --git a/src/yelp-xslt-pager.c b/src/yelp-xslt-pager.c
index 0439a411..84de6c28 100644
--- a/src/yelp-xslt-pager.c
+++ b/src/yelp-xslt-pager.c
@@ -326,7 +326,7 @@ xslt_pager_finish (YelpPager *pager)
 
 /** XSLT Extension Elements ***************************************************/
 
-void
+static void
 xslt_yelp_document (xsltTransformContextPtr ctxt,
 		    xmlNodePtr              node,
 		    xmlNodePtr              inst,
@@ -456,7 +456,7 @@ xslt_yelp_document (xsltTransformContextPtr ctxt,
 	xsltFreeStylesheet (style);
 }
 
-void
+static void
 xslt_yelp_cache (xsltTransformContextPtr ctxt,
 		 xmlNodePtr              node,
 		 xmlNodePtr              inst,