XnMacros.h

Go to the documentation of this file.

/*****************************************************************************
*                                                                            *
*  OpenNI 1.0 Alpha                                                          *
*  Copyright (C) 2010 PrimeSense Ltd.                                        *
*                                                                            *
*  This file is part of OpenNI.                                              *
*                                                                            *
*  OpenNI 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 3 of the License, or      *
*  (at your option) any later version.                                       *
*                                                                            *
*  OpenNI 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 Lesser General Public License  *
*  along with OpenNI. If not, see <http://www.gnu.org/licenses/>.            *
*                                                                            *
*****************************************************************************/




#ifndef _XN_MACROS_H_
#define _XN_MACROS_H_

//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include "XnStatusCodes.h"

//---------------------------------------------------------------------------
// Macros
//---------------------------------------------------------------------------

#define XN_SETBITMASK(x) (1 << x-1)

#define XN_RET_IF_NULL(x, y)    \
                if (x == NULL)                  \
                {                                               \
                        return (y);                     \
                }

#define XN_IS_STATUS_OK_RET(x, y)       \
                if (x != XN_STATUS_OK)          \
                {                                                       \
                        return (y);                             \
                }

#define XN_IS_STATUS_OK_GOCLEANUP_RET(x, y)     \
                if (x != XN_STATUS_OK)                          \
                {                                                                       \
                        x = y;                                                  \
                        goto ErrorCleanUp;                              \
                }

#define XN_IS_STATUS_OK(x)                      \
                XN_IS_STATUS_OK_RET(x, x)

#define XN_IS_STATUS_OK_ASSERT(x)       \
        if (x != XN_STATUS_OK)          \
        {                                                       \
                XN_ASSERT(FALSE);               \
                return (x);                             \
        }
                

#define XN_IS_STATUS_OK_GOCLEANUP(x)    \
                if (x != XN_STATUS_OK)                  \
                {                                                               \
                        goto ErrorCleanUp;                      \
                }

#define XN_IS_BOOL_OK_RET(x, y)         \
                if (x != TRUE)                          \
                {                                                       \
                        return (y);                             \
                }

#define XN_IS_BOOL_OK_GOCLEANUP_RET(x, y)       \
                if (x != TRUE)                                          \
                {                                                                       \
                        goto ErrorCleanUp;                              \
                }

#define XN_GOCLEANUP_RET(x, y)  \
                x = y;                                  \
                goto ErrorCleanUp;                              

#define XN_VALIDATE_PTR(x,y)    \
                if (x == NULL)                  \
                {                                               \
                        return (y);                     \
                }

#define XN_CHECK_INPUT_OVERFLOW(x, y)                                   \
                if (x > y)                                                                              \
                {                                                                                               \
                        return (XN_STATUS_INPUT_BUFFER_OVERFLOW);       \
                }

#define XN_CHECK_OUTPUT_OVERFLOW(x, y)                                  \
                if (x > y)                                                                              \
                {                                                                                               \
                        return (XN_STATUS_OUTPUT_BUFFER_OVERFLOW);      \
                }

#endif //_XN_MACROS_H_