XML_Macros.h File Reference

#include "ace/Exception_Macros.h"
Include dependency graph for XML_Macros.h:
This graph shows which files directly or indirectly include this file:

Defines

#define ACE_del_bad_alloc
#define ACEXML_ENV_TYPE   ACEXML_Env
#define ACEXML_TRY_ENV   _ACEXML_Env_variable
#define ACEXML_EXCEPTION_TYPE   ACEXML_Exception
#define ACEXML_ANY_EXCEPTION   ex
#define ACEXML_DECLARE_NEW_ENV   ACEXML_ENV_TYPE ACEXML_TRY_ENV
#define ACEXML_ADOPT_ENV(ENV)   ACEXML_ENV_TYPE &ACEXML_TRY_ENV = ENV
#define ACEXML_CHECK
#define ACEXML_CHECK_RETURN(RETV)
#define ACEXML_THROW_R_INT(EXCEPTION)   ACEXML_TRY_ENV.exception (new EXCEPTION)
#define ACEXML_THROW(EXCEPTION)
#define ACEXML_THROW_RETURN(EXCEPTION, RETV)
#define ACEXML_TRY
#define ACEXML_TRY_NEW_ENV
#define ACEXML_TRY_EX(LABEL)
#define ACEXML_TRY_CHECK
#define ACEXML_TRY_CHECK_EX(LABEL)
#define ACEXML_TRY_THROW(EXCEPTION)
#define ACEXML_TRY_THROW_EX(EXCEPTION, LABEL)
#define ACEXML_CATCH(TYPE, VAR)
#define ACEXML_CATCHANY   ACEXML_CATCH (ACEXML_EXCEPTION_TYPE, ACEXML_ANY_EXCEPTION)
#define ACEXML_CATCHALL   ACEXML_CATCHANY
#define ACEXML_RE_THROW
#define ACEXML_RE_THROW_EX(LABEL)
#define ACEXML_ENDTRY
#define ACEXML_NEW_THROW_EX(POINTER, CONSTRUCTOR, EXCEPTION)
#define ACEXML_GUARD_THROW_EX(MUTEX, OBJ, LOCK, EXCEPTION)
#define ACEXML_READ_GUARD_THROW_EX(MUTEX, OBJ, LOCK, EXCEPTION)
#define ACEXML_WRITE_GUARD_THROW_EX(MUTEX, OBJ, LOCK, EXCEPTION)
#define ACEXML_ENV_RAISE(ex)   ACEXML_TRY_ENV.exception (ex)
Native C++ exceptions portability macros.

The following macros are used to write code portable between platforms with and without native C++ exception support. Their main goal is to hide the presence of the ACEXML_ENV_TYPE argument, but they collaborate with the ACEXML_TRY_* macros to emulate the try/catch blocks.



#define ACEXML_ENV_EMIT_CODE(X)   X
 Define a macro to emit code only when ACEXML_ENV_TYPE is used.
#define ACEXML_ENV_EMIT_CODE2(X, Y)   X,Y
 Another macro to emit code only when ACEXML_ENV_TYPE is used.
#define ACEXML_ENV_EMIT_DUMMY
 Helper macro.
#define ACEXML_ENV_ARG_DECL
#define ACEXML_ENV_ARG_DECL_NOT_USED
#define ACEXML_ENV_SINGLE_ARG_DECL   ACEXML_ENV_EMIT_CODE(ACEXML_ENV_TYPE &ACEXML_TRY_ENV)
#define ACEXML_ENV_SINGLE_ARG_DECL_NOT_USED   ACEXML_ENV_EMIT_CODE(ACEXML_ENV_TYPE &)
 Declare a ACEXML_ENV_TYPE argument for methods which don't use it.
#define ACEXML_ENV_ARG_PARAMETER
 Use the ACEXML_ENV_TYPE argument in a nested call.
#define ACEXML_ENV_SINGLE_ARG_PARAMETER   ACEXML_ENV_EMIT_CODE(ACEXML_TRY_ENV)
#define ACEXML_ENV_ARG_NOT_USED   ACEXML_ENV_EMIT_CODE(ACE_UNUSED_ARG(ACEXML_TRY_ENV))
 Eliminate unused argument warnings about ACEXML_TRY_ENV.

Detailed Description

Id
XML_Macros.h 80826 2008-03-04 14:51:23Z wotte

Writing code that is portable between platforms with or without native C++ exceptions is hard. The following macros offer some help on this task.

Author:
Nanbor Wang <nanbor@cs.wustl.edu>
Aniruddha Gokhale <gokhale@sahyadri.research.bell-labs.com>
Carlos O'Ryan <coryan@uci.edu>
Krishnakumar B <kitty@cs.wustl.edu>, et al.

Define Documentation

#define ACE_del_bad_alloc
#define ACEXML_ADOPT_ENV ( ENV   )     ACEXML_ENV_TYPE &ACEXML_TRY_ENV = ENV
#define ACEXML_ANY_EXCEPTION   ex
#define ACEXML_CATCH ( TYPE,
VAR   ) 
Value:
} while (0); \
   do \
     if (ACEXML_TRY_ENV.exception () != 0 && ACEXML_EXCEPTION_NOT_CAUGHT && \
       TYPE::_downcast(ACEXML_TRY_ENV.exception ()) != 0) \
       { \
         ACEXML_ENV_TYPE ACEXML_CAUGHT_ENV = ACEXML_TRY_ENV;\
         ACEXML_EXCEPTION_NOT_CAUGHT = 0; \
         TYPE &VAR = *TYPE::_downcast (ACEXML_CAUGHT_ENV.exception ()); \
         ACE_UNUSED_ARG (VAR); \
         ACEXML_TRY_ENV.clear ();
#define ACEXML_CATCHALL   ACEXML_CATCHANY
#define ACEXML_CATCHANY   ACEXML_CATCH (ACEXML_EXCEPTION_TYPE, ACEXML_ANY_EXCEPTION)
#define ACEXML_CHECK
Value:
if (ACEXML_TRY_ENV . exception () != 0) \
      return
#define ACEXML_CHECK_RETURN ( RETV   ) 
Value:
if (ACEXML_TRY_ENV . exception () != 0) \
      return RETV
#define ACEXML_DECLARE_NEW_ENV   ACEXML_ENV_TYPE ACEXML_TRY_ENV
#define ACEXML_ENDTRY
Value:
} while (0); \
    } while (0)
#define ACEXML_ENV_ARG_DECL
Value:
ACEXML_ENV_EMIT_CODE2(ACEXML_ENV_EMIT_DUMMY, \
                       ACEXML_ENV_TYPE &ACEXML_TRY_ENV)

Declare a ACEXML_ENV_TYPE argument as the last argument of a function Normally this macro is used as follows:

void my_funct (int x, int y ACEXML_ENV_ARG_DECL);

Its purpose is to provide developers (and users) with a mechanism to write code that is portable to platforms with and without native C++ exceptions.

#define ACEXML_ENV_ARG_DECL_NOT_USED
Value:
ACEXML_ENV_EMIT_CODE2(ACEXML_ENV_EMIT_DUMMY, \
                       ACEXML_ENV_TYPE &)

Declare a ACEXML_ENV_TYPE argument that is not used by the function definition. Similar to ACEXML_ENV_ARG_DECL, but the formal parameter name is dropped to avoid warnings about unused parameters

#define ACEXML_ENV_ARG_NOT_USED   ACEXML_ENV_EMIT_CODE(ACE_UNUSED_ARG(ACEXML_TRY_ENV))

Eliminate unused argument warnings about ACEXML_TRY_ENV.

#define ACEXML_ENV_ARG_PARAMETER
Value:
ACEXML_ENV_EMIT_CODE2(ACEXML_ENV_EMIT_DUMMY, \
                       ACEXML_TRY_ENV)

Use the ACEXML_ENV_TYPE argument in a nested call.

#define ACEXML_ENV_EMIT_CODE ( X   )     X

Define a macro to emit code only when ACEXML_ENV_TYPE is used.

#define ACEXML_ENV_EMIT_CODE2 ( X,
Y   )     X,Y

Another macro to emit code only when ACEXML_ENV_TYPE is used.

#define ACEXML_ENV_EMIT_DUMMY

Helper macro.

#define ACEXML_ENV_RAISE ( ex   )     ACEXML_TRY_ENV.exception (ex)
#define ACEXML_ENV_SINGLE_ARG_DECL   ACEXML_ENV_EMIT_CODE(ACEXML_ENV_TYPE &ACEXML_TRY_ENV)

Declare a ACEXML_ENV_TYPE argument for methods that do not take any other parameters

#define ACEXML_ENV_SINGLE_ARG_DECL_NOT_USED   ACEXML_ENV_EMIT_CODE(ACEXML_ENV_TYPE &)

Declare a ACEXML_ENV_TYPE argument for methods which don't use it.

#define ACEXML_ENV_SINGLE_ARG_PARAMETER   ACEXML_ENV_EMIT_CODE(ACEXML_TRY_ENV)

Use the ACEXML_ENV_TYPE argument in a nested call, assuming that the called function takes only the ACEXML_TRY_ENV argument.

#define ACEXML_ENV_TYPE   ACEXML_Env
#define ACEXML_EXCEPTION_TYPE   ACEXML_Exception
#define ACEXML_GUARD_THROW_EX ( MUTEX,
OBJ,
LOCK,
EXCEPTION   ) 
Value:
ACE_Guard< MUTEX > OBJ (LOCK); \
    if (OBJ.locked () == 0) ACEXML_THROW_R_INT (EXCEPTION);
#define ACEXML_NEW_THROW_EX ( POINTER,
CONSTRUCTOR,
EXCEPTION   ) 
Value:
do { POINTER = new CONSTRUCTOR; \
       if (POINTER == 0) { errno = ENOMEM; ACEXML_THROW_R_INT (EXCEPTION); } \
     } while (0)
#define ACEXML_RE_THROW
Value:
do {\
      ACEXML_TRY_ENV = ACEXML_CAUGHT_ENV; \
      goto ACEXML_TRY_LABEL; \
    } while (0)
#define ACEXML_RE_THROW_EX ( LABEL   ) 
Value:
do {\
      ACEXML_TRY_ENV = ACEXML_CAUGHT_ENV; \
      goto ACEXML_TRY_LABEL ## LABEL; \
    } while (0)
#define ACEXML_READ_GUARD_THROW_EX ( MUTEX,
OBJ,
LOCK,
EXCEPTION   ) 
Value:
ACE_Read_Guard< MUTEX > OBJ (LOCK); \
    if (OBJ.locked () == 0) ACEXML_THROW_R_INT (EXCEPTION);
#define ACEXML_THROW ( EXCEPTION   ) 
Value:
do \
      { \
        ACEXML_TRY_ENV.exception (new EXCEPTION); \
        return; \
      } while (0)
#define ACEXML_THROW_R_INT ( EXCEPTION   )     ACEXML_TRY_ENV.exception (new EXCEPTION)
#define ACEXML_THROW_RETURN ( EXCEPTION,
RETV   ) 
Value:
do \
      { \
        ACEXML_TRY_ENV.exception (new EXCEPTION); \
        return RETV; \
      } while (0)
#define ACEXML_TRY
Value:
do { \
     int ACEXML_TRY_FLAG = 1; \
     int ACEXML_EXCEPTION_NOT_CAUGHT = 1; \
   ACEXML_TRY_LABEL: \
     if (ACEXML_TRY_FLAG) \
       do {
#define ACEXML_TRY_CHECK
Value:
{ \
      if (ACEXML_TRY_ENV.exception () != 0) \
        { \
          ACEXML_TRY_FLAG = 0; \
          goto ACEXML_TRY_LABEL; \
        } \
    }
#define ACEXML_TRY_CHECK_EX ( LABEL   ) 
Value:
{ \
      if (ACEXML_TRY_ENV.exception () != 0) \
        { \
          ACEXML_TRY_FLAG = 0; \
          goto ACEXML_TRY_LABEL ## LABEL; \
        } \
    }
#define ACEXML_TRY_ENV   _ACEXML_Env_variable
#define ACEXML_TRY_EX ( LABEL   ) 
Value:
do { \
     int ACEXML_TRY_FLAG = 1; \
     int ACEXML_EXCEPTION_NOT_CAUGHT = 1; \
   ACEXML_TRY_LABEL ## LABEL: \
     if (ACEXML_TRY_FLAG) \
       do {
#define ACEXML_TRY_NEW_ENV
Value:
do { \
     ACEXML_ENV_TYPE ACEXML_TRY_ENV;\
     int ACEXML_TRY_FLAG = 1; \
     int ACEXML_EXCEPTION_NOT_CAUGHT = 1; \
   ACEXML_TRY_LABEL: \
     if (ACEXML_TRY_FLAG) \
       do {
#define ACEXML_TRY_THROW ( EXCEPTION   ) 
Value:
{ \
      ACEXML_TRY_ENV.exception (new EXCEPTION); \
      ACEXML_TRY_FLAG = 0; \
      goto ACEXML_TRY_LABEL; \
    }
#define ACEXML_TRY_THROW_EX ( EXCEPTION,
LABEL   ) 
Value:
{ \
      ACEXML_TRY_ENV.exception (new EXCEPTION); \
      ACEXML_TRY_FLAG = 0; \
      goto ACEXML_TRY_LABEL ## LABEL; \
    }
#define ACEXML_WRITE_GUARD_THROW_EX ( MUTEX,
OBJ,
LOCK,
EXCEPTION   ) 
Value:
ACE_Write_Guard< MUTEX > OBJ (LOCK); \
    if (OBJ.locked () == 0) ACEXML_THROW_R_INT (EXCEPTION);
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Fri Sep 11 04:04:52 2009 for ACEXML by  doxygen 1.6.1