Changeset 9990 for trunk/psLib/src/db/psDB.h

Timestamp:

Nov 14, 2006, 3:34:42 PM (20 years ago)

Author:

jhoblitt

Message:

rename psDBInit() -> psDBAlloc() and set psDBFree() as the deallocator func
rename psDBCleanup() -> psDBFree() and make it private
add a macro/wrapper named psDBInit() around psDBAlloc()
add a macro/wrapper named psDBCleanup() around psFree()

File:

• trunk/psLib/src/db/psDB.h (modified) (3 diffs)

trunk/psLib/src/db/psDB.h

@@ -10 +10 @@
  *  @author Joshua Hoblitt
  *
- *  @version $Revision: 1.29 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-10-13 22:26:14 $
+ *  @version $Revision: 1.30 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-11-15 01:34:42 $
  *
  *  Copyright 2005 Joshua Hoblitt, University of Hawaii
@@ -40 +40 @@
 /** Opens a new database connection
  *
- *  @return psDB*:      A new psDB object if the database connection is successful or NULL on
- *  failure.
- */
+ *  @return psDB*:      A new psDB object if the database connection is
+ *  successful or NULL on failure.
+ */
+psDB *psDBAlloc(
+    const char *host,                  ///< Database server hostname
+    const char *user,                  ///< Database username
+    const char *passwd,                ///< Database password
+    const char *dbname,                ///< Database namespace
+    unsigned int port                  ///< Database port number
+);
+
+/** Opens a new database connection
+ *
+ *  This function is deprecated favor of psDBAlloc()
+ *
+ *  @return psDB*:      A new psDB object if the database connection is
+ *  successful or NULL on failure.
+ */
+#ifdef DOXYGEN
 psDB *psDBInit(
     const char *host,                  ///< Database server hostname
@@ -50 +66 @@
     unsigned int port                  ///< Database port number
 );
-
-/** Closes a database connection  */
+#else // DOXYGEN
+#define psDBInit(host, user, passwd, dbname, port) \
+psDBAlloc(host, user, passwd, dbname, port)
+#endif
+
+#ifdef DOXYGEN
+/** Closes a database connection
+ *
+ *  This function is deprecated favor of psFree()
+ */
 void psDBCleanup(
     psDB *dbh                          ///< Database handle
 );
+#else // DOXYGEN
+#define psDBCleanup(dbh) \
+psFree(dbh)
+#endif
 
 /** Creates a new database namespace