irplib_error.h

Go to the documentation of this file.

/* $Id: irplib_error.h,v 1.4 2007-10-04 08:57:15 rhaigron Exp $
 *
 * This file is part of the irplib package
 * Copyright (C) 2002,2003,2004,2005,2006 European Southern Observatory
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02111-1307  USA
 */
 
/*
 * $Author: rhaigron $
 * $Date: 2007-10-04 08:57:15 $
 * $Revision: 1.4 $
 * $Name: not supported by cvs2svn $
 */
 
#ifndef IRPLIB_ERROR_H
#define IRPLIB_ERROR_H
 
/*-----------------------------------------------------------------------------
                                   Includes
 -----------------------------------------------------------------------------*/
 
#include <cpl.h>
#include <xsh_msg.h>
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------
                                   Define
 -----------------------------------------------------------------------------*/
/* fixme:  This is to avoid including irplib_utils.h which includes this file */
#if defined HAVE_DECL___FUNC__ && !HAVE_DECL___FUNC__
#ifndef __func__
#define __func__ ""
#endif
#endif
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
#define irplib_error_assure(CONDITION, ERROR_CODE, MSG, ACTION)                \
  do {\
      if (cpl_error_get_code() != CPL_ERROR_NONE){                             \
          irplib_error_push(cpl_error_get_code(),                              \
                           ("An error occurred that was not caught: %s",       \
                           cpl_error_get_where()) );                           \
          ACTION;                                                              \
      }                                                                        \
      else if (!(CONDITION))                                                   \
      {\
          irplib_error_push(ERROR_CODE, MSG);                                  \
          ACTION;                                                              \
      }                                                                        \
  } while (0)
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#define irplib_error_push(ec, msg)                                             \
      do {                                                                     \
        xsh_irplib_error_set_msg msg;                                          \
        xsh_irplib_error_push_macro(__func__, ec, __FILE__, __LINE__);         \
      } while (0)
 
 
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
#define irplib_error_dump(severity, trace_severity)                            \
        xsh_irplib_error_dump_macro(__func__, __FILE__, __LINE__,              \
                severity, trace_severity) 
 
/*-----------------------------------------------------------------------------
                               Functions prototypes
 -----------------------------------------------------------------------------*/
 
void xsh_irplib_error_reset(void);
 
/*
 * The following functions should not be called directly ; but they must
 * be exported in order to support the macro nature of the interface
 */
cpl_error_code xsh_irplib_error_push_macro(const char *func,
                       cpl_error_code ec,
                       const char *file, 
                       unsigned int line);
void xsh_irplib_error_dump_macro(const char *func,
                 const char *file,
                 unsigned int line,
                 cpl_msg_severity severity,
                 cpl_msg_severity trace_severity);
 
void xsh_irplib_error_set_msg(const char *format, ...)
#ifdef __GNUC__
    __attribute__((format (printf, 1, 2)))
#endif
    ;
 
#endif  /* IRPLIB_ERROR_H */