ObitErr.h

Go to the documentation of this file.

/* $Id: ObitErr.h,v 1.3 2005/12/08 02:01:20 bcotton Exp $         */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2002-2004                                          */
/*;  Associated Universities, Inc. Washington DC, USA.                */
/*;  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., 675 Massachusetts Ave, Cambridge,     */
/*;  MA 02139, USA.                                                   */
/*;                                                                   */
/*;  Correspondence this software should be addressed as follows:     */
/*;         Internet email: bcotton@nrao.edu.                         */
/*;         Postal address: William Cotton                            */
/*;                         National Radio Astronomy Observatory      */
/*;                         520 Edgemont Road                         */
/*;                         Charlottesville, VA 22903-2475 USA        */
/*--------------------------------------------------------------------*/
#ifndef OBITERR_H 
#define OBITERR_H 
#include <glib.h>

/*-------- Obit: Software for the recently deceased ------------------*/
/*----------------- enums ---------------------------*/
enum ObitErrCode {
  OBIT_None = 0,
  OBIT_InfoErr,
  OBIT_InfoWarn,
  OBIT_Traceback,
  OBIT_MildError,
  OBIT_Error,
  OBIT_StrongError,
  OBIT_Fatal
};/* end enum ObitErrCode */
typedef enum ObitErrCode ObitErrCode;

#define OBITERRBUFSIZE 120

/*----------------- Macroes ---------------------------*/
#define Obit_log_error(err,errCode,format...)        G_STMT_START{ \
        g_snprintf (err->buffer, OBITERRBUFSIZE, format);          \
        ObitErrPush (err, errCode, err->buffer);                   \
        if (errCode>OBIT_Traceback) {                              \
           g_snprintf (err->buffer, OBITERRBUFSIZE,                \
                       " This occured at file %s: line %d (%s)",   \
                        __FILE__, __LINE__, __PRETTY_FUNCTION__);  \
           ObitErrPush (err, OBIT_Error, err->buffer);             \
          }                                                        \
        }G_STMT_END  

#define Obit_log_error_no_trace(err,errCode,format...) G_STMT_START{ \
        g_snprintf (err->buffer, OBITERRBUFSIZE, format);          \
        ObitErrPush (err, errCode, err->buffer);                   \
        }G_STMT_END  

#define Obit_return_if_fail(expr,err,format...)   G_STMT_START{  \
     if (expr) { } else  {                                       \
        g_snprintf (err->buffer, OBITERRBUFSIZE, format);        \
        ObitErrPush (err, OBIT_Error, err->buffer);              \
        g_snprintf (err->buffer, OBITERRBUFSIZE,                 \
                    " Occured at file %s: line %d (%s)",         \
                     __FILE__, __LINE__, __PRETTY_FUNCTION__);   \
        ObitErrPush (err, OBIT_Error, err->buffer);              \
        return;                                                  \
     } }G_STMT_END  

#define Obit_retval_if_fail(expr,err,out,format...) G_STMT_START{ \
     if (expr) { } else  {                                        \
        g_snprintf (err->buffer, OBITERRBUFSIZE, format);         \
        ObitErrPush (err, OBIT_Error, err->buffer);               \
        g_snprintf (err->buffer, OBITERRBUFSIZE,                  \
                    " Occured at file %s: line %d (%s)",          \
                     __FILE__, __LINE__, __PRETTY_FUNCTION__);    \
        ObitErrPush (err, OBIT_Error, err->buffer);               \
        return out;                                               \
     } }G_STMT_END  

#define Obit_traceback_msg(err,me,name) G_STMT_START{           \
     g_snprintf (err->buffer, OBITERRBUFSIZE,                   \
                "Traceback: routine %s:  object %s", me, name); \
     ObitErrPush (err, OBIT_Traceback, err->buffer);            \
     g_snprintf (err->buffer, OBITERRBUFSIZE,                   \
                 " Occured at file %s: line %d (%s)",           \
                  __FILE__, __LINE__, __PRETTY_FUNCTION__);     \
      ObitErrPush (err, OBIT_Traceback, err->buffer);           \
      return;                                                   \
     }G_STMT_END

#define Obit_traceback_val(err,me,name,out) G_STMT_START{       \
     g_snprintf (err->buffer, OBITERRBUFSIZE,                   \
                "Traceback: routine %s:  object %s", me, name); \
     ObitErrPush (err, OBIT_Traceback, err->buffer);            \
     g_snprintf (err->buffer, OBITERRBUFSIZE,                   \
                 " at file %s: line %d (%s)",                   \
                  __FILE__, __LINE__, __PRETTY_FUNCTION__);     \
      ObitErrPush (err, OBIT_Traceback, err->buffer);           \
      return out;                                               \
     }G_STMT_END

#define Obit_cfitsio_error(err)   G_STMT_START{                       \
      while (fits_read_errmsg(err->buffer))                           \
        ObitErrPush (err, OBIT_Error, err->buffer);                   \
      fits_clear_errmsg();     }G_STMT_END  

/*---------------Class Structures---------------------------*/
typedef struct {
  gchar *className;
  gint16 number;
  gboolean error;
  GQueue *stack;
  gint32 ReferenceCount;
  gchar buffer[OBITERRBUFSIZE+1];
} ObitErr;

typedef struct {
  ObitErrCode errLevel;
  gchar *errMsg;
} ObitErrElem;

/* Private functions defined only in ObitErr.c */
/*---------------Public functions---------------------------*/

ObitErr* newObitErr (void);

ObitErr* ObitErrRef (ObitErr* in);

ObitErr* ObitErrUnref (ObitErr* in);

void ObitErrClear (ObitErr* in);

void ObitErrClearErr (ObitErr* in);

void ObitErrPush (ObitErr *in, ObitErrCode errLevel, gchar *errMsg);

void ObitErrPop  (ObitErr *in, ObitErrCode *errLevel, gchar **errMsg);

void ObitErrLog  (ObitErr *in);

gboolean ObitErrIsA (ObitErr* in);

#endif /* OBITERR_H */ 

---