fs_debug.h

Latest ucFS v.3.10d PC Windows Evaluation Ed., provided with free Flash driver

/*
**********************************************************************
*                          Micrium, Inc.
*                      949 Crestview Circle
*                     Weston,  FL 33327-1848
*
*                            uC/FS
*
*             (c) Copyright 2001 - 2007, Micrium, Inc.
*                      All rights reserved.
*
***********************************************************************

**** 礐/FS file system for embedded applications ****
礐/FS is protected by international copyright laws. Knowledge of the
source code may not be used to write a similar product. This file may
only be used in accordance with a license and should not be re-
distributed in any way. We appreciate your understanding and fairness.
----------------------------------------------------------------------
File        : FS_Debug.h
Purpose     : Debug macros
----------------------------------------------------------------------
   Debug macros for logging

 In the FS Simulation, all output is transferred into the log window.
*/

#ifndef FS_DEBUG_H
#define FS_DEBUG_H


#define FS_DEBUG_LEVEL_NOCHECK       0  /* No run time checks are performed */
#define FS_DEBUG_LEVEL_CHECK_PARA    1  /* Parameter checks are performed to avoid crashes */
#define FS_DEBUG_LEVEL_CHECK_ALL     2  /* Parameter checks and consistency checks are performed */
#define FS_DEBUG_LEVEL_LOG_ERRORS    3  /* Errors are recorded */
#define FS_DEBUG_LEVEL_LOG_WARNINGS  4  /* Errors & Warnings are recorded */
#define FS_DEBUG_LEVEL_LOG_ALL       5  /* Errors, Warnings and Messages are recorded. */

#ifndef FS_DEBUG_LEVEL
  #ifdef WIN32
    #define FS_DEBUG_LEVEL FS_DEBUG_LEVEL_LOG_WARNINGS  /* Simulation should log all warnings */
  #else
    #define FS_DEBUG_LEVEL FS_DEBUG_LEVEL_CHECK_PARA  /* For most targets, min. size is important */
  #endif
#endif

#if defined(__cplusplus)
extern "C" {     /* Make sure we have C-declarations in C++ programs */
#endif

/*********************************************************************
*
*       Logging (for debugging primarily)
*
**********************************************************************
*/
void FS__Log      (const char *s);
void FS__Log1     (const char *s, int p0);
void FS__Log2     (const char *s, int p0, int p1);
void FS__Log3     (const char *s, int p0, int p1, int p2);
void FS__Log4     (const char *s, int p0, int p1, int p2,int p3);
void FS__Warn     (const char *s);
void FS__Warn1    (const char *s, int p0);
void FS__Warn2    (const char *s, int p0, int p1);
void FS__Warn3    (const char *s, int p0, int p1, int p2);
void FS__Warn4    (const char *s, int p0, int p1, int p2, int p3);
void FS__ErrorOut (const char *s);
void FS__ErrorOut1(const char *s, int p0);
void FS__ErrorOut2(const char *s, int p0, int p1);
void FS__ErrorOut3(const char *s, int p0, int p1, int p2);
void FS__ErrorOut4(const char *s, int p0, int p1, int p2, int p3);

/*******************************************************************
*
*               Commandline
*
********************************************************************
*/

#ifdef WIN32
  void FS_X_Logf(const char * sFormat, ...);
#endif

/*******************************************************************
*
*               Error macros
*
********************************************************************
*/

/* Make sure the macros are actually defined */

#if FS_DEBUG_LEVEL >= FS_DEBUG_LEVEL_LOG_ERRORS
  #define FS_DEBUG_ERROROUT(s)              FS__ErrorOut(s)
  #define FS_DEBUG_ERROROUT1(s,p0)          FS__ErrorOut1(s,p0)
  #define FS_DEBUG_ERROROUT2(s,p0,p1)       FS__ErrorOut2(s,p0,p1)
  #define FS_DEBUG_ERROROUT3(s,p0,p1,p2)    FS__ErrorOut3(s,p0,p1,p2)
  #define FS_DEBUG_ERROROUT4(s,p0,p1,p2,p3) FS__ErrorOut4(s,p0,p1,p2,p3)
  #define FS_DEBUG_ERROROUT_IF(exp,s)              { if (exp) FS_DEBUG_ERROROUT(s); }
  #define FS_DEBUG_ERROROUT1_IF(exp,s,p0)          { if (exp) FS_DEBUG_ERROROUT1(s,p0); }
  #define FS_DEBUG_ERROROUT2_IF(exp,s,p0,p1)       { if (exp) FS_DEBUG_ERROROUT2(s,p0,p1); }
  #define FS_DEBUG_ERROROUT3_IF(exp,s,p0,p1,p2)    { if (exp) FS_DEBUG_ERROROUT3(s,p0,p1,p2); }
  #define FS_DEBUG_ERROROUT4_IF(exp,s,p0,p1,p2,p3) { if (exp) FS_DEBUG_ERROROUT4(s,p0,p1,p2,p3); }
#else
  #define FS_DEBUG_ERROROUT(s)
  #define FS_DEBUG_ERROROUT1(s,p0)
  #define FS_DEBUG_ERROROUT2(s,p0,p1)
  #define FS_DEBUG_ERROROUT3(s,p0,p1,p2)
  #define FS_DEBUG_ERROROUT4(s,p0,p1,p2,p3)
  #define FS_DEBUG_ERROROUT_IF(exp,s)
  #define FS_DEBUG_ERROROUT1_IF(exp,s,p0)
  #define FS_DEBUG_ERROROUT2_IF(exp,s,p0,p1)
  #define FS_DEBUG_ERROROUT3_IF(exp,s,p0,p1,p2)
  #define FS_DEBUG_ERROROUT4_IF(exp,s,p0,p1,p2,p3)
#endif

/*******************************************************************
*
*               Warning macros
*
********************************************************************
*/

/* Make sure the macros are actually defined */

#if FS_DEBUG_LEVEL >= FS_DEBUG_LEVEL_LOG_WARNINGS
  #define FS_DEBUG_WARN(s)              FS__Warn(s)
  #define FS_DEBUG_WARN1(s,p0)          FS__Warn1(s,p0)
  #define FS_DEBUG_WARN2(s,p0,p1)       FS__Warn2(s,p0,p1)
  #define FS_DEBUG_WARN3(s,p0,p1,p2)    FS__Warn3(s,p0,p1,p2)
  #define FS_DEBUG_WARN4(s,p0,p1,p2,p3) FS__Warn4(s,p0,p1,p2,p3)
  #define FS_DEBUG_WARN_IF(exp,s)                  { if (exp) FS_DEBUG_WARN(s); }
  #define FS_DEBUG_WARN1_IF(exp,s,p0)              { if (exp) FS_DEBUG_WARN1(s,p0); }
  #define FS_DEBUG_WARN2_IF(exp,s,p0,p1)           { if (exp) FS_DEBUG_WARN2(s,p0,p1); }
  #define FS_DEBUG_WARN3_IF(exp,s,p0,p1,p2)        { if (exp) FS_DEBUG_WARN3(s,p0,p1,p2); }
  #define FS_DEBUG_WARN4_IF(exp,s,p0,p1,p2,p3)     { if (exp) FS_DEBUG_WARN4(s,p0,p1,p2,p3); }
#else
  #define FS_DEBUG_WARN(s)
  #define FS_DEBUG_WARN1(s,p0)
  #define FS_DEBUG_WARN2(s,p0,p1)
  #define FS_DEBUG_WARN3(s,p0,p1,p2)
  #define FS_DEBUG_WARN4(s,p0,p1,p2,p3)
  #define FS_DEBUG_WARN_IF(exp,s)
  #define FS_DEBUG_WARN1_IF(exp,s,p0)
  #define FS_DEBUG_WARN2_IF(exp,s,p0,p1)
  #define FS_DEBUG_WARN3_IF(exp,s,p0,p1,p2)
  #define FS_DEBUG_WARN4_IF(exp,s,p0,p1,p2,p3)
#endif

/*******************************************************************
*
*               Logging macros
*
********************************************************************
*/
/* Make sure the macros are actually defined */

#if FS_DEBUG_LEVEL >= FS_DEBUG_LEVEL_LOG_ALL
  #define FS_DEBUG_LOG(s)              FS__Log(s)
  #define FS_DEBUG_LOG1(s,p0)          FS__Log1(s,p0)
  #define FS_DEBUG_LOG2(s,p0,p1)       FS__Log2(s,p0,p1)
  #define FS_DEBUG_LOG3(s,p0,p1,p2)    FS__Log3(s,p0,p1,p2)
  #define FS_DEBUG_LOG4(s,p0,p1,p2,p3) FS__Log4(s,p0,p1,p2,p3)
  #define FS_DEBUG_LOG_IF(exp,s)                   { if (exp) FS_DEBUG_LOG(s); }
  #define FS_DEBUG_LOG1_IF(exp,s,p0)               { if (exp) FS_DEBUG_LOG1(s,p0); }
  #define FS_DEBUG_LOG2_IF(exp,s,p0,p1)            { if (exp) FS_DEBUG_LOG2(s,p0,p1); }
  #define FS_DEBUG_LOG3_IF(exp,s,p0,p1,p2)         { if (exp) FS_DEBUG_LOG3(s,p0,p1,p2); }
  #define FS_DEBUG_LOG4_IF(exp,s,p0,p1,p2,p3)      { if (exp) FS_DEBUG_LOG4(s,p0,p1,p2,p3); }
#ifdef WIN32
  #define FS_DEBUG_LOGF(s)                         FS_X_Logf s
#else 
  #define FS_DEBUG_LOGF(s)
#endif
#else
  #define FS_DEBUG_LOG(s)
  #define FS_DEBUG_LOG1(s,p0)
  #define FS_DEBUG_LOG2(s,p0,p1)
  #define FS_DEBUG_LOG3(s,p0,p1,p2)
  #define FS_DEBUG_LOG4(s,p0,p1,p2,p3)
  #define FS_DEBUG_LOG_IF(exp,s)
  #define FS_DEBUG_LOG1_IF(exp,s,p0)
  #define FS_DEBUG_LOG2_IF(exp,s,p0,p1)
  #define FS_DEBUG_LOG3_IF(exp,s,p0,p1,p2)
  #define FS_DEBUG_LOG4_IF(exp,s,p0,p1,p2,p3)
  #define FS_DEBUG_LOGF(s)
#endif



/*******************************************************************
*
*               Asserts
*
********************************************************************
*/
#if FS_DEBUG_LEVEL >= FS_DEBUG_LEVEL_LOG_ERRORS
  #define FS_DEBUG_ASSERT(exp)                     { if (!(exp)) FS_DEBUG_ERROROUT(#exp); }
#else
  #define FS_DEBUG_ASSERT(exp)
#endif

#if defined(__cplusplus)
  }              /* Make sure we have C-declarations in C++ programs */
#endif

#endif /* FS_DEBUG_H */




/*************************** End of file ****************************/