legato_error.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
*
* Subject to your compliance with these terms, you may use Microchip software
* and any derivatives exclusively with Microchip products. It is your
* responsibility to comply with third party license terms applicable to your
* use of third party software (including open source software) that may
* accompany Microchip software.
*
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
* EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
* INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
* WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
* BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
* FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
* ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
*******************************************************************************/

/*******************************************************************************
 Module for Microchip Graphics Library - Legato User Interface Library

  Company:
    Microchip Technology Inc.

  File Name:
    legato_error.h

  Summary:
    Defines library assert macros.

  Description:
    Defines library assert macros.
*******************************************************************************/

#ifndef LE_ERROR_H
#define LE_ERROR_H

#include "gfx/legato/common/legato_common.h"

#ifdef __cplusplus
extern "C" {
#endif

// *****************************************************************************
// *****************************************************************************
// Section: Data Types and Constants
// *****************************************************************************
// *****************************************************************************

#if LE_ASSERT_ENABLE == 1
//#include <assert.h>
#endif

/* controls whether library-wide asserts are enabled */
#if LE_ASSERT_ENABLE == 1
//#define LE_ASSERT(val)          assert(val)
//#define LE_ASSERT_MSG(val, msg) for ( ; !(val) ; assert(val) ) { leSetErrorMessage(msg); }
//#define LE_ASSERT_VAR(val, fmt, ...) for ( ; !(val) ; assert(val) ) { leSprintfErrorMessage(fmt, __VA_ARGS__); }
#define LE_ASSERT(val)          if((val) == 0) { leAssert(); }
#define LE_ASSERT_MSG(val, msg) if((val) == 0) { leSetErrorMessage(msg); }
#define LE_ASSERT_VAR(val, fmt, ...) if((val) == 0) { leSprintfErrorMessage(fmt, __VA_ARGS__); }
#else
#define LE_ASSERT(val)
#define LE_ASSERT_MSG(val, msg)
#define LE_ASSERT_VAR(val, fmt, ...)
#endif

#define LE_ASSERT_THIS() LE_ASSERT_MSG(_this != NULL, "'this' pointer is null")

// *****************************************************************************
// *****************************************************************************
// Section: Routines
// *****************************************************************************
// *****************************************************************************

#if LE_ASSERT_ENABLE == 1

void leAssert(void) __attribute__ ((noreturn));;

// *****************************************************************************
/* Function:
    const char* leGetErrorMessage()

  Summary:
    Gets the library global error message.

  Description:
    Gets the library global error message.

  Parameters:

  Returns:
    const char* msg - the error message

  Remarks:

*/
const char* leGetErrorMessage(void);

// *****************************************************************************
/* Function:
    void leSetErrorMessage(const char* msg)

  Summary:
    Sets the library global error message.

  Description:
    Sets the library global error message.

  Parameters:
    const char* msg - the error message

  Returns:

  Remarks:

*/
void leSetErrorMessage(const char* msg);

// *****************************************************************************
/* Function:
    void leSetErrorMessage(const char* fmt, ...)

  Summary:
    Sets the library global error message using a formatted string.

  Description:
    Sets the library global error message using a formatted string.

  Parameters:
    const char* fmt - the formatted error message string
    varargs - the arguments to the formatted string

  Returns:

  Remarks:

*/
void leSprintfErrorMessage(const char* fmt, ...) __attribute__ ((noreturn));;

#endif

#ifdef __cplusplus
}
#endif

#endif /* LE_ERROR_H */