[Opensrf-commits] r1769 - trunk/src/libopensrf (scottmk)

[svn at svn.open-ils.org]

Author: scottmk
Date: 2009-09-04 17:47:55 -0400 (Fri, 04 Sep 2009)
New Revision: 1769

Modified:
   trunk/src/libopensrf/osrf_settings.c
Log:
Enhanced the error messages from osrf_settings_host_value() and
osrf_settings_host_value_object() to include the requested
search path.  That should make it easier to identify the caller
and thereby figure out what went wrong.

Also: added a couple of Doxygen-style comments.


Modified: trunk/src/libopensrf/osrf_settings.c
===================================================================
--- trunk/src/libopensrf/osrf_settings.c	2009-09-04 15:38:46 UTC (rev 1768)
+++ trunk/src/libopensrf/osrf_settings.c	2009-09-04 21:47:55 UTC (rev 1769)
@@ -2,13 +2,30 @@
 
 osrf_host_config* config = NULL;
 
+/**
+	@brief Fetch a specified string from an already-loaded configuration.
+	@param format A printf-style format string.  Subsequent parameters, if any, will be formatted
+		and inserted into the format string.
+	@return If the value is found, a pointer to a newly-allocated string containing the value;
+		otherwise NULL.
+
+	The format string, after expansion, defines a search path through a configuration previously
+	loaded and stored as a jsonObject.
+
+	The configuration must have been already been loaded via a call to osrf_settings_retrieve()
+	(probably via a call to osrfSystemBootstrap()).  Otherwise this function will call exit()
+	immediately.
+
+	The calling code is responsible for freeing the string.
+*/
 char* osrf_settings_host_value(const char* format, ...) {
 	VA_LIST_TO_STRING(format);
 
 	if( ! config ) {
-		const char * msg = "NULL config pointer";
-		fprintf( stderr, "osrf_settings_host_value: %s\n", msg );
-		osrfLogError( OSRF_LOG_MARK, msg );
+		const char * msg = "NULL config pointer; looking for config_context ";
+		fprintf( stderr, "osrf_settings_host_value: %s\"%s\"\n",
+			msg, VA_BUF );
+		osrfLogError( OSRF_LOG_MARK, "%s\"%s\"", msg, VA_BUF );
 		exit( 99 );
 	}
 
@@ -18,13 +35,30 @@
 	return val;
 }
 
+/**
+	@brief Fetch a specified subset of an already-loaded configuration.
+	@param format A printf-style format string.  Subsequent parameters, if any, will be formatted
+		and inserted into the format string.
+	@return If the value is found, a pointer to a newly created jsonObject containing the
+		specified subset; otherwise NULL.
+
+	The format string, after expansion, defines a search path through a configuration previously
+	loaded and stored as a jsonObject.
+
+	The configuration must have been already been loaded via a call to osrf_settings_retrieve()
+	(probably via a call to osrfSystemBootstrap()).  Otherwise this function will call exit()
+	immediately.
+
+	The calling code is responsible for freeing the jsonObject.
+ */
 jsonObject* osrf_settings_host_value_object(const char* format, ...) {
 	VA_LIST_TO_STRING(format);
 
 	if( ! config ) {
-		const char * msg = "config pointer is NULL";
-		fprintf( stderr, "osrf_settings_host_value_object: %s\n", msg );
-		osrfLogError( OSRF_LOG_MARK, msg );
+		const char * msg = "config pointer is NULL; looking for config context ";
+		fprintf( stderr, "osrf_settings_host_value_object: %s\"%s\"\n",
+			msg, VA_BUF );
+		osrfLogError( OSRF_LOG_MARK, "%s\"%s\"", msg, VA_BUF );
 		exit( 99 );
 	}
 
@@ -50,7 +84,7 @@
 			osrfMessageFree(omsg);
 			osrfLogError(
 				OSRF_LOG_MARK,
-			"NULL or non-existant osrfMessage result content received from host %s, "
+			"NULL or non-existent osrfMessage result content received from host %s, "
 				"broken message or no settings for host",
 				hostname
 			);