[svn-r17140] Description:

    Migrate "new style" func enter macros (BEGIN_FUNC/THROW/CATCH/END_FUNC) into
common header files, so that other packages can use them.

Tested on:
    FreeBSD/32 6.3 (duty) in debug mode
    FreeBSD/64 6.3 (liberty) w/C++ & FORTRAN, in debug mode
    Linux/32 2.6 (jam) w/PGI compilers, w/C++ & FORTRAN, w/threadsafe,
        in debug mode
    Linux/64-amd64 2.6 (smirom) w/Intel compilers w/default API=1.6.x,
        w/C++ & FORTRAN, in production mode
    Solaris/32 2.10 (linew) w/deprecated symbols disabled, w/C++ & FORTRAN,
        w/szip filter, in production mode
    Linux/64-ia64 2.6 (cobalt) w/Intel compilers, w/C++ & FORTRAN,
        in production mode
    Linux/64-ia64 2.4 (tg-login3) w/parallel, w/FORTRAN, in debug mode
    Linux/64-amd64 2.6 (abe) w/parallel, w/FORTRAN, in production mode
    Mac OS X/32 10.5.7 (amazon) in debug mode
    Mac OS X/32 10.5.7 (amazon) w/C++ & FORTRAN, w/threadsafe,
        in production mode

1 files changed, 263 insertions, 0 deletions

diff --git a/src/H5private.h b/src/H5private.h
index cb776de..9c18be2 100644
--- a/src/H5private.h
+++ b/src/H5private.h
@@ -1955,6 +1955,269 @@ static herr_t		H5_INTERFACE_INIT_FUNC(void);
 } /*end scope from beginning of FUNC_ENTER*/
 
 
+/****************************************/
+/* Revisions to FUNC_ENTER/LEAVE Macros */
+/****************************************/
+
+/* `S' is the name of a function which is being tested to check if it's */
+/*      a public API function */
+#define H5_IS_PUB(S) (((HDisdigit(S[1]) || HDisupper(S[1])) && HDislower(S[2])) || \
+    ((HDisdigit(S[2]) || HDisupper(S[2])) && HDislower(S[3])) || \
+    (!S[4] || ((HDisdigit(S[3]) || HDisupper(S[3])) && HDislower(S[4]))))
+
+/* `S' is the name of a function which is being tested to check if it's */
+/*      a private library function */
+#define H5_IS_PRIV(S) (((HDisdigit(S[1]) || HDisupper(S[1])) && '_' == S[2] && HDislower(S[3])) || \
+    ((HDisdigit(S[2]) || HDisupper(S[2])) && '_' == S[3] && HDislower(S[4])) || \
+    ((HDisdigit(S[3]) || HDisupper(S[3])) && '_' == S[4] && HDislower(S[5])))
+
+/* `S' is the name of a function which is being tested to check if it's */
+/*      a package private function */
+#define H5_IS_PKG(S) (((HDisdigit(S[1]) || HDisupper(S[1])) && '_' == S[2] && '_' == S[3] && HDislower(S[4])) || \
+    ((HDisdigit(S[2]) || HDisupper(S[2])) && '_' == S[3] && '_' == S[4] && HDislower(S[5])) || \
+    ((HDisdigit(S[3]) || HDisupper(S[3])) && '_' == S[4] && '_' == S[5] && HDislower(S[6])))
+
+#ifndef NDEBUG
+#define FUNC_ENTER_NAME_CHECK(asrt)					      \
+    {					          			      \
+        static hbool_t func_check = FALSE;          			      \
+                                                                              \
+        if(!func_check) {		   				      \
+            /* Check function naming status */				      \
+            HDassert(asrt);			                              \
+                                                                              \
+            /* Don't check again */                 			      \
+            func_check = TRUE;						      \
+        } /* end if */							      \
+    } /* end scope */
+#else /* NDEBUG */
+#define FUNC_ENTER_NAME_CHECK(asrt)
+#endif /* NDEBUG */
+
+/* Macros for referencing package initialization symbols */
+#define H5_PACKAGE_INIT_VAR(x) H5_GLUE3(H5_, x, _init_g)
+#define H5_PACKAGE_INIT_FUNC(x) H5_GLUE(x, __pkg_init)
+
+/* Macros to check if a package is initialized */
+#define H5_CHECK_PACKAGE_INIT_REG_YES(asrt)       HDassert(H5_PACKAGE_INIT_VAR(pkg));
+#define H5_CHECK_PACKAGE_INIT_REG_NO(asrt)
+#define H5_CHECK_PACKAGE_INIT_INIT_YES(asrt)
+#define H5_CHECK_PACKAGE_INIT_INIT_NO(asrt)
+
+/* Macros to initialize package, if a package initialization routine is defined */
+#define H5_PKG_YES_INIT(pkg)						      \
+    if(!H5_PACKAGE_INIT_VAR(pkg)) {					      \
+        if(H5_GLUE(pkg, _pkg_init)() < 0) {				      \
+            /* (Can't use H5E_THROW here) */				      \
+            H5E_PRINTF(H5E_CANTINIT, "interface initialization failed");      \
+            ret_value = fail_value;					      \
+            goto func_init_failed;					      \
+        } /* end if */						              \
+    } /* end if */
+#define H5_PKG_NO_INIT(pkg)
+
+/* Macros to declare package initialization symbols, if a package initialization routine is defined */
+#define H5_PKG_YES_INIT_VAR(pkg) extern hbool_t H5_PACKAGE_INIT_VAR(H5_MY_PKG);
+#define H5_PKG_NO_INIT_VAR(pkg)
+#define H5_PKG_YES_INIT_FUNC(pkg) extern herr_t H5_PACKAGE_INIT_FUNC(pkg)(void);
+#define H5_PKG_NO_INIT_FUNC(pkg)
+
+/* Declare package initialization symbols (if in a package) */
+#define H5_DECLARE_PKG_VAR(pkg_init, pkg) H5_GLUE3(H5_PKG_, pkg_init, _INIT_VAR)(pkg)
+#define H5_DECLARE_PKG_FUNC(pkg_init, pkg) H5_GLUE3(H5_PKG_, pkg_init, _INIT_FUNC)(pkg)
+#ifdef H5_MY_PKG
+H5_DECLARE_PKG_VAR(H5_MY_PKG_INIT, H5_MY_PKG)
+H5_DECLARE_PKG_FUNC(H5_MY_PKG_INIT, H5_MY_PKG)
+#endif /* H5_MY_PKG */
+
+/* API re-entrance variable */
+extern hbool_t H5_api_entered_g;    /* Has library already been entered through API? */
+
+/* Use FUNCNAME to safely handle variations of C99 __func__ keyword handling */
+#ifdef H5_HAVE_C99_FUNC
+#define FUNCNAME __func__
+#elif defined(H5_HAVE_FUNCTION)
+#define FUNCNAME __FUNCTION__
+#else
+#error "We need __func__ or __FUNCTION__ to test function names!"
+#endif
+
+/* Macros for entering different scopes of routines */
+#define H5_PACKAGE_ENTER(pkg, pkg_init, init)				      \
+    FUNC_ENTER_NAME_CHECK(H5_IS_PKG(FUNCNAME))				      \
+                                                                              \
+    /* The library should be initialized already */			      \
+    HDassert(H5_INIT_GLOBAL);						      \
+                                                                              \
+    /* This interface should be initialized already */			      \
+    /* (except for package initialization routines :-) */		      \
+    H5_GLUE4(H5_CHECK_PACKAGE_INIT_, init, _, pkg_init)(pkg)		      \
+                                                                              \
+    /* Push the name of this function on the function stack */		      \
+    H5_PUSH_FUNC(FUNCNAME)							      \
+                                                                              \
+    /* Enter scope for this type of function */				      \
+    {
+
+#define H5_PRIVATE_ENTER(pkg, pkg_init)					      \
+    FUNC_ENTER_NAME_CHECK(H5_IS_PRIV(FUNCNAME))				      \
+                                                                              \
+    /* The library should be initialized already */			      \
+    HDassert(H5_INIT_GLOBAL);						      \
+                                                                              \
+    /* Initialize this interface if desired */				      \
+    H5_GLUE3(H5_PKG_, pkg_init, _INIT)(pkg)				      \
+                                                                              \
+    /* Push the name of this function on the function stack */		      \
+    H5_PUSH_FUNC(FUNCNAME)							      \
+                                                                              \
+    /* Enter scope for this type of function */				      \
+    {{
+
+#define H5_PUBLIC_ENTER(pkg, pkg_init)					      \
+    FUNC_ENTER_API_VARS(FUNCNAME)                                      	      \
+    FUNC_ENTER_API_THREADSAFE;                                                \
+    FUNC_ENTER_NAME_CHECK(H5_IS_PUB(FUNCNAME))				      \
+                                                                              \
+    /* Clear thread error stack when entering public functions */	      \
+    H5E_clear_stack(NULL);				                      \
+                                                                              \
+    /* Initialize the library or bust */				      \
+    if(!(H5_INIT_GLOBAL)) {						      \
+        H5_INIT_GLOBAL = TRUE;                                                \
+        if(H5_init_library() < 0) {  					      \
+            /* (Can't use H5E_THROW here) */				      \
+            H5E_PRINTF(H5E_CANTINIT, "interface initialization failed");      \
+            ret_value = fail_value;					      \
+            goto func_init_failed;					      \
+        } /* end if */						              \
+    } /* end if */						              \
+                                                                              \
+    /* Initialize this interface if desired */				      \
+    H5_GLUE3(H5_PKG_, pkg_init, _INIT)(pkg)				      \
+                                                                              \
+    /* Check for re-entering API routine */				      \
+    HDassert(!H5_api_entered_g);					      \
+    H5_api_entered_g = TRUE;						      \
+                                                                              \
+    /* Start logging MPI's MPE information */				      \
+    BEGIN_MPE_LOG(FUNCNAME)							      \
+                                                                              \
+    /* Push the name of this function on the function stack */		      \
+    H5_PUSH_FUNC(FUNCNAME)							      \
+                                                                              \
+    /* Enter scope for this type of function */				      \
+    {{{
+
+/* Macros for substituting the package name */
+#define FUNC_ENTER_STATIC	H5_PACKAGE_ENTER(H5_MY_PKG, H5_MY_PKG_INIT, REG)
+#define FUNC_ENTER_PKGINIT	H5_PACKAGE_ENTER(H5_MY_PKG, H5_MY_PKG_INIT, INIT)
+#define FUNC_ENTER_PKG		H5_PACKAGE_ENTER(H5_MY_PKG, H5_MY_PKG_INIT, REG)
+#define FUNC_ENTER_PRIV		H5_PRIVATE_ENTER(H5_MY_PKG, H5_MY_PKG_INIT)
+#define FUNC_ENTER_PUB		H5_PUBLIC_ENTER(H5_MY_PKG, H5_MY_PKG_INIT)
+
+/* Macros for substituting a function prefix */
+#define FUNC_PREFIX_STATIC	static
+#define FUNC_PREFIX_PKGINIT
+#define FUNC_PREFIX_PKG
+#define FUNC_PREFIX_PRIV
+#define FUNC_PREFIX_PUB
+
+/* Macros for declaring error variables */
+#define FUNC_ERR_VAR_ERR(ret_typ, err)					      \
+    hbool_t past_catch = FALSE;						      \
+    ret_typ fail_value = err;
+#define FUNC_ERR_VAR_ERRCATCH(ret_typ, err)					      \
+    hbool_t past_catch = FALSE;
+#define FUNC_ERR_VAR_NOERR(ret_typ, err)
+
+/* Use this macro when entering all functions */
+#define BEGIN_FUNC(scope, use_err, ret_typ, ret_init, err, func)	      \
+H5_GLUE(FUNC_PREFIX_, scope)						      \
+ret_typ									      \
+func									      \
+/* Open function */							      \
+{									      \
+    ret_typ ret_value = ret_init;					      \
+    H5_GLUE(FUNC_ERR_VAR_, use_err)(ret_typ, err)			      \
+    H5_GLUE(FUNC_ENTER_, scope)
+
+/* Macros for label when a function initialization can fail */
+#define H5_PRIV_YES_FUNC_INIT_FAILED func_init_failed:
+#define H5_PRIV_NO_FUNC_INIT_FAILED
+#define H5_PRIV_FUNC_INIT_FAILED(pkg_init) H5_GLUE3(H5_PRIV_, pkg_init, _FUNC_INIT_FAILED)
+
+/* Macros for leaving different scopes of routines */
+#define FUNC_LEAVE_PKGINIT					       	      \
+    /* Leave scope for this type of function */				      \
+    }									      \
+                                                                              \
+    /* Pop the name of this function off the function stack */		      \
+    H5_POP_FUNC
+
+#define FUNC_LEAVE_STATIC					       	      \
+    /* Leave scope for this type of function */				      \
+    }									      \
+                                                                              \
+    /* Pop the name of this function off the function stack */		      \
+    H5_POP_FUNC
+
+#define FUNC_LEAVE_PKG						       	      \
+    /* Leave scope for this type of function */				      \
+    }									      \
+                                                                              \
+    /* Pop the name of this function off the function stack */		      \
+    H5_POP_FUNC
+
+#define FUNC_LEAVE_PRIV						       	      \
+    /* Leave scope for this type of function */				      \
+    }}									      \
+                                                                              \
+    /* Label for errors during FUNC_ENTER */				      \
+    H5_PRIV_FUNC_INIT_FAILED(H5_MY_PKG_INIT)				      \
+                                                                              \
+    /* Pop the name of this function off the function stack */		      \
+    H5_POP_FUNC
+
+#define FUNC_LEAVE_PUB						       	      \
+    /* Leave scope for this type of function */				      \
+    }}}									      \
+                                                                              \
+    /* Label for errors during FUNC_ENTER */				      \
+func_init_failed:							      \
+                                                                              \
+    /* Dump error stack if an error occurred during API routine */	      \
+    if(ret_value == fail_value)						      \
+        (void)H5E_dump_api_stack(TRUE);					      \
+                                                                              \
+    /* Finish the API tracing info */					      \
+    H5TRACE_RETURN(ret_value);						      \
+                                                                              \
+    /* Pop the name of this function off the function stack */		      \
+    H5_POP_FUNC							      \
+                                                                              \
+    /* Finish the MPE tracing info */					      \
+    FINISH_MPE_LOG;							      \
+                                                                              \
+    /* Check for leaving API routine */					      \
+    HDassert(H5_api_entered_g);						      \
+    H5_api_entered_g = FALSE;						      \
+                                                                              \
+    /* Release thread-safety semaphore */				      \
+    FUNC_LEAVE_API_THREADSAFE
+
+/* Use this macro when leaving all functions */
+#define END_FUNC(scope)							      \
+    /* Scope-specific function conclusion */				      \
+    H5_GLUE(FUNC_LEAVE_, scope)						      \
+                                                                              \
+    /* Leave routine */							      \
+    return(ret_value);							      \
+                                                                              \
+    /* Close Function */						      \
+}
+
+
 /* Macro for "stringizing" an integer in the C preprocessor (use H5_TOSTRING) */
 /* (use H5_TOSTRING, H5_STRINGIZE is just part of the implementation) */
 #define H5_STRINGIZE(x) #x