/*  ES40 emulator.
 * Copyright (C) 2007-2008 by the ES40 Emulator Project
 *
 * WWW    : http://sourceforge.net/projects/es40
 * E-mail : camiel@camicom.com
 *
 * 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 Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Although this is not required, the author would appreciate being notified of,
 * and receiving any modifications you may make to the source code that might serve
 * the general public.
 *
 * Parts of this file based upon GXemul, which is Copyright (C) 2004-2007
 * Anders Gavare.  All rights reserved.
 */

 /**
  * \file
  * Contains macro's and prototypes for debugging.
  *
  * $Id$
  *
  * X-1.7        Camiel Vanderhoeven                             14-MAR-2008
  *   1. More meaningful exceptions replace throwing (int) 1.
  *   2. U64 macro replaces X64 macro.
  *
  * X-1.6        Brian Wheeler                                   27-FEB-2008
  *      Avoid compiler warnings.
  *
  * X-1.5        Brian wheeler                                   26-FEB-2008
  *      Pause before throwing an exception.
  *
  * X-1.4        Camiel Vanderhoeven                             28-DEC-2007
  *      Throw exceptions rather than just exiting when errors occur.
  *
  * X-1.3        Camiel Vanderhoeven                             28-DEC-2007
  *      Keep the compiler happy.
  *
  * X-1.2        Camiel Vanderhoeven                             15-NOV-2007
  *      Included stdarg.h for Linux.
  *
  * X-1.1        Camiel Vanderhoeven                             14-NOV-2007
  *      Initial creation.
  *
  * \author Camiel Vanderhoeven (camiel@camicom.com / http://www.camicom.com)
  **/
#include <stdarg.h>

#if !defined(INCLUDED_DEBUG_H)
#define INCLUDED_DEBUG_H

#define DEBUG_BUFSIZE     1024
#define DEBUG_INDENTATION 4

#ifdef HAVE___FUNCTION__
#define FAILURE(cls, error_msg)                                          \
  {                                                                      \
    char  where_msg[800];                                                \
    sprintf(where_msg, "%s, line %i, function '%s'", __FILE__, __LINE__, \
            __FUNCTION__);                                               \
    throw C##cls##Exception(error_msg, where_msg);                       \
  }

#else
#define FAILURE(cls, error_msg)                            \
  {                                                        \
    char  where_msg[800];                                  \
    sprintf(where_msg, "%s, line %i", __FILE__, __LINE__); \
    throw C##cls##Exception(error_msg, where_msg);         \
  }
#endif /*  !HAVE___FUNCTION__  */

#define FAILURE_1(cls, error_msg, a) \
  {                                  \
    char  what_msg[800];             \
    sprintf(what_msg, error_msg, a); \
    FAILURE(cls, what_msg);          \
  }

#define FAILURE_2(cls, error_msg, a, b) \
  {                                     \
    char  what_msg[800];                \
    sprintf(what_msg, error_msg, a, b); \
    FAILURE(cls, what_msg);             \
  }

#define FAILURE_3(cls, error_msg, a, b, c) \
  {                                        \
    char  what_msg[800];                   \
    sprintf(what_msg, error_msg, a, b, c); \
    FAILURE(cls, what_msg);                \
  }

#define FAILURE_4(cls, error_msg, a, b, c, d) \
  {                                           \
    char  what_msg[800];                      \
    sprintf(what_msg, error_msg, a, b, c, d); \
    FAILURE(cls, what_msg);                   \
  }

#define FAILURE_5(cls, error_msg, a, b, c, d, e) \
  {                                              \
    char  what_msg[800];                         \
    sprintf(what_msg, error_msg, a, b, c, d, e); \
    FAILURE(cls, what_msg);                      \
  }

#define FAILURE_6(cls, error_msg, a, b, c, d, e, f) \
  {                                                 \
    char  what_msg[800];                            \
    sprintf(what_msg, error_msg, a, b, c, d, e, f); \
    FAILURE(cls, what_msg);                         \
  }

#define CHECK_ALLOCATION(ptr)                \
  {                                          \
    if((ptr) == NULL)                        \
      FAILURE(OutOfMemory, "Out of memory"); \
  }

#define CHECK_REALLOCATION(dst, src, type)   \
  {                                          \
    type*   rea_x;                           \
    rea_x = (type*) src;                     \
    if((rea_x) == NULL)                      \
    {                                        \
      FAILURE(OutOfMemory, "Out of memory"); \
    }                                        \
    else                                     \
    {                                        \
      dst = rea_x;                           \
    }                                        \
  }

void  debug_indentation(int diff);
void  debug(char* fmt, ...);
void  fatal(char* fmt, ...);
#endif