Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rename CLEANUP definition (used after TRY) into TRY_CLEANUP
[simgrid.git] / include / xbt / ex.h
index a688f0d..7667341 100644 (file)
@@ -1,15 +1,44 @@
-/* $Id$ */
+/* ex - Exception Handling                                                  */
 
-/* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
-
-/*  Copyright (c) 2005-2006 Martin Quinson                                  */
+/*  Copyright (c) 2005-2010 The SimGrid team                                */
 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
 /*  All rights reserved.                                                    */
 
-/* This program is free software; you can redistribute it and/or modify it
-  * under the terms of the license (GNU LGPL) which comes with this package. */
+/* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
+/* It was heavily modified to fit the SimGrid framework.                    */
+
+/* The OSSP version has the following copyright notice:
+**  OSSP ex - Exception Handling
+**  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
+**  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
+**  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
+**
+**  This file is part of OSSP ex, an exception handling library
+**  which can be found at http://www.ossp.org/pkg/lib/ex/.
+**
+**  Permission to use, copy, modify, and distribute this software for
+**  any purpose with or without fee is hereby granted, provided that
+**  the above copyright notice and this permission notice appear in all
+**  copies.
+**
+**  THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
+**  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+**  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+**  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
+**  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+**  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+**  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+**  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+**  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+**  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+**  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+**  SUCH DAMAGE.
+ */
+
+/* The extensions made for the SimGrid project can either be distributed    */
+/* under the same license, or under the LGPL v2.1                           */
 
 #ifndef __XBT_EX_H__
 #define __XBT_EX_H__
@@ -18,6 +47,8 @@
 #include "xbt/misc.h"
 #include "xbt/virtu.h"
 
+SG_BEGIN_DECL()
+
 /*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/
 #undef __EX_MAYDAY
 
@@ -109,7 +140,7 @@ __ex_mctx_struct} __ex_mctx_t;
  *
  * @section XBT_ex_base BASIC USAGE
  *
- * \em TRY \b TRIED_BLOCK [\em CLEANUP \b CLEANUP_BLOCK] \em CATCH (variable) \b CATCH_BLOCK
+ * \em TRY \b TRIED_BLOCK [\em TRY_CLEANUP \b CLEANUP_BLOCK] \em CATCH (variable) \b CATCH_BLOCK
  *
  * This is the primary syntactical construct provided. It is modeled after the
  * ISO-C++ try-catch clause and should sound familiar to most of you.
@@ -122,7 +153,7 @@ __ex_mctx_struct} __ex_mctx_t;
  *
  * 
  * In absence of exception, the control flow goes into the blocks TRIED_BLOCK
- * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored. 
+ * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored.
  *
  * When an exception is thrown, the control flow goes through the following
  * blocks: TRIED_BLOCK (up to the statement throwing the exception),
@@ -236,7 +267,8 @@ typedef enum {
   network_error,  /**< error while sending/receiving data */
   timeout_error,  /**< not quick enough, dude */
   thread_error,    /**< error while [un]locking */
-  host_error                            /**< host failed */
+  host_error,                            /**< host failed */
+  tracing_error   /**< error during the simulation tracing */
 } xbt_errcat_t;
 
 XBT_PUBLIC(const char *) xbt_ex_catname(xbt_errcat_t cat);
@@ -328,10 +360,10 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate;
         if (__ex_mctx_save(&__ex_mctx_me)) { \
             if (1)
 
-/** @brief optional(!) block for cleanup 
+/** @brief optional(!) block for cleanup
  *  @hideinitializer
  */
-#define CLEANUP \
+#define TRY_CLEANUP \
             else { \
             } \
             __xbt_ex_ctx_ptr->ctx_caught = 0; \
@@ -390,7 +422,7 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate;
  *
  * If called from within a TRY/CATCH construct, this exception 
  * is copied into the CATCH relevant variable program control flow 
- * is derouted to the CATCH (after the optional sg_cleanup). 
+ * is derouted to the CATCH (after the optional sg_cleanup).
  *
  * If no TRY/CATCH construct embeeds this call, the program calls
  * abort(3). 
@@ -513,5 +545,7 @@ XBT_PUBLIC(void) xbt_backtrace_current(xbt_ex_t * e);
 /** @brief Display a previously captured backtrace */
 XBT_PUBLIC(void) xbt_backtrace_display(xbt_ex_t * e);
 
+SG_END_DECL()
+
 /** @} */
 #endif /* __XBT_EX_H__ */