SFBAssert.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBAssert.h - Names for SFB assertions
  Copyright (C) 2008 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/

#ifndef SFBASSERT_H_
#define SFBASSERT_H_

#include "SFBErrors.h"  /* For E_ error codes */

#ifndef API_UNPROTECTED

#define API_BUG(code) do { _apiError_(code,__FILE__,__LINE__); } while (0)


#define API_ASSERT(condition,code) do { if (!(condition)) API_BUG(code); } while (0)

#else

#define API_BUG(code) 0 /* ignored */ 
#define API_ASSERT(condition,code) /* ignored */

#endif

#define POISON(code0_6) API_BUG(BLINK_MAP(1,0,code0_6))

#define API_ASSERT_MAX_CODE(value,maxval,code) API_ASSERT(((u32)(value))<(maxval),code)

#define API_ASSERT_MAX(value,maxval) API_ASSERT_MAX_CODE(value,maxval,E_API_MAX_RANGE)

#define API_ASSERT_TRUE(value) API_ASSERT((value)!=0,E_API_TRUE)

#define API_ASSERT_FALSE(value) API_ASSERT((value)==0,E_API_FALSE)

#define API_ASSERT_NONZERO(value) API_ASSERT((value)!=0,E_API_NONZERO)

#define API_ASSERT_NONNULL(value) API_ASSERT((value)!=0,E_API_NULL_POINTER)

#define API_ASSERT_NULL(value) API_ASSERT((value)==0,E_API_NONNULL_POINTER)

#define API_ASSERT_ZERO(value) API_ASSERT((value)==0,E_API_ZERO)

#define API_ASSERT_EQUAL(target,value) API_ASSERT((value)==(target),E_API_EQUAL)

#define API_ASSERT_NOT_EQUAL(target,value) API_ASSERT((value)!=(target),E_API_NOT_EQUAL)

#define API_ASSERT_LESS(target,value) API_ASSERT((target)<(value),E_API_LESS)

#define API_ASSERT_LESS_EQUAL(target,value) API_ASSERT((target)<=(value),E_API_LESS_EQUAL)

#define API_ASSERT_GREATER(target,value) API_ASSERT((target)>(value),E_API_GREATER)

#define API_ASSERT_GREATER_EQUAL(target,value) API_ASSERT((target)>=(value),E_API_GREATER_EQUAL)

#define API_ASSERT_VALID_PIN(u32Pin) API_ASSERT_MAX_CODE(u32Pin,VIRTUAL_PIN_COUNT,E_API_BAD_PIN)

#define API_ASSERT_VALID_FACE(u32Face) API_ASSERT_MAX_CODE(u32Face,FACE_COUNT,E_API_BAD_FACE)

#define API_ASSERT_VALID_EXTENDED_FACE(u32Face) API_ASSERT_MAX_CODE(u32Face,MAX_FACE_INDEX,E_API_BAD_FACE)

#define API_ASSERT_HALFWORD_ALIGNED(uptraddress) API_ASSERT((((uptr)(uptraddress))&1)==0,E_API_HALFWORD_ALIGNED)

#define API_ASSERT_WORD_ALIGNED(uptraddress) API_ASSERT((((uptr)(uptraddress))&3)==0,E_API_WORD_ALIGNED)

#define API_ASSERT_DOUBLEWORD_ALIGNED(uptraddress) API_ASSERT((((uptr)(uptraddress))&7)==0,E_API_DOUBLEWORD_ALIGNED)

#endif /*SFBASSERT_H_*/